maxio-advanced-billing-sdk 7.0.0 → 8.0.0

data/lib/advanced_billing/controllers/webhooks_controller.rb

@@ -6,30 +6,10 @@
 module AdvancedBilling
   # WebhooksController
   class WebhooksController < BaseController
-    # ## Webhooks Intro
-    # The Webhooks API allows you to view a list of all webhooks and to
-    # selectively resend individual or groups of webhooks. Webhooks will be sent
-    # on endpoints specified by you. Endpoints can be added via API or Web UI.
-    # There is also an option to enable / disable webhooks via API request.
-    # We recommend that you review Advanced Billing's webhook documentation
-    # located in our help site. The following resources will help guide you on
-    # how to use webhooks in Advanced Billing, in addition to these webhook
-    # endpoints:
-    # + [Adding/editing new
-    # webhooks](https://maxio.zendesk.com/hc/en-us/articles/24286723085197-Webho
-    # oks#configure-webhook-url)
-    # + [Webhooks introduction and delivery
-    # information](https://maxio.zendesk.com/hc/en-us/articles/24266143173901-We
-    # bhooks-Overview)
-    # + [Main webhook
-    # reference](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webh
-    # ooks-Reference)
-    # + [Available webhooks and
-    # payloads](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webho
-    # oks-Reference#events)
-    # ## List Webhooks for a Site
-    # This method allows you to fetch data about webhooks. You can pass query
-    # parameters if you want to filter webhooks.
+    # Allows you to view a list of webhooks.  You can pass query parameters if
+    # you want to filter webhooks. See the
+    # [Webhooks](page:introduction/webhooks/webhooks) documentation for more
+    # information.
     # @param [WebhookStatus] status Optional parameter: Webhooks with matching
     # status would be returned.
     # @param [String] since_date Optional parameter: Format YYYY-MM-DD. Returns
@@ -75,7 +55,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This method allows you to enable webhooks via API for your site
+    # Allows you to enable webhooks for your site
     # @param [EnableWebhooksRequest] body Optional parameter: TODO: type
     # description here
     # @return [EnableWebhooksResponse] Response from the API call.
@@ -95,11 +75,10 @@ module AdvancedBilling
         .execute
     end
 
-    # Posting to the replay endpoint does not immediately resend the webhooks.
-    # They are added to a queue and will be sent as soon as possible, depending
-    # on available system resources.
-    # You may submit an array of up to 1000 webhook IDs to replay in the
-    # request.
+    # Replays webhooks. Posting to this endpoint does not immediately resend the
+    # webhooks. They are added to a queue and sent as soon as possible,
+    # depending on available system resources. You can submit an array of up to
+    # 1000 webhook IDs in the replay request.
     # @param [ReplayWebhooksRequest] body Optional parameter: TODO: type
     # description here
     # @return [ReplayWebhooksResponse] Response from the API call.
@@ -119,12 +98,11 @@ module AdvancedBilling
         .execute
     end
 
-    # The Chargify API allows you to create an endpoint and assign a list of
-    # webhooks subscriptions (events) to it.
-    # You can check available events here.
-    # [Event
-    # keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
-    # Reference#events)
+    # Creates an endpoint and assigns a list of webhooks subscriptions (events)
+    # to it.
+    # See the [Webhooks
+    # Reference](page:introduction/webhooks/webhooks-reference#events) page for
+    # available events.
     # @param [CreateOrUpdateEndpointRequest] body Optional parameter: TODO: type
     # description here
     # @return [EndpointResponse] Response from the API call.
@@ -148,7 +126,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This method returns created endpoints for site.
+    # Returns created endpoints for a site.
     # @return [Array[Endpoint]] Response from the API call.
     def list_endpoints
       @api_call
@@ -164,17 +142,14 @@ module AdvancedBilling
         .execute
     end
 
-    # You can update an Endpoint via the API with a PUT request to the resource
-    # endpoint.
-    # You can change the `url` of your endpoint which consumes webhooks or list
-    # of `webhook_subscriptions`.
-    # Check available [Event
-    # keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
-    # Reference#events).
-    # Always send a complete list of events which you want subscribe/watch.
-    # Sending an PUT request for existing endpoint with empty list of
-    # `webhook_subscriptions` will end with unsubscribe from all events.
-    # If you want unsubscribe from specific event, just send a list of
+    # Updates an Endpoint. You can change the `url` of your endpoint or the list
+    # of `webhook_subscriptions` to which you are subscribed. See the [Webhooks
+    # Reference](page:introduction/webhooks/webhooks-reference#events) page for
+    # available events.
+    # Always send a complete list of events to which you want to subscribe.
+    # Sending a PUT request for an existing endpoint with an empty list of
+    # `webhook_subscriptions` will unsubscribe all events.
+    # If you want unsubscribe from a specific event, send a list of
     # `webhook_subscriptions` without the specific event key.
     # @param [Integer] endpoint_id Required parameter: The Advanced Billing id
     # for the endpoint that should be updated

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

@@ -0,0 +1,22 @@
+# advanced_billing
+#
+# This file was automatically generated for Maxio by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module AdvancedBilling
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # 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