stripe 13.4.0 → 13.5.0.pre.beta.1

data/rbi/stripe/resources/account_link.rbi

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Account Links are the means by which a Connect platform grants a connected account permission to access
+  # Stripe-hosted applications, such as Connect Onboarding.
+  #
+  # Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)
+  class AccountLink < APIResource
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # The timestamp at which this account link will expire.
+    sig { returns(Integer) }
+    attr_reader :expires_at
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # The URL for the account link.
+    sig { returns(String) }
+    attr_reader :url
+    class CreateParams < Stripe::RequestParams
+      class CollectionOptions < Stripe::RequestParams
+        # Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.
+        sig { returns(String) }
+        attr_accessor :fields
+        # Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
+        sig { returns(String) }
+        attr_accessor :future_requirements
+        sig { params(fields: String, future_requirements: String).void }
+        def initialize(fields: nil, future_requirements: nil); end
+      end
+      # The identifier of the account to create an account link for.
+      sig { returns(String) }
+      attr_accessor :account
+      # The collect parameter is deprecated. Use `collection_options` instead.
+      sig { returns(String) }
+      attr_accessor :collect
+      # Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
+      sig { returns(::Stripe::AccountLink::CreateParams::CollectionOptions) }
+      attr_accessor :collection_options
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      # The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
+      sig { returns(String) }
+      attr_accessor :refresh_url
+      # The URL that the user will be redirected to upon leaving or completing the linked flow.
+      sig { returns(String) }
+      attr_accessor :return_url
+      # The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.
+      sig { returns(String) }
+      attr_accessor :type
+      sig {
+        params(account: String, collect: String, collection_options: ::Stripe::AccountLink::CreateParams::CollectionOptions, expand: T::Array[String], refresh_url: String, return_url: String, type: String).void
+       }
+      def initialize(
+        account: nil,
+        collect: nil,
+        collection_options: nil,
+        expand: nil,
+        refresh_url: nil,
+        return_url: nil,
+        type: nil
+      ); end
+    end
+    # Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.
+    sig {
+      params(params: T.any(::Stripe::AccountLink::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountLink)
+     }
+    def self.create(params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/resources/account_notice.rbi

@@ -0,0 +1,139 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
+  #
+  # See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
+  class AccountNotice < APIResource
+    class Email < Stripe::StripeObject
+      # Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
+      sig { returns(String) }
+      attr_reader :plain_text
+      # Email address of the recipient.
+      sig { returns(String) }
+      attr_reader :recipient
+      # Subject of the email.
+      sig { returns(String) }
+      attr_reader :subject
+    end
+    class LinkedObjects < Stripe::StripeObject
+      # Associated [Capability](https://stripe.com/docs/api/capabilities)
+      sig { returns(T.nilable(String)) }
+      attr_reader :capability
+      # Associated [Credit Underwriting Record](https://stripe.com/docs/api/issuing/credit_underwriting_record)
+      sig { returns(T.nilable(String)) }
+      attr_reader :issuing_credit_underwriting_record
+      # Associated [Issuing Dispute](https://stripe.com/docs/api/issuing/disputes)
+      sig { returns(T.nilable(String)) }
+      attr_reader :issuing_dispute
+    end
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # When present, the deadline for sending the notice to meet the relevant regulations.
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :deadline
+    # Information about the email when sent.
+    sig { returns(T.nilable(Email)) }
+    attr_reader :email
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # Information about objects related to the notice.
+    sig { returns(T.nilable(LinkedObjects)) }
+    attr_reader :linked_objects
+    # 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) }
+    attr_reader :livemode
+    # 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.
+    sig { returns(T.nilable(T::Hash[String, String])) }
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
+    sig { returns(String) }
+    attr_reader :reason
+    # Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :sent_at
+    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) }
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      sig { returns(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) }
+      attr_accessor :limit
+      # Set to false to only return unsent AccountNotices.
+      sig { returns(T::Boolean) }
+      attr_accessor :sent
+      # 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) }
+      attr_accessor :starting_after
+      sig {
+        params(ending_before: String, expand: T::Array[String], limit: Integer, sent: T::Boolean, starting_after: String).void
+       }
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        sent: nil,
+        starting_after: nil
+      ); end
+    end
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+    class UpdateParams < Stripe::RequestParams
+      class Email < Stripe::RequestParams
+        # Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
+        sig { returns(String) }
+        attr_accessor :plain_text
+        # Email address of the recipient.
+        sig { returns(String) }
+        attr_accessor :recipient
+        # Subject of the email.
+        sig { returns(String) }
+        attr_accessor :subject
+        sig { params(plain_text: String, recipient: String, subject: String).void }
+        def initialize(plain_text: nil, recipient: nil, subject: nil); end
+      end
+      # Information about the email you sent.
+      sig { returns(::Stripe::AccountNotice::UpdateParams::Email) }
+      attr_accessor :email
+      # Specifies which fields in the response should be expanded.
+      sig { returns(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]) }
+      attr_accessor :metadata
+      # Date when you sent the notice.
+      sig { returns(Integer) }
+      attr_accessor :sent_at
+      sig {
+        params(email: ::Stripe::AccountNotice::UpdateParams::Email, expand: T::Array[String], metadata: T::Hash[String, String], sent_at: Integer).void
+       }
+      def initialize(email: nil, expand: nil, metadata: nil, sent_at: nil); end
+    end
+    # Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
+    sig {
+      params(params: T.any(::Stripe::AccountNotice::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+
+    # Updates an AccountNotice object.
+    sig {
+      params(account_notice: String, params: T.any(::Stripe::AccountNotice::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountNotice)
+     }
+    def self.update(account_notice, params = {}, opts = {}); end
+  end
+end