maxio-advanced-billing-sdk 4.0.0 → 5.0.0

data/lib/advanced_billing/models/create_metafield.rb

@@ -27,7 +27,8 @@ module AdvancedBilling
     # @return [MetafieldInput]
     attr_accessor :input_type
 
-    # Only applicable when input_type is radio or dropdown
+    # Only applicable when input_type is radio or dropdown. Empty strings will
+    # not be submitted.
     # @return [Array[String]]
     attr_accessor :enum
 

data/lib/advanced_billing/models/create_or_update_product.rb

@@ -72,12 +72,12 @@ module AdvancedBilling
     attr_accessor :expiration_interval
 
     # A string representing the expiration interval unit for this product,
-    # either month or day
-    # @return [IntervalUnit]
+    # either month, day or never
+    # @return [ExpirationIntervalUnit]
     attr_accessor :expiration_interval_unit
 
     # A string representing the expiration interval unit for this product,
-    # either month or day
+    # either month, day or never
     # @return [TrueClass | FalseClass]
     attr_accessor :auto_create_signup_page
 
@@ -128,7 +128,10 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        trial_interval_unit
+        expiration_interval_unit
+      ]
     end
 
     def initialize(name:, description:, price_in_cents:, interval:,

data/lib/advanced_billing/models/create_payment_profile.rb

@@ -94,7 +94,7 @@ module AdvancedBilling
 
     # The vault that stores the payment profile with the provided `vault_token`.
     # Use `bogus` for testing.
-    # @return [CurrentVault]
+    # @return [AllVaults]
     attr_accessor :current_vault
 
     # The “token” provided by your vault storage for an already stored payment

data/lib/advanced_billing/models/create_prepaid_usage_component_price_point.rb

@@ -56,10 +56,9 @@ module AdvancedBilling
     # @return [Float]
     attr_accessor :expiration_interval
 
-    # (only for prepaid usage components where rollover_prepaid_remainder is
-    # true) The number of `expiration_interval_unit`s after which rollover
-    # amounts should expire
-    # @return [IntervalUnit]
+    # A string representing the expiration interval unit for this component,
+    # either month or day
+    # @return [ExpirationIntervalUnit]
     attr_accessor :expiration_interval_unit
 
     # A mapping from model property names to API property names.
@@ -92,7 +91,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        expiration_interval_unit
+      ]
     end
 
     def initialize(name:, pricing_scheme:, prices:, overage_pricing:,

data/lib/advanced_billing/models/create_product_price_point.rb

@@ -67,8 +67,8 @@ module AdvancedBilling
     attr_accessor :expiration_interval
 
     # A string representing the expiration interval unit for this product price
-    # point, either month or day
-    # @return [IntervalUnit]
+    # point, either month, day or never
+    # @return [ExpirationIntervalUnit]
     attr_accessor :expiration_interval_unit
 
     # Whether or not to use the site's exchange rate or define your own pricing
@@ -114,7 +114,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        expiration_interval_unit
+      ]
     end
 
     def initialize(name:, price_in_cents:, interval:, interval_unit:,

data/lib/advanced_billing/models/create_subscription.rb

@@ -70,16 +70,17 @@ module AdvancedBilling
     # (Optional) Set this attribute to a future date/time to sync imported
     # subscriptions to your existing renewal schedule. See the notes on
     # “Date/Time Format” in our [subscription import
-    # documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/540486
-    # 3655821#date-format). If you provide a next_billing_at timestamp that is
-    # in the future, no trial or initial charges will be applied when you create
-    # the subscription. In fact, no payment will be captured at all. The first
-    # payment will be captured, according to the prices defined by the product,
-    # near the time specified by next_billing_at. If you do not provide a value
-    # for next_billing_at, any trial and/or initial charges will be assessed and
-    # charged at the time of subscription creation. If the card cannot be
-    # successfully charged, the subscription will not be created. See further
-    # notes in the section on Importing Subscriptions.
+    # documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-
+    # Advanced-Billing-Subscription-Imports#date-format). If you provide a
+    # next_billing_at timestamp that is in the future, no trial or initial
+    # charges will be applied when you create the subscription. In fact, no
+    # payment will be captured at all. The first payment will be captured,
+    # according to the prices defined by the product, near the time specified by
+    # next_billing_at. If you do not provide a value for next_billing_at, any
+    # trial and/or initial charges will be assessed and charged at the time of
+    # subscription creation. If the card cannot be successfully charged, the
+    # subscription will not be created. See further notes in the section on
+    # Importing Subscriptions.
     # @return [DateTime]
     attr_accessor :next_billing_at
 
@@ -87,16 +88,17 @@ module AdvancedBilling
     # subscription in the "Awaiting Signup" state, rather than "Active" or
     # "Trialing". See the notes on “Date/Time Format” in our [subscription
     # import
-    # documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/540486
-    # 3655821#date-format). In the "Awaiting Signup" state, a subscription
-    # behaves like any other. It can be canceled, allocated to, had its billing
-    # date changed. etc. When the initial_billing_at date hits, the subscription
-    # will transition to the expected state. If the product has a trial, the
-    # subscription will enter a trial, otherwise it will go active. Setup fees
-    # will be respected either before or after the trial, as configured on the
-    # price point. If the payment is due at the initial_billing_at and it fails
-    # the subscription will be immediately canceled. See further notes in the
-    # section on Delayed Signups.
+    # documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-
+    # Advanced-Billing-Subscription-Imports#date-format). In the "Awaiting
+    # Signup" state, a subscription behaves like any other. It can be canceled,
+    # allocated to, had its billing date changed. etc. When the
+    # initial_billing_at date hits, the subscription will transition to the
+    # expected state. If the product has a trial, the subscription will enter a
+    # trial, otherwise it will go active. Setup fees will be respected either
+    # before or after the trial, as configured on the price point. If the
+    # payment is due at the initial_billing_at and it fails the subscription
+    # will be immediately canceled. See further notes in the section on Delayed
+    # Signups.
     # @return [DateTime]
     attr_accessor :initial_billing_at
 
@@ -146,8 +148,8 @@ module AdvancedBilling
 
     # (Optional) An array of component ids and quantities to be added to the
     # subscription. See
-    # [Components](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050206
-    # 25677) for more information.
+    # [Components](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Co
+    # mponents-Overview) for more information.
     # @return [Array[CreateSubscriptionComponent]]
     attr_accessor :components
 
@@ -174,9 +176,9 @@ module AdvancedBilling
     attr_accessor :group
 
     # A valid referral code. (optional, see
-    # [Referrals](https://maxio-chargify.zendesk.com/hc/en-us/articles/540542020
-    # 4045-Referrals-Reference#how-to-obtain-referral-codes) for more details).
-    # If supplied, must be valid, or else subscription creation will fail.
+    # [Referrals](https://maxio.zendesk.com/hc/en-us/articles/24286981223693-Ref
+    # errals-Reference#how-to-obtain-referral-codes) for more details). If
+    # supplied, must be valid, or else subscription creation will fail.
     # @return [String]
     attr_accessor :ref
 

data/lib/advanced_billing/models/credit_card_payment_profile.rb

@@ -48,7 +48,7 @@ module AdvancedBilling
 
     # The vault that stores the payment profile with the provided `vault_token`.
     # Use `bogus` for testing.
-    # @return [CurrentVault]
+    # @return [CreditCardVault]
     attr_accessor :current_vault
 
     # The “token” provided by your vault storage for an already stored payment
@@ -143,6 +143,7 @@ module AdvancedBilling
         id
         first_name
         last_name
+        masked_card_number
         card_type
         expiration_month
         expiration_year
@@ -156,7 +157,6 @@ module AdvancedBilling
         billing_country
         customer_vault_token
         billing_address_2
-        payment_type
         disabled
         chargify_token
         site_gateway_setting_id
@@ -180,20 +180,21 @@ module AdvancedBilling
       ]
     end
 
