stripe 13.6.0.pre.beta.1 → 14.0.0

data/rbi/stripe/services/identity/verification_session_service.rbi

@@ -8,48 +8,50 @@ module Stripe
       class ListParams < Stripe::RequestParams
         class Created < Stripe::RequestParams
           # Minimum value to filter by (exclusive)
-          sig { returns(Integer) }
+          sig { returns(T.nilable(Integer)) }
           attr_accessor :gt
           # Minimum value to filter by (inclusive)
-          sig { returns(Integer) }
+          sig { returns(T.nilable(Integer)) }
           attr_accessor :gte
           # Maximum value to filter by (exclusive)
-          sig { returns(Integer) }
+          sig { returns(T.nilable(Integer)) }
           attr_accessor :lt
           # Maximum value to filter by (inclusive)
-          sig { returns(Integer) }
+          sig { returns(T.nilable(Integer)) }
           attr_accessor :lte
-          sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+          sig {
+            params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
+           }
           def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
         end
         # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :client_reference_id
         # Only return VerificationSessions that were created during the given date interval.
         sig {
-          returns(T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer))
+          returns(T.nilable(T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer)))
          }
         attr_accessor :created
         # 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
         # Attribute for param field related_customer
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :related_customer
         # 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
         # Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :status
         sig {
-          params(client_reference_id: String, created: T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, related_customer: String, starting_after: String, status: String).void
+          params(client_reference_id: T.nilable(String), created: T.nilable(T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), related_customer: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
          }
         def initialize(
           client_reference_id: nil,
@@ -66,19 +68,19 @@ module Stripe
         class Options < Stripe::RequestParams
           class Document < Stripe::RequestParams
             # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
-            sig { returns(T::Array[String]) }
+            sig { returns(T.nilable(T::Array[String])) }
             attr_accessor :allowed_types
             # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
-            sig { returns(T::Boolean) }
+            sig { returns(T.nilable(T::Boolean)) }
             attr_accessor :require_id_number
             # Disable image uploads, identity document images have to be captured using the device’s camera.
-            sig { returns(T::Boolean) }
+            sig { returns(T.nilable(T::Boolean)) }
             attr_accessor :require_live_capture
             # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
-            sig { returns(T::Boolean) }
+            sig { returns(T.nilable(T::Boolean)) }
             attr_accessor :require_matching_selfie
             sig {
-              params(allowed_types: T::Array[String], require_id_number: T::Boolean, require_live_capture: T::Boolean, require_matching_selfie: T::Boolean).void
+              params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
              }
             def initialize(
               allowed_types: nil,
@@ -89,55 +91,57 @@ module Stripe
           end
           # Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
           sig {
-            returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document))
+            returns(T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document))))
            }
           attr_accessor :document
           sig {
-            params(document: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document)).void
+            params(document: T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document)))).void
            }
           def initialize(document: nil); end
         end
         class ProvidedDetails < Stripe::RequestParams
           # Email of user being verified
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :email
           # Phone number of user being verified
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :phone
-          sig { params(email: String, phone: String).void }
+          sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
           def initialize(email: nil, phone: nil); end
         end
         # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :client_reference_id
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
         # 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`.
-        sig { returns(T::Hash[String, String]) }
+        sig { returns(T.nilable(T::Hash[String, String])) }
         attr_accessor :metadata
         # A set of options for the session’s verification checks.
-        sig { returns(::Stripe::Identity::VerificationSessionService::CreateParams::Options) }
+        sig {
+          returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options))
+         }
         attr_accessor :options
         # Details provided about the user being verified. These details may be shown to the user.
         sig {
-          returns(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails)
+          returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails))
          }
         attr_accessor :provided_details
         # Customer ID
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :related_customer
         # The URL that the user will be redirected to upon completing the verification flow.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :return_url
         # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :type
         # The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :verification_flow
         sig {
-          params(client_reference_id: String, expand: T::Array[String], metadata: T::Hash[String, String], options: ::Stripe::Identity::VerificationSessionService::CreateParams::Options, provided_details: ::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails, related_customer: String, return_url: String, type: String, verification_flow: String).void
+          params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails), related_customer: T.nilable(String), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
          }
         def initialize(
           client_reference_id: nil,
@@ -153,28 +157,28 @@ module Stripe
       end
       class RetrieveParams < 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 UpdateParams < Stripe::RequestParams
         class Options < Stripe::RequestParams
           class Document < Stripe::RequestParams
             # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
-            sig { returns(T::Array[String]) }
+            sig { returns(T.nilable(T::Array[String])) }
             attr_accessor :allowed_types
             # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
-            sig { returns(T::Boolean) }
+            sig { returns(T.nilable(T::Boolean)) }
             attr_accessor :require_id_number
             # Disable image uploads, identity document images have to be captured using the device’s camera.
-            sig { returns(T::Boolean) }
+            sig { returns(T.nilable(T::Boolean)) }
             attr_accessor :require_live_capture
             # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
-            sig { returns(T::Boolean) }
+            sig { returns(T.nilable(T::Boolean)) }
             attr_accessor :require_matching_selfie
             sig {
-              params(allowed_types: T::Array[String], require_id_number: T::Boolean, require_live_capture: T::Boolean, require_matching_selfie: T::Boolean).void
+              params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
              }
             def initialize(
               allowed_types: nil,
@@ -185,43 +189,45 @@ module Stripe
           end
           # Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
           sig {
-            returns(T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document))
+            returns(T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document))))
            }
           attr_accessor :document
           sig {
-            params(document: T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document)).void
+            params(document: T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document)))).void
            }
           def initialize(document: nil); end
         end
         class ProvidedDetails < Stripe::RequestParams
           # Email of user being verified
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :email
           # Phone number of user being verified
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :phone
-          sig { params(email: String, phone: String).void }
+          sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
           def initialize(email: nil, phone: nil); end
         end
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
         # 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`.
-        sig { returns(T::Hash[String, String]) }
+        sig { returns(T.nilable(T::Hash[String, String])) }
         attr_accessor :metadata
         # A set of options for the session’s verification checks.
-        sig { returns(::Stripe::Identity::VerificationSessionService::UpdateParams::Options) }
+        sig {
+          returns(T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options))
+         }
         attr_accessor :options
         # Details provided about the user being verified. These details may be shown to the user.
         sig {
-          returns(::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails)
+          returns(T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails))
          }
         attr_accessor :provided_details
         # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :type
         sig {
-          params(expand: T::Array[String], metadata: T::Hash[String, String], options: ::Stripe::Identity::VerificationSessionService::UpdateParams::Options, provided_details: ::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails, type: String).void
+          params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails), type: T.nilable(String)).void
          }
         def initialize(
           expand: nil,
@@ -233,16 +239,16 @@ module Stripe
       end
       class CancelParams < 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 RedactParams < 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
       # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).