maxio-advanced-billing-sdk 5.1.0 → 6.0.0

data/lib/advanced_billing/models/ebb_component.rb

@@ -45,27 +45,17 @@ module AdvancedBilling
 
     # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
     # See [Price Bracket
-    # Rules](https://help.chargify.com/products/product-components.html#general-
-    # price-bracket-rules) for an overview of how price brackets work for
-    # different pricing schemes.
+    # Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Componen
+    # t-Pricing-Schemes#price-bracket-rules) for an overview of how price
+    # brackets work for different pricing schemes.
     # @return [Array[Price]]
     attr_accessor :prices
 
-    # 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 [CreditType]
-    attr_accessor :upgrade_charge
-
-    # 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 [CreditType]
-    attr_accessor :downgrade_credit
-
-    # 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`.
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Componen
+    # t-Pricing-Schemes#price-bracket-rules) for an overview of how price
+    # brackets work for different pricing schemes.
     # @return [Array[ComponentPricePointItem]]
     attr_accessor :price_points
 
@@ -87,10 +77,6 @@ module AdvancedBilling
     # @return [TrueClass | FalseClass]
     attr_accessor :hide_date_range_on_invoice
 
-    # deprecated May 2011 - use unit_price instead
-    # @return [String]
-    attr_accessor :price_in_cents
-
     # The ID of an event based billing metric that will be attached to this
     # component.
     # @return [Integer]
@@ -119,13 +105,10 @@ module AdvancedBilling
       @_hash['taxable'] = 'taxable'
       @_hash['pricing_scheme'] = 'pricing_scheme'
       @_hash['prices'] = 'prices'
-      @_hash['upgrade_charge'] = 'upgrade_charge'
-      @_hash['downgrade_credit'] = 'downgrade_credit'
       @_hash['price_points'] = 'price_points'
       @_hash['unit_price'] = 'unit_price'
       @_hash['tax_code'] = 'tax_code'
       @_hash['hide_date_range_on_invoice'] = 'hide_date_range_on_invoice'
-      @_hash['price_in_cents'] = 'price_in_cents'
       @_hash['event_based_billing_metric_id'] =
         'event_based_billing_metric_id'
       @_hash['interval'] = 'interval'
@@ -140,13 +123,10 @@ module AdvancedBilling
         handle
         taxable
         prices
-        upgrade_charge
-        downgrade_credit
         price_points
         unit_price
         tax_code
         hide_date_range_on_invoice
-        price_in_cents
         interval
         interval_unit
       ]
@@ -155,8 +135,6 @@ module AdvancedBilling
     # An array for nullable fields
     def self.nullables
       %w[
-        upgrade_charge
-        downgrade_credit
         interval_unit
       ]
     end
@@ -164,11 +142,14 @@ module AdvancedBilling
     def initialize(name:, unit_name:, pricing_scheme:,
                    event_based_billing_metric_id:, description: SKIP,
                    handle: SKIP, taxable: SKIP, prices: SKIP,
-                   upgrade_charge: SKIP, downgrade_credit: SKIP,
                    price_points: SKIP, unit_price: SKIP, tax_code: SKIP,
-                   hide_date_range_on_invoice: SKIP, price_in_cents: SKIP,
-                   interval: SKIP, interval_unit: SKIP,
-                   additional_properties: {})
+                   hide_date_range_on_invoice: SKIP, interval: SKIP,
+                   interval_unit: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @name = name
       @unit_name = unit_name
       @description = description unless description == SKIP
@@ -176,8 +157,6 @@ module AdvancedBilling
       @taxable = taxable unless taxable == SKIP
       @pricing_scheme = pricing_scheme
       @prices = prices unless prices == SKIP
-      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
-      @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
       @price_points = price_points unless price_points == SKIP
       @unit_price = unit_price unless unit_price == SKIP
       @tax_code = tax_code unless tax_code == SKIP
@@ -185,15 +164,9 @@ module AdvancedBilling
         @hide_date_range_on_invoice =
           hide_date_range_on_invoice
       end
-      @price_in_cents = price_in_cents unless price_in_cents == SKIP
       @event_based_billing_metric_id = event_based_billing_metric_id
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless interval_unit == 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.
@@ -220,10 +193,6 @@ module AdvancedBilling
       end
 
       prices = SKIP unless hash.key?('prices')
-      upgrade_charge =
-        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
-      downgrade_credit =
-        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
       # Parameter is an array, so we need to iterate through it
       price_points = nil
       unless hash['price_points'].nil?
@@ -240,13 +209,11 @@ module AdvancedBilling
       tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
       hide_date_range_on_invoice =
         hash.key?('hide_date_range_on_invoice') ? hash['hide_date_range_on_invoice'] : SKIP
