summaryrefslogtreecommitdiff
path: root/lib/generators/solidus_subscriptions/install/templates/initializer.rb
blob: 3de51828d482406362fe2aacf20b661fa1e33617 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# frozen_string_literal: true

SolidusSubscriptions::Config.tap do |config|
  # These handlers are pluggable, however it is highly encouraged that
  # you subclass from the the dispatcher you are replacing, and call
  # `super` from within the #dispatch method (if you override it).

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

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

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

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

  # 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. Once this limit
  # is reached, no more skips are permitted.
  # config.maximum_total_skips = nil

  # Minimum days between the current date and the next installment for the
  # installment not to be processed after subscription cancellation.
  # 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

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

  # SolidusSubscriptions::LineItem attributes which are allowed to
  # be updated from user data
  #
  # This is useful in the case where certain fields should not be allowed to
  # be modified by the user. This locks these attributes from being passed
  # to the orders controller (or the API controller).
  #
  # For example, if a store does not want to allow users to configure the end
  # date of a subscription, set this:
  #
  # ```
  # SolidusSubscriptions::Config.subscription_line_item_attributes = [
  #   :quantity,
  #   :subscribable_id,
  #   :interval_length,
  #   :interval_units,
  # ]
  # ```
  #
  # You can also add additional attributes that you want to track in the
  # subscription line items.
  # config.subscription_line_item_attributes = [
  #   :quantity,
  #   :subscribable_id,
  #   :interval_length,
  #   :interval_units,
  #   :end_date,
  # ]

  # SolidusSubscriptions::Subscription attributes which are allowed to
  # be modified by the user.
  # config.subscription_attributes = [
  #   :interval_length,
  #   :interval_units,
  #   :end_date,
  #   :actionable_date,
  #   shipping_address_attributes: Spree::PermittedAttributes.address_attributes,
  #   billing_address_attributes: Spree::PermittedAttributes.address_attributes,
  # ]
end