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.
Files changed (196) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +92 -0
  3. data/CONTRIBUTING.md +25 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +10 -7
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_version.rb +1 -1
  8. data/lib/stripe/event_types.rb +9 -0
  9. data/lib/stripe/events/v2_core_account_link_completed_event.rb +1 -1
  10. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +1 -1
  11. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +1 -1
  12. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +1 -1
  13. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +1 -1
  14. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +1 -1
  15. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +1 -1
  16. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +1 -1
  17. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +1 -1
  18. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +1 -1
  19. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +1 -1
  20. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  21. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  22. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  23. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  24. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  25. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  26. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  27. data/lib/stripe/object_types.rb +1 -3
  28. data/lib/stripe/resources/account.rb +47 -20
  29. data/lib/stripe/resources/account_session.rb +85 -24
  30. data/lib/stripe/resources/apple_pay_domain.rb +1 -2
  31. data/lib/stripe/resources/balance.rb +42 -0
  32. data/lib/stripe/resources/balance_transaction.rb +2 -0
  33. data/lib/stripe/resources/bank_account.rb +2 -2
  34. data/lib/stripe/resources/billing_portal/session.rb +1 -1
  35. data/lib/stripe/resources/capability.rb +1 -1
  36. data/lib/stripe/resources/charge.rb +85 -9
  37. data/lib/stripe/resources/checkout/session.rb +22 -6
  38. data/lib/stripe/resources/confirmation_token.rb +37 -97
  39. data/lib/stripe/resources/country_spec.rb +1 -1
  40. data/lib/stripe/resources/coupon.rb +1 -2
  41. data/lib/stripe/resources/credit_note.rb +10 -11
  42. data/lib/stripe/resources/customer.rb +2 -4
  43. data/lib/stripe/resources/customer_session.rb +3 -3
  44. data/lib/stripe/resources/dispute.rb +2 -2
  45. data/lib/stripe/resources/event.rb +1 -1
  46. data/lib/stripe/resources/file.rb +1 -1
  47. data/lib/stripe/resources/financial_connections/account.rb +2 -0
  48. data/lib/stripe/resources/financial_connections/institution.rb +2 -0
  49. data/lib/stripe/resources/identity/verification_report.rb +6 -0
  50. data/lib/stripe/resources/identity/verification_session.rb +17 -11
  51. data/lib/stripe/resources/invoice.rb +70 -43
  52. data/lib/stripe/resources/invoice_item.rb +2 -3
  53. data/lib/stripe/resources/invoice_line_item.rb +1 -1
  54. data/lib/stripe/resources/invoice_payment.rb +9 -2
  55. data/lib/stripe/resources/issuing/authorization.rb +8 -8
  56. data/lib/stripe/resources/issuing/card.rb +1 -1
  57. data/lib/stripe/resources/issuing/dispute.rb +3 -3
  58. data/lib/stripe/resources/order.rb +2 -55
  59. data/lib/stripe/resources/payment_attempt_record.rb +8 -0
  60. data/lib/stripe/resources/payment_intent.rb +439 -411
  61. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +7 -0
  62. data/lib/stripe/resources/payment_method.rb +50 -113
  63. data/lib/stripe/resources/payment_method_configuration.rb +297 -2
  64. data/lib/stripe/resources/payment_method_domain.rb +2 -2
  65. data/lib/stripe/resources/payment_record.rb +8 -0
  66. data/lib/stripe/resources/payout.rb +4 -4
  67. data/lib/stripe/resources/person.rb +2 -2
  68. data/lib/stripe/resources/plan.rb +2 -3
  69. data/lib/stripe/resources/price.rb +1 -1
  70. data/lib/stripe/resources/privacy/redaction_job.rb +52 -29
  71. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +12 -4
  72. data/lib/stripe/resources/product.rb +1 -61
  73. data/lib/stripe/resources/quote.rb +1 -1
  74. data/lib/stripe/resources/quote_preview_invoice.rb +2 -2
  75. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +26 -1
  76. data/lib/stripe/resources/radar/value_list.rb +1 -2
  77. data/lib/stripe/resources/radar/value_list_item.rb +1 -2
  78. data/lib/stripe/resources/refund.rb +6 -1
  79. data/lib/stripe/resources/reversal.rb +1 -1
  80. data/lib/stripe/resources/review.rb +1 -1
  81. data/lib/stripe/resources/setup_intent.rb +123 -311
  82. data/lib/stripe/resources/source.rb +1 -1
  83. data/lib/stripe/resources/subscription.rb +132 -37
  84. data/lib/stripe/resources/subscription_item.rb +33 -0
  85. data/lib/stripe/resources/subscription_schedule.rb +120 -5
  86. data/lib/stripe/resources/tax/association.rb +8 -31
  87. data/lib/stripe/resources/tax/calculation.rb +4 -0
  88. data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
  89. data/lib/stripe/resources/tax/registration.rb +1 -1
  90. data/lib/stripe/resources/tax_id.rb +1 -2
  91. data/lib/stripe/resources/tax_rate.rb +2 -2
  92. data/lib/stripe/resources/terminal/configuration.rb +1 -2
  93. data/lib/stripe/resources/terminal/location.rb +2 -3
  94. data/lib/stripe/resources/terminal/reader.rb +26 -4
  95. data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
  96. data/lib/stripe/resources/token.rb +2 -2
  97. data/lib/stripe/resources/transfer.rb +1 -1
  98. data/lib/stripe/resources/v2/core/account.rb +5 -5
  99. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -20
  100. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -24
  101. data/lib/stripe/resources/v2/payments/off_session_payment.rb +74 -0
  102. data/lib/stripe/resources/webhook_endpoint.rb +1 -2
  103. data/lib/stripe/resources.rb +8 -3
  104. data/lib/stripe/services/account_external_account_service.rb +2 -3
  105. data/lib/stripe/services/account_login_link_service.rb +1 -1
  106. data/lib/stripe/services/account_person_service.rb +1 -2
  107. data/lib/stripe/services/account_service.rb +38 -13
  108. data/lib/stripe/services/account_session_service.rb +49 -24
  109. data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
  110. data/lib/stripe/services/balance_service.rb +1 -1
  111. data/lib/stripe/services/balance_settings_service.rb +2 -2
  112. data/lib/stripe/services/charge_service.rb +76 -8
  113. data/lib/stripe/services/checkout/session_service.rb +14 -6
  114. data/lib/stripe/services/coupon_service.rb +1 -2
  115. data/lib/stripe/services/credit_note_service.rb +7 -8
  116. data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
  117. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
  118. data/lib/stripe/services/customer_payment_source_service.rb +1 -1
  119. data/lib/stripe/services/customer_service.rb +3 -5
  120. data/lib/stripe/services/customer_tax_id_service.rb +1 -2
  121. data/lib/stripe/services/dispute_service.rb +1 -1
  122. data/lib/stripe/services/external_account_service.rb +2 -3
  123. data/lib/stripe/services/file_service.rb +1 -1
  124. data/lib/stripe/services/identity/verification_session_service.rb +5 -5
  125. data/lib/stripe/services/invoice_item_service.rb +1 -2
  126. data/lib/stripe/services/invoice_service.rb +65 -35
  127. data/lib/stripe/services/issuing/authorization_service.rb +4 -4
  128. data/lib/stripe/services/issuing/card_service.rb +1 -1
  129. data/lib/stripe/services/issuing/dispute_service.rb +2 -2
  130. data/lib/stripe/services/order_service.rb +1 -33
  131. data/lib/stripe/services/payment_intent_service.rb +385 -386
  132. data/lib/stripe/services/payment_method_configuration_service.rb +212 -2
  133. data/lib/stripe/services/payment_method_domain_service.rb +1 -1
  134. data/lib/stripe/services/payment_method_service.rb +47 -110
  135. data/lib/stripe/services/payout_service.rb +2 -2
  136. data/lib/stripe/services/plan_service.rb +2 -3
  137. data/lib/stripe/services/price_service.rb +2 -2
  138. data/lib/stripe/services/privacy/redaction_job_service.rb +22 -13
  139. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +1 -1
  140. data/lib/stripe/services/product_feature_service.rb +1 -2
  141. data/lib/stripe/services/product_service.rb +2 -41
  142. data/lib/stripe/services/promotion_code_service.rb +1 -1
  143. data/lib/stripe/services/quote_service.rb +1 -1
  144. data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
  145. data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
  146. data/lib/stripe/services/radar/value_list_service.rb +1 -2
  147. data/lib/stripe/services/setup_intent_service.rb +122 -310
  148. data/lib/stripe/services/source_service.rb +1 -1
  149. data/lib/stripe/services/subscription_item_service.rb +26 -0
  150. data/lib/stripe/services/subscription_schedule_service.rb +94 -4
  151. data/lib/stripe/services/subscription_service.rb +103 -33
  152. data/lib/stripe/services/tax/calculation_service.rb +4 -0
  153. data/lib/stripe/services/tax/registration_service.rb +1 -1
  154. data/lib/stripe/services/tax_id_service.rb +1 -2
  155. data/lib/stripe/services/terminal/configuration_service.rb +1 -2
  156. data/lib/stripe/services/terminal/location_service.rb +2 -3
  157. data/lib/stripe/services/terminal/reader_service.rb +17 -3
  158. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +37 -97
  159. data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
  160. data/lib/stripe/services/token_service.rb +1 -1
  161. data/lib/stripe/services/transfer_service.rb +1 -1
  162. data/lib/stripe/services/v1_services.rb +1 -2
  163. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
  164. data/lib/stripe/services/v2/core/accounts/person_service.rb +2 -4
  165. data/lib/stripe/services/v2/core/event_destination_service.rb +4 -10
  166. data/lib/stripe/services/v2/core/event_service.rb +1 -2
  167. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +3 -7
  168. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +2 -4
  169. data/lib/stripe/services/v2/money_management/adjustment_service.rb +1 -2
  170. data/lib/stripe/services/v2/money_management/financial_account_service.rb +1 -2
  171. data/lib/stripe/services/v2/money_management/financial_address_service.rb +1 -1
  172. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +1 -2
  173. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +1 -2
  174. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +2 -4
  175. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +2 -4
  176. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +2 -4
  177. data/lib/stripe/services/v2/money_management/payout_method_service.rb +3 -7
  178. data/lib/stripe/services/v2/money_management/received_credit_service.rb +1 -2
  179. data/lib/stripe/services/v2/money_management/received_debit_service.rb +1 -2
  180. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +1 -2
  181. data/lib/stripe/services/v2/money_management/transaction_service.rb +1 -2
  182. data/lib/stripe/services/v2/payment_service.rb +15 -0
  183. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +138 -0
  184. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +1 -2
  185. data/lib/stripe/services/v2_services.rb +2 -1
  186. data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
  187. data/lib/stripe/services.rb +2 -3
  188. data/lib/stripe/version.rb +1 -1
  189. data/rbi/stripe.rbi +3903 -4131
  190. metadata +13 -8
  191. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  192. data/lib/stripe/resources/gift_cards/card.rb +0 -208
  193. data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
  194. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  195. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  196. data/lib/stripe/services/gift_cards_service.rb +0 -14
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: stripe
3
3
  version: !ruby/object:Gem::Version
