stripe 13.0.2 → 13.1.0.pre.beta.2

data/OPENAPI_VERSION

@@ -1 +1 @@
-v1268
+v1273

data/README.md

@@ -367,7 +367,7 @@ background terminal ([stripe-mock's README][stripe-mock] also contains
 instructions for installing via Homebrew and other methods):
 
 ```sh
-go install github.com/stripe/stripe-mock@latest
+go get -u github.com/stripe/stripe-mock
 stripe-mock
 ```
 

data/VERSION

@@ -1 +1 @@
-13.0.2
+13.1.0-beta.2

data/examples/README.md

@@ -3,14 +3,9 @@
 From the examples folder, run:
 `RUBYLIB=../lib ruby your_example.rb`
 
-e.g.
-
-`RUBYLIB=../lib ruby thinevent_webhook_handler.rb`
-
 ## Adding a new example
 
 1. Clone new_example.rb
 2. Implement your example
-3. Fill out the file comment. Include a description and key steps that are being demonstrated.
-4. Run it (as per above)
-5. 👍
+3. Run it (as per above)
+4. 👍

data/examples/meter_event_stream.rb

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-# meter_event_stream.py - use the high-throughput meter event stream to report create billing meter events.
-#
-# In this example, we:
-#   - create a meter event session and store the session's authentication token
-#   - define an event with a payload
-#   - use the meter_event_stream service accessor in StripeClient to create an event stream that reports this event
-#
-# This example expects a billing meter with an event_name of 'alpaca_ai_tokens'.  If you have
-# a different meter event name, you can change it before running this example.
-
 require "stripe"
 require "date"
 

data/examples/new_example.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "stripe"
+require "date"
+
+class NewExample
+  attr_accessor :api_key
+
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def do_something_great
+    puts "Hello World"
+    # client = Stripe::StripeClient.new(api_key)
+    # client.v1
+  end
+end
+
+# Send meter events
+api_key = "{{API_KEY}}"
+
+example = NewExample.new(api_key)
+example.do_something_great

data/examples/{thinevent_webhook_handler.rb → stripe_webhook_handler.rb}

@@ -1,17 +1,6 @@
 # frozen_string_literal: true
 # typed: false
 
-# thinevent_webhook_handler.rb - receive and process thin events like the
-# v1.billing.meter.error_report_triggered event.
-#
-# In this example, we:
-#     - create a StripeClient called client
-#     - use client.parse_thin_event to parse the received thin event webhook body
-#     - call client.v2.core.events.retrieve to retrieve the full event object
-#     - if it is a V1BillingMeterErrorReportTriggeredEvent event type, call
-#       event.fetchRelatedObject to retrieve the Billing Meter object associated
-#       with the event.
-
 require "stripe"
 require "sinatra"
 

data/lib/stripe/api_resource.rb

@@ -110,6 +110,7 @@ module Stripe
       opts = Util.normalize_opts(opts)
       instance = new(id, opts)
       instance.refresh
+      instance
     end
 
     def request_stripe_object(method:, path:, params:, base_address: :api, opts: {})

data/lib/stripe/object_types.rb

@@ -14,6 +14,7 @@ module Stripe
         # object classes: The beginning of the section generated from our OpenAPI spec
         Account.object_name => Account,
         AccountLink.object_name => AccountLink,
+        AccountNotice.object_name => AccountNotice,
         AccountSession.object_name => AccountSession,
         ApplePayDomain.object_name => ApplePayDomain,
         ApplicationFee.object_name => ApplicationFee,
@@ -33,6 +34,9 @@ module Stripe
         BillingPortal::Configuration.object_name => BillingPortal::Configuration,
         BillingPortal::Session.object_name => BillingPortal::Session,
         Capability.object_name => Capability,
+        Capital::FinancingOffer.object_name => Capital::FinancingOffer,
+        Capital::FinancingSummary.object_name => Capital::FinancingSummary,
+        Capital::FinancingTransaction.object_name => Capital::FinancingTransaction,
         Card.object_name => Card,
         CashBalance.object_name => CashBalance,
         Charge.object_name => Charge,
@@ -59,22 +63,30 @@ module Stripe
         File.object_name => File,
         FileLink.object_name => FileLink,
         FinancialConnections::Account.object_name => FinancialConnections::Account,
+        FinancialConnections::AccountInferredBalance.object_name =>
+        FinancialConnections::AccountInferredBalance,
         FinancialConnections::AccountOwner.object_name => FinancialConnections::AccountOwner,
         FinancialConnections::AccountOwnership.object_name => FinancialConnections::AccountOwnership,
+        FinancialConnections::Institution.object_name => FinancialConnections::Institution,
         FinancialConnections::Session.object_name => FinancialConnections::Session,
         FinancialConnections::Transaction.object_name => FinancialConnections::Transaction,
         Forwarding::Request.object_name => Forwarding::Request,
         FundingInstructions.object_name => FundingInstructions,
+        GiftCards::Card.object_name => GiftCards::Card,
+        GiftCards::Transaction.object_name => GiftCards::Transaction,
         Identity::VerificationReport.object_name => Identity::VerificationReport,
         Identity::VerificationSession.object_name => Identity::VerificationSession,
         Invoice.object_name => Invoice,
         InvoiceItem.object_name => InvoiceItem,
         InvoiceLineItem.object_name => InvoiceLineItem,
+        InvoicePayment.object_name => InvoicePayment,
         InvoiceRenderingTemplate.object_name => InvoiceRenderingTemplate,
         Issuing::Authorization.object_name => Issuing::Authorization,
         Issuing::Card.object_name => Issuing::Card,
         Issuing::Cardholder.object_name => Issuing::Cardholder,
+        Issuing::CreditUnderwritingRecord.object_name => Issuing::CreditUnderwritingRecord,
         Issuing::Dispute.object_name => Issuing::Dispute,
+        Issuing::DisputeSettlementDetail.object_name => Issuing::DisputeSettlementDetail,
         Issuing::PersonalizationDesign.object_name => Issuing::PersonalizationDesign,
         Issuing::PhysicalBundle.object_name => Issuing::PhysicalBundle,
         Issuing::Token.object_name => Issuing::Token,
@@ -82,6 +94,8 @@ module Stripe
         LineItem.object_name => LineItem,
         LoginLink.object_name => LoginLink,
         Mandate.object_name => Mandate,
+        Margin.object_name => Margin,
+        Order.object_name => Order,
         PaymentIntent.object_name => PaymentIntent,
         PaymentLink.object_name => PaymentLink,
         PaymentMethod.object_name => PaymentMethod,
@@ -95,6 +109,8 @@ module Stripe
         ProductFeature.object_name => ProductFeature,
         PromotionCode.object_name => PromotionCode,
         Quote.object_name => Quote,
+        QuotePreviewInvoice.object_name => QuotePreviewInvoice,
+        QuotePreviewSubscriptionSchedule.object_name => QuotePreviewSubscriptionSchedule,
         Radar::EarlyFraudWarning.object_name => Radar::EarlyFraudWarning,
         Radar::ValueList.object_name => Radar::ValueList,
         Radar::ValueListItem.object_name => Radar::ValueListItem,
@@ -112,8 +128,10 @@ module Stripe
         Subscription.object_name => Subscription,
         SubscriptionItem.object_name => SubscriptionItem,
         SubscriptionSchedule.object_name => SubscriptionSchedule,
+        Tax::Association.object_name => Tax::Association,
         Tax::Calculation.object_name => Tax::Calculation,
         Tax::CalculationLineItem.object_name => Tax::CalculationLineItem,
+        Tax::Form.object_name => Tax::Form,
         Tax::Registration.object_name => Tax::Registration,
         Tax::Settings.object_name => Tax::Settings,
         Tax::Transaction.object_name => Tax::Transaction,
@@ -125,6 +143,7 @@ module Stripe
         Terminal::ConnectionToken.object_name => Terminal::ConnectionToken,
         Terminal::Location.object_name => Terminal::Location,
         Terminal::Reader.object_name => Terminal::Reader,
+        Terminal::ReaderCollectedData.object_name => Terminal::ReaderCollectedData,
         TestHelpers::TestClock.object_name => TestHelpers::TestClock,
         Token.object_name => Token,
         Topup.object_name => Topup,

data/lib/stripe/request_signing_authenticator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Stripe
+  class RequestSigningAuthenticator
+    AUTHORIZATION_HEADER_NAME = "Authorization"
+    CONTENT_TYPE_HEADER_NAME = "Content-Type"
+    STRIPE_CONTEXT_HEADER_NAME = "Stripe-Context"
+    STRIPE_ACCOUNT_HEADER_NAME = "Stripe-Account"
+    CONTENT_DIGEST_HEADER_NAME = "Content-Digest"
+    SIGNATURE_INPUT_HEADER_NAME = "Signature-Input"
+    SIGNATURE_HEADER_NAME = "Signature"
+
+    attr_reader :auth_token, :sign_lambda
+
+    def initialize(auth_token, sign_lambda)
+      raise ArgumentError, "auth_token must be a string" unless auth_token.is_a?(String)
+      raise ArgumentError, "sign_lambda must be a lambda" unless sign_lambda.is_a?(Proc)
+
+      @auth_token = auth_token
+      @sign_lambda = sign_lambda
+    end
+
+    def authenticate(method, headers, body)
+      covered_headers = [CONTENT_TYPE_HEADER_NAME,
+                         CONTENT_DIGEST_HEADER_NAME,
+                         STRIPE_CONTEXT_HEADER_NAME,
+                         STRIPE_ACCOUNT_HEADER_NAME,
+                         AUTHORIZATION_HEADER_NAME,]
+
+      headers[AUTHORIZATION_HEADER_NAME] = "STRIPE-V2-SIG #{auth_token}"
+
+      if method == :get
+        covered_headers -= [CONTENT_TYPE_HEADER_NAME,
+                            CONTENT_DIGEST_HEADER_NAME,]
+      else
+        content = body || ""
+        headers[CONTENT_DIGEST_HEADER_NAME] =
+          %(sha-256=:#{content_digest(content)}:)
+      end
+
+      covered_headers_formatted = covered_headers
+                                  .map { |string| %("#{string.downcase}") }
+                                  .join(" ")
+
+      signature_input = "(#{covered_headers_formatted});created=#{created_time}"
+
+      inputs = covered_headers
+               .map { |header| %("#{header.downcase}": #{headers[header]}) }
+               .join("\n")
+
+      signature_base = %(#{inputs}\n"@signature-params": #{signature_input})
+                       .encode(Encoding::UTF_8)
+
+      headers[SIGNATURE_INPUT_HEADER_NAME] = "sig1=#{signature_input}"
+
+      headers[SIGNATURE_HEADER_NAME] =
+        "sig1=:#{encoded_signature(signature_base)}:"
+    end
+
+    private def sign(signature_base)
+      @sign_lambda.call(signature_base)
+    end
+
+    private def encoded_signature(signature_base)
+      Base64.strict_encode64(sign(signature_base))
+    rescue StandardError
+      raise AuthenticationError, "Encountered '#{e.message} (#{e.class})' " \
+                                 "when calculating request signature."
+    end
+
+    private def content_digest(content)
+      Base64.strict_encode64(OpenSSL::Digest.new("SHA256").digest(content))
+    end
+
+    private def created_time
+      Time.now.to_i
+    end
+  end
+end

data/lib/stripe/resources/account_notice.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: 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
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "account_notice"
+    def self.object_name
+      "account_notice"
+    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.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/account_notices", params: filters, opts: opts)
+    end
+
+    # Updates an AccountNotice object.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/account_notices/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/billing/meter.rb

@@ -4,6 +4,8 @@
 module Stripe
   module Billing
     # A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.
+    #
+    # Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
     class Meter < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/capital/financing_offer.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing an offer of financing from
+    # Stripe Capital to a Connect subaccount.
+    class FinancingOffer < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_offer"
+      def self.object_name
+        "capital.financing_offer"
+      end
+
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def self.mark_delivered(financing_offer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_summary.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # A financing object describes an account's current financing state. Used by Connect
+    # platforms to read the state of Capital offered to their connected accounts.
+    class FinancingSummary < SingletonAPIResource
+      OBJECT_NAME = "capital.financing_summary"
+      def self.object_name
+        "capital.financing_summary"
+      end
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_transaction.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing the details of a transaction on a Capital financing object.
+    class FinancingTransaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_transaction"
+      def self.object_name
+        "capital.financing_transaction"
+      end
+
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/financial_connections/account.rb

@@ -6,12 +6,15 @@ module Stripe
     # A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
     class Account < APIResource
       extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
 
       OBJECT_NAME = "financial_connections.account"
       def self.object_name
         "financial_connections.account"
       end
 
+      nested_resource_class_methods :inferred_balance, operations: %i[list]
+
       # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
       def disconnect(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/financial_connections/account_inferred_balance.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
+    class AccountInferredBalance < APIResource
+      OBJECT_NAME = "financial_connections.account_inferred_balance"
+      def self.object_name
+        "financial_connections.account_inferred_balance"
+      end
+    end
+  end
+end

data/lib/stripe/resources/financial_connections/institution.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
+    class Institution < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "financial_connections.institution"
+      def self.object_name
+        "financial_connections.institution"
+      end
+
+      # Returns a list of Financial Connections Institution objects.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/financial_connections/institutions",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/gift_cards/card.rb

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card represents a single gift card owned by a customer, including the
+    # remaining balance, gift card code, and whether or not it is active.
+    class Card < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.card"
+      def self.object_name
+        "gift_cards.card"
+      end
+
+      # Creates a new gift card object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List gift cards for an account
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/gift_cards/cards",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Update a gift card
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Validates a gift card code, returning the matching gift card object if it exists.
+      def self.validate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/cards/validate",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/gift_cards/transaction.rb

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card transaction represents a single transaction on a referenced gift card.
+    # A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
+    # transaction is one that has added/deducted funds. A `held` transaction has created a
+    # temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
+    # can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
+    # A `canceled` transaction has no effect on a gift card's balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.transaction"
+      def self.object_name
+        "gift_cards.transaction"
+      end
+
+      # Cancel a gift card transaction
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Cancel a gift card transaction
+      def self.cancel(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Confirm a gift card transaction
+      def confirm(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Confirm a gift card transaction
+      def self.confirm(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Create a gift card transaction
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List gift card transactions for a gift card
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/gift_cards/transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Update a gift card transaction
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end