stripe 13.3.0 → 13.4.0.pre.beta.1

data/rbi/stripe/services/billing_portal/session_service.rbi

@@ -0,0 +1,233 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module BillingPortal
+    class SessionService < StripeService
+      class CreateParams < Stripe::RequestParams
+        class FlowData < Stripe::RequestParams
+          class AfterCompletion < Stripe::RequestParams
+            class HostedConfirmation < Stripe::RequestParams
+              # A custom message to display to the customer after the flow is completed.
+              sig { returns(String) }
+              attr_accessor :custom_message
+
+              sig { params(custom_message: String).void }
+              def initialize(custom_message: nil); end
+            end
+            class Redirect < Stripe::RequestParams
+              # The URL the customer will be redirected to after the flow is completed.
+              sig { returns(String) }
+              attr_accessor :return_url
+
+              sig { params(return_url: String).void }
+              def initialize(return_url: nil); end
+            end
+            # Configuration when `after_completion.type=hosted_confirmation`.
+            sig {
+              returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation)
+             }
+            attr_accessor :hosted_confirmation
+
+            # Configuration when `after_completion.type=redirect`.
+            sig {
+              returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect)
+             }
+            attr_accessor :redirect
+
+            # The specified behavior after the flow is completed.
+            sig { returns(String) }
+            attr_accessor :type
+
+            sig {
+              params(hosted_confirmation: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation, redirect: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect, type: String).void
+             }
+            def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
+          end
+          class SubscriptionCancel < Stripe::RequestParams
+            class Retention < Stripe::RequestParams
+              class CouponOffer < Stripe::RequestParams
+                # The ID of the coupon to be offered.
+                sig { returns(String) }
+                attr_accessor :coupon
+
+                sig { params(coupon: String).void }
+                def initialize(coupon: nil); end
+              end
+              # Configuration when `retention.type=coupon_offer`.
+              sig {
+                returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer)
+               }
+              attr_accessor :coupon_offer
+
+              # Type of retention strategy to use with the customer.
+              sig { returns(String) }
+              attr_accessor :type
+
+              sig {
+                params(coupon_offer: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer, type: String).void
+               }
+              def initialize(coupon_offer: nil, type: nil); end
+            end
+            # Specify a retention strategy to be used in the cancellation flow.
+            sig {
+              returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention)
+             }
+            attr_accessor :retention
+
+            # The ID of the subscription to be canceled.
+            sig { returns(String) }
+            attr_accessor :subscription
+
+            sig {
+              params(retention: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention, subscription: String).void
+             }
+            def initialize(retention: nil, subscription: nil); end
+          end
+          class SubscriptionUpdate < Stripe::RequestParams
+            # The ID of the subscription to be updated.
+            sig { returns(String) }
+            attr_accessor :subscription
+
+            sig { params(subscription: String).void }
+            def initialize(subscription: nil); end
+          end
+          class SubscriptionUpdateConfirm < Stripe::RequestParams
+            class Discount < Stripe::RequestParams
+              # The ID of the coupon to apply to this subscription update.
+              sig { returns(String) }
+              attr_accessor :coupon
+
+              # The ID of a promotion code to apply to this subscription update.
+              sig { returns(String) }
+              attr_accessor :promotion_code
+
+              sig { params(coupon: String, promotion_code: String).void }
+              def initialize(coupon: nil, promotion_code: nil); end
+            end
+            class Item < Stripe::RequestParams
+              # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+              sig { returns(String) }
+              attr_accessor :id
+
+              # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+              sig { returns(String) }
+              attr_accessor :price
+
+              # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+              sig { returns(Integer) }
+              attr_accessor :quantity
+
+              sig { params(id: String, price: String, quantity: Integer).void }
+              def initialize(id: nil, price: nil, quantity: nil); end
+            end
+            # The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
+            sig {
+              returns(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount])
+             }
+            attr_accessor :discounts
+
+            # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+            sig {
+              returns(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item])
+             }
+            attr_accessor :items
+
+            # The ID of the subscription to be updated.
+            sig { returns(String) }
+            attr_accessor :subscription
+
+            sig {
+              params(discounts: T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount], items: T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
+             }
+            def initialize(discounts: nil, items: nil, subscription: nil); end
+          end
+          # Behavior after the flow is completed.
+          sig {
+            returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion)
+           }
+          attr_accessor :after_completion
+
+          # Configuration when `flow_data.type=subscription_cancel`.
+          sig {
+            returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel)
+           }
+          attr_accessor :subscription_cancel
+
+          # Configuration when `flow_data.type=subscription_update`.
+          sig {
+            returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate)
+           }
+          attr_accessor :subscription_update
+
+          # Configuration when `flow_data.type=subscription_update_confirm`.
+          sig {
+            returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm)
+           }
+          attr_accessor :subscription_update_confirm
+
+          # Type of flow that the customer will go through.
+          sig { returns(String) }
+          attr_accessor :type
+
+          sig {
+            params(after_completion: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion, subscription_cancel: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate, subscription_update_confirm: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm, type: String).void
+           }
+          def initialize(
+            after_completion: nil,
+            subscription_cancel: nil,
+            subscription_update: nil,
+            subscription_update_confirm: nil,
+            type: nil
+          ); end
+        end
+        # The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
+        sig { returns(String) }
+        attr_accessor :configuration
+
+        # The ID of an existing customer.
+        sig { returns(String) }
+        attr_accessor :customer
+
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+
+        # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
+        sig { returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData) }
+        attr_accessor :flow_data
+
+        # The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
+        sig { returns(String) }
+        attr_accessor :locale
+
+        # The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+        sig { returns(String) }
+        attr_accessor :on_behalf_of
+
+        # The default URL to redirect customers to when they click on the portal's link to return to your website.
+        sig { returns(String) }
+        attr_accessor :return_url
+
+        sig {
+          params(configuration: String, customer: String, expand: T::Array[String], flow_data: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData, locale: String, on_behalf_of: String, return_url: String).void
+         }
+        def initialize(
+          configuration: nil,
+          customer: nil,
+          expand: nil,
+          flow_data: nil,
+          locale: nil,
+          on_behalf_of: nil,
+          return_url: nil
+        ); end
+      end
+      # Creates a session of the customer portal.
+      sig {
+        params(params: T.any(::Stripe::BillingPortal::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Session)
+       }
+      def create(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/services/billing_portal_service.rbi

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class BillingPortalService < StripeService
+    attr_reader :configurations
+    attr_reader :sessions
+  end
+end

data/rbi/stripe/services/billing_service.rbi

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class BillingService < StripeService
+    attr_reader :alerts
+    attr_reader :credit_balance_summary
+    attr_reader :credit_balance_transactions
+    attr_reader :credit_grants
+    attr_reader :meters
+    attr_reader :meter_events
+    attr_reader :meter_event_adjustments
+  end
+end

data/rbi/stripe/services/capital/financing_offer_service.rbi

@@ -0,0 +1,108 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Capital
+    class FinancingOfferService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :gt
+
+          # Minimum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :gte
+
+          # Maximum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :lt
+
+          # Maximum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :lte
+
+          sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+        end
+        # limit list to offers belonging to given connected account
+        sig { returns(String) }
+        attr_accessor :connected_account
+
+        # Only return offers that were created during the given date interval.
+        sig {
+          returns(T.any(::Stripe::Capital::FinancingOfferService::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) }
+        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
+
+        # 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
+
+        # limit list to offers with given status
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig {
+          params(connected_account: String, created: T.any(::Stripe::Capital::FinancingOfferService::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, status: String).void
+         }
+        def initialize(
+          connected_account: nil,
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          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
+
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      class MarkDeliveredParams < 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
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      sig {
+        params(params: T.any(::Stripe::Capital::FinancingOfferService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def list(params = {}, opts = {}); end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      sig {
+        params(financing_offer: String, params: T.any(::Stripe::Capital::FinancingOfferService::MarkDeliveredParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
+       }
+      def mark_delivered(financing_offer, params = {}, opts = {}); end
+
+      # Get the details of the financing offer
+      sig {
+        params(financing_offer: String, params: T.any(::Stripe::Capital::FinancingOfferService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
+       }
+      def retrieve(financing_offer, params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/services/capital/financing_summary_service.rbi

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Capital
+    class FinancingSummaryService < StripeService
+      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
+      # Retrieve the financing state for the account that was authenticated in the request.
+      sig {
+        params(params: T.any(::Stripe::Capital::FinancingSummaryService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingSummary)
+       }
+      def retrieve(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/services/capital/financing_transaction_service.rbi

@@ -0,0 +1,77 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Capital
+    class FinancingTransactionService < StripeService
+      class ListParams < Stripe::RequestParams
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
+        sig { returns(String) }
+        attr_accessor :charge
+
+        # 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
+
+        # Returns transactions that were created that apply to this financing offer ID.
+        sig { returns(String) }
+        attr_accessor :financing_offer
+
+        # 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
+
+        # Only returns transactions that are responsible for reversing this financing transaction ID.
+        sig { returns(String) }
+        attr_accessor :reversed_transaction
+
+        # 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
+
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
+        sig { returns(String) }
+        attr_accessor :treasury_transaction
+
+        sig {
+          params(charge: String, ending_before: String, expand: T::Array[String], financing_offer: String, limit: Integer, reversed_transaction: String, starting_after: String, treasury_transaction: String).void
+         }
+        def initialize(
+          charge: nil,
+          ending_before: nil,
+          expand: nil,
+          financing_offer: nil,
+          limit: nil,
+          reversed_transaction: nil,
+          starting_after: nil,
+          treasury_transaction: 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
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      sig {
+        params(params: T.any(::Stripe::Capital::FinancingTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def list(params = {}, opts = {}); end
+
+      # Retrieves a financing transaction for a financing offer.
+      sig {
+        params(financing_transaction: String, params: T.any(::Stripe::Capital::FinancingTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingTransaction)
+       }
+      def retrieve(financing_transaction, params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/services/capital_service.rbi

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class CapitalService < StripeService
+    attr_reader :financing_offers
+    attr_reader :financing_summary
+    attr_reader :financing_transactions
+  end
+end