4
- version: 15.2.0.pre.beta.1
4
+ version: 15.3.0.pre.beta.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stripe
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-04-30 00:00:00.000000000 Z
11
+ date: 2025-05-28 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Stripe is the easiest way to accept payments online. See https://stripe.com
14
14
  for details.
@@ -20,6 +20,7 @@ extra_rdoc_files: []
20
20
  files:
21
21
  - CHANGELOG.md
22
22
  - CODE_OF_CONDUCT.md
23
+ - CONTRIBUTING.md
23
24
  - CONTRIBUTORS
24
25
  - Gemfile
25
26
  - History.txt
@@ -106,6 +107,13 @@ files:
106
107
  - lib/stripe/events/v2_money_management_received_debit_updated_event.rb
107
108
  - lib/stripe/events/v2_money_management_transaction_created_event.rb
108
109
  - lib/stripe/events/v2_money_management_transaction_updated_event.rb
110
+ - lib/stripe/events/v2_off_session_payment_requires_capture_event.rb
111
+ - lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb
112
+ - lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb
113
+ - lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb
114
+ - lib/stripe/events/v2_payments_off_session_payment_created_event.rb
115
+ - lib/stripe/events/v2_payments_off_session_payment_failed_event.rb
116
+ - lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb
109
117
  - lib/stripe/instrumentation.rb
