dodopayments 2.9.0 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +1 -1
- data/lib/dodopayments/internal/transport/base_client.rb +2 -0
- data/lib/dodopayments/internal/type/union.rb +21 -7
- data/lib/dodopayments/models/abandoned_checkout_detected_webhook_event.rb +4 -16
- data/lib/dodopayments/models/abandoned_checkout_recovered_webhook_event.rb +4 -16
- data/lib/dodopayments/models/checkout_session_request.rb +15 -2
- data/lib/dodopayments/models/credit_added_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_balance_low_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_deducted_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_expired_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_manual_adjustment_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_overage_charged_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_overage_reset_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_rolled_over_webhook_event.rb +4 -16
- data/lib/dodopayments/models/credit_rollover_forfeited_webhook_event.rb +4 -16
- data/lib/dodopayments/models/digital_product_delivery.rb +14 -7
- data/lib/dodopayments/models/digital_product_delivery_file.rb +12 -5
- data/lib/dodopayments/models/dispute_accepted_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dispute_cancelled_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dispute_challenged_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dispute_expired_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dispute_lost_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dispute_opened_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dispute_won_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dunning_recovered_webhook_event.rb +4 -16
- data/lib/dodopayments/models/dunning_started_webhook_event.rb +4 -16
- data/lib/dodopayments/models/entitlement.rb +31 -20
- data/lib/dodopayments/models/entitlement_create_params.rb +3 -3
- data/lib/dodopayments/models/entitlement_grant_created_webhook_event.rb +10 -17
- data/lib/dodopayments/models/entitlement_grant_delivered_webhook_event.rb +10 -17
- data/lib/dodopayments/models/entitlement_grant_failed_webhook_event.rb +10 -17
- data/lib/dodopayments/models/entitlement_grant_revoked_webhook_event.rb +10 -17
- data/lib/dodopayments/models/entitlement_update_params.rb +3 -3
- data/lib/dodopayments/models/entitlements/entitlement_grant.rb +50 -32
- data/lib/dodopayments/models/entitlements/file_upload_response.rb +3 -3
- data/lib/dodopayments/models/entitlements/license_key_grant.rb +14 -9
- data/lib/dodopayments/models/integration_config.rb +70 -27
- data/lib/dodopayments/models/integration_config_response.rb +88 -48
- data/lib/dodopayments/models/license_key_created_webhook_event.rb +4 -16
- data/lib/dodopayments/models/payment.rb +153 -3
- data/lib/dodopayments/models/payment_cancelled_webhook_event.rb +4 -16
- data/lib/dodopayments/models/payment_create_params.rb +15 -3
- data/lib/dodopayments/models/payment_create_response.rb +14 -3
- data/lib/dodopayments/models/payment_failed_webhook_event.rb +4 -16
- data/lib/dodopayments/models/payment_processing_webhook_event.rb +4 -16
- data/lib/dodopayments/models/payment_succeeded_webhook_event.rb +4 -16
- data/lib/dodopayments/models/payout_list_response.rb +6 -3
- data/lib/dodopayments/models/price.rb +20 -48
- data/lib/dodopayments/models/product.rb +6 -8
- data/lib/dodopayments/models/product_create_params.rb +3 -3
- data/lib/dodopayments/models/product_entitlement_summary.rb +5 -5
- data/lib/dodopayments/models/product_item_req.rb +42 -1
- data/lib/dodopayments/models/product_update_params.rb +3 -3
- data/lib/dodopayments/models/refund_failed_webhook_event.rb +4 -16
- data/lib/dodopayments/models/refund_succeeded_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription.rb +153 -5
- data/lib/dodopayments/models/subscription_active_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription_cancelled_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription_create_params.rb +15 -3
- data/lib/dodopayments/models/subscription_create_response.rb +14 -3
- data/lib/dodopayments/models/subscription_expired_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription_failed_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription_list_response.rb +36 -5
- data/lib/dodopayments/models/subscription_on_hold_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription_plan_changed_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription_preview_change_plan_response.rb +21 -49
- data/lib/dodopayments/models/subscription_renewed_webhook_event.rb +4 -16
- data/lib/dodopayments/models/subscription_update_payment_method_params.rb +12 -30
- data/lib/dodopayments/models/subscription_updated_webhook_event.rb +4 -16
- data/lib/dodopayments/models/unsafe_unwrap_webhook_event.rb +41 -39
- data/lib/dodopayments/models/unwrap_webhook_event.rb +41 -39
- data/lib/dodopayments/models/update_subscription_plan_req.rb +17 -6
- data/lib/dodopayments/models/webhook_event_type.rb +3 -0
- data/lib/dodopayments/models/webhook_payload.rb +57 -143
- data/lib/dodopayments/resources/checkout_sessions.rb +8 -4
- data/lib/dodopayments/resources/entitlements/files.rb +3 -10
- data/lib/dodopayments/resources/entitlements/grants.rb +2 -4
- data/lib/dodopayments/resources/entitlements.rb +2 -2
- data/lib/dodopayments/resources/payments.rb +4 -2
- data/lib/dodopayments/resources/subscriptions.rb +12 -6
- data/lib/dodopayments/version.rb +1 -1
- data/rbi/dodopayments/models/abandoned_checkout_detected_webhook_event.rbi +4 -40
- data/rbi/dodopayments/models/abandoned_checkout_recovered_webhook_event.rbi +4 -40
- data/rbi/dodopayments/models/checkout_session_request.rbi +14 -0
- data/rbi/dodopayments/models/credit_added_webhook_event.rbi +4 -29
- data/rbi/dodopayments/models/credit_balance_low_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/credit_deducted_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/credit_expired_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/credit_manual_adjustment_webhook_event.rbi +4 -39
- data/rbi/dodopayments/models/credit_overage_charged_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/credit_overage_reset_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/credit_rolled_over_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/credit_rollover_forfeited_webhook_event.rbi +4 -40
- data/rbi/dodopayments/models/digital_product_delivery.rbi +15 -5
- data/rbi/dodopayments/models/digital_product_delivery_file.rbi +11 -0
- data/rbi/dodopayments/models/dispute_accepted_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/dispute_cancelled_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/dispute_challenged_webhook_event.rbi +4 -34
- data/rbi/dodopayments/models/dispute_expired_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/dispute_lost_webhook_event.rbi +4 -29
- data/rbi/dodopayments/models/dispute_opened_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/dispute_won_webhook_event.rbi +4 -29
- data/rbi/dodopayments/models/dunning_recovered_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/dunning_started_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/entitlement.rbi +35 -20
- data/rbi/dodopayments/models/entitlement_create_params.rbi +8 -5
- data/rbi/dodopayments/models/entitlement_grant_created_webhook_event.rbi +8 -40
- data/rbi/dodopayments/models/entitlement_grant_delivered_webhook_event.rbi +8 -40
- data/rbi/dodopayments/models/entitlement_grant_failed_webhook_event.rbi +8 -39
- data/rbi/dodopayments/models/entitlement_grant_revoked_webhook_event.rbi +8 -40
- data/rbi/dodopayments/models/entitlement_update_params.rbi +4 -4
- data/rbi/dodopayments/models/entitlements/entitlement_grant.rbi +54 -20
- data/rbi/dodopayments/models/entitlements/file_upload_response.rbi +4 -4
- data/rbi/dodopayments/models/entitlements/license_key_grant.rbi +10 -4
- data/rbi/dodopayments/models/integration_config.rbi +141 -26
- data/rbi/dodopayments/models/integration_config_response.rbi +153 -38
- data/rbi/dodopayments/models/license_key_created_webhook_event.rbi +4 -34
- data/rbi/dodopayments/models/payment.rbi +170 -2
- data/rbi/dodopayments/models/payment_cancelled_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/payment_create_params.rbi +14 -2
- data/rbi/dodopayments/models/payment_create_response.rbi +12 -2
- data/rbi/dodopayments/models/payment_failed_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/payment_processing_webhook_event.rbi +4 -34
- data/rbi/dodopayments/models/payment_succeeded_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/price.rbi +18 -90
- data/rbi/dodopayments/models/product.rbi +4 -8
- data/rbi/dodopayments/models/product_entitlement_summary.rbi +8 -8
- data/rbi/dodopayments/models/product_item_req.rbi +74 -3
- data/rbi/dodopayments/models/refund_failed_webhook_event.rbi +4 -31
- data/rbi/dodopayments/models/refund_succeeded_webhook_event.rbi +4 -33
- data/rbi/dodopayments/models/subscription.rbi +173 -4
- data/rbi/dodopayments/models/subscription_active_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/subscription_cancelled_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/subscription_create_params.rbi +14 -2
- data/rbi/dodopayments/models/subscription_create_response.rbi +12 -2
- data/rbi/dodopayments/models/subscription_expired_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/subscription_failed_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/subscription_list_response.rbi +67 -4
- data/rbi/dodopayments/models/subscription_on_hold_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/subscription_plan_changed_webhook_event.rbi +4 -40
- data/rbi/dodopayments/models/subscription_preview_change_plan_response.rbi +18 -123
- data/rbi/dodopayments/models/subscription_renewed_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/subscription_update_payment_method_params.rbi +12 -96
- data/rbi/dodopayments/models/subscription_updated_webhook_event.rbi +4 -36
- data/rbi/dodopayments/models/update_subscription_plan_req.rbi +18 -8
- data/rbi/dodopayments/models/webhook_event_type.rbi +15 -0
- data/rbi/dodopayments/models/webhook_payload.rbi +48 -466
- data/rbi/dodopayments/resources/checkout_sessions.rbi +12 -0
- data/rbi/dodopayments/resources/entitlements/files.rbi +3 -10
- data/rbi/dodopayments/resources/entitlements/grants.rbi +2 -4
- data/rbi/dodopayments/resources/entitlements.rbi +4 -4
- data/rbi/dodopayments/resources/payments.rbi +6 -1
- data/rbi/dodopayments/resources/subscriptions.rbi +22 -9
- data/sig/dodopayments/models/abandoned_checkout_detected_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/abandoned_checkout_recovered_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/checkout_session_request.rbs +5 -0
- data/sig/dodopayments/models/credit_added_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_balance_low_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_deducted_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_expired_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_manual_adjustment_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_overage_charged_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_overage_reset_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_rolled_over_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/credit_rollover_forfeited_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dispute_accepted_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dispute_cancelled_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dispute_challenged_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dispute_expired_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dispute_lost_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dispute_opened_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dispute_won_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dunning_recovered_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/dunning_started_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/entitlement.rbs +8 -10
- data/sig/dodopayments/models/entitlement_create_params.rbs +6 -4
- data/sig/dodopayments/models/entitlement_grant_created_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/entitlement_grant_delivered_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/entitlement_grant_failed_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/entitlement_grant_revoked_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/entitlements/entitlement_grant.rbs +4 -11
- data/sig/dodopayments/models/integration_config.rbs +28 -4
- data/sig/dodopayments/models/integration_config_response.rbs +28 -9
- data/sig/dodopayments/models/license_key_created_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/payment.rbs +97 -0
- data/sig/dodopayments/models/payment_cancelled_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/payment_create_params.rbs +5 -0
- data/sig/dodopayments/models/payment_create_response.rbs +5 -0
- data/sig/dodopayments/models/payment_failed_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/payment_processing_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/payment_succeeded_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/price.rbs +15 -45
- data/sig/dodopayments/models/product_item_req.rbs +27 -3
- data/sig/dodopayments/models/refund_failed_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/refund_succeeded_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription.rbs +97 -0
- data/sig/dodopayments/models/subscription_active_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription_cancelled_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription_create_params.rbs +5 -0
- data/sig/dodopayments/models/subscription_create_response.rbs +5 -0
- data/sig/dodopayments/models/subscription_expired_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription_failed_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription_list_response.rbs +24 -0
- data/sig/dodopayments/models/subscription_on_hold_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription_plan_changed_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription_preview_change_plan_response.rbs +15 -45
- data/sig/dodopayments/models/subscription_renewed_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/subscription_update_payment_method_params.rbs +8 -48
- data/sig/dodopayments/models/subscription_updated_webhook_event.rbs +4 -14
- data/sig/dodopayments/models/update_subscription_plan_req.rbs +5 -0
- data/sig/dodopayments/models/webhook_event_type.rbs +6 -0
- data/sig/dodopayments/models/webhook_payload.rbs +50 -213
- data/sig/dodopayments/resources/checkout_sessions.rbs +2 -0
- data/sig/dodopayments/resources/entitlements.rbs +1 -1
- data/sig/dodopayments/resources/payments.rbs +1 -0
- data/sig/dodopayments/resources/subscriptions.rbs +3 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d827139482498b3f218d10da46c7dc1cd1ab9ad8b0ae2c189cec3e569d89281c
|
|
4
|
+
data.tar.gz: df661b3d70d0b2db7c2303178ac94af3fbf2aabcac58ed713f877e5798f6f97a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7672453866107e0a8c5ff8a861b6ac40849258cca2ab525176484a0037d35b9cdf953e2e0426cfe72c8ca9759a11875ec3ae01526cd0a849330c44af1b30647b
|
|
7
|
+
data.tar.gz: 5a38f85089af1044e74042865fcf907db78b1ad5b1d5f52e5b26071a127febbf6a001342c706e08961b59adf17099a7a9c4f88cda01aff4eae5afdfd58982426
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.10.0 (2026-05-14)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v2.9.1...v2.10.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.9.1...v2.10.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** manual updates ([5bea624](https://github.com/dodopayments/dodopayments-ruby/commit/5bea6246c3a998c3587e24a9c345a41000a87e31))
|
|
10
|
+
* **api:** updated openapi spec to 1.98.0 ([4747cdf](https://github.com/dodopayments/dodopayments-ruby/commit/4747cdf437c49a58c4e70908e08e4bd853dd0859))
|
|
11
|
+
* **api:** updated openapi spec to v1.97.10 ([4b79dec](https://github.com/dodopayments/dodopayments-ruby/commit/4b79dec6275293cce30c1db6d682eeb4ee1f69b7))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Bug Fixes
|
|
15
|
+
|
|
16
|
+
* **client:** elide content type header on requests without body ([036bd33](https://github.com/dodopayments/dodopayments-ruby/commit/036bd33ad42365dfd68d18274297dcb46887ab94))
|
|
17
|
+
|
|
18
|
+
## 2.9.1 (2026-05-04)
|
|
19
|
+
|
|
20
|
+
Full Changelog: [v2.9.0...v2.9.1](https://github.com/dodopayments/dodopayments-ruby/compare/v2.9.0...v2.9.1)
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* **api:** update openapi spec ([70ea025](https://github.com/dodopayments/dodopayments-ruby/commit/70ea025d3eac9e8d76227be87d301d852d1a3518))
|
|
25
|
+
|
|
3
26
|
## 2.9.0 (2026-04-30)
|
|
4
27
|
|
|
5
28
|
Full Changelog: [v2.8.1...v2.9.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.8.1...v2.9.0)
|
data/README.md
CHANGED
|
@@ -306,6 +306,8 @@ module Dodopayments
|
|
|
306
306
|
Dodopayments::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
|
|
307
307
|
end
|
|
308
308
|
|
|
309
|
+
headers.delete("content-type") if body.nil?
|
|
310
|
+
|
|
309
311
|
url = Dodopayments::Internal::Util.join_parsed_uri(
|
|
310
312
|
@base_url_components,
|
|
311
313
|
{**req, path: path, query: query}
|
|
@@ -6,14 +6,28 @@ module Dodopayments
|
|
|
6
6
|
# @api private
|
|
7
7
|
#
|
|
8
8
|
# @example
|
|
9
|
-
# # `
|
|
10
|
-
# case
|
|
11
|
-
# when Dodopayments::
|
|
12
|
-
# puts(
|
|
13
|
-
# when Dodopayments::
|
|
14
|
-
# puts(
|
|
9
|
+
# # `price` is a `Dodopayments::Price`
|
|
10
|
+
# case price
|
|
11
|
+
# when Dodopayments::Price::OneTimePrice
|
|
12
|
+
# puts(price.currency)
|
|
13
|
+
# when Dodopayments::Price::RecurringPrice
|
|
14
|
+
# puts(price.discount)
|
|
15
|
+
# when Dodopayments::Price::UsageBasedPrice
|
|
16
|
+
# puts(price.fixed_price)
|
|
15
17
|
# else
|
|
16
|
-
# puts(
|
|
18
|
+
# puts(price)
|
|
19
|
+
# end
|
|
20
|
+
#
|
|
21
|
+
# @example
|
|
22
|
+
# case price
|
|
23
|
+
# in {type: :one_time_price, currency: currency, discount: discount, price: price}
|
|
24
|
+
# puts(currency)
|
|
25
|
+
# in {type: :recurring_price, currency: currency, discount: discount, payment_frequency_count: payment_frequency_count}
|
|
26
|
+
# puts(discount)
|
|
27
|
+
# in {type: :usage_based_price, currency: currency, discount: discount, fixed_price: fixed_price}
|
|
28
|
+
# puts(fixed_price)
|
|
29
|
+
# else
|
|
30
|
+
# puts(price)
|
|
17
31
|
# end
|
|
18
32
|
module Union
|
|
19
33
|
include Dodopayments::Internal::Type::Converter
|
|
@@ -25,10 +25,10 @@ module Dodopayments
|
|
|
25
25
|
# @!attribute type
|
|
26
26
|
# The event type
|
|
27
27
|
#
|
|
28
|
-
# @return [Symbol,
|
|
29
|
-
required :type,
|
|
28
|
+
# @return [Symbol, :"abandoned_checkout.detected"]
|
|
29
|
+
required :type, const: :"abandoned_checkout.detected"
|
|
30
30
|
|
|
31
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
31
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"abandoned_checkout.detected")
|
|
32
32
|
# Some parameter documentations has been truncated, see
|
|
33
33
|
# {Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent} for more details.
|
|
34
34
|
#
|
|
@@ -38,7 +38,7 @@ module Dodopayments
|
|
|
38
38
|
#
|
|
39
39
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
40
40
|
#
|
|
41
|
-
# @param type [Symbol,
|
|
41
|
+
# @param type [Symbol, :"abandoned_checkout.detected"] The event type
|
|
42
42
|
|
|
43
43
|
# @see Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent#data
|
|
44
44
|
class Data < Dodopayments::Internal::Type::BaseModel
|
|
@@ -109,18 +109,6 @@ module Dodopayments
|
|
|
109
109
|
# @return [Array<Symbol>]
|
|
110
110
|
end
|
|
111
111
|
end
|
|
112
|
-
|
|
113
|
-
# The event type
|
|
114
|
-
#
|
|
115
|
-
# @see Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent#type
|
|
116
|
-
module Type
|
|
117
|
-
extend Dodopayments::Internal::Type::Enum
|
|
118
|
-
|
|
119
|
-
ABANDONED_CHECKOUT_DETECTED = :"abandoned_checkout.detected"
|
|
120
|
-
|
|
121
|
-
# @!method self.values
|
|
122
|
-
# @return [Array<Symbol>]
|
|
123
|
-
end
|
|
124
112
|
end
|
|
125
113
|
end
|
|
126
114
|
end
|
|
@@ -25,10 +25,10 @@ module Dodopayments
|
|
|
25
25
|
# @!attribute type
|
|
26
26
|
# The event type
|
|
27
27
|
#
|
|
28
|
-
# @return [Symbol,
|
|
29
|
-
required :type,
|
|
28
|
+
# @return [Symbol, :"abandoned_checkout.recovered"]
|
|
29
|
+
required :type, const: :"abandoned_checkout.recovered"
|
|
30
30
|
|
|
31
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
31
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"abandoned_checkout.recovered")
|
|
32
32
|
# Some parameter documentations has been truncated, see
|
|
33
33
|
# {Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent} for more details.
|
|
34
34
|
#
|
|
@@ -38,7 +38,7 @@ module Dodopayments
|
|
|
38
38
|
#
|
|
39
39
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
40
40
|
#
|
|
41
|
-
# @param type [Symbol,
|
|
41
|
+
# @param type [Symbol, :"abandoned_checkout.recovered"] The event type
|
|
42
42
|
|
|
43
43
|
# @see Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent#data
|
|
44
44
|
class Data < Dodopayments::Internal::Type::BaseModel
|
|
@@ -109,18 +109,6 @@ module Dodopayments
|
|
|
109
109
|
# @return [Array<Symbol>]
|
|
110
110
|
end
|
|
111
111
|
end
|
|
112
|
-
|
|
113
|
-
# The event type
|
|
114
|
-
#
|
|
115
|
-
# @see Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent#type
|
|
116
|
-
module Type
|
|
117
|
-
extend Dodopayments::Internal::Type::Enum
|
|
118
|
-
|
|
119
|
-
ABANDONED_CHECKOUT_RECOVERED = :"abandoned_checkout.recovered"
|
|
120
|
-
|
|
121
|
-
# @!method self.values
|
|
122
|
-
# @return [Array<Symbol>]
|
|
123
|
-
end
|
|
124
112
|
end
|
|
125
113
|
end
|
|
126
114
|
end
|
|
@@ -68,10 +68,21 @@ module Dodopayments
|
|
|
68
68
|
optional :customization, -> { Dodopayments::CheckoutSessionCustomization }
|
|
69
69
|
|
|
70
70
|
# @!attribute discount_code
|
|
71
|
+
# @deprecated Use `discount_id` instead.
|
|
72
|
+
#
|
|
73
|
+
# DEPRECATED: Use discount_codes instead. Cannot be used together with
|
|
74
|
+
# discount_codes.
|
|
71
75
|
#
|
|
72
76
|
# @return [String, nil]
|
|
73
77
|
optional :discount_code, String, nil?: true
|
|
74
78
|
|
|
79
|
+
# @!attribute discount_codes
|
|
80
|
+
# Stacked discount codes to apply, in order. Max 20. Cannot be used together with
|
|
81
|
+
# discount_code.
|
|
82
|
+
#
|
|
83
|
+
# @return [Array<String>, nil]
|
|
84
|
+
optional :discount_codes, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
|
|
85
|
+
|
|
75
86
|
# @!attribute feature_flags
|
|
76
87
|
#
|
|
77
88
|
# @return [Dodopayments::Models::CheckoutSessionFlags, nil]
|
|
@@ -151,7 +162,7 @@ module Dodopayments
|
|
|
151
162
|
# @return [String, nil]
|
|
152
163
|
optional :tax_id, String, nil?: true
|
|
153
164
|
|
|
154
|
-
# @!method initialize(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil)
|
|
165
|
+
# @!method initialize(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, discount_codes: nil, feature_flags: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil)
|
|
155
166
|
# Some parameter documentations has been truncated, see
|
|
156
167
|
# {Dodopayments::Models::CheckoutSessionRequest} for more details.
|
|
157
168
|
#
|
|
@@ -173,7 +184,9 @@ module Dodopayments
|
|
|
173
184
|
#
|
|
174
185
|
# @param customization [Dodopayments::Models::CheckoutSessionCustomization] Customization for the checkout session page
|
|
175
186
|
#
|
|
176
|
-
# @param discount_code [String, nil]
|
|
187
|
+
# @param discount_code [String, nil] DEPRECATED: Use discount_codes instead. Cannot be used together with discount_co
|
|
188
|
+
#
|
|
189
|
+
# @param discount_codes [Array<String>, nil] Stacked discount codes to apply, in order. Max 20.
|
|
177
190
|
#
|
|
178
191
|
# @param feature_flags [Dodopayments::Models::CheckoutSessionFlags]
|
|
179
192
|
#
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.added"]
|
|
28
|
+
required :type, const: :"credit.added"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.added")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditAddedWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_ADDED = :"credit.added"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.added"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -24,17 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.balance_low"]
|
|
28
|
+
required :type, const: :"credit.balance_low"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.balance_low")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditBalanceLowWebhookEvent::Data] Webhook payload for credit.balance_low event
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
37
|
+
# @param type [Symbol, :"credit.balance_low"] The event type
|
|
38
38
|
|
|
39
39
|
# @see Dodopayments::Models::CreditBalanceLowWebhookEvent#data
|
|
40
40
|
class Data < Dodopayments::Internal::Type::BaseModel
|
|
@@ -90,18 +90,6 @@ module Dodopayments
|
|
|
90
90
|
# @param threshold_amount [String]
|
|
91
91
|
# @param threshold_percent [Integer]
|
|
92
92
|
end
|
|
93
|
-
|
|
94
|
-
# The event type
|
|
95
|
-
#
|
|
96
|
-
# @see Dodopayments::Models::CreditBalanceLowWebhookEvent#type
|
|
97
|
-
module Type
|
|
98
|
-
extend Dodopayments::Internal::Type::Enum
|
|
99
|
-
|
|
100
|
-
CREDIT_BALANCE_LOW = :"credit.balance_low"
|
|
101
|
-
|
|
102
|
-
# @!method self.values
|
|
103
|
-
# @return [Array<Symbol>]
|
|
104
|
-
end
|
|
105
93
|
end
|
|
106
94
|
end
|
|
107
95
|
end
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.deducted"]
|
|
28
|
+
required :type, const: :"credit.deducted"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.deducted")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditDeductedWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_DEDUCTED = :"credit.deducted"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.deducted"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.expired"]
|
|
28
|
+
required :type, const: :"credit.expired"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.expired")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditExpiredWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_EXPIRED = :"credit.expired"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.expired"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.manual_adjustment"]
|
|
28
|
+
required :type, const: :"credit.manual_adjustment"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.manual_adjustment")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditManualAdjustmentWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_MANUAL_ADJUSTMENT = :"credit.manual_adjustment"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.manual_adjustment"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.overage_charged"]
|
|
28
|
+
required :type, const: :"credit.overage_charged"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.overage_charged")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditOverageChargedWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_OVERAGE_CHARGED = :"credit.overage_charged"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.overage_charged"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.overage_reset"]
|
|
28
|
+
required :type, const: :"credit.overage_reset"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.overage_reset")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditOverageResetWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_OVERAGE_RESET = :"credit.overage_reset"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.overage_reset"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.rolled_over"]
|
|
28
|
+
required :type, const: :"credit.rolled_over"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.rolled_over")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditRolledOverWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_ROLLED_OVER = :"credit.rolled_over"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.rolled_over"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -24,29 +24,17 @@ module Dodopayments
|
|
|
24
24
|
# @!attribute type
|
|
25
25
|
# The event type
|
|
26
26
|
#
|
|
27
|
-
# @return [Symbol,
|
|
28
|
-
required :type,
|
|
27
|
+
# @return [Symbol, :"credit.rollover_forfeited"]
|
|
28
|
+
required :type, const: :"credit.rollover_forfeited"
|
|
29
29
|
|
|
30
|
-
# @!method initialize(business_id:, data:, timestamp:, type:)
|
|
30
|
+
# @!method initialize(business_id:, data:, timestamp:, type: :"credit.rollover_forfeited")
|
|
31
31
|
# @param business_id [String] The business identifier
|
|
32
32
|
#
|
|
33
33
|
# @param data [Dodopayments::Models::CreditEntitlements::CreditLedgerEntry] Response for a ledger entry
|
|
34
34
|
#
|
|
35
35
|
# @param timestamp [Time] The timestamp of when the event occurred
|
|
36
36
|
#
|
|
37
|
-
# @param type [Symbol,
|
|
38
|
-
|
|
39
|
-
# The event type
|
|
40
|
-
#
|
|
41
|
-
# @see Dodopayments::Models::CreditRolloverForfeitedWebhookEvent#type
|
|
42
|
-
module Type
|
|
43
|
-
extend Dodopayments::Internal::Type::Enum
|
|
44
|
-
|
|
45
|
-
CREDIT_ROLLOVER_FORFEITED = :"credit.rollover_forfeited"
|
|
46
|
-
|
|
47
|
-
# @!method self.values
|
|
48
|
-
# @return [Array<Symbol>]
|
|
49
|
-
end
|
|
37
|
+
# @param type [Symbol, :"credit.rollover_forfeited"] The event type
|
|
50
38
|
end
|
|
51
39
|
end
|
|
52
40
|
end
|
|
@@ -4,29 +4,36 @@ module Dodopayments
|
|
|
4
4
|
module Models
|
|
5
5
|
class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute files
|
|
7
|
+
# One entry per attached file.
|
|
7
8
|
#
|
|
8
9
|
# @return [Array<Dodopayments::Models::DigitalProductDeliveryFile>]
|
|
9
10
|
required :files, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::DigitalProductDeliveryFile] }
|
|
10
11
|
|
|
11
12
|
# @!attribute external_url
|
|
13
|
+
# Optional external URL, passed through from the entitlement configuration.
|
|
12
14
|
#
|
|
13
15
|
# @return [String, nil]
|
|
14
16
|
optional :external_url, String, nil?: true
|
|
15
17
|
|
|
16
18
|
# @!attribute instructions
|
|
19
|
+
# Optional human-readable delivery instructions, passed through from the
|
|
20
|
+
# entitlement configuration.
|
|
17
21
|
#
|
|
18
22
|
# @return [String, nil]
|
|
19
23
|
optional :instructions, String, nil?: true
|
|
20
24
|
|
|
21
25
|
# @!method initialize(files:, external_url: nil, instructions: nil)
|
|
22
|
-
#
|
|
23
|
-
#
|
|
24
|
-
# download URLs; the source (EE service or legacy in-process S3 presigning) is
|
|
25
|
-
# opaque to the caller.
|
|
26
|
+
# Some parameter documentations has been truncated, see
|
|
27
|
+
# {Dodopayments::Models::DigitalProductDelivery} for more details.
|
|
26
28
|
#
|
|
27
|
-
#
|
|
28
|
-
#
|
|
29
|
-
#
|
|
29
|
+
# Digital-product-delivery payload, present on grants for `digital_files`
|
|
30
|
+
# entitlements. Each file carries a short-lived presigned download URL.
|
|
31
|
+
#
|
|
32
|
+
# @param files [Array<Dodopayments::Models::DigitalProductDeliveryFile>] One entry per attached file.
|
|
33
|
+
#
|
|
34
|
+
# @param external_url [String, nil] Optional external URL, passed through from the entitlement
|
|
35
|
+
#
|
|
36
|
+
# @param instructions [String, nil] Optional human-readable delivery instructions, passed through from
|
|
30
37
|
end
|
|
31
38
|
end
|
|
32
39
|
end
|
|
@@ -4,6 +4,7 @@ module Dodopayments
|
|
|
4
4
|
module Models
|
|
5
5
|
class DigitalProductDeliveryFile < Dodopayments::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute download_url
|
|
7
|
+
# Short-lived presigned URL for downloading the file.
|
|
7
8
|
#
|
|
8
9
|
# @return [String]
|
|
9
10
|
required :download_url, String
|
|
@@ -15,37 +16,43 @@ module Dodopayments
|
|
|
15
16
|
required :expires_in, Integer
|
|
16
17
|
|
|
17
18
|
# @!attribute file_id
|
|
19
|
+
# Identifier of the attached file.
|
|
18
20
|
#
|
|
19
21
|
# @return [String]
|
|
20
22
|
required :file_id, String
|
|
21
23
|
|
|
22
24
|
# @!attribute filename
|
|
25
|
+
# Original filename of the attached file.
|
|
23
26
|
#
|
|
24
27
|
# @return [String]
|
|
25
28
|
required :filename, String
|
|
26
29
|
|
|
27
30
|
# @!attribute content_type
|
|
31
|
+
# Optional content-type declared at upload.
|
|
28
32
|
#
|
|
29
33
|
# @return [String, nil]
|
|
30
34
|
optional :content_type, String, nil?: true
|
|
31
35
|
|
|
32
36
|
# @!attribute file_size
|
|
37
|
+
# Optional size of the file in bytes.
|
|
33
38
|
#
|
|
34
39
|
# @return [Integer, nil]
|
|
35
40
|
optional :file_size, Integer, nil?: true
|
|
36
41
|
|
|
37
42
|
# @!method initialize(download_url:, expires_in:, file_id:, filename:, content_type: nil, file_size: nil)
|
|
38
|
-
#
|
|
43
|
+
# One file in a digital-product delivery payload.
|
|
44
|
+
#
|
|
45
|
+
# @param download_url [String] Short-lived presigned URL for downloading the file.
|
|
39
46
|
#
|
|
40
47
|
# @param expires_in [Integer] Seconds until `download_url` expires.
|
|
41
48
|
#
|
|
42
|
-
# @param file_id [String]
|
|
49
|
+
# @param file_id [String] Identifier of the attached file.
|
|
43
50
|
#
|
|
44
|
-
# @param filename [String]
|
|
51
|
+
# @param filename [String] Original filename of the attached file.
|
|
45
52
|
#
|
|
46
|
-
# @param content_type [String, nil]
|
|
53
|
+
# @param content_type [String, nil] Optional content-type declared at upload.
|
|
47
54
|
#
|
|
48
|
-
# @param file_size [Integer, nil]
|
|
55
|
+
# @param file_size [Integer, nil] Optional size of the file in bytes.
|
|
49
56
|
end
|
|
50
57
|
end
|
|
51
58
|
end
|