maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/list_segments_filter.rb

@@ -0,0 +1,103 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSegmentsFilter Model.
+  class ListSegmentsFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value passed here would be used to filter segments. Pass a value
+    # related to `segment_property_1` on attached Metric. If empty string is
+    # passed, this filter would be rejected. Use in query
+    # `filter[segment_property_1_value]=EU`.
+    # @return [String]
+    attr_accessor :segment_property_1_value
+
+    # The value passed here would be used to filter segments. Pass a value
+    # related to `segment_property_2` on attached Metric. If empty string is
+    # passed, this filter would be rejected.
+    # @return [String]
+    attr_accessor :segment_property_2_value
+
+    # The value passed here would be used to filter segments. Pass a value
+    # related to `segment_property_3` on attached Metric. If empty string is
+    # passed, this filter would be rejected.
+    # @return [String]
+    attr_accessor :segment_property_3_value
+
+    # The value passed here would be used to filter segments. Pass a value
+    # related to `segment_property_4` on attached Metric. If empty string is
+    # passed, this filter would be rejected.
+    # @return [String]
+    attr_accessor :segment_property_4_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['segment_property_1_value'] = 'segment_property_1_value'
+      @_hash['segment_property_2_value'] = 'segment_property_2_value'
+      @_hash['segment_property_3_value'] = 'segment_property_3_value'
+      @_hash['segment_property_4_value'] = 'segment_property_4_value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        segment_property_1_value
+        segment_property_2_value
+        segment_property_3_value
+        segment_property_4_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(segment_property_1_value = SKIP,
+                   segment_property_2_value = SKIP,
+                   segment_property_3_value = SKIP,
+                   segment_property_4_value = SKIP,
+                   additional_properties = {})
+      @segment_property_1_value = segment_property_1_value unless segment_property_1_value == SKIP
+      @segment_property_2_value = segment_property_2_value unless segment_property_2_value == SKIP
+      @segment_property_3_value = segment_property_3_value unless segment_property_3_value == SKIP
+      @segment_property_4_value = segment_property_4_value unless segment_property_4_value == 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.
+      segment_property_1_value =
+        hash.key?('segment_property_1_value') ? hash['segment_property_1_value'] : SKIP
+      segment_property_2_value =
+        hash.key?('segment_property_2_value') ? hash['segment_property_2_value'] : SKIP
+      segment_property_3_value =
+        hash.key?('segment_property_3_value') ? hash['segment_property_3_value'] : SKIP
+      segment_property_4_value =
+        hash.key?('segment_property_4_value') ? hash['segment_property_4_value'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListSegmentsFilter.new(segment_property_1_value,
+                             segment_property_2_value,
+                             segment_property_3_value,
+                             segment_property_4_value,
+                             hash)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_components_filter.rb

@@ -0,0 +1,74 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionComponentsFilter Model.
+  class ListSubscriptionComponentsFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allows fetching components allocation with matching currency based on
+    # provided values. Use in query `filter[currencies]=EUR,USD`.
+    # @return [Array[String]]
+    attr_accessor :currencies
+
+    # Allows fetching components allocation with matching use_site_exchange_rate
+    # based on provided value. Use in query
+    # `filter[use_site_exchange_rate]=true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currencies'] = 'currencies'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currencies
+        use_site_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currencies = SKIP,
+                   use_site_exchange_rate = SKIP,
+                   additional_properties = {})
+      @currencies = currencies unless currencies == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == 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.
+      currencies = hash.key?('currencies') ? hash['currencies'] : SKIP
+      use_site_exchange_rate =
+        hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListSubscriptionComponentsFilter.new(currencies,
+                                           use_site_exchange_rate,
+                                           hash)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_components_for_site_filter.rb

