maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/subscription_filter.rb

@@ -0,0 +1,153 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Nested filter used for List Subscription Components For Site Filter
+  class SubscriptionFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allows fetching components allocations that belong to the subscription
+    # with matching states based on provided values. To use this filter you also
+    # have to include the following param in the request `include=subscription`.
+    # Use in query
+    # `filter[subscription][states]=active,canceled&include=subscription`.
+    # @return [Array[SubscriptionStateFilter]]
+    attr_accessor :states
+
+    # The type of filter you'd like to apply to your search. To use this filter
+    # you also have to include the following param in the request
+    # `include=subscription`.
+    # @return [SubscriptionListDateField]
+    attr_accessor :date_field
+
+    # The start date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns components that belong to the subscription with a timestamp at or
+    # after midnight (12:00:00 AM) in your site’s time zone on the date
+    # specified. To use this filter you also have to include the following param
+    # in the request `include=subscription`.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The end date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns components that belong to the subscription with a timestamp up to
+    # and including 11:59:59PM in your site’s time zone on the date specified.
+    # To use this filter you also have to include the following param in the
+    # request `include=subscription`.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter
+    # the date_field. Returns components that belong to the subscription with a
+    # timestamp at or after exact time provided in query. You can specify
+    # timezone in query - otherwise your site''s time zone will be used. If
+    # provided, this parameter will be used instead of start_date. To use this
+    # filter you also have to include the following param in the request
+    # `include=subscription`.
+    # @return [DateTime]
+    attr_accessor :start_datetime
+
+    # The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter
+    # the date_field. Returns components that belong to the subscription with a
+    # timestamp at or before exact time provided in query. You can specify
+    # timezone in query - otherwise your site''s time zone will be used. If
+    # provided, this parameter will be used instead of end_date. To use this
+    # filter you also have to include the following param in the request
+    # `include=subscription`.
+    # @return [DateTime]
+    attr_accessor :end_datetime
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['states'] = 'states'
+      @_hash['date_field'] = 'date_field'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['start_datetime'] = 'start_datetime'
+      @_hash['end_datetime'] = 'end_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        states
+        date_field
+        start_date
+        end_date
+        start_datetime
+        end_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(states = SKIP,
+                   date_field = SKIP,
+                   start_date = SKIP,
+                   end_date = SKIP,
+                   start_datetime = SKIP,
+                   end_datetime = SKIP,
+                   additional_properties = {})
+      @states = states unless states == SKIP
+      @date_field = date_field unless date_field == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @start_datetime = start_datetime unless start_datetime == SKIP
+      @end_datetime = end_datetime unless end_datetime == 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.
+      states = hash.key?('states') ? hash['states'] : SKIP
+      date_field = hash.key?('date_field') ? hash['date_field'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      start_datetime = if hash.key?('start_datetime')
+                         (DateTimeHelper.from_rfc3339(hash['start_datetime']) if hash['start_datetime'])
+                       else
+                         SKIP
+                       end
+      end_datetime = if hash.key?('end_datetime')
+                       (DateTimeHelper.from_rfc3339(hash['end_datetime']) if hash['end_datetime'])
+                     else
+                       SKIP
+                     end
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      SubscriptionFilter.new(states,
+                             date_field,
+                             start_date,
+                             end_date,
+                             start_datetime,
+                             end_datetime,
+                             hash)
+    end
+
+    def to_custom_start_datetime
+      DateTimeHelper.to_rfc3339(start_datetime)
+    end
+
+    def to_custom_end_datetime
+      DateTimeHelper.to_rfc3339(end_datetime)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group.rb

@@ -68,7 +68,7 @@ module AdvancedBilling
 
     def initialize(customer_id = SKIP,
                    payment_profile = SKIP,
-                   payment_collection_method = CollectionMethod::AUTOMATIC,
+                   payment_collection_method = SKIP,
                    subscription_ids = SKIP,
                    created_at = SKIP,
                    additional_properties = {})
@@ -96,7 +96,7 @@ module AdvancedBilling
       payment_profile = SubscriptionGroupPaymentProfile.from_hash(hash['payment_profile']) if
         hash['payment_profile']
       payment_collection_method =
-        hash['payment_collection_method'] ||= CollectionMethod::AUTOMATIC
+        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
       subscription_ids =
         hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP
       created_at = if hash.key?('created_at')

data/lib/advanced_billing/models/subscription_group_bank_account.rb

@@ -222,5 +222,15 @@ module AdvancedBilling
                                        gateway_handle,
                                        hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupBankAccount | 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_group_component_custom_price.rb

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

@@ -53,7 +53,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        memo
+      ]
     end
 
     def initialize(id = SKIP,

data/lib/advanced_billing/models/subscription_group_signup.rb

@@ -92,7 +92,7 @@ module AdvancedBilling
                    payment_profile_id = SKIP,
                    payer_id = SKIP,
                    payer_reference = SKIP,
-                   payment_collection_method = CollectionMethod::AUTOMATIC,
+                   payment_collection_method = SKIP,
                    payer_attributes = SKIP,
                    credit_card_attributes = SKIP,
                    bank_account_attributes = SKIP,
@@ -136,7 +136,7 @@ module AdvancedBilling
       payer_reference =
         hash.key?('payer_reference') ? hash['payer_reference'] : SKIP
       payment_collection_method =
-        hash['payment_collection_method'] ||= CollectionMethod::AUTOMATIC
+        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
       payer_attributes = PayerAttributes.from_hash(hash['payer_attributes']) if
         hash['payer_attributes']
       if hash['credit_card_attributes']

data/lib/advanced_billing/models/subscription_group_signup_failure.rb

@@ -74,7 +74,8 @@ module AdvancedBilling
       if value.instance_of? self
         return (
           APIHelper.valid_type?(value.subscription_group,
-                                ->(val) { SubscriptionGroupSignupFailureData.validate(val) }) and
+                                ->(val) { SubscriptionGroupSignupFailureData.validate(val) },
+                                is_model_hash: true) and
             APIHelper.valid_type?(value.customer,
                                   ->(val) { val.instance_of? String })
         )
