maxio-advanced-billing-sdk 7.0.0 → 8.0.0

data/lib/advanced_billing/models/invoice_discount_type.rb

@@ -22,5 +22,19 @@ module AdvancedBilling
 
       INVOICE_DISCOUNT_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = PERCENTAGE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'percentage' then PERCENTAGE
+      when 'flat_amount' then FLAT_AMOUNT
+      when 'rollover' then ROLLOVER
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_event_payment_method.rb

@@ -28,5 +28,21 @@ module AdvancedBilling
 
       INVOICE_EVENT_PAYMENT_METHOD.include?(value)
     end
+
+    def self.from_value(value, default_value = APPLE_PAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'apple_pay' then APPLE_PAY
+      when 'bank_account' then BANK_ACCOUNT
+      when 'credit_card' then CREDIT_CARD
+      when 'external' then EXTERNAL
+      when 'paypal_account' then PAYPAL_ACCOUNT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_event_type.rb

@@ -58,5 +58,31 @@ module AdvancedBilling
 
       INVOICE_EVENT_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = ISSUE_INVOICE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'issue_invoice' then ISSUE_INVOICE
+      when 'apply_credit_note' then APPLY_CREDIT_NOTE
+      when 'create_credit_note' then CREATE_CREDIT_NOTE
+      when 'apply_payment' then APPLY_PAYMENT
+      when 'apply_debit_note' then APPLY_DEBIT_NOTE
+      when 'create_debit_note' then CREATE_DEBIT_NOTE
+      when 'refund_invoice' then REFUND_INVOICE
+      when 'void_invoice' then VOID_INVOICE
+      when 'void_remainder' then VOID_REMAINDER
+      when 'backport_invoice' then BACKPORT_INVOICE
+      when 'change_invoice_status' then CHANGE_INVOICE_STATUS
+      when 'change_invoice_collection_method' then CHANGE_INVOICE_COLLECTION_METHOD
+      when 'remove_payment' then REMOVE_PAYMENT
+      when 'failed_payment' then FAILED_PAYMENT
+      when 'change_chargeback_status' then CHANGE_CHARGEBACK_STATUS
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_payment_method_type.rb

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

data/lib/advanced_billing/models/invoice_payment_type.rb

@@ -25,5 +25,20 @@ module AdvancedBilling
 
       INVOICE_PAYMENT_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = EXTERNAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'external' then EXTERNAL
+      when 'prepayment' then PREPAYMENT
+      when 'service_credit' then SERVICE_CREDIT
+      when 'payment' then PAYMENT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_role.rb

@@ -43,5 +43,26 @@ module AdvancedBilling
 
       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 'signup' then SIGNUP
+      when 'renewal' then RENEWAL
+      when 'usage' then USAGE
+      when 'reactivation' then REACTIVATION
+      when 'proration' then PRORATION
+      when 'migration' then MIGRATION
+      when 'adhoc' then ADHOC
+      when 'backport' then BACKPORT
+      when 'backportbalancereconciliation' then BACKPORTBALANCERECONCILIATION
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_sort_field.rb

@@ -37,5 +37,24 @@ module AdvancedBilling
 
       INVOICE_SORT_FIELD.include?(value)
     end
+
+    def self.from_value(value, default_value = STATUS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'status' then STATUS
+      when 'total_amount' then TOTAL_AMOUNT
+      when 'due_amount' then DUE_AMOUNT
+      when 'created_at' then CREATED_AT
+      when 'updated_at' then UPDATED_AT
+      when 'issue_date' then ISSUE_DATE
+      when 'due_date' then DUE_DATE
+      when 'number' then NUMBER
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/invoice_status.rb

@@ -36,5 +36,23 @@ module AdvancedBilling
 
       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 'open' then OPEN
+      when 'paid' then PAID
+      when 'pending' then PENDING
+      when 'voided' then VOIDED
+      when 'canceled' then CANCELED
+      when 'processing' then PROCESSING
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/item_category.rb

@@ -29,5 +29,21 @@ module AdvancedBilling
 
       ITEM_CATEGORY.include?(value)
     end
+
+    def self.from_value(value, default_value = ENUM_BUSINESS_SOFTWARE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_business_software' then ENUM_BUSINESS_SOFTWARE
+      when 'enum_consumer_software' then ENUM_CONSUMER_SOFTWARE
+      when 'enum_digital_services' then ENUM_DIGITAL_SERVICES
+      when 'enum_physical_goods' then ENUM_PHYSICAL_GOODS
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/line_item_kind.rb

@@ -43,5 +43,26 @@ module AdvancedBilling
 
       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 'quantity_based_component' then QUANTITY_BASED_COMPONENT
+      when 'prepaid_usage_component' then PREPAID_USAGE_COMPONENT
+      when 'on_off_component' then ON_OFF_COMPONENT
+      when 'metered_component' then METERED_COMPONENT
+      when 'event_based_component' then EVENT_BASED_COMPONENT
+      when 'coupon' then COUPON
+      when 'tax' then TAX
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/line_item_transaction_type.rb

@@ -34,5 +34,23 @@ module AdvancedBilling
 
       LINE_ITEM_TRANSACTION_TYPE.include?(value)
     end
+
+    def self.from_value(value, default_value = CHARGE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'charge' then CHARGE
+      when 'credit' then CREDIT
+      when 'adjustment' then ADJUSTMENT
+      when 'payment' then PAYMENT
+      when 'refund' then REFUND
+      when 'info_transaction' then INFO_TRANSACTION
+      when 'payment_authorization' then PAYMENT_AUTHORIZATION
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/list_components_price_points_include.rb

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

data/lib/advanced_billing/models/list_coupons_filter.rb

@@ -57,11 +57,20 @@ module AdvancedBilling
     # @return [Array[String]]
     attr_accessor :codes
 
-    # Allows fetching coupons with matching use_site_exchange_rate based on
-    # provided value. Use in query `filter[use_site_exchange_rate]=true`.
+    # If true, restricts the list to coupons whose pricing is recalculated from
+    # the site’s current exchange rates, so their currency_prices array contains
+    # on-the-fly conversions rather than stored price records. If false,
+    # restricts the list to coupons that have manually defined amounts for each
+    # currency, ensuring the response includes the saved currency_prices entries
+    # instead of exchange-rate-derived values. Use in query
+    # `filter[use_site_exchange_rate]=true`.
     # @return [TrueClass | FalseClass]
     attr_accessor :use_site_exchange_rate
 
+    # Controls returning archived coupons.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_archived
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -73,6 +82,7 @@ module AdvancedBilling
       @_hash['ids'] = 'ids'
       @_hash['codes'] = 'codes'
       @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash['include_archived'] = 'include_archived'
       @_hash
     end
 
@@ -87,6 +97,7 @@ module AdvancedBilling
         ids
         codes
         use_site_exchange_rate
+        include_archived
       ]
     end
 
@@ -98,7 +109,7 @@ module AdvancedBilling
     def initialize(date_field: SKIP, start_date: SKIP, end_date: SKIP,
                    start_datetime: SKIP, end_datetime: SKIP, ids: SKIP,
                    codes: SKIP, use_site_exchange_rate: SKIP,
-                   additional_properties: {})
+                   include_archived: SKIP, additional_properties: {})
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
@@ -112,6 +123,7 @@ module AdvancedBilling
       @ids = ids unless ids == SKIP
       @codes = codes unless codes == SKIP
       @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+      @include_archived = include_archived unless include_archived == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -136,6 +148,8 @@ module AdvancedBilling
       codes = hash.key?('codes') ? hash['codes'] : SKIP
       use_site_exchange_rate =
         hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+      include_archived =
+        hash.key?('include_archived') ? hash['include_archived'] : SKIP
 
       # Clean out expected properties from Hash.
       additional_properties = hash.reject { |k, _| names.value?(k) }
@@ -149,6 +163,7 @@ module AdvancedBilling
                             ids: ids,
                             codes: codes,
                             use_site_exchange_rate: use_site_exchange_rate,
+                            include_archived: include_archived,
                             additional_properties: additional_properties)
     end
 
@@ -166,7 +181,8 @@ module AdvancedBilling
       "<#{class_name} date_field: #{@date_field}, start_date: #{@start_date}, end_date:"\
       " #{@end_date}, start_datetime: #{@start_datetime}, end_datetime: #{@end_datetime}, ids:"\
       " #{@ids}, codes: #{@codes}, use_site_exchange_rate: #{@use_site_exchange_rate},"\
-      " additional_properties: #{get_additional_properties}>"
+      " include_archived: #{@include_archived}, additional_properties:"\
+      " #{get_additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -175,8 +191,8 @@ module AdvancedBilling
       "<#{class_name} date_field: #{@date_field.inspect}, start_date: #{@start_date.inspect},"\
       " end_date: #{@end_date.inspect}, start_datetime: #{@start_datetime.inspect}, end_datetime:"\
       " #{@end_datetime.inspect}, ids: #{@ids.inspect}, codes: #{@codes.inspect},"\
-      " use_site_exchange_rate: #{@use_site_exchange_rate.inspect}, additional_properties:"\
-      " #{get_additional_properties}>"
+      " use_site_exchange_rate: #{@use_site_exchange_rate.inspect}, include_archived:"\
+      " #{@include_archived.inspect}, additional_properties: #{get_additional_properties}>"
     end
   end
 end

data/lib/advanced_billing/models/list_events_date_field.rb

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

data/lib/advanced_billing/models/list_prepayment_date_field.rb

@@ -19,5 +19,18 @@ module AdvancedBilling
 
       LIST_PREPAYMENT_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 'application_at' then APPLICATION_AT
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/list_products_include.rb

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

data/lib/advanced_billing/models/list_products_price_points_include.rb

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

data/lib/advanced_billing/models/list_subscription_components_include.rb

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

data/lib/advanced_billing/models/list_subscription_components_sort.rb

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

data/lib/advanced_billing/models/metafield.rb

@@ -23,23 +23,20 @@ module AdvancedBilling
     # @return [MetafieldScope]
     attr_accessor :scope
 
-    # the amount of subscriptions this metafield has been applied to in Chargify
+    # The amount of subscriptions this metafield has been applied to in Advanced
+    # Billing.
     # @return [Integer]
     attr_accessor :data_count
 
-    # Indicates how data should be added to the metafield. For example, a text
-    # type is just a string, so a given metafield of this type can have any
-    # value attached. On the other hand, dropdown and radio have a set of
-    # allowed values that can be input, and appear differently on a Public
-    # Signup Page. Defaults to 'text'
+    # Indicates the type of metafield. A text metafield allows any string value.
+    # Dropdown and radio metafields have a set of values that can be selected.
+    # Defaults to 'text'.
     # @return [MetafieldInput]
     attr_accessor :input_type
 
-    # Indicates how data should be added to the metafield. For example, a text
-    # type is just a string, so a given metafield of this type can have any
-    # value attached. On the other hand, dropdown and radio have a set of
-    # allowed values that can be input, and appear differently on a Public
-    # Signup Page. Defaults to 'text'
+    # Indicates the type of metafield. A text metafield allows any string value.
+    # Dropdown and radio metafields have a set of values that can be selected.
+    # Defaults to 'text'.
     # @return [Object]
     attr_accessor :enum
 

data/lib/advanced_billing/models/metafield_input.rb

@@ -4,11 +4,9 @@
 # APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module AdvancedBilling
-  # Indicates how data should be added to the metafield. For example, a text
-  # type is just a string, so a given metafield of this type can have any value
-  # attached. On the other hand, dropdown and radio have a set of allowed values
-  # that can be input, and appear differently on a Public Signup Page. Defaults
-  # to 'text'
+  # Indicates the type of metafield. A text metafield allows any string value.
+  # Dropdown and radio metafields have a set of values that can be selected.
+  # Defaults to 'text'.
   class MetafieldInput
     METAFIELD_INPUT = [
       # TODO: Write general description for BALANCE_TRACKER
@@ -29,5 +27,20 @@ module AdvancedBilling
 
       METAFIELD_INPUT.include?(value)
     end
+
+    def self.from_value(value, default_value = BALANCE_TRACKER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'balance_tracker' then BALANCE_TRACKER
+      when 'text' then TEXT
+      when 'radio' then RADIO
+      when 'dropdown' then DROPDOWN
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/metafield_scope.rb

@@ -27,16 +27,21 @@ module AdvancedBilling
     # @return [IncludeOption]
     attr_accessor :portal
 
-    # Include (1) or exclude (0) metafields from being viewable by your
-    # ecosystem.
+    # Include (1) or exclude (0) metafields used in [Embeddable
+    # Components](page:development-tools/embeddable-components/overview) from
+    # being viewable by your ecosystem.
     # @return [IncludeOption]
     attr_accessor :public_show
 
-    # Include (1) or exclude (0) metafields from being edited by your ecosystem.
+    # Include (1) or exclude (0) metafields used in [Embeddable
+    # Components](page:development-tools/embeddable-components/overview) from
+    # being editable by your ecosystem.
     # @return [IncludeOption]
     attr_accessor :public_edit
 
-    # Include (1) or exclude (0) metafields from being edited by your ecosystem.
+    # Include (1) or exclude (0) metafields used in [Embeddable
+    # Components](page:development-tools/embeddable-components/overview) from
+    # being editable by your ecosystem.
     # @return [Array[String]]
     attr_accessor :hosted
 

data/lib/advanced_billing/models/metered_component.rb

@@ -68,8 +68,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/nested_subscription_group.rb

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

data/lib/advanced_billing/models/on_off_component.rb

@@ -55,8 +55,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/pay_pal_vault.rb

@@ -25,5 +25,20 @@ module AdvancedBilling
 
       PAY_PAL_VAULT.include?(value)
     end
+
+    def self.from_value(value, default_value = BRAINTREE_BLUE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'braintree_blue' then BRAINTREE_BLUE
+      when 'paypal' then PAYPAL
+      when 'moduslink' then MODUSLINK
+      when 'paypal_complete' then PAYPAL_COMPLETE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/advanced_billing/models/payment_profile_attributes.rb

@@ -94,9 +94,9 @@ module AdvancedBilling
     # required in [ISO_3166-1
     # alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format (i.e.
     # “US”). This value is merely passed through to the payment gateway. Some
-    # gateways require country codes in a specific format. Please check your
-    # gateway’s documentation. If creating an ACH subscription, only US is
-    # supported at this time.
+    # gateways require country codes in a specific format. Check your gateway’s
+    # documentation. If creating an ACH subscription, only US is supported at
+    # this time.
     # @return [String]
     attr_accessor :billing_country