maxio-advanced-billing-sdk 7.0.1 → 8.0.0

data/lib/advanced_billing/http/auth/basic_auth.rb

@@ -40,6 +40,18 @@ module AdvancedBilling
       @password = password
     end
 
+    def self.from_env
+      username = ENV['USERNAME']
+      password = ENV['PASSWORD']
+      all_nil = [
+        username,
+        password
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(username: username, password: password)
+    end
+
     def clone_with(username: nil, password: nil)
       username ||= self.username
       password ||= self.password

data/lib/advanced_billing/http/proxy_settings.rb

@@ -9,5 +9,14 @@ module AdvancedBilling
   # including optional basic authentication.
   #
   class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
   end
 end

data/lib/advanced_billing/models/activate_event_based_component.rb

@@ -15,8 +15,7 @@ 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
 

data/lib/advanced_billing/models/all_vaults.rb

@@ -116,5 +116,50 @@ module AdvancedBilling
 
       ALL_VAULTS.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 'gocardless' then GOCARDLESS
+      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/allocation_preview_direction.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       ALLOCATION_PREVIEW_DIRECTION.include?(value)
     end
+
+    def self.from_value(value, default_value = UPGRADE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'upgrade' then UPGRADE
+      when 'downgrade' then DOWNGRADE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/allocation_preview_line_item_kind.rb

@@ -25,5 +25,20 @@ module AdvancedBilling
 
       ALLOCATION_PREVIEW_LINE_ITEM_KIND.include?(value)
     end
+
+    def self.from_value(value, default_value = QUANTITY_BASED_COMPONENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'quantity_based_component' then QUANTITY_BASED_COMPONENT
+      when 'on_off_component' then ON_OFF_COMPONENT
+      when 'coupon' then COUPON
+      when 'tax' then TAX
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/apple_pay_vault.rb

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

data/lib/advanced_billing/models/auto_invite.rb

@@ -19,5 +19,24 @@ module AdvancedBilling
 
       AUTO_INVITE.include?(value)
     end
+
+    def self.from_value(value, default_value = NO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if AUTO_INVITE.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'no' then NO
+      when 'yes' then YES
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/bank_account_holder_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       BANK_ACCOUNT_HOLDER_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = PERSONAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'personal' then PERSONAL
+      when 'business' then BUSINESS
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/bank_account_type.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       BANK_ACCOUNT_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = CHECKING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'checking' then CHECKING
+      when 'savings' then SAVINGS
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/bank_account_vault.rb

@@ -38,5 +38,24 @@ module AdvancedBilling
 
       BANK_ACCOUNT_VAULT.include?(value)
     end
+
+    def self.from_value(value, default_value = AUTHORIZENET)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authorizenet' then AUTHORIZENET
+      when 'blue_snap' then BLUE_SNAP
+      when 'bogus' then BOGUS
+      when 'forte' then FORTE
+      when 'gocardless' then GOCARDLESS
+      when 'maxio_payments' then MAXIO_PAYMENTS
+      when 'maxp' then MAXP
+      when 'stripe_connect' then STRIPE_CONNECT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/basic_date_field.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       BASIC_DATE_FIELD.include?(value)
     end
+
+    def self.from_value(value, default_value = UPDATED_AT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'updated_at' then UPDATED_AT
+      when 'created_at' then CREATED_AT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/billing_manifest_line_item_kind.rb

@@ -31,5 +31,22 @@ module AdvancedBilling
 
       BILLING_MANIFEST_LINE_ITEM_KIND.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 'initial' then INITIAL
+      when 'trial' then TRIAL
+      when 'coupon' then COUPON
+      when 'component' then COMPONENT
+      when 'tax' then TAX
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/billing_schedule.rb

@@ -5,8 +5,8 @@
 
 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
+  # for different components on distinct schedules within a subscription. This
+  # only works for site with Multifrequency enabled.
   class BillingSchedule < BaseModel
     SKIP = Object.new
     private_constant :SKIP

data/lib/advanced_billing/models/calendar_billing.rb

@@ -38,7 +38,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        snap_day
+      ]
     end
 
     def initialize(snap_day: SKIP, calendar_billing_first_charge: SKIP,

data/lib/advanced_billing/models/cancellation_method.rb

@@ -32,5 +32,22 @@ module AdvancedBilling
 
       CANCELLATION_METHOD.include?(value)
     end
+
+    def self.from_value(value, default_value = MERCHANT_UI)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant_ui' then MERCHANT_UI
+      when 'merchant_api' then MERCHANT_API
+      when 'dunning' then DUNNING
+      when 'billing_portal' then BILLING_PORTAL
+      when 'unknown' then UNKNOWN
+      when 'imported' then IMPORTED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/card_type.rb

@@ -121,5 +121,52 @@ module AdvancedBilling
 
       CARD_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = VISA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visa' then VISA
+      when 'master' then MASTER
+      when 'elo' then ELO
+      when 'cabal' then CABAL
+      when 'alelo' then ALELO
+      when 'discover' then DISCOVER
+      when 'american_express' then AMERICAN_EXPRESS
+      when 'naranja' then NARANJA
+      when 'diners_club' then DINERS_CLUB
+      when 'jcb' then JCB
+      when 'dankort' then DANKORT
+      when 'maestro' then MAESTRO
+      when 'maestro_no_luhn' then MAESTRO_NO_LUHN
+      when 'forbrugsforeningen' then FORBRUGSFORENINGEN
+      when 'sodexo' then SODEXO
+      when 'alia' then ALIA
+      when 'vr' then VR
+      when 'unionpay' then UNIONPAY
+      when 'carnet' then CARNET
+      when 'cartes_bancaires' then CARTES_BANCAIRES
+      when 'olimpica' then OLIMPICA
+      when 'creditel' then CREDITEL
+      when 'confiable' then CONFIABLE
+      when 'synchrony' then SYNCHRONY
+      when 'routex' then ROUTEX
+      when 'mada' then MADA
+      when 'bp_plus' then BP_PLUS
+      when 'passcard' then PASSCARD
+      when 'edenred' then EDENRED
+      when 'anda' then ANDA
+      when 'tarjetad' then TARJETAD
+      when 'hipercard' then HIPERCARD
+      when 'bogus' then BOGUS
+      when 'switch' then SWITCH
+      when 'solo' then SOLO
+      when 'laser' then LASER
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/chargeback_status.rb

@@ -25,5 +25,20 @@ module AdvancedBilling
 
       CHARGEBACK_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 'lost' then LOST
+      when 'won' then WON
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/chargify_ebb.rb

@@ -16,14 +16,14 @@ module AdvancedBilling
     # @return [DateTime]
     attr_accessor :timestamp
 
-    # A unique ID set by Chargify. Please note that this field is reserved. If
-    # `chargify.id` is present in the request payload, it will be overwritten.
+    # A unique ID set by Chargify. This field is reserved. If `chargify.id` is
+    # present in the request payload, it will be overwritten.
     # @return [String]
     attr_accessor :id
 
     # An ISO-8601 timestamp, set by Chargify at the time each event is recorded.
-    # Please note that this field is reserved. If `chargify.created_at` is
-    # present in the request payload, it will be overwritten.
+    # This field is reserved. If `chargify.created_at` is present in the request
+    # payload, it will be overwritten.
     # @return [DateTime]
     attr_accessor :created_at
 

data/lib/advanced_billing/models/cleanup_scope.rb

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

data/lib/advanced_billing/models/collection_method.rb

@@ -28,5 +28,20 @@ module AdvancedBilling
 
       COLLECTION_METHOD.include?(value)
     end
+
+    def self.from_value(value, default_value = AUTOMATIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'automatic' then AUTOMATIC
+      when 'remittance' then REMITTANCE
+      when 'prepaid' then PREPAID
+      when 'invoice' then INVOICE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/component.rb

@@ -62,10 +62,6 @@ module AdvancedBilling
     # @return [TrueClass | FalseClass]
     attr_accessor :archived
 
-    # Boolean flag describing whether a component is taxable or not.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :taxable
-
     # The description of the component.
     # @return [String]
     attr_accessor :description
@@ -98,15 +94,19 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :default_price_point_name
 
+    # Boolean flag describing whether a component is taxable or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
     # 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
 
     # 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 [TrueClass | FalseClass]
     attr_accessor :recurring
 
@@ -193,7 +193,6 @@ module AdvancedBilling
       @_hash['price_per_unit_in_cents'] = 'price_per_unit_in_cents'
       @_hash['kind'] = 'kind'
       @_hash['archived'] = 'archived'
-      @_hash['taxable'] = 'taxable'
       @_hash['description'] = 'description'
       @_hash['default_price_point_id'] = 'default_price_point_id'
       @_hash['overage_prices'] = 'overage_prices'
@@ -201,6 +200,7 @@ module AdvancedBilling
       @_hash['price_point_count'] = 'price_point_count'
       @_hash['price_points_url'] = 'price_points_url'
       @_hash['default_price_point_name'] = 'default_price_point_name'
+      @_hash['taxable'] = 'taxable'
       @_hash['tax_code'] = 'tax_code'
       @_hash['recurring'] = 'recurring'
       @_hash['upgrade_charge'] = 'upgrade_charge'
@@ -235,7 +235,6 @@ module AdvancedBilling
         price_per_unit_in_cents
         kind
         archived
-        taxable
         description
         default_price_point_id
         overage_prices
@@ -243,6 +242,7 @@ module AdvancedBilling
         price_point_count
         price_points_url
         default_price_point_name
+        taxable
         tax_code
         recurring
         upgrade_charge
@@ -288,13 +288,13 @@ module AdvancedBilling
                    unit_name: SKIP, unit_price: SKIP, product_family_id: SKIP,
                    product_family_name: SKIP, product_family_handle: SKIP,
                    price_per_unit_in_cents: SKIP, kind: SKIP, archived: SKIP,
-                   taxable: SKIP, description: SKIP,
-                   default_price_point_id: SKIP, overage_prices: SKIP,
-                   prices: SKIP, price_point_count: SKIP,
+                   description: SKIP, default_price_point_id: SKIP,
+                   overage_prices: SKIP, prices: SKIP, price_point_count: SKIP,
                    price_points_url: SKIP, default_price_point_name: SKIP,
-                   tax_code: SKIP, recurring: SKIP, upgrade_charge: SKIP,
-                   downgrade_credit: SKIP, created_at: SKIP, updated_at: SKIP,
-                   archived_at: SKIP, hide_date_range_on_invoice: SKIP,
+                   taxable: SKIP, tax_code: SKIP, recurring: SKIP,
+                   upgrade_charge: SKIP, downgrade_credit: SKIP,
+                   created_at: SKIP, updated_at: SKIP, archived_at: SKIP,
+                   hide_date_range_on_invoice: SKIP,
                    allow_fractional_quantities: SKIP, item_category: SKIP,
                    use_site_exchange_rate: SKIP, accounting_code: SKIP,
                    event_based_billing_metric_id: SKIP, interval: SKIP,
@@ -316,7 +316,6 @@ module AdvancedBilling
       @price_per_unit_in_cents = price_per_unit_in_cents unless price_per_unit_in_cents == SKIP
       @kind = kind unless kind == SKIP
       @archived = archived unless archived == SKIP
-      @taxable = taxable unless taxable == SKIP
       @description = description unless description == SKIP
       @default_price_point_id = default_price_point_id unless default_price_point_id == SKIP
       @overage_prices = overage_prices unless overage_prices == SKIP
@@ -324,6 +323,7 @@ module AdvancedBilling
       @price_point_count = price_point_count unless price_point_count == SKIP
       @price_points_url = price_points_url unless price_points_url == SKIP
       @default_price_point_name = default_price_point_name unless default_price_point_name == SKIP
+      @taxable = taxable unless taxable == SKIP
       @tax_code = tax_code unless tax_code == SKIP
       @recurring = recurring unless recurring == SKIP
       @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
@@ -372,7 +372,6 @@ module AdvancedBilling
         hash.key?('price_per_unit_in_cents') ? hash['price_per_unit_in_cents'] : SKIP
       kind = hash.key?('kind') ? hash['kind'] : SKIP
       archived = hash.key?('archived') ? hash['archived'] : SKIP
-      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
       description = hash.key?('description') ? hash['description'] : SKIP
       default_price_point_id =
         hash.key?('default_price_point_id') ? hash['default_price_point_id'] : SKIP
@@ -402,6 +401,7 @@ module AdvancedBilling
         hash.key?('price_points_url') ? hash['price_points_url'] : SKIP
       default_price_point_name =
         hash.key?('default_price_point_name') ? hash['default_price_point_name'] : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
       tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
       recurring = hash.key?('recurring') ? hash['recurring'] : SKIP
       upgrade_charge =
@@ -453,7 +453,6 @@ module AdvancedBilling
                     price_per_unit_in_cents: price_per_unit_in_cents,
                     kind: kind,
                     archived: archived,
-                    taxable: taxable,
                     description: description,
                     default_price_point_id: default_price_point_id,
                     overage_prices: overage_prices,
@@ -461,6 +460,7 @@ module AdvancedBilling
                     price_point_count: price_point_count,
                     price_points_url: price_points_url,
                     default_price_point_name: default_price_point_name,
+                    taxable: taxable,
                     tax_code: tax_code,
                     recurring: recurring,
                     upgrade_charge: upgrade_charge,
@@ -498,13 +498,13 @@ module AdvancedBilling
       " #{@pricing_scheme}, unit_name: #{@unit_name}, unit_price: #{@unit_price},"\
       " product_family_id: #{@product_family_id}, product_family_name: #{@product_family_name},"\
       " product_family_handle: #{@product_family_handle}, price_per_unit_in_cents:"\
-      " #{@price_per_unit_in_cents}, kind: #{@kind}, archived: #{@archived}, taxable: #{@taxable},"\
-      " description: #{@description}, default_price_point_id: #{@default_price_point_id},"\
-      " overage_prices: #{@overage_prices}, prices: #{@prices}, price_point_count:"\
-      " #{@price_point_count}, price_points_url: #{@price_points_url}, default_price_point_name:"\
-      " #{@default_price_point_name}, tax_code: #{@tax_code}, recurring: #{@recurring},"\
-      " upgrade_charge: #{@upgrade_charge}, downgrade_credit: #{@downgrade_credit}, created_at:"\
-      " #{@created_at}, updated_at: #{@updated_at}, archived_at: #{@archived_at},"\
+      " #{@price_per_unit_in_cents}, kind: #{@kind}, archived: #{@archived}, description:"\
+      " #{@description}, default_price_point_id: #{@default_price_point_id}, overage_prices:"\
+      " #{@overage_prices}, prices: #{@prices}, price_point_count: #{@price_point_count},"\
+      " price_points_url: #{@price_points_url}, default_price_point_name:"\
+      " #{@default_price_point_name}, taxable: #{@taxable}, tax_code: #{@tax_code}, recurring:"\
+      " #{@recurring}, upgrade_charge: #{@upgrade_charge}, downgrade_credit: #{@downgrade_credit},"\
+      " created_at: #{@created_at}, updated_at: #{@updated_at}, archived_at: #{@archived_at},"\
       " hide_date_range_on_invoice: #{@hide_date_range_on_invoice}, allow_fractional_quantities:"\
       " #{@allow_fractional_quantities}, item_category: #{@item_category}, use_site_exchange_rate:"\
       " #{@use_site_exchange_rate}, accounting_code: #{@accounting_code},"\
@@ -521,11 +521,11 @@ module AdvancedBilling
       " product_family_name: #{@product_family_name.inspect}, product_family_handle:"\
       " #{@product_family_handle.inspect}, price_per_unit_in_cents:"\
       " #{@price_per_unit_in_cents.inspect}, kind: #{@kind.inspect}, archived:"\
-      " #{@archived.inspect}, taxable: #{@taxable.inspect}, description: #{@description.inspect},"\
-      " default_price_point_id: #{@default_price_point_id.inspect}, overage_prices:"\
-      " #{@overage_prices.inspect}, prices: #{@prices.inspect}, price_point_count:"\
-      " #{@price_point_count.inspect}, price_points_url: #{@price_points_url.inspect},"\
-      " default_price_point_name: #{@default_price_point_name.inspect}, tax_code:"\
+      " #{@archived.inspect}, description: #{@description.inspect}, default_price_point_id:"\
+      " #{@default_price_point_id.inspect}, overage_prices: #{@overage_prices.inspect}, prices:"\
+      " #{@prices.inspect}, price_point_count: #{@price_point_count.inspect}, price_points_url:"\
+      " #{@price_points_url.inspect}, default_price_point_name:"\
+      " #{@default_price_point_name.inspect}, taxable: #{@taxable.inspect}, tax_code:"\
       " #{@tax_code.inspect}, recurring: #{@recurring.inspect}, upgrade_charge:"\
       " #{@upgrade_charge.inspect}, downgrade_credit: #{@downgrade_credit.inspect}, created_at:"\
       " #{@created_at.inspect}, updated_at: #{@updated_at.inspect}, archived_at:"\