maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/change_invoice_status_event_data.rb

@@ -0,0 +1,131 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Example schema for an `change_invoice_status` event
+  class ChangeInvoiceStatusEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier for the transaction within the payment gateway.
+    # @return [String]
+    attr_accessor :gateway_trans_id
+
+    # The monetary value associated with the linked payment, expressed in
+    # dollars.
+    # @return [String]
+    attr_accessor :amount
+
+    # The status of the invoice before any changes occurred. See [Invoice
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statuses) for more.
+    # @return [InvoiceStatus]
+    attr_accessor :from_status
+
+    # The updated status of the invoice after changes have been made. See
+    # [Invoice
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statuses) for more.
+    # @return [InvoiceStatus]
+    attr_accessor :to_status
+
+    # The updated status of the invoice after changes have been made. See
+    # [Invoice
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statuses) for more.
+    # @return [InvoiceConsolidationLevel]
+    attr_accessor :consolidation_level
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gateway_trans_id'] = 'gateway_trans_id'
+      @_hash['amount'] = 'amount'
+      @_hash['from_status'] = 'from_status'
+      @_hash['to_status'] = 'to_status'
+      @_hash['consolidation_level'] = 'consolidation_level'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        gateway_trans_id
+        amount
+        consolidation_level
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from_status = nil,
+                   to_status = nil,
+                   gateway_trans_id = SKIP,
+                   amount = SKIP,
+                   consolidation_level = SKIP,
+                   additional_properties = {})
+      @gateway_trans_id = gateway_trans_id unless gateway_trans_id == SKIP
+      @amount = amount unless amount == SKIP
+      @from_status = from_status
+      @to_status = to_status
+      @consolidation_level = consolidation_level unless consolidation_level == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      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.
+      from_status = hash.key?('from_status') ? hash['from_status'] : nil
+      to_status = hash.key?('to_status') ? hash['to_status'] : nil
+      gateway_trans_id =
+        hash.key?('gateway_trans_id') ? hash['gateway_trans_id'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      consolidation_level =
+        hash.key?('consolidation_level') ? hash['consolidation_level'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ChangeInvoiceStatusEventData.new(from_status,
+                                       to_status,
+                                       gateway_trans_id,
+                                       amount,
+                                       consolidation_level,
+                                       hash)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ChangeInvoiceStatusEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.from_status,
+                                ->(val) { InvoiceStatus.validate(val) }) and
+            APIHelper.valid_type?(value.to_status,
+                                  ->(val) { InvoiceStatus.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['from_status'],
+                              ->(val) { InvoiceStatus.validate(val) }) and
+          APIHelper.valid_type?(value['to_status'],
+                                ->(val) { InvoiceStatus.validate(val) })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/chargeback_status.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The current chargeback status.
+  class ChargebackStatus
+    CHARGEBACK_STATUS = [
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for LOST
+      LOST = 'lost'.freeze,
+
+      # TODO: Write general description for WON
+      WON = 'won'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'closed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHARGEBACK_STATUS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/component.rb

@@ -266,6 +266,7 @@ module AdvancedBilling
         default_price_point_id
         overage_prices
         prices
+        price_points_url
         tax_code
         upgrade_charge
         downgrade_credit
@@ -369,9 +370,8 @@ module AdvancedBilling
       id = hash.key?('id') ? hash['id'] : SKIP
       name = hash.key?('name') ? hash['name'] : SKIP
       handle = hash.key?('handle') ? hash['handle'] : SKIP
-      pricing_scheme = hash.key?('pricing_scheme') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:ComponentPricingScheme), hash['pricing_scheme']
-      ) : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : SKIP
       unit_name = hash.key?('unit_name') ? hash['unit_name'] : SKIP
       unit_price = hash.key?('unit_price') ? hash['unit_price'] : SKIP
       product_family_id =
@@ -499,15 +499,5 @@ module AdvancedBilling
     def to_custom_archived_at
       DateTimeHelper.to_rfc3339(archived_at)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [Component | 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/component_cost_data.rb

@@ -134,5 +134,15 @@ module AdvancedBilling
                             tiers,
                             hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ComponentCostData | 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/component_cost_data_rate_tier.rb

@@ -100,5 +100,15 @@ module AdvancedBilling
                                     amount,
                                     hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ComponentCostDataRateTier | 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/component_custom_price.rb

@@ -102,5 +102,15 @@ module AdvancedBilling
                                prices,
                                hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ComponentCustomPrice | 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/component_price_point.rb

@@ -159,6 +159,7 @@ module AdvancedBilling
     # An array for nullable fields
     def self.nullables
       %w[
+        handle
         archived_at
         interval
         interval_unit
@@ -251,9 +252,7 @@ module AdvancedBilling
         hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
       tax_included = hash.key?('tax_included') ? hash['tax_included'] : SKIP
       interval = hash.key?('interval') ? hash['interval'] : SKIP
-      interval_unit = hash.key?('interval_unit') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:ComponentPricePointIntervalUnit), hash['interval_unit']
-      ) : SKIP
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
       # Parameter is an array, so we need to iterate through it
       currency_prices = nil
       unless hash['currency_prices'].nil?
@@ -300,15 +299,5 @@ module AdvancedBilling
     def to_custom_updated_at
       DateTimeHelper.to_rfc3339(updated_at)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [ComponentPricePoint | 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/component_price_point_item.rb

@@ -125,5 +125,15 @@ module AdvancedBilling
                                   prices,
                                   hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ComponentPricePointItem | 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/coupon.rb

@@ -95,7 +95,7 @@ module AdvancedBilling
     attr_accessor :stackable
 
     # TODO: Write general description for this method
-    # @return [Object]
+    # @return [CompoundingStrategy]
     attr_accessor :compounding_strategy
 
     # TODO: Write general description for this method
@@ -219,6 +219,7 @@ module AdvancedBilling
         duration_interval_span
         archived_at
         conversion_limit
+        compounding_strategy
       ]
     end
 
@@ -347,9 +348,8 @@ module AdvancedBilling
       conversion_limit =
         hash.key?('conversion_limit') ? hash['conversion_limit'] : SKIP
       stackable = hash.key?('stackable') ? hash['stackable'] : SKIP
-      compounding_strategy = hash.key?('compounding_strategy') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CouponCompoundingStrategy), hash['compounding_strategy']
-      ) : SKIP
+      compounding_strategy =
+        hash.key?('compounding_strategy') ? hash['compounding_strategy'] : SKIP
       use_site_exchange_rate =
         hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
       created_at = if hash.key?('created_at')