@@ -84,7 +85,8 @@ module AdvancedBilling
 
       (
         APIHelper.valid_type?(value['subscription_group'],
-                              ->(val) { SubscriptionGroupSignupFailureData.validate(val) }) and
+                              ->(val) { SubscriptionGroupSignupFailureData.validate(val) },
+                              is_model_hash: true) and
           APIHelper.valid_type?(value['customer'],
                                 ->(val) { val.instance_of? String })
       )

data/lib/advanced_billing/models/subscription_group_signup_failure_data.rb

@@ -146,5 +146,15 @@ module AdvancedBilling
                                              subscriptions,
                                              hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupFailureData | 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_group_signup_item.rb

@@ -203,5 +203,15 @@ module AdvancedBilling
                                       metafields,
                                       hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupItem | 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_group_signup_response.rb

@@ -310,7 +310,7 @@ module AdvancedBilling
                    state = SKIP,
                    cancel_at_end_of_period = SKIP,
                    subscriptions = SKIP,
-                   payment_collection_method = CollectionMethod::AUTOMATIC,
+                   payment_collection_method = SKIP,
                    additional_properties = {})
       @uid = uid unless uid == SKIP
       @scheme = scheme unless scheme == SKIP
@@ -366,7 +366,7 @@ module AdvancedBilling
 
       subscriptions = SKIP unless hash.key?('subscriptions')
       payment_collection_method =
-        hash['payment_collection_method'] ||= CollectionMethod::AUTOMATIC
+        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }

data/lib/advanced_billing/models/subscription_group_signup_success.rb

@@ -72,9 +72,11 @@ module AdvancedBilling
       if value.instance_of? self
         return (
           APIHelper.valid_type?(value.subscription_group,
-                                ->(val) { SubscriptionGroupSignupSuccessData.validate(val) }) and
+                                ->(val) { SubscriptionGroupSignupSuccessData.validate(val) },
+                                is_model_hash: true) and
             APIHelper.valid_type?(value.customer,
-                                  ->(val) { Customer.validate(val) })
+                                  ->(val) { Customer.validate(val) },
+                                  is_model_hash: true)
         )
       end
 