@@ -0,0 +1,84 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionComponentsForSiteFilter Model.
+  class ListSubscriptionComponentsForSiteFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allows fetching components allocation with matching currency based on
+    # provided values. Use in query `filter[currencies]=USD,EUR`.
+    # @return [Array[String]]
+    attr_accessor :currencies
+
+    # Allows fetching components allocation with matching use_site_exchange_rate
+    # based on provided value. Use in query
+    # `filter[use_site_exchange_rate]=true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # Nested filter used for List Subscription Components For Site Filter
+    # @return [SubscriptionFilter]
+    attr_accessor :subscription
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currencies'] = 'currencies'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash['subscription'] = 'subscription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currencies
+        use_site_exchange_rate
+        subscription
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currencies = SKIP,
+                   use_site_exchange_rate = SKIP,
+                   subscription = SKIP,
+                   additional_properties = {})
+      @currencies = currencies unless currencies == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+      @subscription = subscription unless subscription == 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.
+      currencies = hash.key?('currencies') ? hash['currencies'] : SKIP
+      use_site_exchange_rate =
+        hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+      subscription = SubscriptionFilter.from_hash(hash['subscription']) if hash['subscription']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListSubscriptionComponentsForSiteFilter.new(currencies,
+                                                  use_site_exchange_rate,
+                                                  subscription,
+                                                  hash)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_components_include.rb

@@ -8,7 +8,10 @@ module AdvancedBilling
   class ListSubscriptionComponentsInclude
     LIST_SUBSCRIPTION_COMPONENTS_INCLUDE = [
       # TODO: Write general description for SUBSCRIPTION
-      SUBSCRIPTION = 'subscription'.freeze
+      SUBSCRIPTION = 'subscription'.freeze,
+
+      # TODO: Write general description for HISTORIC_USAGES
+      HISTORIC_USAGES = 'historic_usages'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/advanced_billing/models/metafield_scope.rb

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

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

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

@@ -79,5 +79,19 @@ module AdvancedBilling
                          prices,
                          hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [OveragePricing | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.pricing_scheme,
+                                     ->(val) { PricingScheme.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['pricing_scheme'],
+                            ->(val) { PricingScheme.validate(val) })
+    end
   end
 end

data/lib/advanced_billing/models/paid_invoice.rb

@@ -14,8 +14,8 @@ module AdvancedBilling
     attr_accessor :invoice_id
 
     # The current status of the invoice. See [Invoice
-    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
-    # e-item-breakdowns) for more.
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statuses) for more.
     # @return [InvoiceStatus]
     attr_accessor :status
 

data/lib/advanced_billing/models/payer_attributes.rb

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

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

@@ -0,0 +1,56 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PrepaidProductPricePointFilter Model.
+  class PrepaidProductPricePointFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Passed as a parameter to list methods to return only non null values.
+    # @return [String]
+    attr_reader :product_price_point_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_properties = {})
+      @product_price_point_id = 'not_null'
+
+      # 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.
+
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      PrepaidProductPricePointFilter.new(hash)
+    end
+  end
+end

data/lib/advanced_billing/models/prepaid_usage.rb

@@ -177,7 +177,9 @@ module AdvancedBilling
             APIHelper.valid_type?(value.memo,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.allocation_details,
-                                  ->(val) { PrepaidUsageAllocationDetail.validate(val) })
+                                  ->(val) { PrepaidUsageAllocationDetail.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
         )
       end
 
