maxio-advanced-billing-sdk 7.0.1 → 8.0.0

data/lib/advanced_billing/models/product_price_point.rb

@@ -52,9 +52,13 @@ module AdvancedBilling
     # @return [IntervalUnit]
     attr_accessor :trial_interval_unit
 
-    # A string representing the trial interval unit for this product price
-    # point, either month or day
-    # @return [String]
+    # Indicates how a trial is handled when the trail period ends and there is
+    # no credit card on file. For `no_obligation`, the subscription transitions
+    # to a Trial Ended state. Maxio will not send any emails or statements. For
+    # `payment_expected`, the subscription transitions to a Past Due state.
+    # Maxio will send normal dunning emails and statements according to your
+    # other settings.
+    # @return [TrialType]
     attr_accessor :trial_type
 
     # reserved for future use
@@ -188,6 +192,7 @@ module AdvancedBilling
         trial_price_in_cents
         trial_interval
         trial_interval_unit
+        trial_type
         introductory_offer
         initial_charge_in_cents
         initial_charge_after_trial

data/lib/advanced_billing/models/proforma_invoice_discount_source_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       PROFORMA_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
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/proforma_invoice_role.rb

@@ -26,5 +26,20 @@ module AdvancedBilling
 
       PROFORMA_INVOICE_ROLE.include?(value)
     end
+
+    def self.from_value(value, default_value = UNSET)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unset' then UNSET
+      when 'proforma' then PROFORMA
+      when 'proforma_adhoc' then PROFORMA_ADHOC
+      when 'proforma_automatic' then PROFORMA_AUTOMATIC
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/proforma_invoice_status.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       PROFORMA_INVOICE_STATUS.include?(value)
     end
+
+    def self.from_value(value, default_value = DRAFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'draft' then DRAFT
+      when 'voided' then VOIDED
+      when 'archived' then ARCHIVED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/proforma_invoice_tax_source_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       PROFORMA_INVOICE_TAX_SOURCE_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = TAX)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'tax' then TAX
+      when 'avalara' then AVALARA
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/public_signup_page.rb

@@ -88,6 +88,16 @@ module AdvancedBilling
                            additional_properties: additional_properties)
     end
 
+    # Validates an instance of the object from a given value.
+    # @param [PublicSignupPage | 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
+
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last

data/lib/advanced_billing/models/quantity_based_component.rb

@@ -78,8 +78,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/reactivation_charge.rb

@@ -26,5 +26,19 @@ module AdvancedBilling
 
       REACTIVATION_CHARGE.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/recurring_scheme.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       RECURRING_SCHEME.include?(value)
     end
