sharpetronics/stripe-ruby
1
0
Fork 0
mirror of https://github.com/stripe/stripe-ruby.git synced 2025-11-27 00:03:06 -05:00
Code Issues Projects Releases Wiki Activity

Update generated code for v1759

Browse Source
This commit is contained in:
Stripe OpenAPI 2025-05-15 21:24:41 +00:00
parent 9055854651
commit 1f5eb68c99
10 changed files with 52 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
OPENAPI_VERSION
View File

@ -1 +1 @@
v1758
v1759

17
lib/stripe/resources/credit_note.rb
View File

@ -635,9 +635,9 @@ module Stripe
attr_reader :out_of_band_amount
# The link to download the PDF of the credit note.
attr_reader :pdf
# Attribute for field post_payment_amount
# The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
attr_reader :post_payment_amount
# Attribute for field pre_payment_amount
# The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
attr_reader :pre_payment_amount
# The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
attr_reader :pretax_credit_amounts
@ -664,20 +664,19 @@ module Stripe
# The time that the credit note was voided.
attr_reader :voided_at
# Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
# its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
# in any combination of the following:
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
# or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
def self.create(params = {}, opts = {})
request_stripe_object(method: :post, path: "/v1/credit_notes", params: params, opts: opts)
end

10
lib/stripe/resources/invoice.rb
View File

@ -4336,9 +4336,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -4346,7 +4343,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
def attach_payment(params = {}, opts = {})
request_stripe_object(
method: :post,
@ -4358,9 +4355,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -4368,7 +4362,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
def self.attach_payment(invoice, params = {}, opts = {})
request_stripe_object(
method: :post,

13
lib/stripe/services/credit_note_service.rb
View File

@ -380,20 +380,19 @@ module Stripe
end
end
# Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
# its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
# in any combination of the following:
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
# or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
def create(params = {}, opts = {})
request(
method: :post,

5
lib/stripe/services/invoice_service.rb
View File

@ -3680,9 +3680,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -3690,7 +3687,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
def attach_payment(invoice, params = {}, opts = {})
request(
method: :post,

45
rbi/stripe.rbi
View File

@ -26169,10 +26169,10 @@ module Stripe
# The link to download the PDF of the credit note.
sig { returns(String) }
attr_reader :pdf
# Attribute for field post_payment_amount
# The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
sig { returns(Integer) }
attr_reader :post_payment_amount
# Attribute for field pre_payment_amount
# The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
sig { returns(Integer) }
attr_reader :pre_payment_amount
# The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
@ -26716,20 +26716,19 @@ module Stripe
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
# its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
# in any combination of the following:
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
# or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
sig {
params(params: T.any(::Stripe::CreditNote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
@ -37242,9 +37241,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -37252,7 +37248,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
sig {
params(params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
@ -37260,9 +37256,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -37270,7 +37263,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
@ -127512,20 +127505,19 @@ module Stripe
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
# its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
# in any combination of the following:
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
# or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
sig {
params(params: T.any(::Stripe::CreditNoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
@ -135165,9 +135157,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -135175,7 +135164,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}

17
rbi/stripe/resources/credit_note.rbi
View File

@ -155,10 +155,10 @@ module Stripe
# The link to download the PDF of the credit note.
sig { returns(String) }
attr_reader :pdf
# Attribute for field post_payment_amount
# The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
sig { returns(Integer) }
attr_reader :post_payment_amount
# Attribute for field pre_payment_amount
# The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
sig { returns(Integer) }
attr_reader :pre_payment_amount
# The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
@ -702,20 +702,19 @@ module Stripe
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
# its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
# in any combination of the following:
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
# or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
sig {
params(params: T.any(::Stripe::CreditNote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}

10
rbi/stripe/resources/invoice.rbi
View File

@ -4782,9 +4782,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -4792,7 +4789,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
sig {
params(params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
@ -4800,9 +4797,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -4810,7 +4804,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}

13
rbi/stripe/services/credit_note_service.rbi
View File

@ -368,20 +368,19 @@ module Stripe
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
# its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
# in any combination of the following:
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
# or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
sig {
params(params: T.any(::Stripe::CreditNoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}

5
rbi/stripe/services/invoice_service.rbi
View File

@ -3950,9 +3950,6 @@ module Stripe
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
#
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
#
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
# invoice's status becomes paid.
@ -3960,7 +3957,7 @@ module Stripe
# If the PaymentIntent's status is already succeeded when it's attached, it's
# credited to the invoice immediately.
#
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
# See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}