stripe 10.8.0 → 10.9.0.pre.beta.1

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,29 @@
+# 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"
+
+    # 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/capital/financing_offer.rb

@@ -0,0 +1,46 @@
+# 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"
+
+      # 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
+
+      # 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
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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"
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# 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"
+
+      # 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/confirmation_token.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # ConfirmationTokens help transport client side data collected by Stripe JS over
+  # to your server for confirming a PaymentIntent or SetupIntent. If the confirmation
+  # is successful, values present on the ConfirmationToken are written onto the Intent.
+  #
+  # To learn more or request access, visit the related guided: [Finalize payments on the server using Confirmation Tokens](https://stripe.com/docs/payments/finalize-payments-on-the-server-confirmation-tokens).
+  class ConfirmationToken < APIResource
+    OBJECT_NAME = "confirmation_token"
+  end
+end

data/lib/stripe/resources/customer.rb

@@ -17,6 +17,7 @@ module Stripe
 
     nested_resource_class_methods :balance_transaction, operations: %i[create retrieve update list]
     nested_resource_class_methods :cash_balance_transaction, operations: %i[retrieve list]
+    nested_resource_class_methods :entitlement, operations: %i[list]
     nested_resource_class_methods :tax_id, operations: %i[create retrieve delete list]
 
     # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
@@ -183,6 +184,16 @@ module Stripe
       )
     end
 
+    # Retrieve the entitlement summary for a customer
+    def self.retrieve_entitlement_summary(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/entitlement_summary", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def test_helpers
       TestHelpers.new(self)
     end

data/lib/stripe/resources/customer_entitlement.rb

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A entitlement for a customer describes access to a feature.
+  class CustomerEntitlement < APIResource
+    OBJECT_NAME = "customer_entitlement"
+  end
+end

data/lib/stripe/resources/customer_entitlement_summary.rb

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A summary of a customer's entitlements.
+  class CustomerEntitlementSummary < APIResource
+    OBJECT_NAME = "customer_entitlement_summary"
+  end
+end

data/lib/stripe/resources/entitlements/event.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    # An entitlement event either grants or revokes an entitlement to a feature for a customer.
+    class Event < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "entitlements.event"
+
+      # Create an entitlement event manually, outside of the entitlement events automatically created by Stripe lifecycle events.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/entitlements/events",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/entitlements/feature.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    # A feature represents a monetizable ability or functionality in your system.
+    # Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
+    class Feature < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "entitlements.feature"
+
+      # Creates a feature
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/entitlements/features",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of features
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/entitlements/features",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -6,9 +6,12 @@ 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"
 
+      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,11 @@
+# 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"
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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"
+
+      # 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
+
+      # 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
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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"
+
+      # 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
+
+      # 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
+
+      # 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 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

data/lib/stripe/resources/invoice.rb

@@ -40,9 +40,30 @@ module Stripe
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "invoice"
 
+    nested_resource_class_methods :payment, operations: %i[retrieve list]
+
+    # Attaches a PaymentIntent to the invoice, adding it to the list of payments.
+    # When the PaymentIntent's status changes to succeeded, the payment is credited
+    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
+    # invoice's status becomes paid.
+    #
+    # If the PaymentIntent's status is already succeeded when it is attached, it is
+    # credited to the invoice immediately.
+    #
+    # Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
+    def attach_payment_intent(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
     def finalize_invoice(params = {}, opts = {})
       request_stripe_object(
@@ -95,6 +116,38 @@ module Stripe
       )
     end
 
+    # Attaches a PaymentIntent to the invoice, adding it to the list of payments.
+    # When the PaymentIntent's status changes to succeeded, the payment is credited
+    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
+    # invoice's status becomes paid.
+    #
+    # If the PaymentIntent's status is already succeeded when it is attached, it is
+    # credited to the invoice immediately.
+    #
+    # Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
+    def self.attach_payment_intent(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
+    #
+    # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
+    #
+    # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.
+    def self.create_preview(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "/v1/invoices/create_preview",
+        params: params,
+        opts: opts
+      )
+    end
+
     # Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
     def self.finalize_invoice(invoice, params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources/invoice_payment.rb

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # The invoice payment object
+  class InvoicePayment < APIResource
+    OBJECT_NAME = "invoice_payment"
+  end
+end

data/lib/stripe/resources/issuing/credit_underwriting_record.rb

@@ -0,0 +1,85 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new `CreditUnderwritingRecord` object on a connected account.
+    #
+    # [Follow the guide](https://stripe.com/docs/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.
+    class CreditUnderwritingRecord < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.credit_underwriting_record"
+
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def correct(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def report_decision(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def self.correct(credit_underwriting_record, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object with information about a credit application submission.
+      def self.create_from_application(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_application",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
+      def self.create_from_proactive_review(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_proactive_review",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def self.report_decision(credit_underwriting_record, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieves a list of CreditUnderwritingRecord 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/issuing/credit_underwriting_records",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end