maxio-advanced-billing-sdk 7.0.0 → 8.0.0

data/lib/advanced_billing/models/create_usage.rb

@@ -26,11 +26,15 @@ module AdvancedBilling
 
     # This attribute is particularly useful when you need to align billing
     # events for different components on distinct schedules within a
-    # subscription. Please note this only works for site with Multifrequency
-    # enabled
+    # subscription. This only works for site with Multifrequency enabled.
     # @return [BillingSchedule]
     attr_accessor :billing_schedule
 
+    # Create or update custom pricing unique to the subscription. Used in place
+    # of `price_point_id`.
+    # @return [ComponentCustomPrice]
+    attr_accessor :custom_price
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -38,6 +42,7 @@ module AdvancedBilling
       @_hash['price_point_id'] = 'price_point_id'
       @_hash['memo'] = 'memo'
       @_hash['billing_schedule'] = 'billing_schedule'
+      @_hash['custom_price'] = 'custom_price'
       @_hash
     end
 
@@ -48,6 +53,7 @@ module AdvancedBilling
         price_point_id
         memo
         billing_schedule
+        custom_price
       ]
     end
 
@@ -57,7 +63,8 @@ module AdvancedBilling
     end
 
     def initialize(quantity: SKIP, price_point_id: SKIP, memo: SKIP,
-                   billing_schedule: SKIP, additional_properties: {})
+                   billing_schedule: SKIP, custom_price: SKIP,
+                   additional_properties: {})
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
@@ -67,6 +74,7 @@ module AdvancedBilling
       @price_point_id = price_point_id unless price_point_id == SKIP
       @memo = memo unless memo == SKIP
       @billing_schedule = billing_schedule unless billing_schedule == SKIP
+      @custom_price = custom_price unless custom_price == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -80,6 +88,7 @@ module AdvancedBilling
       memo = hash.key?('memo') ? hash['memo'] : SKIP
       billing_schedule = BillingSchedule.from_hash(hash['billing_schedule']) if
         hash['billing_schedule']
+      custom_price = ComponentCustomPrice.from_hash(hash['custom_price']) if hash['custom_price']
 
       # Clean out expected properties from Hash.
       additional_properties = hash.reject { |k, _| names.value?(k) }
@@ -89,6 +98,7 @@ module AdvancedBilling
                       price_point_id: price_point_id,
                       memo: memo,
                       billing_schedule: billing_schedule,
+                      custom_price: custom_price,
                       additional_properties: additional_properties)
     end
 
@@ -96,16 +106,16 @@ module AdvancedBilling
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} quantity: #{@quantity}, price_point_id: #{@price_point_id}, memo: #{@memo},"\
-      " billing_schedule: #{@billing_schedule}, additional_properties:"\
-      " #{get_additional_properties}>"
+      " billing_schedule: #{@billing_schedule}, custom_price: #{@custom_price},"\
+      " additional_properties: #{get_additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
       "<#{class_name} quantity: #{@quantity.inspect}, price_point_id: #{@price_point_id.inspect},"\
-      " memo: #{@memo.inspect}, billing_schedule: #{@billing_schedule.inspect},"\
-      " additional_properties: #{get_additional_properties}>"
+      " memo: #{@memo.inspect}, billing_schedule: #{@billing_schedule.inspect}, custom_price:"\
+      " #{@custom_price.inspect}, additional_properties: #{get_additional_properties}>"
     end
   end
 end

data/lib/advanced_billing/models/credit_card_vault.rb

@@ -113,5 +113,49 @@ module AdvancedBilling
 
       CREDIT_CARD_VAULT.include?(value)
     end