-    def initialize(masked_card_number:, id: SKIP, first_name: SKIP,
-                   last_name: SKIP, card_type: SKIP, expiration_month: SKIP,
+    def initialize(payment_type: PaymentType::CREDIT_CARD, id: SKIP,
+                   first_name: SKIP, last_name: SKIP, masked_card_number: SKIP,
+                   card_type: SKIP, expiration_month: SKIP,
                    expiration_year: SKIP, customer_id: SKIP,
                    current_vault: SKIP, vault_token: SKIP,
                    billing_address: SKIP, billing_city: SKIP,
                    billing_state: SKIP, billing_zip: SKIP,
                    billing_country: SKIP, customer_vault_token: SKIP,
-                   billing_address_2: SKIP, payment_type: SKIP, disabled: SKIP,
+                   billing_address_2: SKIP, disabled: SKIP,
                    chargify_token: SKIP, site_gateway_setting_id: SKIP,
                    gateway_handle: SKIP, additional_properties: {})
       @id = id unless id == SKIP
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
-      @masked_card_number = masked_card_number
+      @masked_card_number = masked_card_number unless masked_card_number == SKIP
       @card_type = card_type unless card_type == SKIP
       @expiration_month = expiration_month unless expiration_month == SKIP
       @expiration_year = expiration_year unless expiration_year == SKIP
@@ -207,7 +208,7 @@ module AdvancedBilling
       @billing_country = billing_country unless billing_country == SKIP
       @customer_vault_token = customer_vault_token unless customer_vault_token == SKIP
       @billing_address_2 = billing_address_2 unless billing_address_2 == SKIP
-      @payment_type = payment_type unless payment_type == SKIP
+      @payment_type = payment_type
       @disabled = disabled unless disabled == SKIP
       @chargify_token = chargify_token unless chargify_token == SKIP
       @site_gateway_setting_id = site_gateway_setting_id unless site_gateway_setting_id == SKIP
@@ -224,11 +225,12 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      masked_card_number =
-        hash.key?('masked_card_number') ? hash['masked_card_number'] : nil
+      payment_type = hash['payment_type'] ||= PaymentType::CREDIT_CARD
       id = hash.key?('id') ? hash['id'] : SKIP
       first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
       last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      masked_card_number =
+        hash.key?('masked_card_number') ? hash['masked_card_number'] : SKIP
       card_type = hash.key?('card_type') ? hash['card_type'] : SKIP
       expiration_month =
         hash.key?('expiration_month') ? hash['expiration_month'] : SKIP
@@ -248,7 +250,6 @@ module AdvancedBilling
         hash.key?('customer_vault_token') ? hash['customer_vault_token'] : SKIP
       billing_address_2 =
         hash.key?('billing_address_2') ? hash['billing_address_2'] : SKIP
-      payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
       disabled = hash.key?('disabled') ? hash['disabled'] : SKIP
       chargify_token =
         hash.key?('chargify_token') ? hash['chargify_token'] : SKIP
@@ -261,10 +262,11 @@ module AdvancedBilling
       names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
-      CreditCardPaymentProfile.new(masked_card_number: masked_card_number,
+      CreditCardPaymentProfile.new(payment_type: payment_type,
                                    id: id,
                                    first_name: first_name,
                                    last_name: last_name,
+                                   masked_card_number: masked_card_number,
                                    card_type: card_type,
                                    expiration_month: expiration_month,
                                    expiration_year: expiration_year,
@@ -278,7 +280,6 @@ module AdvancedBilling
                                    billing_country: billing_country,
                                    customer_vault_token: customer_vault_token,
                                    billing_address_2: billing_address_2,
-                                   payment_type: payment_type,
                                    disabled: disabled,
                                    chargify_token: chargify_token,
                                    site_gateway_setting_id: site_gateway_setting_id,
@@ -290,14 +291,14 @@ module AdvancedBilling
     # @param [CreditCardPaymentProfile | Hash] The value against the validation is performed.
     def self.validate(value)
       if value.instance_of? self
-        return APIHelper.valid_type?(value.masked_card_number,
-                                     ->(val) { val.instance_of? String })
+        return APIHelper.valid_type?(value.payment_type,
+                                     ->(val) { PaymentType.validate(val) })
       end
 
       return false unless value.instance_of? Hash
 
-      APIHelper.valid_type?(value['masked_card_number'],
-                            ->(val) { val.instance_of? String })
+      APIHelper.valid_type?(value['payment_type'],
+                            ->(val) { PaymentType.validate(val) })
     end
   end
 end

data/lib/advanced_billing/models/credit_card_vault.rb

@@ -0,0 +1,117 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The vault that stores the payment profile with the provided `vault_token`.
+  # Use `bogus` for testing.
+  class CreditCardVault
+    CREDIT_CARD_VAULT = [
+      # TODO: Write general description for ADYEN
+      ADYEN = 'adyen'.freeze,
+
+      # TODO: Write general description for AUTHORIZENET
+      AUTHORIZENET = 'authorizenet'.freeze,
+
+      # TODO: Write general description for BEANSTREAM
+      BEANSTREAM = 'beanstream'.freeze,
+
+      # TODO: Write general description for BLUE_SNAP
+      BLUE_SNAP = 'blue_snap'.freeze,
+
+      # TODO: Write general description for BOGUS
+      BOGUS = 'bogus'.freeze,
+
+      # TODO: Write general description for BRAINTREE1
+      BRAINTREE1 = 'braintree1'.freeze,
+
+      # TODO: Write general description for BRAINTREE_BLUE
+      BRAINTREE_BLUE = 'braintree_blue'.freeze,
+
+      # TODO: Write general description for CHECKOUT
+      CHECKOUT = 'checkout'.freeze,
+
+      # TODO: Write general description for CYBERSOURCE
+      CYBERSOURCE = 'cybersource'.freeze,
+
+      # TODO: Write general description for ELAVON
+      ELAVON = 'elavon'.freeze,
+
+      # TODO: Write general description for EWAY
+      EWAY = 'eway'.freeze,
+
+      # TODO: Write general description for EWAY_RAPID
+      EWAY_RAPID = 'eway_rapid'.freeze,
+
+      # TODO: Write general description for EWAY_RAPID_STD
+      EWAY_RAPID_STD = 'eway_rapid_std'.freeze,
+
+      # TODO: Write general description for FIRSTDATA
+      FIRSTDATA = 'firstdata'.freeze,
+
+      # TODO: Write general description for FORTE
+      FORTE = 'forte'.freeze,
+
+      # TODO: Write general description for LITLE
+      LITLE = 'litle'.freeze,
+
+      # TODO: Write general description for MAXIO_PAYMENTS
+      MAXIO_PAYMENTS = 'maxio_payments'.freeze,
+
+      # TODO: Write general description for MAXP
+      MAXP = 'maxp'.freeze,
+
+      # TODO: Write general description for MODUSLINK
+      MODUSLINK = 'moduslink'.freeze,
+
+      # TODO: Write general description for MONERIS
+      MONERIS = 'moneris'.freeze,
+
+      # TODO: Write general description for NMI
+      NMI = 'nmi'.freeze,
+
+      # TODO: Write general description for ORBITAL
+      ORBITAL = 'orbital'.freeze,
+
+      # TODO: Write general description for PAYMENT_EXPRESS
+      PAYMENT_EXPRESS = 'payment_express'.freeze,
+
+      # TODO: Write general description for PAYMILL
+      PAYMILL = 'paymill'.freeze,
+
+      # TODO: Write general description for PAYPAL
+      PAYPAL = 'paypal'.freeze,
+
+      # TODO: Write general description for PAYPAL_COMPLETE
+      PAYPAL_COMPLETE = 'paypal_complete'.freeze,
+
+      # TODO: Write general description for PIN
+      PIN = 'pin'.freeze,
+
+      # TODO: Write general description for SQUARE
+      SQUARE = 'square'.freeze,
+
+      # TODO: Write general description for STRIPE
+      STRIPE = 'stripe'.freeze,
+
+      # TODO: Write general description for STRIPE_CONNECT
+      STRIPE_CONNECT = 'stripe_connect'.freeze,
+
+      # TODO: Write general description for TRUST_COMMERCE
+      TRUST_COMMERCE = 'trust_commerce'.freeze,
+
+      # TODO: Write general description for UNIPAAS
+      UNIPAAS = 'unipaas'.freeze,
+
+      # TODO: Write general description for WIRECARD
+      WIRECARD = 'wirecard'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREDIT_CARD_VAULT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/credit_note.rb

@@ -147,8 +147,8 @@ module AdvancedBilling
 
     # An array of origin invoices for the credit note. Learn more about [Origin
     # Invoice from our
-    # docs](https://chargify.zendesk.com/hc/en-us/articles/4407753036699#origin-
-    # invoices)
+    # docs](https://maxio.zendesk.com/hc/en-us/articles/24252261284749-Credit-No
+    # tes-Proration#origin-invoices)
     # @return [Array[OriginInvoice]]
     attr_accessor :origin_invoices
 

data/lib/advanced_billing/models/customer.rb

@@ -129,6 +129,10 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :default_subscription_group_uid
 
+    # The Salesforce ID for the customer
+    # @return [String]
+    attr_accessor :salesforce_id
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -161,6 +165,7 @@ module AdvancedBilling
       @_hash['locale'] = 'locale'
       @_hash['default_subscription_group_uid'] =
         'default_subscription_group_uid'
+      @_hash['salesforce_id'] = 'salesforce_id'
       @_hash
     end
 
@@ -194,6 +199,7 @@ module AdvancedBilling
         parent_id
         locale
         default_subscription_group_uid
+        salesforce_id
       ]
     end
 
@@ -220,6 +226,7 @@ module AdvancedBilling
         parent_id
         locale
         default_subscription_group_uid
+        salesforce_id
       ]
     end
 
@@ -232,7 +239,7 @@ module AdvancedBilling
                    portal_invite_last_sent_at: SKIP,
                    portal_invite_last_accepted_at: SKIP, tax_exempt: SKIP,
                    vat_number: SKIP, parent_id: SKIP, locale: SKIP,
-                   default_subscription_group_uid: SKIP,
+                   default_subscription_group_uid: SKIP, salesforce_id: SKIP,
                    additional_properties: {})
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
@@ -273,6 +280,7 @@ module AdvancedBilling
         @default_subscription_group_uid =
           default_subscription_group_uid
       end
+      @salesforce_id = salesforce_id unless salesforce_id == SKIP
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -333,6 +341,7 @@ module AdvancedBilling
       locale = hash.key?('locale') ? hash['locale'] : SKIP
       default_subscription_group_uid =
         hash.key?('default_subscription_group_uid') ? hash['default_subscription_group_uid'] : SKIP
+      salesforce_id = hash.key?('salesforce_id') ? hash['salesforce_id'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -365,6 +374,7 @@ module AdvancedBilling
                    parent_id: parent_id,
                    locale: locale,
                    default_subscription_group_uid: default_subscription_group_uid,
+                   salesforce_id: salesforce_id,
                    additional_properties: hash)
     end
 

data/lib/advanced_billing/models/customer_attributes.rb

@@ -101,6 +101,10 @@ module AdvancedBilling
     # @return [Integer]
     attr_accessor :parent_id
 
+    # (Optional) The Salesforce ID of the customer.
+    # @return [String]
+    attr_accessor :salesforce_id
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -122,6 +126,7 @@ module AdvancedBilling
       @_hash['vat_number'] = 'vat_number'
       @_hash['metafields'] = 'metafields'
       @_hash['parent_id'] = 'parent_id'
+      @_hash['salesforce_id'] = 'salesforce_id'
       @_hash
     end
 
@@ -146,6 +151,7 @@ module AdvancedBilling
         vat_number
         metafields
         parent_id
+        salesforce_id
       ]
     end
 