@@ -203,7 +205,9 @@ module AdvancedBilling
           APIHelper.valid_type?(value['memo'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['allocation_details'],
-                                ->(val) { PrepaidUsageAllocationDetail.validate(val) })
+                                ->(val) { PrepaidUsageAllocationDetail.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/prepaid_usage_allocation_detail.rb

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

@@ -301,6 +301,7 @@ module AdvancedBilling
         archived_at
         return_params
         update_return_url
+        initial_charge_after_trial
         update_return_params
         tax_code
         use_site_exchange_rate
@@ -415,9 +416,8 @@ module AdvancedBilling
         hash.key?('request_credit_card') ? hash['request_credit_card'] : SKIP
       expiration_interval =
         hash.key?('expiration_interval') ? hash['expiration_interval'] : SKIP
-      expiration_interval_unit = hash.key?('expiration_interval_unit') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:ProductExpirationIntervalUnit), hash['expiration_interval_unit']
-      ) : SKIP
+      expiration_interval_unit =
+        hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : SKIP
       created_at = if hash.key?('created_at')
                      (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
                    else
@@ -438,9 +438,8 @@ module AdvancedBilling
         hash.key?('trial_price_in_cents') ? hash['trial_price_in_cents'] : SKIP
       trial_interval =
         hash.key?('trial_interval') ? hash['trial_interval'] : SKIP
-      trial_interval_unit = hash.key?('trial_interval_unit') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:ProductTrialIntervalUnit), hash['trial_interval_unit']
-      ) : SKIP
+      trial_interval_unit =
+        hash.key?('trial_interval_unit') ? hash['trial_interval_unit'] : SKIP
       archived_at = if hash.key?('archived_at')
                       (DateTimeHelper.from_rfc3339(hash['archived_at']) if hash['archived_at'])
                     else
@@ -543,15 +542,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 [Product | 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/product_price_point.rb

@@ -184,6 +184,15 @@ module AdvancedBilling
     # An array for nullable fields
     def self.nullables
       %w[
+        handle
+        trial_price_in_cents
+        trial_interval
+        trial_interval_unit
+        introductory_offer
+        initial_charge_in_cents
+        initial_charge_after_trial
+        expiration_interval
+        expiration_interval_unit
         archived_at
         subscription_id
       ]

data/lib/advanced_billing/models/proforma_invoice.rb

@@ -321,7 +321,7 @@ module AdvancedBilling
                    created_at = SKIP,
                    delivery_date = SKIP,
                    status = SKIP,
-                   collection_method = CollectionMethod::AUTOMATIC,
+                   collection_method = SKIP,
                    payment_instructions = SKIP,
                    currency = SKIP,
                    consolidation_level = SKIP,
@@ -413,7 +413,7 @@ module AdvancedBilling
       delivery_date = hash.key?('delivery_date') ? hash['delivery_date'] : SKIP
       status = hash.key?('status') ? hash['status'] : SKIP
       collection_method =
-        hash['collection_method'] ||= CollectionMethod::AUTOMATIC
+        hash.key?('collection_method') ? hash['collection_method'] : SKIP
       payment_instructions =
         hash.key?('payment_instructions') ? hash['payment_instructions'] : SKIP
       currency = hash.key?('currency') ? hash['currency'] : SKIP

data/lib/advanced_billing/models/proforma_invoice_issued.rb

@@ -187,7 +187,9 @@ module AdvancedBilling
             APIHelper.valid_type?(value.product_name,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.line_items,
-                                  ->(val) { InvoiceLineItemEventData.validate(val) })
+                                  ->(val) { InvoiceLineItemEventData.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
         )
       end
 
@@ -215,7 +217,9 @@ module AdvancedBilling
           APIHelper.valid_type?(value['product_name'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['line_items'],
-                                ->(val) { InvoiceLineItemEventData.validate(val) })
+                                ->(val) { InvoiceLineItemEventData.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/reactivation_billing.rb

@@ -62,5 +62,15 @@ module AdvancedBilling
       ReactivationBilling.new(reactivation_charge,
                               hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReactivationBilling | 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/record_payment_response.rb

@@ -67,9 +67,7 @@ module AdvancedBilling
       end
 
       paid_invoices = SKIP unless hash.key?('paid_invoices')
-      prepayment = hash.key?('prepayment') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:RecordPaymentResponsePrepayment), hash['prepayment']
-      ) : SKIP
+      prepayment = InvoicePrePayment.from_hash(hash['prepayment']) if hash['prepayment']
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -79,15 +77,5 @@ module AdvancedBilling
                                 prepayment,
                                 hash)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [RecordPaymentResponse | 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