stripe 18.2.0.pre.alpha.1 → 18.2.0.pre.alpha.3

data/lib/stripe/resources/tax_code.rb

@@ -11,6 +11,18 @@ module Stripe
       "tax_code"
     end
 
+    class Requirements < ::Stripe::StripeObject
+      # Describes whether a performance location is required for a successful tax calculation with a tax code.
+      attr_reader :performance_location
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
     # A detailed description of which types of products the tax code represents.
     attr_reader :description
     # Unique identifier for the object.
@@ -19,6 +31,8 @@ module Stripe
     attr_reader :name
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
+    # An object that describes more information about the tax location required for this tax code. Some [tax codes](/tax/tax-for-tickets/integration-guide#types-of-products) require a tax location of type `performance` to calculate tax correctly.
+    attr_reader :requirements
 
     # A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
     def self.list(params = {}, opts = {})
@@ -26,7 +40,7 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = {}
+      @inner_class_types = { requirements: Requirements }
     end
 
     def self.field_remappings

data/lib/stripe/resources/v2/money_management/outbound_payment.rb

@@ -27,13 +27,31 @@ module Stripe
         end
 
         class DeliveryOptions < ::Stripe::StripeObject
-          # Open Enum. Method for bank account.
-          attr_reader :bank_account
+          class PaperCheck < ::Stripe::StripeObject
+            # Memo printed on the memo field of the check.
+            attr_reader :memo
+            # Open Enum. Shipping speed of the paper check.
+            attr_reader :shipping_speed
+            # Signature for the paper check.
+            attr_reader :signature
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
           # Open Enum. Speed of the payout.
           attr_reader :speed
+          # Open Enum. Method for bank account.
+          attr_reader :bank_account
+          # Delivery options for paper check.
+          attr_reader :paper_check
 
           def self.inner_class_types
-            @inner_class_types = {}
+            @inner_class_types = { paper_check: PaperCheck }
           end
 
           def self.field_remappings
@@ -195,6 +213,67 @@ module Stripe
             @field_remappings = {}
           end
         end
+
+        class TrackingDetails < ::Stripe::StripeObject
+          class PaperCheck < ::Stripe::StripeObject
+            class MailingAddress < ::Stripe::StripeObject
+              # City, district, suburb, town, or village.
+              attr_reader :city
+              # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+              attr_reader :country
+              # Address line 1 (e.g., street, PO Box, or company name).
+              attr_reader :line1
+              # Address line 2 (e.g., apartment, suite, unit, or building).
+              attr_reader :line2
+              # ZIP or postal code.
+              attr_reader :postal_code
+              # State, county, province, or region.
+              attr_reader :state
+              # Town or district.
+              attr_reader :town
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Open Enum. Carrier of the paper check.
+            attr_reader :carrier
+            # Check number.
+            attr_reader :check_number
+            # Postal code of the latest tracking update.
+            attr_reader :current_postal_code
+            # Mailing address of the paper check.
+            attr_reader :mailing_address
+            # Tracking number for the check.
+            attr_reader :tracking_number
+            # Open Enum. Tracking status of the paper check.
+            attr_reader :tracking_status
+            # When the tracking details were last updated.
+            attr_reader :updated_at
+
+            def self.inner_class_types
+              @inner_class_types = { mailing_address: MailingAddress }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Paper check tracking details.
+          attr_reader :paper_check
+
+          def self.inner_class_types
+            @inner_class_types = { paper_check: PaperCheck }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
         # The "presentment amount" for the OutboundPayment.
         attr_reader :amount
         # Returns true if the OutboundPayment can be canceled, and false otherwise.
@@ -240,6 +319,8 @@ module Stripe
         attr_reader :to
         # A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar.
         attr_reader :trace_id
+        # Information to track this OutboundPayment with the recipient bank.
+        attr_reader :tracking_details
         # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
         attr_reader :livemode
 
@@ -253,6 +334,7 @@ module Stripe
             status_transitions: StatusTransitions,
             to: To,
             trace_id: TraceId,
+            tracking_details: TrackingDetails,
           }
         end
 

data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb

@@ -27,10 +27,10 @@ module Stripe
         end
 
         class DeliveryOptions < ::Stripe::StripeObject
-          # Open Enum. Method for bank account.
-          attr_reader :bank_account
           # Open Enum. Speed of the payout.
           attr_reader :speed
+          # Open Enum. Method for bank account.
+          attr_reader :bank_account
 
           def self.inner_class_types
             @inner_class_types = {}

data/lib/stripe/resources.rb

@@ -144,6 +144,7 @@ require "stripe/resources/tax/association"
 require "stripe/resources/tax/calculation"
 require "stripe/resources/tax/calculation_line_item"
 require "stripe/resources/tax/form"
