stripe 7.1.0.pre.beta.1 → 7.2.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803504fb9cf5348f6c69d73dce412e713d60da6eeb583598a269fdf6e74d1519
-  data.tar.gz: e2ec613485ac48c5118ce5bfdf9179fbf369f62f91ba4b38e3c4918050310f26
+  metadata.gz: e4845d5ca23b7a644ecea69e1ed4248990a2602e69ca624c01b3f2ccf6f89e21
+  data.tar.gz: fb173da5fd059e3644062a92f93e9362f0f0c13f375753f5049ec16c10cbb766
 SHA512:
-  metadata.gz: 9ca2cd6e815e5acbca268b1c6be2be3651b1486c7377334e4de6b016091b9602479782b0a774d9429ac3bf753199db5c0c21ee00e34faa100a85fba8eb31ea5a
-  data.tar.gz: 459abca01397a4f89a6740c48e51e613e821ec7a877f24a1864d939ed993b2b45cac574a9b513f3187aa06a57987eeb10ee070b9a1f7cc81edb955285d69fbf2
+  metadata.gz: e46a5de00036241655b787669f934adf56fd18f9327468d1b7970cfbab2ee4407b4dab45a819bb3cebe18d63311bd7782aa2d19f6c84bc5985a0854d49240164
+  data.tar.gz: 04cb4e8098a288ee885b3e0a9bc515c436f875cac7fda1819aa8b02fd0859984e376f1be61267cd21f95da686fdd1b78d08fc4a452a60cb3b621db42feb557e7

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 7.2.0-beta.1 - 2022-08-23
+* [#1122](https://github.com/stripe/stripe-ruby/pull/1122) API Updates for beta branch
+  - Updated stable APIs to the latest version
+  - `Stripe-Version` beta headers are not pinned by-default and need to be manually specified, please refer to [beta SDKs README section](https://github.com/stripe/stripe-ruby/blob/master/README.md#beta-sdks) 
+
+## 7.1.0 - 2022-08-19
+* [#1116](https://github.com/stripe/stripe-ruby/pull/1116) API Updates
+  * Add support for new resource `CustomerCashBalanceTransaction`
+* [#1118](https://github.com/stripe/stripe-ruby/pull/1118) Update AllowedChars in rubocop config
+* [#1117](https://github.com/stripe/stripe-ruby/pull/1117) Refresh rubocop config.
+* [#1115](https://github.com/stripe/stripe-ruby/pull/1115) Add a support section to the readme
+
+## 7.1.0-beta.2 - 2022-08-11
+* [#1113](https://github.com/stripe/stripe-ruby/pull/1113) API Updates for beta branch
+  - Updated stable APIs to the latest version
+  - Add `refund_payment` method to Terminal resource
+
 ## 7.1.0-beta.1 - 2022-08-03
 * [#1107](https://github.com/stripe/stripe-ruby/pull/1107) API Updates for beta branch
   - Updated stable APIs to the latest version

data/OPENAPI_VERSION

@@ -1 +1 @@
-v175
+v184

data/README.md

@@ -16,6 +16,10 @@ The library also provides other features. For example:
 - Built-in mechanisms for the serialization of parameters according to the
   expectations of Stripe's API.
 
+## Support
+
+New features and bug fixes are released on the latest major version of the Stripe Ruby library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
+
 ## Documentation
 
 See the [Ruby API docs](https://stripe.com/docs/api?lang=ruby).

data/VERSION

@@ -1 +1 @@
-7.1.0-beta.1
+7.2.0-beta.1

data/lib/stripe/api_version.rb

@@ -3,6 +3,6 @@
 
 module Stripe
   module ApiVersion
-    CURRENT = "2022-08-01; server_side_confirmation_beta=v1; orders_beta=v4"
+    CURRENT = "2022-08-01"
   end
 end

data/lib/stripe/object_types.rb

@@ -14,6 +14,7 @@ module Stripe
         # business objects
         Account::OBJECT_NAME => Account,
         AccountLink::OBJECT_NAME => AccountLink,
+        AccountSession::OBJECT_NAME => AccountSession,
         ApplePayDomain::OBJECT_NAME => ApplePayDomain,
         ApplicationFee::OBJECT_NAME => ApplicationFee,
         ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund,
@@ -34,6 +35,7 @@ module Stripe
         CreditNoteLineItem::OBJECT_NAME => CreditNoteLineItem,
         Customer::OBJECT_NAME => Customer,
         CustomerBalanceTransaction::OBJECT_NAME => CustomerBalanceTransaction,
+        CustomerCashBalanceTransaction::OBJECT_NAME => CustomerCashBalanceTransaction,
         Discount::OBJECT_NAME => Discount,
         Dispute::OBJECT_NAME => Dispute,
         EphemeralKey::OBJECT_NAME => EphemeralKey,

data/lib/stripe/resources/account.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a Stripe account. You can retrieve it to see
+  # properties on the account like its current e-mail address or if the account is
+  # enabled yet to make live charges.
+  #
+  # Some properties, marked below, are available only to platforms that want to
+  # [create and manage Express or Custom accounts](https://stripe.com/docs/connect/accounts).
   class Account < APIResource
     extend Gem::Deprecate
     extend Stripe::APIOperations::Create

data/lib/stripe/resources/account_link.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: 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/connect-onboarding).
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/account_session.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # An AccountSession allows a Connect platform to grant access to a connected account in Connect Elements.
+  #
+  # We recommend that you create an AccountSession each time you need to display an embedded UI
+  # to your user. Do not save AccountSessions to your database as they expire relatively
+  # quickly, and cannot be used more than once.
+  #
+  # Related guide: [Connect Elements](https://stripe.com/docs/connect/get-started-connect-elements).
+  class AccountSession < APIResource
+    extend Stripe::APIOperations::Create
+
+    OBJECT_NAME = "account_session"
+  end
+end

data/lib/stripe/resources/application_fee_refund.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # `Application Fee Refund` objects allow you to refund an application fee that
+  # has previously been created but not yet refunded. Funds will be refunded to
+  # the Stripe account from which the fee was originally collected.
+  #
+  # Related guide: [Refunding Application Fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee).
   class ApplicationFeeRefund < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/apps/secret.rb

@@ -3,6 +3,15 @@
 
 module Stripe
   module Apps
+    # Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
+    #
+    # The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
+    #
+    # All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
+    #
+    # A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
+    #
+    # Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects).
     class Secret < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/balance.rb

@@ -2,6 +2,17 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing your Stripe balance. You can retrieve it to see
+  # the balance currently on your Stripe account.
+  #
+  # You can also retrieve the balance history, which contains a list of
+  # [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance
+  # (charges, payouts, and so forth).
+  #
+  # The available and pending amounts for each currency are broken down further by
+  # payment source types.
+  #
+  # Related guide: [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).
   class Balance < SingletonAPIResource
     OBJECT_NAME = "balance"
   end

data/lib/stripe/resources/balance_transaction.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Balance transactions represent funds moving through your Stripe account.
+  # They're created for every type of transaction that comes into or flows out of your Stripe account balance.
+  #
+  # Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/bank_account.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # These bank accounts are payment methods on `Customer` objects.
+  #
+  # On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer
+  # destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).
+  # They can be bank accounts or debit cards as well, and are documented in the links above.
+  #
+  # Related guide: [Bank Debits and Transfers](https://stripe.com/docs/payments/bank-debits-transfers).
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -3,6 +3,7 @@
 
 module Stripe
   module BillingPortal
+    # A portal configuration describes the functionality and behavior of a portal session.
     class Configuration < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/billing_portal/session.rb

@@ -3,6 +3,20 @@
 
 module Stripe
   module BillingPortal
+    # The Billing customer portal is a Stripe-hosted UI for subscription and
+    # billing management.
+    #
+    # A portal configuration describes the functionality and features that you
+    # want to provide to your customers through the portal.
+    #
+    # A portal session describes the instantiation of the customer portal for
+    # a particular customer. By visiting the session's URL, the customer
+    # can manage their subscriptions and billing details. For security reasons,
+    # sessions are short-lived and will expire if the customer does not visit the URL.
+    # Create sessions on-demand when customers intend to manage their subscriptions
+    # and billing details.
+    #
+    # Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
     class Session < APIResource
       extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/capability.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a capability for a Stripe account.
+  #
+  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities).
   class Capability < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/card.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # You can store multiple cards on a customer in order to charge the customer
+  # later. You can also store multiple debit cards on a recipient in order to
+  # transfer to those cards later.
+  #
+  # Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards).
   class Card < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/cash_balance.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
   class CashBalance < APIResource
     OBJECT_NAME = "cash_balance"
 

data/lib/stripe/resources/charge.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # To charge a credit or a debit card, you create a `Charge` object. You can
+  # retrieve and refund individual charges as well as list all charges. Charges
+  # are identified by a unique, random ID.
+  #
+  # Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).
   class Charge < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/checkout/session.rb

@@ -3,6 +3,20 @@
 
 module Stripe
   module Checkout
+    # A Checkout Session represents your customer's session as they pay for
+    # one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
+    # or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
+    # new Session each time your customer attempts to pay.
+    #
+    # Once payment is successful, the Checkout Session will contain a reference
+    # to the [Customer](https://stripe.com/docs/api/customers), and either the successful
+    # [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
+    # [Subscription](https://stripe.com/docs/api/subscriptions).
+    #
+    # You can create a Checkout Session on your server and pass its ID to the
+    # client to begin Checkout.
+    #
+    # Related guide: [Checkout Quickstart](https://stripe.com/docs/checkout/quickstart).
     class Session < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/country_spec.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Stripe needs to collect certain pieces of information about each account
+  # created. These requirements can differ depending on the account's country. The
+  # Country Specs API makes these rules available to your integration.
+  #
+  # You can also view the information from this API call as [an online
+  # guide](https://stripe.com/docs/connect/required-verification-information).
   class CountrySpec < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/coupon.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A coupon contains information about a percent-off or amount-off discount you
+  # might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
+  # [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
   class Coupon < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/credit_note.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Issue a credit note to adjust an invoice's amount after the invoice is finalized.
+  #
+  # Related guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes).
   class CreditNote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/customer.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.
+  #
+  # Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).
   class Customer < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
@@ -14,6 +17,8 @@ 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 :tax_id,
                                   operations: %i[create retrieve delete list]
 

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value,
+  # which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
+  # You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),
+  # or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.
+  #
+  # Related guide: [Customer Balance](https://stripe.com/docs/billing/customer/balance) to learn more.
   class CustomerBalanceTransaction < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/customer_cash_balance_transaction.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Customers with certain payments enabled have a cash balance, representing funds that were paid
+  # by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions
+  # represent when funds are moved into or out of this balance. This includes funding by the customer, allocation
+  # to payments, and refunds to the customer.
+  class CustomerCashBalanceTransaction < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "customer_cash_balance_transaction"
+  end
+end

data/lib/stripe/resources/discount.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+  # It contains information about when the discount began, when it will end, and what it is applied to.
+  #
+  # Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
   class Discount < StripeObject
     OBJECT_NAME = "discount"
   end

data/lib/stripe/resources/dispute.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A dispute occurs when a customer questions your charge with their card issuer.
+  # When this happens, you're given the opportunity to respond to the dispute with
+  # evidence that shows that the charge is legitimate. You can find more
+  # information about the dispute process in our [Disputes and
+  # Fraud](https://stripe.com/docs/disputes) documentation.
+  #
+  # Related guide: [Disputes and Fraud](https://stripe.com/docs/disputes).
   class Dispute < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/event.rb

@@ -2,6 +2,35 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Events are our way of letting you know when something interesting happens in
+  # your account. When an interesting event occurs, we create a new `Event`
+  # object. For example, when a charge succeeds, we create a `charge.succeeded`
+  # event; and when an invoice payment attempt fails, we create an
+  # `invoice.payment_failed` event. Note that many API requests may cause multiple
+  # events to be created. For example, if you create a new subscription for a
+  # customer, you will receive both a `customer.subscription.created` event and a
+  # `charge.succeeded` event.
+  #
+  # Events occur when the state of another API resource changes. The state of that
+  # resource at the time of the change is embedded in the event's data field. For
+  # example, a `charge.succeeded` event will contain a charge, and an
+  # `invoice.payment_failed` event will contain an invoice.
+  #
+  # As with other API resources, you can use endpoints to retrieve an
+  # [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)
+  # from the API. We also have a separate
+  # [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the
+  # `Event` objects directly to an endpoint on your server. Webhooks are managed
+  # in your
+  # [account settings](https://dashboard.stripe.com/account/webhooks),
+  # and our [Using Webhooks](https://stripe.com/docs/webhooks) guide will help you get set up.
+  #
+  # When using [Connect](https://stripe.com/docs/connect), you can also receive notifications of
+  # events that occur in connected accounts. For these events, there will be an
+  # additional `account` attribute in the received `Event` object.
+  #
+  # **NOTE:** Right now, access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) is
+  # guaranteed only for 30 days.
   class Event < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/exchange_rate.rb

@@ -2,6 +2,17 @@
 # frozen_string_literal: true
 
 module Stripe
+  # `Exchange Rate` objects allow you to determine the rates that Stripe is
+  # currently using to convert from one currency to another. Since this number is
+  # variable throughout the day, there are various reasons why you might want to
+  # know the current rate (for example, to dynamically price an item for a user
+  # with a default payment in a foreign currency).
+  #
+  # If you want a guarantee that the charge is made with a certain exchange rate
+  # you expect is current, you can pass in `exchange_rate` to charges endpoints.
+  # If the value is no longer up to date, the charge won't go through. Please
+  # refer to our [Exchange Rates API](https://stripe.com/docs/exchange-rates) guide for more
+  # details.
   class ExchangeRate < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/file.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a file hosted on Stripe's servers. The
+  # file may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file)
+  # request (for example, when uploading dispute evidence) or it may have
+  # been created by Stripe (for example, the results of a [Sigma scheduled
+  # query](https://stripe.com/docs/api#scheduled_queries)).
+  #
+  # Related guide: [File Upload Guide](https://stripe.com/docs/file-upload).
   class File < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/file_link.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # To share the contents of a `File` object with non-Stripe users, you can
+  # create a `FileLink`. `FileLink`s contain a URL that can be used to
+  # retrieve the contents of the file without authentication.
   class FileLink < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

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

@@ -3,6 +3,7 @@
 
 module Stripe
   module FinancialConnections
+    # 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
 

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

@@ -3,6 +3,7 @@
 
 module Stripe
   module FinancialConnections
+    # Describes a snapshot of the owners of an account at a particular point in time.
     class AccountOwnership < StripeObject
       OBJECT_NAME = "financial_connections.account_ownership"
     end

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

@@ -3,6 +3,7 @@
 
 module Stripe
   module FinancialConnections
+    # A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
     class Session < APIResource
       extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/funding_instructions.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is
+  # automatically applied to future invoices and payments using the `customer_balance` payment method.
+  # Customers can fund this balance by initiating a bank transfer to any account in the
+  # `financial_addresses` field.
+  # Related guide: [Customer Balance - Funding Instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) to learn more
   class FundingInstructions < APIResource
     OBJECT_NAME = "funding_instructions"
 

data/lib/stripe/resources/identity/verification_report.rb

@@ -3,6 +3,17 @@
 
 module Stripe
   module Identity
+    # A VerificationReport is the result of an attempt to collect and verify data from a user.
+    # The collection of verification checks performed is determined from the `type` and `options`
+    # parameters used. You can find the result of each verification check performed in the
+    # appropriate sub-resource: `document`, `id_number`, `selfie`.
+    #
+    # Each VerificationReport contains a copy of any data collected by the user as well as
+    # reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)
+    # API. To configure and create VerificationReports, use the
+    # [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.
+    #
+    # Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).
     class VerificationReport < APIResource
       extend Stripe::APIOperations::List
 

data/lib/stripe/resources/identity/verification_session.rb

@@ -3,6 +3,17 @@
 
 module Stripe
   module Identity
+    # A VerificationSession guides you through the process of collecting and verifying the identities
+    # of your users. It contains details about the type of verification, such as what [verification
+    # check](https://stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
+    # each verification in your system.
+    #
+    # A VerificationSession transitions through [multiple
+    # statuses](https://stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through
+    # the verification flow. The VerificationSession contains the user's verified data after
+    # verification checks are complete.
+    #
+    # Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)
     class VerificationSession < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/invoice.rb

@@ -2,6 +2,38 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Invoices are statements of amounts owed by a customer, and are either
+  # generated one-off, or generated periodically from a subscription.
+  #
+  # They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments
+  # that may be caused by subscription upgrades/downgrades (if necessary).
+  #
+  # If your invoice is configured to be billed through automatic charges,
+  # Stripe automatically finalizes your invoice and attempts payment. Note
+  # that finalizing the invoice,
+  # [when automatic](https://stripe.com/docs/billing/invoices/workflow/#auto_advance), does
+  # not happen immediately as the invoice is created. Stripe waits
+  # until one hour after the last webhook was successfully sent (or the last
+  # webhook timed out after failing). If you (and the platforms you may have
+  # connected to) have no webhooks configured, Stripe waits one hour after
+  # creation to finalize the invoice.
+  #
+  # If your invoice is configured to be billed by sending an email, then based on your
+  # [email settings](https://dashboard.stripe.com/account/billing/automatic),
+  # Stripe will email the invoice to your customer and await payment. These
+  # emails can contain a link to a hosted page to pay the invoice.
+  #
+  # Stripe applies any customer credit on the account before determining the
+  # amount due for the invoice (i.e., the amount that will be actually
+  # charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
+  # per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
+  # invoice is automatically marked paid, and we add the amount due to the
+  # customer's credit balance which is applied to the next invoice.
+  #
+  # More details on the customer's credit balance are
+  # [here](https://stripe.com/docs/billing/customer/balance).
+  #
+  # Related guide: [Send Invoices to Customers](https://stripe.com/docs/billing/invoices/sending).
   class Invoice < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/invoice_item.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Sometimes you want to add a charge or credit to a customer, but actually
+  # charge or credit the customer's card only at the end of a regular billing
+  # cycle. This is useful for combining several charges (to minimize
+  # per-transaction fees), or for having Stripe tabulate your usage-based billing
+  # totals.
+  #
+  # Related guide: [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).
   class InvoiceItem < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete