maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/refund_invoice_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # RefundInvoiceEvent Model.
+  class RefundInvoiceEvent < 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 `refund_invoice` event
+    # @return [RefundInvoiceEventData]
+    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::REFUND_INVOICE,
+                   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::REFUND_INVOICE
+      event_data = RefundInvoiceEventData.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.
+      RefundInvoiceEvent.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 [RefundInvoiceEvent | 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) { RefundInvoiceEventData.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) { RefundInvoiceEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/refund_invoice_event_data.rb

@@ -172,7 +172,8 @@ module AdvancedBilling
           APIHelper.valid_type?(value.apply_credit,
                                 ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
             APIHelper.valid_type?(value.credit_note_attributes,
-                                  ->(val) { CreditNote.validate(val) }) and
+                                  ->(val) { CreditNote.validate(val) },
+                                  is_model_hash: true) and
             APIHelper.valid_type?(value.payment_id,
                                   ->(val) { val.instance_of? Integer }) and
             APIHelper.valid_type?(value.refund_amount,
@@ -190,7 +191,8 @@ module AdvancedBilling
         APIHelper.valid_type?(value['apply_credit'],
                               ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
           APIHelper.valid_type?(value['credit_note_attributes'],
-                                ->(val) { CreditNote.validate(val) }) and
+                                ->(val) { CreditNote.validate(val) },
+                                is_model_hash: true) and
           APIHelper.valid_type?(value['payment_id'],
                                 ->(val) { val.instance_of? Integer }) and
           APIHelper.valid_type?(value['refund_amount'],

data/lib/advanced_billing/models/refund_invoice_request.rb

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

data/lib/advanced_billing/models/refund_prepayment.rb

@@ -46,7 +46,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        amount_in_cents
+      ]
     end
 
     def initialize(amount_in_cents = nil,

data/lib/advanced_billing/models/remove_payment_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # RemovePaymentEvent Model.
+  class RemovePaymentEvent < 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 `remove_payment` event
+    # @return [RemovePaymentEventData]
+    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::REMOVE_PAYMENT,
+                   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::REMOVE_PAYMENT
+      event_data = RemovePaymentEventData.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.
+      RemovePaymentEvent.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 [RemovePaymentEvent | 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) { RemovePaymentEventData.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) { RemovePaymentEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/remove_payment_event_data.rb

@@ -32,7 +32,7 @@ module AdvancedBilling
     attr_accessor :transaction_time
 
     # A nested data structure detailing the method of payment
-    # @return [InvoiceEventPayment]
+    # @return [Object]
     attr_accessor :payment_method
 
     # The flag that shows whether the original payment was a prepayment or not

data/lib/advanced_billing/models/segment_price.rb

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

@@ -291,7 +291,8 @@ module AdvancedBilling
     # @return [Integer]
     attr_accessor :payer_id
 
-    # The balance in cents plus the estimated renewal amount in cents.
+    # The balance in cents plus the estimated renewal amount in cents. Returned
+    # ONLY for readSubscription operation as it's compute intensive operation.
     # @return [Integer]
     attr_accessor :current_billing_amount_in_cents
 
@@ -530,13 +531,17 @@ module AdvancedBilling
     # An array for nullable fields
     def self.nullables
       %w[
+        current_period_ends_at
+        next_assessment_at
         trial_started_at
         trial_ended_at
+        activated_at
         expires_at
         cancellation_message
         cancellation_method
         cancel_at_end_of_period
         canceled_at
+        current_period_started_at
         delayed_cancel_at
         coupon_code
         snap_day
@@ -560,6 +565,7 @@ module AdvancedBilling
         receives_invoice_emails
         locale
         scheduled_cancellation_at
+        prepaid_configuration
       ]
     end
 
@@ -588,7 +594,7 @@ module AdvancedBilling
                    delayed_cancel_at = SKIP,
                    coupon_code = SKIP,
                    snap_day = SKIP,
-                   payment_collection_method = CollectionMethod::AUTOMATIC,
+                   payment_collection_method = SKIP,
                    customer = SKIP,
                    product = SKIP,
                    credit_card = SKIP,
@@ -807,13 +813,11 @@ module AdvancedBilling
       coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
       snap_day = hash.key?('snap_day') ? hash['snap_day'] : SKIP
       payment_collection_method =
-        hash['payment_collection_method'] ||= CollectionMethod::AUTOMATIC
+        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
       customer = Customer.from_hash(hash['customer']) if hash['customer']
       product = Product.from_hash(hash['product']) if hash['product']
       credit_card = CreditCardPaymentProfile.from_hash(hash['credit_card']) if hash['credit_card']
-      group = hash.key?('group') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:SubscriptionGroup2), hash['group']
-      ) : SKIP
+      group = NestedSubscriptionGroup.from_hash(hash['group']) if hash['group']
       bank_account = BankAccountPaymentProfile.from_hash(hash['bank_account']) if
         hash['bank_account']
       payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
@@ -1010,15 +1014,5 @@ module AdvancedBilling
     def to_custom_scheduled_cancellation_at
       DateTimeHelper.to_rfc3339(scheduled_cancellation_at)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [Subscription | 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/subscription_component.rb

@@ -110,7 +110,7 @@ module AdvancedBilling
     # The type of credit to be created when upgrading/downgrading. Defaults to
     # the component and then site setting if one is not provided.
     # Available values: `full`, `prorated`, `none`.
-    # @return [Object]
+    # @return [PricePointType]
     attr_accessor :price_point_type
 
     # The type of credit to be created when upgrading/downgrading. Defaults to
@@ -166,6 +166,11 @@ module AdvancedBilling
     # @return [SubscriptionComponentSubscription]
     attr_accessor :subscription
 
+    # An optional object, will be returned if provided `include=subscription`
+    # query param.
+    # @return [Array[HistoricUsage]]
+    attr_accessor :historic_usages
+
     # An optional object, will be returned if provided `include=subscription`
     # query param.
     # @return [TrueClass | FalseClass]
@@ -215,6 +220,7 @@ module AdvancedBilling
       @_hash['description'] = 'description'
       @_hash['allow_fractional_quantities'] = 'allow_fractional_quantities'
       @_hash['subscription'] = 'subscription'
+      @_hash['historic_usages'] = 'historic_usages'
       @_hash['display_on_hosted_page'] = 'display_on_hosted_page'
       @_hash['interval'] = 'interval'
       @_hash['interval_unit'] = 'interval_unit'
@@ -252,6 +258,7 @@ module AdvancedBilling
         description
         allow_fractional_quantities
         subscription
+        historic_usages
         display_on_hosted_page
         interval
         interval_unit
@@ -268,6 +275,7 @@ module AdvancedBilling
         archived_at
         price_point_id
         price_point_handle
+        price_point_type
         price_point_name
         use_site_exchange_rate
         description
@@ -302,6 +310,7 @@ module AdvancedBilling
                    description = SKIP,
                    allow_fractional_quantities = SKIP,
                    subscription = SKIP,
+                   historic_usages = SKIP,
                    display_on_hosted_page = SKIP,
                    interval = SKIP,
                    interval_unit = SKIP,
@@ -337,6 +346,7 @@ module AdvancedBilling
           allow_fractional_quantities
       end
       @subscription = subscription unless subscription == SKIP
+      @historic_usages = historic_usages unless historic_usages == SKIP
       @display_on_hosted_page = display_on_hosted_page unless display_on_hosted_page == SKIP
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless interval_unit == SKIP
@@ -362,9 +372,8 @@ module AdvancedBilling
       allocated_quantity = hash.key?('allocated_quantity') ? APIHelper.deserialize_union_type(
         UnionTypeLookUp.get(:SubscriptionComponentAllocatedQuantity), hash['allocated_quantity']
       ) : SKIP
-      pricing_scheme = hash.key?('pricing_scheme') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:SubscriptionComponentPricingScheme), hash['pricing_scheme']
-      ) : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : SKIP
       component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
       component_handle =
         hash.key?('component_handle') ? hash['component_handle'] : SKIP
@@ -384,9 +393,8 @@ module AdvancedBilling
         hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
       price_point_handle =
         hash.key?('price_point_handle') ? hash['price_point_handle'] : SKIP
-      price_point_type = hash.key?('price_point_type') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:SubscriptionComponentPricePointType), hash['price_point_type']
-      ) : SKIP
+      price_point_type =
+        hash.key?('price_point_type') ? hash['price_point_type'] : SKIP
       price_point_name =
         hash.key?('price_point_name') ? hash['price_point_name'] : SKIP
       product_family_id =