-      price_in_cents =
-        hash.key?('price_in_cents') ? hash['price_in_cents'] : SKIP
       interval = hash.key?('interval') ? hash['interval'] : SKIP
       interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       EBBComponent.new(name: name,
@@ -257,16 +224,13 @@ module AdvancedBilling
                        handle: handle,
                        taxable: taxable,
                        prices: prices,
-                       upgrade_charge: upgrade_charge,
-                       downgrade_credit: downgrade_credit,
                        price_points: price_points,
                        unit_price: unit_price,
                        tax_code: tax_code,
                        hide_date_range_on_invoice: hide_date_range_on_invoice,
-                       price_in_cents: price_in_cents,
                        interval: interval,
                        interval_unit: interval_unit,
-                       additional_properties: hash)
+                       additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/ebb_event.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(chargify: SKIP, additional_properties: {})
-      @chargify = chargify unless chargify == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @chargify = chargify unless chargify == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       chargify = ChargifyEBB.from_hash(hash['chargify']) if hash['chargify']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       EBBEvent.new(chargify: chargify,
-                   additional_properties: hash)
+                   additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/enable_webhooks_request.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(webhooks_enabled:, additional_properties: {})
-      @webhooks_enabled = webhooks_enabled
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @webhooks_enabled = webhooks_enabled
     end
 
     # Creates an instance of the object from a hash.