@@ -436,15 +436,5 @@ module AdvancedBilling
     def to_custom_updated_at
       DateTimeHelper.to_rfc3339(updated_at)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [Coupon | 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/create_component_price_point.rb

@@ -154,7 +154,9 @@ module AdvancedBilling
             APIHelper.valid_type?(value.pricing_scheme,
                                   ->(val) { PricingScheme.validate(val) }) and
             APIHelper.valid_type?(value.prices,
-                                  ->(val) { Price.validate(val) })
+                                  ->(val) { Price.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
         )
       end
 
@@ -166,7 +168,9 @@ module AdvancedBilling
           APIHelper.valid_type?(value['pricing_scheme'],
                                 ->(val) { PricingScheme.validate(val) }) and
           APIHelper.valid_type?(value['prices'],
-                                ->(val) { Price.validate(val) })
+                                ->(val) { Price.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/create_component_price_point_request.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [PricePoint]
+    # @return [Object]
     attr_accessor :price_point
 
     # A mapping from model property names to API property names.

data/lib/advanced_billing/models/create_component_price_points_request.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [Array[PricePoint]]
+    # @return [Array[Object]]
     attr_accessor :price_points
 
     # A mapping from model property names to API property names.

data/lib/advanced_billing/models/create_credit_note_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # CreateCreditNoteEvent Model.
+  class CreateCreditNoteEvent < 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 [DateTime]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # TODO: Write general description for this method
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # Example schema for an `create_credit_note` event
+    # @return [CreditNote]
+    attr_accessor :event_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   timestamp = nil,
+                   invoice = nil,
+                   event_type = InvoiceEventType::CREATE_CREDIT_NOTE,
+                   event_data = nil,
+                   additional_properties = {})
+      @id = id
+      @timestamp = timestamp
+      @invoice = invoice
+      @event_type = event_type
+      @event_data = event_data
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      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.
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+      event_type = hash['event_type'] ||= InvoiceEventType::CREATE_CREDIT_NOTE
+      event_data = CreditNote.from_hash(hash['event_data']) if hash['event_data']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      CreateCreditNoteEvent.new(id,
+                                timestamp,
+                                invoice,
+                                event_type,
+                                event_data,
+                                hash)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateCreditNoteEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { InvoiceEventType.validate(val) }) and
+            APIHelper.valid_type?(value.event_data,
+                                  ->(val) { CreditNote.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { InvoiceEventType.validate(val) }) and
+          APIHelper.valid_type?(value['event_data'],
+                                ->(val) { CreditNote.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_debit_note_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # CreateDebitNoteEvent Model.
+  class CreateDebitNoteEvent < 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 [DateTime]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # TODO: Write general description for this method
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # Example schema for an `create_debit_note` event
+    # @return [DebitNote]
+    attr_accessor :event_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   timestamp = nil,
+                   invoice = nil,
+                   event_type = InvoiceEventType::CREATE_DEBIT_NOTE,
+                   event_data = nil,
+                   additional_properties = {})
+      @id = id
+      @timestamp = timestamp
+      @invoice = invoice
+      @event_type = event_type
+      @event_data = event_data
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      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.
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+      event_type = hash['event_type'] ||= InvoiceEventType::CREATE_DEBIT_NOTE
+      event_data = DebitNote.from_hash(hash['event_data']) if hash['event_data']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      CreateDebitNoteEvent.new(id,
+                               timestamp,
+                               invoice,
+                               event_type,
+                               event_data,
+                               hash)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateDebitNoteEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { InvoiceEventType.validate(val) }) and
+            APIHelper.valid_type?(value.event_data,
+                                  ->(val) { DebitNote.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { InvoiceEventType.validate(val) }) and
+          APIHelper.valid_type?(value['event_data'],
+                                ->(val) { DebitNote.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end