stripe 13.6.0.pre.beta.1 → 14.0.0

data/rbi/stripe/resources/invoice_payment.rbi

@@ -12,9 +12,6 @@ module Stripe
       # ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
       sig { returns(T.any(String, Stripe::PaymentIntent)) }
       attr_reader :payment_intent
-      # ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
-      sig { returns(T.any(String, Stripe::PaymentRecord)) }
-      attr_reader :payment_record
       # Type of payment object associated with this invoice payment.
       sig { returns(String) }
       attr_reader :type
@@ -27,9 +24,6 @@ module Stripe
       sig { returns(T.nilable(Integer)) }
       attr_reader :paid_at
     end
-    # Excess payment that was received for this invoice and credited to the customer’s `invoice_credit_balance`. This field is null until the payment is `paid`. Overpayment can happen when you attach more than one PaymentIntent to the invoice, and each of them succeeds. To avoid overpayment, cancel any PaymentIntents that you do not need before attaching more.
-    sig { returns(T.nilable(Integer)) }
-    attr_reader :amount_overpaid
     # Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.
     sig { returns(T.nilable(Integer)) }
     attr_reader :amount_paid
@@ -49,7 +43,7 @@ module Stripe
     sig { returns(T.any(String, Stripe::Invoice)) }
     attr_reader :invoice
     # Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly.
-    sig { returns(T.nilable(T::Boolean)) }
+    sig { returns(T::Boolean) }
     attr_reader :is_default
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
     sig { returns(T::Boolean) }
@@ -66,5 +60,55 @@ module Stripe
     # Attribute for field status_transitions
     sig { returns(StatusTransitions) }
     attr_reader :status_transitions
+    class ListParams < Stripe::RequestParams
+      class Payment < Stripe::RequestParams
+        # Only return invoice payments associated by this payment intent ID.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_intent
+        # Only return invoice payments associated by this payment type.
+        sig { returns(String) }
+        attr_accessor :type
+        sig { params(payment_intent: T.nilable(String), type: String).void }
+        def initialize(payment_intent: nil, type: nil); end
+      end
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      # The identifier of the invoice whose payments to return.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :invoice
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :limit
+      # The payment details of the invoice payments to return.
+      sig { returns(T.nilable(::Stripe::InvoicePayment::ListParams::Payment)) }
+      attr_accessor :payment
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :starting_after
+      # The status of the invoice payments to return.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :status
+      sig {
+        params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), payment: T.nilable(::Stripe::InvoicePayment::ListParams::Payment), starting_after: T.nilable(String), status: T.nilable(String)).void
+       }
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        invoice: nil,
+        limit: nil,
+        payment: nil,
+        starting_after: nil,
+        status: nil
+      ); end
+    end
+    # When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+    sig {
+      params(params: T.any(::Stripe::InvoicePayment::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
   end
 end

data/rbi/stripe/resources/invoice_rendering_template.rbi

@@ -32,22 +32,22 @@ module Stripe
     attr_reader :version
     class ListParams < Stripe::RequestParams
       # 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.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :ending_before
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
       # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :limit
       # 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.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :starting_after
       # Attribute for param field status
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :status
       sig {
-        params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, status: String).void
+        params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
        }
       def initialize(
         ending_before: nil,
@@ -57,28 +57,18 @@ module Stripe
         status: nil
       ); end
     end
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
-      attr_accessor :expand
-      # Attribute for param field version
-      sig { returns(Integer) }
-      attr_accessor :version
-      sig { params(expand: T::Array[String], version: Integer).void }
-      def initialize(expand: nil, version: nil); end
-    end
     class ArchiveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
-      sig { params(expand: T::Array[String]).void }
+      sig { params(expand: T.nilable(T::Array[String])).void }
       def initialize(expand: nil); end
     end
     class UnarchiveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
-      sig { params(expand: T::Array[String]).void }
+      sig { params(expand: T.nilable(T::Array[String])).void }
       def initialize(expand: nil); end
     end
     # Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.