@@ -154,6 +160,7 @@ module AdvancedBilling
       %w[
         address_2
         parent_id
+        salesforce_id
       ]
     end
 
@@ -162,7 +169,8 @@ module AdvancedBilling
                    address: SKIP, address_2: SKIP, city: SKIP, state: SKIP,
                    zip: SKIP, country: SKIP, phone: SKIP, verified: SKIP,
                    tax_exempt: SKIP, vat_number: SKIP, metafields: SKIP,
-                   parent_id: SKIP, additional_properties: {})
+                   parent_id: SKIP, salesforce_id: SKIP,
+                   additional_properties: {})
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
       @email = email unless email == SKIP
@@ -181,6 +189,7 @@ module AdvancedBilling
       @vat_number = vat_number unless vat_number == SKIP
       @metafields = metafields unless metafields == SKIP
       @parent_id = parent_id unless parent_id == SKIP
+      @salesforce_id = salesforce_id unless salesforce_id == SKIP
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -211,6 +220,7 @@ module AdvancedBilling
       vat_number = hash.key?('vat_number') ? hash['vat_number'] : SKIP
       metafields = hash.key?('metafields') ? hash['metafields'] : SKIP
       parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+      salesforce_id = hash.key?('salesforce_id') ? hash['salesforce_id'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -234,6 +244,7 @@ module AdvancedBilling
                              vat_number: vat_number,
                              metafields: metafields,
                              parent_id: parent_id,
+                             salesforce_id: salesforce_id,
                              additional_properties: hash)
     end
 

data/lib/advanced_billing/models/ebb_component.rb

@@ -157,6 +157,7 @@ module AdvancedBilling
       %w[
         upgrade_charge
         downgrade_credit
+        interval_unit
       ]
     end
 

data/lib/advanced_billing/models/{extended_interval_unit.rb → expiration_interval_unit.rb}

@@ -4,9 +4,9 @@
 # ( https://apimatic.io ).
 
 module AdvancedBilling
-  # Extended Interval Unit.
-  class ExtendedIntervalUnit
-    EXTENDED_INTERVAL_UNIT = [
+  # Expiration Interval Unit.
+  class ExpirationIntervalUnit
+    EXPIRATION_INTERVAL_UNIT = [
       # TODO: Write general description for DAY
       DAY = 'day'.freeze,
 
@@ -20,7 +20,7 @@ module AdvancedBilling
     def self.validate(value)
       return false if value.nil?
 
-      EXTENDED_INTERVAL_UNIT.include?(value)
+      EXPIRATION_INTERVAL_UNIT.include?(value)
     end
   end
 end