stripe 15.2.0.pre.beta.1 → 15.3.0.pre.beta.1
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 +92 -0
- data/CONTRIBUTING.md +25 -0
- data/OPENAPI_VERSION +1 -1
- data/README.md +10 -7
- data/VERSION +1 -1
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/event_types.rb +9 -0
- data/lib/stripe/events/v2_core_account_link_completed_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +1 -1
- data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +1 -1
- data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
- data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
- data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
- data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
- data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
- data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
- data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
- data/lib/stripe/object_types.rb +1 -3
- data/lib/stripe/resources/account.rb +47 -20
- data/lib/stripe/resources/account_session.rb +85 -24
- data/lib/stripe/resources/apple_pay_domain.rb +1 -2
- data/lib/stripe/resources/balance.rb +42 -0
- data/lib/stripe/resources/balance_transaction.rb +2 -0
- data/lib/stripe/resources/bank_account.rb +2 -2
- data/lib/stripe/resources/billing_portal/session.rb +1 -1
- data/lib/stripe/resources/capability.rb +1 -1
- data/lib/stripe/resources/charge.rb +85 -9
- data/lib/stripe/resources/checkout/session.rb +22 -6
- data/lib/stripe/resources/confirmation_token.rb +37 -97
- data/lib/stripe/resources/country_spec.rb +1 -1
- data/lib/stripe/resources/coupon.rb +1 -2
- data/lib/stripe/resources/credit_note.rb +10 -11
- data/lib/stripe/resources/customer.rb +2 -4
- data/lib/stripe/resources/customer_session.rb +3 -3
- data/lib/stripe/resources/dispute.rb +2 -2
- data/lib/stripe/resources/event.rb +1 -1
- data/lib/stripe/resources/file.rb +1 -1
- data/lib/stripe/resources/financial_connections/account.rb +2 -0
- data/lib/stripe/resources/financial_connections/institution.rb +2 -0
- data/lib/stripe/resources/identity/verification_report.rb +6 -0
- data/lib/stripe/resources/identity/verification_session.rb +17 -11
- data/lib/stripe/resources/invoice.rb +70 -43
- data/lib/stripe/resources/invoice_item.rb +2 -3
- data/lib/stripe/resources/invoice_line_item.rb +1 -1
- data/lib/stripe/resources/invoice_payment.rb +9 -2
- data/lib/stripe/resources/issuing/authorization.rb +8 -8
- data/lib/stripe/resources/issuing/card.rb +1 -1
- data/lib/stripe/resources/issuing/dispute.rb +3 -3
- data/lib/stripe/resources/order.rb +2 -55
- data/lib/stripe/resources/payment_attempt_record.rb +8 -0
- data/lib/stripe/resources/payment_intent.rb +439 -411
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +7 -0
- data/lib/stripe/resources/payment_method.rb +50 -113
- data/lib/stripe/resources/payment_method_configuration.rb +297 -2
- data/lib/stripe/resources/payment_method_domain.rb +2 -2
- data/lib/stripe/resources/payment_record.rb +8 -0
- data/lib/stripe/resources/payout.rb +4 -4
- data/lib/stripe/resources/person.rb +2 -2
- data/lib/stripe/resources/plan.rb +2 -3
- data/lib/stripe/resources/price.rb +1 -1
- data/lib/stripe/resources/privacy/redaction_job.rb +52 -29
- data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +12 -4
- data/lib/stripe/resources/product.rb +1 -61
- data/lib/stripe/resources/quote.rb +1 -1
- data/lib/stripe/resources/quote_preview_invoice.rb +2 -2
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +26 -1
- data/lib/stripe/resources/radar/value_list.rb +1 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -2
- data/lib/stripe/resources/refund.rb +6 -1
- data/lib/stripe/resources/reversal.rb +1 -1
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_intent.rb +123 -311
- data/lib/stripe/resources/source.rb +1 -1
- data/lib/stripe/resources/subscription.rb +132 -37
- data/lib/stripe/resources/subscription_item.rb +33 -0
- data/lib/stripe/resources/subscription_schedule.rb +120 -5
- data/lib/stripe/resources/tax/association.rb +8 -31
- data/lib/stripe/resources/tax/calculation.rb +4 -0
- data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
- data/lib/stripe/resources/tax/registration.rb +1 -1
- data/lib/stripe/resources/tax_id.rb +1 -2
- data/lib/stripe/resources/tax_rate.rb +2 -2
- data/lib/stripe/resources/terminal/configuration.rb +1 -2
- data/lib/stripe/resources/terminal/location.rb +2 -3
- data/lib/stripe/resources/terminal/reader.rb +26 -4
- data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
- data/lib/stripe/resources/token.rb +2 -2
- data/lib/stripe/resources/transfer.rb +1 -1
- data/lib/stripe/resources/v2/core/account.rb +5 -5
- data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -20
- data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -24
- data/lib/stripe/resources/v2/payments/off_session_payment.rb +74 -0
- data/lib/stripe/resources/webhook_endpoint.rb +1 -2
- data/lib/stripe/resources.rb +8 -3
- data/lib/stripe/services/account_external_account_service.rb +2 -3
- data/lib/stripe/services/account_login_link_service.rb +1 -1
- data/lib/stripe/services/account_person_service.rb +1 -2
- data/lib/stripe/services/account_service.rb +38 -13
- data/lib/stripe/services/account_session_service.rb +49 -24
- data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
- data/lib/stripe/services/balance_service.rb +1 -1
- data/lib/stripe/services/balance_settings_service.rb +2 -2
- data/lib/stripe/services/charge_service.rb +76 -8
- data/lib/stripe/services/checkout/session_service.rb +14 -6
- data/lib/stripe/services/coupon_service.rb +1 -2
- data/lib/stripe/services/credit_note_service.rb +7 -8
- data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
- data/lib/stripe/services/customer_payment_source_service.rb +1 -1
- data/lib/stripe/services/customer_service.rb +3 -5
- data/lib/stripe/services/customer_tax_id_service.rb +1 -2
- data/lib/stripe/services/dispute_service.rb +1 -1
- data/lib/stripe/services/external_account_service.rb +2 -3
- data/lib/stripe/services/file_service.rb +1 -1
- data/lib/stripe/services/identity/verification_session_service.rb +5 -5
- data/lib/stripe/services/invoice_item_service.rb +1 -2
- data/lib/stripe/services/invoice_service.rb +65 -35
- data/lib/stripe/services/issuing/authorization_service.rb +4 -4
- data/lib/stripe/services/issuing/card_service.rb +1 -1
- data/lib/stripe/services/issuing/dispute_service.rb +2 -2
- data/lib/stripe/services/order_service.rb +1 -33
- data/lib/stripe/services/payment_intent_service.rb +385 -386
- data/lib/stripe/services/payment_method_configuration_service.rb +212 -2
- data/lib/stripe/services/payment_method_domain_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +47 -110
- data/lib/stripe/services/payout_service.rb +2 -2
- data/lib/stripe/services/plan_service.rb +2 -3
- data/lib/stripe/services/price_service.rb +2 -2
- data/lib/stripe/services/privacy/redaction_job_service.rb +22 -13
- data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +1 -1
- data/lib/stripe/services/product_feature_service.rb +1 -2
- data/lib/stripe/services/product_service.rb +2 -41
- data/lib/stripe/services/promotion_code_service.rb +1 -1
- data/lib/stripe/services/quote_service.rb +1 -1
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
- data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
- data/lib/stripe/services/radar/value_list_service.rb +1 -2
- data/lib/stripe/services/setup_intent_service.rb +122 -310
- data/lib/stripe/services/source_service.rb +1 -1
- data/lib/stripe/services/subscription_item_service.rb +26 -0
- data/lib/stripe/services/subscription_schedule_service.rb +94 -4
- data/lib/stripe/services/subscription_service.rb +103 -33
- data/lib/stripe/services/tax/calculation_service.rb +4 -0
- data/lib/stripe/services/tax/registration_service.rb +1 -1
- data/lib/stripe/services/tax_id_service.rb +1 -2
- data/lib/stripe/services/terminal/configuration_service.rb +1 -2
- data/lib/stripe/services/terminal/location_service.rb +2 -3
- data/lib/stripe/services/terminal/reader_service.rb +17 -3
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +37 -97
- data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
- data/lib/stripe/services/token_service.rb +1 -1
- data/lib/stripe/services/transfer_service.rb +1 -1
- data/lib/stripe/services/v1_services.rb +1 -2
- data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
- data/lib/stripe/services/v2/core/accounts/person_service.rb +2 -4
- data/lib/stripe/services/v2/core/event_destination_service.rb +4 -10
- data/lib/stripe/services/v2/core/event_service.rb +1 -2
- data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +3 -7
- data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +2 -4
- data/lib/stripe/services/v2/money_management/adjustment_service.rb +1 -2
- data/lib/stripe/services/v2/money_management/financial_account_service.rb +1 -2
- data/lib/stripe/services/v2/money_management/financial_address_service.rb +1 -1
- data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +1 -2
- data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +1 -2
- data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +2 -4
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +2 -4
- data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +2 -4
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +3 -7
- data/lib/stripe/services/v2/money_management/received_credit_service.rb +1 -2
- data/lib/stripe/services/v2/money_management/received_debit_service.rb +1 -2
- data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +1 -2
- data/lib/stripe/services/v2/money_management/transaction_service.rb +1 -2
- data/lib/stripe/services/v2/payment_service.rb +15 -0
- data/lib/stripe/services/v2/payments/off_session_payment_service.rb +138 -0
- data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +1 -2
- data/lib/stripe/services/v2_services.rb +2 -1
- data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
- data/lib/stripe/services.rb +2 -3
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe.rbi +3903 -4131
- metadata +13 -8
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
- data/lib/stripe/resources/gift_cards/card.rb +0 -208
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
- data/lib/stripe/services/gift_cards/card_service.rb +0 -170
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
- data/lib/stripe/services/gift_cards_service.rb +0 -14
@@ -4,9 +4,9 @@
|
|
4
4
|
module Stripe
|
5
5
|
# This is an object representing a person associated with a Stripe account.
|
6
6
|
#
|
7
|
-
# A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
|
7
|
+
# A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
|
8
8
|
#
|
9
|
-
# See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
|
9
|
+
# See the [Standard onboarding](https://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://docs.stripe.com/connect/handling-api-verification#person-information).
|
10
10
|
class Person < APIResource
|
11
11
|
include Stripe::APIOperations::Save
|
12
12
|
|
@@ -41,8 +41,7 @@ module Stripe
|
|
41
41
|
attr_reader :round
|
42
42
|
end
|
43
43
|
|
44
|
-
class DeleteParams < Stripe::RequestParams
|
45
|
-
end
|
44
|
+
class DeleteParams < Stripe::RequestParams; end
|
46
45
|
|
47
46
|
class UpdateParams < Stripe::RequestParams
|
48
47
|
# Whether the plan is currently available for new subscriptions.
|
@@ -323,7 +322,7 @@ module Stripe
|
|
323
322
|
# Always true for a deleted object
|
324
323
|
attr_reader :deleted
|
325
324
|
|
326
|
-
# You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/
|
325
|
+
# You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
|
327
326
|
def self.create(params = {}, opts = {})
|
328
327
|
request_stripe_object(method: :post, path: "/v1/plans", params: params, opts: opts)
|
329
328
|
end
|
@@ -658,7 +658,7 @@ module Stripe
|
|
658
658
|
request_stripe_object(method: :post, path: "/v1/prices", params: params, opts: opts)
|
659
659
|
end
|
660
660
|
|
661
|
-
# Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
|
661
|
+
# Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
|
662
662
|
def self.list(params = {}, opts = {})
|
663
663
|
request_stripe_object(method: :get, path: "/v1/prices", params: params, opts: opts)
|
664
664
|
end
|
@@ -3,8 +3,10 @@
|
|
3
3
|
|
4
4
|
module Stripe
|
5
5
|
module Privacy
|
6
|
-
# Redaction
|
7
|
-
#
|
6
|
+
# The Redaction Job object redacts Stripe objects. You can use it
|
7
|
+
# to coordinate the removal of personal information from selected
|
8
|
+
# objects, making them permanently inaccessible in the Stripe Dashboard
|
9
|
+
# and API.
|
8
10
|
class RedactionJob < APIResource
|
9
11
|
extend Stripe::APIOperations::Create
|
10
12
|
extend Stripe::APIOperations::List
|
@@ -19,23 +21,23 @@ module Stripe
|
|
19
21
|
nested_resource_class_methods :validation_error, operations: %i[list]
|
20
22
|
|
21
23
|
class Objects < Stripe::StripeObject
|
22
|
-
#
|
24
|
+
# Charge object identifiers usually starting with `ch_`
|
23
25
|
attr_reader :charges
|
24
|
-
#
|
26
|
+
# CheckoutSession object identifiers starting with `cs_`
|
25
27
|
attr_reader :checkout_sessions
|
26
|
-
#
|
28
|
+
# Customer object identifiers starting with `cus_`
|
27
29
|
attr_reader :customers
|
28
|
-
#
|
30
|
+
# Identity VerificationSessions object identifiers starting with `vs_`
|
29
31
|
attr_reader :identity_verification_sessions
|
30
|
-
#
|
32
|
+
# Invoice object identifiers starting with `in_`
|
31
33
|
attr_reader :invoices
|
32
|
-
#
|
34
|
+
# Issuing Cardholder object identifiers starting with `ich_`
|
33
35
|
attr_reader :issuing_cardholders
|
34
|
-
#
|
36
|
+
# PaymentIntent object identifiers starting with `pi_`
|
35
37
|
attr_reader :payment_intents
|
36
|
-
#
|
38
|
+
# Fraud ValueListItem object identifiers starting with `rsli_`
|
37
39
|
attr_reader :radar_value_list_items
|
38
|
-
#
|
40
|
+
# SetupIntent object identifiers starting with `seti_`
|
39
41
|
attr_reader :setup_intents
|
40
42
|
end
|
41
43
|
|
@@ -115,12 +117,9 @@ module Stripe
|
|
115
117
|
end
|
116
118
|
# Specifies which fields in the response should be expanded.
|
117
119
|
attr_accessor :expand
|
118
|
-
# The objects
|
120
|
+
# The objects to redact. These root objects and their related ones will be validated for redaction.
|
119
121
|
attr_accessor :objects
|
120
|
-
#
|
121
|
-
# redactable in the 1st traversal, otherwise error. If "fix", where possible, we will
|
122
|
-
# auto-fix any validation errors (e.g. by auto-transitioning objects to a terminal
|
123
|
-
# state, etc.) in the 2nd traversal before redacting
|
122
|
+
# Determines the validation behavior of the job. Default is `error`.
|
124
123
|
attr_accessor :validation_behavior
|
125
124
|
|
126
125
|
def initialize(expand: nil, objects: nil, validation_behavior: nil)
|
@@ -133,7 +132,7 @@ module Stripe
|
|
133
132
|
class UpdateParams < Stripe::RequestParams
|
134
133
|
# Specifies which fields in the response should be expanded.
|
135
134
|
attr_accessor :expand
|
136
|
-
#
|
135
|
+
# Determines the validation behavior of the job. Default is `error`.
|
137
136
|
attr_accessor :validation_behavior
|
138
137
|
|
139
138
|
def initialize(expand: nil, validation_behavior: nil)
|
@@ -172,16 +171,20 @@ module Stripe
|
|
172
171
|
attr_reader :created
|
173
172
|
# Unique identifier for the object.
|
174
173
|
attr_reader :id
|
174
|
+
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
175
|
+
attr_reader :livemode
|
175
176
|
# String representing the object's type. Objects of the same type share the same value.
|
176
177
|
attr_reader :object
|
177
|
-
# The objects
|
178
|
+
# The objects to redact in this job.
|
178
179
|
attr_reader :objects
|
179
|
-
# The status
|
180
|
+
# The status of the job.
|
180
181
|
attr_reader :status
|
181
|
-
#
|
182
|
+
# Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
|
182
183
|
attr_reader :validation_behavior
|
183
184
|
|
184
|
-
#
|
185
|
+
# You can cancel a redaction job when it's in one of these statuses: ready, failed.
|
186
|
+
#
|
187
|
+
# Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
|
185
188
|
def cancel(params = {}, opts = {})
|
186
189
|
request_stripe_object(
|
187
190
|
method: :post,
|
@@ -191,7 +194,9 @@ module Stripe
|
|
191
194
|
)
|
192
195
|
end
|
193
196
|
|
194
|
-
#
|
197
|
+
# You can cancel a redaction job when it's in one of these statuses: ready, failed.
|
198
|
+
#
|
199
|
+
# Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
|
195
200
|
def self.cancel(job, params = {}, opts = {})
|
196
201
|
request_stripe_object(
|
197
202
|
method: :post,
|
@@ -201,7 +206,7 @@ module Stripe
|
|
201
206
|
)
|
202
207
|
end
|
203
208
|
|
204
|
-
#
|
209
|
+
# Creates a redaction job. When a job is created, it will start to validate.
|
205
210
|
def self.create(params = {}, opts = {})
|
206
211
|
request_stripe_object(
|
207
212
|
method: :post,
|
@@ -211,7 +216,7 @@ module Stripe
|
|
211
216
|
)
|
212
217
|
end
|
213
218
|
|
214
|
-
#
|
219
|
+
# Returns a list of redaction jobs.
|
215
220
|
def self.list(params = {}, opts = {})
|
216
221
|
request_stripe_object(
|
217
222
|
method: :get,
|
@@ -221,7 +226,11 @@ module Stripe
|
|
221
226
|
)
|
222
227
|
end
|
223
228
|
|
224
|
-
# Run redaction job
|
229
|
+
# Run a redaction job in a ready status.
|
230
|
+
#
|
231
|
+
# When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
|
232
|
+
#
|
233
|
+
# The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
|
225
234
|
def run(params = {}, opts = {})
|
226
235
|
request_stripe_object(
|
227
236
|
method: :post,
|
@@ -231,7 +240,11 @@ module Stripe
|
|
231
240
|
)
|
232
241
|
end
|
233
242
|
|
234
|
-
# Run redaction job
|
243
|
+
# Run a redaction job in a ready status.
|
244
|
+
#
|
245
|
+
# When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
|
246
|
+
#
|
247
|
+
# The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
|
235
248
|
def self.run(job, params = {}, opts = {})
|
236
249
|
request_stripe_object(
|
237
250
|
method: :post,
|
@@ -241,7 +254,9 @@ module Stripe
|
|
241
254
|
)
|
242
255
|
end
|
243
256
|
|
244
|
-
#
|
257
|
+
# Updates the properties of a redaction job without running or canceling the job.
|
258
|
+
#
|
259
|
+
# If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
|
245
260
|
def self.update(job, params = {}, opts = {})
|
246
261
|
request_stripe_object(
|
247
262
|
method: :post,
|
@@ -251,7 +266,11 @@ module Stripe
|
|
251
266
|
)
|
252
267
|
end
|
253
268
|
|
254
|
-
# Validate redaction job
|
269
|
+
# Validate a redaction job when it is in a failed status.
|
270
|
+
#
|
271
|
+
# When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
|
272
|
+
#
|
273
|
+
# The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
|
255
274
|
def validate(params = {}, opts = {})
|
256
275
|
request_stripe_object(
|
257
276
|
method: :post,
|
@@ -261,7 +280,11 @@ module Stripe
|
|
261
280
|
)
|
262
281
|
end
|
263
282
|
|
264
|
-
# Validate redaction job
|
283
|
+
# Validate a redaction job when it is in a failed status.
|
284
|
+
#
|
285
|
+
# When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
|
286
|
+
#
|
287
|
+
# The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
|
265
288
|
def self.validate(job, params = {}, opts = {})
|
266
289
|
request_stripe_object(
|
267
290
|
method: :post,
|
@@ -3,20 +3,28 @@
|
|
3
3
|
|
4
4
|
module Stripe
|
5
5
|
module Privacy
|
6
|
-
#
|
6
|
+
# The Redaction Job validation error object contains information about
|
7
|
+
# errors that affect the ability to redact a specific object in a
|
8
|
+
# redaction job.
|
7
9
|
class RedactionJobValidationError < APIResource
|
8
10
|
OBJECT_NAME = "privacy.redaction_job_validation_error"
|
9
11
|
def self.object_name
|
10
12
|
"privacy.redaction_job_validation_error"
|
11
13
|
end
|
12
14
|
|
13
|
-
|
15
|
+
class ErroringObject < Stripe::StripeObject
|
16
|
+
# Unique identifier for the object.
|
17
|
+
attr_reader :id
|
18
|
+
# Erroring object type
|
19
|
+
attr_reader :object_type
|
20
|
+
end
|
21
|
+
# A code indicating the reason for the error.
|
14
22
|
attr_reader :code
|
15
|
-
#
|
23
|
+
# If the error is related to a specific object, this field includes the object's identifier and object type.
|
16
24
|
attr_reader :erroring_object
|
17
25
|
# Unique identifier for the object.
|
18
26
|
attr_reader :id
|
19
|
-
#
|
27
|
+
# A human-readable message providing more details about the error.
|
20
28
|
attr_reader :message
|
21
29
|
# String representing the object's type. Objects of the same type share the same value.
|
22
30
|
attr_reader :object
|
@@ -41,27 +41,7 @@ module Stripe
|
|
41
41
|
attr_reader :width
|
42
42
|
end
|
43
43
|
|
44
|
-
class
|
45
|
-
class GiftCard < Stripe::StripeObject
|
46
|
-
class FixedAmount < Stripe::StripeObject
|
47
|
-
# The initial amount with which the provisioned gift card will be created.
|
48
|
-
attr_reader :amount
|
49
|
-
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
50
|
-
attr_reader :currency
|
51
|
-
end
|
52
|
-
# Attribute for field fixed_amount
|
53
|
-
attr_reader :fixed_amount
|
54
|
-
# The specific type of gift_card provisioning, only `fixed_amount` currently supported.
|
55
|
-
attr_reader :type
|
56
|
-
end
|
57
|
-
# Attribute for field gift_card
|
58
|
-
attr_reader :gift_card
|
59
|
-
# The type of provisioning, only `gift_card` currently supported.
|
60
|
-
attr_reader :type
|
61
|
-
end
|
62
|
-
|
63
|
-
class DeleteParams < Stripe::RequestParams
|
64
|
-
end
|
44
|
+
class DeleteParams < Stripe::RequestParams; end
|
65
45
|
|
66
46
|
class UpdateParams < Stripe::RequestParams
|
67
47
|
class MarketingFeature < Stripe::RequestParams
|
@@ -385,40 +365,6 @@ module Stripe
|
|
385
365
|
@width = width
|
386
366
|
end
|
387
367
|
end
|
388
|
-
|
389
|
-
class Provisioning < Stripe::RequestParams
|
390
|
-
class GiftCard < Stripe::RequestParams
|
391
|
-
class FixedAmount < Stripe::RequestParams
|
392
|
-
# The initial amount with which the provisioned gift card will be created.
|
393
|
-
attr_accessor :amount
|
394
|
-
# Attribute for param field currency
|
395
|
-
attr_accessor :currency
|
396
|
-
|
397
|
-
def initialize(amount: nil, currency: nil)
|
398
|
-
@amount = amount
|
399
|
-
@currency = currency
|
400
|
-
end
|
401
|
-
end
|
402
|
-
# Attribute for param field fixed_amount
|
403
|
-
attr_accessor :fixed_amount
|
404
|
-
# The specific type of gift_card provisioning, only `fixed_amount` currently supported.
|
405
|
-
attr_accessor :type
|
406
|
-
|
407
|
-
def initialize(fixed_amount: nil, type: nil)
|
408
|
-
@fixed_amount = fixed_amount
|
409
|
-
@type = type
|
410
|
-
end
|
411
|
-
end
|
412
|
-
# Attribute for param field gift_card
|
413
|
-
attr_accessor :gift_card
|
414
|
-
# The type of provisioning, only `gift_card` currently supported.
|
415
|
-
attr_accessor :type
|
416
|
-
|
417
|
-
def initialize(gift_card: nil, type: nil)
|
418
|
-
@gift_card = gift_card
|
419
|
-
@type = type
|
420
|
-
end
|
421
|
-
end
|
422
368
|
# Whether the product is currently available for purchase. Defaults to `true`.
|
423
369
|
attr_accessor :active
|
424
370
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
|
@@ -439,8 +385,6 @@ module Stripe
|
|
439
385
|
attr_accessor :name
|
440
386
|
# The dimensions of this product for shipping purposes.
|
441
387
|
attr_accessor :package_dimensions
|
442
|
-
# Provisioning configuration for this product.
|
443
|
-
attr_accessor :provisioning
|
444
388
|
# Whether this product is shipped (i.e., physical goods).
|
445
389
|
attr_accessor :shippable
|
446
390
|
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
|
@@ -468,7 +412,6 @@ module Stripe
|
|
468
412
|
metadata: nil,
|
469
413
|
name: nil,
|
470
414
|
package_dimensions: nil,
|
471
|
-
provisioning: nil,
|
472
415
|
shippable: nil,
|
473
416
|
statement_descriptor: nil,
|
474
417
|
tax_code: nil,
|
@@ -486,7 +429,6 @@ module Stripe
|
|
486
429
|
@metadata = metadata
|
487
430
|
@name = name
|
488
431
|
@package_dimensions = package_dimensions
|
489
|
-
@provisioning = provisioning
|
490
432
|
@shippable = shippable
|
491
433
|
@statement_descriptor = statement_descriptor
|
492
434
|
@tax_code = tax_code
|
@@ -537,8 +479,6 @@ module Stripe
|
|
537
479
|
attr_reader :object
|
538
480
|
# The dimensions of this product for shipping purposes.
|
539
481
|
attr_reader :package_dimensions
|
540
|
-
# Provisioning configuration for this product.
|
541
|
-
attr_reader :provisioning
|
542
482
|
# Whether this product is shipped (i.e., physical goods).
|
543
483
|
attr_reader :shippable
|
544
484
|
# Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
|
@@ -1279,7 +1279,7 @@ module Stripe
|
|
1279
1279
|
attr_accessor :billing_behavior
|
1280
1280
|
# When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
|
1281
1281
|
attr_accessor :billing_cycle_anchor
|
1282
|
-
#
|
1282
|
+
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
1283
1283
|
attr_accessor :billing_mode
|
1284
1284
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
1285
1285
|
attr_accessor :description
|
@@ -26,7 +26,7 @@ module Stripe
|
|
26
26
|
# Stripe applies any customer credit on the account before determining the
|
27
27
|
# amount due for the invoice (i.e., the amount that will be actually
|
28
28
|
# charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
|
29
|
-
# per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
|
29
|
+
# per currency](https://docs.stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
|
30
30
|
# invoice is automatically marked paid, and we add the amount due to the
|
31
31
|
# customer's credit balance which is applied to the next invoice.
|
32
32
|
#
|
@@ -583,7 +583,7 @@ module Stripe
|
|
583
583
|
attr_reader :footer
|
584
584
|
# Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
|
585
585
|
attr_reader :from_invoice
|
586
|
-
# Unique identifier for the object.
|
586
|
+
# Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.
|
587
587
|
attr_reader :id
|
588
588
|
# Attribute for field issuer
|
589
589
|
attr_reader :issuer
|
@@ -40,6 +40,13 @@ module Stripe
|
|
40
40
|
attr_reader :liability
|
41
41
|
end
|
42
42
|
|
43
|
+
class BillingThresholds < Stripe::StripeObject
|
44
|
+
# Monetary threshold that triggers the subscription to create an invoice
|
45
|
+
attr_reader :amount_gte
|
46
|
+
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
47
|
+
attr_reader :reset_billing_cycle_anchor
|
48
|
+
end
|
49
|
+
|
43
50
|
class InvoiceSettings < Stripe::StripeObject
|
44
51
|
class Issuer < Stripe::StripeObject
|
45
52
|
# The connected account being referenced when `type` is `account`.
|
@@ -67,6 +74,8 @@ module Stripe
|
|
67
74
|
attr_reader :automatic_tax
|
68
75
|
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
69
76
|
attr_reader :billing_cycle_anchor
|
77
|
+
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
78
|
+
attr_reader :billing_thresholds
|
70
79
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
|
71
80
|
attr_reader :collection_method
|
72
81
|
# ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
@@ -139,6 +148,13 @@ module Stripe
|
|
139
148
|
attr_reader :liability
|
140
149
|
end
|
141
150
|
|
151
|
+
class BillingThresholds < Stripe::StripeObject
|
152
|
+
# Monetary threshold that triggers the subscription to create an invoice
|
153
|
+
attr_reader :amount_gte
|
154
|
+
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
155
|
+
attr_reader :reset_billing_cycle_anchor
|
156
|
+
end
|
157
|
+
|
142
158
|
class Discount < Stripe::StripeObject
|
143
159
|
class DiscountEnd < Stripe::StripeObject
|
144
160
|
# The discount end timestamp.
|
@@ -172,6 +188,11 @@ module Stripe
|
|
172
188
|
end
|
173
189
|
|
174
190
|
class Item < Stripe::StripeObject
|
191
|
+
class BillingThresholds < Stripe::StripeObject
|
192
|
+
# Usage threshold that triggers the subscription to create an invoice
|
193
|
+
attr_reader :usage_gte
|
194
|
+
end
|
195
|
+
|
175
196
|
class Discount < Stripe::StripeObject
|
176
197
|
class DiscountEnd < Stripe::StripeObject
|
177
198
|
# The discount end timestamp.
|
@@ -195,6 +216,8 @@ module Stripe
|
|
195
216
|
# Determines the type of trial for this item.
|
196
217
|
attr_reader :type
|
197
218
|
end
|
219
|
+
# Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
|
220
|
+
attr_reader :billing_thresholds
|
198
221
|
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
|
199
222
|
attr_reader :discounts
|
200
223
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
|
@@ -239,6 +262,8 @@ module Stripe
|
|
239
262
|
attr_reader :automatic_tax
|
240
263
|
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
241
264
|
attr_reader :billing_cycle_anchor
|
265
|
+
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
266
|
+
attr_reader :billing_thresholds
|
242
267
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
|
243
268
|
attr_reader :collection_method
|
244
269
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
@@ -263,7 +288,7 @@ module Stripe
|
|
263
288
|
attr_reader :on_behalf_of
|
264
289
|
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
265
290
|
attr_reader :pause_collection
|
266
|
-
#
|
291
|
+
# When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
267
292
|
attr_reader :proration_behavior
|
268
293
|
# The start of this phase of the subscription schedule.
|
269
294
|
attr_reader :start_date
|
@@ -113,7 +113,12 @@ module Stripe
|
|
113
113
|
end
|
114
114
|
|
115
115
|
class Paynow < Stripe::StripeObject; end
|
116
|
-
|
116
|
+
|
117
|
+
class Paypal < Stripe::StripeObject
|
118
|
+
# For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
|
119
|
+
attr_reader :network_decline_code
|
120
|
+
end
|
121
|
+
|
117
122
|
class Pix < Stripe::StripeObject; end
|
118
123
|
class Revolut < Stripe::StripeObject; end
|
119
124
|
class Sofort < Stripe::StripeObject; end
|
@@ -8,7 +8,7 @@ module Stripe
|
|
8
8
|
# platform's balance and subtract from the destination account's balance.
|
9
9
|
#
|
10
10
|
# Reversing a transfer that was made for a [destination
|
11
|
-
# charge](https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
|
11
|
+
# charge](https://docs.stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
|
12
12
|
# the charge. It is possible to reverse a
|
13
13
|
# [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)
|
14
14
|
# transfer only if the destination account has enough balance to cover the
|
@@ -4,7 +4,7 @@
|
|
4
4
|
module Stripe
|
5
5
|
# Reviews can be used to supplement automated fraud detection with human expertise.
|
6
6
|
#
|
7
|
-
# Learn more about [Radar](https://stripe.com/radar) and reviewing payments
|
7
|
+
# Learn more about [Radar](https://docs.stripe.com/radar) and reviewing payments
|
8
8
|
# [here](https://stripe.com/docs/radar/reviews).
|
9
9
|
class Review < APIResource
|
10
10
|
extend Stripe::APIOperations::List
|