+
+    def self.from_value(value, default_value = DO_NOT_RECUR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'do_not_recur' then DO_NOT_RECUR
+      when 'recur_indefinitely' then RECUR_INDEFINITELY
+      when 'recur_with_duration' then RECUR_WITH_DURATION
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/resource_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       RESOURCE_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = SUBSCRIPTIONS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'subscriptions' then SUBSCRIPTIONS
+      when 'customers' then CUSTOMERS
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/restriction_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       RESTRICTION_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = COMPONENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'component' then COMPONENT
+      when 'product' then PRODUCT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/resume_options.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     private_constant :SKIP
 
     # Chargify will only attempt to resume the subscription's billing period. If
-    # not resumable, the subscription will be left in it's current state.
+    # not resumable, the subscription will be left in its current state.
     # @return [TrueClass | FalseClass]
     attr_accessor :require_resume
 

data/lib/advanced_billing/models/resumption_charge.rb

@@ -23,5 +23,19 @@ module AdvancedBilling
 
       RESUMPTION_CHARGE.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/service_credit_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       SERVICE_CREDIT_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/snap_day.rb

@@ -4,8 +4,7 @@
 # APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module AdvancedBilling
-  # Use for subscriptions with product eligible for calendar billing only. Value
-  # can be 1-28 or 'end'.
+  # SnapDay.
   class SnapDay
     SNAP_DAY = [
       # TODO: Write general description for ENUM_END
@@ -17,5 +16,11 @@ module AdvancedBilling
 
       SNAP_DAY.include?(value)
     end
+
+    def self.from_value(value, default_value = ENUM_END)
+      return default_value if value.nil?
+
+      default_value
+    end
   end
 end

data/lib/advanced_billing/models/sorting_direction.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       SORTING_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/subscription.rb

@@ -198,7 +198,7 @@ module AdvancedBilling
 
     # The day of the month that the subscription will charge according to
     # calendar billing rules, if used.
-    # @return [String]
+    # @return [Object]
     attr_accessor :snap_day
 
     # The type of payment collection to be used in the subscription. For legacy
@@ -295,7 +295,8 @@ module AdvancedBilling
     attr_accessor :payer_id
 
     # The balance in cents plus the estimated renewal amount in cents. Returned
-    # ONLY for readSubscription operation as it's compute intensive operation.
+    # ONLY for the readSubscription operation as it's a compute intensive
+    # operation.
     # @return [Integer]
     attr_accessor :current_billing_amount_in_cents
 
@@ -782,7 +783,9 @@ module AdvancedBilling
                             SKIP
                           end
       coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
-      snap_day = hash.key?('snap_day') ? hash['snap_day'] : SKIP
+      snap_day = hash.key?('snap_day') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionSnapDay), hash['snap_day']
+      ) : SKIP
       payment_collection_method =
         hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
       customer = Customer.from_hash(hash['customer']) if hash['customer']
@@ -986,6 +989,16 @@ module AdvancedBilling
       DateTimeHelper.to_rfc3339(scheduled_cancellation_at)
     end
 
+    # Validates an instance of the object from a given value.
+    # @param [Subscription | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last

data/lib/advanced_billing/models/subscription_custom_price.rb

@@ -42,6 +42,15 @@ module AdvancedBilling
     # @return [IntervalUnit]
     attr_accessor :trial_interval_unit
 
+    # Indicates how a trial is handled when the trail period ends and there is
+    # no credit card on file. For `no_obligation`, the subscription transitions
+    # to a Trial Ended state. Maxio will not send any emails or statements. For
+    # `payment_expected`, the subscription transitions to a Past Due state.
+    # Maxio will send normal dunning emails and statements according to your
+    # other settings.
+    # @return [TrialType]
+    attr_accessor :trial_type
+
     # (Optional)
     # @return [Object]
     attr_accessor :initial_charge_in_cents
@@ -73,6 +82,7 @@ module AdvancedBilling
       @_hash['trial_price_in_cents'] = 'trial_price_in_cents'
       @_hash['trial_interval'] = 'trial_interval'
       @_hash['trial_interval_unit'] = 'trial_interval_unit'
+      @_hash['trial_type'] = 'trial_type'
       @_hash['initial_charge_in_cents'] = 'initial_charge_in_cents'
       @_hash['initial_charge_after_trial'] = 'initial_charge_after_trial'
       @_hash['expiration_interval'] = 'expiration_interval'
@@ -89,6 +99,7 @@ module AdvancedBilling
         trial_price_in_cents
         trial_interval
         trial_interval_unit
+        trial_type
         initial_charge_in_cents
         initial_charge_after_trial
         expiration_interval
@@ -101,6 +112,7 @@ module AdvancedBilling
     def self.nullables
       %w[
         interval_unit
+        trial_type
         expiration_interval_unit
       ]
     end
@@ -108,7 +120,7 @@ module AdvancedBilling
     def initialize(price_in_cents:, interval:, interval_unit:, name: SKIP,
                    handle: SKIP, trial_price_in_cents: SKIP,
                    trial_interval: SKIP, trial_interval_unit: SKIP,
-                   initial_charge_in_cents: SKIP,
+                   trial_type: SKIP, initial_charge_in_cents: SKIP,
                    initial_charge_after_trial: SKIP, expiration_interval: SKIP,
                    expiration_interval_unit: SKIP, tax_included: SKIP,
                    additional_properties: {})
