Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update generated code for beta #1498

Merged
merged 2 commits into from
May 19, 2023
Merged

Update generated code for beta #1498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6357a73
Update generated code (#1499)
stripe-openapi[bot] May 16, 2023
3554694
Merge upstream and update generated code for v351
stripe-openapi[bot] May 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v338
v351
14 changes: 5 additions & 9 deletions lib/Account.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,10 @@
* properties on the account like its current requirements or if the account is
* enabled to make live charges or receive payouts.
*
* For Custom accounts, the properties below are always returned. For other
* accounts, some properties are returned until that account has started to go
* through Connect Onboarding. Once you create an <a
* href="https://stripe.com/docs/api/account_links">Account Link</a> for a Standard
* or Express account, some parameters are no longer returned. These are marked as
* <strong>Custom Only</strong> or <strong>Custom and Express</strong> below. Learn
* about the differences <a href="https://stripe.com/docs/connect/accounts">between
* accounts</a>.
* For Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that
* account has started to go through Connect Onboarding. Once you create an <a href="https://stripe.com/docs/api/account_links">Account Link</a>
* for a Standard or Express account, some parameters are no longer returned. These are marked as <strong>Custom Only</strong> or <strong>Custom and Express</strong>
* below. Learn about the differences <a href="https://stripe.com/docs/connect/accounts">between accounts</a>.
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand All @@ -33,7 +29,7 @@
* @property null|string $email An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.
* @property null|\Stripe\Collection<\Stripe\BankAccount|\Stripe\Card> $external_accounts External accounts (bank accounts and debit cards) currently attached to this account
* @property null|\Stripe\StripeObject $future_requirements
* @property null|\Stripe\Person $individual <p>This is an object representing a person associated with a Stripe account.</p><p>A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the <a href="https://stripe.com/docs/connect/standard-accounts">Standard onboarding</a> or <a href="https://stripe.com/docs/connect/express-accounts">Express onboarding documentation</a> for information about platform pre-filling and account onboarding steps.</p><p>Related guide: <a href="https://stripe.com/docs/connect/identity-verification-api#person-information">Handling Identity Verification with the API</a>.</p>
* @property null|\Stripe\Person $individual <p>This is an object representing a person associated with a Stripe account.</p><p>A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the <a href="https://stripe.com/docs/connect/standard-accounts">Standard onboarding</a> or <a href="https://stripe.com/docs/connect/express-accounts">Express onboarding documentation</a> for information about platform pre-filling and account onboarding steps.</p><p>Related guide: <a href="https://stripe.com/docs/connect/identity-verification-api#person-information">Handling identity verification with the API</a></p>
* @property null|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* @property null|bool $payouts_enabled Whether Stripe can send payouts to this account.
* @property null|\Stripe\StripeObject $requirements
Expand Down
9 changes: 3 additions & 6 deletions lib/AccountLink.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,10 @@
namespace 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.
* 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: <a
* href="https://stripe.com/docs/connect/connect-onboarding">Connect
* Onboarding</a>.
* Related guide: <a href="https://stripe.com/docs/connect/connect-onboarding">Connect Onboarding</a>
*
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
Expand Down
13 changes: 5 additions & 8 deletions lib/AccountSession.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,13 @@
namespace Stripe;

/**
* An AccountSession allows a Connect platform to grant access to a connected
* account in Connect embedded components.
* An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
*
* We recommend that you create an AccountSession each time you need to display an
* embedded component to your user. Do not save AccountSessions to your database as
* they expire relatively quickly, and cannot be used more than once.
* We recommend that you create an AccountSession each time you need to display an embedded component
* to your user. Do not save AccountSessions to your database as they expire relatively
* quickly, and cannot be used more than once.
*
* Related guide: <a
* href="https://stripe.com/docs/connect/get-started-connect-embedded-components">Connect
* embedded components</a>.
* Related guide: <a href="https://stripe.com/docs/connect/get-started-connect-embedded-components">Connect embedded components</a>
*
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property string $account The ID of the account the AccountSession was created for
Expand Down
10 changes: 4 additions & 6 deletions lib/ApplicationFeeRefund.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@
namespace Stripe;

/**
* <code>Application Fee Refund</code> 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.
* <code>Application Fee Refund</code> 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: <a
* href="https://stripe.com/docs/connect/destination-charges#refunding-app-fee">Refunding
* Application Fees</a>.
* Related guide: <a href="https://stripe.com/docs/connect/destination-charges#refunding-app-fee">Refunding application fees</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
20 changes: 5 additions & 15 deletions lib/Apps/Secret.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,15 @@
namespace Stripe\Apps;

/**
* Secret Store is an API that allows Stripe Apps developers to securely persist
* secrets for use by UI Extensions and app backends.
* 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 <code>secret</code>. Other apps can't
* view secrets created by an app. Additionally, secrets are scoped to provide
* further permission control.
* The primary resource in Secret Store is a <code>secret</code>. 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 <code>account</code> scoped
* secrets. Use the <code>account</code> scope for secrets that don't change
* per-user, like a third-party API key.
* All Dashboard users and the app backend share <code>account</code> scoped secrets. Use the <code>account</code> scope for secrets that don't change per-user, like a third-party API key.
*
* A <code>user</code> scoped secret is accessible by the app backend and one
* specific Dashboard user. Use the <code>user</code> scope for per-user secrets
* like per-user OAuth tokens, where different users might have different
* permissions.
* A <code>user</code> scoped secret is accessible by the app backend and one specific Dashboard user. Use the <code>user</code> scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
*
* Related guide: <a
* href="https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects">Store
* data between page reloads</a>.
* Related guide: <a href="https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects">Store data between page reloads</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
10 changes: 4 additions & 6 deletions lib/Balance.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,14 @@
* 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 <a
* href="https://stripe.com/docs/reporting/balance-transaction-types">transactions</a>
* that contributed to the balance (charges, payouts, and so forth).
* You can also retrieve the balance history, which contains a list of
* <a href="https://stripe.com/docs/reporting/balance-transaction-types">transactions</a> 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: <a
* href="https://stripe.com/docs/connect/account-balances">Understanding Connect
* Account Balances</a>.
* Related guide: <a href="https://stripe.com/docs/connect/account-balances">Understanding Connect account balances</a>
*
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the <a href="https://stripe.com/docs/api#transfers">Transfers API</a> or <a href="https://stripe.com/docs/api#payouts">Payouts API</a>. The available balance for each currency and payment type can be found in the <code>source_types</code> property.
Expand Down
9 changes: 3 additions & 6 deletions lib/BalanceTransaction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,10 @@
namespace 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.
* 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: <a
* href="https://stripe.com/docs/reports/balance-transaction-types">Balance
* Transaction Types</a>.
* Related guide: <a href="https://stripe.com/docs/reports/balance-transaction-types">Balance transaction types</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
13 changes: 4 additions & 9 deletions lib/BankAccount.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,11 @@
/**
* These bank accounts are payment methods on <code>Customer</code> objects.
*
* On the other hand <a
* href="https://stripe.com/docs/api#external_accounts">External Accounts</a> are
* transfer destinations on <code>Account</code> objects for <a
* href="https://stripe.com/docs/connect/custom-accounts">Custom accounts</a>. They
* can be bank accounts or debit cards as well, and are documented in the links
* above.
* On the other hand <a href="https://stripe.com/docs/api#external_accounts">External Accounts</a> are transfer
* destinations on <code>Account</code> objects for <a href="https://stripe.com/docs/connect/custom-accounts">Custom accounts</a>.
* They can be bank accounts or debit cards as well, and are documented in the links above.
*
* Related guide: <a
* href="https://stripe.com/docs/payments/bank-debits-transfers">Bank Debits and
* Transfers</a>.
* Related guide: <a href="https://stripe.com/docs/payments/bank-debits-transfers">Bank debits and transfers</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
3 changes: 1 addition & 2 deletions lib/BillingPortal/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
namespace Stripe\BillingPortal;

/**
* A portal configuration describes the functionality and behavior of a portal
* session.
* A portal configuration describes the functionality and behavior of a portal session.
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
24 changes: 11 additions & 13 deletions lib/BillingPortal/Session.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,20 @@
namespace Stripe\BillingPortal;

/**
* The Billing customer portal is a Stripe-hosted UI for subscription and billing
* management.
* 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 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.
* 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 <a
* href="https://stripe.com/docs/billing/subscriptions/integrating-customer-portal">integration
* guide</a>.
* Learn more in the <a href="https://stripe.com/docs/billing/subscriptions/integrating-customer-portal">integration guide</a>.
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
4 changes: 1 addition & 3 deletions lib/Capability.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
/**
* This is an object representing a capability for a Stripe account.
*
* Related guide: <a
* href="https://stripe.com/docs/connect/account-capabilities">Account
* capabilities</a>.
* Related guide: <a href="https://stripe.com/docs/connect/account-capabilities">Account capabilities</a>
*
* @property string $id The identifier for the capability.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
4 changes: 2 additions & 2 deletions lib/Capital/FinancingOffer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
namespace Stripe\Capital;

/**
* This is an object representing an offer of financing from Stripe Capital to a
* Connect subaccount.
* This is an object representing an offer of financing from
* Stripe Capital to a Connect subaccount.
*
* @property string $id A unique identifier for the financing object.
* @property string $object The object type: financing_offer.
Expand Down
5 changes: 2 additions & 3 deletions lib/Capital/FinancingSummary.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
namespace Stripe\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.
* 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.
*
* @property string $object The object type: financing_summary
* @property null|\Stripe\StripeObject $details Additional information about the financing summary. Describes currency, advance amount, fee amount, withhold rate, remaining amount, paid amount, current repayment interval, repayment start date, and advance payout date.
Expand Down
3 changes: 1 addition & 2 deletions lib/Capital/FinancingTransaction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
namespace Stripe\Capital;

/**
* This is an object representing the details of a transaction on a Capital
* financing object.
* This is an object representing the details of a transaction on a Capital financing object.
*
* @property string $id A unique identifier for the financing transaction object.
* @property string $object The object type: financing_transaction
Expand Down
3 changes: 1 addition & 2 deletions lib/Card.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
* later. You can also store multiple debit cards on a recipient in order to
* transfer to those cards later.
*
* Related guide: <a href="https://stripe.com/docs/sources/cards">Card Payments
* with Sources</a>.
* Related guide: <a href="https://stripe.com/docs/sources/cards">Card payments with Sources</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
4 changes: 1 addition & 3 deletions lib/CashBalance.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
namespace Stripe;

/**
* A customer's <code>Cash balance</code> 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.
* A customer's <code>Cash balance</code> 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.
*
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property null|\Stripe\StripeObject $available A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.
Expand Down
8 changes: 3 additions & 5 deletions lib/Charge.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@
namespace Stripe;

/**
* To charge a credit or a debit card, you create a <code>Charge</code> object. You
* can retrieve and refund individual charges as well as list all charges. Charges
* To charge a credit or a debit card, you create a <code>Charge</code> object. You can
* retrieve and refund individual charges as well as list all charges. Charges
* are identified by a unique, random ID.
*
* Related guide: <a
* href="https://stripe.com/docs/payments/accept-a-payment-charges">Accept a
* payment with the Charges API</a>.
* Related guide: <a href="https://stripe.com/docs/payments/accept-a-payment-charges">Accept a payment with the Charges API</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
Expand Down
Loading
Loading