110
118
  - lib/stripe/list_object.rb
111
119
  - lib/stripe/multipart_encoder.rb
@@ -134,7 +142,6 @@ files:
134
142
  - lib/stripe/resources/billing/credit_balance_transaction.rb
135
143
  - lib/stripe/resources/billing/credit_grant.rb
136
144
  - lib/stripe/resources/billing/meter.rb
137
- - lib/stripe/resources/billing/meter_error_report.rb
138
145
  - lib/stripe/resources/billing/meter_event.rb
139
146
  - lib/stripe/resources/billing/meter_event_adjustment.rb
140
147
  - lib/stripe/resources/billing/meter_event_summary.rb
@@ -181,8 +188,6 @@ files:
181
188
  - lib/stripe/resources/forwarding/request.rb
182
189
  - lib/stripe/resources/funding_instructions.rb
183
190
  - lib/stripe/resources/fx_quote.rb
184
- - lib/stripe/resources/gift_cards/card.rb
185
- - lib/stripe/resources/gift_cards/transaction.rb
186
191
  - lib/stripe/resources/identity/verification_report.rb
187
192
  - lib/stripe/resources/identity/verification_session.rb
188
193
  - lib/stripe/resources/invoice.rb
@@ -307,6 +312,7 @@ files:
307
312
  - lib/stripe/resources/v2/money_management/received_debit.rb