@@ -125,6 +137,7 @@ module AdvancedBilling
       @trial_price_in_cents = trial_price_in_cents unless trial_price_in_cents == SKIP
       @trial_interval = trial_interval unless trial_interval == SKIP
       @trial_interval_unit = trial_interval_unit unless trial_interval_unit == SKIP
+      @trial_type = trial_type unless trial_type == SKIP
       @initial_charge_in_cents = initial_charge_in_cents unless initial_charge_in_cents == SKIP
       unless initial_charge_after_trial == SKIP
         @initial_charge_after_trial =
@@ -157,6 +170,7 @@ module AdvancedBilling
       ) : SKIP
       trial_interval_unit =
         hash.key?('trial_interval_unit') ? hash['trial_interval_unit'] : SKIP
+      trial_type = hash.key?('trial_type') ? hash['trial_type'] : SKIP
       initial_charge_in_cents = hash.key?('initial_charge_in_cents') ? APIHelper.deserialize_union_type(
         UnionTypeLookUp.get(:SubscriptionCustomPriceInitialChargeInCents), hash['initial_charge_in_cents']
       ) : SKIP
@@ -181,6 +195,7 @@ module AdvancedBilling
                                   trial_price_in_cents: trial_price_in_cents,
                                   trial_interval: trial_interval,
                                   trial_interval_unit: trial_interval_unit,
+                                  trial_type: trial_type,
                                   initial_charge_in_cents: initial_charge_in_cents,
                                   initial_charge_after_trial: initial_charge_after_trial,
                                   expiration_interval: expiration_interval,
@@ -221,10 +236,11 @@ module AdvancedBilling
       "<#{class_name} name: #{@name}, handle: #{@handle}, price_in_cents: #{@price_in_cents},"\
       " interval: #{@interval}, interval_unit: #{@interval_unit}, trial_price_in_cents:"\
       " #{@trial_price_in_cents}, trial_interval: #{@trial_interval}, trial_interval_unit:"\
-      " #{@trial_interval_unit}, initial_charge_in_cents: #{@initial_charge_in_cents},"\
-      " initial_charge_after_trial: #{@initial_charge_after_trial}, expiration_interval:"\
-      " #{@expiration_interval}, expiration_interval_unit: #{@expiration_interval_unit},"\
-      " tax_included: #{@tax_included}, additional_properties: #{get_additional_properties}>"
+      " #{@trial_interval_unit}, trial_type: #{@trial_type}, initial_charge_in_cents:"\
+      " #{@initial_charge_in_cents}, initial_charge_after_trial: #{@initial_charge_after_trial},"\
+      " expiration_interval: #{@expiration_interval}, expiration_interval_unit:"\
+      " #{@expiration_interval_unit}, tax_included: #{@tax_included}, additional_properties:"\
+      " #{get_additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -234,8 +250,8 @@ module AdvancedBilling
       " #{@price_in_cents.inspect}, interval: #{@interval.inspect}, interval_unit:"\
       " #{@interval_unit.inspect}, trial_price_in_cents: #{@trial_price_in_cents.inspect},"\
       " trial_interval: #{@trial_interval.inspect}, trial_interval_unit:"\
-      " #{@trial_interval_unit.inspect}, initial_charge_in_cents:"\
-      " #{@initial_charge_in_cents.inspect}, initial_charge_after_trial:"\
+      " #{@trial_interval_unit.inspect}, trial_type: #{@trial_type.inspect},"\
+      " initial_charge_in_cents: #{@initial_charge_in_cents.inspect}, initial_charge_after_trial:"\
       " #{@initial_charge_after_trial.inspect}, expiration_interval:"\
       " #{@expiration_interval.inspect}, expiration_interval_unit:"\
       " #{@expiration_interval_unit.inspect}, tax_included: #{@tax_included.inspect},"\