+
+    def self.from_value(value, default_value = ADYEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'adyen' then ADYEN
+      when 'authorizenet' then AUTHORIZENET
+      when 'beanstream' then BEANSTREAM
+      when 'blue_snap' then BLUE_SNAP
+      when 'bogus' then BOGUS
+      when 'braintree1' then BRAINTREE1
+      when 'braintree_blue' then BRAINTREE_BLUE
+      when 'checkout' then CHECKOUT
+      when 'cybersource' then CYBERSOURCE
+      when 'elavon' then ELAVON
+      when 'eway' then EWAY
+      when 'eway_rapid' then EWAY_RAPID
+      when 'eway_rapid_std' then EWAY_RAPID_STD
+      when 'firstdata' then FIRSTDATA
+      when 'forte' then FORTE
+      when 'litle' then LITLE
+      when 'maxio_payments' then MAXIO_PAYMENTS
+      when 'maxp' then MAXP
+      when 'moduslink' then MODUSLINK
+      when 'moneris' then MONERIS
+      when 'nmi' then NMI
+      when 'orbital' then ORBITAL
+      when 'payment_express' then PAYMENT_EXPRESS
+      when 'paymill' then PAYMILL
+      when 'paypal' then PAYPAL
+      when 'paypal_complete' then PAYPAL_COMPLETE
+      when 'pin' then PIN
+      when 'square' then SQUARE
+      when 'stripe' then STRIPE
+      when 'stripe_connect' then STRIPE_CONNECT
+      when 'trust_commerce' then TRUST_COMMERCE
+      when 'unipaas' then UNIPAAS
+      when 'wirecard' then WIRECARD
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/credit_note_status.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       CREDIT_NOTE_STATUS.include?(value)
     end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'applied' then APPLIED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/credit_scheme.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       CREDIT_SCHEME.include?(value)
     end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'credit' then CREDIT
+      when 'refund' then REFUND
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/credit_type.rb

@@ -24,5 +24,19 @@ module AdvancedBilling
 
       CREDIT_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = FULL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'full' then FULL
+      when 'prorated' then PRORATED
+      when 'none' then NONE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/currency_price_role.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       CURRENCY_PRICE_ROLE.include?(value)
     end
+
+    def self.from_value(value, default_value = BASELINE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'baseline' then BASELINE
+      when 'trial' then TRIAL
+      when 'initial' then INITIAL
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/custom_field_owner.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       CUSTOM_FIELD_OWNER.include?(value)
     end
+
+    def self.from_value(value, default_value = CUSTOMER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'customer' then CUSTOMER
+      when 'subscription' then SUBSCRIPTION
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/debit_note_role.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       DEBIT_NOTE_ROLE.include?(value)
     end
+
+    def self.from_value(value, default_value = CHARGEBACK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'chargeback' then CHARGEBACK
+      when 'refund' then REFUND
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/debit_note_status.rb

@@ -25,5 +25,20 @@ module AdvancedBilling
 
       DEBIT_NOTE_STATUS.include?(value)
     end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'applied' then APPLIED
+      when 'banished' then BANISHED
+      when 'paid' then PAID
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/direction.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       DIRECTION.include?(value)
     end
+
+    def self.from_value(value, default_value = ASC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asc' then ASC
+      when 'desc' then DESC
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/discount_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       DISCOUNT_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = AMOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'amount' then AMOUNT
+      when 'percent' then PERCENT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/ebb_component.rb

@@ -66,8 +66,8 @@ module AdvancedBilling
     attr_accessor :unit_price
 
     # A string representing the tax code related to the component type. This is
-    # especially important when using the Avalara service to tax based on
-    # locale. This attribute has a max length of 10 characters.
+    # especially important when using AvaTax to tax based on locale. This
+    # attribute has a max length of 25 characters.
     # @return [String]
     attr_accessor :tax_code
 

data/lib/advanced_billing/models/event_key.rb

@@ -260,5 +260,96 @@ module AdvancedBilling
 
       EVENT_KEY.include?(value)
     end
+
+    def self.from_value(value, default_value = PAYMENT_SUCCESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payment_success' then PAYMENT_SUCCESS
+      when 'payment_failure' then PAYMENT_FAILURE
+      when 'signup_success' then SIGNUP_SUCCESS
+      when 'signup_failure' then SIGNUP_FAILURE
+      when 'delayed_signup_creation_success' then DELAYED_SIGNUP_CREATION_SUCCESS
+      when 'delayed_signup_creation_failure' then DELAYED_SIGNUP_CREATION_FAILURE
+      when 'billing_date_change' then BILLING_DATE_CHANGE
+      when 'expiration_date_change' then EXPIRATION_DATE_CHANGE
+      when 'renewal_success' then RENEWAL_SUCCESS
+      when 'renewal_failure' then RENEWAL_FAILURE
+      when 'subscription_state_change' then SUBSCRIPTION_STATE_CHANGE
+      when 'subscription_product_change' then SUBSCRIPTION_PRODUCT_CHANGE
+      when 'pending_cancellation_change' then PENDING_CANCELLATION_CHANGE
+      when 'expiring_card' then EXPIRING_CARD
+      when 'customer_update' then CUSTOMER_UPDATE
+      when 'customer_create' then CUSTOMER_CREATE
+      when 'customer_delete' then CUSTOMER_DELETE
+      when 'component_allocation_change' then COMPONENT_ALLOCATION_CHANGE
+      when 'metered_usage' then METERED_USAGE
+      when 'prepaid_usage' then PREPAID_USAGE
+      when 'upgrade_downgrade_success' then UPGRADE_DOWNGRADE_SUCCESS
+      when 'upgrade_downgrade_failure' then UPGRADE_DOWNGRADE_FAILURE
+      when 'statement_closed' then STATEMENT_CLOSED
+      when 'statement_settled' then STATEMENT_SETTLED
+      when 'subscription_card_update' then SUBSCRIPTION_CARD_UPDATE
+      when 'subscription_group_card_update' then SUBSCRIPTION_GROUP_CARD_UPDATE
+      when 'subscription_bank_account_update' then SUBSCRIPTION_BANK_ACCOUNT_UPDATE
+      when 'refund_success' then REFUND_SUCCESS
+      when 'refund_failure' then REFUND_FAILURE
+      when 'upcoming_renewal_notice' then UPCOMING_RENEWAL_NOTICE
+      when 'trial_end_notice' then TRIAL_END_NOTICE
+      when 'dunning_step_reached' then DUNNING_STEP_REACHED
+      when 'invoice_issued' then INVOICE_ISSUED
+      when 'prepaid_subscription_balance_changed' then PREPAID_SUBSCRIPTION_BALANCE_CHANGED
+      when 'subscription_group_signup_success' then SUBSCRIPTION_GROUP_SIGNUP_SUCCESS
+      when 'subscription_group_signup_failure' then SUBSCRIPTION_GROUP_SIGNUP_FAILURE
+      when 'direct_debit_payment_paid_out' then DIRECT_DEBIT_PAYMENT_PAID_OUT
+      when 'direct_debit_payment_rejected' then DIRECT_DEBIT_PAYMENT_REJECTED
+      when 'direct_debit_payment_pending' then DIRECT_DEBIT_PAYMENT_PENDING
+      when 'pending_payment_created' then PENDING_PAYMENT_CREATED
+      when 'pending_payment_failed' then PENDING_PAYMENT_FAILED
+      when 'pending_payment_completed' then PENDING_PAYMENT_COMPLETED
+      when 'proforma_invoice_issued' then PROFORMA_INVOICE_ISSUED
+      when 'subscription_prepayment_account_balance_changed' then SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED
+      when 'subscription_service_credit_account_balance_changed' then SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED
+      when 'custom_field_value_change' then CUSTOM_FIELD_VALUE_CHANGE
+      when 'item_price_point_changed' then ITEM_PRICE_POINT_CHANGED
+      when 'renewal_success_recreated' then RENEWAL_SUCCESS_RECREATED
+      when 'renewal_failure_recreated' then RENEWAL_FAILURE_RECREATED
+      when 'payment_success_recreated' then PAYMENT_SUCCESS_RECREATED
+      when 'payment_failure_recreated' then PAYMENT_FAILURE_RECREATED
+      when 'subscription_deletion' then SUBSCRIPTION_DELETION
+      when 'subscription_group_bank_account_update' then SUBSCRIPTION_GROUP_BANK_ACCOUNT_UPDATE
+      when 'subscription_paypal_account_update' then SUBSCRIPTION_PAYPAL_ACCOUNT_UPDATE
+      when 'subscription_group_paypal_account_update' then SUBSCRIPTION_GROUP_PAYPAL_ACCOUNT_UPDATE
+      when 'subscription_customer_change' then SUBSCRIPTION_CUSTOMER_CHANGE
+      when 'account_transaction_changed' then ACCOUNT_TRANSACTION_CHANGED
+      when 'go_cardless_payment_paid_out' then GO_CARDLESS_PAYMENT_PAID_OUT
+      when 'go_cardless_payment_rejected' then GO_CARDLESS_PAYMENT_REJECTED
+      when 'go_cardless_payment_pending' then GO_CARDLESS_PAYMENT_PENDING
+      when 'stripe_direct_debit_payment_paid_out' then STRIPE_DIRECT_DEBIT_PAYMENT_PAID_OUT
+      when 'stripe_direct_debit_payment_rejected' then STRIPE_DIRECT_DEBIT_PAYMENT_REJECTED
+      when 'stripe_direct_debit_payment_pending' then STRIPE_DIRECT_DEBIT_PAYMENT_PENDING
+      when 'maxio_payments_direct_debit_payment_paid_out' then MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_PAID_OUT
+      when 'maxio_payments_direct_debit_payment_rejected' then MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_REJECTED
+      when 'maxio_payments_direct_debit_payment_pending' then MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_PENDING
+      when 'invoice_in_collections_canceled' then INVOICE_IN_COLLECTIONS_CANCELED
+      when 'subscription_added_to_group' then SUBSCRIPTION_ADDED_TO_GROUP
+      when 'subscription_removed_from_group' then SUBSCRIPTION_REMOVED_FROM_GROUP
+      when 'chargeback_opened' then CHARGEBACK_OPENED
+      when 'chargeback_lost' then CHARGEBACK_LOST
+      when 'chargeback_accepted' then CHARGEBACK_ACCEPTED
+      when 'chargeback_closed' then CHARGEBACK_CLOSED
+      when 'chargeback_won' then CHARGEBACK_WON
+      when 'payment_collection_method_changed' then PAYMENT_COLLECTION_METHOD_CHANGED
+      when 'component_billing_date_changed' then COMPONENT_BILLING_DATE_CHANGED
+      when 'subscription_term_renewal_scheduled' then SUBSCRIPTION_TERM_RENEWAL_SCHEDULED
+      when 'subscription_term_renewal_pending' then SUBSCRIPTION_TERM_RENEWAL_PENDING
+      when 'subscription_term_renewal_activated' then SUBSCRIPTION_TERM_RENEWAL_ACTIVATED
+      when 'subscription_term_renewal_removed' then SUBSCRIPTION_TERM_RENEWAL_REMOVED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/expiration_interval_unit.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       EXPIRATION_INTERVAL_UNIT.include?(value)
     end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'month' then MONTH
+      when 'never' then NEVER
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/failed_payment_action.rb

@@ -33,5 +33,19 @@ module AdvancedBilling
 
       FAILED_PAYMENT_ACTION.include?(value)
     end
+
+    def self.from_value(value, default_value = LEAVE_OPEN_INVOICE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'leave_open_invoice' then LEAVE_OPEN_INVOICE
+      when 'rollback_to_pending' then ROLLBACK_TO_PENDING
+      when 'initiate_dunning' then INITIATE_DUNNING
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/first_charge_type.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       FIRST_CHARGE_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = PRORATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'prorated' then PRORATED
+      when 'immediate' then IMMEDIATE
+      when 'delayed' then DELAYED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/group_target_type.rb

@@ -28,5 +28,21 @@ module AdvancedBilling
 
       GROUP_TARGET_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = CUSTOMER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'customer' then CUSTOMER
+      when 'subscription' then SUBSCRIPTION
+      when 'enum_self' then ENUM_SELF
+      when 'parent' then PARENT
+      when 'eldest' then ELDEST
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/group_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       GROUP_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = SINGLE_CUSTOMER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'single_customer' then SINGLE_CUSTOMER
+      when 'multiple_customers' then MULTIPLE_CUSTOMERS
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/include_not_null.rb

@@ -16,5 +16,11 @@ module AdvancedBilling
 
       INCLUDE_NOT_NULL.include?(value)
     end
+
+    def self.from_value(value, default_value = NOT_NULL)
+      return default_value if value.nil?
+
+      default_value
+    end
   end
 end

data/lib/advanced_billing/models/include_null_or_not_null.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       INCLUDE_NULL_OR_NOT_NULL.include?(value)
     end
+
+    def self.from_value(value, default_value = NOT_NULL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'not_null' then NOT_NULL
+      when 'null' then NULL
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/include_option.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       INCLUDE_OPTION.include?(value)
     end
+
+    def self.from_value(value, default_value = EXCLUDE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'exclude' then EXCLUDE
+      when 'include' then INCLUDE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/interval_unit.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       INTERVAL_UNIT.include?(value)
     end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'month' then MONTH
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_consolidation_level.rb

@@ -30,5 +30,19 @@ module AdvancedBilling
 
       INVOICE_CONSOLIDATION_LEVEL.include?(value)
     end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'child' then CHILD
+      when 'parent' then PARENT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_date_field.rb

@@ -28,5 +28,21 @@ module AdvancedBilling
 
       INVOICE_DATE_FIELD.include?(value)
     end
+
+    def self.from_value(value, default_value = CREATED_AT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created_at' then CREATED_AT
+      when 'due_date' then DUE_DATE
+      when 'issue_date' then ISSUE_DATE
+      when 'updated_at' then UPDATED_AT
+      when 'paid_date' then PAID_DATE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_discount_source_type.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       INVOICE_DISCOUNT_SOURCE_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = COUPON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'coupon' then COUPON
+      when 'referral' then REFERRAL
+      when 'enum_ad_hoc_coupon' then ENUM_AD_HOC_COUPON
+      else
+        default_value
+      end
+    end
   end
 end