308
313
  - lib/stripe/resources/v2/money_management/transaction.rb
309
314
  - lib/stripe/resources/v2/money_management/transaction_entry.rb
315
+ - lib/stripe/resources/v2/payments/off_session_payment.rb
310
316
  - lib/stripe/resources/webhook_endpoint.rb
311
317
  - lib/stripe/search_result_object.rb
312
318
  - lib/stripe/services.rb
@@ -385,9 +391,6 @@ files:
385
391
  - lib/stripe/services/forwarding/request_service.rb
386
392
  - lib/stripe/services/forwarding_service.rb
387
393
  - lib/stripe/services/fx_quote_service.rb
388
- - lib/stripe/services/gift_cards/card_service.rb
389
- - lib/stripe/services/gift_cards/transaction_service.rb
390
- - lib/stripe/services/gift_cards_service.rb
391
394
  - lib/stripe/services/identity/verification_report_service.rb
392
395
  - lib/stripe/services/identity/verification_session_service.rb
393
396
  - lib/stripe/services/identity_service.rb
@@ -537,6 +540,8 @@ files:
537
540
  - lib/stripe/services/v2/money_management/transaction_entry_service.rb
538
541
  - lib/stripe/services/v2/money_management/transaction_service.rb
539
542
  - lib/stripe/services/v2/money_management_service.rb
543
+ - lib/stripe/services/v2/payment_service.rb
544
+ - lib/stripe/services/v2/payments/off_session_payment_service.rb
540
545
  - lib/stripe/services/v2/test_helper_service.rb
541
546
  - lib/stripe/services/v2/test_helpers/financial_address_service.rb
542
547
  - lib/stripe/services/v2_services.rb