+require "stripe/resources/tax/location"
 require "stripe/resources/tax/registration"
 require "stripe/resources/tax/settings"
 require "stripe/resources/tax/transaction"
@@ -290,6 +291,7 @@ require "stripe/events/v2_core_account_including_configuration_recipient_updated
 require "stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event"
 require "stripe/events/v2_core_account_including_configuration_storer_updated_event"
 require "stripe/events/v2_core_account_including_defaults_updated_event"
+require "stripe/events/v2_core_account_including_future_requirements_updated_event"
 require "stripe/events/v2_core_account_including_identity_updated_event"
 require "stripe/events/v2_core_account_including_requirements_updated_event"
 require "stripe/events/v2_core_account_link_returned_event"

data/lib/stripe/services/subscription_service.rb

@@ -79,6 +79,17 @@ module Stripe
       )
     end
 
+    # Pauses a subscription by transitioning it to the paused status. A paused subscription does not generate invoices and will not advance to new billing periods. The subscription can be resumed later using the resume endpoint. Cannot pause subscriptions with attached schedules.
+    def pause(subscription, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/pause", { subscription: CGI.escape(subscription) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
     def resume(subscription, params = {}, opts = {})
       request(

data/lib/stripe/services/tax/location_service.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class LocationService < StripeService
+      # Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/tax/locations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.
+      #
+      # The response includes detailed information for each tax location, such as its address, name, description, and current operational status.
+      #
+      # You can paginate through the list by using the limit parameter to control the number of results returned in each request.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/tax/locations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide).
+      def retrieve(location, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/locations/%<location>s", { location: CGI.escape(location) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/tax_service.rb

@@ -3,13 +3,14 @@
 
 module Stripe
   class TaxService < StripeService
-    attr_reader :associations, :calculations, :forms, :registrations, :settings, :transactions
+    attr_reader :associations, :calculations, :forms, :locations, :registrations, :settings, :transactions
 
     def initialize(requestor)
       super
       @associations = Stripe::Tax::AssociationService.new(@requestor)
       @calculations = Stripe::Tax::CalculationService.new(@requestor)
       @forms = Stripe::Tax::FormService.new(@requestor)
+      @locations = Stripe::Tax::LocationService.new(@requestor)
       @registrations = Stripe::Tax::RegistrationService.new(@requestor)
       @settings = Stripe::Tax::SettingsService.new(@requestor)
       @transactions = Stripe::Tax::TransactionService.new(@requestor)

data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb

@@ -17,7 +17,7 @@ module Stripe
         end
 
         # Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration
-        def update(shared_payment_granted_token, params = {}, opts = {})
+        def revoke(shared_payment_granted_token, params = {}, opts = {})
           request(
             method: :post,
             path: format("/v1/test_helpers/shared_payment/granted_tokens/%<shared_payment_granted_token>s/revoke", { shared_payment_granted_token: CGI.escape(shared_payment_granted_token) }),

data/lib/stripe/services/v2/core/account_link_service.rb

@@ -6,6 +6,8 @@ module Stripe
     module Core
       class AccountLinkService < StripeService
         # Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.
+        #
+        # ** raises RateLimitError
         def create(params = {}, opts = {})
           request(
             method: :post,

data/lib/stripe/services/v2/core/account_service.rb

@@ -14,6 +14,8 @@ module Stripe
         end
 
         # Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.
+        #
+        # ** raises RateLimitError
         def close(id, params = {}, opts = {})
           request(
             method: :post,
@@ -25,6 +27,8 @@ module Stripe
         end
 
         # An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.
+        #
+        # ** raises RateLimitError
         def create(params = {}, opts = {})
           request(
             method: :post,
@@ -36,6 +40,8 @@ module Stripe
         end
 
         # Returns a list of Accounts.
+        #
+        # ** raises RateLimitError
         def list(params = {}, opts = {})
           request(
             method: :get,
@@ -47,6 +53,8 @@ module Stripe
         end
 
         # Retrieves the details of an Account.
+        #
+        # ** raises RateLimitError
         def retrieve(id, params = {}, opts = {})
           request(
             method: :get,
@@ -58,6 +66,8 @@ module Stripe
         end
 
         # Updates the details of an Account.
+        #
+        # ** raises RateLimitError
         def update(id, params = {}, opts = {})
           request(
             method: :post,

data/lib/stripe/services/v2/core/account_token_service.rb

@@ -6,6 +6,8 @@ module Stripe
     module Core
       class AccountTokenService < StripeService
         # Creates an Account Token.
+        #
+        # ** raises RateLimitError
         def create(params = {}, opts = {})
           request(
             method: :post,
@@ -17,6 +19,8 @@ module Stripe
         end
 
         # Retrieves an Account Token.
+        #
+        # ** raises RateLimitError
         def retrieve(id, params = {}, opts = {})
           request(
             method: :get,

data/lib/stripe/services/v2/core/accounts/person_service.rb

@@ -7,6 +7,8 @@ module Stripe
       module Accounts
         class PersonService < StripeService
           # Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation.
+          #
+          # ** raises RateLimitError
           def create(account_id, params = {}, opts = {})
             request(
               method: :post,
@@ -18,6 +20,8 @@ module Stripe
           end
 
           # Delete a Person associated with an Account.
+          #
+          # ** raises RateLimitError
           def delete(account_id, id, params = {}, opts = {})
             request(
               method: :delete,
@@ -29,6 +33,8 @@ module Stripe
           end
 
           # Returns a paginated list of Persons associated with an Account.
+          #
+          # ** raises RateLimitError
           def list(account_id, params = {}, opts = {})
             request(
               method: :get,
@@ -40,6 +46,8 @@ module Stripe
           end
 
           # Retrieves a Person associated with an Account.
+          #
+          # ** raises RateLimitError
           def retrieve(account_id, id, params = {}, opts = {})
             request(
               method: :get,
@@ -51,6 +59,8 @@ module Stripe
           end
 
           # Updates a Person associated with an Account.
+          #
+          # ** raises RateLimitError
           def update(account_id, id, params = {}, opts = {})
             request(
               method: :post,

data/lib/stripe/services/v2/core/accounts/person_token_service.rb

@@ -7,6 +7,8 @@ module Stripe
       module Accounts
         class PersonTokenService < StripeService
           # Creates a Person Token associated with an Account.
+          #
+          # ** raises RateLimitError
           def create(account_id, params = {}, opts = {})
             request(
               method: :post,
@@ -18,6 +20,8 @@ module Stripe
           end
 
           # Retrieves a Person Token associated with an Account.
+          #
+          # ** raises RateLimitError
           def retrieve(account_id, id, params = {}, opts = {})
             request(
               method: :get,

data/lib/stripe/services/v2/iam/api_key_service.rb

@@ -5,7 +5,7 @@ module Stripe
   module V2
     module Iam
       class ApiKeyService < StripeService
-        # Create an API key.
+        # Create an API key. To create a secret key in livemode, a public key for encryption must be provided.
         def create(params = {}, opts = {})
           request(
             method: :post,
@@ -16,7 +16,7 @@ module Stripe
           )
         end
 
-        # Expire an API key.
+        # Expire an API key. The specified key becomes invalid immediately.
         def expire(id, params = {}, opts = {})
           request(
             method: :post,
@@ -38,7 +38,7 @@ module Stripe
           )
         end
 
-        # Retrieve an API key.
+        # Retrieve an API key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.
         def retrieve(id, params = {}, opts = {})
           request(
             method: :get,
@@ -49,7 +49,7 @@ module Stripe
           )
         end
 
-        # Rotate an API key.
+        # Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.
         def rotate(id, params = {}, opts = {})
           request(
             method: :post,
@@ -60,7 +60,7 @@ module Stripe
           )
         end
 
-        # Update an API key.
+        # Update an API key. Only parameters that are specified in the request will be updated.
         def update(id, params = {}, opts = {})
           request(
             method: :post,

data/lib/stripe/services.rb

@@ -159,6 +159,7 @@ require "stripe/services/tax/association_service"
 require "stripe/services/tax/calculation_line_item_service"
 require "stripe/services/tax/calculation_service"
 require "stripe/services/tax/form_service"
+require "stripe/services/tax/location_service"
 require "stripe/services/tax/registration_service"
 require "stripe/services/tax/settings_service"
 require "stripe/services/tax/transaction_line_item_service"

data/lib/stripe/util.rb

@@ -7,16 +7,22 @@ module Stripe
     LEGAL_FIRST_CHARACTER = /[a-zA-Z_]/.freeze
     LEGAL_VARIABLE_CHARACTER = /[a-zA-Z0-9_]/.freeze
 
-    def self.objects_to_ids(obj)
+    def self.objects_to_ids(obj, semantics)
       case obj
       when APIResource
         obj.id
       when Hash
         res = {}
-        obj.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? }
+        obj.each do |k, v|
+          if !v.nil?
+            res[k] = objects_to_ids(v, semantics)
+          elsif semantics == :v2
+            res[k] = nil
+          end
+        end
         res
       when Array
-        obj.map { |v| objects_to_ids(v) }
+        obj.map { |v| objects_to_ids(v, semantics) }
       else
         obj
       end

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "18.2.0-alpha.1"
+  VERSION = "18.2.0-alpha.3"
 end