# frozen_string_literal: true

SolidusSubscriptions.configure do |config|
  # ========================================= Basic config =========================================

  # The ActiveRecord model users can subscribe to.
  # config.subscribable_class = 'Spree::Variant'

  # Which queue is responsible for processing subscription background jobs.
  # config.processing_queue = :default

  # Maximum number of times a user can skip their subscription before it must be processed.
  # config.maximum_successive_skips = 1

  # Maximum number of times a user can skip their subscription.
  # config.maximum_total_skips = nil

  # Minimum days between the current date and the next installment for the installment not to be
  # processed after the user cancels their subscription.
  # config.minimum_cancellation_notice = 1.day

  # Time between an installment failing to be processed and the system retrying to fulfill it.
  # config.reprocessing_interval = 1.day

  # Maximum time that can pass after the last succesfull subscription installment to make a payment
  # failure cancel the subscription.
  # config.maximum_reprocessing_time = nil

  # This custom error handler is called when a ProcessInstallmentJob `#perform` method fails.
  # The rescued error can be managed as required via a Proc, such as one which logs the error
  # on an error tracking system.
  # Though not recommended due to the retry mechanisms built into this gem, the error can be
  # re-raised if the default retry behaviour is required in ActiveJob.
  # config.processing_error_handler = nil

  # ========================================= Dispatchers ==========================================
  #
  # These dispatchers are pluggable. If you override any handlers, it is highly encouraged that you
  # subclass from the the dispatcher you are replacing and call `super` from within `#dispatch`.

  # This handler is called when a subscription order is successfully placed.
  # config.success_dispatcher_class = 'SolidusSubscriptions::Dispatcher::SuccessDispatcher'

  # This handler is called when a group of installments fails to be processed.
  # config.failure_dispatcher_class = 'SolidusSubscriptions::Dispatcher::FailureDispatcher'

  # This handler is called when a payment fails on a subscription order.
  # config.payment_failed_dispatcher_class = 'SolidusSubscriptions::Dispatcher::PaymentFailedDispatcher'

  # This handler is called when there isn't enough stock to fulfill an installment.
  # config.out_of_stock_dispatcher = 'SolidusSubscriptions::Dispatcher::OutOfStockDispatcher'

  # ===================================== Permitted attributes =====================================
  #
  # In this section, you can override the list of attributes the user can pass to the controllers.
  #
  # This is useful in the case where certain fields should not be allowed to be modified by the
  # user, or if you add additional fields to the extension's model and you want the users to be able
  # to set them.

  # Attributes the user can specify for subscriptions.
  # config.subscription_attributes = [
  #   :interval_length,
  #   :interval_units,
  #   :end_date,
  #   shipping_address_attributes: Spree::PermittedAttributes.address_attributes,
  #   billing_address_attributes: Spree::PermittedAttributes.address_attributes,
  # ]

  # Attributes the user be specify for subscription line items.
  # config.subscription_line_item_attributes = [
  #   :quantity,
  #   :subscribable_id,
  #   :interval_length,
  #   :interval_units,
  #   :end_date,
  # ]

  # ========================================= Churn Buster =========================================
  #
  # This extension can integrate with Churn Buster for churn mitigation and failed payment recovery.
  # If you want to integrate with Churn Buster, simply configure your credentials below.
  #
  # NOTE: If you integrate with Churn Buster and override any of the handlers, make sure to call
  # `super` or copy-paste the original integration code or things won't work!

  # Your Churn Buster account ID.
  # config.churn_buster_account_id = 'YOUR_CHURN_BUSTER_ACCOUNT_ID'

  # Your Churn Buster API key.
  # config.churn_buster_api_key = 'YOUR_CHURN_BUSTER_API_KEY'

  # =================================== Clear past installments ====================================
  #
  # This setting prevents the overlap of old failed installments (e.g. for an expired credit card)
  # with new subscription cycles by clearing any past failed installment when a new one is created

  # config.clear_past_installments = true

  # ==================================== Custom Order Creation =====================================
  #
  # This settings allows the customization of the creation of each Installment Order and / or
  # adding additional attributes to the Order
  #
  # config.order_creation_class = 'SolidusSubscriptions::OrderCreator'
  #
  # this class is initialized and called on the creation of the Order for each Subscription Installment
  # along with a customizable hash of extra attributes that can also be configured, like below:
  # config.order_creation_extra_attributes = { channel: 'subscriptions' }
  #
  #
  # config.order_creation_extra_attributes = { }
end