@@ -410,6 +418,16 @@ module AdvancedBilling
         hash.key?('allow_fractional_quantities') ? hash['allow_fractional_quantities'] : SKIP
       subscription = SubscriptionComponentSubscription.from_hash(hash['subscription']) if
         hash['subscription']
+      # Parameter is an array, so we need to iterate through it
+      historic_usages = nil
+      unless hash['historic_usages'].nil?
+        historic_usages = []
+        hash['historic_usages'].each do |structure|
+          historic_usages << (HistoricUsage.from_hash(structure) if structure)
+        end
+      end
+
+      historic_usages = SKIP unless hash.key?('historic_usages')
       display_on_hosted_page =
         hash.key?('display_on_hosted_page') ? hash['display_on_hosted_page'] : SKIP
       interval = hash.key?('interval') ? hash['interval'] : SKIP
@@ -447,6 +465,7 @@ module AdvancedBilling
                                 description,
                                 allow_fractional_quantities,
                                 subscription,
+                                historic_usages,
                                 display_on_hosted_page,
                                 interval,
                                 interval_unit,

data/lib/advanced_billing/models/subscription_component_subscription.rb

@@ -212,5 +212,15 @@ module AdvancedBilling
     def to_custom_updated_at
       DateTimeHelper.to_rfc3339(updated_at)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionComponentSubscription | 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