@@ -1,59 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- module Stripe
5
- module Billing
6
- class MeterErrorReport < APIResource
7
- OBJECT_NAME = "billing.meter_error_report"
8
- def self.object_name
9
- "billing.meter_error_report"
10
- end
11
-
12
- class Reason < Stripe::StripeObject
13
- class ErrorType < Stripe::StripeObject
14
- class SampleError < Stripe::StripeObject
15
- class ApiRequest < Stripe::StripeObject
16
- # Unique identifier for the object.
17
- attr_reader :id
18
- # idempotency_key of the request
19
- attr_reader :idempotency_key
20
- end
21
- # Attribute for field api_request
22
- attr_reader :api_request
23
- # message of the error
24
- attr_reader :error_message
25
- end
26
- # Attribute for field sample_errors
27
- attr_reader :sample_errors
28
- end
29
- # The number of errors generated
30
- attr_reader :error_count
31
- # More information about errors
32
- attr_reader :error_types
33
- end
34
-
35
- class RelatedObject < Stripe::StripeObject
36
- # Unique identifier for the object.
37
- attr_reader :id
38
- # The type of meter error related object. Should be 'meter'
39
- attr_reader :object
40
- # The url of the meter object
41
- attr_reader :url
42
- end
43
- # Unique identifier for the object.
44
- attr_reader :id
45
- # String representing the object's type. Objects of the same type share the same value.
46
- attr_reader :object
47
- # Attribute for field reason
48
- attr_reader :reason
49
- # The related objects about the error
50
- attr_reader :related_object
51
- # Summary of invalid events
52
- attr_reader :summary
53
- # Time when validation ended. Measured in seconds since the Unix epoch
54
- attr_reader :validation_end
55
- # Time when validation started. Measured in seconds since the Unix epoch
56
- attr_reader :validation_start
57
- end
58
- end
59
- end
@@ -1,208 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- module Stripe
5
- module GiftCards
6
- # A gift card represents a single gift card owned by a customer, including the
7
- # remaining balance, gift card code, and whether or not it is active.
8
- class Card < APIResource
9
- extend Stripe::APIOperations::Create
10
- extend Stripe::APIOperations::List
11
- include Stripe::APIOperations::Save
12
-
13
- OBJECT_NAME = "gift_cards.card"
14
- def self.object_name
15
- "gift_cards.card"
16
- end
17
-
18
- class CreatedBy < Stripe::StripeObject
19
- class Checkout < Stripe::StripeObject
20
- # The Stripe CheckoutSession that created this object.
21
- attr_reader :checkout_session
22
- # The Stripe CheckoutSession LineItem that created this object.
23
- attr_reader :line_item
24
- end
25
-
26
- class Order < Stripe::StripeObject
27
- # The Stripe Order LineItem that created this object.
28
- attr_reader :line_item
29
- # The Stripe Order that created this object.
30
- attr_reader :order
31
- end
32
-
33
- class Payment < Stripe::StripeObject
34
- # The PaymentIntent that created this object.
35
- attr_reader :payment_intent
36
- end
37
- # Attribute for field checkout
38
- attr_reader :checkout
39
- # Attribute for field order
40
- attr_reader :order
41
- # Attribute for field payment
42
- attr_reader :payment
43
- # The type of event that created this object.
44
- attr_reader :type
45
- end
46
-
47
- class ListParams < Stripe::RequestParams
48
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
49
- attr_accessor :ending_before
50
- # Specifies which fields in the response should be expanded.
51
- attr_accessor :expand
52
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
53
- attr_accessor :limit
54
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
55
- attr_accessor :starting_after
56
-
57
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
58
- @ending_before = ending_before
59
- @expand = expand
60
- @limit = limit
61
- @starting_after = starting_after
62
- end
63
- end
64
-
65
- class CreateParams < Stripe::RequestParams
66
- class CreatedBy < Stripe::RequestParams
67
- class Payment < Stripe::RequestParams
68
- # The PaymentIntent used to collect payment for this object.
69
- attr_accessor :payment_intent
70
-
71
- def initialize(payment_intent: nil)
72
- @payment_intent = payment_intent
73
- end
74
- end
75
- # The details for the payment that created this object.
76
- attr_accessor :payment
77
- # The type of event that created this object.
78
- attr_accessor :type
79
-
80
- def initialize(payment: nil, type: nil)
81
- @payment = payment
82
- @type = type
83
- end
84
- end
85
- # The active state for the new gift card, defaults to false. The active state can be updated after creation.
86
- attr_accessor :active
87
- # Related objects which created this gift card.
88
- attr_accessor :created_by
89
- # 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).
90
- attr_accessor :currency
91
- # Specifies which fields in the response should be expanded.
92
- attr_accessor :expand
93
- # The initial amount to load onto the new gift card, defaults to 0.
94
- attr_accessor :initial_amount
95
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
96
- attr_accessor :metadata
97
-
98
- def initialize(
99
- active: nil,
100
- created_by: nil,
101
- currency: nil,
102
- expand: nil,
103
- initial_amount: nil,
104
- metadata: nil
105
- )
106
- @active = active
107
- @created_by = created_by
108
- @currency = currency
109
- @expand = expand
110
- @initial_amount = initial_amount
111
- @metadata = metadata
112
- end
113
- end
114
-
115
- class UpdateParams < Stripe::RequestParams
116
- # The new active state for the gift card.
117
- attr_accessor :active
118
- # Specifies which fields in the response should be expanded.
119
- attr_accessor :expand
120
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
121
- attr_accessor :metadata
122
-
123
- def initialize(active: nil, expand: nil, metadata: nil)
124
- @active = active
125
- @expand = expand
126
- @metadata = metadata
127
- end
128
- end
129
-
130
- class ValidateParams < Stripe::RequestParams
131
- # The gift card code to be validated.
132
- attr_accessor :code
133
- # Specifies which fields in the response should be expanded.
134
- attr_accessor :expand
135
- # The pin associated with the gift card. Not all gift cards have pins.
136
- attr_accessor :giftcard_pin
137
-
138
- def initialize(code: nil, expand: nil, giftcard_pin: nil)
139
- @code = code
140
- @expand = expand
141
- @giftcard_pin = giftcard_pin
142
- end
143
- end
144
- # Whether this gift card can be used or not.
145
- attr_reader :active
146
- # The amount of funds available for new transactions.
147
- attr_reader :amount_available
148
- # The amount of funds marked as held.
149
- attr_reader :amount_held
150
- # Code used to redeem this gift card.
151
- attr_reader :code
152
- # Time at which the object was created. Measured in seconds since the Unix epoch.
153
- attr_reader :created
154
- # The related Stripe objects that created this gift card.
155
- attr_reader :created_by
156
- # 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).
157
- attr_reader :currency
158
- # Unique identifier for the object.
159
- attr_reader :id
160
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
161
- attr_reader :metadata
162
- # String representing the object's type. Objects of the same type share the same value.
163
- attr_reader :object
164
- # Transactions on this gift card.
165
- attr_reader :transactions
166
-
167
- # Creates a new gift card object.
168
- def self.create(params = {}, opts = {})
169
- request_stripe_object(
170
- method: :post,
171
- path: "/v1/gift_cards/cards",
172
- params: params,
173
- opts: opts
174
- )
175
- end
176
-
177
- # List gift cards for an account
178
- def self.list(params = {}, opts = {})
179
- request_stripe_object(
180
- method: :get,
181
- path: "/v1/gift_cards/cards",
182
- params: params,
183
- opts: opts
184
- )
185
- end
186
-
187
- # Update a gift card
188
- def self.update(id, params = {}, opts = {})
189
- request_stripe_object(
190
- method: :post,
191
- path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
192
- params: params,
193
- opts: opts
194
- )
195
- end
196
-
197
- # Validates a gift card code, returning the matching gift card object if it exists.
198
- def self.validate(params = {}, opts = {})
199
- request_stripe_object(
200
- method: :post,
201
- path: "/v1/gift_cards/cards/validate",
202
- params: params,
203
- opts: opts
204
- )
205
- end
206
- end
207
- end
208
- end
@@ -1,272 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- module Stripe
5
- module GiftCards
6
- # A gift card transaction represents a single transaction on a referenced gift card.
7
- # A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
8
- # transaction is one that has added/deducted funds. A `held` transaction has created a
9
- # temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
10
- # can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
11
- # A `canceled` transaction has no effect on a gift card's balance.
12
- class Transaction < APIResource
13
- extend Stripe::APIOperations::Create
14
- extend Stripe::APIOperations::List
15
- include Stripe::APIOperations::Save
16
-
17
- OBJECT_NAME = "gift_cards.transaction"
18
- def self.object_name
19
- "gift_cards.transaction"
20
- end
21
-
22
- class CreatedBy < Stripe::StripeObject
23
- class Checkout < Stripe::StripeObject
24
- # The Stripe CheckoutSession that created this object.
25
- attr_reader :checkout_session
26
- # The Stripe CheckoutSession LineItem that created this object.
27
- attr_reader :line_item
28
- end
29
-
30
- class Order < Stripe::StripeObject
31
- # The Stripe Order LineItem that created this object.
32
- attr_reader :line_item
33
- # The Stripe Order that created this object.
34
- attr_reader :order
35
- end
36
-
37
- class Payment < Stripe::StripeObject
38
- # The PaymentIntent that created this object.
39
- attr_reader :payment_intent
40
- end
41
- # Attribute for field checkout
42
- attr_reader :checkout
43
- # Attribute for field order
44
- attr_reader :order
45
- # Attribute for field payment
46
- attr_reader :payment
47
- # The type of event that created this object.
48
- attr_reader :type
49
- end
50
-
51
- class ListParams < Stripe::RequestParams
52
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
53
- attr_accessor :ending_before
54
- # Specifies which fields in the response should be expanded.
55
- attr_accessor :expand
56
- # The gift card to list transactions for.
57
- attr_accessor :gift_card
58
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
59
- attr_accessor :limit
60
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
61
- attr_accessor :starting_after
62
- # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
63
- attr_accessor :transfer_group
64
-
65
- def initialize(
66
- ending_before: nil,
67
- expand: nil,
68
- gift_card: nil,
69
- limit: nil,
70
- starting_after: nil,
71
- transfer_group: nil
72
- )
73
- @ending_before = ending_before
74
- @expand = expand
75
- @gift_card = gift_card
76
- @limit = limit
77
- @starting_after = starting_after
78
- @transfer_group = transfer_group
79
- end
80
- end
81
-
82
- class CreateParams < Stripe::RequestParams
83
- class CreatedBy < Stripe::RequestParams
84
- class Payment < Stripe::RequestParams
85
- # The PaymentIntent used to collect payment for this object.
86
- attr_accessor :payment_intent
87
-
88
- def initialize(payment_intent: nil)
89
- @payment_intent = payment_intent
90
- end
91
- end
92
- # The details for the payment that created this object.
93
- attr_accessor :payment
94
- # The type of event that created this object.
95
- attr_accessor :type
96
-
97
- def initialize(payment: nil, type: nil)
98
- @payment = payment
99
- @type = type
100
- end
101
- end
102
- # The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds.
103
- attr_accessor :amount
104
- # Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the `amount_available` on the gift card. Otherwise, it creates a held transaction that increments the `amount_held` on the gift card.
105
- attr_accessor :confirm
106
- # Related objects which created this transaction.
107
- attr_accessor :created_by
108
- # The currency of the transaction. This must match the currency of the gift card.
109
- attr_accessor :currency
110
- # An arbitrary string attached to the object. Often useful for displaying to users.
111
- attr_accessor :description
112
- # Specifies which fields in the response should be expanded.
113
- attr_accessor :expand
114
- # The gift card to create a new transaction on.
115
- attr_accessor :gift_card
116
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
117
- attr_accessor :metadata
118
- # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
119
- attr_accessor :transfer_group
120
-
121
- def initialize(
122
- amount: nil,
123
- confirm: nil,
124
- created_by: nil,
125
- currency: nil,
126
- description: nil,
127
- expand: nil,
128
- gift_card: nil,
129
- metadata: nil,
130
- transfer_group: nil
131
- )
132
- @amount = amount
133
- @confirm = confirm
134
- @created_by = created_by
135
- @currency = currency
136
- @description = description
137
- @expand = expand
138
- @gift_card = gift_card
139
- @metadata = metadata
140
- @transfer_group = transfer_group
141
- end
142
- end
143
-
144
- class UpdateParams < Stripe::RequestParams
145
- # An arbitrary string attached to the object. Often useful for displaying to users.
146
- attr_accessor :description
147
- # Specifies which fields in the response should be expanded.
148
- attr_accessor :expand
149
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
150
- attr_accessor :metadata
151
-
152
- def initialize(description: nil, expand: nil, metadata: nil)
153
- @description = description
154
- @expand = expand
155
- @metadata = metadata
156
- end
157
- end
158
-
159
- class CancelParams < Stripe::RequestParams
160
- # Specifies which fields in the response should be expanded.
161
- attr_accessor :expand
162
-
163
- def initialize(expand: nil)
164
- @expand = expand
165
- end
166
- end
167
-
168
- class ConfirmParams < Stripe::RequestParams
169
- # Specifies which fields in the response should be expanded.
170
- attr_accessor :expand
171
-
172
- def initialize(expand: nil)
173
- @expand = expand
174
- end
175
- end
176
- # The amount of this transaction. A positive value indicates that funds were added to the gift card. A negative value indicates that funds were removed from the gift card.
177
- attr_reader :amount
178
- # Time at which the transaction was confirmed. Measured in seconds since the Unix epoch.
179
- attr_reader :confirmed_at
180
- # Time at which the object was created. Measured in seconds since the Unix epoch.
181
- attr_reader :created
182
- # The related Stripe objects that created this gift card transaction.
183
- attr_reader :created_by
184
- # 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).
185
- attr_reader :currency
186
- # An arbitrary string attached to the object. Often useful for displaying to users.
187
- attr_reader :description
188
- # The gift card that this transaction occurred on
189
- attr_reader :gift_card
190
- # Unique identifier for the object.
191
- attr_reader :id
192
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
193
- attr_reader :metadata
194
- # String representing the object's type. Objects of the same type share the same value.
195
- attr_reader :object
196
- # Status of this transaction, one of `held`, `confirmed`, or `canceled`.
197
- attr_reader :status
198
- # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
199
- attr_reader :transfer_group
200
-
201
- # Cancel a gift card transaction
202
- def cancel(params = {}, opts = {})
203
- request_stripe_object(
204
- method: :post,
205
- path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
206
- params: params,
207
- opts: opts
208
- )
209
- end
210
-
211
- # Cancel a gift card transaction
212
- def self.cancel(id, params = {}, opts = {})
213
- request_stripe_object(
214
- method: :post,
215
- path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
216
- params: params,
217
- opts: opts
218
- )
219
- end
220
-
221
- # Confirm a gift card transaction
222
- def confirm(params = {}, opts = {})
223
- request_stripe_object(
224
- method: :post,
225
- path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(self["id"]) }),
226
- params: params,
227
- opts: opts
228
- )
229
- end
230
-
231
- # Confirm a gift card transaction
232
- def self.confirm(id, params = {}, opts = {})
233
- request_stripe_object(
234
- method: :post,
235
- path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
236
- params: params,
237
- opts: opts
238
- )
239
- end
240
-
241
- # Create a gift card transaction
242
- def self.create(params = {}, opts = {})
243
- request_stripe_object(
244
- method: :post,
245
- path: "/v1/gift_cards/transactions",
246
- params: params,
247
- opts: opts
248
- )
249
- end
250
-
251
- # List gift card transactions for a gift card
252
- def self.list(params = {}, opts = {})
253
- request_stripe_object(
254
- method: :get,
255
- path: "/v1/gift_cards/transactions",
256
- params: params,
257
- opts: opts
258
- )
259
- end
260
-
261
- # Update a gift card transaction
262
- def self.update(id, params = {}, opts = {})
263
- request_stripe_object(
264
- method: :post,
265
- path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
266
- params: params,
267
- opts: opts
268
- )
269
- end
270
- end
271
- end
272
- end