@@ -82,9 +84,11 @@ module AdvancedBilling
 
       (
         APIHelper.valid_type?(value['subscription_group'],
-                              ->(val) { SubscriptionGroupSignupSuccessData.validate(val) }) and
+                              ->(val) { SubscriptionGroupSignupSuccessData.validate(val) },
+                              is_model_hash: true) and
           APIHelper.valid_type?(value['customer'],
-                                ->(val) { Customer.validate(val) })
+                                ->(val) { Customer.validate(val) },
+                                is_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/subscription_group_signup_success_data.rb

@@ -137,5 +137,55 @@ module AdvancedBilling
     def to_custom_next_assessment_at
       DateTimeHelper.to_rfc3339(next_assessment_at)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupSuccessData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.uid,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.scheme,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.customer_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.payment_profile_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.subscription_ids,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.primary_subscription_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.next_assessment_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.state,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.cancel_at_end_of_period,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['uid'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['scheme'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['customer_id'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['payment_profile_id'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['subscription_ids'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['primary_subscription_id'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['next_assessment_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['state'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['cancel_at_end_of_period'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      )
+    end
   end
 end

data/lib/advanced_billing/models/update_customer.rb

@@ -81,6 +81,11 @@ module AdvancedBilling
     # @return [Integer]
     attr_accessor :parent_id
 
+    # Is the customer verified to use ACH as a payment method. Available only on
+    # Authorize.Net gateway
+    # @return [TrueClass | FalseClass]
+    attr_accessor :verified
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -102,6 +107,7 @@ module AdvancedBilling
       @_hash['tax_exempt'] = 'tax_exempt'
       @_hash['tax_exempt_reason'] = 'tax_exempt_reason'
       @_hash['parent_id'] = 'parent_id'
+      @_hash['verified'] = 'verified'
       @_hash
     end
 
@@ -126,6 +132,7 @@ module AdvancedBilling
         tax_exempt
         tax_exempt_reason
         parent_id
+        verified
       ]
     end
 
@@ -133,6 +140,7 @@ module AdvancedBilling
     def self.nullables
       %w[
         parent_id
+        verified
       ]
     end
 
@@ -154,6 +162,7 @@ module AdvancedBilling
                    tax_exempt = SKIP,
                    tax_exempt_reason = SKIP,
                    parent_id = SKIP,
+                   verified = SKIP,
                    additional_properties = {})
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
@@ -173,6 +182,7 @@ module AdvancedBilling
       @tax_exempt = tax_exempt unless tax_exempt == SKIP
       @tax_exempt_reason = tax_exempt_reason unless tax_exempt_reason == SKIP
       @parent_id = parent_id unless parent_id == SKIP
+      @verified = verified unless verified == SKIP
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -204,6 +214,7 @@ module AdvancedBilling
       tax_exempt_reason =
         hash.key?('tax_exempt_reason') ? hash['tax_exempt_reason'] : SKIP
       parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+      verified = hash.key?('verified') ? hash['verified'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -227,6 +238,7 @@ module AdvancedBilling
                          tax_exempt,
                          tax_exempt_reason,
                          parent_id,
+                         verified,
                          hash)
     end
   end

data/lib/advanced_billing/models/update_subscription_component.rb

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

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

@@ -78,7 +78,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        memo
+      ]
     end
 
     def initialize(id = SKIP,

data/lib/advanced_billing/models/void_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
+  # VoidInvoiceEvent Model.
+  class VoidInvoiceEvent < 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 `void_invoice` event
+    # @return [VoidInvoiceEventData]
+    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::VOID_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::VOID_INVOICE
+      event_data = VoidInvoiceEventData.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.
+      VoidInvoiceEvent.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 [VoidInvoiceEvent | 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) { VoidInvoiceEventData.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) { VoidInvoiceEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end