data/lib/advanced_billing/models/subscription_date_field.rb

@@ -40,5 +40,25 @@ module AdvancedBilling
 
       SUBSCRIPTION_DATE_FIELD.include?(value)
     end
+
+    def self.from_value(value, default_value = CURRENT_PERIOD_ENDS_AT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'current_period_ends_at' then CURRENT_PERIOD_ENDS_AT
+      when 'current_period_starts_at' then CURRENT_PERIOD_STARTS_AT
+      when 'created_at' then CREATED_AT
+      when 'activated_at' then ACTIVATED_AT
+      when 'canceled_at' then CANCELED_AT
+      when 'expires_at' then EXPIRES_AT
+      when 'trial_started_at' then TRIAL_STARTED_AT
+      when 'trial_ended_at' then TRIAL_ENDED_AT
+      when 'updated_at' then UPDATED_AT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/subscription_group_include.rb

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

data/lib/advanced_billing/models/subscription_group_prepayment_method.rb

@@ -31,5 +31,22 @@ module AdvancedBilling
 
       SUBSCRIPTION_GROUP_PREPAYMENT_METHOD.include?(value)
     end
+
+    def self.from_value(value, default_value = CHECK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'check' then CHECK
+      when 'cash' then CASH
+      when 'money_order' then MONEY_ORDER
+      when 'ach' then ACH
+      when 'paypal_account' then PAYPAL_ACCOUNT
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/subscription_groups_list_include.rb

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

data/lib/advanced_billing/models/subscription_include.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       SUBSCRIPTION_INCLUDE.include?(value)
     end
+
+    def self.from_value(value, default_value = COUPONS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'coupons' then COUPONS
+      when 'self_service_page_token' then SELF_SERVICE_PAGE_TOKEN
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/subscription_included_coupon.rb

@@ -117,6 +117,16 @@ module AdvancedBilling
                                      additional_properties: additional_properties)
     end
 
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionIncludedCoupon | 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
+
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last

data/lib/advanced_billing/models/subscription_list_date_field.rb

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

data/lib/advanced_billing/models/subscription_list_include.rb

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

data/lib/advanced_billing/models/subscription_purge_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       SUBSCRIPTION_PURGE_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 'payment_profile' then PAYMENT_PROFILE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/subscription_sort.rb

@@ -31,5 +31,22 @@ module AdvancedBilling
 
       SUBSCRIPTION_SORT.include?(value)
     end
+
+    def self.from_value(value, default_value = SIGNUP_DATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'signup_date' then SIGNUP_DATE
+      when 'period_start' then PERIOD_START
+      when 'period_end' then PERIOD_END
+      when 'next_assessment' then NEXT_ASSESSMENT
+      when 'updated_at' then UPDATED_AT
+      when 'created_at' then CREATED_AT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/subscription_state.rb

@@ -114,5 +114,31 @@ module AdvancedBilling
 
       SUBSCRIPTION_STATE.include?(value)
     end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'failed_to_create' then FAILED_TO_CREATE
+      when 'trialing' then TRIALING
+      when 'assessing' then ASSESSING
+      when 'active' then ACTIVE
+      when 'soft_failure' then SOFT_FAILURE
+      when 'past_due' then PAST_DUE
+      when 'suspended' then SUSPENDED
+      when 'canceled' then CANCELED
+      when 'expired' then EXPIRED
+      when 'paused' then PAUSED
+      when 'unpaid' then UNPAID
+      when 'trial_ended' then TRIAL_ENDED
+      when 'on_hold' then ON_HOLD
+      when 'awaiting_signup' then AWAITING_SIGNUP
+      else
+        default_value
+      end
+    end
   end
 end