@@ -48,11 +48,11 @@ module AdvancedBilling
         hash.key?('webhooks_enabled') ? hash['webhooks_enabled'] : nil
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       EnableWebhooksRequest.new(webhooks_enabled: webhooks_enabled,
-                                additional_properties: hash)
+                                additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/enable_webhooks_response.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(webhooks_enabled: SKIP, additional_properties: {})
-      @webhooks_enabled = webhooks_enabled unless webhooks_enabled == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @webhooks_enabled = webhooks_enabled unless webhooks_enabled == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -50,11 +50,11 @@ module AdvancedBilling
         hash.key?('webhooks_enabled') ? hash['webhooks_enabled'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       EnableWebhooksResponse.new(webhooks_enabled: webhooks_enabled,
-                                 additional_properties: hash)
+                                 additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/endpoint.rb

@@ -58,16 +58,16 @@ module AdvancedBilling
 
     def initialize(id: SKIP, url: SKIP, site_id: SKIP, status: SKIP,
                    webhook_subscriptions: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id unless id == SKIP
       @url = url unless url == SKIP
       @site_id = site_id unless site_id == SKIP
       @status = status unless status == SKIP
       @webhook_subscriptions = webhook_subscriptions unless webhook_subscriptions == 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.
@@ -83,7 +83,7 @@ module AdvancedBilling
         hash.key?('webhook_subscriptions') ? hash['webhook_subscriptions'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       Endpoint.new(id: id,
@@ -91,7 +91,7 @@ module AdvancedBilling
                    site_id: site_id,
                    status: status,
                    webhook_subscriptions: webhook_subscriptions,
-                   additional_properties: hash)
+                   additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/endpoint_response.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(endpoint: SKIP, additional_properties: {})
-      @endpoint = endpoint unless endpoint == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @endpoint = endpoint unless endpoint == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       endpoint = Endpoint.from_hash(hash['endpoint']) if hash['endpoint']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       EndpointResponse.new(endpoint: endpoint,
-                           additional_properties: hash)
+                           additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/errors.rb

@@ -39,13 +39,13 @@ module AdvancedBilling
     end
 
     def initialize(per_page: SKIP, price_point: SKIP, additional_properties: {})
-      @per_page = per_page unless per_page == SKIP
-      @price_point = price_point unless price_point == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @per_page = per_page unless per_page == SKIP
+      @price_point = price_point unless price_point == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -57,12 +57,12 @@ module AdvancedBilling
       price_point = hash.key?('price_point') ? hash['price_point'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       Errors.new(per_page: per_page,
                  price_point: price_point,
-                 additional_properties: hash)
+                 additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/event.rb

@@ -15,7 +15,7 @@ module AdvancedBilling
     attr_accessor :id
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [EventKey]
     attr_accessor :key
 
     # TODO: Write general description for this method
@@ -34,7 +34,67 @@ module AdvancedBilling
     # @return [DateTime]
     attr_accessor :created_at
 
-    # TODO: Write general description for this method
+    # The schema varies based on the event key. The key-to-event data mapping is
+    # as follows:
+    # * `subscription_product_change` - SubscriptionProductChange
+    # * `subscription_state_change` - SubscriptionStateChange
+    # * `signup_success`, `delayed_signup_creation_success`, `payment_success`,
+    # `payment_failure`, `renewal_success`, `renewal_failure`,
+    # `chargeback_lost`, `chargeback_accepted`, `chargeback_closed` -
+    # PaymentRelatedEvents
+    # * `refund_success` - RefundSuccess
+    # * `component_allocation_change` - ComponentAllocationChange
+    # * `metered_usage` - MeteredUsage
+    # * `prepaid_usage` - PrepaidUsage
+    # * `dunning_step_reached` - DunningStepReached
+    # * `invoice_issued` - InvoiceIssued
+    # * `pending_cancellation_change` - PendingCancellationChange
+    # * `prepaid_subscription_balance_changed` -
+    # PrepaidSubscriptionBalanceChanged
+    # * `subscription_group_signup_success` and
+    # `subscription_group_signup_failure` - SubscriptionGroupSignupEventData
+    # * `proforma_invoice_issued` - ProformaInvoiceIssued
+    # * `subscription_prepayment_account_balance_changed` -
+    # PrepaymentAccountBalanceChanged
+    # * `payment_collection_method_changed` - PaymentCollectionMethodChanged
+    # * `subscription_service_credit_account_balance_changed` -
+    # CreditAccountBalanceChanged
+    # * `item_price_point_changed` - ItemPricePointChanged
+    # * `custom_field_value_change` - CustomFieldValueChange
+    # * The rest, that is `delayed_signup_creation_failure`,
+    # `billing_date_change`, `expiration_date_change`, `expiring_card`, 
+    # `customer_update`, `customer_create`, `customer_delete`,
+    # `upgrade_downgrade_success`, `upgrade_downgrade_failure`, 
+    # `statement_closed`, `statement_settled`, `subscription_card_update`,
+    # `subscription_group_card_update`, 
+    # `subscription_bank_account_update`, `refund_failure`,
+    # `upcoming_renewal_notice`, `trial_end_notice`, 
+    # `direct_debit_payment_paid_out`, `direct_debit_payment_rejected`,
+    # `direct_debit_payment_pending`, `pending_payment_created`, 
+    # `pending_payment_failed`, `pending_payment_completed`,  don't have
+    # event_specific_data defined,
+    # `renewal_success_recreated`, `renewal_failure_recreated`,
+    # `payment_success_recreated`, `payment_failure_recreated`,
+    # `subscription_deletion`, `subscription_group_bank_account_update`,
+    # `subscription_paypal_account_update`,
+    # `subscription_group_paypal_account_update`,
+    # `subscription_customer_change`, `account_transaction_changed`,
+    # `go_cardless_payment_paid_out`, `go_cardless_payment_rejected`,
+    # `go_cardless_payment_pending`, `stripe_direct_debit_payment_paid_out`,
+    # `stripe_direct_debit_payment_rejected`,
+    # `stripe_direct_debit_payment_pending`,
+    # `maxio_payments_direct_debit_payment_paid_out`,
+    # `maxio_payments_direct_debit_payment_rejected`,
+    # `maxio_payments_direct_debit_payment_pending`,
+    # `invoice_in_collections_canceled`, `subscription_added_to_group`,
+    # `subscription_removed_from_group`, `chargeback_opened`, `chargeback_lost`,
+    # `chargeback_accepted`, `chargeback_closed`, `chargeback_won`,
+    # `payment_collection_method_changed`, `component_billing_date_changed`,
+    # `subscription_term_renewal_scheduled`,
+    # `subscription_term_renewal_pending`,
+    # `subscription_term_renewal_activated`, `subscription_term_renewal_removed`
+    # 
+    # they map to `null` instead.
     # @return [Object]
     attr_accessor :event_specific_data
 
@@ -67,6 +127,11 @@ module AdvancedBilling
 
     def initialize(id:, key:, message:, subscription_id:, customer_id:,
                    created_at:, event_specific_data:, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id
       @key = key
       @message = message
@@ -74,11 +139,6 @@ module AdvancedBilling
       @customer_id = customer_id
       @created_at = created_at
       @event_specific_data = event_specific_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.
@@ -100,7 +160,7 @@ module AdvancedBilling
       ) : nil
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       Event.new(id: id,
@@ -110,7 +170,7 @@ module AdvancedBilling
                 customer_id: customer_id,
                 created_at: created_at,
                 event_specific_data: event_specific_data,
-                additional_properties: hash)
+                additional_properties: additional_properties)
     end
 
     def to_custom_created_at
@@ -125,7 +185,7 @@ module AdvancedBilling
           APIHelper.valid_type?(value.id,
                                 ->(val) { val.instance_of? Integer }) and
             APIHelper.valid_type?(value.key,
-                                  ->(val) { val.instance_of? String }) and
+                                  ->(val) { EventKey.validate(val) }) and
             APIHelper.valid_type?(value.message,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.subscription_id,
@@ -145,7 +205,7 @@ module AdvancedBilling
         APIHelper.valid_type?(value['id'],
                               ->(val) { val.instance_of? Integer }) and
           APIHelper.valid_type?(value['key'],
-                                ->(val) { val.instance_of? String }) and
+                                ->(val) { EventKey.validate(val) }) and
           APIHelper.valid_type?(value['message'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['subscription_id'],

data/lib/advanced_billing/models/event_based_billing_segment_error.rb

@@ -34,12 +34,12 @@ module AdvancedBilling
     end
 
     def initialize(segments:, additional_properties: {})
-      @segments = segments
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @segments = segments
     end
 
     # Creates an instance of the object from a hash.
@@ -50,11 +50,11 @@ module AdvancedBilling
       segments = hash.key?('segments') ? hash['segments'] : nil
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       EventBasedBillingSegmentError.new(segments: segments,
-                                        additional_properties: hash)
+                                        additional_properties: additional_properties)
     end
   end
 end