diff --git a/src/main/java/com/stripe/model/Account.java b/src/main/java/com/stripe/model/Account.java index a3459819332..8421e3caafa 100644 --- a/src/main/java/com/stripe/model/Account.java +++ b/src/main/java/com/stripe/model/Account.java @@ -29,7 +29,8 @@ public class Account extends ApiResource implements MetadataStore, Paym /** * The business type. * - *

One of `company`, `government_entity`, `individual`, or `non_profit`. + *

One of {@code company}, {@code government_entity}, {@code individual}, or {@code + * non_profit}. */ @SerializedName("business_type") String businessType; @@ -54,7 +55,8 @@ public class Account extends ApiResource implements MetadataStore, Paym /** * Three-letter ISO currency code representing the default currency for the account. This must be - * a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). + * a currency that Stripe supports in the account's + * country. */ @SerializedName("default_currency") String defaultCurrency; @@ -97,7 +99,7 @@ public class Account extends ApiResource implements MetadataStore, Paym /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `account`. + *

Equal to {@code account}. */ @SerializedName("object") String object; @@ -116,7 +118,7 @@ public class Account extends ApiResource implements MetadataStore, Paym @SerializedName("tos_acceptance") TosAcceptance tosAcceptance; - /** The Stripe account type. Can be `standard`, `express`, or `custom`. */ + /** The Stripe account type. Can be {@code standard}, {@code express}, or {@code custom}. */ @SerializedName("type") String type; @@ -177,16 +179,16 @@ public static Account retrieve( } /** - * Updates a connected Express or Custom account by setting - * the values of the parameters passed. Any parameters not provided are left unchanged. Most - * parameters can be changed only for Custom accounts. (These are marked Custom - * Only below.) Parameters marked Custom and Express are supported by - * both account types. + * Updates a connected Express or Custom + * account by setting the values of the parameters passed. Any parameters not provided are + * left unchanged. Most parameters can be changed only for Custom accounts. (These are marked + * Custom Only below.) Parameters marked Custom and Express are + * supported by both account types. * *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating - * accounts. + * href="https://stripe.com/docs/connect/updating-accounts">Connect documentation to learn + * more about updating accounts. */ @Override public Account update(Map params) throws StripeException { @@ -194,16 +196,16 @@ public Account update(Map params) throws StripeException { } /** - * Updates a connected Express or Custom account by setting - * the values of the parameters passed. Any parameters not provided are left unchanged. Most - * parameters can be changed only for Custom accounts. (These are marked Custom - * Only below.) Parameters marked Custom and Express are supported by - * both account types. + * Updates a connected Express or Custom + * account by setting the values of the parameters passed. Any parameters not provided are + * left unchanged. Most parameters can be changed only for Custom accounts. (These are marked + * Custom Only below.) Parameters marked Custom and Express are + * supported by both account types. * *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating - * accounts. + * href="https://stripe.com/docs/connect/updating-accounts">Connect documentation to learn + * more about updating accounts. */ @Override public Account update(Map params, RequestOptions options) throws StripeException { @@ -216,32 +218,32 @@ public Account update(Map params, RequestOptions options) throws } /** - * Updates a connected Express or Custom account by setting - * the values of the parameters passed. Any parameters not provided are left unchanged. Most - * parameters can be changed only for Custom accounts. (These are marked Custom - * Only below.) Parameters marked Custom and Express are supported by - * both account types. + * Updates a connected Express or Custom + * account by setting the values of the parameters passed. Any parameters not provided are + * left unchanged. Most parameters can be changed only for Custom accounts. (These are marked + * Custom Only below.) Parameters marked Custom and Express are + * supported by both account types. * *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating - * accounts. + * href="https://stripe.com/docs/connect/updating-accounts">Connect documentation to learn + * more about updating accounts. */ public Account update(AccountUpdateParams params) throws StripeException { return update(params, (RequestOptions) null); } /** - * Updates a connected Express or Custom account by setting - * the values of the parameters passed. Any parameters not provided are left unchanged. Most - * parameters can be changed only for Custom accounts. (These are marked Custom - * Only below.) Parameters marked Custom and Express are supported by - * both account types. + * Updates a connected Express or Custom + * account by setting the values of the parameters passed. Any parameters not provided are + * left unchanged. Most parameters can be changed only for Custom accounts. (These are marked + * Custom Only below.) Parameters marked Custom and Express are + * supported by both account types. * *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating - * accounts. + * href="https://stripe.com/docs/connect/updating-accounts">Connect documentation to learn + * more about updating accounts. */ public Account update(AccountUpdateParams params, RequestOptions options) throws StripeException { String url = @@ -253,16 +255,18 @@ public Account update(AccountUpdateParams params, RequestOptions options) throws } /** - * Returns a list of accounts connected to your platform via Connect. - * If you’re not a platform, the list is empty. + * Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is + * empty. */ public static AccountCollection list(Map params) throws StripeException { return list(params, (RequestOptions) null); } /** - * Returns a list of accounts connected to your platform via Connect. - * If you’re not a platform, the list is empty. + * Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is + * empty. */ public static AccountCollection list(Map params, RequestOptions options) throws StripeException { @@ -271,16 +275,18 @@ public static AccountCollection list(Map params, RequestOptions } /** - * Returns a list of accounts connected to your platform via Connect. - * If you’re not a platform, the list is empty. + * Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is + * empty. */ public static AccountCollection list(AccountListParams params) throws StripeException { return list(params, (RequestOptions) null); } /** - * Returns a list of accounts connected to your platform via Connect. - * If you’re not a platform, the list is empty. + * Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is + * empty. */ public static AccountCollection list(AccountListParams params, RequestOptions options) throws StripeException { @@ -289,8 +295,8 @@ public static AccountCollection list(AccountListParams params, RequestOptions op } /** - * With Connect, you can create Stripe accounts for your users. To do - * this, you’ll first need to Connect, you can create Stripe accounts for + * your users. To do this, you’ll first need to register your platform. * *

For Standard accounts, parameters other than country, email, and @@ -302,8 +308,8 @@ public static Account create(Map params) throws StripeException } /** - * With Connect, you can create Stripe accounts for your users. To do - * this, you’ll first need to Connect, you can create Stripe accounts for + * your users. To do this, you’ll first need to register your platform. * *

For Standard accounts, parameters other than country, email, and @@ -317,8 +323,8 @@ public static Account create(Map params, RequestOptions options) } /** - * With Connect, you can create Stripe accounts for your users. To do - * this, you’ll first need to Connect, you can create Stripe accounts for + * your users. To do this, you’ll first need to register your platform. * *

For Standard accounts, parameters other than country, email, and @@ -330,8 +336,8 @@ public static Account create(AccountCreateParams params) throws StripeException } /** - * With Connect, you can create Stripe accounts for your users. To do - * this, you’ll first need to Connect, you can create Stripe accounts for + * your users. To do this, you’ll first need to register your platform. * *

For Standard accounts, parameters other than country, email, and @@ -345,7 +351,8 @@ public static Account create(AccountCreateParams params, RequestOptions options) } /** - * With Connect, you can delete Custom or Express accounts you manage. + * With Connect, you can delete Custom or Express + * accounts you manage. * *

Accounts created using test-mode keys can be deleted at any time. Accounts created using * live-mode keys can only be deleted once all balances are zero. @@ -359,7 +366,8 @@ public Account delete() throws StripeException { } /** - * With Connect, you can delete Custom or Express accounts you manage. + * With Connect, you can delete Custom or Express + * accounts you manage. * *

Accounts created using test-mode keys can be deleted at any time. Accounts created using * live-mode keys can only be deleted once all balances are zero. @@ -373,7 +381,8 @@ public Account delete(RequestOptions options) throws StripeException { } /** - * With Connect, you can delete Custom or Express accounts you manage. + * With Connect, you can delete Custom or Express + * accounts you manage. * *

Accounts created using test-mode keys can be deleted at any time. Accounts created using * live-mode keys can only be deleted once all balances are zero. @@ -387,7 +396,8 @@ public Account delete(Map params) throws StripeException { } /** - * With Connect, you can delete Custom or Express accounts you manage. + * With Connect, you can delete Custom or Express + * accounts you manage. * *

Accounts created using test-mode keys can be deleted at any time. Accounts created using * live-mode keys can only be deleted once all balances are zero. @@ -407,7 +417,8 @@ public Account delete(Map params, RequestOptions options) throws } /** - * With Connect, you may flag accounts as suspicious. + * With Connect, you may flag accounts as + * suspicious. * *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using * live-mode keys may only be rejected once all balances are zero. @@ -417,7 +428,8 @@ public Account reject(Map params) throws StripeException { } /** - * With Connect, you may flag accounts as suspicious. + * With Connect, you may flag accounts as + * suspicious. * *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using * live-mode keys may only be rejected once all balances are zero. @@ -432,7 +444,8 @@ public Account reject(Map params, RequestOptions options) throws } /** - * With Connect, you may flag accounts as suspicious. + * With Connect, you may flag accounts as + * suspicious. * *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using * live-mode keys may only be rejected once all balances are zero. @@ -442,7 +455,8 @@ public Account reject(AccountRejectParams params) throws StripeException { } /** - * With Connect, you may flag accounts as suspicious. + * With Connect, you may flag accounts as + * suspicious. * *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using * live-mode keys may only be rejected once all balances are zero. @@ -566,8 +580,9 @@ public CapabilityCollection capabilities(AccountCapabilitiesParams params, Reque @EqualsAndHashCode(callSuper = false) public static class BusinessProfile extends StripeObject { /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). - * MCCs are used to classify businesses based on the goods or services they provide. + * The merchant category code for the + * account. MCCs are used to classify businesses based on the goods or services they + * provide. */ @SerializedName("mcc") String mcc; @@ -612,7 +627,7 @@ public static class Capabilities extends StripeObject { * The status of the card issuing capability of the account, or whether you can use Issuing to * distribute funds on cards * - *

One of `active`, `inactive`, or `pending`. + *

One of {@code active}, {@code inactive}, or {@code pending}. */ @SerializedName("card_issuing") String cardIssuing; @@ -621,7 +636,7 @@ public static class Capabilities extends StripeObject { * The status of the card payments capability of the account, or whether the account can * directly process credit and debit card charges. * - *

One of `active`, `inactive`, or `pending`. + *

One of {@code active}, {@code inactive}, or {@code pending}. */ @SerializedName("card_payments") String cardPayments; @@ -629,7 +644,7 @@ public static class Capabilities extends StripeObject { /** * The status of the legacy payments capability of the account. * - *

One of `active`, `inactive`, or `pending`. + *

One of {@code active}, {@code inactive}, or {@code pending}. */ @SerializedName("legacy_payments") String legacyPayments; @@ -638,7 +653,7 @@ public static class Capabilities extends StripeObject { * The status of the transfers capability of the account, or whether your platform can transfer * funds to the account. * - *

One of `active`, `inactive`, or `pending`. + *

One of {@code active}, {@code inactive}, or {@code pending}. */ @SerializedName("transfers") String transfers; @@ -660,18 +675,20 @@ public static class Company extends StripeObject { Person.JapanAddress addressKanji; /** - * Whether the company's directors have been provided. This Boolean will be `true` if you've - * manually indicated that all directors are provided via [the `directors_provided` - * parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). + * Whether the company's directors have been provided. This Boolean will be {@code true} if + * you've manually indicated that all directors are provided via the + * {@code directors_provided} parameter. */ @SerializedName("directors_provided") Boolean directorsProvided; /** - * Whether the company's executives have been provided. This Boolean will be `true` if you've - * manually indicated that all executives are provided via [the `executives_provided` - * parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), - * or if Stripe determined that sufficient executives were provided. + * Whether the company's executives have been provided. This Boolean will be {@code true} if + * you've manually indicated that all executives are provided via the + * {@code executives_provided} parameter, or if Stripe determined that sufficient executives + * were provided. */ @SerializedName("executives_provided") Boolean executivesProvided; @@ -689,12 +706,13 @@ public static class Company extends StripeObject { String nameKanji; /** - * Whether the company's owners have been provided. This Boolean will be `true` if you've - * manually indicated that all owners are provided via [the `owners_provided` - * parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), - * or if Stripe determined that sufficient owners were provided. Stripe determines ownership - * requirements using both the number of owners provided and their total percent ownership - * (calculated by adding the `percent_ownership` of each owner together). + * Whether the company's owners have been provided. This Boolean will be {@code true} if you've + * manually indicated that all owners are provided via the + * {@code owners_provided} parameter, or if Stripe determined that sufficient owners were + * provided. Stripe determines ownership requirements using both the number of owners provided + * and their total percent ownership (calculated by adding the {@code percent_ownership} of each + * owner together). */ @SerializedName("owners_provided") Boolean ownersProvided; @@ -706,10 +724,11 @@ public static class Company extends StripeObject { /** * The category identifying the legal structure of the company or legal entity. * - *

One of `government_instrumentality`, `governmental_unit`, `incorporated_non_profit`, - * `multi_member_llc`, `private_corporation`, `private_partnership`, `public_corporation`, - * `public_partnership`, `tax_exempt_government_instrumentality`, `unincorporated_association`, - * or `unincorporated_non_profit`. + *

One of {@code government_instrumentality}, {@code governmental_unit}, {@code + * incorporated_non_profit}, {@code multi_member_llc}, {@code private_corporation}, {@code + * private_partnership}, {@code public_corporation}, {@code public_partnership}, {@code + * tax_exempt_government_instrumentality}, {@code unincorporated_association}, or {@code + * unincorporated_non_profit}. */ @SerializedName("structure") String structure; @@ -718,7 +737,9 @@ public static class Company extends StripeObject { @SerializedName("tax_id_provided") Boolean taxIdProvided; - /** The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ + /** + * The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only). + */ @SerializedName("tax_id_registrar") String taxIdRegistrar; @@ -742,8 +763,9 @@ public static class Verification extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class VerificationDocument extends StripeObject { /** - * The back of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. + * The back of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. */ @SerializedName("back") @Getter(lombok.AccessLevel.NONE) @@ -755,26 +777,28 @@ public static class VerificationDocument extends StripeObject { String details; /** - * One of `document_corrupt`, `document_expired`, `document_failed_copy`, - * `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, - * `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, - * `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or - * `document_too_large`. A machine-readable code specifying the verification state for this + * One of {@code document_corrupt}, {@code document_expired}, {@code document_failed_copy}, + * {@code document_failed_greyscale}, {@code document_failed_other}, {@code + * document_failed_test_mode}, {@code document_fraudulent}, {@code document_incomplete}, + * {@code document_invalid}, {@code document_manipulated}, {@code document_not_readable}, + * {@code document_not_uploaded}, {@code document_type_not_supported}, or {@code + * document_too_large}. A machine-readable code specifying the verification state for this * document. */ @SerializedName("details_code") String detailsCode; /** - * The front of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. + * The front of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. */ @SerializedName("front") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) ExpandableField front; - /** Get id of expandable `back` object. */ + /** Get ID of expandable {@code back} object. */ public String getBack() { return (this.back != null) ? this.back.getId() : null; } @@ -783,7 +807,7 @@ public void setBack(String id) { this.back = ApiResource.setExpandableFieldId(id, this.back); } - /** Get expanded `back`. */ + /** Get expanded {@code back}. */ public File getBackObject() { return (this.back != null) ? this.back.getExpanded() : null; } @@ -792,7 +816,7 @@ public void setBackObject(File expandableObject) { this.back = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `front` object. */ + /** Get ID of expandable {@code front} object. */ public String getFront() { return (this.front != null) ? this.front.getId() : null; } @@ -801,7 +825,7 @@ public void setFront(String id) { this.front = ApiResource.setExpandableFieldId(id, this.front); } - /** Get expanded `front`. */ + /** Get expanded {@code front}. */ public File getFrontObject() { return (this.front != null) ? this.front.getExpanded() : null; } @@ -841,22 +865,23 @@ public static class PayoutSchedule extends StripeObject { Long delayDays; /** - * How frequently funds will be paid out. One of `manual` (payouts only created via API call), - * `daily`, `weekly`, or `monthly`. + * How frequently funds will be paid out. One of {@code manual} (payouts only created via API + * call), {@code daily}, {@code weekly}, or {@code monthly}. */ @SerializedName("interval") String interval; /** - * The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts - * scheduled between the 29th and 31st of the month are sent on the last day of shorter months. + * The day of the month funds will be paid out. Only shown if {@code interval} is monthly. + * Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter + * months. */ @SerializedName("monthly_anchor") Long monthlyAnchor; /** * The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown - * if `interval` is weekly. + * if {@code interval} is weekly. */ @SerializedName("weekly_anchor") String weeklyAnchor; @@ -867,8 +892,8 @@ public static class PayoutSchedule extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Requirements extends StripeObject { /** - * The date the fields in `currently_due` must be collected by to keep payouts enabled for the - * account. These fields might block payouts sooner if the next threshold is reached before + * The date the fields in {@code currently_due} must be collected by to keep payouts enabled for + * the account. These fields might block payouts sooner if the next threshold is reached before * these fields are collected. */ @SerializedName("current_deadline") @@ -876,30 +901,32 @@ public static class Requirements extends StripeObject { /** * The fields that need to be collected to keep the account enabled. If not collected by the - * `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. + * {@code current_deadline}, these fields appear in {@code past_due} as well, and the account is + * disabled. */ @SerializedName("currently_due") List currentlyDue; /** * If the account is disabled, this string describes why the account can’t create charges or - * receive payouts. Can be `requirements.past_due`, `requirements.pending_verification`, - * `rejected.fraud`, `rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `listed`, - * `under_review`, or `other`. + * receive payouts. Can be {@code requirements.past_due}, {@code + * requirements.pending_verification}, {@code rejected.fraud}, {@code + * rejected.terms_of_service}, {@code rejected.listed}, {@code rejected.other}, {@code listed}, + * {@code under_review}, or {@code other}. */ @SerializedName("disabled_reason") String disabledReason; /** * The fields that need to be collected assuming all volume thresholds are reached. As they - * become required, these fields appear in `currently_due` as well, and the `current_deadline` - * is set. + * become required, these fields appear in {@code currently_due} as well, and the {@code + * current_deadline} is set. */ @SerializedName("eventually_due") List eventuallyDue; /** - * The fields that weren't collected by the `current_deadline`. These fields need to be + * The fields that weren't collected by the {@code current_deadline}. These fields need to be * collected to re-enable the account. */ @SerializedName("past_due") @@ -908,7 +935,7 @@ public static class Requirements extends StripeObject { /** * Fields that may become required depending on the results of verification or review. An empty * array unless an asynchronous verification is pending. If verification fails, the fields in - * this array become required and move to `currently_due` or `past_due`. + * this array become required and move to {@code currently_due} or {@code past_due}. */ @SerializedName("pending_verification") List pendingVerification; @@ -939,8 +966,8 @@ public static class Settings extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class SettingsBranding extends StripeObject { /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. - * Must be square and at least 128px x 128px. + * (ID of a file upload) An icon for + * the account. Must be square and at least 128px x 128px. */ @SerializedName("icon") @Getter(lombok.AccessLevel.NONE) @@ -948,9 +975,9 @@ public static class SettingsBranding extends StripeObject { ExpandableField icon; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account - * that will be used in Checkout instead of the icon and without the account's name next to it - * if provided. Must be at least 128px x 128px. + * (ID of a file upload) A logo for the + * account that will be used in Checkout instead of the icon and without the account's name next + * to it if provided. Must be at least 128px x 128px. */ @SerializedName("logo") @Getter(lombok.AccessLevel.NONE) @@ -961,7 +988,7 @@ public static class SettingsBranding extends StripeObject { @SerializedName("primary_color") String primaryColor; - /** Get id of expandable `icon` object. */ + /** Get ID of expandable {@code icon} object. */ public String getIcon() { return (this.icon != null) ? this.icon.getId() : null; } @@ -970,7 +997,7 @@ public void setIcon(String id) { this.icon = ApiResource.setExpandableFieldId(id, this.icon); } - /** Get expanded `icon`. */ + /** Get expanded {@code icon}. */ public File getIconObject() { return (this.icon != null) ? this.icon.getExpanded() : null; } @@ -979,7 +1006,7 @@ public void setIconObject(File expandableObject) { this.icon = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `logo` object. */ + /** Get ID of expandable {@code logo} object. */ public String getLogo() { return (this.logo != null) ? this.logo.getId() : null; } @@ -988,7 +1015,7 @@ public void setLogo(String id) { this.logo = ApiResource.setExpandableFieldId(id, this.logo); } - /** Get expanded `logo`. */ + /** Get expanded {@code logo}. */ public File getLogoObject() { return (this.logo != null) ? this.logo.getExpanded() : null; } @@ -1007,8 +1034,8 @@ public static class SettingsCardPayments extends StripeObject { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. - * `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic + * prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code + * statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic * portion. */ @SerializedName("statement_descriptor_prefix") @@ -1028,7 +1055,8 @@ public static class SettingsDashboard extends StripeObject { /** * The timezone used in the Stripe Dashboard for this account. A list of possible time zone - * values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). + * values is maintained at the IANA Time Zone + * Database. */ @SerializedName("timezone") String timezone; @@ -1040,7 +1068,7 @@ public static class SettingsDashboard extends StripeObject { public static class SettingsPayments extends StripeObject { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. + * prefixes any dynamic {@code statement_descriptor} specified on the charge. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -1066,9 +1094,9 @@ public static class SettingsPayments extends StripeObject { public static class SettingsPayouts extends StripeObject { /** * A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank - * account. See our [Understanding Connect Account - * Balances](https://stripe.com/docs/connect/account-balances) documentation for details. - * Default value is `true` for Express accounts and `false` for Custom accounts. + * account. See our Understanding + * Connect Account Balances documentation for details. Default value is {@code true} for + * Express accounts and {@code false} for Custom accounts. */ @SerializedName("debit_negative_balances") Boolean debitNegativeBalances; diff --git a/src/main/java/com/stripe/model/AccountLink.java b/src/main/java/com/stripe/model/AccountLink.java index 4552088235a..e905ca89d8e 100644 --- a/src/main/java/com/stripe/model/AccountLink.java +++ b/src/main/java/com/stripe/model/AccountLink.java @@ -26,7 +26,7 @@ public class AccountLink extends ApiResource { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `account_link`. + *

Equal to {@code account_link}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/Address.java b/src/main/java/com/stripe/model/Address.java index 7cf8968446c..bf718ccc7a6 100644 --- a/src/main/java/com/stripe/model/Address.java +++ b/src/main/java/com/stripe/model/Address.java @@ -14,8 +14,8 @@ public class Address extends StripeObject { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO 3166-1 + * alpha-2). */ @SerializedName("country") String country; diff --git a/src/main/java/com/stripe/model/AlipayAccount.java b/src/main/java/com/stripe/model/AlipayAccount.java index a5481dab1d2..651d406ba5f 100644 --- a/src/main/java/com/stripe/model/AlipayAccount.java +++ b/src/main/java/com/stripe/model/AlipayAccount.java @@ -38,8 +38,8 @@ public class AlipayAccount extends StripeObject implements PaymentSource { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -54,7 +54,7 @@ public class AlipayAccount extends StripeObject implements PaymentSource { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `alipay_account`. + *

Equal to {@code alipay_account}. */ @SerializedName("object") String object; @@ -88,7 +88,7 @@ public class AlipayAccount extends StripeObject implements PaymentSource { @SerializedName("username") String username; - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -97,7 +97,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/ApplePayDomain.java b/src/main/java/com/stripe/model/ApplePayDomain.java index 6e178ffc243..f549075b589 100644 --- a/src/main/java/com/stripe/model/ApplePayDomain.java +++ b/src/main/java/com/stripe/model/ApplePayDomain.java @@ -34,8 +34,8 @@ public class ApplePayDomain extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -43,7 +43,7 @@ public class ApplePayDomain extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `apple_pay_domain`. + *

Equal to {@code apple_pay_domain}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/Application.java b/src/main/java/com/stripe/model/Application.java index 0420faa1b27..10c938a908b 100644 --- a/src/main/java/com/stripe/model/Application.java +++ b/src/main/java/com/stripe/model/Application.java @@ -21,7 +21,7 @@ public class Application extends StripeObject implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `application`. + *

Equal to {@code application}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/ApplicationFee.java b/src/main/java/com/stripe/model/ApplicationFee.java index aa8a7114c47..107476549fa 100644 --- a/src/main/java/com/stripe/model/ApplicationFee.java +++ b/src/main/java/com/stripe/model/ApplicationFee.java @@ -59,8 +59,8 @@ public class ApplicationFee extends ApiResource implements BalanceTransactionSou Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -71,8 +71,8 @@ public class ApplicationFee extends ApiResource implements BalanceTransactionSou String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -80,14 +80,14 @@ public class ApplicationFee extends ApiResource implements BalanceTransactionSou /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `application_fee`. + *

Equal to {@code application_fee}. */ @SerializedName("object") String object; /** * ID of the corresponding charge on the platform account, if this fee was the result of a charge - * using the `destination` parameter. + * using the {@code destination} parameter. */ @SerializedName("originating_transaction") @Getter(lombok.AccessLevel.NONE) @@ -105,7 +105,7 @@ public class ApplicationFee extends ApiResource implements BalanceTransactionSou @SerializedName("refunds") FeeRefundCollection refunds; - /** Get id of expandable `account` object. */ + /** Get ID of expandable {@code account} object. */ public String getAccount() { return (this.account != null) ? this.account.getId() : null; } @@ -114,7 +114,7 @@ public void setAccount(String id) { this.account = ApiResource.setExpandableFieldId(id, this.account); } - /** Get expanded `account`. */ + /** Get expanded {@code account}. */ public Account getAccountObject() { return (this.account != null) ? this.account.getExpanded() : null; } @@ -123,7 +123,7 @@ public void setAccountObject(Account expandableObject) { this.account = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `application` object. */ + /** Get ID of expandable {@code application} object. */ public String getApplication() { return (this.application != null) ? this.application.getId() : null; } @@ -132,7 +132,7 @@ public void setApplication(String id) { this.application = ApiResource.setExpandableFieldId(id, this.application); } - /** Get expanded `application`. */ + /** Get expanded {@code application}. */ public Application getApplicationObject() { return (this.application != null) ? this.application.getExpanded() : null; } @@ -141,7 +141,7 @@ public void setApplicationObject(Application expandableObject) { this.application = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -150,7 +150,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -160,7 +160,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `charge` object. */ + /** Get ID of expandable {@code charge} object. */ public String getCharge() { return (this.charge != null) ? this.charge.getId() : null; } @@ -169,7 +169,7 @@ public void setCharge(String id) { this.charge = ApiResource.setExpandableFieldId(id, this.charge); } - /** Get expanded `charge`. */ + /** Get expanded {@code charge}. */ public Charge getChargeObject() { return (this.charge != null) ? this.charge.getExpanded() : null; } @@ -178,7 +178,7 @@ public void setChargeObject(Charge expandableObject) { this.charge = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `originatingTransaction` object. */ + /** Get ID of expandable {@code originatingTransaction} object. */ public String getOriginatingTransaction() { return (this.originatingTransaction != null) ? this.originatingTransaction.getId() : null; } @@ -187,7 +187,7 @@ public void setOriginatingTransaction(String id) { this.originatingTransaction = ApiResource.setExpandableFieldId(id, this.originatingTransaction); } - /** Get expanded `originatingTransaction`. */ + /** Get expanded {@code originatingTransaction}. */ public Charge getOriginatingTransactionObject() { return (this.originatingTransaction != null) ? this.originatingTransaction.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/Balance.java b/src/main/java/com/stripe/model/Balance.java index 9dee2f590d8..8d12a866d5f 100644 --- a/src/main/java/com/stripe/model/Balance.java +++ b/src/main/java/com/stripe/model/Balance.java @@ -18,22 +18,23 @@ public class Balance extends ApiResource { /** * Funds that are available to be transferred or paid out, whether automatically by Stripe or - * explicitly via the [Transfers API](#transfers) or [Payouts API](#payouts). The available - * balance for each currency and payment type can be found in the `source_types` property. + * explicitly via the Transfers API or Payouts API. The available balance for each + * currency and payment type can be found in the {@code source_types} property. */ @SerializedName("available") List available; /** * Funds held due to negative balances on connected Custom accounts. The connect reserve balance - * for each currency and payment type can be found in the `source_types` property. + * for each currency and payment type can be found in the {@code source_types} property. */ @SerializedName("connect_reserved") List connectReserved; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -41,15 +42,15 @@ public class Balance extends ApiResource { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `balance`. + *

Equal to {@code balance}. */ @SerializedName("object") String object; /** * Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The - * pending balance for each currency, and for each payment type, can be found in the - * `source_types` property. + * pending balance for each currency, and for each payment type, can be found in the {@code + * source_types} property. */ @SerializedName("pending") List pending; @@ -57,8 +58,8 @@ public class Balance extends ApiResource { /** * Retrieves the current account balance, based on the authentication that was used to make the * request. For a sample request, see Accounting for negative - * balances. + * href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting + * for negative balances. */ public static Balance retrieve() throws StripeException { return retrieve((Map) null, (RequestOptions) null); @@ -67,8 +68,8 @@ public static Balance retrieve() throws StripeException { /** * Retrieves the current account balance, based on the authentication that was used to make the * request. For a sample request, see Accounting for negative - * balances. + * href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting + * for negative balances. */ public static Balance retrieve(RequestOptions options) throws StripeException { return retrieve((Map) null, options); @@ -77,8 +78,8 @@ public static Balance retrieve(RequestOptions options) throws StripeException { /** * Retrieves the current account balance, based on the authentication that was used to make the * request. For a sample request, see Accounting for negative - * balances. + * href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting + * for negative balances. */ public static Balance retrieve(Map params, RequestOptions options) throws StripeException { @@ -89,8 +90,8 @@ public static Balance retrieve(Map params, RequestOptions option /** * Retrieves the current account balance, based on the authentication that was used to make the * request. For a sample request, see Accounting for negative - * balances. + * href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting + * for negative balances. */ public static Balance retrieve(BalanceRetrieveParams params, RequestOptions options) throws StripeException { @@ -107,8 +108,9 @@ public static class Money extends StripeObject { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ @SerializedName("currency") String currency; diff --git a/src/main/java/com/stripe/model/BalanceTransaction.java b/src/main/java/com/stripe/model/BalanceTransaction.java index 0dfb944bdc1..200dfc74aae 100644 --- a/src/main/java/com/stripe/model/BalanceTransaction.java +++ b/src/main/java/com/stripe/model/BalanceTransaction.java @@ -31,8 +31,8 @@ public class BalanceTransaction extends ApiResource implements HasId { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -43,12 +43,12 @@ public class BalanceTransaction extends ApiResource implements HasId { /** * The exchange rate used, if applicable, for this transaction. Specifically, if money was - * converted from currency A to currency B, then the `amount` in currency A, times - * `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a - * customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be - * `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the - * BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` - * would be `1.234`. + * converted from currency A to currency B, then the {@code amount} in currency A, times {@code + * exchange_rate}, would be the {@code amount} in currency B. For example, suppose you charged a + * customer 10.00 EUR. Then the PaymentIntent's {@code amount} would be {@code 1000} and {@code + * currency} would be {@code eur}. Suppose this was converted into 12.34 USD in your Stripe + * account. Then the BalanceTransaction's {@code amount} would be {@code 1234}, {@code currency} + * would be {@code usd}, and {@code exchange_rate} would be {@code 1.234}. */ @SerializedName("exchange_rate") BigDecimal exchangeRate; @@ -73,14 +73,15 @@ public class BalanceTransaction extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `balance_transaction`. + *

Equal to {@code balance_transaction}. */ @SerializedName("object") String object; /** - * [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting - * categories can help you understand balance transactions from an accounting perspective. + * Learn more about how + * reporting categories can help you understand balance transactions from an accounting + * perspective. */ @SerializedName("reporting_category") String reportingCategory; @@ -92,36 +93,40 @@ public class BalanceTransaction extends ApiResource implements HasId { ExpandableField source; /** - * If the transaction's net funds are available in the Stripe balance yet. Either `available` or - * `pending`. + * If the transaction's net funds are available in the Stripe balance yet. Either {@code + * available} or {@code pending}. */ @SerializedName("status") String status; /** - * Transaction type: `adjustment`, `advance`, `advance_funding`, `application_fee`, - * `application_fee_refund`, `charge`, `connect_collection_transfer`, - * `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_transaction`, - * `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, - * `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, - * `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, - * `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn - * more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction - * types and what they represent. If you are looking to classify transactions for accounting - * purposes, you might want to consider `reporting_category` instead. + * Transaction type: {@code adjustment}, {@code advance}, {@code advance_funding}, {@code + * application_fee}, {@code application_fee_refund}, {@code charge}, {@code + * connect_collection_transfer}, {@code issuing_authorization_hold}, {@code + * issuing_authorization_release}, {@code issuing_transaction}, {@code payment}, {@code + * payment_failure_refund}, {@code payment_refund}, {@code payout}, {@code payout_cancel}, {@code + * payout_failure}, {@code refund}, {@code refund_failure}, {@code reserve_transaction}, {@code + * reserved_funds}, {@code stripe_fee}, {@code stripe_fx_fee}, {@code tax_fee}, {@code topup}, + * {@code topup_reversal}, {@code transfer}, {@code transfer_cancel}, {@code transfer_failure}, or + * {@code transfer_refund}. Learn more about balance + * transaction types and what they represent. If you are looking to classify transactions for + * accounting purposes, you might want to consider {@code reporting_category} instead. * - *

One of `adjustment`, `advance`, `advance_funding`, `application_fee`, - * `application_fee_refund`, `charge`, `connect_collection_transfer`, - * `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_transaction`, - * `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, - * `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, - * `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, - * `transfer_cancel`, `transfer_failure`, or `transfer_refund`. + *

One of {@code adjustment}, {@code advance}, {@code advance_funding}, {@code + * application_fee}, {@code application_fee_refund}, {@code charge}, {@code + * connect_collection_transfer}, {@code issuing_authorization_hold}, {@code + * issuing_authorization_release}, {@code issuing_transaction}, {@code payment}, {@code + * payment_failure_refund}, {@code payment_refund}, {@code payout}, {@code payout_cancel}, {@code + * payout_failure}, {@code refund}, {@code refund_failure}, {@code reserve_transaction}, {@code + * reserved_funds}, {@code stripe_fee}, {@code stripe_fx_fee}, {@code tax_fee}, {@code topup}, + * {@code topup_reversal}, {@code transfer}, {@code transfer_cancel}, {@code transfer_failure}, or + * {@code transfer_refund}. */ @SerializedName("type") String type; - /** Get id of expandable `source` object. */ + /** Get ID of expandable {@code source} object. */ public String getSource() { return (this.source != null) ? this.source.getId() : null; } @@ -130,7 +135,7 @@ public void setSource(String id) { this.source = ApiResource.setExpandableFieldId(id, this.source); } - /** Get expanded `source`. */ + /** Get expanded {@code source}. */ public BalanceTransactionSource getSourceObject() { return (this.source != null) ? this.source.getExpanded() : null; } @@ -259,8 +264,9 @@ public static class Fee extends StripeObject { String application; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ @SerializedName("currency") String currency; @@ -269,7 +275,7 @@ public static class Fee extends StripeObject { @SerializedName("description") String description; - /** Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ + /** Type of the fee, one of: {@code application_fee}, {@code stripe_fee} or {@code tax}. */ @SerializedName("type") String type; } diff --git a/src/main/java/com/stripe/model/BankAccount.java b/src/main/java/com/stripe/model/BankAccount.java index 4853b421675..4dbb966e6b7 100644 --- a/src/main/java/com/stripe/model/BankAccount.java +++ b/src/main/java/com/stripe/model/BankAccount.java @@ -29,11 +29,14 @@ public class BankAccount extends ApiResource @SerializedName("account_holder_name") String accountHolderName; - /** The type of entity that holds the account. This can be either `individual` or `company`. */ + /** + * The type of entity that holds the account. This can be either {@code individual} or {@code + * company}. + */ @SerializedName("account_holder_type") String accountHolderType; - /** Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ + /** Name of the bank associated with the routing number (e.g., {@code WELLS FARGO}). */ @SerializedName("bank_name") String bankName; @@ -42,8 +45,8 @@ public class BankAccount extends ApiResource String country; /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank - * account. + * Three-letter ISO code for the currency paid out + * to the bank account. */ @SerializedName("currency") String currency; @@ -89,7 +92,7 @@ public class BankAccount extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `bank_account`. + *

Equal to {@code bank_account}. */ @SerializedName("object") String object; @@ -99,25 +102,25 @@ public class BankAccount extends ApiResource String routingNumber; /** - * For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, - * or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If - * Stripe can determine that the bank account exists, its status will be `validated`. Note that - * there often isn’t enough information to know (e.g., for smaller credit unions), and the - * validation is not always run. If customer bank account verification has succeeded, the bank - * account status will be `verified`. If the verification failed for any reason, such as - * microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank - * account fails, we'll set the status to `errored` and will not continue to send transfers until - * the bank details are updated. + * For bank accounts, possible values are {@code new}, {@code validated}, {@code verified}, {@code + * verification_failed}, or {@code errored}. A bank account that hasn't had any activity or + * validation performed is {@code new}. If Stripe can determine that the bank account exists, its + * status will be {@code validated}. Note that there often isn’t enough information to know (e.g., + * for smaller credit unions), and the validation is not always run. If customer bank account + * verification has succeeded, the bank account status will be {@code verified}. If the + * verification failed for any reason, such as microdeposit failure, the status will be {@code + * verification_failed}. If a transfer sent to this bank account fails, we'll set the status to + * {@code errored} and will not continue to send transfers until the bank details are updated. * - *

For external accounts, possible values are `new` and `errored`. Validations aren't run - * against external accounts because they're only used for payouts. This means the other statuses - * don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped - * until account details are updated. + *

For external accounts, possible values are {@code new} and {@code errored}. Validations + * aren't run against external accounts because they're only used for payouts. This means the + * other statuses don't apply. If a transfer fails, the status is set to {@code errored} and + * transfers are stopped until account details are updated. */ @SerializedName("status") String status; - /** Get id of expandable `account` object. */ + /** Get ID of expandable {@code account} object. */ public String getAccount() { return (this.account != null) ? this.account.getId() : null; } @@ -126,7 +129,7 @@ public void setAccount(String id) { this.account = ApiResource.setExpandableFieldId(id, this.account); } - /** Get expanded `account`. */ + /** Get expanded {@code account}. */ public Account getAccountObject() { return (this.account != null) ? this.account.getExpanded() : null; } @@ -135,7 +138,7 @@ public void setAccountObject(Account expandableObject) { this.account = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -144,7 +147,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -205,8 +208,9 @@ public BankAccount verify(BankAccountVerifyParams params, RequestOptions options /** * Updates the metadata, account holder name, and account holder type of a bank account belonging - * to a Custom account, and optionally sets it as the - * default for its currency. Other bank account details are not editable by design. + * to a Custom account, and + * optionally sets it as the default for its currency. Other bank account details are not editable + * by design. * *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes. @@ -222,8 +226,9 @@ public BankAccount update(Map params) throws StripeException { /** * Updates the metadata, account holder name, and account holder type of a bank account belonging - * to a Custom account, and optionally sets it as the - * default for its currency. Other bank account details are not editable by design. + * to a Custom account, and + * optionally sets it as the default for its currency. Other bank account details are not editable + * by design. * *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes. @@ -268,8 +273,9 @@ public BankAccount update(Map params, RequestOptions options) /** * Updates the metadata, account holder name, and account holder type of a bank account belonging - * to a Custom account, and optionally sets it as the - * default for its currency. Other bank account details are not editable by design. + * to a Custom account, and + * optionally sets it as the default for its currency. Other bank account details are not editable + * by design. * *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes. @@ -284,8 +290,9 @@ public BankAccount update(BankAccountUpdateOnAccountParams params) throws Stripe /** * Updates the metadata, account holder name, and account holder type of a bank account belonging - * to a Custom account, and optionally sets it as the - * default for its currency. Other bank account details are not editable by design. + * to a Custom account, and + * optionally sets it as the default for its currency. Other bank account details are not editable + * by design. * *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes. @@ -320,8 +327,9 @@ public BankAccount update(BankAccountUpdateOnAccountParams params, RequestOption /** * Updates the metadata, account holder name, and account holder type of a bank account belonging - * to a Custom account, and optionally sets it as the - * default for its currency. Other bank account details are not editable by design. + * to a Custom account, and + * optionally sets it as the default for its currency. Other bank account details are not editable + * by design. * *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes. @@ -336,8 +344,9 @@ public BankAccount update(BankAccountUpdateOnCustomerParams params) throws Strip /** * Updates the metadata, account holder name, and account holder type of a bank account belonging - * to a Custom account, and optionally sets it as the - * default for its currency. Other bank account details are not editable by design. + * to a Custom account, and + * optionally sets it as the default for its currency. Other bank account details are not editable + * by design. * *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes. diff --git a/src/main/java/com/stripe/model/BitcoinReceiver.java b/src/main/java/com/stripe/model/BitcoinReceiver.java index 01a076fb59a..de6723b40c9 100644 --- a/src/main/java/com/stripe/model/BitcoinReceiver.java +++ b/src/main/java/com/stripe/model/BitcoinReceiver.java @@ -20,17 +20,17 @@ public class BitcoinReceiver extends ApiResource implements PaymentSource { @SerializedName("active") Boolean active; - /** The amount of `currency` that you are collecting as payment. */ + /** The amount of {@code currency} that you are collecting as payment. */ @SerializedName("amount") Long amount; - /** The amount of `currency` to which `bitcoin_amount_received` has been converted. */ + /** The amount of {@code currency} to which {@code bitcoin_amount_received} has been converted. */ @SerializedName("amount_received") Long amountReceived; /** - * The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` - * is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. + * The amount of bitcoin that the customer should send to fill the receiver. The {@code + * bitcoin_amount} is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ @SerializedName("bitcoin_amount") Long bitcoinAmount; @@ -51,8 +51,8 @@ public class BitcoinReceiver extends ApiResource implements PaymentSource { Long created; /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the - * bitcoin will be converted. + * Three-letter ISO code for the currency to + * which the bitcoin will be converted. */ @SerializedName("currency") String currency; @@ -74,8 +74,8 @@ public class BitcoinReceiver extends ApiResource implements PaymentSource { String email; /** - * This flag is initially false and updates to true when the customer sends the `bitcoin_amount` - * to this receiver. + * This flag is initially false and updates to true when the customer sends the {@code + * bitcoin_amount} to this receiver. */ @SerializedName("filled") Boolean filled; @@ -93,8 +93,8 @@ public class BitcoinReceiver extends ApiResource implements PaymentSource { String inboundAddress; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -109,7 +109,7 @@ public class BitcoinReceiver extends ApiResource implements PaymentSource { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `bitcoin_receiver`. + *

Equal to {@code bitcoin_receiver}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/BitcoinTransaction.java b/src/main/java/com/stripe/model/BitcoinTransaction.java index a41978d3f82..202ad70725a 100644 --- a/src/main/java/com/stripe/model/BitcoinTransaction.java +++ b/src/main/java/com/stripe/model/BitcoinTransaction.java @@ -9,7 +9,7 @@ @Setter @EqualsAndHashCode(callSuper = false) public class BitcoinTransaction extends StripeObject implements HasId { - /** The amount of `currency` that the transaction was converted to in real-time. */ + /** The amount of {@code currency} that the transaction was converted to in real-time. */ @SerializedName("amount") Long amount; @@ -22,8 +22,8 @@ public class BitcoinTransaction extends StripeObject implements HasId { Long created; /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this - * transaction was converted. + * Three-letter ISO code for the currency to + * which this transaction was converted. */ @SerializedName("currency") String currency; @@ -36,7 +36,7 @@ public class BitcoinTransaction extends StripeObject implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `bitcoin_transaction`. + *

Equal to {@code bitcoin_transaction}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/Capability.java b/src/main/java/com/stripe/model/Capability.java index 5d2bc1993be..68b01e28ff9 100644 --- a/src/main/java/com/stripe/model/Capability.java +++ b/src/main/java/com/stripe/model/Capability.java @@ -30,7 +30,7 @@ public class Capability extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `capability`. + *

Equal to {@code capability}. */ @SerializedName("object") String object; @@ -46,11 +46,14 @@ public class Capability extends ApiResource implements HasId { @SerializedName("requirements") Requirements requirements; - /** The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. */ + /** + * The status of the capability. Can be {@code active}, {@code inactive}, {@code pending}, or + * {@code unrequested}. + */ @SerializedName("status") String status; - /** Get id of expandable `account` object. */ + /** Get ID of expandable {@code account} object. */ public String getAccount() { return (this.account != null) ? this.account.getId() : null; } @@ -59,7 +62,7 @@ public void setAccount(String id) { this.account = ApiResource.setExpandableFieldId(id, this.account); } - /** Get expanded `account`. */ + /** Get expanded {@code account}. */ public Account getAccountObject() { return (this.account != null) ? this.account.getExpanded() : null; } @@ -111,38 +114,38 @@ public Capability update(CapabilityUpdateParams params, RequestOptions options) @EqualsAndHashCode(callSuper = false) public static class Requirements extends StripeObject { /** - * The date the fields in `currently_due` must be collected by to keep the capability enabled - * for the account. + * The date the fields in {@code currently_due} must be collected by to keep the capability + * enabled for the account. */ @SerializedName("current_deadline") Long currentDeadline; /** * The fields that need to be collected to keep the capability enabled. If not collected by the - * `current_deadline`, these fields appear in `past_due` as well, and the capability is - * disabled. + * {@code current_deadline}, these fields appear in {@code past_due} as well, and the capability + * is disabled. */ @SerializedName("currently_due") List currentlyDue; /** - * If the capability is disabled, this string describes why. Possible values are - * `requirement.fields_needed`, `pending.onboarding`, `pending.review`, `rejected_fraud`, or - * `rejected.other`. + * If the capability is disabled, this string describes why. Possible values are {@code + * requirement.fields_needed}, {@code pending.onboarding}, {@code pending.review}, {@code + * rejected_fraud}, or {@code rejected.other}. */ @SerializedName("disabled_reason") String disabledReason; /** * The fields that need to be collected assuming all volume thresholds are reached. As they - * become required, these fields appear in `currently_due` as well, and the `current_deadline` - * is set. + * become required, these fields appear in {@code currently_due} as well, and the {@code + * current_deadline} is set. */ @SerializedName("eventually_due") List eventuallyDue; /** - * The fields that weren't collected by the `current_deadline`. These fields need to be + * The fields that weren't collected by the {@code current_deadline}. These fields need to be * collected to enable the capability for the account. */ @SerializedName("past_due") @@ -151,7 +154,7 @@ public static class Requirements extends StripeObject { /** * Fields that may become required depending on the results of verification or review. An empty * array unless an asynchronous verification is pending. If verification fails, the fields in - * this array become required and move to `currently_due` or `past_due`. + * this array become required and move to {@code currently_due} or {@code past_due}. */ @SerializedName("pending_verification") List pendingVerification; diff --git a/src/main/java/com/stripe/model/Card.java b/src/main/java/com/stripe/model/Card.java index d1064d71726..481409329be 100644 --- a/src/main/java/com/stripe/model/Card.java +++ b/src/main/java/com/stripe/model/Card.java @@ -41,8 +41,8 @@ public class Card extends ApiResource String addressLine1; /** - * If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or - * `unchecked`. + * If {@code address_line1} was provided, results of the check: {@code pass}, {@code fail}, {@code + * unavailable}, or {@code unchecked}. */ @SerializedName("address_line1_check") String addressLine1Check; @@ -60,23 +60,23 @@ public class Card extends ApiResource String addressZip; /** - * If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or - * `unchecked`. + * If {@code address_zip} was provided, results of the check: {@code pass}, {@code fail}, {@code + * unavailable}, or {@code unchecked}. */ @SerializedName("address_zip_check") String addressZipCheck; /** - * A set of available payout methods for this card. Will be either `["standard"]` or `["standard", - * "instant"]`. Only values from this set should be passed as the `method` when creating a - * transfer. + * A set of available payout methods for this card. Will be either {@code ["standard"]} or {@code + * ["standard", "instant"]}. Only values from this set should be passed as the {@code method} when + * creating a transfer. */ @SerializedName("available_payout_methods") List availablePayoutMethods; /** - * Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, - * `UnionPay`, `Visa`, or `Unknown`. + * Card brand. Can be {@code American Express}, {@code Diners Club}, {@code Discover}, {@code + * JCB}, {@code MasterCard}, {@code UnionPay}, {@code Visa}, or {@code Unknown}. */ @SerializedName("brand") String brand; @@ -89,8 +89,8 @@ public class Card extends ApiResource String country; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -104,7 +104,10 @@ public class Card extends ApiResource @Setter(lombok.AccessLevel.NONE) ExpandableField customer; - /** If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * If a CVC was provided, results of the check: {@code pass}, {@code fail}, {@code unavailable}, + * or {@code unchecked}. + */ @SerializedName("cvc_check") String cvcCheck; @@ -142,7 +145,9 @@ public class Card extends ApiResource @SerializedName("fingerprint") String fingerprint; - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * Card funding type. Can be {@code credit}, {@code debit}, {@code prepaid}, or {@code unknown}. + */ @SerializedName("funding") String funding; @@ -184,7 +189,7 @@ public class Card extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `card`. + *

Equal to {@code card}. */ @SerializedName("object") String object; @@ -199,14 +204,14 @@ public class Card extends ApiResource ExpandableField recipient; /** - * If the card number is tokenized, this is the method that was used. Can be - * `amex_express_checkout`, `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, - * `visa_checkout`, or null. + * If the card number is tokenized, this is the method that was used. Can be {@code + * amex_express_checkout}, {@code android_pay} (includes Google Pay), {@code apple_pay}, {@code + * masterpass}, {@code visa_checkout}, or null. */ @SerializedName("tokenization_method") String tokenizationMethod; - /** Get id of expandable `account` object. */ + /** Get ID of expandable {@code account} object. */ public String getAccount() { return (this.account != null) ? this.account.getId() : null; } @@ -215,7 +220,7 @@ public void setAccount(String id) { this.account = ApiResource.setExpandableFieldId(id, this.account); } - /** Get expanded `account`. */ + /** Get expanded {@code account}. */ public Account getAccountObject() { return (this.account != null) ? this.account.getExpanded() : null; } @@ -224,7 +229,7 @@ public void setAccountObject(Account expandableObject) { this.account = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -233,7 +238,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -242,7 +247,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `recipient` object. */ + /** Get ID of expandable {@code recipient} object. */ public String getRecipient() { return (this.recipient != null) ? this.recipient.getId() : null; } @@ -251,7 +256,7 @@ public void setRecipient(String id) { this.recipient = ApiResource.setExpandableFieldId(id, this.recipient); } - /** Get expanded `recipient`. */ + /** Get expanded {@code recipient}. */ public Recipient getRecipientObject() { return (this.recipient != null) ? this.recipient.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/Charge.java b/src/main/java/com/stripe/model/Charge.java index 1191cb78a00..a33cd6aee6d 100644 --- a/src/main/java/com/stripe/model/Charge.java +++ b/src/main/java/com/stripe/model/Charge.java @@ -26,11 +26,12 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how much - * to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) - * (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum - * amount is $0.50 US or [equivalent in charge - * currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount - * value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). + * to charge in the smallest currency + * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The + * minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ @SerializedName("amount") Long amount; @@ -49,8 +50,9 @@ public class Charge extends ApiResource implements MetadataStore, Balanc ExpandableField application; /** - * The application fee (if any) for the charge. [See the Connect - * documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. + * The application fee (if any) for the charge. See the Connect + * documentation for details. */ @SerializedName("application_fee") @Getter(lombok.AccessLevel.NONE) @@ -58,8 +60,9 @@ public class Charge extends ApiResource implements MetadataStore, Balanc ExpandableField applicationFee; /** - * The amount of the application fee (if any) for the charge. [See the Connect - * documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. + * The amount of the application fee (if any) for the charge. See the Connect + * documentation for details. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; @@ -92,8 +95,8 @@ public class Charge extends ApiResource implements MetadataStore, Balanc Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -109,7 +112,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc String description; /** - * ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was + * ID of an existing, connected Stripe account to transfer funds to if {@code transfer_data} was * specified in the charge request. */ @SerializedName("destination") @@ -128,8 +131,8 @@ public class Charge extends ApiResource implements MetadataStore, Balanc Boolean disputed; /** - * Error code explaining reason for charge failure if available (see [the errors - * section](https://stripe.com/docs/api#errors) for a list of codes). + * Error code explaining reason for charge failure if available (see the errors section for a list of codes). */ @SerializedName("failure_code") String failureCode; @@ -157,8 +160,8 @@ public class Charge extends ApiResource implements MetadataStore, Balanc Level3 level3; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -174,14 +177,15 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `charge`. + *

Equal to {@code charge}. */ @SerializedName("object") String object; /** * The account (if any) the charge was made on behalf of without triggering an automatic transfer. - * See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers) for details. + * See the Connect documentation + * for details. */ @SerializedName("on_behalf_of") @Getter(lombok.AccessLevel.NONE) @@ -195,13 +199,13 @@ public class Charge extends ApiResource implements MetadataStore, Balanc ExpandableField order; /** - * Details about whether the payment was accepted, and why. See [understanding - * declines](https://stripe.com/docs/declines) for details. + * Details about whether the payment was accepted, and why. See understanding declines for details. */ @SerializedName("outcome") Outcome outcome; - /** `true` if the charge succeeded, or was successfully authorized for later capture. */ + /** {@code true} if the charge succeeded, or was successfully authorized for later capture. */ @SerializedName("paid") Boolean paid; @@ -223,7 +227,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * This is the transaction number that appears on email receipts sent for this charge. This - * attribute will be `null` until a receipt has been sent. + * attribute will be {@code null} until a receipt has been sent. */ @SerializedName("receipt_number") String receiptNumber; @@ -260,15 +264,15 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * This is a legacy field that will be removed in the future. It contains the Source, Card, or * BankAccount object used for the charge. For details about the payment method used for this - * charge, refer to `payment_method` or `payment_method_details` instead. + * charge, refer to {@code payment_method} or {@code payment_method_details} instead. */ @SerializedName("source") PaymentSource source; /** * The transfer ID which created this charge. Only present if the charge came from another Stripe - * account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) - * for details. + * account. See the Connect + * documentation for details. */ @SerializedName("source_transfer") @Getter(lombok.AccessLevel.NONE) @@ -276,9 +280,9 @@ public class Charge extends ApiResource implements MetadataStore, Balanc ExpandableField sourceTransfer; /** - * For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value - * as the complete description of a charge on your customers’ statements. Must contain at least - * one letter, maximum 22 characters. + * For card charges, use {@code statement_descriptor_suffix} instead. Otherwise, you can use this + * value as the complete description of a charge on your customers’ statements. Must contain at + * least one letter, maximum 22 characters. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -291,13 +295,13 @@ public class Charge extends ApiResource implements MetadataStore, Balanc @SerializedName("statement_descriptor_suffix") String statementDescriptorSuffix; - /** The status of the payment is either `succeeded`, `pending`, or `failed`. */ + /** The status of the payment is either {@code succeeded}, {@code pending}, or {@code failed}. */ @SerializedName("status") String status; /** - * ID of the transfer to the `destination` account (only applicable if the charge was created - * using the `destination` parameter). + * ID of the transfer to the {@code destination} account (only applicable if the charge was + * created using the {@code destination} parameter). */ @SerializedName("transfer") @Getter(lombok.AccessLevel.NONE) @@ -306,21 +310,21 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. [See the Connect - * documentation](https://stripe.com/docs/connect/destination-charges) for details. + * destination charge. See the + * Connect documentation for details. */ @SerializedName("transfer_data") TransferData transferData; /** - * A string that identifies this transaction as part of a group. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. See the Connect + * documentation for details. */ @SerializedName("transfer_group") String transferGroup; - /** Get id of expandable `application` object. */ + /** Get ID of expandable {@code application} object. */ public String getApplication() { return (this.application != null) ? this.application.getId() : null; } @@ -329,7 +333,7 @@ public void setApplication(String id) { this.application = ApiResource.setExpandableFieldId(id, this.application); } - /** Get expanded `application`. */ + /** Get expanded {@code application}. */ public Application getApplicationObject() { return (this.application != null) ? this.application.getExpanded() : null; } @@ -338,7 +342,7 @@ public void setApplicationObject(Application expandableObject) { this.application = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `applicationFee` object. */ + /** Get ID of expandable {@code applicationFee} object. */ public String getApplicationFee() { return (this.applicationFee != null) ? this.applicationFee.getId() : null; } @@ -347,7 +351,7 @@ public void setApplicationFee(String id) { this.applicationFee = ApiResource.setExpandableFieldId(id, this.applicationFee); } - /** Get expanded `applicationFee`. */ + /** Get expanded {@code applicationFee}. */ public ApplicationFee getApplicationFeeObject() { return (this.applicationFee != null) ? this.applicationFee.getExpanded() : null; } @@ -357,7 +361,7 @@ public void setApplicationFeeObject(ApplicationFee expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -366,7 +370,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -376,7 +380,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -385,7 +389,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -394,7 +398,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `destination` object. */ + /** Get ID of expandable {@code destination} object. */ public String getDestination() { return (this.destination != null) ? this.destination.getId() : null; } @@ -403,7 +407,7 @@ public void setDestination(String id) { this.destination = ApiResource.setExpandableFieldId(id, this.destination); } - /** Get expanded `destination`. */ + /** Get expanded {@code destination}. */ public Account getDestinationObject() { return (this.destination != null) ? this.destination.getExpanded() : null; } @@ -412,7 +416,7 @@ public void setDestinationObject(Account expandableObject) { this.destination = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `dispute` object. */ + /** Get ID of expandable {@code dispute} object. */ public String getDispute() { return (this.dispute != null) ? this.dispute.getId() : null; } @@ -421,7 +425,7 @@ public void setDispute(String id) { this.dispute = ApiResource.setExpandableFieldId(id, this.dispute); } - /** Get expanded `dispute`. */ + /** Get expanded {@code dispute}. */ public Dispute getDisputeObject() { return (this.dispute != null) ? this.dispute.getExpanded() : null; } @@ -430,7 +434,7 @@ public void setDisputeObject(Dispute expandableObject) { this.dispute = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `invoice` object. */ + /** Get ID of expandable {@code invoice} object. */ public String getInvoice() { return (this.invoice != null) ? this.invoice.getId() : null; } @@ -439,7 +443,7 @@ public void setInvoice(String id) { this.invoice = ApiResource.setExpandableFieldId(id, this.invoice); } - /** Get expanded `invoice`. */ + /** Get expanded {@code invoice}. */ public Invoice getInvoiceObject() { return (this.invoice != null) ? this.invoice.getExpanded() : null; } @@ -448,7 +452,7 @@ public void setInvoiceObject(Invoice expandableObject) { this.invoice = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `onBehalfOf` object. */ + /** Get ID of expandable {@code onBehalfOf} object. */ public String getOnBehalfOf() { return (this.onBehalfOf != null) ? this.onBehalfOf.getId() : null; } @@ -457,7 +461,7 @@ public void setOnBehalfOf(String id) { this.onBehalfOf = ApiResource.setExpandableFieldId(id, this.onBehalfOf); } - /** Get expanded `onBehalfOf`. */ + /** Get expanded {@code onBehalfOf}. */ public Account getOnBehalfOfObject() { return (this.onBehalfOf != null) ? this.onBehalfOf.getExpanded() : null; } @@ -466,7 +470,7 @@ public void setOnBehalfOfObject(Account expandableObject) { this.onBehalfOf = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `order` object. */ + /** Get ID of expandable {@code order} object. */ public String getOrder() { return (this.order != null) ? this.order.getId() : null; } @@ -475,7 +479,7 @@ public void setOrder(String id) { this.order = ApiResource.setExpandableFieldId(id, this.order); } - /** Get expanded `order`. */ + /** Get expanded {@code order}. */ public Order getOrderObject() { return (this.order != null) ? this.order.getExpanded() : null; } @@ -484,7 +488,7 @@ public void setOrderObject(Order expandableObject) { this.order = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `review` object. */ + /** Get ID of expandable {@code review} object. */ public String getReview() { return (this.review != null) ? this.review.getId() : null; } @@ -493,7 +497,7 @@ public void setReview(String id) { this.review = ApiResource.setExpandableFieldId(id, this.review); } - /** Get expanded `review`. */ + /** Get expanded {@code review}. */ public Review getReviewObject() { return (this.review != null) ? this.review.getExpanded() : null; } @@ -502,7 +506,7 @@ public void setReviewObject(Review expandableObject) { this.review = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `sourceTransfer` object. */ + /** Get ID of expandable {@code sourceTransfer} object. */ public String getSourceTransfer() { return (this.sourceTransfer != null) ? this.sourceTransfer.getId() : null; } @@ -511,7 +515,7 @@ public void setSourceTransfer(String id) { this.sourceTransfer = ApiResource.setExpandableFieldId(id, this.sourceTransfer); } - /** Get expanded `sourceTransfer`. */ + /** Get expanded {@code sourceTransfer}. */ public Transfer getSourceTransferObject() { return (this.sourceTransfer != null) ? this.sourceTransfer.getExpanded() : null; } @@ -520,7 +524,7 @@ public void setSourceTransferObject(Transfer expandableObject) { this.sourceTransfer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `transfer` object. */ + /** Get ID of expandable {@code transfer} object. */ public String getTransfer() { return (this.transfer != null) ? this.transfer.getId() : null; } @@ -529,7 +533,7 @@ public void setTransfer(String id) { this.transfer = ApiResource.setExpandableFieldId(id, this.transfer); } - /** Get expanded `transfer`. */ + /** Get expanded {@code transfer}. */ public Transfer getTransferObject() { return (this.transfer != null) ? this.transfer.getExpanded() : null; } @@ -710,8 +714,8 @@ public Charge update(ChargeUpdateParams params, RequestOptions options) throws S /** * Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step - * payment flow, where first you created a charge with the capture - * option set to false. + * payment flow, where first you created a + * charge with the capture option set to false. * *

Uncaptured payments expire exactly seven days after they are created. If they are not * captured by that point in time, they will be marked as refunded and will no longer be @@ -723,8 +727,8 @@ public Charge capture() throws StripeException { /** * Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step - * payment flow, where first you created a charge with the capture - * option set to false. + * payment flow, where first you created a + * charge with the capture option set to false. * *

Uncaptured payments expire exactly seven days after they are created. If they are not * captured by that point in time, they will be marked as refunded and will no longer be @@ -736,8 +740,8 @@ public Charge capture(RequestOptions options) throws StripeException { /** * Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step - * payment flow, where first you created a charge with the capture - * option set to false. + * payment flow, where first you created a + * charge with the capture option set to false. * *

Uncaptured payments expire exactly seven days after they are created. If they are not * captured by that point in time, they will be marked as refunded and will no longer be @@ -749,8 +753,8 @@ public Charge capture(Map params) throws StripeException { /** * Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step - * payment flow, where first you created a charge with the capture - * option set to false. + * payment flow, where first you created a + * charge with the capture option set to false. * *

Uncaptured payments expire exactly seven days after they are created. If they are not * captured by that point in time, they will be marked as refunded and will no longer be @@ -767,8 +771,8 @@ public Charge capture(Map params, RequestOptions options) throws /** * Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step - * payment flow, where first you created a charge with the capture - * option set to false. + * payment flow, where first you created a + * charge with the capture option set to false. * *

Uncaptured payments expire exactly seven days after they are created. If they are not * captured by that point in time, they will be marked as refunded and will no longer be @@ -780,8 +784,8 @@ public Charge capture(ChargeCaptureParams params) throws StripeException { /** * Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step - * payment flow, where first you created a charge with the capture - * option set to false. + * payment flow, where first you created a + * charge with the capture option set to false. * *

Uncaptured payments expire exactly seven days after they are created. If they are not * captured by that point in time, they will be marked as refunded and will no longer be @@ -813,11 +817,14 @@ public static class AlternateStatementDescriptors extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class FraudDetails extends StripeObject { - /** Assessments from Stripe. If set, the value is `fraudulent`. */ + /** Assessments from Stripe. If set, the value is {@code fraudulent}. */ @SerializedName("stripe_report") String stripeReport; - /** Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ + /** + * Assessments reported by you. If set, possible values of are {@code safe} and {@code + * fraudulent}. + */ @SerializedName("user_report") String userReport; } @@ -873,29 +880,32 @@ public static class LineItem extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Outcome extends StripeObject { /** - * Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and - * `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was - * [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank - * authorization, and may temporarily appear as "pending" on a cardholder's statement. + * Possible values are {@code approved_by_network}, {@code declined_by_network}, {@code + * not_sent_to_network}, and {@code reversed_after_approval}. The value {@code + * reversed_after_approval} indicates the payment was blocked by Stripe after bank + * authorization, and may temporarily appear as "pending" on a cardholder's statement. */ @SerializedName("network_status") String networkStatus; /** - * An enumerated value providing a more detailed explanation of the outcome's `type`. Charges - * blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in - * review by Radar's default review rule have the value `elevated_risk_level`. Charges - * authorized, blocked, or placed in review by custom rules have the value `rule`. See - * [understanding declines](https://stripe.com/docs/declines) for more details. + * An enumerated value providing a more detailed explanation of the outcome's {@code type}. + * Charges blocked by Radar's default block rule have the value {@code highest_risk_level}. + * Charges placed in review by Radar's default review rule have the value {@code + * elevated_risk_level}. Charges authorized, blocked, or placed in review by custom rules have + * the value {@code rule}. See understanding + * declines for more details. */ @SerializedName("reason") String reason; /** * Stripe's evaluation of the riskiness of the payment. Possible values for evaluated payments - * are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating - * the public assignment of risk levels, this field will have the value `not_assessed`. In the - * event of an error in the evaluation, this field will have the value `unknown`. + * are {@code normal}, {@code elevated}, {@code highest}. For non-card payments, and card-based + * payments predating the public assignment of risk levels, this field will have the value + * {@code not_assessed}. In the event of an error in the evaluation, this field will have the + * value {@code unknown}. */ @SerializedName("risk_level") String riskLevel; @@ -923,14 +933,15 @@ public static class Outcome extends StripeObject { String sellerMessage; /** - * Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and - * `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar - * reviews](https://stripe.com/docs/radar/reviews) for details. + * Possible values are {@code authorized}, {@code manual_review}, {@code issuer_declined}, + * {@code blocked}, and {@code invalid}. See understanding declines and Radar reviews for details. */ @SerializedName("type") String type; - /** Get id of expandable `rule` object. */ + /** Get ID of expandable {@code rule} object. */ public String getRule() { return (this.rule != null) ? this.rule.getId() : null; } @@ -939,7 +950,7 @@ public void setRule(String id) { this.rule = ApiResource.setExpandableFieldId(id, this.rule); } - /** Get expanded `rule`. */ + /** Get expanded {@code rule}. */ public Rule getRuleObject() { return (this.rule != null) ? this.rule.getExpanded() : null; } @@ -1015,10 +1026,11 @@ public static class PaymentMethodDetails extends StripeObject { /** * The type of transaction-specific details of the payment method used in the payment, one of - * `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, - * `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, - * or `wechat`. An additional hash is included on `payment_method_details` with a name matching - * this value. It contains information specific to the payment method. + * {@code ach_credit_transfer}, {@code ach_debit}, {@code alipay}, {@code bancontact}, {@code + * card}, {@code card_present}, {@code eps}, {@code giropay}, {@code ideal}, {@code klarna}, + * {@code multibanco}, {@code p24}, {@code sepa_debit}, {@code sofort}, {@code stripe_account}, + * or {@code wechat}. An additional hash is included on {@code payment_method_details} with a + * name matching this value. It contains information specific to the payment method. */ @SerializedName("type") String type; @@ -1052,9 +1064,10 @@ public static class AchCreditTransfer extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class AchDebit extends StripeObject { /** - * Type of entity that holds the account. This can be either `individual` or `company`. + * Type of entity that holds the account. This can be either {@code individual} or {@code + * company}. * - *

One of `company`, or `individual`. + *

One of {@code company}, or {@code individual}. */ @SerializedName("account_holder_type") String accountHolderType; @@ -1158,7 +1171,7 @@ public static class Bancontact extends StripeObject { /** * Preferred language of the Bancontact authorization page that the customer is redirected to. - * Can be one of `en`, `de`, `fr`, or `nl` + * Can be one of {@code en}, {@code de}, {@code fr}, or {@code nl} */ @SerializedName("preferred_language") String preferredLanguage; @@ -1199,8 +1212,8 @@ public static class Bitcoin extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Card extends StripeObject { /** - * Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, - * or `unknown`. + * Card brand. Can be {@code amex}, {@code diners}, {@code discover}, {@code jcb}, {@code + * mastercard}, {@code unionpay}, {@code visa}, or {@code unknown}. */ @SerializedName("brand") String brand; @@ -1239,7 +1252,10 @@ public static class Card extends StripeObject { @SerializedName("fingerprint") String fingerprint; - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * Card funding type. Can be {@code credit}, {@code debit}, {@code prepaid}, or {@code + * unknown}. + */ @SerializedName("funding") String funding; @@ -1253,8 +1269,8 @@ public static class Card extends StripeObject { /** * Installment details for this payment (Mexico only). * - *

For more information, see the [installments integration - * guide](https://stripe.com/docs/payments/installments). + *

For more information, see the installments integration guide. */ @SerializedName("installments") Installments installments; @@ -1275,8 +1291,9 @@ public static class Card extends StripeObject { Boolean moto; /** - * Identifies which network this charge was processed on. Can be `amex`, `diners`, `discover`, - * `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. + * Identifies which network this charge was processed on. Can be {@code amex}, {@code diners}, + * {@code discover}, {@code interac}, {@code jcb}, {@code mastercard}, {@code unionpay}, + * {@code visa}, or {@code unknown}. */ @SerializedName("network") String network; @@ -1294,22 +1311,22 @@ public static class Card extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Checks extends StripeObject { /** - * If a address line1 was provided, results of the check, one of `pass`, `fail`, - * `unavailable`, or `unchecked`. + * If a address line1 was provided, results of the check, one of {@code pass}, {@code fail}, + * {@code unavailable}, or {@code unchecked}. */ @SerializedName("address_line1_check") String addressLine1Check; /** - * If a address postal code was provided, results of the check, one of `pass`, `fail`, - * `unavailable`, or `unchecked`. + * If a address postal code was provided, results of the check, one of {@code pass}, {@code + * fail}, {@code unavailable}, or {@code unchecked}. */ @SerializedName("address_postal_code_check") String addressPostalCodeCheck; /** - * If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or - * `unchecked`. + * If a CVC was provided, results of the check, one of {@code pass}, {@code fail}, {@code + * unavailable}, or {@code unchecked}. */ @SerializedName("cvc_check") String cvcCheck; @@ -1368,10 +1385,10 @@ public static class Wallet extends StripeObject { SamsungPay samsungPay; /** - * The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, - * `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the - * Wallet subhash with a name matching this value. It contains additional information - * specific to the card wallet type. + * The type of the card wallet, one of {@code amex_express_checkout}, {@code apple_pay}, + * {@code google_pay}, {@code masterpass}, {@code samsung_pay}, or {@code visa_checkout}. An + * additional hash is included on the Wallet subhash with a name matching this value. It + * contains additional information specific to the card wallet type. */ @SerializedName("type") String type; @@ -1476,8 +1493,8 @@ public static class VisaCheckout extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class CardPresent extends StripeObject { /** - * Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, - * or `unknown`. + * Card brand. Can be {@code amex}, {@code diners}, {@code discover}, {@code jcb}, {@code + * mastercard}, {@code unionpay}, {@code visa}, or {@code unknown}. */ @SerializedName("brand") String brand; @@ -1509,7 +1526,10 @@ public static class CardPresent extends StripeObject { @SerializedName("fingerprint") String fingerprint; - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * Card funding type. Can be {@code credit}, {@code debit}, {@code prepaid}, or {@code + * unknown}. + */ @SerializedName("funding") String funding; @@ -1526,8 +1546,9 @@ public static class CardPresent extends StripeObject { String last4; /** - * Identifies which network this charge was processed on. Can be `amex`, `diners`, `discover`, - * `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. + * Identifies which network this charge was processed on. Can be {@code amex}, {@code diners}, + * {@code discover}, {@code interac}, {@code jcb}, {@code mastercard}, {@code unionpay}, + * {@code visa}, or {@code unknown}. */ @SerializedName("network") String network; @@ -1602,15 +1623,16 @@ public static class Eps extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Fpx extends StripeObject { - /** Account holder type, if provided. Can be one of `individual` or `company`. */ + /** Account holder type, if provided. Can be one of {@code individual} or {@code company}. */ @SerializedName("account_holder_type") String accountHolderType; /** - * The customer's bank. Can be one of `affin_bank`, `alliance_bank`, `ambank`, `bank_islam`, - * `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, - * `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, - * `maybank2e`, `pb_enterprise`, or `uob_regional`. + * The customer's bank. Can be one of {@code affin_bank}, {@code alliance_bank}, {@code + * ambank}, {@code bank_islam}, {@code bank_muamalat}, {@code bank_rakyat}, {@code bsn}, + * {@code cimb}, {@code hong_leong_bank}, {@code hsbc}, {@code kfh}, {@code maybank2u}, {@code + * ocbc}, {@code public_bank}, {@code rhb}, {@code standard_chartered}, {@code uob}, {@code + * deutsche_bank}, {@code maybank2e}, {@code pb_enterprise}, or {@code uob_regional}. */ @SerializedName("bank") String bank; @@ -1649,8 +1671,9 @@ public static class Giropay extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Ideal extends StripeObject { /** - * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, - * `knab`, `moneyou`, `rabobank`, `regiobank`, `sns_bank`, `triodos_bank`, or `van_lanschot`. + * The customer's bank. Can be one of {@code abn_amro}, {@code asn_bank}, {@code bunq}, {@code + * handelsbanken}, {@code ing}, {@code knab}, {@code moneyou}, {@code rabobank}, {@code + * regiobank}, {@code sns_bank}, {@code triodos_bank}, or {@code van_lanschot}. */ @SerializedName("bank") String bank; @@ -1658,8 +1681,9 @@ public static class Ideal extends StripeObject { /** * The Bank Identifier Code of the customer's bank. * - *

One of `ABNANL2A`, `ASNBNL21`, `BUNQNL2A`, `FVLBNL22`, `HANDNL2A`, `INGBNL2A`, - * `KNABNL2H`, `MOYONL21`, `RABONL2U`, `RBRBNL21`, `SNSBNL2A`, or `TRIONL2U`. + *

One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BUNQNL2A}, {@code FVLBNL22}, {@code + * HANDNL2A}, {@code INGBNL2A}, {@code KNABNL2H}, {@code MOYONL21}, {@code RABONL2U}, {@code + * RBRBNL21}, {@code SNSBNL2A}, or {@code TRIONL2U}. */ @SerializedName("bic") String bic; @@ -1814,7 +1838,7 @@ public static class TransferData extends StripeObject { Long amount; /** - * ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was + * ID of an existing, connected Stripe account to transfer funds to if {@code transfer_data} was * specified in the charge request. */ @SerializedName("destination") @@ -1822,7 +1846,7 @@ public static class TransferData extends StripeObject { @Setter(lombok.AccessLevel.NONE) ExpandableField destination; - /** Get id of expandable `destination` object. */ + /** Get ID of expandable {@code destination} object. */ public String getDestination() { return (this.destination != null) ? this.destination.getId() : null; } @@ -1831,7 +1855,7 @@ public void setDestination(String id) { this.destination = ApiResource.setExpandableFieldId(id, this.destination); } - /** Get expanded `destination`. */ + /** Get expanded {@code destination}. */ public Account getDestinationObject() { return (this.destination != null) ? this.destination.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/ConnectCollectionTransfer.java b/src/main/java/com/stripe/model/ConnectCollectionTransfer.java index e1820d6d2d4..560e848be03 100644 --- a/src/main/java/com/stripe/model/ConnectCollectionTransfer.java +++ b/src/main/java/com/stripe/model/ConnectCollectionTransfer.java @@ -15,8 +15,8 @@ public class ConnectCollectionTransfer extends StripeObject implements BalanceTr Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -33,8 +33,8 @@ public class ConnectCollectionTransfer extends StripeObject implements BalanceTr String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -42,12 +42,12 @@ public class ConnectCollectionTransfer extends StripeObject implements BalanceTr /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `connect_collection_transfer`. + *

Equal to {@code connect_collection_transfer}. */ @SerializedName("object") String object; - /** Get id of expandable `destination` object. */ + /** Get ID of expandable {@code destination} object. */ public String getDestination() { return (this.destination != null) ? this.destination.getId() : null; } @@ -56,7 +56,7 @@ public void setDestination(String id) { this.destination = ApiResource.setExpandableFieldId(id, this.destination); } - /** Get expanded `destination`. */ + /** Get expanded {@code destination}. */ public Account getDestinationObject() { return (this.destination != null) ? this.destination.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/CountrySpec.java b/src/main/java/com/stripe/model/CountrySpec.java index 483982051f7..b0be690f9d7 100644 --- a/src/main/java/com/stripe/model/CountrySpec.java +++ b/src/main/java/com/stripe/model/CountrySpec.java @@ -31,7 +31,7 @@ public class CountrySpec extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `country_spec`. + *

Equal to {@code country_spec}. */ @SerializedName("object") String object; @@ -46,9 +46,9 @@ public class CountrySpec extends ApiResource implements HasId { /** * Payment methods available in the specified country. You may need to enable some payment methods - * (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The - * `stripe` payment method refers to [charging through your - * platform](https://stripe.com/docs/connect/destination-charges). + * (e.g., ACH) on your account before they appear in + * this list. The {@code stripe} payment method refers to charging through your platform. */ @SerializedName("supported_payment_methods") List supportedPaymentMethods; diff --git a/src/main/java/com/stripe/model/Coupon.java b/src/main/java/com/stripe/model/Coupon.java index 14ef0432d9b..2996ea09e99 100644 --- a/src/main/java/com/stripe/model/Coupon.java +++ b/src/main/java/com/stripe/model/Coupon.java @@ -20,8 +20,8 @@ @EqualsAndHashCode(callSuper = false) public class Coupon extends ApiResource implements HasId, MetadataStore { /** - * Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for - * this customer. + * Amount (in the {@code currency} specified) that will be taken off the subtotal of any invoices + * for this customer. */ @SerializedName("amount_off") Long amountOff; @@ -31,8 +31,9 @@ public class Coupon extends ApiResource implements HasId, MetadataStore Long created; /** - * If `amount_off` has been set, the three-letter [ISO code for the - * currency](https://stripe.com/docs/currencies) of the amount to take off. + * If {@code amount_off} has been set, the three-letter ISO code for the currency of the amount to take + * off. */ @SerializedName("currency") String currency; @@ -42,15 +43,15 @@ public class Coupon extends ApiResource implements HasId, MetadataStore Boolean deleted; /** - * One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this - * coupon will get the discount. + * One of {@code forever}, {@code once}, and {@code repeating}. Describes how long a customer who + * applies this coupon will get the discount. */ @SerializedName("duration") String duration; /** - * If `duration` is `repeating`, the number of months the coupon applies. Null if coupon - * `duration` is `forever` or `once`. + * If {@code duration} is {@code repeating}, the number of months the coupon applies. Null if + * coupon {@code duration} is {@code forever} or {@code once}. */ @SerializedName("duration_in_months") Long durationInMonths; @@ -61,8 +62,8 @@ public class Coupon extends ApiResource implements HasId, MetadataStore String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -89,7 +90,7 @@ public class Coupon extends ApiResource implements HasId, MetadataStore /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `coupon`. + *

Equal to {@code coupon}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/CreditNote.java b/src/main/java/com/stripe/model/CreditNote.java index 0f218fc6dfb..215a1bfd9bd 100644 --- a/src/main/java/com/stripe/model/CreditNote.java +++ b/src/main/java/com/stripe/model/CreditNote.java @@ -22,7 +22,8 @@ @EqualsAndHashCode(callSuper = false) public class CreditNote extends ApiResource implements HasId, MetadataStore { /** - * The integer amount in **%s** representing the total amount of the credit note, including tax. + * The integer amount in %s representing the total amount of the credit note, + * including tax. */ @SerializedName("amount") Long amount; @@ -32,8 +33,8 @@ public class CreditNote extends ApiResource implements HasId, MetadataStoreISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -50,7 +51,10 @@ public class CreditNote extends ApiResource implements HasId, MetadataStore customerBalanceTransaction; - /** The integer amount in **%s** representing the amount of the discount that was credited. */ + /** + * The integer amount in %s representing the amount of the discount that was + * credited. + */ @SerializedName("discount_amount") Long discountAmount; @@ -70,8 +74,8 @@ public class CreditNote extends ApiResource implements HasId, MetadataStoreEqual to `credit_note`. + *

Equal to {@code credit_note}. */ @SerializedName("object") String object; @@ -112,8 +116,8 @@ public class CreditNote extends ApiResource implements HasId, MetadataStore refund; /** - * Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit - * notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + * Status of this credit note, one of {@code issued} or {@code void}. Learn more about voiding credit notes. */ @SerializedName("status") String status; /** - * The integer amount in **%s** representing the amount of the credit note, excluding tax and - * discount. + * The integer amount in %s representing the amount of the credit note, excluding + * tax and discount. */ @SerializedName("subtotal") Long subtotal; @@ -143,16 +147,16 @@ public class CreditNote extends ApiResource implements HasId, MetadataStore taxAmounts; /** - * The integer amount in **%s** representing the total amount of the credit note, including tax - * and discount. + * The integer amount in %s representing the total amount of the credit note, + * including tax and discount. */ @SerializedName("total") Long total; /** - * Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note - * means it was issued when the invoice was open. A `post_payment` credit note means it was issued - * when the invoice was paid. + * Type of this credit note, one of {@code pre_payment} or {@code post_payment}. A {@code + * pre_payment} credit note means it was issued when the invoice was open. A {@code post_payment} + * credit note means it was issued when the invoice was paid. */ @SerializedName("type") String type; @@ -161,7 +165,7 @@ public class CreditNote extends ApiResource implements HasId, MetadataStore(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customerBalanceTransaction` object. */ + /** Get ID of expandable {@code customerBalanceTransaction} object. */ public String getCustomerBalanceTransaction() { return (this.customerBalanceTransaction != null) ? this.customerBalanceTransaction.getId() @@ -191,7 +195,7 @@ public void setCustomerBalanceTransaction(String id) { ApiResource.setExpandableFieldId(id, this.customerBalanceTransaction); } - /** Get expanded `customerBalanceTransaction`. */ + /** Get expanded {@code customerBalanceTransaction}. */ public CustomerBalanceTransaction getCustomerBalanceTransactionObject() { return (this.customerBalanceTransaction != null) ? this.customerBalanceTransaction.getExpanded() @@ -203,7 +207,7 @@ public void setCustomerBalanceTransactionObject(CustomerBalanceTransaction expan new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `invoice` object. */ + /** Get ID of expandable {@code invoice} object. */ public String getInvoice() { return (this.invoice != null) ? this.invoice.getId() : null; } @@ -212,7 +216,7 @@ public void setInvoice(String id) { this.invoice = ApiResource.setExpandableFieldId(id, this.invoice); } - /** Get expanded `invoice`. */ + /** Get expanded {@code invoice}. */ public Invoice getInvoiceObject() { return (this.invoice != null) ? this.invoice.getExpanded() : null; } @@ -221,7 +225,7 @@ public void setInvoiceObject(Invoice expandableObject) { this.invoice = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `refund` object. */ + /** Get ID of expandable {@code refund} object. */ public String getRefund() { return (this.refund != null) ? this.refund.getId() : null; } @@ -230,7 +234,7 @@ public void setRefund(String id) { this.refund = ApiResource.setExpandableFieldId(id, this.refund); } - /** Get expanded `refund`. */ + /** Get expanded {@code refund}. */ public Refund getRefundObject() { return (this.refund != null) ? this.refund.getExpanded() : null; } @@ -473,7 +477,7 @@ public CreditNote update(CreditNoteUpdateParams params, RequestOptions options) /** * Marks a credit note as void. Learn more about voiding credit notes. + * href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes. */ public CreditNote voidCreditNote() throws StripeException { return voidCreditNote((Map) null, (RequestOptions) null); @@ -481,7 +485,7 @@ public CreditNote voidCreditNote() throws StripeException { /** * Marks a credit note as void. Learn more about voiding credit notes. + * href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes. */ public CreditNote voidCreditNote(RequestOptions options) throws StripeException { return voidCreditNote((Map) null, options); @@ -489,7 +493,7 @@ public CreditNote voidCreditNote(RequestOptions options) throws StripeException /** * Marks a credit note as void. Learn more about voiding credit notes. + * href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes. */ public CreditNote voidCreditNote(Map params) throws StripeException { return voidCreditNote(params, (RequestOptions) null); @@ -497,7 +501,7 @@ public CreditNote voidCreditNote(Map params) throws StripeExcept /** * Marks a credit note as void. Learn more about voiding credit notes. + * href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes. */ public CreditNote voidCreditNote(Map params, RequestOptions options) throws StripeException { @@ -512,7 +516,7 @@ public CreditNote voidCreditNote(Map params, RequestOptions opti /** * Marks a credit note as void. Learn more about voiding credit notes. + * href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes. */ public CreditNote voidCreditNote(CreditNoteVoidCreditNoteParams params) throws StripeException { return voidCreditNote(params, (RequestOptions) null); @@ -520,7 +524,7 @@ public CreditNote voidCreditNote(CreditNoteVoidCreditNoteParams params) throws S /** * Marks a credit note as void. Learn more about voiding credit notes. + * href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes. */ public CreditNote voidCreditNote(CreditNoteVoidCreditNoteParams params, RequestOptions options) throws StripeException { @@ -551,7 +555,7 @@ public static class TaxAmount extends StripeObject { @Setter(lombok.AccessLevel.NONE) ExpandableField taxRate; - /** Get id of expandable `taxRate` object. */ + /** Get ID of expandable {@code taxRate} object. */ public String getTaxRate() { return (this.taxRate != null) ? this.taxRate.getId() : null; } @@ -560,7 +564,7 @@ public void setTaxRate(String id) { this.taxRate = ApiResource.setExpandableFieldId(id, this.taxRate); } - /** Get expanded `taxRate`. */ + /** Get expanded {@code taxRate}. */ public TaxRate getTaxRateObject() { return (this.taxRate != null) ? this.taxRate.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/CreditNoteLineItem.java b/src/main/java/com/stripe/model/CreditNoteLineItem.java index da9a0233e9e..8e3aa7e76b0 100644 --- a/src/main/java/com/stripe/model/CreditNoteLineItem.java +++ b/src/main/java/com/stripe/model/CreditNoteLineItem.java @@ -12,8 +12,8 @@ @EqualsAndHashCode(callSuper = false) public class CreditNoteLineItem extends StripeObject implements HasId { /** - * The integer amount in **%s** representing the gross amount being credited for this line item, - * excluding (exclusive) tax and discounts. + * The integer amount in %s representing the gross amount being credited for this + * line item, excluding (exclusive) tax and discounts. */ @SerializedName("amount") Long amount; @@ -22,7 +22,10 @@ public class CreditNoteLineItem extends StripeObject implements HasId { @SerializedName("description") String description; - /** The integer amount in **%s** representing the discount being credited for this line item. */ + /** + * The integer amount in %s representing the discount being credited for this + * line item. + */ @SerializedName("discount_amount") Long discountAmount; @@ -36,8 +39,8 @@ public class CreditNoteLineItem extends StripeObject implements HasId { String invoiceLineItem; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -45,7 +48,7 @@ public class CreditNoteLineItem extends StripeObject implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `credit_note_line_item`. + *

Equal to {@code credit_note_line_item}. */ @SerializedName("object") String object; @@ -63,9 +66,10 @@ public class CreditNoteLineItem extends StripeObject implements HasId { List taxRates; /** - * The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When - * the type is `invoice_line_item` there is an additional `invoice_line_item` property on the - * resource the value of which is the id of the credited line item on the invoice. + * The type of the credit note line item, one of {@code invoice_line_item} or {@code + * custom_line_item}. When the type is {@code invoice_line_item} there is an additional {@code + * invoice_line_item} property on the resource the value of which is the id of the credited line + * item on the invoice. */ @SerializedName("type") String type; @@ -74,7 +78,7 @@ public class CreditNoteLineItem extends StripeObject implements HasId { @SerializedName("unit_amount") Long unitAmount; - /** Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ + /** Same as {@code unit_amount}, but contains a decimal value with at most 12 decimal places. */ @SerializedName("unit_amount_decimal") BigDecimal unitAmountDecimal; } diff --git a/src/main/java/com/stripe/model/Customer.java b/src/main/java/com/stripe/model/Customer.java index 750455596d1..481f627f568 100644 --- a/src/main/java/com/stripe/model/Customer.java +++ b/src/main/java/com/stripe/model/Customer.java @@ -39,8 +39,8 @@ public class Customer extends ApiResource implements HasId, MetadataStoreISO code for the currency the + * customer can be charged in for recurring billing purposes. */ @SerializedName("currency") String currency; @@ -48,8 +48,8 @@ public class Customer extends ApiResource implements HasId, MetadataStoreIf you are using payment methods created via the PaymentMethods API, see the - * [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + *

If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method * field instead. */ @SerializedName("default_source") @@ -94,8 +94,8 @@ public class Customer extends ApiResource implements HasId, MetadataStoreEqual to `customer`. + *

Equal to {@code customer}. */ @SerializedName("object") String object; @@ -143,8 +143,9 @@ public class Customer extends ApiResource implements HasId, MetadataStore"Reverse charge". */ @SerializedName("tax_exempt") String taxExempt; @@ -153,7 +154,7 @@ public class Customer extends ApiResource implements HasId, MetadataStore params, RequestOptions options) /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection balanceTransactions() throws StripeException { return balanceTransactions((Map) null, (RequestOptions) null); @@ -416,7 +418,8 @@ public CustomerBalanceTransactionCollection balanceTransactions() throws StripeE /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection balanceTransactions(Map params) throws StripeException { @@ -425,7 +428,8 @@ public CustomerBalanceTransactionCollection balanceTransactions(Mapbalance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection balanceTransactions( Map params, RequestOptions options) throws StripeException { @@ -441,7 +445,8 @@ public CustomerBalanceTransactionCollection balanceTransactions( /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection balanceTransactions( CustomerBalanceTransactionsParams params) throws StripeException { @@ -450,7 +455,8 @@ public CustomerBalanceTransactionCollection balanceTransactions( /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection balanceTransactions( CustomerBalanceTransactionsParams params, RequestOptions options) throws StripeException { @@ -507,7 +513,7 @@ public static class InvoiceSettings extends StripeObject { @SerializedName("footer") String footer; - /** Get id of expandable `defaultPaymentMethod` object. */ + /** Get ID of expandable {@code defaultPaymentMethod} object. */ public String getDefaultPaymentMethod() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getId() : null; } @@ -516,7 +522,7 @@ public void setDefaultPaymentMethod(String id) { this.defaultPaymentMethod = ApiResource.setExpandableFieldId(id, this.defaultPaymentMethod); } - /** Get expanded `defaultPaymentMethod`. */ + /** Get expanded {@code defaultPaymentMethod}. */ public PaymentMethod getDefaultPaymentMethodObject() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/CustomerBalanceTransaction.java b/src/main/java/com/stripe/model/CustomerBalanceTransaction.java index 288157dd9aa..c4eb96a5c2e 100644 --- a/src/main/java/com/stripe/model/CustomerBalanceTransaction.java +++ b/src/main/java/com/stripe/model/CustomerBalanceTransaction.java @@ -18,7 +18,7 @@ public class CustomerBalanceTransaction extends ApiResource implements HasId, MetadataStore { /** * The amount of the transaction. A negative value is a credit for the customer's balance, and a - * positive value is a debit to the customer's `balance`. + * positive value is a debit to the customer's {@code balance}. */ @SerializedName("amount") Long amount; @@ -34,8 +34,8 @@ public class CustomerBalanceTransaction extends ApiResource ExpandableField creditNote; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -51,8 +51,8 @@ public class CustomerBalanceTransaction extends ApiResource String description; /** - * The customer's `balance` after the transaction was applied. A negative value decreases the - * amount due on the customer's next invoice. A positive value increases the amount due on the + * The customer's {@code balance} after the transaction was applied. A negative value decreases + * the amount due on the customer's next invoice. A positive value increases the amount due on the * customer's next invoice. */ @SerializedName("ending_balance") @@ -70,8 +70,8 @@ public class CustomerBalanceTransaction extends ApiResource ExpandableField invoice; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -87,25 +87,26 @@ public class CustomerBalanceTransaction extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `customer_balance_transaction`. + *

Equal to {@code customer_balance_transaction}. */ @SerializedName("object") String object; /** - * Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, - * `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or - * `unapplied_from_invoice`. See the [Customer Balance - * page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction - * types. + * Transaction type: {@code adjustment}, {@code applied_to_invoice}, {@code credit_note}, {@code + * initial}, {@code invoice_too_large}, {@code invoice_too_small}, {@code + * unspent_receiver_credit}, or {@code unapplied_from_invoice}. See the Customer Balance page to + * learn more about transaction types. * - *

One of `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, - * `invoice_too_small`, `migration`, `unapplied_from_invoice`, or `unspent_receiver_credit`. + *

One of {@code adjustment}, {@code applied_to_invoice}, {@code credit_note}, {@code initial}, + * {@code invoice_too_large}, {@code invoice_too_small}, {@code migration}, {@code + * unapplied_from_invoice}, or {@code unspent_receiver_credit}. */ @SerializedName("type") String type; - /** Get id of expandable `creditNote` object. */ + /** Get ID of expandable {@code creditNote} object. */ public String getCreditNote() { return (this.creditNote != null) ? this.creditNote.getId() : null; } @@ -114,7 +115,7 @@ public void setCreditNote(String id) { this.creditNote = ApiResource.setExpandableFieldId(id, this.creditNote); } - /** Get expanded `creditNote`. */ + /** Get expanded {@code creditNote}. */ public CreditNote getCreditNoteObject() { return (this.creditNote != null) ? this.creditNote.getExpanded() : null; } @@ -123,7 +124,7 @@ public void setCreditNoteObject(CreditNote expandableObject) { this.creditNote = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -132,7 +133,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -141,7 +142,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `invoice` object. */ + /** Get ID of expandable {@code invoice} object. */ public String getInvoice() { return (this.invoice != null) ? this.invoice.getId() : null; } @@ -150,7 +151,7 @@ public void setInvoice(String id) { this.invoice = ApiResource.setExpandableFieldId(id, this.invoice); } - /** Get expanded `invoice`. */ + /** Get expanded {@code invoice}. */ public Invoice getInvoiceObject() { return (this.invoice != null) ? this.invoice.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/CustomerBalanceTransactionCollection.java b/src/main/java/com/stripe/model/CustomerBalanceTransactionCollection.java index 6f0afbccd31..8f2f7d822d2 100644 --- a/src/main/java/com/stripe/model/CustomerBalanceTransactionCollection.java +++ b/src/main/java/com/stripe/model/CustomerBalanceTransactionCollection.java @@ -13,7 +13,8 @@ public class CustomerBalanceTransactionCollection extends StripeCollection { /** * Retrieves a specific transaction that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction retrieve(String id) throws StripeException { return retrieve(id, (Map) null, (RequestOptions) null); @@ -21,7 +22,8 @@ public CustomerBalanceTransaction retrieve(String id) throws StripeException { /** * Retrieves a specific transaction that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction retrieve(String id, RequestOptions options) throws StripeException { @@ -30,7 +32,8 @@ public CustomerBalanceTransaction retrieve(String id, RequestOptions options) /** * Retrieves a specific transaction that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction retrieve( String id, Map params, RequestOptions options) throws StripeException { @@ -45,7 +48,8 @@ public CustomerBalanceTransaction retrieve( /** * Retrieves a specific transaction that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction retrieve( String id, CustomerBalanceTransactionCollectionRetrieveParams params, RequestOptions options) @@ -61,7 +65,8 @@ public CustomerBalanceTransaction retrieve( /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection list(Map params) throws StripeException { @@ -70,7 +75,8 @@ public CustomerBalanceTransactionCollection list(Map params) /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection list( Map params, RequestOptions options) throws StripeException { @@ -81,7 +87,8 @@ public CustomerBalanceTransactionCollection list( /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection list( CustomerBalanceTransactionCollectionListParams params) throws StripeException { @@ -90,7 +97,8 @@ public CustomerBalanceTransactionCollection list( /** * Returns a list of transactions that updated the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransactionCollection list( CustomerBalanceTransactionCollectionListParams params, RequestOptions options) @@ -102,7 +110,8 @@ public CustomerBalanceTransactionCollection list( /** * Creates an immutable transaction that updates the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -110,7 +119,8 @@ public CustomerBalanceTransaction create(Map params) throws Stri /** * Creates an immutable transaction that updates the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction create(Map params, RequestOptions options) throws StripeException { @@ -121,7 +131,8 @@ public CustomerBalanceTransaction create(Map params, RequestOpti /** * Creates an immutable transaction that updates the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction create(CustomerBalanceTransactionCollectionCreateParams params) throws StripeException { @@ -130,7 +141,8 @@ public CustomerBalanceTransaction create(CustomerBalanceTransactionCollectionCre /** * Creates an immutable transaction that updates the customer’s balance. + * href="https://stripe.com/docs/api/customers/object#customer_object-balance">balance + * . */ public CustomerBalanceTransaction create( CustomerBalanceTransactionCollectionCreateParams params, RequestOptions options) diff --git a/src/main/java/com/stripe/model/Discount.java b/src/main/java/com/stripe/model/Discount.java index 506128274f4..9cc08a62827 100644 --- a/src/main/java/com/stripe/model/Discount.java +++ b/src/main/java/com/stripe/model/Discount.java @@ -24,8 +24,8 @@ public class Discount extends StripeObject { Boolean deleted; /** - * If the coupon has a duration of `repeating`, the date that this discount will end. If the - * coupon has a duration of `once` or `forever`, this attribute will be null. + * If the coupon has a duration of {@code repeating}, the date that this discount will end. If the + * coupon has a duration of {@code once} or {@code forever}, this attribute will be null. */ @SerializedName("end") Long end; @@ -33,7 +33,7 @@ public class Discount extends StripeObject { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `discount`. + *

Equal to {@code discount}. */ @SerializedName("object") String object; @@ -48,7 +48,7 @@ public class Discount extends StripeObject { @SerializedName("subscription") String subscription; - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -57,7 +57,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/Dispute.java b/src/main/java/com/stripe/model/Dispute.java index 1faacefcdf0..1ad16e4049b 100644 --- a/src/main/java/com/stripe/model/Dispute.java +++ b/src/main/java/com/stripe/model/Dispute.java @@ -45,8 +45,8 @@ public class Dispute extends ApiResource Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -71,8 +71,8 @@ public class Dispute extends ApiResource Boolean isChargeRefundable; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -92,7 +92,7 @@ public class Dispute extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `dispute`. + *

Equal to {@code dispute}. */ @SerializedName("object") String object; @@ -104,27 +104,29 @@ public class Dispute extends ApiResource ExpandableField paymentIntent; /** - * Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, - * `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, - * `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, - * `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. - * Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). + * Reason given by cardholder for dispute. Possible values are {@code bank_cannot_process}, {@code + * check_returned}, {@code credit_not_processed}, {@code customer_initiated}, {@code + * debit_not_authorized}, {@code duplicate}, {@code fraudulent}, {@code general}, {@code + * incorrect_account_details}, {@code insufficient_funds}, {@code product_not_received}, {@code + * product_unacceptable}, {@code subscription_canceled}, or {@code unrecognized}. Read more about + * dispute reasons. */ @SerializedName("reason") String reason; /** - * Current status of dispute. Possible values are `warning_needs_response`, - * `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, - * `won`, or `lost`. + * Current status of dispute. Possible values are {@code warning_needs_response}, {@code + * warning_under_review}, {@code warning_closed}, {@code needs_response}, {@code under_review}, + * {@code charge_refunded}, {@code won}, or {@code lost}. * - *

One of `charge_refunded`, `lost`, `needs_response`, `under_review`, `warning_closed`, - * `warning_needs_response`, `warning_under_review`, or `won`. + *

One of {@code charge_refunded}, {@code lost}, {@code needs_response}, {@code under_review}, + * {@code warning_closed}, {@code warning_needs_response}, {@code warning_under_review}, or {@code + * won}. */ @SerializedName("status") String status; - /** Get id of expandable `charge` object. */ + /** Get ID of expandable {@code charge} object. */ public String getCharge() { return (this.charge != null) ? this.charge.getId() : null; } @@ -133,7 +135,7 @@ public void setCharge(String id) { this.charge = ApiResource.setExpandableFieldId(id, this.charge); } - /** Get expanded `charge`. */ + /** Get expanded {@code charge}. */ public Charge getChargeObject() { return (this.charge != null) ? this.charge.getExpanded() : null; } @@ -142,7 +144,7 @@ public void setChargeObject(Charge expandableObject) { this.charge = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `paymentIntent` object. */ + /** Get ID of expandable {@code paymentIntent} object. */ public String getPaymentIntent() { return (this.paymentIntent != null) ? this.paymentIntent.getId() : null; } @@ -151,7 +153,7 @@ public void setPaymentIntent(String id) { this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent); } - /** Get expanded `paymentIntent`. */ + /** Get expanded {@code paymentIntent}. */ public PaymentIntent getPaymentIntentObject() { return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null; } @@ -225,7 +227,7 @@ public static Dispute retrieve( * *

Depending on your dispute type, different evidence fields will give you a better chance of * winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types. + * href="https://stripe.com/docs/disputes/categories">guide to dispute types. */ @Override public Dispute update(Map params) throws StripeException { @@ -240,7 +242,7 @@ public Dispute update(Map params) throws StripeException { * *

Depending on your dispute type, different evidence fields will give you a better chance of * winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types. + * href="https://stripe.com/docs/disputes/categories">guide to dispute types. */ @Override public Dispute update(Map params, RequestOptions options) throws StripeException { @@ -260,7 +262,7 @@ public Dispute update(Map params, RequestOptions options) throws * *

Depending on your dispute type, different evidence fields will give you a better chance of * winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types. + * href="https://stripe.com/docs/disputes/categories">guide to dispute types. */ public Dispute update(DisputeUpdateParams params) throws StripeException { return update(params, (RequestOptions) null); @@ -274,7 +276,7 @@ public Dispute update(DisputeUpdateParams params) throws StripeException { * *

Depending on your dispute type, different evidence fields will give you a better chance of * winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types. + * href="https://stripe.com/docs/disputes/categories">guide to dispute types. */ public Dispute update(DisputeUpdateParams params, RequestOptions options) throws StripeException { String url = @@ -378,8 +380,8 @@ public static class Evidence extends StripeObject { String billingAddress; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription - * cancellation policy, as shown to the customer. + * (ID of a file upload) Your + * subscription cancellation policy, as shown to the customer. */ @SerializedName("cancellation_policy") @Getter(lombok.AccessLevel.NONE) @@ -397,10 +399,10 @@ public static class Evidence extends StripeObject { String cancellationRebuttal; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with - * the customer that you feel is relevant to your case. Examples include emails proving that the - * customer received the product or service, or demonstrating their use of or satisfaction with - * the product or service. + * (ID of a file upload) Any + * communication with the customer that you feel is relevant to your case. Examples include + * emails proving that the customer received the product or service, or demonstrating their use + * of or satisfaction with the product or service. */ @SerializedName("customer_communication") @Getter(lombok.AccessLevel.NONE) @@ -420,8 +422,8 @@ public static class Evidence extends StripeObject { String customerPurchaseIp; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or - * contract showing the customer's signature. + * (ID of a file upload) A relevant + * document or contract showing the customer's signature. */ @SerializedName("customer_signature") @Getter(lombok.AccessLevel.NONE) @@ -429,10 +431,10 @@ public static class Evidence extends StripeObject { ExpandableField customerSignature; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the - * prior charge that can uniquely identify the charge, such as a receipt, shipping label, work - * order, etc. This document should be paired with a similar document from the disputed payment - * that proves the two payments are separate. + * (ID of a file upload) Documentation + * for the prior charge that can uniquely identify the charge, such as a receipt, shipping + * label, work order, etc. This document should be paired with a similar document from the + * disputed payment that proves the two payments are separate. */ @SerializedName("duplicate_charge_documentation") @Getter(lombok.AccessLevel.NONE) @@ -457,8 +459,8 @@ public static class Evidence extends StripeObject { String productDescription; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message - * sent to the customer notifying them of the charge. + * (ID of a file upload) Any receipt or + * message sent to the customer notifying them of the charge. */ @SerializedName("receipt") @Getter(lombok.AccessLevel.NONE) @@ -466,8 +468,8 @@ public static class Evidence extends StripeObject { ExpandableField receipt; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as - * shown to the customer. + * (ID of a file upload) Your refund + * policy, as shown to the customer. */ @SerializedName("refund_policy") @Getter(lombok.AccessLevel.NONE) @@ -492,9 +494,9 @@ public static class Evidence extends StripeObject { String serviceDate; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a service was provided to the customer. This could include a copy of a signed - * contract, work order, or other form of written agreement. + * (ID of a file upload) Documentation + * showing proof that a service was provided to the customer. This could include a copy of a + * signed contract, work order, or other form of written agreement. */ @SerializedName("service_documentation") @Getter(lombok.AccessLevel.NONE) @@ -523,10 +525,10 @@ public static class Evidence extends StripeObject { String shippingDate; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a product was shipped to the customer at the same address the customer provided to - * you. This could include a copy of the shipment receipt, shipping label, etc. It should show - * the customer's full shipping address, if possible. + * (ID of a file upload) Documentation + * showing proof that a product was shipped to the customer at the same address the customer + * provided to you. This could include a copy of the shipment receipt, shipping label, etc. It + * should show the customer's full shipping address, if possible. */ @SerializedName("shipping_documentation") @Getter(lombok.AccessLevel.NONE) @@ -541,8 +543,8 @@ public static class Evidence extends StripeObject { String shippingTrackingNumber; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence - * or statements. + * (ID of a file upload) Any additional + * evidence or statements. */ @SerializedName("uncategorized_file") @Getter(lombok.AccessLevel.NONE) @@ -553,7 +555,7 @@ public static class Evidence extends StripeObject { @SerializedName("uncategorized_text") String uncategorizedText; - /** Get id of expandable `cancellationPolicy` object. */ + /** Get ID of expandable {@code cancellationPolicy} object. */ public String getCancellationPolicy() { return (this.cancellationPolicy != null) ? this.cancellationPolicy.getId() : null; } @@ -562,7 +564,7 @@ public void setCancellationPolicy(String id) { this.cancellationPolicy = ApiResource.setExpandableFieldId(id, this.cancellationPolicy); } - /** Get expanded `cancellationPolicy`. */ + /** Get expanded {@code cancellationPolicy}. */ public File getCancellationPolicyObject() { return (this.cancellationPolicy != null) ? this.cancellationPolicy.getExpanded() : null; } @@ -572,7 +574,7 @@ public void setCancellationPolicyObject(File expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customerCommunication` object. */ + /** Get ID of expandable {@code customerCommunication} object. */ public String getCustomerCommunication() { return (this.customerCommunication != null) ? this.customerCommunication.getId() : null; } @@ -581,7 +583,7 @@ public void setCustomerCommunication(String id) { this.customerCommunication = ApiResource.setExpandableFieldId(id, this.customerCommunication); } - /** Get expanded `customerCommunication`. */ + /** Get expanded {@code customerCommunication}. */ public File getCustomerCommunicationObject() { return (this.customerCommunication != null) ? this.customerCommunication.getExpanded() : null; } @@ -591,7 +593,7 @@ public void setCustomerCommunicationObject(File expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customerSignature` object. */ + /** Get ID of expandable {@code customerSignature} object. */ public String getCustomerSignature() { return (this.customerSignature != null) ? this.customerSignature.getId() : null; } @@ -600,7 +602,7 @@ public void setCustomerSignature(String id) { this.customerSignature = ApiResource.setExpandableFieldId(id, this.customerSignature); } - /** Get expanded `customerSignature`. */ + /** Get expanded {@code customerSignature}. */ public File getCustomerSignatureObject() { return (this.customerSignature != null) ? this.customerSignature.getExpanded() : null; } @@ -610,7 +612,7 @@ public void setCustomerSignatureObject(File expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `duplicateChargeDocumentation` object. */ + /** Get ID of expandable {@code duplicateChargeDocumentation} object. */ public String getDuplicateChargeDocumentation() { return (this.duplicateChargeDocumentation != null) ? this.duplicateChargeDocumentation.getId() @@ -622,7 +624,7 @@ public void setDuplicateChargeDocumentation(String id) { ApiResource.setExpandableFieldId(id, this.duplicateChargeDocumentation); } - /** Get expanded `duplicateChargeDocumentation`. */ + /** Get expanded {@code duplicateChargeDocumentation}. */ public File getDuplicateChargeDocumentationObject() { return (this.duplicateChargeDocumentation != null) ? this.duplicateChargeDocumentation.getExpanded() @@ -634,7 +636,7 @@ public void setDuplicateChargeDocumentationObject(File expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `receipt` object. */ + /** Get ID of expandable {@code receipt} object. */ public String getReceipt() { return (this.receipt != null) ? this.receipt.getId() : null; } @@ -643,7 +645,7 @@ public void setReceipt(String id) { this.receipt = ApiResource.setExpandableFieldId(id, this.receipt); } - /** Get expanded `receipt`. */ + /** Get expanded {@code receipt}. */ public File getReceiptObject() { return (this.receipt != null) ? this.receipt.getExpanded() : null; } @@ -652,7 +654,7 @@ public void setReceiptObject(File expandableObject) { this.receipt = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `refundPolicy` object. */ + /** Get ID of expandable {@code refundPolicy} object. */ public String getRefundPolicy() { return (this.refundPolicy != null) ? this.refundPolicy.getId() : null; } @@ -661,7 +663,7 @@ public void setRefundPolicy(String id) { this.refundPolicy = ApiResource.setExpandableFieldId(id, this.refundPolicy); } - /** Get expanded `refundPolicy`. */ + /** Get expanded {@code refundPolicy}. */ public File getRefundPolicyObject() { return (this.refundPolicy != null) ? this.refundPolicy.getExpanded() : null; } @@ -670,7 +672,7 @@ public void setRefundPolicyObject(File expandableObject) { this.refundPolicy = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `serviceDocumentation` object. */ + /** Get ID of expandable {@code serviceDocumentation} object. */ public String getServiceDocumentation() { return (this.serviceDocumentation != null) ? this.serviceDocumentation.getId() : null; } @@ -679,7 +681,7 @@ public void setServiceDocumentation(String id) { this.serviceDocumentation = ApiResource.setExpandableFieldId(id, this.serviceDocumentation); } - /** Get expanded `serviceDocumentation`. */ + /** Get expanded {@code serviceDocumentation}. */ public File getServiceDocumentationObject() { return (this.serviceDocumentation != null) ? this.serviceDocumentation.getExpanded() : null; } @@ -689,7 +691,7 @@ public void setServiceDocumentationObject(File expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `shippingDocumentation` object. */ + /** Get ID of expandable {@code shippingDocumentation} object. */ public String getShippingDocumentation() { return (this.shippingDocumentation != null) ? this.shippingDocumentation.getId() : null; } @@ -698,7 +700,7 @@ public void setShippingDocumentation(String id) { this.shippingDocumentation = ApiResource.setExpandableFieldId(id, this.shippingDocumentation); } - /** Get expanded `shippingDocumentation`. */ + /** Get expanded {@code shippingDocumentation}. */ public File getShippingDocumentationObject() { return (this.shippingDocumentation != null) ? this.shippingDocumentation.getExpanded() : null; } @@ -708,7 +710,7 @@ public void setShippingDocumentationObject(File expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `uncategorizedFile` object. */ + /** Get ID of expandable {@code uncategorizedFile} object. */ public String getUncategorizedFile() { return (this.uncategorizedFile != null) ? this.uncategorizedFile.getId() : null; } @@ -717,7 +719,7 @@ public void setUncategorizedFile(String id) { this.uncategorizedFile = ApiResource.setExpandableFieldId(id, this.uncategorizedFile); } - /** Get expanded `uncategorizedFile`. */ + /** Get expanded {@code uncategorizedFile}. */ public File getUncategorizedFileObject() { return (this.uncategorizedFile != null) ? this.uncategorizedFile.getExpanded() : null; } @@ -745,9 +747,9 @@ public static class EvidenceDetails extends StripeObject { Boolean hasEvidence; /** - * Whether the last evidence submission was submitted past the due date. Defaults to `false` if - * no evidence submissions have occurred. If `true`, then delivery of the latest evidence is - * *not* guaranteed. + * Whether the last evidence submission was submitted past the due date. Defaults to {@code + * false} if no evidence submissions have occurred. If {@code true}, then delivery of the latest + * evidence is not guaranteed. */ @SerializedName("past_due") Boolean pastDue; diff --git a/src/main/java/com/stripe/model/Event.java b/src/main/java/com/stripe/model/Event.java index 65e6de573e3..e9714bb71c8 100644 --- a/src/main/java/com/stripe/model/Event.java +++ b/src/main/java/com/stripe/model/Event.java @@ -21,8 +21,8 @@ public class Event extends ApiResource implements HasId { String account; /** - * The Stripe API version used to render `data`. *Note: This property is populated only for events - * on or after October 31, 2014*. + * The Stripe API version used to render {@code data}. Note: This property is populated only + * for events on or after October 31, 2014. */ @SerializedName("api_version") String apiVersion; @@ -40,8 +40,8 @@ public class Event extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -49,7 +49,7 @@ public class Event extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `event`. + *

Equal to {@code event}. */ @SerializedName("object") String object; @@ -65,15 +65,16 @@ public class Event extends ApiResource implements HasId { @SerializedName("request") EventRequest request; - /** Description of the event (e.g., `invoice.created` or `charge.refunded`). */ + /** Description of the event (e.g., {@code invoice.created} or {@code charge.refunded}). */ @SerializedName("type") String type; /** * List events, going back up to 30 days. Each event data is rendered according to Stripe API - * version at its creation time, specified in event object - * api_version attribute (not according to your current Stripe API version or - * Stripe-Version header). + * version at its creation time, specified in event object api_version + * attribute (not according to your current Stripe API version or Stripe-Version + * header). */ public static EventCollection list(Map params) throws StripeException { return list(params, (RequestOptions) null); @@ -81,9 +82,10 @@ public static EventCollection list(Map params) throws StripeExce /** * List events, going back up to 30 days. Each event data is rendered according to Stripe API - * version at its creation time, specified in event object - * api_version attribute (not according to your current Stripe API version or - * Stripe-Version header). + * version at its creation time, specified in event object api_version + * attribute (not according to your current Stripe API version or Stripe-Version + * header). */ public static EventCollection list(Map params, RequestOptions options) throws StripeException { @@ -93,9 +95,10 @@ public static EventCollection list(Map params, RequestOptions op /** * List events, going back up to 30 days. Each event data is rendered according to Stripe API - * version at its creation time, specified in event object - * api_version attribute (not according to your current Stripe API version or - * Stripe-Version header). + * version at its creation time, specified in event object api_version + * attribute (not according to your current Stripe API version or Stripe-Version + * header). */ public static EventCollection list(EventListParams params) throws StripeException { return list(params, (RequestOptions) null); @@ -103,9 +106,10 @@ public static EventCollection list(EventListParams params) throws StripeExceptio /** * List events, going back up to 30 days. Each event data is rendered according to Stripe API - * version at its creation time, specified in event object - * api_version attribute (not according to your current Stripe API version or - * Stripe-Version header). + * version at its creation time, specified in event object api_version + * attribute (not according to your current Stripe API version or Stripe-Version + * header). */ public static EventCollection list(EventListParams params, RequestOptions options) throws StripeException { diff --git a/src/main/java/com/stripe/model/EventRequest.java b/src/main/java/com/stripe/model/EventRequest.java index b6d01164db4..306faeb6582 100644 --- a/src/main/java/com/stripe/model/EventRequest.java +++ b/src/main/java/com/stripe/model/EventRequest.java @@ -11,16 +11,16 @@ public class EventRequest extends StripeObject implements HasId { /** * ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's - * automatic subscription handling). Request logs are available in the - * [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. + * automatic subscription handling). Request logs are available in the dashboard, but currently not in the API. */ @Getter(onMethod_ = {@Override}) @SerializedName("id") String id; /** - * The idempotency key transmitted during the request, if any. *Note: This property is populated - * only for events on or after May 23, 2017*. + * The idempotency key transmitted during the request, if any. Note: This property is + * populated only for events on or after May 23, 2017. */ @SerializedName("idempotency_key") String idempotencyKey; diff --git a/src/main/java/com/stripe/model/ExchangeRate.java b/src/main/java/com/stripe/model/ExchangeRate.java index a5992dca08e..bb2f7e3383e 100644 --- a/src/main/java/com/stripe/model/ExchangeRate.java +++ b/src/main/java/com/stripe/model/ExchangeRate.java @@ -18,8 +18,8 @@ @EqualsAndHashCode(callSuper = false) public class ExchangeRate extends ApiResource implements HasId { /** - * Unique identifier for the object. Represented as the three-letter [ISO currency - * code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. + * Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase. */ @Getter(onMethod_ = {@Override}) @SerializedName("id") @@ -28,7 +28,7 @@ public class ExchangeRate extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `exchange_rate`. + *

Equal to {@code exchange_rate}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/FeeRefund.java b/src/main/java/com/stripe/model/FeeRefund.java index 6f573737891..25ddc5ae982 100644 --- a/src/main/java/com/stripe/model/FeeRefund.java +++ b/src/main/java/com/stripe/model/FeeRefund.java @@ -31,8 +31,8 @@ public class FeeRefund extends ApiResource Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -59,12 +59,12 @@ public class FeeRefund extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `fee_refund`. + *

Equal to {@code fee_refund}. */ @SerializedName("object") String object; - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -73,7 +73,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -83,7 +83,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `fee` object. */ + /** Get ID of expandable {@code fee} object. */ public String getFee() { return (this.fee != null) ? this.fee.getId() : null; } @@ -92,7 +92,7 @@ public void setFee(String id) { this.fee = ApiResource.setExpandableFieldId(id, this.fee); } - /** Get expanded `fee`. */ + /** Get expanded {@code fee}. */ public ApplicationFee getFeeObject() { return (this.fee != null) ? this.fee.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/FileLink.java b/src/main/java/com/stripe/model/FileLink.java index f63aa3464f2..087ff0862de 100644 --- a/src/main/java/com/stripe/model/FileLink.java +++ b/src/main/java/com/stripe/model/FileLink.java @@ -42,8 +42,8 @@ public class FileLink extends ApiResource implements HasId, MetadataStoreEqual to `file_link`. + *

Equal to {@code file_link}. */ @SerializedName("object") String object; @@ -68,7 +68,7 @@ public class FileLink extends ApiResource implements HasId, MetadataStoreautomatic collection + * of the invoice. When {@code false}, the invoice's state will not automatically advance without + * an explicit action. */ @SerializedName("auto_advance") Boolean autoAdvance; /** - * Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice - * created by a subscription advancing into a new period. `subscription_create` indicates an - * invoice created due to creating a subscription. `subscription_update` indicates an invoice - * created due to updating a subscription. `subscription` is set for all old invoices to indicate - * either a change to a subscription or a period advancement. `manual` is set for all invoices - * unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value - * is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` - * indicates an invoice created due to a billing threshold being reached. + * Indicates the reason why the invoice was created. {@code subscription_cycle} indicates an + * invoice created by a subscription advancing into a new period. {@code subscription_create} + * indicates an invoice created due to creating a subscription. {@code subscription_update} + * indicates an invoice created due to updating a subscription. {@code subscription} is set for + * all old invoices to indicate either a change to a subscription or a period advancement. {@code + * manual} is set for all invoices unrelated to a subscription (for example: created via the + * invoice editor). The {@code upcoming} value is reserved for simulated invoices per the upcoming + * invoice endpoint. {@code subscription_threshold} indicates an invoice created due to a billing + * threshold being reached. * - *

One of `automatic_pending_invoice_item_invoice`, `manual`, `subscription`, - * `subscription_create`, `subscription_cycle`, `subscription_threshold`, `subscription_update`, - * or `upcoming`. + *

One of {@code automatic_pending_invoice_item_invoice}, {@code manual}, {@code subscription}, + * {@code subscription_create}, {@code subscription_cycle}, {@code subscription_threshold}, {@code + * subscription_update}, or {@code upcoming}. */ @SerializedName("billing_reason") String billingReason; @@ -114,11 +117,11 @@ public class Invoice extends ApiResource implements HasId, MetadataStore charge; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay this invoice using the default source attached to the customer. When sending an - * invoice, Stripe will email this invoice to the customer with payment instructions. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay this invoice using the default source attached to the customer. When + * sending an invoice, Stripe will email this invoice to the customer with payment instructions. * - *

One of `charge_automatically`, or `send_invoice`. + *

One of {@code charge_automatically}, or {@code send_invoice}. */ @SerializedName("collection_method") String collectionMethod; @@ -128,8 +131,8 @@ public class Invoice extends ApiResource implements HasId, MetadataStoreISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -145,52 +148,53 @@ public class Invoice extends ApiResource implements HasId, MetadataStore customer; /** - * The customer's address. Until the invoice is finalized, this field will equal - * `customer.address`. Once the invoice is finalized, this field will no longer be updated. + * The customer's address. Until the invoice is finalized, this field will equal {@code + * customer.address}. Once the invoice is finalized, this field will no longer be updated. */ @SerializedName("customer_address") Address customerAddress; /** - * The customer's email. Until the invoice is finalized, this field will equal `customer.email`. - * Once the invoice is finalized, this field will no longer be updated. + * The customer's email. Until the invoice is finalized, this field will equal {@code + * customer.email}. Once the invoice is finalized, this field will no longer be updated. */ @SerializedName("customer_email") String customerEmail; /** - * The customer's name. Until the invoice is finalized, this field will equal `customer.name`. - * Once the invoice is finalized, this field will no longer be updated. + * The customer's name. Until the invoice is finalized, this field will equal {@code + * customer.name}. Once the invoice is finalized, this field will no longer be updated. */ @SerializedName("customer_name") String customerName; /** - * The customer's phone number. Until the invoice is finalized, this field will equal - * `customer.phone`. Once the invoice is finalized, this field will no longer be updated. + * The customer's phone number. Until the invoice is finalized, this field will equal {@code + * customer.phone}. Once the invoice is finalized, this field will no longer be updated. */ @SerializedName("customer_phone") String customerPhone; /** * The customer's shipping information. Until the invoice is finalized, this field will equal - * `customer.shipping`. Once the invoice is finalized, this field will no longer be updated. + * {@code customer.shipping}. Once the invoice is finalized, this field will no longer be updated. */ @SerializedName("customer_shipping") ShippingDetails customerShipping; /** - * The customer's tax exempt status. Until the invoice is finalized, this field will equal - * `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. + * The customer's tax exempt status. Until the invoice is finalized, this field will equal {@code + * customer.tax_exempt}. Once the invoice is finalized, this field will no longer be updated. * - *

One of `exempt`, `none`, or `reverse`. + *

One of {@code exempt}, {@code none}, or {@code reverse}. */ @SerializedName("customer_tax_exempt") String customerTaxExempt; /** * The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax - * IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. + * IDs as {@code customer.tax_ids}. Once the invoice is finalized, this field will no longer be + * updated. */ @SerializedName("customer_tax_ids") List customerTaxIds; @@ -235,8 +239,8 @@ public class Invoice extends ApiResource implements HasId, MetadataStore metadata; /** - * The time at which payment will next be attempted. This value will be `null` for invoices where - * `collection_method=send_invoice`. + * The time at which payment will next be attempted. This value will be {@code null} for invoices + * where {@code collection_method=send_invoice}. */ @SerializedName("next_payment_attempt") Long nextPaymentAttempt; @@ -311,7 +315,7 @@ public class Invoice extends ApiResource implements HasId, MetadataStoreEqual to `invoice`. + *

Equal to {@code invoice}. */ @SerializedName("object") String object; @@ -365,8 +369,9 @@ public class Invoice extends ApiResource implements HasId, MetadataStoreLearn more */ @SerializedName("status") String status; @@ -399,8 +404,8 @@ public class Invoice extends ApiResource implements HasId, MetadataStore(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -458,7 +463,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -467,7 +472,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `defaultPaymentMethod` object. */ + /** Get ID of expandable {@code defaultPaymentMethod} object. */ public String getDefaultPaymentMethod() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getId() : null; } @@ -476,7 +481,7 @@ public void setDefaultPaymentMethod(String id) { this.defaultPaymentMethod = ApiResource.setExpandableFieldId(id, this.defaultPaymentMethod); } - /** Get expanded `defaultPaymentMethod`. */ + /** Get expanded {@code defaultPaymentMethod}. */ public PaymentMethod getDefaultPaymentMethodObject() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getExpanded() : null; } @@ -486,7 +491,7 @@ public void setDefaultPaymentMethodObject(PaymentMethod expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `defaultSource` object. */ + /** Get ID of expandable {@code defaultSource} object. */ public String getDefaultSource() { return (this.defaultSource != null) ? this.defaultSource.getId() : null; } @@ -495,7 +500,7 @@ public void setDefaultSource(String id) { this.defaultSource = ApiResource.setExpandableFieldId(id, this.defaultSource); } - /** Get expanded `defaultSource`. */ + /** Get expanded {@code defaultSource}. */ public PaymentSource getDefaultSourceObject() { return (this.defaultSource != null) ? this.defaultSource.getExpanded() : null; } @@ -505,7 +510,7 @@ public void setDefaultSourceObject(PaymentSource expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `paymentIntent` object. */ + /** Get ID of expandable {@code paymentIntent} object. */ public String getPaymentIntent() { return (this.paymentIntent != null) ? this.paymentIntent.getId() : null; } @@ -514,7 +519,7 @@ public void setPaymentIntent(String id) { this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent); } - /** Get expanded `paymentIntent`. */ + /** Get expanded {@code paymentIntent}. */ public PaymentIntent getPaymentIntentObject() { return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null; } @@ -524,7 +529,7 @@ public void setPaymentIntentObject(PaymentIntent expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `subscription` object. */ + /** Get ID of expandable {@code subscription} object. */ public String getSubscription() { return (this.subscription != null) ? this.subscription.getId() : null; } @@ -533,7 +538,7 @@ public void setSubscription(String id) { this.subscription = ApiResource.setExpandableFieldId(id, this.subscription); } - /** Get expanded `subscription`. */ + /** Get expanded {@code subscription}. */ public Subscription getSubscriptionObject() { return (this.subscription != null) ? this.subscription.getExpanded() : null; } @@ -773,13 +778,13 @@ public static Invoice retrieve( /** * Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as - * collection_method, become uneditable. + * href="https://stripe.com/docs/billing/invoices/workflow#finalized">finalized, monetary + * values, as well as collection_method, become uneditable. * *

If you would like to stop the Stripe Billing engine from automatically finalizing, * reattempting payments on, sending reminders for, or automatically reconciling invoices, pass - * auto_advance=false. + * href="https://stripe.com/docs/billing/invoices/reconciliation">automatically reconciling + * invoices, pass auto_advance=false. */ @Override public Invoice update(Map params) throws StripeException { @@ -788,13 +793,13 @@ public Invoice update(Map params) throws StripeException { /** * Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as - * collection_method, become uneditable. + * href="https://stripe.com/docs/billing/invoices/workflow#finalized">finalized, monetary + * values, as well as collection_method, become uneditable. * *

If you would like to stop the Stripe Billing engine from automatically finalizing, * reattempting payments on, sending reminders for, or automatically reconciling invoices, pass - * auto_advance=false. + * href="https://stripe.com/docs/billing/invoices/reconciliation">automatically reconciling + * invoices, pass auto_advance=false. */ @Override public Invoice update(Map params, RequestOptions options) throws StripeException { @@ -808,13 +813,13 @@ public Invoice update(Map params, RequestOptions options) throws /** * Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as - * collection_method, become uneditable. + * href="https://stripe.com/docs/billing/invoices/workflow#finalized">finalized, monetary + * values, as well as collection_method, become uneditable. * *

If you would like to stop the Stripe Billing engine from automatically finalizing, * reattempting payments on, sending reminders for, or automatically reconciling invoices, pass - * auto_advance=false. + * href="https://stripe.com/docs/billing/invoices/reconciliation">automatically reconciling + * invoices, pass auto_advance=false. */ public Invoice update(InvoiceUpdateParams params) throws StripeException { return update(params, (RequestOptions) null); @@ -822,13 +827,13 @@ public Invoice update(InvoiceUpdateParams params) throws StripeException { /** * Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as - * collection_method, become uneditable. + * href="https://stripe.com/docs/billing/invoices/workflow#finalized">finalized, monetary + * values, as well as collection_method, become uneditable. * *

If you would like to stop the Stripe Billing engine from automatically finalizing, * reattempting payments on, sending reminders for, or automatically reconciling invoices, pass - * auto_advance=false. + * href="https://stripe.com/docs/billing/invoices/reconciliation">automatically reconciling + * invoices, pass auto_advance=false. */ public Invoice update(InvoiceUpdateParams params, RequestOptions options) throws StripeException { String url = @@ -842,7 +847,7 @@ public Invoice update(InvoiceUpdateParams params, RequestOptions options) throws /** * Permanently deletes a draft invoice. This cannot be undone. Attempts to delete invoices that * are no longer in a draft state will fail; once an invoice has been finalized, it must be voided. + * href="https://stripe.com/docs/api#void_invoice">voided. */ public Invoice delete() throws StripeException { return delete((Map) null, (RequestOptions) null); @@ -851,7 +856,7 @@ public Invoice delete() throws StripeException { /** * Permanently deletes a draft invoice. This cannot be undone. Attempts to delete invoices that * are no longer in a draft state will fail; once an invoice has been finalized, it must be voided. + * href="https://stripe.com/docs/api#void_invoice">voided. */ public Invoice delete(RequestOptions options) throws StripeException { return delete((Map) null, options); @@ -860,7 +865,7 @@ public Invoice delete(RequestOptions options) throws StripeException { /** * Permanently deletes a draft invoice. This cannot be undone. Attempts to delete invoices that * are no longer in a draft state will fail; once an invoice has been finalized, it must be voided. + * href="https://stripe.com/docs/api#void_invoice">voided. */ public Invoice delete(Map params) throws StripeException { return delete(params, (RequestOptions) null); @@ -869,7 +874,7 @@ public Invoice delete(Map params) throws StripeException { /** * Permanently deletes a draft invoice. This cannot be undone. Attempts to delete invoices that * are no longer in a draft state will fail; once an invoice has been finalized, it must be voided. + * href="https://stripe.com/docs/api#void_invoice">voided. */ public Invoice delete(Map params, RequestOptions options) throws StripeException { String url = @@ -1177,8 +1182,8 @@ public Invoice markUncollectible(InvoiceMarkUncollectibleParams params, RequestO /** * Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and - * maintains a papertrail where the invoice can still be found. + * href="https://stripe.com/docs/api#delete_invoice">deletion, however it only applies to + * finalized invoices and maintains a papertrail where the invoice can still be found. */ public Invoice voidInvoice() throws StripeException { return voidInvoice((Map) null, (RequestOptions) null); @@ -1186,8 +1191,8 @@ public Invoice voidInvoice() throws StripeException { /** * Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and - * maintains a papertrail where the invoice can still be found. + * href="https://stripe.com/docs/api#delete_invoice">deletion, however it only applies to + * finalized invoices and maintains a papertrail where the invoice can still be found. */ public Invoice voidInvoice(RequestOptions options) throws StripeException { return voidInvoice((Map) null, options); @@ -1195,8 +1200,8 @@ public Invoice voidInvoice(RequestOptions options) throws StripeException { /** * Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and - * maintains a papertrail where the invoice can still be found. + * href="https://stripe.com/docs/api#delete_invoice">deletion, however it only applies to + * finalized invoices and maintains a papertrail where the invoice can still be found. */ public Invoice voidInvoice(Map params) throws StripeException { return voidInvoice(params, (RequestOptions) null); @@ -1204,8 +1209,8 @@ public Invoice voidInvoice(Map params) throws StripeException { /** * Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and - * maintains a papertrail where the invoice can still be found. + * href="https://stripe.com/docs/api#delete_invoice">deletion, however it only applies to + * finalized invoices and maintains a papertrail where the invoice can still be found. */ public Invoice voidInvoice(Map params, RequestOptions options) throws StripeException { @@ -1219,8 +1224,8 @@ public Invoice voidInvoice(Map params, RequestOptions options) /** * Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and - * maintains a papertrail where the invoice can still be found. + * href="https://stripe.com/docs/api#delete_invoice">deletion, however it only applies to + * finalized invoices and maintains a papertrail where the invoice can still be found. */ public Invoice voidInvoice(InvoiceVoidInvoiceParams params) throws StripeException { return voidInvoice(params, (RequestOptions) null); @@ -1228,8 +1233,8 @@ public Invoice voidInvoice(InvoiceVoidInvoiceParams params) throws StripeExcepti /** * Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and - * maintains a papertrail where the invoice can still be found. + * href="https://stripe.com/docs/api#delete_invoice">deletion, however it only applies to + * finalized invoices and maintains a papertrail where the invoice can still be found. */ public Invoice voidInvoice(InvoiceVoidInvoiceParams params, RequestOptions options) throws StripeException { @@ -1259,9 +1264,11 @@ public static class CustomField extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class CustomerTaxId extends StripeObject { /** - * The type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, - * `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, - * `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, or `unknown`. + * The type of the tax ID, one of {@code eu_vat}, {@code nz_gst}, {@code au_abn}, {@code + * in_gst}, {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc}, {@code sg_uen}, + * {@code ru_inn}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat}, {@code th_vat}, + * {@code jp_cn}, {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn}, {@code + * ca_qst}, or {@code unknown}. */ @SerializedName("type") String type; @@ -1310,7 +1317,7 @@ public static class TaxAmount extends StripeObject { @Setter(lombok.AccessLevel.NONE) ExpandableField taxRate; - /** Get id of expandable `taxRate` object. */ + /** Get ID of expandable {@code taxRate} object. */ public String getTaxRate() { return (this.taxRate != null) ? this.taxRate.getId() : null; } @@ -1319,7 +1326,7 @@ public void setTaxRate(String id) { this.taxRate = ApiResource.setExpandableFieldId(id, this.taxRate); } - /** Get expanded `taxRate`. */ + /** Get expanded {@code taxRate}. */ public TaxRate getTaxRateObject() { return (this.taxRate != null) ? this.taxRate.getExpanded() : null; } @@ -1368,7 +1375,7 @@ public static class TransferData extends StripeObject { @Setter(lombok.AccessLevel.NONE) ExpandableField destination; - /** Get id of expandable `destination` object. */ + /** Get ID of expandable {@code destination} object. */ public String getDestination() { return (this.destination != null) ? this.destination.getId() : null; } @@ -1377,7 +1384,7 @@ public void setDestination(String id) { this.destination = ApiResource.setExpandableFieldId(id, this.destination); } - /** Get expanded `destination`. */ + /** Get expanded {@code destination}. */ public Account getDestinationObject() { return (this.destination != null) ? this.destination.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/InvoiceItem.java b/src/main/java/com/stripe/model/InvoiceItem.java index bdf7df425a2..cbefe02681a 100644 --- a/src/main/java/com/stripe/model/InvoiceItem.java +++ b/src/main/java/com/stripe/model/InvoiceItem.java @@ -21,15 +21,15 @@ @EqualsAndHashCode(callSuper = false) public class InvoiceItem extends ApiResource implements HasId, MetadataStore { /** - * Amount (in the `currency` specified) of the invoice item. This should always be equal to - * `unit_amount * quantity`. + * Amount (in the {@code currency} specified) of the invoice item. This should always be equal to + * {@code unit_amount * quantity}. */ @SerializedName("amount") Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -68,8 +68,8 @@ public class InvoiceItem extends ApiResource implements HasId, MetadataStore invoice; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -85,7 +85,7 @@ public class InvoiceItem extends ApiResource implements HasId, MetadataStoreEqual to `invoiceitem`. + *

Equal to {@code invoiceitem}. */ @SerializedName("object") String object; @@ -125,8 +125,8 @@ public class InvoiceItem extends ApiResource implements HasId, MetadataStore taxRates; @@ -138,15 +138,15 @@ public class InvoiceItem extends ApiResource implements HasId, MetadataStore(expandableObject.getId(), expandableObject); } - /** Get id of expandable `invoice` object. */ + /** Get ID of expandable {@code invoice} object. */ public String getInvoice() { return (this.invoice != null) ? this.invoice.getId() : null; } @@ -173,7 +173,7 @@ public void setInvoice(String id) { this.invoice = ApiResource.setExpandableFieldId(id, this.invoice); } - /** Get expanded `invoice`. */ + /** Get expanded {@code invoice}. */ public Invoice getInvoiceObject() { return (this.invoice != null) ? this.invoice.getExpanded() : null; } @@ -182,7 +182,7 @@ public void setInvoiceObject(Invoice expandableObject) { this.invoice = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `subscription` object. */ + /** Get ID of expandable {@code subscription} object. */ public String getSubscription() { return (this.subscription != null) ? this.subscription.getId() : null; } @@ -191,7 +191,7 @@ public void setSubscription(String id) { this.subscription = ApiResource.setExpandableFieldId(id, this.subscription); } - /** Get expanded `subscription`. */ + /** Get expanded {@code subscription}. */ public Subscription getSubscriptionObject() { return (this.subscription != null) ? this.subscription.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/InvoiceLineItem.java b/src/main/java/com/stripe/model/InvoiceLineItem.java index 916a05eed28..78364673e94 100644 --- a/src/main/java/com/stripe/model/InvoiceLineItem.java +++ b/src/main/java/com/stripe/model/InvoiceLineItem.java @@ -16,8 +16,8 @@ public class InvoiceLineItem extends StripeObject implements HasId { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -36,15 +36,15 @@ public class InvoiceLineItem extends StripeObject implements HasId { String id; /** - * The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this - * line item if any. + * The ID of the invoice item associated + * with this line item if any. */ @SerializedName("invoice_item") String invoiceItem; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -52,8 +52,8 @@ public class InvoiceLineItem extends StripeObject implements HasId { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Note that for line items with - * `type=subscription` this will reflect the metadata of the subscription that caused the line - * item to be created. + * {@code type=subscription} this will reflect the metadata of the subscription that caused the + * line item to be created. */ @SerializedName("metadata") Map metadata; @@ -61,7 +61,7 @@ public class InvoiceLineItem extends StripeObject implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `line_item`. + *

Equal to {@code line_item}. */ @SerializedName("object") String object; @@ -101,10 +101,10 @@ public class InvoiceLineItem extends StripeObject implements HasId { List taxRates; /** - * A string identifying the type of the source of this line item, either an `invoiceitem` or a - * `subscription`. + * A string identifying the type of the source of this line item, either an {@code invoiceitem} or + * a {@code subscription}. * - *

One of `invoiceitem`, or `subscription`. + *

One of {@code invoiceitem}, or {@code subscription}. */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/IssuerFraudRecord.java b/src/main/java/com/stripe/model/IssuerFraudRecord.java index d60c04aaf47..ca46c2baa8a 100644 --- a/src/main/java/com/stripe/model/IssuerFraudRecord.java +++ b/src/main/java/com/stripe/model/IssuerFraudRecord.java @@ -35,16 +35,16 @@ public class IssuerFraudRecord extends ApiResource implements HasId { Long created; /** - * The type of fraud labelled by the issuer. One of `card_never_received`, - * `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, - * `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. + * The type of fraud labelled by the issuer. One of {@code card_never_received}, {@code + * fraudulent_card_application}, {@code made_with_counterfeit_card}, {@code made_with_lost_card}, + * {@code made_with_stolen_card}, {@code misc}, {@code unauthorized_use_of_card}. */ @SerializedName("fraud_type") String fraudType; /** - * If true, the associated charge is subject to [liability - * shift](https://stripe.com/docs/sources/three-d-secure#disputed-payments). + * If true, the associated charge is subject to liability shift. */ @SerializedName("has_liability_shift") Boolean hasLiabilityShift; @@ -55,8 +55,8 @@ public class IssuerFraudRecord extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -64,7 +64,7 @@ public class IssuerFraudRecord extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `issuer_fraud_record`. + *

Equal to {@code issuer_fraud_record}. */ @SerializedName("object") String object; @@ -73,7 +73,7 @@ public class IssuerFraudRecord extends ApiResource implements HasId { @SerializedName("post_date") Long postDate; - /** Get id of expandable `charge` object. */ + /** Get ID of expandable {@code charge} object. */ public String getCharge() { return (this.charge != null) ? this.charge.getId() : null; } @@ -82,7 +82,7 @@ public void setCharge(String id) { this.charge = ApiResource.setExpandableFieldId(id, this.charge); } - /** Get expanded `charge`. */ + /** Get expanded {@code charge}. */ public Charge getChargeObject() { return (this.charge != null) ? this.charge.getExpanded() : null; } @@ -120,8 +120,8 @@ public static IssuerFraudRecordCollection list( /** * Retrieves the details of an issuer fraud record that has previously been created. * - *

Please refer to the issuer fraud record object - * reference for more details. + *

Please refer to the issuer + * fraud record object reference for more details. */ public static IssuerFraudRecord retrieve(String issuerFraudRecord) throws StripeException { return retrieve(issuerFraudRecord, (Map) null, (RequestOptions) null); @@ -130,8 +130,8 @@ public static IssuerFraudRecord retrieve(String issuerFraudRecord) throws Stripe /** * Retrieves the details of an issuer fraud record that has previously been created. * - *

Please refer to the issuer fraud record object - * reference for more details. + *

Please refer to the issuer + * fraud record object reference for more details. */ public static IssuerFraudRecord retrieve(String issuerFraudRecord, RequestOptions options) throws StripeException { @@ -141,8 +141,8 @@ public static IssuerFraudRecord retrieve(String issuerFraudRecord, RequestOption /** * Retrieves the details of an issuer fraud record that has previously been created. * - *

Please refer to the issuer fraud record object - * reference for more details. + *

Please refer to the issuer + * fraud record object reference for more details. */ public static IssuerFraudRecord retrieve( String issuerFraudRecord, Map params, RequestOptions options) @@ -160,8 +160,8 @@ public static IssuerFraudRecord retrieve( /** * Retrieves the details of an issuer fraud record that has previously been created. * - *

Please refer to the issuer fraud record object - * reference for more details. + *

Please refer to the issuer + * fraud record object reference for more details. */ public static IssuerFraudRecord retrieve( String issuerFraudRecord, IssuerFraudRecordRetrieveParams params, RequestOptions options) diff --git a/src/main/java/com/stripe/model/LoginLink.java b/src/main/java/com/stripe/model/LoginLink.java index 5bf41f92b5a..c8b8c1c5516 100644 --- a/src/main/java/com/stripe/model/LoginLink.java +++ b/src/main/java/com/stripe/model/LoginLink.java @@ -22,7 +22,7 @@ public class LoginLink extends ApiResource { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `login_link`. + *

Equal to {@code login_link}. */ @SerializedName("object") String object; @@ -34,8 +34,9 @@ public class LoginLink extends ApiResource { /** * Creates a single-use login link for an Express account to access their Stripe dashboard. * - *

You may only create login links for Express - * accounts connected to your platform. + *

You may only create login links for Express accounts connected to your + * platform. */ public static LoginLink createOnAccount( String account, Map params, RequestOptions options) throws StripeException { @@ -51,8 +52,9 @@ public static LoginLink createOnAccount( /** * Creates a single-use login link for an Express account to access their Stripe dashboard. * - *

You may only create login links for Express - * accounts connected to your platform. + *

You may only create login links for Express accounts connected to your + * platform. */ public static LoginLink createOnAccount( String account, LoginLinkCreateOnAccountParams params, RequestOptions options) diff --git a/src/main/java/com/stripe/model/Mandate.java b/src/main/java/com/stripe/model/Mandate.java index 2fe6041a0ff..0cf69d6ac37 100644 --- a/src/main/java/com/stripe/model/Mandate.java +++ b/src/main/java/com/stripe/model/Mandate.java @@ -24,8 +24,8 @@ public class Mandate extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -36,7 +36,7 @@ public class Mandate extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `mandate`. + *

Equal to {@code mandate}. */ @SerializedName("object") String object; @@ -54,17 +54,17 @@ public class Mandate extends ApiResource implements HasId { SingleUse singleUse; /** - * The status of the Mandate, one of `pending`, `inactive`, or `active`. The Mandate can be used - * to initiate a payment only if status=active. + * The status of the Mandate, one of {@code pending}, {@code inactive}, or {@code active}. The + * Mandate can be used to initiate a payment only if status=active. */ @SerializedName("status") String status; - /** The type of the mandate, one of `single_use` or `multi_use`. */ + /** The type of the mandate, one of {@code single_use} or {@code multi_use}. */ @SerializedName("type") String type; - /** Get id of expandable `paymentMethod` object. */ + /** Get ID of expandable {@code paymentMethod} object. */ public String getPaymentMethod() { return (this.paymentMethod != null) ? this.paymentMethod.getId() : null; } @@ -73,7 +73,7 @@ public void setPaymentMethod(String id) { this.paymentMethod = ApiResource.setExpandableFieldId(id, this.paymentMethod); } - /** Get expanded `paymentMethod`. */ + /** Get expanded {@code paymentMethod}. */ public PaymentMethod getPaymentMethodObject() { return (this.paymentMethod != null) ? this.paymentMethod.getExpanded() : null; } @@ -138,8 +138,8 @@ public static class CustomerAcceptance extends StripeObject { Online online; /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code online} + * or {@code offline}. */ @SerializedName("type") String type; @@ -183,8 +183,8 @@ public static class PaymentMethodDetails extends StripeObject { /** * The type of the payment method associated with this mandate. An additional hash is included - * on `payment_method_details` with a name matching this value. It contains mandate information - * specific to the payment method. + * on {@code payment_method_details} with a name matching this value. It contains mandate + * information specific to the payment method. */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/Order.java b/src/main/java/com/stripe/model/Order.java index 97fd5e490c1..7c4cc214b66 100644 --- a/src/main/java/com/stripe/model/Order.java +++ b/src/main/java/com/stripe/model/Order.java @@ -45,8 +45,8 @@ public class Order extends ApiResource implements HasId, MetadataStore { Long applicationFee; /** - * The ID of the payment used to pay for the order. Present if the order status is `paid`, - * `fulfilled`, or `refunded`. + * The ID of the payment used to pay for the order. Present if the order status is {@code paid}, + * {@code fulfilled}, or {@code refunded}. */ @SerializedName("charge") @Getter(lombok.AccessLevel.NONE) @@ -58,8 +58,8 @@ public class Order extends ApiResource implements HasId, MetadataStore { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -88,8 +88,8 @@ public class Order extends ApiResource implements HasId, MetadataStore { List items; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -105,7 +105,7 @@ public class Order extends ApiResource implements HasId, MetadataStore { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `order`. + *

Equal to {@code order}. */ @SerializedName("object") String object; @@ -116,9 +116,9 @@ public class Order extends ApiResource implements HasId, MetadataStore { /** * The shipping method that is currently selected for this order, if any. If present, it is equal - * to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation - * time, if there are multiple shipping methods, Stripe will automatically selected the first - * method. + * to one of the {@code id}s of shipping methods in the {@code shipping_methods} array. At order + * creation time, if there are multiple shipping methods, Stripe will automatically selected the + * first method. */ @SerializedName("selected_shipping_method") String selectedShippingMethod; @@ -135,9 +135,9 @@ public class Order extends ApiResource implements HasId, MetadataStore { List shippingMethods; /** - * Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More - * details in the [Orders - * Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). + * Current order status. One of {@code created}, {@code paid}, {@code canceled}, {@code + * fulfilled}, or {@code returned}. More details in the Orders Guide. */ @SerializedName("status") String status; @@ -154,7 +154,7 @@ public class Order extends ApiResource implements HasId, MetadataStore { @SerializedName("upstream_id") String upstreamId; - /** Get id of expandable `charge` object. */ + /** Get ID of expandable {@code charge} object. */ public String getCharge() { return (this.charge != null) ? this.charge.getId() : null; } @@ -163,7 +163,7 @@ public void setCharge(String id) { this.charge = ApiResource.setExpandableFieldId(id, this.charge); } - /** Get expanded `charge`. */ + /** Get expanded {@code charge}. */ public Charge getChargeObject() { return (this.charge != null) ? this.charge.getExpanded() : null; } @@ -172,7 +172,7 @@ public void setChargeObject(Charge expandableObject) { this.charge = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -181,7 +181,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -462,8 +462,9 @@ public static class ShippingMethod extends StripeObject implements HasId { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ @SerializedName("currency") String currency; @@ -489,25 +490,27 @@ public static class ShippingMethod extends StripeObject implements HasId { @EqualsAndHashCode(callSuper = false) public static class DeliveryEstimate extends StripeObject { /** - * If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. + * If {@code type} is {@code "exact"}, {@code date} will be the expected delivery date in the + * format YYYY-MM-DD. */ @SerializedName("date") String date; /** - * If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format - * YYYY-MM-DD. + * If {@code type} is {@code "range"}, {@code earliest} will be be the earliest delivery date + * in the format YYYY-MM-DD. */ @SerializedName("earliest") String earliest; /** - * If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. + * If {@code type} is {@code "range"}, {@code latest} will be the latest delivery date in the + * format YYYY-MM-DD. */ @SerializedName("latest") String latest; - /** The type of estimate. Must be either `"range"` or `"exact"`. */ + /** The type of estimate. Must be either {@code "range"} or {@code "exact"}. */ @SerializedName("type") String type; } diff --git a/src/main/java/com/stripe/model/OrderItem.java b/src/main/java/com/stripe/model/OrderItem.java index dd213a8d65b..0bdf9d3c8fd 100644 --- a/src/main/java/com/stripe/model/OrderItem.java +++ b/src/main/java/com/stripe/model/OrderItem.java @@ -18,14 +18,15 @@ public class OrderItem extends StripeObject { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; /** - * Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). + * Description of the line item, meant to be displayable to the user (e.g., {@code "Express + * shipping"}). */ @SerializedName("description") String description; @@ -33,7 +34,7 @@ public class OrderItem extends StripeObject { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `order_item`. + *

Equal to {@code order_item}. */ @SerializedName("object") String object; @@ -48,17 +49,19 @@ public class OrderItem extends StripeObject { ExpandableField parent; /** - * A positive integer representing the number of instances of `parent` that are included in this - * order item. Applicable/present only if `type` is `sku`. + * A positive integer representing the number of instances of {@code parent} that are included in + * this order item. Applicable/present only if {@code type} is {@code sku}. */ @SerializedName("quantity") Long quantity; - /** The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ + /** + * The type of line item. One of {@code sku}, {@code tax}, {@code shipping}, or {@code discount}. + */ @SerializedName("type") String type; - /** Get id of expandable `parent` object. */ + /** Get ID of expandable {@code parent} object. */ public String getParent() { return (this.parent != null) ? this.parent.getId() : null; } @@ -67,7 +70,7 @@ public void setParent(String id) { this.parent = ApiResource.setExpandableFieldId(id, this.parent); } - /** Get expanded `parent`. */ + /** Get expanded {@code parent}. */ public Sku getParentObject() { return (this.parent != null) ? this.parent.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/OrderReturn.java b/src/main/java/com/stripe/model/OrderReturn.java index 3258f344a76..3de9619faa9 100644 --- a/src/main/java/com/stripe/model/OrderReturn.java +++ b/src/main/java/com/stripe/model/OrderReturn.java @@ -30,8 +30,8 @@ public class OrderReturn extends ApiResource implements HasId { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -46,8 +46,8 @@ public class OrderReturn extends ApiResource implements HasId { List items; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -55,7 +55,7 @@ public class OrderReturn extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `order_return`. + *

Equal to {@code order_return}. */ @SerializedName("object") String object; @@ -72,7 +72,7 @@ public class OrderReturn extends ApiResource implements HasId { @Setter(lombok.AccessLevel.NONE) ExpandableField refund; - /** Get id of expandable `order` object. */ + /** Get ID of expandable {@code order} object. */ public String getOrder() { return (this.order != null) ? this.order.getId() : null; } @@ -81,7 +81,7 @@ public void setOrder(String id) { this.order = ApiResource.setExpandableFieldId(id, this.order); } - /** Get expanded `order`. */ + /** Get expanded {@code order}. */ public Order getOrderObject() { return (this.order != null) ? this.order.getExpanded() : null; } @@ -90,7 +90,7 @@ public void setOrderObject(Order expandableObject) { this.order = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `refund` object. */ + /** Get ID of expandable {@code refund} object. */ public String getRefund() { return (this.refund != null) ? this.refund.getId() : null; } @@ -99,7 +99,7 @@ public void setRefund(String id) { this.refund = ApiResource.setExpandableFieldId(id, this.refund); } - /** Get expanded `refund`. */ + /** Get expanded {@code refund}. */ public Refund getRefundObject() { return (this.refund != null) ? this.refund.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/PaymentIntent.java b/src/main/java/com/stripe/model/PaymentIntent.java index 25d941a9f88..9054067ce6b 100644 --- a/src/main/java/com/stripe/model/PaymentIntent.java +++ b/src/main/java/com/stripe/model/PaymentIntent.java @@ -24,11 +24,12 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how much - * to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) - * (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum - * amount is $0.50 US or [equivalent in charge - * currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount - * value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). + * to charge in the smallest currency + * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The + * minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ @SerializedName("amount") Long amount; @@ -48,27 +49,27 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

application; /** - * The amount of the application fee (if any) for the resulting payment. See the PaymentIntents - * [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for - * details. + * The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts + * for details. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; /** - * Populated when `status` is `canceled`, this is the time at which the PaymentIntent was - * canceled. Measured in seconds since the Unix epoch. + * Populated when {@code status} is {@code canceled}, this is the time at which the PaymentIntent + * was canceled. Measured in seconds since the Unix epoch. */ @SerializedName("canceled_at") Long canceledAt; /** - * Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, - * `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, - * `void_invoice`, or `automatic`). + * Reason for cancellation of this PaymentIntent, either user-provided ({@code duplicate}, {@code + * fraudulent}, {@code requested_by_customer}, or {@code abandoned}) or generated by Stripe + * internally ({@code failed_invoice}, {@code void_invoice}, or {@code automatic}). * - *

One of `abandoned`, `automatic`, `duplicate`, `failed_invoice`, `fraudulent`, - * `requested_by_customer`, or `void_invoice`. + *

One of {@code abandoned}, {@code automatic}, {@code duplicate}, {@code failed_invoice}, + * {@code fraudulent}, {@code requested_by_customer}, or {@code void_invoice}. */ @SerializedName("cancellation_reason") String cancellationReason; @@ -76,7 +77,7 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

One of `automatic`, or `manual`. + *

One of {@code automatic}, or {@code manual}. */ @SerializedName("capture_method") String captureMethod; @@ -93,8 +94,8 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment) - * and learn about how `client_secret` should be handled. + *

Refer to our docs to accept a + * payment and learn about how {@code client_secret} should be handled. */ @SerializedName("client_secret") String clientSecret; @@ -107,8 +108,8 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -148,8 +149,8 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

documentation. */ @Getter(onMethod_ = {@Override}) @SerializedName("metadata") @@ -173,15 +175,15 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

Equal to `payment_intent`. + *

Equal to {@code payment_intent}. */ @SerializedName("object") String object; /** * The account (if any) for which the funds of the PaymentIntent are intended. See the - * PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * PaymentIntents use case for + * connected accounts for details. */ @SerializedName("on_behalf_of") @Getter(lombok.AccessLevel.NONE) @@ -215,22 +217,22 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

For more, learn to [save card details after a - * payment](https://stripe.com/docs/payments/save-after-payment). + *

For more, learn to save card + * details after a payment. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure - * that they are authenticated while processing this PaymentIntent. You will then be able to - * collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and comply + * with regional legislation and network rules. For example, if your customer is impacted by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. * - *

One of `off_session`, or `on_session`. + *

One of {@code off_session}, or {@code on_session}. */ @SerializedName("setup_future_usage") String setupFutureUsage; @@ -264,29 +266,31 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

status. */ @SerializedName("status") String status; /** * The data with which to automatically create a Transfer when the payment is finalized. See the - * PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * PaymentIntents use case for + * connected accounts for details. */ @SerializedName("transfer_data") TransferData transferData; /** - * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use - * case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts + * for details. */ @SerializedName("transfer_group") String transferGroup; - /** Get id of expandable `application` object. */ + /** Get ID of expandable {@code application} object. */ public String getApplication() { return (this.application != null) ? this.application.getId() : null; } @@ -295,7 +299,7 @@ public void setApplication(String id) { this.application = ApiResource.setExpandableFieldId(id, this.application); } - /** Get expanded `application`. */ + /** Get expanded {@code application}. */ public Application getApplicationObject() { return (this.application != null) ? this.application.getExpanded() : null; } @@ -304,7 +308,7 @@ public void setApplicationObject(Application expandableObject) { this.application = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -313,7 +317,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -322,7 +326,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `invoice` object. */ + /** Get ID of expandable {@code invoice} object. */ public String getInvoice() { return (this.invoice != null) ? this.invoice.getId() : null; } @@ -331,7 +335,7 @@ public void setInvoice(String id) { this.invoice = ApiResource.setExpandableFieldId(id, this.invoice); } - /** Get expanded `invoice`. */ + /** Get expanded {@code invoice}. */ public Invoice getInvoiceObject() { return (this.invoice != null) ? this.invoice.getExpanded() : null; } @@ -340,7 +344,7 @@ public void setInvoiceObject(Invoice expandableObject) { this.invoice = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `onBehalfOf` object. */ + /** Get ID of expandable {@code onBehalfOf} object. */ public String getOnBehalfOf() { return (this.onBehalfOf != null) ? this.onBehalfOf.getId() : null; } @@ -349,7 +353,7 @@ public void setOnBehalfOf(String id) { this.onBehalfOf = ApiResource.setExpandableFieldId(id, this.onBehalfOf); } - /** Get expanded `onBehalfOf`. */ + /** Get expanded {@code onBehalfOf}. */ public Account getOnBehalfOfObject() { return (this.onBehalfOf != null) ? this.onBehalfOf.getExpanded() : null; } @@ -358,7 +362,7 @@ public void setOnBehalfOfObject(Account expandableObject) { this.onBehalfOf = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `paymentMethod` object. */ + /** Get ID of expandable {@code paymentMethod} object. */ public String getPaymentMethod() { return (this.paymentMethod != null) ? this.paymentMethod.getId() : null; } @@ -367,7 +371,7 @@ public void setPaymentMethod(String id) { this.paymentMethod = ApiResource.setExpandableFieldId(id, this.paymentMethod); } - /** Get expanded `paymentMethod`. */ + /** Get expanded {@code paymentMethod}. */ public PaymentMethod getPaymentMethodObject() { return (this.paymentMethod != null) ? this.paymentMethod.getExpanded() : null; } @@ -377,7 +381,7 @@ public void setPaymentMethodObject(PaymentMethod expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `review` object. */ + /** Get ID of expandable {@code review} object. */ public String getReview() { return (this.review != null) ? this.review.getId() : null; } @@ -386,7 +390,7 @@ public void setReview(String id) { this.review = ApiResource.setExpandableFieldId(id, this.review); } - /** Get expanded `review`. */ + /** Get expanded {@code review}. */ public Review getReviewObject() { return (this.review != null) ? this.review.getExpanded() : null; } @@ -395,7 +399,7 @@ public void setReviewObject(Review expandableObject) { this.review = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `source` object. */ + /** Get ID of expandable {@code source} object. */ public String getSource() { return (this.source != null) ? this.source.getId() : null; } @@ -404,7 +408,7 @@ public void setSource(String id) { this.source = ApiResource.setExpandableFieldId(id, this.source); } - /** Get expanded `source`. */ + /** Get expanded {@code source}. */ public PaymentSource getSourceObject() { return (this.source != null) ? this.source.getExpanded() : null; } @@ -417,14 +421,14 @@ public void setSourceObject(PaymentSource expandableObject) { * Creates a PaymentIntent object. * *

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can read more - * about the different payment flows available via the Payment Intents API here. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm to continue the payment. + * You can read more about the different payment flows available via the Payment Intents API here. * *

When confirm=true is used during creation, it is equivalent to creating and * confirming the PaymentIntent in the same call. You may use any parameters available in the confirm API when confirm=true is - * supplied. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm API when + * confirm=true is supplied. */ public static PaymentIntent create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -434,14 +438,14 @@ public static PaymentIntent create(Map params) throws StripeExce * Creates a PaymentIntent object. * *

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can read more - * about the different payment flows available via the Payment Intents API here. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm to continue the payment. + * You can read more about the different payment flows available via the Payment Intents API here. * *

When confirm=true is used during creation, it is equivalent to creating and * confirming the PaymentIntent in the same call. You may use any parameters available in the confirm API when confirm=true is - * supplied. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm API when + * confirm=true is supplied. */ public static PaymentIntent create(Map params, RequestOptions options) throws StripeException { @@ -454,14 +458,14 @@ public static PaymentIntent create(Map params, RequestOptions op * Creates a PaymentIntent object. * *

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can read more - * about the different payment flows available via the Payment Intents API here. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm to continue the payment. + * You can read more about the different payment flows available via the Payment Intents API here. * *

When confirm=true is used during creation, it is equivalent to creating and * confirming the PaymentIntent in the same call. You may use any parameters available in the confirm API when confirm=true is - * supplied. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm API when + * confirm=true is supplied. */ public static PaymentIntent create(PaymentIntentCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -471,14 +475,14 @@ public static PaymentIntent create(PaymentIntentCreateParams params) throws Stri * Creates a PaymentIntent object. * *

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can read more - * about the different payment flows available via the Payment Intents API here. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm to continue the payment. + * You can read more about the different payment flows available via the Payment Intents API here. * *

When confirm=true is used during creation, it is equivalent to creating and * confirming the PaymentIntent in the same call. You may use any parameters available in the confirm API when confirm=true is - * supplied. + * href="https://stripe.com/docs/api/payment_intents/confirm">confirm API when + * confirm=true is supplied. */ public static PaymentIntent create(PaymentIntentCreateParams params, RequestOptions options) throws StripeException { @@ -519,8 +523,8 @@ public static PaymentIntentCollection list(PaymentIntentListParams params, Reque * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the payment intent object reference for more - * details. + * refer to the payment intent + * object reference for more details. */ public static PaymentIntent retrieve(String intent) throws StripeException { return retrieve(intent, (Map) null, (RequestOptions) null); @@ -533,8 +537,8 @@ public static PaymentIntent retrieve(String intent) throws StripeException { * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the payment intent object reference for more - * details. + * refer to the payment intent + * object reference for more details. */ public static PaymentIntent retrieve(String intent, RequestOptions options) throws StripeException { @@ -548,8 +552,8 @@ public static PaymentIntent retrieve(String intent, RequestOptions options) * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the payment intent object reference for more - * details. + * refer to the payment intent + * object reference for more details. */ public static PaymentIntent retrieve( String intent, Map params, RequestOptions options) throws StripeException { @@ -569,8 +573,8 @@ public static PaymentIntent retrieve( * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the payment intent object reference for more - * details. + * refer to the payment intent + * object reference for more details. */ public static PaymentIntent retrieve( String intent, PaymentIntentRetrieveParams params, RequestOptions options) @@ -590,8 +594,8 @@ public static PaymentIntent retrieve( *

Depending on which properties you update, you may need to confirm the PaymentIntent again. * For example, updating the payment_method will always require you to confirm the * PaymentIntent again. If you prefer to update and confirm at the same time, we recommend - * updating properties via the confirm API - * instead. + * updating properties via the confirm API instead. */ @Override public PaymentIntent update(Map params) throws StripeException { @@ -604,8 +608,8 @@ public PaymentIntent update(Map params) throws StripeException { *

Depending on which properties you update, you may need to confirm the PaymentIntent again. * For example, updating the payment_method will always require you to confirm the * PaymentIntent again. If you prefer to update and confirm at the same time, we recommend - * updating properties via the confirm API - * instead. + * updating properties via the confirm API instead. */ @Override public PaymentIntent update(Map params, RequestOptions options) @@ -625,8 +629,8 @@ public PaymentIntent update(Map params, RequestOptions options) *

Depending on which properties you update, you may need to confirm the PaymentIntent again. * For example, updating the payment_method will always require you to confirm the * PaymentIntent again. If you prefer to update and confirm at the same time, we recommend - * updating properties via the confirm API - * instead. + * updating properties via the confirm API instead. */ public PaymentIntent update(PaymentIntentUpdateParams params) throws StripeException { return update(params, (RequestOptions) null); @@ -638,8 +642,8 @@ public PaymentIntent update(PaymentIntentUpdateParams params) throws StripeExcep *

Depending on which properties you update, you may need to confirm the PaymentIntent again. * For example, updating the payment_method will always require you to confirm the * PaymentIntent again. If you prefer to update and confirm at the same time, we recommend - * updating properties via the confirm API - * instead. + * updating properties via the confirm API instead. */ public PaymentIntent update(PaymentIntentUpdateParams params, RequestOptions options) throws StripeException { @@ -664,8 +668,10 @@ public PaymentIntent update(PaymentIntentUpdateParams params, RequestOptions opt * is set to manual). * *

If the confirmation_method is automatic, payment may be attempted - * using our client SDKs and - * the PaymentIntent’s client_secret. After + * using our client SDKs + * and the PaymentIntent’s client_secret. After * next_actions are handled by the client, no additional confirmation is required to * complete the payment. * @@ -673,8 +679,9 @@ public PaymentIntent update(PaymentIntentUpdateParams params, RequestOptions opt * initiated using a secret key. If any actions are required for the payment, the PaymentIntent * will return to the requires_confirmation state after those actions are completed. * Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. Read the expanded - * documentation to learn more about manual confirmation. + * attempt. Read the expanded documentation + * to learn more about manual confirmation. */ public PaymentIntent confirm() throws StripeException { return confirm((Map) null, (RequestOptions) null); @@ -692,8 +699,10 @@ public PaymentIntent confirm() throws StripeException { * is set to manual). * *

If the confirmation_method is automatic, payment may be attempted - * using our client SDKs and - * the PaymentIntent’s client_secret. After + * using our client SDKs + * and the PaymentIntent’s client_secret. After * next_actions are handled by the client, no additional confirmation is required to * complete the payment. * @@ -701,8 +710,9 @@ public PaymentIntent confirm() throws StripeException { * initiated using a secret key. If any actions are required for the payment, the PaymentIntent * will return to the requires_confirmation state after those actions are completed. * Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. Read the expanded - * documentation to learn more about manual confirmation. + * attempt. Read the expanded documentation + * to learn more about manual confirmation. */ public PaymentIntent confirm(RequestOptions options) throws StripeException { return confirm((Map) null, options); @@ -720,8 +730,10 @@ public PaymentIntent confirm(RequestOptions options) throws StripeException { * is set to manual). * *

If the confirmation_method is automatic, payment may be attempted - * using our client SDKs and - * the PaymentIntent’s client_secret. After + * using our client SDKs + * and the PaymentIntent’s client_secret. After * next_actions are handled by the client, no additional confirmation is required to * complete the payment. * @@ -729,8 +741,9 @@ public PaymentIntent confirm(RequestOptions options) throws StripeException { * initiated using a secret key. If any actions are required for the payment, the PaymentIntent * will return to the requires_confirmation state after those actions are completed. * Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. Read the expanded - * documentation to learn more about manual confirmation. + * attempt. Read the expanded documentation + * to learn more about manual confirmation. */ public PaymentIntent confirm(Map params) throws StripeException { return confirm(params, (RequestOptions) null); @@ -748,8 +761,10 @@ public PaymentIntent confirm(Map params) throws StripeException * is set to manual). * *

If the confirmation_method is automatic, payment may be attempted - * using our client SDKs and - * the PaymentIntent’s client_secret. After + * using our client SDKs + * and the PaymentIntent’s client_secret. After * next_actions are handled by the client, no additional confirmation is required to * complete the payment. * @@ -757,8 +772,9 @@ public PaymentIntent confirm(Map params) throws StripeException * initiated using a secret key. If any actions are required for the payment, the PaymentIntent * will return to the requires_confirmation state after those actions are completed. * Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. Read the expanded - * documentation to learn more about manual confirmation. + * attempt. Read the expanded documentation + * to learn more about manual confirmation. */ public PaymentIntent confirm(Map params, RequestOptions options) throws StripeException { @@ -783,8 +799,10 @@ public PaymentIntent confirm(Map params, RequestOptions options) * is set to manual). * *

If the confirmation_method is automatic, payment may be attempted - * using our client SDKs and - * the PaymentIntent’s client_secret. After + * using our client SDKs + * and the PaymentIntent’s client_secret. After * next_actions are handled by the client, no additional confirmation is required to * complete the payment. * @@ -792,8 +810,9 @@ public PaymentIntent confirm(Map params, RequestOptions options) * initiated using a secret key. If any actions are required for the payment, the PaymentIntent * will return to the requires_confirmation state after those actions are completed. * Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. Read the expanded - * documentation to learn more about manual confirmation. + * attempt. Read the expanded documentation + * to learn more about manual confirmation. */ public PaymentIntent confirm(PaymentIntentConfirmParams params) throws StripeException { return confirm(params, (RequestOptions) null); @@ -811,8 +830,10 @@ public PaymentIntent confirm(PaymentIntentConfirmParams params) throws StripeExc * is set to manual). * *

If the confirmation_method is automatic, payment may be attempted - * using our client SDKs and - * the PaymentIntent’s client_secret. After + * using our client SDKs + * and the PaymentIntent’s client_secret. After * next_actions are handled by the client, no additional confirmation is required to * complete the payment. * @@ -820,8 +841,9 @@ public PaymentIntent confirm(PaymentIntentConfirmParams params) throws StripeExc * initiated using a secret key. If any actions are required for the payment, the PaymentIntent * will return to the requires_confirmation state after those actions are completed. * Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. Read the expanded - * documentation to learn more about manual confirmation. + * attempt. Read the expanded documentation + * to learn more about manual confirmation. */ public PaymentIntent confirm(PaymentIntentConfirmParams params, RequestOptions options) throws StripeException { @@ -938,8 +960,8 @@ public PaymentIntent cancel(PaymentIntentCancelParams params, RequestOptions opt * *

Uncaptured PaymentIntents will be canceled exactly seven days after they are created. * - *

Learn more about separate authorization and - * capture. + *

Learn more about separate + * authorization and capture. */ public PaymentIntent capture() throws StripeException { return capture((Map) null, (RequestOptions) null); @@ -951,8 +973,8 @@ public PaymentIntent capture() throws StripeException { * *

Uncaptured PaymentIntents will be canceled exactly seven days after they are created. * - *

Learn more about separate authorization and - * capture. + *

Learn more about separate + * authorization and capture. */ public PaymentIntent capture(RequestOptions options) throws StripeException { return capture((Map) null, options); @@ -964,8 +986,8 @@ public PaymentIntent capture(RequestOptions options) throws StripeException { * *

Uncaptured PaymentIntents will be canceled exactly seven days after they are created. * - *

Learn more about separate authorization and - * capture. + *

Learn more about separate + * authorization and capture. */ public PaymentIntent capture(Map params) throws StripeException { return capture(params, (RequestOptions) null); @@ -977,8 +999,8 @@ public PaymentIntent capture(Map params) throws StripeException * *

Uncaptured PaymentIntents will be canceled exactly seven days after they are created. * - *

Learn more about separate authorization and - * capture. + *

Learn more about separate + * authorization and capture. */ public PaymentIntent capture(Map params, RequestOptions options) throws StripeException { @@ -997,8 +1019,8 @@ public PaymentIntent capture(Map params, RequestOptions options) * *

Uncaptured PaymentIntents will be canceled exactly seven days after they are created. * - *

Learn more about separate authorization and - * capture. + *

Learn more about separate + * authorization and capture. */ public PaymentIntent capture(PaymentIntentCaptureParams params) throws StripeException { return capture(params, (RequestOptions) null); @@ -1010,8 +1032,8 @@ public PaymentIntent capture(PaymentIntentCaptureParams params) throws StripeExc * *

Uncaptured PaymentIntents will be canceled exactly seven days after they are created. * - *

Learn more about separate authorization and - * capture. + *

Learn more about separate + * authorization and capture. */ public PaymentIntent capture(PaymentIntentCaptureParams params, RequestOptions options) throws StripeException { @@ -1031,7 +1053,9 @@ public static class NextAction extends StripeObject { @SerializedName("redirect_to_url") NextActionRedirectToUrl redirectToUrl; - /** Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`. */ + /** + * Type of the next action to perform, one of {@code redirect_to_url} or {@code use_stripe_sdk}. + */ @SerializedName("type") String type; @@ -1074,23 +1098,24 @@ public static class Card extends StripeObject { /** * Installment details for this payment (Mexico only). * - *

For more information, see the [installments integration - * guide](https://stripe.com/docs/payments/installments). + *

For more information, see the installments integration guide. */ @SerializedName("installments") Installments installments; /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish - * to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on - * how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our SCA + * Engine. * - *

One of `any`, `automatic`, or `challenge_only`. + *

One of {@code any}, {@code automatic}, or {@code challenge_only}. */ @SerializedName("request_three_d_secure") String requestThreeDSecure; @@ -1116,20 +1141,20 @@ public static class Installments extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Plan extends StripeObject { /** - * For `fixed_count` installment plans, this is the number of installment payments your - * customer will make to their credit card. + * For {@code fixed_count} installment plans, this is the number of installment payments + * your customer will make to their credit card. */ @SerializedName("count") Long count; /** - * For `fixed_count` installment plans, this is the interval between installment payments - * your customer will make to their credit card. One of `month`. + * For {@code fixed_count} installment plans, this is the interval between installment + * payments your customer will make to their credit card. One of {@code month}. */ @SerializedName("interval") String interval; - /** Type of installment plan, one of `fixed_count`. */ + /** Type of installment plan, one of {@code fixed_count}. */ @SerializedName("type") String type; } @@ -1143,12 +1168,12 @@ public static class Plan extends StripeObject { public static class TransferData extends StripeObject { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how - * much to charge in the [smallest currency - * unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or - * 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent - * in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). - * The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of - * $999,999.99). + * much to charge in the smallest + * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal + * currency). The minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ @SerializedName("amount") Long amount; @@ -1162,7 +1187,7 @@ public static class TransferData extends StripeObject { @Setter(lombok.AccessLevel.NONE) ExpandableField destination; - /** Get id of expandable `destination` object. */ + /** Get ID of expandable {@code destination} object. */ public String getDestination() { return (this.destination != null) ? this.destination.getId() : null; } @@ -1171,7 +1196,7 @@ public void setDestination(String id) { this.destination = ApiResource.setExpandableFieldId(id, this.destination); } - /** Get expanded `destination`. */ + /** Get expanded {@code destination}. */ public Account getDestinationObject() { return (this.destination != null) ? this.destination.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/PaymentMethod.java b/src/main/java/com/stripe/model/PaymentMethod.java index 370998019a5..61b9a37502b 100644 --- a/src/main/java/com/stripe/model/PaymentMethod.java +++ b/src/main/java/com/stripe/model/PaymentMethod.java @@ -57,8 +57,8 @@ public class PaymentMethod extends ApiResource implements HasId, MetadataStore

Equal to `payment_method`. + *

Equal to {@code payment_method}. */ @SerializedName("object") String object; @@ -86,12 +86,13 @@ public class PaymentMethod extends ApiResource implements HasId, MetadataStore

One of `au_becs_debit`, `card`, `card_present`, `fpx`, `ideal`, or `sepa_debit`. + *

One of {@code au_becs_debit}, {@code card}, {@code card_present}, {@code fpx}, {@code + * ideal}, or {@code sepa_debit}. */ @SerializedName("type") String type; - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -100,7 +101,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -111,8 +112,8 @@ public void setCustomerObject(Customer expandableObject) { /** * Creates a PaymentMethod object. Read the Stripe.js reference to learn - * how to create PaymentMethods via Stripe.js. + * href="https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js + * reference to learn how to create PaymentMethods via Stripe.js. */ public static PaymentMethod create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -120,8 +121,8 @@ public static PaymentMethod create(Map params) throws StripeExce /** * Creates a PaymentMethod object. Read the Stripe.js reference to learn - * how to create PaymentMethods via Stripe.js. + * href="https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js + * reference to learn how to create PaymentMethods via Stripe.js. */ public static PaymentMethod create(Map params, RequestOptions options) throws StripeException { @@ -132,8 +133,8 @@ public static PaymentMethod create(Map params, RequestOptions op /** * Creates a PaymentMethod object. Read the Stripe.js reference to learn - * how to create PaymentMethods via Stripe.js. + * href="https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js + * reference to learn how to create PaymentMethods via Stripe.js. */ public static PaymentMethod create(PaymentMethodCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -141,8 +142,8 @@ public static PaymentMethod create(PaymentMethodCreateParams params) throws Stri /** * Creates a PaymentMethod object. Read the Stripe.js reference to learn - * how to create PaymentMethods via Stripe.js. + * href="https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js + * reference to learn how to create PaymentMethods via Stripe.js. */ public static PaymentMethod create(PaymentMethodCreateParams params, RequestOptions options) throws StripeException { @@ -253,7 +254,7 @@ public static PaymentMethodCollection list(PaymentMethodListParams params, Reque * Attaches a PaymentMethod object to a Customer. * *

To use this PaymentMethod as the default for invoice or subscription payments, set + * href="https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"> * invoice_settings.default_payment_method, on the Customer to the * PaymentMethod’s ID. */ @@ -265,7 +266,7 @@ public PaymentMethod attach(Map params) throws StripeException { * Attaches a PaymentMethod object to a Customer. * *

To use this PaymentMethod as the default for invoice or subscription payments, set + * href="https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"> * invoice_settings.default_payment_method, on the Customer to the * PaymentMethod’s ID. */ @@ -284,7 +285,7 @@ public PaymentMethod attach(Map params, RequestOptions options) * Attaches a PaymentMethod object to a Customer. * *

To use this PaymentMethod as the default for invoice or subscription payments, set + * href="https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"> * invoice_settings.default_payment_method, on the Customer to the * PaymentMethod’s ID. */ @@ -296,7 +297,7 @@ public PaymentMethod attach(PaymentMethodAttachParams params) throws StripeExcep * Attaches a PaymentMethod object to a Customer. * *

To use this PaymentMethod as the default for invoice or subscription payments, set + * href="https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"> * invoice_settings.default_payment_method, on the Customer to the * PaymentMethod’s ID. */ @@ -395,8 +396,8 @@ public static class BillingDetails extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Card extends StripeObject { /** - * Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or - * `unknown`. + * Card brand. Can be {@code amex}, {@code diners}, {@code discover}, {@code jcb}, {@code + * mastercard}, {@code unionpay}, {@code visa}, or {@code unknown}. */ @SerializedName("brand") String brand; @@ -434,7 +435,9 @@ public static class Card extends StripeObject { @SerializedName("fingerprint") String fingerprint; - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * Card funding type. Can be {@code credit}, {@code debit}, {@code prepaid}, or {@code unknown}. + */ @SerializedName("funding") String funding; @@ -469,22 +472,22 @@ public static class Card extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Checks extends StripeObject { /** - * If a address line1 was provided, results of the check, one of `pass`, `fail`, - * `unavailable`, or `unchecked`. + * If a address line1 was provided, results of the check, one of {@code pass}, {@code fail}, + * {@code unavailable}, or {@code unchecked}. */ @SerializedName("address_line1_check") String addressLine1Check; /** - * If a address postal code was provided, results of the check, one of `pass`, `fail`, - * `unavailable`, or `unchecked`. + * If a address postal code was provided, results of the check, one of {@code pass}, {@code + * fail}, {@code unavailable}, or {@code unchecked}. */ @SerializedName("address_postal_code_check") String addressPostalCodeCheck; /** - * If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or - * `unchecked`. + * If a CVC was provided, results of the check, one of {@code pass}, {@code fail}, {@code + * unavailable}, or {@code unchecked}. */ @SerializedName("cvc_check") String cvcCheck; @@ -523,10 +526,10 @@ public static class Wallet extends StripeObject { SamsungPay samsungPay; /** - * The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, - * `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the - * Wallet subhash with a name matching this value. It contains additional information specific - * to the card wallet type. + * The type of the card wallet, one of {@code amex_express_checkout}, {@code apple_pay}, + * {@code google_pay}, {@code masterpass}, {@code samsung_pay}, or {@code visa_checkout}. An + * additional hash is included on the Wallet subhash with a name matching this value. It + * contains additional information specific to the card wallet type. */ @SerializedName("type") String type; @@ -631,15 +634,16 @@ public static class CardPresent extends StripeObject {} @Setter @EqualsAndHashCode(callSuper = false) public static class Fpx extends StripeObject { - /** Account holder type, if provided. Can be one of `individual` or `company`. */ + /** Account holder type, if provided. Can be one of {@code individual} or {@code company}. */ @SerializedName("account_holder_type") String accountHolderType; /** - * The customer's bank, if provided. Can be one of `affin_bank`, `alliance_bank`, `ambank`, - * `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, - * `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, - * `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `uob_regional`. + * The customer's bank, if provided. Can be one of {@code affin_bank}, {@code alliance_bank}, + * {@code ambank}, {@code bank_islam}, {@code bank_muamalat}, {@code bank_rakyat}, {@code bsn}, + * {@code cimb}, {@code hong_leong_bank}, {@code hsbc}, {@code kfh}, {@code maybank2u}, {@code + * ocbc}, {@code public_bank}, {@code rhb}, {@code standard_chartered}, {@code uob}, {@code + * deutsche_bank}, {@code maybank2e}, {@code pb_enterprise}, or {@code uob_regional}. */ @SerializedName("bank") String bank; @@ -650,9 +654,9 @@ public static class Fpx extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Ideal extends StripeObject { /** - * The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, - * `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `sns_bank`, - * `triodos_bank`, or `van_lanschot`. + * The customer's bank, if provided. Can be one of {@code abn_amro}, {@code asn_bank}, {@code + * bunq}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code moneyou}, {@code rabobank}, + * {@code regiobank}, {@code sns_bank}, {@code triodos_bank}, or {@code van_lanschot}. */ @SerializedName("bank") String bank; @@ -660,8 +664,9 @@ public static class Ideal extends StripeObject { /** * The Bank Identifier Code of the customer's bank, if the bank was provided. * - *

One of `ABNANL2A`, `ASNBNL21`, `BUNQNL2A`, `FVLBNL22`, `HANDNL2A`, `INGBNL2A`, `KNABNL2H`, - * `MOYONL21`, `RABONL2U`, `RBRBNL21`, `SNSBNL2A`, or `TRIONL2U`. + *

One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BUNQNL2A}, {@code FVLBNL22}, {@code + * HANDNL2A}, {@code INGBNL2A}, {@code KNABNL2H}, {@code MOYONL21}, {@code RABONL2U}, {@code + * RBRBNL21}, {@code SNSBNL2A}, or {@code TRIONL2U}. */ @SerializedName("bic") String bic; diff --git a/src/main/java/com/stripe/model/PaymentSourceCollection.java b/src/main/java/com/stripe/model/PaymentSourceCollection.java index 25b632d73b8..3a8b4055957 100644 --- a/src/main/java/com/stripe/model/PaymentSourceCollection.java +++ b/src/main/java/com/stripe/model/PaymentSourceCollection.java @@ -76,8 +76,8 @@ public PaymentSource retrieve( * *

If the card’s owner has no default card, then the new card will become the default. However, * if the owner already has a default, then it will not change. To change the default, you should - * update the customer to have a new default_source - * . + * update the customer to have a new + * default_source. */ public PaymentSource create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -89,8 +89,8 @@ public PaymentSource create(Map params) throws StripeException { * *

If the card’s owner has no default card, then the new card will become the default. However, * if the owner already has a default, then it will not change. To change the default, you should - * update the customer to have a new default_source - * . + * update the customer to have a new + * default_source. */ public PaymentSource create(Map params, RequestOptions options) throws StripeException { @@ -105,8 +105,8 @@ public PaymentSource create(Map params, RequestOptions options) * *

If the card’s owner has no default card, then the new card will become the default. However, * if the owner already has a default, then it will not change. To change the default, you should - * update the customer to have a new default_source - * . + * update the customer to have a new + * default_source. */ public PaymentSource create(PaymentSourceCollectionCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -118,8 +118,8 @@ public PaymentSource create(PaymentSourceCollectionCreateParams params) throws S * *

If the card’s owner has no default card, then the new card will become the default. However, * if the owner already has a default, then it will not change. To change the default, you should - * update the customer to have a new default_source - * . + * update the customer to have a new + * default_source. */ public PaymentSource create(PaymentSourceCollectionCreateParams params, RequestOptions options) throws StripeException { diff --git a/src/main/java/com/stripe/model/Payout.java b/src/main/java/com/stripe/model/Payout.java index 45c3dc1cf8c..bb787fc8dfc 100644 --- a/src/main/java/com/stripe/model/Payout.java +++ b/src/main/java/com/stripe/model/Payout.java @@ -31,9 +31,10 @@ public class Payout extends ApiResource implements MetadataStore, Balanc Long arrivalDate; /** - * Returns `true` if the payout was created by an [automated payout - * schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested - * manually](https://stripe.com/docs/payouts#manual-payouts). + * Returns {@code true} if the payout was created by an automated payout schedule, and + * {@code false} if it was requested + * manually. */ @SerializedName("automatic") Boolean automatic; @@ -51,8 +52,8 @@ public class Payout extends ApiResource implements MetadataStore, Balanc Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -78,8 +79,9 @@ public class Payout extends ApiResource implements MetadataStore, Balanc ExpandableField failureBalanceTransaction; /** - * Error code explaining reason for payout failure if available. See [Types of payout - * failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. + * Error code explaining reason for payout failure if available. See Types of payout failures for a list of + * failure codes. */ @SerializedName("failure_code") String failureCode; @@ -94,8 +96,8 @@ public class Payout extends ApiResource implements MetadataStore, Balanc String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -109,9 +111,10 @@ public class Payout extends ApiResource implements MetadataStore, Balanc Map metadata; /** - * The method used to send this payout, which can be `standard` or `instant`. `instant` is only - * supported for payouts to debit cards. (See [Instant payouts for - * marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) + * The method used to send this payout, which can be {@code standard} or {@code instant}. {@code + * instant} is only supported for payouts to debit cards. (See Instant payouts for + * marketplaces for more information.) */ @SerializedName("method") String method; @@ -119,12 +122,12 @@ public class Payout extends ApiResource implements MetadataStore, Balanc /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `payout`. + *

Equal to {@code payout}. */ @SerializedName("object") String object; - /** The source balance this payout came from. One of `card` or `bank_account`. */ + /** The source balance this payout came from. One of {@code card} or {@code bank_account}. */ @SerializedName("source_type") String sourceType; @@ -133,19 +136,20 @@ public class Payout extends ApiResource implements MetadataStore, Balanc String statementDescriptor; /** - * Current status of the payout (`paid`, `pending`, `in_transit`, `canceled` or `failed`). A - * payout will be `pending` until it is submitted to the bank, at which point it becomes - * `in_transit`. It will then change to `paid` if the transaction goes through. If it does not go - * through successfully, its status will change to `failed` or `canceled`. + * Current status of the payout ({@code paid}, {@code pending}, {@code in_transit}, {@code + * canceled} or {@code failed}). A payout will be {@code pending} until it is submitted to the + * bank, at which point it becomes {@code in_transit}. It will then change to {@code paid} if the + * transaction goes through. If it does not go through successfully, its status will change to + * {@code failed} or {@code canceled}. */ @SerializedName("status") String status; - /** Can be `bank_account` or `card`. */ + /** Can be {@code bank_account} or {@code card}. */ @SerializedName("type") String type; - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -154,7 +158,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -164,7 +168,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `destination` object. */ + /** Get ID of expandable {@code destination} object. */ public String getDestination() { return (this.destination != null) ? this.destination.getId() : null; } @@ -173,7 +177,7 @@ public void setDestination(String id) { this.destination = ApiResource.setExpandableFieldId(id, this.destination); } - /** Get expanded `destination`. */ + /** Get expanded {@code destination}. */ public ExternalAccount getDestinationObject() { return (this.destination != null) ? this.destination.getExpanded() : null; } @@ -183,7 +187,7 @@ public void setDestinationObject(ExternalAccount expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `failureBalanceTransaction` object. */ + /** Get ID of expandable {@code failureBalanceTransaction} object. */ public String getFailureBalanceTransaction() { return (this.failureBalanceTransaction != null) ? this.failureBalanceTransaction.getId() : null; } @@ -193,7 +197,7 @@ public void setFailureBalanceTransaction(String id) { ApiResource.setExpandableFieldId(id, this.failureBalanceTransaction); } - /** Get expanded `failureBalanceTransaction`. */ + /** Get expanded {@code failureBalanceTransaction}. */ public BalanceTransaction getFailureBalanceTransactionObject() { return (this.failureBalanceTransaction != null) ? this.failureBalanceTransaction.getExpanded() @@ -293,15 +297,16 @@ public static PayoutCollection list(PayoutListParams params, RequestOptions opti /** * To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive - * an “Insufficient Funds” error. + * href="https://stripe.com/docs/api#balance">Stripe balance must be able to cover the payout + * amount, or you’ll receive an “Insufficient Funds” error. * *

If your API key is in test mode, money won’t actually be sent, though everything else will * occur as if in live mode. * *

If you are creating a manual payout on a Stripe account that uses multiple payment source * types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type. + * href="https://stripe.com/docs/api#balance_object">balance object details available and + * pending amounts by source type. */ public static Payout create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -309,15 +314,16 @@ public static Payout create(Map params) throws StripeException { /** * To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive - * an “Insufficient Funds” error. + * href="https://stripe.com/docs/api#balance">Stripe balance must be able to cover the payout + * amount, or you’ll receive an “Insufficient Funds” error. * *

If your API key is in test mode, money won’t actually be sent, though everything else will * occur as if in live mode. * *

If you are creating a manual payout on a Stripe account that uses multiple payment source * types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type. + * href="https://stripe.com/docs/api#balance_object">balance object details available and + * pending amounts by source type. */ public static Payout create(Map params, RequestOptions options) throws StripeException { @@ -327,15 +333,16 @@ public static Payout create(Map params, RequestOptions options) /** * To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive - * an “Insufficient Funds” error. + * href="https://stripe.com/docs/api#balance">Stripe balance must be able to cover the payout + * amount, or you’ll receive an “Insufficient Funds” error. * *

If your API key is in test mode, money won’t actually be sent, though everything else will * occur as if in live mode. * *

If you are creating a manual payout on a Stripe account that uses multiple payment source * types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type. + * href="https://stripe.com/docs/api#balance_object">balance object details available and + * pending amounts by source type. */ public static Payout create(PayoutCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -343,15 +350,16 @@ public static Payout create(PayoutCreateParams params) throws StripeException { /** * To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive - * an “Insufficient Funds” error. + * href="https://stripe.com/docs/api#balance">Stripe balance must be able to cover the payout + * amount, or you’ll receive an “Insufficient Funds” error. * *

If your API key is in test mode, money won’t actually be sent, though everything else will * occur as if in live mode. * *

If you are creating a manual payout on a Stripe account that uses multiple payment source * types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type. + * href="https://stripe.com/docs/api#balance_object">balance object details available and + * pending amounts by source type. */ public static Payout create(PayoutCreateParams params, RequestOptions options) throws StripeException { diff --git a/src/main/java/com/stripe/model/Person.java b/src/main/java/com/stripe/model/Person.java index 67970b5bc54..6b89f19733f 100644 --- a/src/main/java/com/stripe/model/Person.java +++ b/src/main/java/com/stripe/model/Person.java @@ -59,7 +59,10 @@ public class Person extends ApiResource implements HasId, MetadataStore @SerializedName("first_name_kanji") String firstNameKanji; - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ @SerializedName("gender") String gender; @@ -68,7 +71,7 @@ public class Person extends ApiResource implements HasId, MetadataStore @SerializedName("id") String id; - /** Whether the person's `id_number` was provided. */ + /** Whether the person's {@code id_number} was provided. */ @SerializedName("id_number_provided") Boolean idNumberProvided; @@ -99,7 +102,7 @@ public class Person extends ApiResource implements HasId, MetadataStore /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `person`. + *

Equal to {@code person}. */ @SerializedName("object") String object; @@ -235,8 +238,8 @@ public static class JapanAddress extends StripeObject { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -310,22 +313,23 @@ public static class Relationship extends StripeObject { public static class Requirements extends StripeObject { /** * Fields that need to be collected to keep the person's account enabled. If not collected by - * the account's `current_deadline`, these fields appear in `past_due` as well, and the account - * is disabled. + * the account's {@code current_deadline}, these fields appear in {@code past_due} as well, and + * the account is disabled. */ @SerializedName("currently_due") List currentlyDue; /** * Fields that need to be collected assuming all volume thresholds are reached. As fields are - * needed, they are moved to `currently_due` and the account's `current_deadline` is set. + * needed, they are moved to {@code currently_due} and the account's {@code current_deadline} is + * set. */ @SerializedName("eventually_due") List eventuallyDue; /** - * Fields that weren't collected by the account's `current_deadline`. These fields need to be - * collected to enable payouts for the person's account. + * Fields that weren't collected by the account's {@code current_deadline}. These fields need to + * be collected to enable payouts for the person's account. */ @SerializedName("past_due") List pastDue; @@ -333,7 +337,7 @@ public static class Requirements extends StripeObject { /** * Fields that may become required depending on the results of verification or review. An empty * array unless an asynchronous verification is pending. If verification fails, the fields in - * this array become required and move to `currently_due` or `past_due`. + * this array become required and move to {@code currently_due} or {@code past_due}. */ @SerializedName("pending_verification") List pendingVerification; @@ -352,15 +356,16 @@ public static class Verification extends StripeObject { /** * A user-displayable string describing the verification state for the person. For example, this - * may say "Provided identity information could not be verified". + * may say "Provided identity information could not be verified". */ @SerializedName("details") String details; /** - * One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, - * `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, - * `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the + * One of {@code document_address_mismatch}, {@code document_dob_mismatch}, {@code + * document_duplicate_type}, {@code document_id_number_mismatch}, {@code + * document_name_mismatch}, {@code document_nationality_mismatch}, {@code + * failed_keyed_identity}, or {@code failed_other}. A machine-readable code specifying the * verification state for the person. */ @SerializedName("details_code") @@ -370,8 +375,8 @@ public static class Verification extends StripeObject { VerificationDocument document; /** - * The state of verification for the person. Possible values are `unverified`, `pending`, or - * `verified`. + * The state of verification for the person. Possible values are {@code unverified}, {@code + * pending}, or {@code verified}. */ @SerializedName("status") String status; @@ -382,8 +387,8 @@ public static class Verification extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class VerificationDocument extends StripeObject { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") @Getter(lombok.AccessLevel.NONE) @@ -392,34 +397,35 @@ public static class VerificationDocument extends StripeObject { /** * A user-displayable string describing the verification state of this document. For example, if - * a document is uploaded and the picture is too fuzzy, this may say "Identity document is too - * unclear to read". + * a document is uploaded and the picture is too fuzzy, this may say "Identity document is + * too unclear to read". */ @SerializedName("details") String details; /** - * One of `document_corrupt`, `document_country_not_supported`, `document_expired`, - * `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, - * `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, - * `document_invalid`, `document_manipulated`, `document_missing_back`, - * `document_missing_front`, `document_not_readable`, `document_not_uploaded`, - * `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A - * machine-readable code specifying the verification state for this document. + * One of {@code document_corrupt}, {@code document_country_not_supported}, {@code + * document_expired}, {@code document_failed_copy}, {@code document_failed_other}, {@code + * document_failed_test_mode}, {@code document_fraudulent}, {@code document_failed_greyscale}, + * {@code document_incomplete}, {@code document_invalid}, {@code document_manipulated}, {@code + * document_missing_back}, {@code document_missing_front}, {@code document_not_readable}, {@code + * document_not_uploaded}, {@code document_photo_mismatch}, {@code document_too_large}, or + * {@code document_type_not_supported}. A machine-readable code specifying the verification + * state for this document. */ @SerializedName("details_code") String detailsCode; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) ExpandableField front; - /** Get id of expandable `back` object. */ + /** Get ID of expandable {@code back} object. */ public String getBack() { return (this.back != null) ? this.back.getId() : null; } @@ -428,7 +434,7 @@ public void setBack(String id) { this.back = ApiResource.setExpandableFieldId(id, this.back); } - /** Get expanded `back`. */ + /** Get expanded {@code back}. */ public File getBackObject() { return (this.back != null) ? this.back.getExpanded() : null; } @@ -437,7 +443,7 @@ public void setBackObject(File expandableObject) { this.back = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `front` object. */ + /** Get ID of expandable {@code front} object. */ public String getFront() { return (this.front != null) ? this.front.getId() : null; } @@ -446,7 +452,7 @@ public void setFront(String id) { this.front = ApiResource.setExpandableFieldId(id, this.front); } - /** Get expanded `front`. */ + /** Get expanded {@code front}. */ public File getFrontObject() { return (this.front != null) ? this.front.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/Plan.java b/src/main/java/com/stripe/model/Plan.java index c63eb112a78..d4ad3a2f2a3 100644 --- a/src/main/java/com/stripe/model/Plan.java +++ b/src/main/java/com/stripe/model/Plan.java @@ -25,13 +25,13 @@ public class Plan extends ApiResource implements HasId, MetadataStore { Boolean active; /** - * Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are - * `sum` for summing up all usage during a period, `last_during_period` for picking the last usage - * record reported within a period, `last_ever` for picking the last usage record ever (across - * period bounds) or `max` which picks the usage record with the maximum reported usage during a - * period. Defaults to `sum`. + * Specifies a usage aggregation strategy for plans of {@code usage_type=metered}. Allowed values + * are {@code sum} for summing up all usage during a period, {@code last_during_period} for + * picking the last usage record reported within a period, {@code last_ever} for picking the last + * usage record ever (across period bounds) or {@code max} which picks the usage record with the + * maximum reported usage during a period. Defaults to {@code sum}. * - *

One of `last_during_period`, `last_ever`, `max`, or `sum`. + *

One of {@code last_during_period}, {@code last_ever}, {@code max}, or {@code sum}. */ @SerializedName("aggregate_usage") String aggregateUsage; @@ -40,18 +40,19 @@ public class Plan extends ApiResource implements HasId, MetadataStore { @SerializedName("amount") Long amount; - /** Same as `amount`, but contains a decimal value with at most 12 decimal places. */ + /** Same as {@code amount}, but contains a decimal value with at most 12 decimal places. */ @SerializedName("amount_decimal") BigDecimal amountDecimal; /** - * Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` - * indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` - * (for plans with `usage_type=licensed`), or per unit of total usage (for plans with - * `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a - * tiering strategy as defined using the `tiers` and `tiers_mode` attributes. + * Describes how to compute the price per period. Either {@code per_unit} or {@code tiered}. + * {@code per_unit} indicates that the fixed amount (specified in {@code amount}) will be charged + * per unit in {@code quantity} (for plans with {@code usage_type=licensed}), or per unit of total + * usage (for plans with {@code usage_type=metered}). {@code tiered} indicates that the unit + * pricing will be computed using a tiering strategy as defined using the {@code tiers} and {@code + * tiers_mode} attributes. * - *

One of `per_unit`, or `tiered`. + *

One of {@code per_unit}, or {@code tiered}. */ @SerializedName("billing_scheme") String billingScheme; @@ -61,8 +62,8 @@ public class Plan extends ApiResource implements HasId, MetadataStore { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -77,22 +78,23 @@ public class Plan extends ApiResource implements HasId, MetadataStore { String id; /** - * One of `day`, `week`, `month` or `year`. The frequency with which a subscription should be - * billed. + * One of {@code day}, {@code week}, {@code month} or {@code year}. The frequency with which a + * subscription should be billed. */ @SerializedName("interval") String interval; /** - * The number of intervals (specified in the `interval` property) between subscription billings. - * For example, `interval=month` and `interval_count=3` bills every 3 months. + * The number of intervals (specified in the {@code interval} property) between subscription + * billings. For example, {@code interval=month} and {@code interval_count=3} bills every 3 + * months. */ @SerializedName("interval_count") Long intervalCount; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -112,7 +114,7 @@ public class Plan extends ApiResource implements HasId, MetadataStore { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `plan`. + *

Equal to {@code plan}. */ @SerializedName("object") String object; @@ -124,48 +126,49 @@ public class Plan extends ApiResource implements HasId, MetadataStore { ExpandableField product; /** - * Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to - * `tiered`. See also the documentation for `billing_scheme`. + * Each element represents a pricing tier. This parameter requires {@code billing_scheme} to be + * set to {@code tiered}. See also the documentation for {@code billing_scheme}. */ @SerializedName("tiers") List tiers; /** - * Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based - * tiering, the maximum quantity within a period determines the per unit price, in `graduated` - * tiering pricing can successively change as the quantity grows. + * Defines if the tiering price should be {@code graduated} or {@code volume} based. In {@code + * volume}-based tiering, the maximum quantity within a period determines the per unit price, in + * {@code graduated} tiering pricing can successively change as the quantity grows. * - *

One of `graduated`, or `volume`. + *

One of {@code graduated}, or {@code volume}. */ @SerializedName("tiers_mode") String tiersMode; /** * Apply a transformation to the reported usage or set quantity before computing the billed price. - * Cannot be combined with `tiers`. + * Cannot be combined with {@code tiers}. */ @SerializedName("transform_usage") TransformUsage transformUsage; /** - * Default number of trial days when subscribing a customer to this plan using - * [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + * Default number of trial days when subscribing a customer to this plan using {@code + * trial_from_plan=true}. */ @SerializedName("trial_period_days") Long trialPeriodDays; /** - * Configures how the quantity per period should be determined, can be either `metered` or - * `licensed`. `licensed` will automatically bill the `quantity` set when adding it to a - * subscription, `metered` will aggregate the total usage based on usage records. Defaults to - * `licensed`. + * Configures how the quantity per period should be determined, can be either {@code metered} or + * {@code licensed}. {@code licensed} will automatically bill the {@code quantity} set when adding + * it to a subscription, {@code metered} will aggregate the total usage based on usage records. + * Defaults to {@code licensed}. * - *

One of `licensed`, or `metered`. + *

One of {@code licensed}, or {@code metered}. */ @SerializedName("usage_type") String usageType; - /** Get id of expandable `product` object. */ + /** Get ID of expandable {@code product} object. */ public String getProduct() { return (this.product != null) ? this.product.getId() : null; } @@ -174,7 +177,7 @@ public void setProduct(String id) { this.product = ApiResource.setExpandableFieldId(id, this.product); } - /** Get expanded `product`. */ + /** Get expanded {@code product}. */ public Product getProductObject() { return (this.product != null) ? this.product.getExpanded() : null; } @@ -354,7 +357,7 @@ public static class Tier extends StripeObject { @SerializedName("flat_amount") Long flatAmount; - /** Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ + /** Same as {@code flat_amount}, but contains a decimal value with at most 12 decimal places. */ @SerializedName("flat_amount_decimal") BigDecimal flatAmountDecimal; @@ -362,7 +365,7 @@ public static class Tier extends StripeObject { @SerializedName("unit_amount") Long unitAmount; - /** Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ + /** Same as {@code unit_amount}, but contains a decimal value with at most 12 decimal places. */ @SerializedName("unit_amount_decimal") BigDecimal unitAmountDecimal; @@ -380,9 +383,9 @@ public static class TransformUsage extends StripeObject { Long divideBy; /** - * After division, either round the result `up` or `down`. + * After division, either round the result {@code up} or {@code down}. * - *

One of `down`, or `up`. + *

One of {@code down}, or {@code up}. */ @SerializedName("round") String round; diff --git a/src/main/java/com/stripe/model/PlatformTaxFee.java b/src/main/java/com/stripe/model/PlatformTaxFee.java index a8525c36e60..20a5430a1e0 100644 --- a/src/main/java/com/stripe/model/PlatformTaxFee.java +++ b/src/main/java/com/stripe/model/PlatformTaxFee.java @@ -21,7 +21,7 @@ public class PlatformTaxFee extends StripeObject implements BalanceTransactionSo /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `platform_tax_fee`. + *

Equal to {@code platform_tax_fee}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/Product.java b/src/main/java/com/stripe/model/Product.java index e9ddb6adc97..4e9b19b59db 100644 --- a/src/main/java/com/stripe/model/Product.java +++ b/src/main/java/com/stripe/model/Product.java @@ -24,14 +24,15 @@ public class Product extends ApiResource implements HasId, MetadataStore attributes; /** * A short one-line description of the product, meant to be displayable to the customer. Only - * applicable to products of `type=good`. + * applicable to products of {@code type=good}. */ @SerializedName("caption") String caption; @@ -42,7 +43,7 @@ public class Product extends ApiResource implements HasId, MetadataStore deactivateOn; @@ -66,14 +67,14 @@ public class Product extends ApiResource implements HasId, MetadataStore images; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -96,20 +97,20 @@ public class Product extends ApiResource implements HasId, MetadataStoreEqual to `product`. + *

Equal to {@code product}. */ @SerializedName("object") String object; /** * The dimensions of this product for shipping purposes. A SKU associated with this product can - * override this value by having its own `package_dimensions`. Only applicable to products of - * `type=good`. + * override this value by having its own {@code package_dimensions}. Only applicable to products + * of {@code type=good}. */ @SerializedName("package_dimensions") PackageDimensions packageDimensions; - /** Whether this product is a shipped good. Only applicable to products of `type=good`. */ + /** Whether this product is a shipped good. Only applicable to products of {@code type=good}. */ @SerializedName("shippable") Boolean shippable; @@ -122,10 +123,11 @@ public class Product extends ApiResource implements HasId, MetadataStoreOne of `good`, or `service`. + *

One of {@code good}, or {@code service}. */ @SerializedName("type") String type; @@ -142,15 +144,15 @@ public class Product extends ApiResource implements HasId, MetadataStoreProducts. + * href="https://stripe.com/docs/api#create_product">Products. */ public static Product create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -158,7 +160,7 @@ public static Product create(Map params) throws StripeException /** * Creates a new product object. To create a product for use with orders, see Products. + * href="https://stripe.com/docs/api#create_product">Products. */ public static Product create(Map params, RequestOptions options) throws StripeException { @@ -168,7 +170,7 @@ public static Product create(Map params, RequestOptions options) /** * Creates a new product object. To create a product for use with orders, see Products. + * href="https://stripe.com/docs/api#create_product">Products. */ public static Product create(ProductCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -176,7 +178,7 @@ public static Product create(ProductCreateParams params) throws StripeException /** * Creates a new product object. To create a product for use with orders, see Products. + * href="https://stripe.com/docs/api#create_product">Products. */ public static Product create(ProductCreateParams params, RequestOptions options) throws StripeException { diff --git a/src/main/java/com/stripe/model/Recipient.java b/src/main/java/com/stripe/model/Recipient.java index 46a5a7bbafe..73dcf43ec76 100644 --- a/src/main/java/com/stripe/model/Recipient.java +++ b/src/main/java/com/stripe/model/Recipient.java @@ -52,8 +52,8 @@ public class Recipient extends ApiResource implements HasId, MetadataStore metadata; /** - * The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient - * was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to - * it: use the Custom account instead. + * The ID of the Custom account this + * recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be + * made to it: use the Custom account instead. */ @SerializedName("migrated_to") @Getter(lombok.AccessLevel.NONE) @@ -83,7 +83,7 @@ public class Recipient extends ApiResource implements HasId, MetadataStoreEqual to `recipient`. + *

Equal to {@code recipient}. */ @SerializedName("object") String object; @@ -93,7 +93,7 @@ public class Recipient extends ApiResource implements HasId, MetadataStore rolledBackFrom; - /** Type of the recipient, one of `individual` or `corporation`. */ + /** Type of the recipient, one of {@code individual} or {@code corporation}. */ @SerializedName("type") String type; @@ -104,7 +104,7 @@ public class Recipient extends ApiResource implements HasId, MetadataStore(expandableObject.getId(), expandableObject); } - /** Get id of expandable `migratedTo` object. */ + /** Get ID of expandable {@code migratedTo} object. */ public String getMigratedTo() { return (this.migratedTo != null) ? this.migratedTo.getId() : null; } @@ -131,7 +131,7 @@ public void setMigratedTo(String id) { this.migratedTo = ApiResource.setExpandableFieldId(id, this.migratedTo); } - /** Get expanded `migratedTo`. */ + /** Get expanded {@code migratedTo}. */ public Account getMigratedToObject() { return (this.migratedTo != null) ? this.migratedTo.getExpanded() : null; } @@ -140,7 +140,7 @@ public void setMigratedToObject(Account expandableObject) { this.migratedTo = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `rolledBackFrom` object. */ + /** Get ID of expandable {@code rolledBackFrom} object. */ public String getRolledBackFrom() { return (this.rolledBackFrom != null) ? this.rolledBackFrom.getId() : null; } @@ -149,7 +149,7 @@ public void setRolledBackFrom(String id) { this.rolledBackFrom = ApiResource.setExpandableFieldId(id, this.rolledBackFrom); } - /** Get expanded `rolledBackFrom`. */ + /** Get expanded {@code rolledBackFrom}. */ public Account getRolledBackFromObject() { return (this.rolledBackFrom != null) ? this.rolledBackFrom.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/Refund.java b/src/main/java/com/stripe/model/Refund.java index 6ce0039b062..dddb8a1b65b 100644 --- a/src/main/java/com/stripe/model/Refund.java +++ b/src/main/java/com/stripe/model/Refund.java @@ -39,8 +39,8 @@ public class Refund extends ApiResource implements MetadataStore, Balanc Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -62,8 +62,8 @@ public class Refund extends ApiResource implements MetadataStore, Balanc ExpandableField failureBalanceTransaction; /** - * If the refund failed, the reason for refund failure if known. Possible values are - * `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. + * If the refund failed, the reason for refund failure if known. Possible values are {@code + * lost_or_stolen_card}, {@code expired_or_canceled_card}, or {@code unknown}. */ @SerializedName("failure_reason") String failureReason; @@ -84,7 +84,7 @@ public class Refund extends ApiResource implements MetadataStore, Balanc /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `refund`. + *

Equal to {@code refund}. */ @SerializedName("object") String object; @@ -96,8 +96,8 @@ public class Refund extends ApiResource implements MetadataStore, Balanc ExpandableField paymentIntent; /** - * Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or - * `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). + * Reason for the refund, either user-provided ({@code duplicate}, {@code fraudulent}, or {@code + * requested_by_customer}) or generated by Stripe internally ({@code expired_uncaptured_charge}). */ @SerializedName("reason") String reason; @@ -116,9 +116,11 @@ public class Refund extends ApiResource implements MetadataStore, Balanc ExpandableField sourceTransferReversal; /** - * Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. - * For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to - * our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. + * Status of the refund. For credit card refunds, this can be {@code pending}, {@code succeeded}, + * or {@code failed}. For other types of refunds, it can be {@code pending}, {@code succeeded}, + * {@code failed}, or {@code canceled}. Refer to our refunds documentation for more + * details. */ @SerializedName("status") String status; @@ -132,7 +134,7 @@ public class Refund extends ApiResource implements MetadataStore, Balanc @Setter(lombok.AccessLevel.NONE) ExpandableField transferReversal; - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -141,7 +143,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -151,7 +153,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `charge` object. */ + /** Get ID of expandable {@code charge} object. */ public String getCharge() { return (this.charge != null) ? this.charge.getId() : null; } @@ -160,7 +162,7 @@ public void setCharge(String id) { this.charge = ApiResource.setExpandableFieldId(id, this.charge); } - /** Get expanded `charge`. */ + /** Get expanded {@code charge}. */ public Charge getChargeObject() { return (this.charge != null) ? this.charge.getExpanded() : null; } @@ -169,7 +171,7 @@ public void setChargeObject(Charge expandableObject) { this.charge = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `failureBalanceTransaction` object. */ + /** Get ID of expandable {@code failureBalanceTransaction} object. */ public String getFailureBalanceTransaction() { return (this.failureBalanceTransaction != null) ? this.failureBalanceTransaction.getId() : null; } @@ -179,7 +181,7 @@ public void setFailureBalanceTransaction(String id) { ApiResource.setExpandableFieldId(id, this.failureBalanceTransaction); } - /** Get expanded `failureBalanceTransaction`. */ + /** Get expanded {@code failureBalanceTransaction}. */ public BalanceTransaction getFailureBalanceTransactionObject() { return (this.failureBalanceTransaction != null) ? this.failureBalanceTransaction.getExpanded() @@ -191,7 +193,7 @@ public void setFailureBalanceTransactionObject(BalanceTransaction expandableObje new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `paymentIntent` object. */ + /** Get ID of expandable {@code paymentIntent} object. */ public String getPaymentIntent() { return (this.paymentIntent != null) ? this.paymentIntent.getId() : null; } @@ -200,7 +202,7 @@ public void setPaymentIntent(String id) { this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent); } - /** Get expanded `paymentIntent`. */ + /** Get expanded {@code paymentIntent}. */ public PaymentIntent getPaymentIntentObject() { return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null; } @@ -210,7 +212,7 @@ public void setPaymentIntentObject(PaymentIntent expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `sourceTransferReversal` object. */ + /** Get ID of expandable {@code sourceTransferReversal} object. */ public String getSourceTransferReversal() { return (this.sourceTransferReversal != null) ? this.sourceTransferReversal.getId() : null; } @@ -219,7 +221,7 @@ public void setSourceTransferReversal(String id) { this.sourceTransferReversal = ApiResource.setExpandableFieldId(id, this.sourceTransferReversal); } - /** Get expanded `sourceTransferReversal`. */ + /** Get expanded {@code sourceTransferReversal}. */ public TransferReversal getSourceTransferReversalObject() { return (this.sourceTransferReversal != null) ? this.sourceTransferReversal.getExpanded() : null; } @@ -229,7 +231,7 @@ public void setSourceTransferReversalObject(TransferReversal expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `transferReversal` object. */ + /** Get ID of expandable {@code transferReversal} object. */ public String getTransferReversal() { return (this.transferReversal != null) ? this.transferReversal.getId() : null; } @@ -238,7 +240,7 @@ public void setTransferReversal(String id) { this.transferReversal = ApiResource.setExpandableFieldId(id, this.transferReversal); } - /** Get expanded `transferReversal`. */ + /** Get expanded {@code transferReversal}. */ public TransferReversal getTransferReversalObject() { return (this.transferReversal != null) ? this.transferReversal.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/ReserveTransaction.java b/src/main/java/com/stripe/model/ReserveTransaction.java index 7ab2c51a0db..0fa3667ae39 100644 --- a/src/main/java/com/stripe/model/ReserveTransaction.java +++ b/src/main/java/com/stripe/model/ReserveTransaction.java @@ -13,8 +13,8 @@ public class ReserveTransaction extends StripeObject implements BalanceTransacti Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -31,7 +31,7 @@ public class ReserveTransaction extends StripeObject implements BalanceTransacti /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `reserve_transaction`. + *

Equal to {@code reserve_transaction}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/Review.java b/src/main/java/com/stripe/model/Review.java index 02c85fd755a..beb8311d250 100644 --- a/src/main/java/com/stripe/model/Review.java +++ b/src/main/java/com/stripe/model/Review.java @@ -29,8 +29,8 @@ public class Review extends ApiResource implements HasId { ExpandableField charge; /** - * The reason the review was closed, or null if it has not yet been closed. One of `approved`, - * `refunded`, `refunded_as_fraud`, or `disputed`. + * The reason the review was closed, or null if it has not yet been closed. One of {@code + * approved}, {@code refunded}, {@code refunded_as_fraud}, or {@code disputed}. */ @SerializedName("closed_reason") String closedReason; @@ -57,8 +57,8 @@ public class Review extends ApiResource implements HasId { Location ipAddressLocation; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -66,16 +66,16 @@ public class Review extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `review`. + *

Equal to {@code review}. */ @SerializedName("object") String object; - /** If `true`, the review needs action. */ + /** If {@code true}, the review needs action. */ @SerializedName("open") Boolean open; - /** The reason the review was opened. One of `rule` or `manual`. */ + /** The reason the review was opened. One of {@code rule} or {@code manual}. */ @SerializedName("opened_reason") String openedReason; @@ -86,8 +86,8 @@ public class Review extends ApiResource implements HasId { ExpandableField paymentIntent; /** - * The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, - * `refunded`, `refunded_as_fraud`, or `disputed`. + * The reason the review is currently open or closed. One of {@code rule}, {@code manual}, {@code + * approved}, {@code refunded}, {@code refunded_as_fraud}, or {@code disputed}. */ @SerializedName("reason") String reason; @@ -96,7 +96,7 @@ public class Review extends ApiResource implements HasId { @SerializedName("session") Session session; - /** Get id of expandable `charge` object. */ + /** Get ID of expandable {@code charge} object. */ public String getCharge() { return (this.charge != null) ? this.charge.getId() : null; } @@ -105,7 +105,7 @@ public void setCharge(String id) { this.charge = ApiResource.setExpandableFieldId(id, this.charge); } - /** Get expanded `charge`. */ + /** Get expanded {@code charge}. */ public Charge getChargeObject() { return (this.charge != null) ? this.charge.getExpanded() : null; } @@ -114,7 +114,7 @@ public void setChargeObject(Charge expandableObject) { this.charge = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `paymentIntent` object. */ + /** Get ID of expandable {@code paymentIntent} object. */ public String getPaymentIntent() { return (this.paymentIntent != null) ? this.paymentIntent.getId() : null; } @@ -123,7 +123,7 @@ public void setPaymentIntent(String id) { this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent); } - /** Get expanded `paymentIntent`. */ + /** Get expanded {@code paymentIntent}. */ public PaymentIntent getPaymentIntentObject() { return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null; } @@ -272,19 +272,21 @@ public static class Location extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Session extends StripeObject { - /** The browser used in this browser session (e.g., `Chrome`). */ + /** The browser used in this browser session (e.g., {@code Chrome}). */ @SerializedName("browser") String browser; - /** Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ + /** + * Information about the device used for the browser session (e.g., {@code Samsung SM-G930T}). + */ @SerializedName("device") String device; - /** The platform for the browser session (e.g., `Macintosh`). */ + /** The platform for the browser session (e.g., {@code Macintosh}). */ @SerializedName("platform") String platform; - /** The version for the browser session (e.g., `61.0.3163.100`). */ + /** The version for the browser session (e.g., {@code 61.0.3163.100}). */ @SerializedName("version") String version; } diff --git a/src/main/java/com/stripe/model/SetupIntent.java b/src/main/java/com/stripe/model/SetupIntent.java index 882d8ab0279..f1be309a219 100644 --- a/src/main/java/com/stripe/model/SetupIntent.java +++ b/src/main/java/com/stripe/model/SetupIntent.java @@ -28,8 +28,8 @@ public class SetupIntent extends ApiResource implements HasId, MetadataStore application; /** - * Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or - * `duplicate`. + * Reason for cancellation of this SetupIntent, one of {@code abandoned}, {@code + * requested_by_customer}, or {@code duplicate}. */ @SerializedName("cancellation_reason") String cancellationReason; @@ -73,8 +73,8 @@ public class SetupIntent extends ApiResource implements HasId, MetadataStoreEqual to `setup_intent`. + *

Equal to {@code setup_intent}. */ @SerializedName("object") String object; @@ -135,9 +135,9 @@ public class SetupIntent extends ApiResource implements HasId, MetadataStore singleUseMandate; /** - * [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of - * `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, - * `canceled`, or `succeeded`. + * Status of this + * SetupIntent, one of {@code requires_payment_method}, {@code requires_confirmation}, {@code + * requires_action}, {@code processing}, {@code canceled}, or {@code succeeded}. */ @SerializedName("status") String status; @@ -145,14 +145,14 @@ public class SetupIntent extends ApiResource implements HasId, MetadataStoreUse `on_session` if you intend to only reuse the payment method when the customer is in your - * checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If - * not provided, this value defaults to `off_session`. + *

Use {@code on_session} if you intend to only reuse the payment method when the customer is + * in your checkout flow. Use {@code off_session} if your customer may or may not be in your + * checkout flow. If not provided, this value defaults to {@code off_session}. */ @SerializedName("usage") String usage; - /** Get id of expandable `application` object. */ + /** Get ID of expandable {@code application} object. */ public String getApplication() { return (this.application != null) ? this.application.getId() : null; } @@ -161,7 +161,7 @@ public void setApplication(String id) { this.application = ApiResource.setExpandableFieldId(id, this.application); } - /** Get expanded `application`. */ + /** Get expanded {@code application}. */ public Application getApplicationObject() { return (this.application != null) ? this.application.getExpanded() : null; } @@ -170,7 +170,7 @@ public void setApplicationObject(Application expandableObject) { this.application = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -179,7 +179,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -188,7 +188,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `mandate` object. */ + /** Get ID of expandable {@code mandate} object. */ public String getMandate() { return (this.mandate != null) ? this.mandate.getId() : null; } @@ -197,7 +197,7 @@ public void setMandate(String id) { this.mandate = ApiResource.setExpandableFieldId(id, this.mandate); } - /** Get expanded `mandate`. */ + /** Get expanded {@code mandate}. */ public Mandate getMandateObject() { return (this.mandate != null) ? this.mandate.getExpanded() : null; } @@ -206,7 +206,7 @@ public void setMandateObject(Mandate expandableObject) { this.mandate = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `onBehalfOf` object. */ + /** Get ID of expandable {@code onBehalfOf} object. */ public String getOnBehalfOf() { return (this.onBehalfOf != null) ? this.onBehalfOf.getId() : null; } @@ -215,7 +215,7 @@ public void setOnBehalfOf(String id) { this.onBehalfOf = ApiResource.setExpandableFieldId(id, this.onBehalfOf); } - /** Get expanded `onBehalfOf`. */ + /** Get expanded {@code onBehalfOf}. */ public Account getOnBehalfOfObject() { return (this.onBehalfOf != null) ? this.onBehalfOf.getExpanded() : null; } @@ -224,7 +224,7 @@ public void setOnBehalfOfObject(Account expandableObject) { this.onBehalfOf = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `paymentMethod` object. */ + /** Get ID of expandable {@code paymentMethod} object. */ public String getPaymentMethod() { return (this.paymentMethod != null) ? this.paymentMethod.getId() : null; } @@ -233,7 +233,7 @@ public void setPaymentMethod(String id) { this.paymentMethod = ApiResource.setExpandableFieldId(id, this.paymentMethod); } - /** Get expanded `paymentMethod`. */ + /** Get expanded {@code paymentMethod}. */ public PaymentMethod getPaymentMethodObject() { return (this.paymentMethod != null) ? this.paymentMethod.getExpanded() : null; } @@ -243,7 +243,7 @@ public void setPaymentMethodObject(PaymentMethod expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `singleUseMandate` object. */ + /** Get ID of expandable {@code singleUseMandate} object. */ public String getSingleUseMandate() { return (this.singleUseMandate != null) ? this.singleUseMandate.getId() : null; } @@ -252,7 +252,7 @@ public void setSingleUseMandate(String id) { this.singleUseMandate = ApiResource.setExpandableFieldId(id, this.singleUseMandate); } - /** Get expanded `singleUseMandate`. */ + /** Get expanded {@code singleUseMandate}. */ public Mandate getSingleUseMandateObject() { return (this.singleUseMandate != null) ? this.singleUseMandate.getExpanded() : null; } @@ -266,8 +266,8 @@ public void setSingleUseMandateObject(Mandate expandableObject) { * Creates a SetupIntent object. * *

After the SetupIntent is created, attach a payment method and confirm to collect any required permissions to - * charge the payment method later. + * href="https://stripe.com/docs/api/setup_intents/confirm">confirm to collect any required + * permissions to charge the payment method later. */ public static SetupIntent create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -277,8 +277,8 @@ public static SetupIntent create(Map params) throws StripeExcept * Creates a SetupIntent object. * *

After the SetupIntent is created, attach a payment method and confirm to collect any required permissions to - * charge the payment method later. + * href="https://stripe.com/docs/api/setup_intents/confirm">confirm to collect any required + * permissions to charge the payment method later. */ public static SetupIntent create(Map params, RequestOptions options) throws StripeException { @@ -291,8 +291,8 @@ public static SetupIntent create(Map params, RequestOptions opti * Creates a SetupIntent object. * *

After the SetupIntent is created, attach a payment method and confirm to collect any required permissions to - * charge the payment method later. + * href="https://stripe.com/docs/api/setup_intents/confirm">confirm to collect any required + * permissions to charge the payment method later. */ public static SetupIntent create(SetupIntentCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -302,8 +302,8 @@ public static SetupIntent create(SetupIntentCreateParams params) throws StripeEx * Creates a SetupIntent object. * *

After the SetupIntent is created, attach a payment method and confirm to collect any required permissions to - * charge the payment method later. + * href="https://stripe.com/docs/api/setup_intents/confirm">confirm to collect any required + * permissions to charge the payment method later. */ public static SetupIntent create(SetupIntentCreateParams params, RequestOptions options) throws StripeException { @@ -343,7 +343,8 @@ public static SetupIntentCollection list(SetupIntentListParams params, RequestOp * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the SetupIntent object reference for more details. + * refer to the SetupIntent object + * reference for more details. */ public static SetupIntent retrieve(String intent) throws StripeException { return retrieve(intent, (Map) null, (RequestOptions) null); @@ -356,7 +357,8 @@ public static SetupIntent retrieve(String intent) throws StripeException { * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the SetupIntent object reference for more details. + * refer to the SetupIntent object + * reference for more details. */ public static SetupIntent retrieve(String intent, RequestOptions options) throws StripeException { return retrieve(intent, (Map) null, options); @@ -369,7 +371,8 @@ public static SetupIntent retrieve(String intent, RequestOptions options) throws * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the SetupIntent object reference for more details. + * refer to the SetupIntent object + * reference for more details. */ public static SetupIntent retrieve( String intent, Map params, RequestOptions options) throws StripeException { @@ -389,7 +392,8 @@ public static SetupIntent retrieve( * is provided in the query string. * *

When retrieved with a publishable key, only a subset of properties will be returned. Please - * refer to the SetupIntent object reference for more details. + * refer to the SetupIntent object + * reference for more details. */ public static SetupIntent retrieve( String intent, SetupIntentRetrieveParams params, RequestOptions options) @@ -642,7 +646,9 @@ public static class NextAction extends StripeObject { @SerializedName("redirect_to_url") NextActionRedirectToUrl redirectToUrl; - /** Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`. */ + /** + * Type of the next action to perform, one of {@code redirect_to_url} or {@code use_stripe_sdk}. + */ @SerializedName("type") String type; @@ -684,15 +690,16 @@ public static class PaymentMethodOptions extends StripeObject { public static class Card extends StripeObject { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish - * to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on - * how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our SCA + * Engine. * - *

One of `any`, `automatic`, or `challenge_only`. + *

One of {@code any}, {@code automatic}, or {@code challenge_only}. */ @SerializedName("request_three_d_secure") String requestThreeDSecure; diff --git a/src/main/java/com/stripe/model/Sku.java b/src/main/java/com/stripe/model/Sku.java index b1e42a6462d..d1995043a8c 100644 --- a/src/main/java/com/stripe/model/Sku.java +++ b/src/main/java/com/stripe/model/Sku.java @@ -24,8 +24,8 @@ public class Sku extends ApiResource implements HasId, MetadataStore { /** * A dictionary of attributes and values for the attributes defined by the product. If, for - * example, a product's attributes are `["size", "gender"]`, a valid SKU has the following - * dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. + * example, a product's attributes are {@code ["size", "gender"]}, a valid SKU has the following + * dictionary of attributes: {@code {"size": "Medium", "gender": "Unisex"}}. */ @SerializedName("attributes") Map attributes; @@ -35,8 +35,8 @@ public class Sku extends ApiResource implements HasId, MetadataStore { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -58,8 +58,8 @@ public class Sku extends ApiResource implements HasId, MetadataStore { Inventory inventory; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -75,7 +75,7 @@ public class Sku extends ApiResource implements HasId, MetadataStore { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `sku`. + *

Equal to {@code sku}. */ @SerializedName("object") String object; @@ -101,7 +101,7 @@ public class Sku extends ApiResource implements HasId, MetadataStore { @SerializedName("updated") Long updated; - /** Get id of expandable `product` object. */ + /** Get ID of expandable {@code product} object. */ public String getProduct() { return (this.product != null) ? this.product.getId() : null; } @@ -110,7 +110,7 @@ public void setProduct(String id) { this.product = ApiResource.setExpandableFieldId(id, this.product); } - /** Get expanded `product`. */ + /** Get expanded {@code product}. */ public Product getProductObject() { return (this.product != null) ? this.product.getExpanded() : null; } @@ -303,17 +303,24 @@ public Sku delete(Map params, RequestOptions options) throws Str @Setter @EqualsAndHashCode(callSuper = false) public static class Inventory extends StripeObject { - /** The count of inventory available. Will be present if and only if `type` is `finite`. */ + /** + * The count of inventory available. Will be present if and only if {@code type} is {@code + * finite}. + */ @SerializedName("quantity") Long quantity; - /** Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ + /** + * Inventory type. Possible values are {@code finite}, {@code bucket} (not quantified), and + * {@code infinite}. + */ @SerializedName("type") String type; /** - * An indicator of the inventory available. Possible values are `in_stock`, `limited`, and - * `out_of_stock`. Will be present if and only if `type` is `bucket`. + * An indicator of the inventory available. Possible values are {@code in_stock}, {@code + * limited}, and {@code out_of_stock}. Will be present if and only if {@code type} is {@code + * bucket}. */ @SerializedName("value") String value; diff --git a/src/main/java/com/stripe/model/Source.java b/src/main/java/com/stripe/model/Source.java index 3faf7539f0a..ef69dd04bd5 100644 --- a/src/main/java/com/stripe/model/Source.java +++ b/src/main/java/com/stripe/model/Source.java @@ -37,7 +37,7 @@ public class Source extends ApiResource implements MetadataStore, Paymen * A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, * Japanese Yen being a zero-decimal currency) representing the total amount associated with the * source. This is the amount for which the source will be chargeable once ready. Required for - * `single_use` sources. + * {@code single_use} sources. */ @SerializedName("amount") Long amount; @@ -66,9 +66,9 @@ public class Source extends ApiResource implements MetadataStore, Paymen Long created; /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with - * the source. This is the currency for which the source will be chargeable once ready. Required - * for `single_use` sources. + * Three-letter ISO code for the currency + * associated with the source. This is the currency for which the source will be chargeable once + * ready. Required for {@code single_use} sources. */ @SerializedName("currency") String currency; @@ -84,8 +84,8 @@ public class Source extends ApiResource implements MetadataStore, Paymen Eps eps; /** - * The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, - * `code_verification`, `none`. + * The authentication {@code flow} of the source. {@code flow} is one of {@code redirect}, {@code + * receiver}, {@code code_verification}, {@code none}. */ @SerializedName("flow") String flow; @@ -105,8 +105,8 @@ public class Source extends ApiResource implements MetadataStore, Paymen Klarna klarna; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -125,7 +125,7 @@ public class Source extends ApiResource implements MetadataStore, Paymen /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `source`. + *

Equal to {@code source}. */ @SerializedName("object") String object; @@ -166,8 +166,8 @@ public class Source extends ApiResource implements MetadataStore, Paymen String statementDescriptor; /** - * The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. - * Only `chargeable` sources can be used to create a charge. + * The status of the source, one of {@code canceled}, {@code chargeable}, {@code consumed}, {@code + * failed}, or {@code pending}. Only {@code chargeable} sources can be used to create a charge. */ @SerializedName("status") String status; @@ -176,19 +176,21 @@ public class Source extends ApiResource implements MetadataStore, Paymen ThreeDSecure threeDSecure; /** - * The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, - * `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, - * `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An - * additional hash is included on the source with a name matching this value. It contains - * additional information specific to the [payment method](https://stripe.com/docs/sources) used. + * The {@code type} of the source. The {@code type} is a payment method, one of {@code + * ach_credit_transfer}, {@code ach_debit}, {@code alipay}, {@code bancontact}, {@code card}, + * {@code card_present}, {@code eps}, {@code giropay}, {@code ideal}, {@code multibanco}, {@code + * klarna}, {@code p24}, {@code sepa_debit}, {@code sofort}, {@code three_d_secure}, or {@code + * wechat}. An additional hash is included on the source with a name matching this value. It + * contains additional information specific to the payment method used. */ @SerializedName("type") String type; /** - * Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source - * types may or may not be reusable by construction, while others may leave the option at - * creation. If an incompatible value is passed, an error will be returned. + * Either {@code reusable} or {@code single_use}. Whether this source should be reusable or not. + * Some source types may or may not be reusable by construction, while others may leave the option + * at creation. If an incompatible value is passed, an error will be returned. */ @SerializedName("usage") String usage; @@ -311,7 +313,7 @@ public static Source create(SourceCreateParams params, RequestOptions options) * *

This request accepts the metadata and owner as arguments. It is * also possible to update type specific information for selected payment methods. Please refer to - * our payment method guides for more detail. + * our payment method guides for more detail. */ @Override public Source update(Map params) throws StripeException { @@ -324,7 +326,7 @@ public Source update(Map params) throws StripeException { * *

This request accepts the metadata and owner as arguments. It is * also possible to update type specific information for selected payment methods. Please refer to - * our payment method guides for more detail. + * our payment method guides for more detail. */ @Override public Source update(Map params, RequestOptions options) throws StripeException { @@ -342,7 +344,7 @@ public Source update(Map params, RequestOptions options) throws * *

This request accepts the metadata and owner as arguments. It is * also possible to update type specific information for selected payment methods. Please refer to - * our payment method guides for more detail. + * our payment method guides for more detail. */ public Source update(SourceUpdateParams params) throws StripeException { return update(params, (RequestOptions) null); @@ -354,7 +356,7 @@ public Source update(SourceUpdateParams params) throws StripeException { * *

This request accepts the metadata and owner as arguments. It is * also possible to update type specific information for selected payment methods. Please refer to - * our payment method guides for more detail. + * our payment method guides for more detail. */ public Source update(SourceUpdateParams params, RequestOptions options) throws StripeException { String url = @@ -724,10 +726,10 @@ public static class CodeVerificationFlow extends StripeObject { Long attemptsRemaining; /** - * The status of the code verification, either `pending` (awaiting verification, - * `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or - * `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be - * 0). + * The status of the code verification, either {@code pending} (awaiting verification, {@code + * attempts_remaining} should be greater than 0), {@code succeeded} (successful verification) or + * {@code failed} (failed verification, cannot be verified anymore as {@code attempts_remaining} + * should be 0). */ @SerializedName("status") String status; @@ -905,8 +907,9 @@ public static class Order extends StripeObject { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ @SerializedName("currency") String currency; @@ -931,7 +934,7 @@ public static class OrderItem extends StripeObject { @SerializedName("amount") Long amount; - /** This currency of this order item. Required when `amount` is present. */ + /** This currency of this order item. Required when {@code amount} is present. */ @SerializedName("currency") String currency; @@ -940,13 +943,13 @@ public static class OrderItem extends StripeObject { String description; /** - * The quantity of this order item. When type is `sku`, this is the number of instances of the - * SKU to be ordered. + * The quantity of this order item. When type is {@code sku}, this is the number of instances of + * the SKU to be ordered. */ @SerializedName("quantity") Long quantity; - /** The type of this order item. Must be `sku`, `tax`, or `shipping`. */ + /** The type of this order item. Must be {@code sku}, {@code tax}, or {@code shipping}. */ @SerializedName("type") String type; } @@ -1031,8 +1034,8 @@ public static class ReceiverFlow extends StripeObject { Long amountCharged; /** - * The total amount received by the receiver source. `amount_received = amount_returned + - * amount_charged` is true at all time. The amount received is expressed in the source's + * The total amount received by the receiver source. {@code amount_received = amount_returned + + * amount_charged} is true at all time. The amount received is expressed in the source's * currency. */ @SerializedName("amount_received") @@ -1045,11 +1048,14 @@ public static class ReceiverFlow extends StripeObject { @SerializedName("amount_returned") Long amountReturned; - /** Type of refund attribute method, one of `email`, `manual`, or `none`. */ + /** Type of refund attribute method, one of {@code email}, {@code manual}, or {@code none}. */ @SerializedName("refund_attributes_method") String refundAttributesMethod; - /** Type of refund attribute status, one of `missing`, `requested`, or `available`. */ + /** + * Type of refund attribute status, one of {@code missing}, {@code requested}, or {@code + * available}. + */ @SerializedName("refund_attributes_status") String refundAttributesStatus; } @@ -1059,10 +1065,10 @@ public static class ReceiverFlow extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class RedirectFlow extends StripeObject { /** - * The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out - * of the redirect flow), `declined` (the authentication failed or the transaction was - * declined), or `processing_error` (the redirect failed due to a technical error). Present only - * if the redirect status is `failed`. + * The failure reason for the redirect, either {@code user_abort} (the customer aborted or + * dropped out of the redirect flow), {@code declined} (the authentication failed or the + * transaction was declined), or {@code processing_error} (the redirect failed due to a + * technical error). Present only if the redirect status is {@code failed}. */ @SerializedName("failure_reason") String failureReason; @@ -1072,17 +1078,17 @@ public static class RedirectFlow extends StripeObject { String returnUrl; /** - * The status of the redirect, either `pending` (ready to be used by your customer to - * authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or - * `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be - * reused). + * The status of the redirect, either {@code pending} (ready to be used by your customer to + * authenticate the transaction), {@code succeeded} (succesful authentication, cannot be reused) + * or {@code not_required} (redirect should not be used) or {@code failed} (failed + * authentication, cannot be reused). */ @SerializedName("status") String status; /** - * The URL provided to you to redirect a customer to as part of a `redirect` authentication - * flow. + * The URL provided to you to redirect a customer to as part of a {@code redirect} + * authentication flow. */ @SerializedName("url") String url; diff --git a/src/main/java/com/stripe/model/SourceMandateNotification.java b/src/main/java/com/stripe/model/SourceMandateNotification.java index 4c08aa66610..5b2eb8cfa22 100644 --- a/src/main/java/com/stripe/model/SourceMandateNotification.java +++ b/src/main/java/com/stripe/model/SourceMandateNotification.java @@ -13,7 +13,7 @@ public class SourceMandateNotification extends StripeObject implements HasId { * A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, * Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate * notification. The amount is expressed in the currency of the underlying source. Required if the - * notification type is `debit_initiated`. + * notification type is {@code debit_initiated}. */ @SerializedName("amount") Long amount; @@ -31,8 +31,8 @@ public class SourceMandateNotification extends StripeObject implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -40,14 +40,14 @@ public class SourceMandateNotification extends StripeObject implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `source_mandate_notification`. + *

Equal to {@code source_mandate_notification}. */ @SerializedName("object") String object; /** - * The reason of the mandate notification. Valid reasons are `mandate_confirmed` or - * `debit_initiated`. + * The reason of the mandate notification. Valid reasons are {@code mandate_confirmed} or {@code + * debit_initiated}. */ @SerializedName("reason") String reason; @@ -58,13 +58,16 @@ public class SourceMandateNotification extends StripeObject implements HasId { @SerializedName("source") Source source; - /** The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ + /** + * The status of the mandate notification. Valid statuses are {@code pending} or {@code + * submitted}. + */ @SerializedName("status") String status; /** * The type of source this mandate notification is attached to. Should be the source type - * identifier code for the payment method, such as `three_d_secure`. + * identifier code for the payment method, such as {@code three_d_secure}. */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/SourceTransaction.java b/src/main/java/com/stripe/model/SourceTransaction.java index a05b8b8ef5f..4137ba8cd02 100644 --- a/src/main/java/com/stripe/model/SourceTransaction.java +++ b/src/main/java/com/stripe/model/SourceTransaction.java @@ -28,8 +28,8 @@ public class SourceTransaction extends StripeObject implements HasId { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -43,8 +43,8 @@ public class SourceTransaction extends StripeObject implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -52,7 +52,7 @@ public class SourceTransaction extends StripeObject implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `source_transaction`. + *

Equal to {@code source_transaction}. */ @SerializedName("object") String object; @@ -67,16 +67,19 @@ public class SourceTransaction extends StripeObject implements HasId { @SerializedName("source") String source; - /** The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ + /** + * The status of the transaction, one of {@code succeeded}, {@code pending}, or {@code failed}. + */ @SerializedName("status") String status; /** * The type of source this transaction is attached to. * - *

One of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, - * `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, - * `three_d_secure`, or `wechat`. + *

One of {@code ach_credit_transfer}, {@code ach_debit}, {@code alipay}, {@code bancontact}, + * {@code card}, {@code card_present}, {@code eps}, {@code giropay}, {@code ideal}, {@code + * klarna}, {@code multibanco}, {@code p24}, {@code sepa_debit}, {@code sofort}, {@code + * three_d_secure}, or {@code wechat}. */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/StripeError.java b/src/main/java/com/stripe/model/StripeError.java index 04f1353f419..6c66177b4fd 100644 --- a/src/main/java/com/stripe/model/StripeError.java +++ b/src/main/java/com/stripe/model/StripeError.java @@ -14,22 +14,23 @@ public class StripeError extends StripeObject { String charge; /** - * For some errors that could be handled programmatically, a short string indicating the [error - * code](https://stripe.com/docs/error-codes) reported. + * For some errors that could be handled programmatically, a short string indicating the error code reported. */ @SerializedName("code") String code; /** - * For card errors resulting from a card issuer decline, a short string indicating the [card - * issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they - * provide one. + * For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the + * decline if they provide one. */ @SerializedName("decline_code") String declineCode; /** - * A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. + * A URL to more information about the error + * code reported. */ @SerializedName("doc_url") String docUrl; @@ -61,8 +62,9 @@ public class StripeError extends StripeObject { PaymentSource source; /** - * The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, - * `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error` + * The type of error returned. One of {@code api_connection_error}, {@code api_error}, {@code + * authentication_error}, {@code card_error}, {@code idempotency_error}, {@code + * invalid_request_error}, or {@code rate_limit_error} */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/Subscription.java b/src/main/java/com/stripe/model/Subscription.java index 4a745dad64f..45a955f1636 100644 --- a/src/main/java/com/stripe/model/Subscription.java +++ b/src/main/java/com/stripe/model/Subscription.java @@ -30,8 +30,8 @@ public class Subscription extends ApiResource implements HasId, MetadataStoreOne of `charge_automatically`, or `send_invoice`. + *

One of {@code charge_automatically}, or {@code send_invoice}. */ @SerializedName("collection_method") String collectionMethod; @@ -99,7 +99,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStore defaultSource; /** - * The tax rates that will apply to any subscription item that does not have `tax_rates` set. - * Invoices created will have their `default_tax_rates` populated from the subscription. + * The tax rates that will apply to any subscription item that does not have {@code tax_rates} + * set. Invoices created will have their {@code default_tax_rates} populated from the + * subscription. */ @SerializedName("default_tax_rates") List defaultTaxRates; @@ -158,8 +159,8 @@ public class Subscription extends ApiResource implements HasId, MetadataStore latestInvoice; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -174,7 +175,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStoreEqual to `subscription`. + *

Equal to {@code subscription}. */ @SerializedName("object") String object; /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given - * subscription at the specified interval. + * calling Create an invoice for the + * given subscription at the specified interval. */ @SerializedName("pending_invoice_item_interval") PendingInvoiceItemInterval pendingInvoiceItemInterval; /** - * You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user - * authentication when creating a subscription without immediate payment or updating a + * You can use this SetupIntent to collect + * user authentication when creating a subscription without immediate payment or updating a * subscription's payment method, allowing you to optimize for off-session payments. Learn more in - * the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). + * the SCA + * Migration Guide. */ @SerializedName("pending_setup_intent") @Getter(lombok.AccessLevel.NONE) @@ -208,8 +210,9 @@ public class Subscription extends ApiResource implements HasId, MetadataStore pendingSetupIntent; /** - * If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) - * that will be applied to the subscription once the `latest_invoice` has been paid. + * If specified, pending + * updates that will be applied to the subscription once the {@code latest_invoice} has been + * paid. */ @SerializedName("pending_update") PendingUpdate pendingUpdate; @@ -236,39 +239,39 @@ public class Subscription extends ApiResource implements HasId, MetadataStore schedule; /** - * Date when the subscription was first created. The date might differ from the `created` date due - * to backdating. + * Date when the subscription was first created. The date might differ from the {@code created} + * date due to backdating. */ @SerializedName("start_date") Long startDate; /** - * Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, - * `canceled`, or `unpaid`. + * Possible values are {@code incomplete}, {@code incomplete_expired}, {@code trialing}, {@code + * active}, {@code past_due}, {@code canceled}, or {@code unpaid}. * - *

For `collection_method=charge_automatically` a subscription moves into `incomplete` if the - * initial payment attempt fails. A subscription in this state can only have metadata and - * default_source updated. Once the first invoice is paid, the subscription moves into an `active` - * state. If the first invoice is not paid within 23 hours, the subscription transitions to - * `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further - * invoices will be generated. + *

For {@code collection_method=charge_automatically} a subscription moves into {@code + * incomplete} if the initial payment attempt fails. A subscription in this state can only have + * metadata and default_source updated. Once the first invoice is paid, the subscription moves + * into an {@code active} state. If the first invoice is not paid within 23 hours, the + * subscription transitions to {@code incomplete_expired}. This is a terminal state, the open + * invoice will be voided and no further invoices will be generated. * - *

A subscription that is currently in a trial period is `trialing` and moves to `active` when - * the trial period is over. + *

A subscription that is currently in a trial period is {@code trialing} and moves to {@code + * active} when the trial period is over. * - *

If subscription `collection_method=charge_automatically` it becomes `past_due` when payment - * to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when - * Stripe has exhausted all payment retry attempts. + *

If subscription {@code collection_method=charge_automatically} it becomes {@code past_due} + * when payment to renew it fails and {@code canceled} or {@code unpaid} (depending on your + * subscriptions settings) when Stripe has exhausted all payment retry attempts. * - *

If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is - * not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional - * deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent - * invoices will be attempted (invoices will be created, but then immediately automatically - * closed). After receiving updated payment information from a customer, you may choose to reopen - * and pay their closed invoices. + *

If subscription {@code collection_method=send_invoice} it becomes {@code past_due} when its + * invoice is not paid by the due date, and {@code canceled} or {@code unpaid} if it is still not + * paid by an additional deadline after that. Note that when a subscription has a status of {@code + * unpaid}, no subsequent invoices will be attempted (invoices will be created, but then + * immediately automatically closed). After receiving updated payment information from a customer, + * you may choose to reopen and pay their closed invoices. * - *

One of `active`, `canceled`, `incomplete`, `incomplete_expired`, `past_due`, `trialing`, or - * `unpaid`. + *

One of {@code active}, {@code canceled}, {@code incomplete}, {@code incomplete_expired}, + * {@code past_due}, {@code trialing}, or {@code unpaid}. */ @SerializedName("status") String status; @@ -295,7 +298,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStore(expandableObject.getId(), expandableObject); } - /** Get id of expandable `defaultPaymentMethod` object. */ + /** Get ID of expandable {@code defaultPaymentMethod} object. */ public String getDefaultPaymentMethod() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getId() : null; } @@ -322,7 +325,7 @@ public void setDefaultPaymentMethod(String id) { this.defaultPaymentMethod = ApiResource.setExpandableFieldId(id, this.defaultPaymentMethod); } - /** Get expanded `defaultPaymentMethod`. */ + /** Get expanded {@code defaultPaymentMethod}. */ public PaymentMethod getDefaultPaymentMethodObject() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getExpanded() : null; } @@ -332,7 +335,7 @@ public void setDefaultPaymentMethodObject(PaymentMethod expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `defaultSource` object. */ + /** Get ID of expandable {@code defaultSource} object. */ public String getDefaultSource() { return (this.defaultSource != null) ? this.defaultSource.getId() : null; } @@ -341,7 +344,7 @@ public void setDefaultSource(String id) { this.defaultSource = ApiResource.setExpandableFieldId(id, this.defaultSource); } - /** Get expanded `defaultSource`. */ + /** Get expanded {@code defaultSource}. */ public PaymentSource getDefaultSourceObject() { return (this.defaultSource != null) ? this.defaultSource.getExpanded() : null; } @@ -351,7 +354,7 @@ public void setDefaultSourceObject(PaymentSource expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `latestInvoice` object. */ + /** Get ID of expandable {@code latestInvoice} object. */ public String getLatestInvoice() { return (this.latestInvoice != null) ? this.latestInvoice.getId() : null; } @@ -360,7 +363,7 @@ public void setLatestInvoice(String id) { this.latestInvoice = ApiResource.setExpandableFieldId(id, this.latestInvoice); } - /** Get expanded `latestInvoice`. */ + /** Get expanded {@code latestInvoice}. */ public Invoice getLatestInvoiceObject() { return (this.latestInvoice != null) ? this.latestInvoice.getExpanded() : null; } @@ -369,7 +372,7 @@ public void setLatestInvoiceObject(Invoice expandableObject) { this.latestInvoice = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `pendingSetupIntent` object. */ + /** Get ID of expandable {@code pendingSetupIntent} object. */ public String getPendingSetupIntent() { return (this.pendingSetupIntent != null) ? this.pendingSetupIntent.getId() : null; } @@ -378,7 +381,7 @@ public void setPendingSetupIntent(String id) { this.pendingSetupIntent = ApiResource.setExpandableFieldId(id, this.pendingSetupIntent); } - /** Get expanded `pendingSetupIntent`. */ + /** Get expanded {@code pendingSetupIntent}. */ public SetupIntent getPendingSetupIntentObject() { return (this.pendingSetupIntent != null) ? this.pendingSetupIntent.getExpanded() : null; } @@ -388,7 +391,7 @@ public void setPendingSetupIntentObject(SetupIntent expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `schedule` object. */ + /** Get ID of expandable {@code schedule} object. */ public String getSchedule() { return (this.schedule != null) ? this.schedule.getId() : null; } @@ -397,7 +400,7 @@ public void setSchedule(String id) { this.schedule = ApiResource.setExpandableFieldId(id, this.schedule); } - /** Get expanded `schedule`. */ + /** Get expanded {@code schedule}. */ public SubscriptionSchedule getScheduleObject() { return (this.schedule != null) ? this.schedule.getExpanded() : null; } @@ -485,7 +488,7 @@ public static Subscription create(SubscriptionCreateParams params, RequestOption * Updates an existing subscription on a customer to match the specified parameters. When changing * plans or quantities, we will optionally prorate the price we charge next month to make up for * any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint. + * href="https://stripe.com/docs/api#upcoming_invoice">upcoming invoice endpoint. */ @Override public Subscription update(Map params) throws StripeException { @@ -496,7 +499,7 @@ public Subscription update(Map params) throws StripeException { * Updates an existing subscription on a customer to match the specified parameters. When changing * plans or quantities, we will optionally prorate the price we charge next month to make up for * any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint. + * href="https://stripe.com/docs/api#upcoming_invoice">upcoming invoice endpoint. */ @Override public Subscription update(Map params, RequestOptions options) @@ -514,7 +517,7 @@ public Subscription update(Map params, RequestOptions options) * Updates an existing subscription on a customer to match the specified parameters. When changing * plans or quantities, we will optionally prorate the price we charge next month to make up for * any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint. + * href="https://stripe.com/docs/api#upcoming_invoice">upcoming invoice endpoint. */ public Subscription update(SubscriptionUpdateParams params) throws StripeException { return update(params, (RequestOptions) null); @@ -524,7 +527,7 @@ public Subscription update(SubscriptionUpdateParams params) throws StripeExcepti * Updates an existing subscription on a customer to match the specified parameters. When changing * plans or quantities, we will optionally prorate the price we charge next month to make up for * any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint. + * href="https://stripe.com/docs/api#upcoming_invoice">upcoming invoice endpoint. */ public Subscription update(SubscriptionUpdateParams params, RequestOptions options) throws StripeException { @@ -579,9 +582,10 @@ public static Subscription retrieve( * subscription. * *

Note, however, that any pending invoice items that you’ve created will still be charged for - * at the end of the period, unless manually deleted. If you’ve - * set the subscription to cancel at the end of the period, any pending prorations will also be - * left in place and collected at the end of the period. But if the subscription is set to cancel + * at the end of the period, unless manually deleted. If you’ve set the + * subscription to cancel at the end of the period, any pending prorations will also be left in + * place and collected at the end of the period. But if the subscription is set to cancel * immediately, pending prorations will be removed. * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all @@ -599,9 +603,10 @@ public Subscription cancel() throws StripeException { * subscription. * *

Note, however, that any pending invoice items that you’ve created will still be charged for - * at the end of the period, unless manually deleted. If you’ve - * set the subscription to cancel at the end of the period, any pending prorations will also be - * left in place and collected at the end of the period. But if the subscription is set to cancel + * at the end of the period, unless manually deleted. If you’ve set the + * subscription to cancel at the end of the period, any pending prorations will also be left in + * place and collected at the end of the period. But if the subscription is set to cancel * immediately, pending prorations will be removed. * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all @@ -619,9 +624,10 @@ public Subscription cancel(Map params) throws StripeException { * subscription. * *

Note, however, that any pending invoice items that you’ve created will still be charged for - * at the end of the period, unless manually deleted. If you’ve - * set the subscription to cancel at the end of the period, any pending prorations will also be - * left in place and collected at the end of the period. But if the subscription is set to cancel + * at the end of the period, unless manually deleted. If you’ve set the + * subscription to cancel at the end of the period, any pending prorations will also be left in + * place and collected at the end of the period. But if the subscription is set to cancel * immediately, pending prorations will be removed. * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all @@ -646,9 +652,10 @@ public Subscription cancel(Map params, RequestOptions options) * subscription. * *

Note, however, that any pending invoice items that you’ve created will still be charged for - * at the end of the period, unless manually deleted. If you’ve - * set the subscription to cancel at the end of the period, any pending prorations will also be - * left in place and collected at the end of the period. But if the subscription is set to cancel + * at the end of the period, unless manually deleted. If you’ve set the + * subscription to cancel at the end of the period, any pending prorations will also be left in + * place and collected at the end of the period. But if the subscription is set to cancel * immediately, pending prorations will be removed. * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all @@ -666,9 +673,10 @@ public Subscription cancel(SubscriptionCancelParams params) throws StripeExcepti * subscription. * *

Note, however, that any pending invoice items that you’ve created will still be charged for - * at the end of the period, unless manually deleted. If you’ve - * set the subscription to cancel at the end of the period, any pending prorations will also be - * left in place and collected at the end of the period. But if the subscription is set to cancel + * at the end of the period, unless manually deleted. If you’ve set the + * subscription to cancel at the end of the period, any pending prorations will also be left in + * place and collected at the end of the period. But if the subscription is set to cancel * immediately, pending prorations will be removed. * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all @@ -719,10 +727,10 @@ public static class BillingThresholds extends StripeObject { Long amountGte; /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, - * `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; - * otherwise, the value will remain unchanged. This value may not be `true` if the subscription - * contains items with plans that have `aggregate_usage=last_ever`. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. If + * true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was last + * reached; otherwise, the value will remain unchanged. This value may not be {@code true} if + * the subscription contains items with plans that have {@code aggregate_usage=last_ever}. */ @SerializedName("reset_billing_cycle_anchor") Boolean resetBillingCycleAnchor; @@ -733,16 +741,17 @@ public static class BillingThresholds extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class PendingInvoiceItemInterval extends StripeObject { /** - * Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. + * Specifies invoicing frequency. Either {@code day}, {@code week}, {@code month} or {@code + * year}. * - *

One of `day`, `month`, `week`, or `year`. + *

One of {@code day}, {@code month}, {@code week}, or {@code year}. */ @SerializedName("interval") String interval; /** - * The number of intervals between invoices. For example, `interval=month` and - * `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 + * The number of intervals between invoices. For example, {@code interval=month} and {@code + * interval_count=3} bills every 3 months. Maximum of one year interval allowed (1 year, 12 * months, or 52 weeks). */ @SerializedName("interval_count") @@ -755,7 +764,7 @@ public static class PendingInvoiceItemInterval extends StripeObject { public static class PendingUpdate extends StripeObject { /** * If the update is applied, determines the date of the first full invoice, and, for plans with - * `month` or `year` intervals, the day of the month for subsequent invoices. + * {@code month} or {@code year} intervals, the day of the month for subsequent invoices. */ @SerializedName("billing_cycle_anchor") Long billingCycleAnchor; @@ -782,9 +791,9 @@ public static class PendingUpdate extends StripeObject { Long trialEnd; /** - * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting - * `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to - * `true` together with `trial_end` is not allowed. + * Indicates if a plan's {@code trial_period_days} should be applied to the subscription. + * Setting {@code trial_end} per subscription is preferred, and this defaults to {@code false}. + * Setting this flag to {@code true} together with {@code trial_end} is not allowed. */ @SerializedName("trial_from_plan") Boolean trialFromPlan; diff --git a/src/main/java/com/stripe/model/SubscriptionItem.java b/src/main/java/com/stripe/model/SubscriptionItem.java index 60c9badd5e2..14b4d49f775 100644 --- a/src/main/java/com/stripe/model/SubscriptionItem.java +++ b/src/main/java/com/stripe/model/SubscriptionItem.java @@ -53,7 +53,7 @@ public class SubscriptionItem extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `subscription_item`. + *

Equal to {@code subscription_item}. */ @SerializedName("object") String object; @@ -62,19 +62,19 @@ public class SubscriptionItem extends ApiResource Plan plan; /** - * The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the - * customer should be subscribed. + * The quantity of the plan to + * which the customer should be subscribed. */ @SerializedName("quantity") Long quantity; - /** The `subscription` this `subscription_item` belongs to. */ + /** The {@code subscription} this {@code subscription_item} belongs to. */ @SerializedName("subscription") String subscription; /** - * The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the - * subscription do not apply to this `subscription_item`. + * The tax rates which apply to this {@code subscription_item}. When set, the {@code + * default_tax_rates} on the subscription do not apply to this {@code subscription_item}. */ @SerializedName("tax_rates") List taxRates; diff --git a/src/main/java/com/stripe/model/SubscriptionSchedule.java b/src/main/java/com/stripe/model/SubscriptionSchedule.java index f90e0d171da..57ef65c748c 100644 --- a/src/main/java/com/stripe/model/SubscriptionSchedule.java +++ b/src/main/java/com/stripe/model/SubscriptionSchedule.java @@ -42,7 +42,7 @@ public class SubscriptionSchedule extends ApiResource /** * Object representing the start and end dates for the current phase of the subscription schedule, - * if it is `active`. + * if it is {@code active}. */ @SerializedName("current_phase") CurrentPhase currentPhase; @@ -59,7 +59,7 @@ public class SubscriptionSchedule extends ApiResource /** * Behavior of the subscription schedule and underlying subscription when it ends. * - *

One of `cancel`, `none`, `release`, or `renew`. + *

One of {@code cancel}, {@code none}, {@code release}, or {@code renew}. */ @SerializedName("end_behavior") String endBehavior; @@ -70,8 +70,8 @@ public class SubscriptionSchedule extends ApiResource String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -87,7 +87,7 @@ public class SubscriptionSchedule extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `subscription_schedule`. + *

Equal to {@code subscription_schedule}. */ @SerializedName("object") String object; @@ -108,17 +108,19 @@ public class SubscriptionSchedule extends ApiResource /** * This field has been deprecated. Interval and duration at which the subscription schedule renews - * for when it ends if `renewal_behavior` is `renew`. + * for when it ends if {@code renewal_behavior} is {@code renew}. */ @SerializedName("renewal_interval") RenewalInterval renewalInterval; /** - * The present status of the subscription schedule. Possible values are `not_started`, `active`, - * `completed`, `released`, and `canceled`. You can read more about the different states in our - * [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). + * The present status of the subscription schedule. Possible values are {@code not_started}, + * {@code active}, {@code completed}, {@code released}, and {@code canceled}. You can read more + * about the different states in our behavior guide. * - *

One of `active`, `canceled`, `completed`, `not_started`, or `released`. + *

One of {@code active}, {@code canceled}, {@code completed}, {@code not_started}, or {@code + * released}. */ @SerializedName("status") String status; @@ -129,7 +131,7 @@ public class SubscriptionSchedule extends ApiResource @Setter(lombok.AccessLevel.NONE) ExpandableField subscription; - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -138,7 +140,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -147,7 +149,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `subscription` object. */ + /** Get ID of expandable {@code subscription} object. */ public String getSubscription() { return (this.subscription != null) ? this.subscription.getId() : null; } @@ -156,7 +158,7 @@ public void setSubscription(String id) { this.subscription = ApiResource.setExpandableFieldId(id, this.subscription); } - /** Get expanded `subscription`. */ + /** Get expanded {@code subscription}. */ public Subscription getSubscriptionObject() { return (this.subscription != null) ? this.subscription.getExpanded() : null; } @@ -497,12 +499,12 @@ public static class DefaultSettings extends StripeObject { Subscription.BillingThresholds billingThresholds; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the default - * source attached to the customer. When sending an invoice, Stripe will email your customer an - * invoice with payment instructions. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle using + * the default source attached to the customer. When sending an invoice, Stripe will email your + * customer an invoice with payment instructions. * - *

One of `charge_automatically`, or `send_invoice`. + *

One of {@code charge_automatically}, or {@code send_invoice}. */ @SerializedName("collection_method") String collectionMethod; @@ -520,7 +522,7 @@ public static class DefaultSettings extends StripeObject { @SerializedName("invoice_settings") InvoiceSettings invoiceSettings; - /** Get id of expandable `defaultPaymentMethod` object. */ + /** Get ID of expandable {@code defaultPaymentMethod} object. */ public String getDefaultPaymentMethod() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getId() : null; } @@ -529,7 +531,7 @@ public void setDefaultPaymentMethod(String id) { this.defaultPaymentMethod = ApiResource.setExpandableFieldId(id, this.defaultPaymentMethod); } - /** Get expanded `defaultPaymentMethod`. */ + /** Get expanded {@code defaultPaymentMethod}. */ public PaymentMethod getDefaultPaymentMethodObject() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getExpanded() : null; } @@ -546,8 +548,8 @@ public void setDefaultPaymentMethodObject(PaymentMethod expandableObject) { public static class InvoiceSettings extends StripeObject { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -573,12 +575,12 @@ public static class Phase extends StripeObject { Subscription.BillingThresholds billingThresholds; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the default - * source attached to the customer. When sending an invoice, Stripe will email your customer an - * invoice with payment instructions. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle using + * the default source attached to the customer. When sending an invoice, Stripe will email your + * customer an invoice with payment instructions. * - *

One of `charge_automatically`, or `send_invoice`. + *

One of {@code charge_automatically}, or {@code send_invoice}. */ @SerializedName("collection_method") String collectionMethod; @@ -633,7 +635,7 @@ public static class Phase extends StripeObject { @SerializedName("trial_end") Long trialEnd; - /** Get id of expandable `coupon` object. */ + /** Get ID of expandable {@code coupon} object. */ public String getCoupon() { return (this.coupon != null) ? this.coupon.getId() : null; } @@ -642,7 +644,7 @@ public void setCoupon(String id) { this.coupon = ApiResource.setExpandableFieldId(id, this.coupon); } - /** Get expanded `coupon`. */ + /** Get expanded {@code coupon}. */ public Coupon getCouponObject() { return (this.coupon != null) ? this.coupon.getExpanded() : null; } @@ -651,7 +653,7 @@ public void setCouponObject(Coupon expandableObject) { this.coupon = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `defaultPaymentMethod` object. */ + /** Get ID of expandable {@code defaultPaymentMethod} object. */ public String getDefaultPaymentMethod() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getId() : null; } @@ -660,7 +662,7 @@ public void setDefaultPaymentMethod(String id) { this.defaultPaymentMethod = ApiResource.setExpandableFieldId(id, this.defaultPaymentMethod); } - /** Get expanded `defaultPaymentMethod`. */ + /** Get expanded {@code defaultPaymentMethod}. */ public PaymentMethod getDefaultPaymentMethodObject() { return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getExpanded() : null; } @@ -693,13 +695,13 @@ public static class PhaseItem extends StripeObject { Long quantity; /** - * The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the - * phase do not apply to this `phase_item`. + * The tax rates which apply to this {@code phase_item}. When set, the {@code default_tax_rates} + * on the phase do not apply to this {@code phase_item}. */ @SerializedName("tax_rates") List taxRates; - /** Get id of expandable `plan` object. */ + /** Get ID of expandable {@code plan} object. */ public String getPlan() { return (this.plan != null) ? this.plan.getId() : null; } @@ -708,7 +710,7 @@ public void setPlan(String id) { this.plan = ApiResource.setExpandableFieldId(id, this.plan); } - /** Get expanded `plan`. */ + /** Get expanded {@code plan}. */ public Plan getPlanObject() { return (this.plan != null) ? this.plan.getExpanded() : null; } @@ -725,7 +727,7 @@ public static class RenewalInterval extends StripeObject { /** * Interval at which to renew the subscription schedule for when it ends. * - *

One of `day`, `month`, `week`, or `year`. + *

One of {@code day}, {@code month}, {@code week}, or {@code year}. */ @SerializedName("interval") String interval; diff --git a/src/main/java/com/stripe/model/TaxDeductedAtSource.java b/src/main/java/com/stripe/model/TaxDeductedAtSource.java index dabffdc89a2..ca5908ca1e7 100644 --- a/src/main/java/com/stripe/model/TaxDeductedAtSource.java +++ b/src/main/java/com/stripe/model/TaxDeductedAtSource.java @@ -17,7 +17,7 @@ public class TaxDeductedAtSource extends StripeObject implements BalanceTransact /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `tax_deducted_at_source`. + *

Equal to {@code tax_deducted_at_source}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/TaxId.java b/src/main/java/com/stripe/model/TaxId.java index fbfc0d98258..3eaf2dd2b00 100644 --- a/src/main/java/com/stripe/model/TaxId.java +++ b/src/main/java/com/stripe/model/TaxId.java @@ -38,8 +38,8 @@ public class TaxId extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -47,16 +47,17 @@ public class TaxId extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `tax_id`. + *

Equal to {@code tax_id}. */ @SerializedName("object") String object; /** - * Type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, - * `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, - * `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, or `ca_qst`. Note that some legacy tax IDs - * have type `unknown` + * Type of the tax ID, one of {@code eu_vat}, {@code nz_gst}, {@code au_abn}, {@code in_gst}, + * {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc}, {@code sg_uen}, {@code ru_inn}, + * {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat}, {@code th_vat}, {@code jp_cn}, + * {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn}, or {@code ca_qst}. Note that + * some legacy tax IDs have type {@code unknown} */ @SerializedName("type") String type; @@ -68,7 +69,7 @@ public class TaxId extends ApiResource implements HasId { @SerializedName("verification") Verification verification; - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -77,7 +78,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -118,7 +119,10 @@ public TaxId delete(Map params, RequestOptions options) throws S @Setter @EqualsAndHashCode(callSuper = false) public static class Verification extends StripeObject { - /** Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. */ + /** + * Verification status, one of {@code pending}, {@code verified}, {@code unverified}, or {@code + * unavailable}. + */ @SerializedName("status") String status; diff --git a/src/main/java/com/stripe/model/TaxRate.java b/src/main/java/com/stripe/model/TaxRate.java index bc5f2c8560d..e9f8494d1f2 100644 --- a/src/main/java/com/stripe/model/TaxRate.java +++ b/src/main/java/com/stripe/model/TaxRate.java @@ -20,8 +20,8 @@ @EqualsAndHashCode(callSuper = false) public class TaxRate extends ApiResource implements HasId, MetadataStore { /** - * Defaults to `true`. When set to `false`, this tax rate cannot be applied to objects in the API, - * but will still be applied to subscriptions and invoices that already have it set. + * Defaults to {@code true}. When set to {@code false}, this tax rate cannot be applied to objects + * in the API, but will still be applied to subscriptions and invoices that already have it set. */ @SerializedName("active") Boolean active; @@ -58,8 +58,8 @@ public class TaxRate extends ApiResource implements HasId, MetadataStoreEqual to `tax_rate`. + *

Equal to {@code tax_rate}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/ThreeDSecure.java b/src/main/java/com/stripe/model/ThreeDSecure.java index 31ee8deb75b..e38d038ad73 100644 --- a/src/main/java/com/stripe/model/ThreeDSecure.java +++ b/src/main/java/com/stripe/model/ThreeDSecure.java @@ -35,8 +35,8 @@ public class ThreeDSecure extends ApiResource implements HasId { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -47,8 +47,8 @@ public class ThreeDSecure extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -56,7 +56,7 @@ public class ThreeDSecure extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `three_d_secure`. + *

Equal to {@code three_d_secure}. */ @SerializedName("object") String object; @@ -64,17 +64,18 @@ public class ThreeDSecure extends ApiResource implements HasId { /** * If present, this is the URL that you should send the cardholder to for authentication. If you * are going to use Stripe.js to display the authentication page in an iframe, you should use the - * value "_callback". + * value "_callback". */ @SerializedName("redirect_url") String redirectUrl; /** - * Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be - * authenticated, the object starts with status `redirect_pending`. When liability will be shifted - * to the cardholder's bank (either because the cardholder was successfully authenticated, or - * because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. - * `failed` indicates that authentication was attempted unsuccessfully. + * Possible values are {@code redirect_pending}, {@code succeeded}, or {@code failed}. When the + * cardholder can be authenticated, the object starts with status {@code redirect_pending}. When + * liability will be shifted to the cardholder's bank (either because the cardholder was + * successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil + * be in status {@code succeeded}. {@code failed} indicates that authentication was attempted + * unsuccessfully. */ @SerializedName("status") String status; diff --git a/src/main/java/com/stripe/model/Token.java b/src/main/java/com/stripe/model/Token.java index 6348dc149fa..7699b35c875 100644 --- a/src/main/java/com/stripe/model/Token.java +++ b/src/main/java/com/stripe/model/Token.java @@ -43,8 +43,8 @@ public class Token extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -52,12 +52,12 @@ public class Token extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `token`. + *

Equal to {@code token}. */ @SerializedName("object") String object; - /** Type of the token: `account`, `bank_account`, `card`, or `pii`. */ + /** Type of the token: {@code account}, {@code bank_account}, {@code card}, or {@code pii}. */ @SerializedName("type") String type; @@ -98,7 +98,7 @@ public static Token retrieve(String token, TokenRetrieveParams params, RequestOp /** * Creates a single-use token that represents a bank account’s details. This token can be used * with any API method in place of a bank account dictionary. This token can be used only once, by - * attaching it to a Custom account. + * attaching it to a Custom account. */ public static Token create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -107,7 +107,7 @@ public static Token create(Map params) throws StripeException { /** * Creates a single-use token that represents a bank account’s details. This token can be used * with any API method in place of a bank account dictionary. This token can be used only once, by - * attaching it to a Custom account. + * attaching it to a Custom account. */ public static Token create(Map params, RequestOptions options) throws StripeException { @@ -118,7 +118,7 @@ public static Token create(Map params, RequestOptions options) /** * Creates a single-use token that represents a bank account’s details. This token can be used * with any API method in place of a bank account dictionary. This token can be used only once, by - * attaching it to a Custom account. + * attaching it to a Custom account. */ public static Token create(TokenCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -127,7 +127,7 @@ public static Token create(TokenCreateParams params) throws StripeException { /** * Creates a single-use token that represents a bank account’s details. This token can be used * with any API method in place of a bank account dictionary. This token can be used only once, by - * attaching it to a Custom account. + * attaching it to a Custom account. */ public static Token create(TokenCreateParams params, RequestOptions options) throws StripeException { diff --git a/src/main/java/com/stripe/model/Topup.java b/src/main/java/com/stripe/model/Topup.java index 04a483385f9..997eff16a70 100644 --- a/src/main/java/com/stripe/model/Topup.java +++ b/src/main/java/com/stripe/model/Topup.java @@ -37,8 +37,8 @@ public class Topup extends ApiResource implements MetadataStore, BalanceT Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -55,8 +55,8 @@ public class Topup extends ApiResource implements MetadataStore, BalanceT Long expectedAvailabilityDate; /** - * Error code explaining reason for top-up failure if available (see [the errors - * section](https://stripe.com/docs/api#errors) for a list of codes). + * Error code explaining reason for top-up failure if available (see the errors section for a list of codes). */ @SerializedName("failure_code") String failureCode; @@ -71,8 +71,8 @@ public class Topup extends ApiResource implements MetadataStore, BalanceT String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -88,7 +88,7 @@ public class Topup extends ApiResource implements MetadataStore, BalanceT /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `topup`. + *

Equal to {@code topup}. */ @SerializedName("object") String object; @@ -104,9 +104,11 @@ public class Topup extends ApiResource implements MetadataStore, BalanceT String statementDescriptor; /** - * The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. + * The status of the top-up is either {@code canceled}, {@code failed}, {@code pending}, {@code + * reversed}, or {@code succeeded}. * - *

One of `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. + *

One of {@code canceled}, {@code failed}, {@code pending}, {@code reversed}, or {@code + * succeeded}. */ @SerializedName("status") String status; @@ -115,7 +117,7 @@ public class Topup extends ApiResource implements MetadataStore, BalanceT @SerializedName("transfer_group") String transferGroup; - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -124,7 +126,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/Transfer.java b/src/main/java/com/stripe/model/Transfer.java index 72f457b0091..4c85a8beda9 100644 --- a/src/main/java/com/stripe/model/Transfer.java +++ b/src/main/java/com/stripe/model/Transfer.java @@ -41,8 +41,8 @@ public class Transfer extends ApiResource Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -72,8 +72,8 @@ public class Transfer extends ApiResource String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -89,7 +89,7 @@ public class Transfer extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `transfer`. + *

Equal to {@code transfer}. */ @SerializedName("object") String object; @@ -114,19 +114,19 @@ public class Transfer extends ApiResource @Setter(lombok.AccessLevel.NONE) ExpandableField sourceTransaction; - /** The source balance this transfer came from. One of `card` or `bank_account`. */ + /** The source balance this transfer came from. One of {@code card} or {@code bank_account}. */ @SerializedName("source_type") String sourceType; /** - * A string that identifies this transaction as part of a group. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. See the Connect + * documentation for details. */ @SerializedName("transfer_group") String transferGroup; - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -135,7 +135,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -145,7 +145,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `destination` object. */ + /** Get ID of expandable {@code destination} object. */ public String getDestination() { return (this.destination != null) ? this.destination.getId() : null; } @@ -154,7 +154,7 @@ public void setDestination(String id) { this.destination = ApiResource.setExpandableFieldId(id, this.destination); } - /** Get expanded `destination`. */ + /** Get expanded {@code destination}. */ public Account getDestinationObject() { return (this.destination != null) ? this.destination.getExpanded() : null; } @@ -163,7 +163,7 @@ public void setDestinationObject(Account expandableObject) { this.destination = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `destinationPayment` object. */ + /** Get ID of expandable {@code destinationPayment} object. */ public String getDestinationPayment() { return (this.destinationPayment != null) ? this.destinationPayment.getId() : null; } @@ -172,7 +172,7 @@ public void setDestinationPayment(String id) { this.destinationPayment = ApiResource.setExpandableFieldId(id, this.destinationPayment); } - /** Get expanded `destinationPayment`. */ + /** Get expanded {@code destinationPayment}. */ public Charge getDestinationPaymentObject() { return (this.destinationPayment != null) ? this.destinationPayment.getExpanded() : null; } @@ -182,7 +182,7 @@ public void setDestinationPaymentObject(Charge expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `sourceTransaction` object. */ + /** Get ID of expandable {@code sourceTransaction} object. */ public String getSourceTransaction() { return (this.sourceTransaction != null) ? this.sourceTransaction.getId() : null; } @@ -191,7 +191,7 @@ public void setSourceTransaction(String id) { this.sourceTransaction = ApiResource.setExpandableFieldId(id, this.sourceTransaction); } - /** Get expanded `sourceTransaction`. */ + /** Get expanded {@code sourceTransaction}. */ public Charge getSourceTransactionObject() { return (this.sourceTransaction != null) ? this.sourceTransaction.getExpanded() : null; } @@ -203,8 +203,8 @@ public void setSourceTransactionObject(Charge expandableObject) { /** * To send funds from your Stripe account to a connected account, you create a new transfer - * object. Your Stripe balance must be able to cover the transfer amount, - * or you’ll receive an “Insufficient Funds” error. + * object. Your Stripe balance must be able to + * cover the transfer amount, or you’ll receive an “Insufficient Funds” error. */ public static Transfer create(Map params) throws StripeException { return create(params, (RequestOptions) null); @@ -212,8 +212,8 @@ public static Transfer create(Map params) throws StripeException /** * To send funds from your Stripe account to a connected account, you create a new transfer - * object. Your Stripe balance must be able to cover the transfer amount, - * or you’ll receive an “Insufficient Funds” error. + * object. Your Stripe balance must be able to + * cover the transfer amount, or you’ll receive an “Insufficient Funds” error. */ public static Transfer create(Map params, RequestOptions options) throws StripeException { @@ -224,8 +224,8 @@ public static Transfer create(Map params, RequestOptions options /** * To send funds from your Stripe account to a connected account, you create a new transfer - * object. Your Stripe balance must be able to cover the transfer amount, - * or you’ll receive an “Insufficient Funds” error. + * object. Your Stripe balance must be able to + * cover the transfer amount, or you’ll receive an “Insufficient Funds” error. */ public static Transfer create(TransferCreateParams params) throws StripeException { return create(params, (RequestOptions) null); @@ -233,8 +233,8 @@ public static Transfer create(TransferCreateParams params) throws StripeExceptio /** * To send funds from your Stripe account to a connected account, you create a new transfer - * object. Your Stripe balance must be able to cover the transfer amount, - * or you’ll receive an “Insufficient Funds” error. + * object. Your Stripe balance must be able to + * cover the transfer amount, or you’ll receive an “Insufficient Funds” error. */ public static Transfer create(TransferCreateParams params, RequestOptions options) throws StripeException { diff --git a/src/main/java/com/stripe/model/TransferReversal.java b/src/main/java/com/stripe/model/TransferReversal.java index af5c797334c..abc4347ed7b 100644 --- a/src/main/java/com/stripe/model/TransferReversal.java +++ b/src/main/java/com/stripe/model/TransferReversal.java @@ -31,8 +31,8 @@ public class TransferReversal extends ApiResource Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -59,7 +59,7 @@ public class TransferReversal extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `transfer_reversal`. + *

Equal to {@code transfer_reversal}. */ @SerializedName("object") String object; @@ -76,7 +76,7 @@ public class TransferReversal extends ApiResource @Setter(lombok.AccessLevel.NONE) ExpandableField transfer; - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -85,7 +85,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -95,7 +95,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `destinationPaymentRefund` object. */ + /** Get ID of expandable {@code destinationPaymentRefund} object. */ public String getDestinationPaymentRefund() { return (this.destinationPaymentRefund != null) ? this.destinationPaymentRefund.getId() : null; } @@ -105,7 +105,7 @@ public void setDestinationPaymentRefund(String id) { ApiResource.setExpandableFieldId(id, this.destinationPaymentRefund); } - /** Get expanded `destinationPaymentRefund`. */ + /** Get expanded {@code destinationPaymentRefund}. */ public Refund getDestinationPaymentRefundObject() { return (this.destinationPaymentRefund != null) ? this.destinationPaymentRefund.getExpanded() @@ -117,7 +117,7 @@ public void setDestinationPaymentRefundObject(Refund expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `sourceRefund` object. */ + /** Get ID of expandable {@code sourceRefund} object. */ public String getSourceRefund() { return (this.sourceRefund != null) ? this.sourceRefund.getId() : null; } @@ -126,7 +126,7 @@ public void setSourceRefund(String id) { this.sourceRefund = ApiResource.setExpandableFieldId(id, this.sourceRefund); } - /** Get expanded `sourceRefund`. */ + /** Get expanded {@code sourceRefund}. */ public Refund getSourceRefundObject() { return (this.sourceRefund != null) ? this.sourceRefund.getExpanded() : null; } @@ -135,7 +135,7 @@ public void setSourceRefundObject(Refund expandableObject) { this.sourceRefund = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `transfer` object. */ + /** Get ID of expandable {@code transfer} object. */ public String getTransfer() { return (this.transfer != null) ? this.transfer.getId() : null; } @@ -144,7 +144,7 @@ public void setTransfer(String id) { this.transfer = ApiResource.setExpandableFieldId(id, this.transfer); } - /** Get expanded `transfer`. */ + /** Get expanded {@code transfer}. */ public Transfer getTransferObject() { return (this.transfer != null) ? this.transfer.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/UsageRecord.java b/src/main/java/com/stripe/model/UsageRecord.java index a8bdcc4ddd5..b7532bac739 100644 --- a/src/main/java/com/stripe/model/UsageRecord.java +++ b/src/main/java/com/stripe/model/UsageRecord.java @@ -21,8 +21,8 @@ public class UsageRecord extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -30,7 +30,7 @@ public class UsageRecord extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `usage_record`. + *

Equal to {@code usage_record}. */ @SerializedName("object") String object; @@ -59,14 +59,14 @@ public class UsageRecord extends ApiResource implements HasId { *

The default calculation for usage is to add up all the quantity values of the * usage records within a billing period. You can change this default behavior with the billing * plan’s aggregate_usage parameter. When there is more - * than one usage record with the same timestamp, Stripe adds the quantity values - * together. In most cases, this is the desired resolution, however, you can change this behavior - * with the action parameter. + * href="https://stripe.com/docs/api/plans/create#create_plan-aggregate_usage">parameter. When + * there is more than one usage record with the same timestamp, Stripe adds the quantity + * values together. In most cases, this is the desired resolution, however, you can change + * this behavior with the action parameter. * *

The default pricing model for metered billing is per-unit pricing. For finer - * granularity, you can configure metered billing to have a per-unit + * pricing. For finer granularity, you can configure metered billing to have a tiered pricing model. */ public static UsageRecord createOnSubscriptionItem( @@ -95,14 +95,14 @@ public static UsageRecord createOnSubscriptionItem( *

The default calculation for usage is to add up all the quantity values of the * usage records within a billing period. You can change this default behavior with the billing * plan’s aggregate_usage parameter. When there is more - * than one usage record with the same timestamp, Stripe adds the quantity values - * together. In most cases, this is the desired resolution, however, you can change this behavior - * with the action parameter. + * href="https://stripe.com/docs/api/plans/create#create_plan-aggregate_usage">parameter. When + * there is more than one usage record with the same timestamp, Stripe adds the quantity + * values together. In most cases, this is the desired resolution, however, you can change + * this behavior with the action parameter. * *

The default pricing model for metered billing is per-unit pricing. For finer - * granularity, you can configure metered billing to have a per-unit + * pricing. For finer granularity, you can configure metered billing to have a tiered pricing model. */ public static UsageRecord createOnSubscriptionItem( diff --git a/src/main/java/com/stripe/model/UsageRecordSummary.java b/src/main/java/com/stripe/model/UsageRecordSummary.java index 7adb5857776..ad85c38f1cd 100644 --- a/src/main/java/com/stripe/model/UsageRecordSummary.java +++ b/src/main/java/com/stripe/model/UsageRecordSummary.java @@ -19,8 +19,8 @@ public class UsageRecordSummary extends StripeObject implements HasId { String invoice; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -28,7 +28,7 @@ public class UsageRecordSummary extends StripeObject implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `usage_record_summary`. + *

Equal to {@code usage_record_summary}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/WebhookEndpoint.java b/src/main/java/com/stripe/model/WebhookEndpoint.java index eca65162216..d41eadfb70e 100644 --- a/src/main/java/com/stripe/model/WebhookEndpoint.java +++ b/src/main/java/com/stripe/model/WebhookEndpoint.java @@ -36,8 +36,8 @@ public class WebhookEndpoint extends ApiResource implements HasId { Boolean deleted; /** - * The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, - * except those that require explicit selection. + * The list of events to enable for this endpoint. {@code ['*']} indicates that all events are + * enabled, except those that require explicit selection. */ @SerializedName("enabled_events") List enabledEvents; @@ -48,8 +48,8 @@ public class WebhookEndpoint extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -57,19 +57,20 @@ public class WebhookEndpoint extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `webhook_endpoint`. + *

Equal to {@code webhook_endpoint}. */ @SerializedName("object") String object; /** - * The endpoint's secret, used to generate [webhook - * signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. + * The endpoint's secret, used to generate webhook signatures. Only returned at + * creation. */ @SerializedName("secret") String secret; - /** The status of the webhook. It can be `enabled` or `disabled`. */ + /** The status of the webhook. It can be {@code enabled} or {@code disabled}. */ @SerializedName("status") String status; diff --git a/src/main/java/com/stripe/model/checkout/Session.java b/src/main/java/com/stripe/model/checkout/Session.java index 68efb24a141..4e1530bf15e 100644 --- a/src/main/java/com/stripe/model/checkout/Session.java +++ b/src/main/java/com/stripe/model/checkout/Session.java @@ -27,7 +27,8 @@ @EqualsAndHashCode(callSuper = false) public class Session extends ApiResource implements HasId { /** - * The value (`auto` or `required`) for whether Checkout collected the customer's billing address. + * The value ({@code auto} or {@code required}) for whether Checkout collected the customer's + * billing address. */ @SerializedName("billing_address_collection") String billingAddressCollection; @@ -47,9 +48,9 @@ public class Session extends ApiResource implements HasId { String clientReferenceId; /** - * The ID of the customer for this session. For Checkout Sessions in `payment` or `subscription` - * mode, Checkout will create a new customer object based on information provided during the - * session unless an existing customer was provided when the session was created. + * The ID of the customer for this session. For Checkout Sessions in {@code payment} or {@code + * subscription} mode, Checkout will create a new customer object based on information provided + * during the session unless an existing customer was provided when the session was created. */ @SerializedName("customer") @Getter(lombok.AccessLevel.NONE) @@ -60,7 +61,7 @@ public class Session extends ApiResource implements HasId { * If provided, this value will be used when the Customer object is created. If not provided, * customers will be asked to enter their email address. Use this parameter to prefill customer * data if you already have an email on file. To access information about the customer once a - * session is complete, use the `customer` field. + * session is complete, use the {@code customer} field. */ @SerializedName("customer_email") String customerEmail; @@ -69,24 +70,25 @@ public class Session extends ApiResource implements HasId { @SerializedName("display_items") List displayItems; - /** Unique identifier for the object. Used to pass to `redirectToCheckout` in Stripe.js. */ + /** Unique identifier for the object. Used to pass to {@code redirectToCheckout} in Stripe.js. */ @Getter(onMethod_ = {@Override}) @SerializedName("id") String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; /** - * The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's - * locale is used. + * The IETF language tag of the locale Checkout is displayed in. If blank or {@code auto}, the + * browser's locale is used. * - *

One of `auto`, `da`, `de`, `en`, `es`, `fi`, `fr`, `it`, `ja`, `ms`, `nb`, `nl`, `pl`, `pt`, - * `sv`, or `zh`. + *

One of {@code auto}, {@code da}, {@code de}, {@code en}, {@code es}, {@code fi}, {@code fr}, + * {@code it}, {@code ja}, {@code ms}, {@code nb}, {@code nl}, {@code pl}, {@code pt}, {@code sv}, + * or {@code zh}. */ @SerializedName("locale") String locale; @@ -98,19 +100,22 @@ public class Session extends ApiResource implements HasId { @SerializedName("metadata") Map metadata; - /** The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`. */ + /** + * The mode of the Checkout Session, one of {@code payment}, {@code setup}, or {@code + * subscription}. + */ @SerializedName("mode") String mode; /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `checkout.session`. + *

Equal to {@code checkout.session}. */ @SerializedName("object") String object; - /** The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ + /** The ID of the PaymentIntent for Checkout Sessions in {@code payment} mode. */ @SerializedName("payment_intent") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) @@ -122,7 +127,7 @@ public class Session extends ApiResource implements HasId { @SerializedName("payment_method_types") List paymentMethodTypes; - /** The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ + /** The ID of the SetupIntent for Checkout Sessions in {@code setup} mode. */ @SerializedName("setup_intent") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) @@ -130,15 +135,16 @@ public class Session extends ApiResource implements HasId { /** * Describes the type of transaction being performed by Checkout in order to customize relevant - * text on the page, such as the submit button. `submit_type` can only be specified on Checkout - * Sessions in `payment` mode, but not Checkout Sessions in `subscription` or `setup` mode. + * text on the page, such as the submit button. {@code submit_type} can only be specified on + * Checkout Sessions in {@code payment} mode, but not Checkout Sessions in {@code subscription} or + * {@code setup} mode. * - *

One of `auto`, `book`, `donate`, or `pay`. + *

One of {@code auto}, {@code book}, {@code donate}, or {@code pay}. */ @SerializedName("submit_type") String submitType; - /** The ID of the subscription for Checkout Sessions in `subscription` mode. */ + /** The ID of the subscription for Checkout Sessions in {@code subscription} mode. */ @SerializedName("subscription") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) @@ -151,7 +157,7 @@ public class Session extends ApiResource implements HasId { @SerializedName("success_url") String successUrl; - /** Get id of expandable `customer` object. */ + /** Get ID of expandable {@code customer} object. */ public String getCustomer() { return (this.customer != null) ? this.customer.getId() : null; } @@ -160,7 +166,7 @@ public void setCustomer(String id) { this.customer = ApiResource.setExpandableFieldId(id, this.customer); } - /** Get expanded `customer`. */ + /** Get expanded {@code customer}. */ public Customer getCustomerObject() { return (this.customer != null) ? this.customer.getExpanded() : null; } @@ -169,7 +175,7 @@ public void setCustomerObject(Customer expandableObject) { this.customer = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `paymentIntent` object. */ + /** Get ID of expandable {@code paymentIntent} object. */ public String getPaymentIntent() { return (this.paymentIntent != null) ? this.paymentIntent.getId() : null; } @@ -178,7 +184,7 @@ public void setPaymentIntent(String id) { this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent); } - /** Get expanded `paymentIntent`. */ + /** Get expanded {@code paymentIntent}. */ public PaymentIntent getPaymentIntentObject() { return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null; } @@ -188,7 +194,7 @@ public void setPaymentIntentObject(PaymentIntent expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `setupIntent` object. */ + /** Get ID of expandable {@code setupIntent} object. */ public String getSetupIntent() { return (this.setupIntent != null) ? this.setupIntent.getId() : null; } @@ -197,7 +203,7 @@ public void setSetupIntent(String id) { this.setupIntent = ApiResource.setExpandableFieldId(id, this.setupIntent); } - /** Get expanded `setupIntent`. */ + /** Get expanded {@code setupIntent}. */ public SetupIntent getSetupIntentObject() { return (this.setupIntent != null) ? this.setupIntent.getExpanded() : null; } @@ -206,7 +212,7 @@ public void setSetupIntentObject(SetupIntent expandableObject) { this.setupIntent = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `subscription` object. */ + /** Get ID of expandable {@code subscription} object. */ public String getSubscription() { return (this.subscription != null) ? this.subscription.getId() : null; } @@ -215,7 +221,7 @@ public void setSubscription(String id) { this.subscription = ApiResource.setExpandableFieldId(id, this.subscription); } - /** Get expanded `subscription`. */ + /** Get expanded {@code subscription}. */ public Subscription getSubscriptionObject() { return (this.subscription != null) ? this.subscription.getExpanded() : null; } @@ -290,8 +296,9 @@ public static class DisplayItem extends StripeObject { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ @SerializedName("currency") String currency; @@ -309,7 +316,7 @@ public static class DisplayItem extends StripeObject { @SerializedName("sku") Sku sku; - /** The type of display item. One of `custom`, `plan` or `sku` */ + /** The type of display item. One of {@code custom}, {@code plan} or {@code sku} */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/issuing/Authorization.java b/src/main/java/com/stripe/model/issuing/Authorization.java index c71a6883228..e5ebbc91833 100644 --- a/src/main/java/com/stripe/model/issuing/Authorization.java +++ b/src/main/java/com/stripe/model/issuing/Authorization.java @@ -33,22 +33,23 @@ public class Authorization extends ApiResource /** * How the card details were provided. * - *

One of `chip`, `contactless`, `keyed_in`, `online`, or `swipe`. + *

One of {@code chip}, {@code contactless}, {@code keyed_in}, {@code online}, or {@code + * swipe}. */ @SerializedName("authorization_method") String authorizationMethod; /** - * The amount that has been authorized. This will be `0` when the object is created, and increase - * after it has been approved. + * The amount that has been authorized. This will be {@code 0} when the object is created, and + * increase after it has been approved. */ @SerializedName("authorized_amount") Long authorizedAmount; /** - * The currency that was presented to the cardholder for the authorization. Three-letter [ISO - * currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a - * [supported currency](https://stripe.com/docs/currencies). + * The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. + * Must be a supported currency. */ @SerializedName("authorized_currency") String authorizedCurrency; @@ -71,18 +72,18 @@ public class Authorization extends ApiResource Long created; /** - * The amount the authorization is expected to be in `held_currency`. When Stripe holds funds from - * you, this is the amount reserved for the authorization. This will be `0` when the object is - * created, and increase after it has been approved. For multi-currency transactions, - * `held_amount` can be used to determine the expected exchange rate. + * The amount the authorization is expected to be in {@code held_currency}. When Stripe holds + * funds from you, this is the amount reserved for the authorization. This will be {@code 0} when + * the object is created, and increase after it has been approved. For multi-currency + * transactions, {@code held_amount} can be used to determine the expected exchange rate. */ @SerializedName("held_amount") Long heldAmount; /** - * The currency of the [held - * amount](https://stripe.com/docs/api#issuing_authorization_object-held_amount). This will always - * be the card currency. + * The currency of the held amount. + * This will always be the card currency. */ @SerializedName("held_currency") String heldCurrency; @@ -93,16 +94,16 @@ public class Authorization extends ApiResource String id; /** - * If set `true`, you may provide - * [held_amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-held_amount) + * If set {@code true}, you may provide held_amount * to control how much to hold for the authorization. */ @SerializedName("is_held_amount_controllable") Boolean isHeldAmountControllable; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -121,21 +122,21 @@ public class Authorization extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `issuing.authorization`. + *

Equal to {@code issuing.authorization}. */ @SerializedName("object") String object; /** * The amount the user is requesting to be authorized. This field will only be non-zero during an - * `issuing.authorization.request` webhook. + * {@code issuing.authorization.request} webhook. */ @SerializedName("pending_authorized_amount") Long pendingAuthorizedAmount; /** * The additional amount Stripe will hold if the authorization is approved. This field will only - * be non-zero during an `issuing.authorization.request` webhook. + * be non-zero during an {@code issuing.authorization.request} webhook. */ @SerializedName("pending_held_amount") Long pendingHeldAmount; @@ -143,9 +144,10 @@ public class Authorization extends ApiResource /** * History of every time the authorization was approved/denied (whether approved/denied by you * directly, or by Stripe based on your authorization_controls). If the merchant changes the - * authorization by performing an [incremental authorization or partial - * capture](https://stripe.com/docs/issuing/authorizations/special_scenarios#incremental-authorizations), - * you can look at request_history to see the previous states of the authorization. + * authorization by performing an incremental + * authorization or partial capture, you can look at request_history to see the previous + * states of the authorization. */ @SerializedName("request_history") List requestHistory; @@ -153,14 +155,14 @@ public class Authorization extends ApiResource /** * The current status of the authorization in its lifecycle. * - *

One of `closed`, `pending`, or `reversed`. + *

One of {@code closed}, {@code pending}, or {@code reversed}. */ @SerializedName("status") String status; /** - * List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this - * authorization. + * List of transactions associated + * with this authorization. */ @SerializedName("transactions") List transactions; @@ -169,13 +171,13 @@ public class Authorization extends ApiResource VerificationData verificationData; /** - * What, if any, digital wallet was used for this authorization. One of `apple_pay`, `google_pay`, - * or `samsung_pay`. + * What, if any, digital wallet was used for this authorization. One of {@code apple_pay}, {@code + * google_pay}, or {@code samsung_pay}. */ @SerializedName("wallet_provider") String walletProvider; - /** Get id of expandable `cardholder` object. */ + /** Get ID of expandable {@code cardholder} object. */ public String getCardholder() { return (this.cardholder != null) ? this.cardholder.getId() : null; } @@ -184,7 +186,7 @@ public void setCardholder(String id) { this.cardholder = ApiResource.setExpandableFieldId(id, this.cardholder); } - /** Get expanded `cardholder`. */ + /** Get expanded {@code cardholder}. */ public Cardholder getCardholderObject() { return (this.cardholder != null) ? this.cardholder.getExpanded() : null; } @@ -420,9 +422,9 @@ public static class RequestHistory extends StripeObject { Long authorizedAmount; /** - * The currency that was presented to the cardholder for the authorization. Three-letter [ISO - * currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a - * [supported currency](https://stripe.com/docs/currencies). + * The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. + * Must be a supported currency. */ @SerializedName("authorized_currency") String authorizedCurrency; @@ -439,8 +441,8 @@ public static class RequestHistory extends StripeObject { Long heldAmount; /** - * The currency of the [held - * amount](https://stripe.com/docs/api#issuing_authorization_object-held_amount). + * The currency of the held amount. */ @SerializedName("held_currency") String heldCurrency; @@ -448,16 +450,17 @@ public static class RequestHistory extends StripeObject { /** * The reason for the approval or decline. * - *

One of `account_compliance_disabled`, `account_inactive`, `authentication_failed`, - * `authorization_controls`, `card_active`, `card_inactive`, `cardholder_inactive`, - * `cardholder_verification_required`, `insufficient_funds`, `not_allowed`, `suspected_fraud`, - * `webhook_approved`, `webhook_declined`, or `webhook_timeout`. + *

One of {@code account_compliance_disabled}, {@code account_inactive}, {@code + * authentication_failed}, {@code authorization_controls}, {@code card_active}, {@code + * card_inactive}, {@code cardholder_inactive}, {@code cardholder_verification_required}, {@code + * insufficient_funds}, {@code not_allowed}, {@code suspected_fraud}, {@code webhook_approved}, + * {@code webhook_declined}, or {@code webhook_timeout}. */ @SerializedName("reason") String reason; /** - * When an authorization is declined due to `authorization_controls`, this array contains + * When an authorization is declined due to {@code authorization_controls}, this array contains * details about the authorization controls that were violated. Otherwise, it is empty. */ @SerializedName("violated_authorization_controls") @@ -468,14 +471,15 @@ public static class RequestHistory extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class ViolatedAuthorizationControl extends StripeObject { /** - * Entity which the authorization control acts on. One of `card`, `cardholder`, or `account`. + * Entity which the authorization control acts on. One of {@code card}, {@code cardholder}, or + * {@code account}. */ @SerializedName("entity") String entity; /** - * Name of the authorization control. One of `allowed_categories`, `blocked_categories`, - * `spending_limits`, `max_approvals`, or `max_amount`. + * Name of the authorization control. One of {@code allowed_categories}, {@code + * blocked_categories}, {@code spending_limits}, {@code max_approvals}, or {@code max_amount}. */ @SerializedName("name") String name; @@ -488,25 +492,27 @@ public static class ViolatedAuthorizationControl extends StripeObject { public static class VerificationData extends StripeObject { /** * Whether the cardholder provided an address first line and if it matched the cardholder’s - * `billing.address.line1`. One of `match`, `mismatch`, or `not_provided`. + * {@code billing.address.line1}. One of {@code match}, {@code mismatch}, or {@code + * not_provided}. */ @SerializedName("address_line1_check") String addressLine1Check; /** * Whether the cardholder provided a zip (or postal code) and if it matched the cardholder’s - * `billing.address.postal_code`. One of `match`, `mismatch`, or `not_provided`. + * {@code billing.address.postal_code}. One of {@code match}, {@code mismatch}, or {@code + * not_provided}. */ @SerializedName("address_zip_check") String addressZipCheck; - /** One of `success`, `failure`, `exempt`, or `none`. */ + /** One of {@code success}, {@code failure}, {@code exempt}, or {@code none}. */ @SerializedName("authentication") String authentication; /** - * Whether the cardholder provided a CVC and if it matched Stripe’s record. One of `match`, - * `mismatch`, or `not_provided`. + * Whether the cardholder provided a CVC and if it matched Stripe’s record. One of {@code + * match}, {@code mismatch}, or {@code not_provided}. */ @SerializedName("cvc_check") String cvcCheck; diff --git a/src/main/java/com/stripe/model/issuing/Card.java b/src/main/java/com/stripe/model/issuing/Card.java index ae2913ced34..cdd13d1dd1f 100644 --- a/src/main/java/com/stripe/model/issuing/Card.java +++ b/src/main/java/com/stripe/model/issuing/Card.java @@ -33,8 +33,8 @@ public class Card extends ApiResource implements HasId, MetadataStore { String brand; /** - * The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object to which the - * card belongs. + * The Cardholder object to + * which the card belongs. */ @SerializedName("cardholder") Cardholder cardholder; @@ -44,8 +44,8 @@ public class Card extends ApiResource implements HasId, MetadataStore { Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -68,8 +68,8 @@ public class Card extends ApiResource implements HasId, MetadataStore { String last4; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -89,7 +89,7 @@ public class Card extends ApiResource implements HasId, MetadataStore { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `issuing.card`. + *

Equal to {@code issuing.card}. */ @SerializedName("object") String object; @@ -107,7 +107,7 @@ public class Card extends ApiResource implements HasId, MetadataStore { /** * The reason why the previous card needed to be replaced. * - *

One of `damage`, `expiration`, `loss`, or `theft`. + *

One of {@code damage}, {@code expiration}, {@code loss}, or {@code theft}. */ @SerializedName("replacement_reason") String replacementReason; @@ -119,7 +119,7 @@ public class Card extends ApiResource implements HasId, MetadataStore { /** * Whether authorizations can be approved on this card. * - *

One of `active`, `canceled`, `inactive`, `lost`, or `stolen`. + *

One of {@code active}, {@code canceled}, {@code inactive}, {@code lost}, or {@code stolen}. */ @SerializedName("status") String status; @@ -127,12 +127,12 @@ public class Card extends ApiResource implements HasId, MetadataStore { /** * The type of the card. * - *

One of `physical`, or `virtual`. + *

One of {@code physical}, or {@code virtual}. */ @SerializedName("type") String type; - /** Get id of expandable `replacementFor` object. */ + /** Get ID of expandable {@code replacementFor} object. */ public String getReplacementFor() { return (this.replacementFor != null) ? this.replacementFor.getId() : null; } @@ -141,7 +141,7 @@ public void setReplacementFor(String id) { this.replacementFor = ApiResource.setExpandableFieldId(id, this.replacementFor); } - /** Get expanded `replacementFor`. */ + /** Get expanded {@code replacementFor}. */ public Card getReplacementForObject() { return (this.replacementFor != null) ? this.replacementFor.getExpanded() : null; } @@ -288,8 +288,8 @@ public Card update(CardUpdateParams params, RequestOptions options) throws Strip /** * For virtual cards only. Retrieves an Issuing card_details object that contains the sensitive details of a virtual - * card. + * href="https://stripe.com/docs/issuing/cards/management#virtual-card-info">the sensitive + * details of a virtual card. */ public CardDetails details() throws StripeException { return details((Map) null, (RequestOptions) null); @@ -297,8 +297,8 @@ public CardDetails details() throws StripeException { /** * For virtual cards only. Retrieves an Issuing card_details object that contains the sensitive details of a virtual - * card. + * href="https://stripe.com/docs/issuing/cards/management#virtual-card-info">the sensitive + * details of a virtual card. */ public CardDetails details(Map params) throws StripeException { return details(params, (RequestOptions) null); @@ -306,8 +306,8 @@ public CardDetails details(Map params) throws StripeException { /** * For virtual cards only. Retrieves an Issuing card_details object that contains the sensitive details of a virtual - * card. + * href="https://stripe.com/docs/issuing/cards/management#virtual-card-info">the sensitive + * details of a virtual card. */ public CardDetails details(Map params, RequestOptions options) throws StripeException { @@ -322,8 +322,8 @@ public CardDetails details(Map params, RequestOptions options) /** * For virtual cards only. Retrieves an Issuing card_details object that contains the sensitive details of a virtual - * card. + * href="https://stripe.com/docs/issuing/cards/management#virtual-card-info">the sensitive + * details of a virtual card. */ public CardDetails details(CardDetailsParams params) throws StripeException { return details(params, (RequestOptions) null); @@ -331,8 +331,8 @@ public CardDetails details(CardDetailsParams params) throws StripeException { /** * For virtual cards only. Retrieves an Issuing card_details object that contains the sensitive details of a virtual - * card. + * href="https://stripe.com/docs/issuing/cards/management#virtual-card-info">the sensitive + * details of a virtual card. */ public CardDetails details(CardDetailsParams params, RequestOptions options) throws StripeException { @@ -350,24 +350,24 @@ public CardDetails details(CardDetailsParams params, RequestOptions options) @EqualsAndHashCode(callSuper = false) public static class AuthorizationControls extends StripeObject { /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations permitted on this card. */ @SerializedName("allowed_categories") List allowedCategories; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations to always decline on this card. */ @SerializedName("blocked_categories") List blockedCategories; /** - * The currency of the card. See - * [max_amount](https://stripe.com/docs/api#issuing_card_object-authorization_controls-max_amount) + * The currency of the card. See max_amount */ @SerializedName("currency") String currency; @@ -395,7 +395,7 @@ public static class Pin extends StripeObject { /** * Wether the PIN will be accepted or not. * - *

One of `active`, or `blocked`. + *

One of {@code active}, or {@code blocked}. */ @SerializedName("status") String status; @@ -411,7 +411,7 @@ public static class Shipping extends StripeObject { /** * The delivery company that shipped a card. * - *

One of `fedex`, or `usps`. + *

One of {@code fedex}, or {@code usps}. */ @SerializedName("carrier") String carrier; @@ -427,7 +427,7 @@ public static class Shipping extends StripeObject { /** * Shipment speed. * - *

One of `express`, `overnight`, or `standard`. + *

One of {@code express}, {@code overnight}, or {@code standard}. */ @SerializedName("speed") String speed; @@ -435,7 +435,8 @@ public static class Shipping extends StripeObject { /** * The delivery status of the card. * - *

One of `canceled`, `delivered`, `failure`, `pending`, `returned`, or `shipped`. + *

One of {@code canceled}, {@code delivered}, {@code failure}, {@code pending}, {@code + * returned}, or {@code shipped}. */ @SerializedName("status") String status; @@ -454,7 +455,7 @@ public static class Shipping extends StripeObject { /** * Packaging options. * - *

One of `bulk`, or `individual`. + *

One of {@code bulk}, or {@code individual}. */ @SerializedName("type") String type; @@ -469,8 +470,8 @@ public static class SpendingLimit extends StripeObject { Long amount; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * on which to apply the spending limit. Leave this blank to limit all charges. */ @SerializedName("categories") @@ -479,7 +480,8 @@ public static class SpendingLimit extends StripeObject { /** * The time interval or event with which to apply this spending limit towards. * - *

One of `all_time`, `daily`, `monthly`, `per_authorization`, `weekly`, or `yearly`. + *

One of {@code all_time}, {@code daily}, {@code monthly}, {@code per_authorization}, {@code + * weekly}, or {@code yearly}. */ @SerializedName("interval") String interval; diff --git a/src/main/java/com/stripe/model/issuing/CardDetails.java b/src/main/java/com/stripe/model/issuing/CardDetails.java index 4621b4235a9..45cd795d374 100644 --- a/src/main/java/com/stripe/model/issuing/CardDetails.java +++ b/src/main/java/com/stripe/model/issuing/CardDetails.java @@ -32,7 +32,7 @@ public class CardDetails extends StripeObject { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `issuing.card_details`. + *

Equal to {@code issuing.card_details}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/issuing/Cardholder.java b/src/main/java/com/stripe/model/issuing/Cardholder.java index b9829f17143..65cb6c0d7a0 100644 --- a/src/main/java/com/stripe/model/issuing/Cardholder.java +++ b/src/main/java/com/stripe/model/issuing/Cardholder.java @@ -27,8 +27,8 @@ public class Cardholder extends ApiResource implements HasId, MetadataStore { /** * Spending rules that give you some control over how this cardholder's cards can be used. Refer - * to our [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more - * details. + * to our authorizations + * documentation for more details. */ @SerializedName("authorization_controls") AuthorizationControls authorizationControls; @@ -36,7 +36,7 @@ public class Cardholder extends ApiResource implements HasId, MetadataStoreEqual to `issuing.cardholder`. + *

Equal to {@code issuing.cardholder}. */ @SerializedName("object") String object; @@ -98,12 +98,12 @@ public class Cardholder extends ApiResource implements HasId, MetadataStoreOne of `active`, `blocked`, or `inactive`. + *

One of {@code active}, {@code blocked}, or {@code inactive}. */ @SerializedName("status") String status; - /** One of `individual` or `business_entity`. */ + /** One of {@code individual} or {@code business_entity}. */ @SerializedName("type") String type; @@ -259,16 +259,16 @@ public Cardholder update(CardholderUpdateParams params, RequestOptions options) @EqualsAndHashCode(callSuper = false) public static class AuthorizationControls extends StripeObject { /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations permitted on this cardholder's cards. */ @SerializedName("allowed_categories") List allowedCategories; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations to always decline on this cardholder's cards. */ @SerializedName("blocked_categories") @@ -354,8 +354,9 @@ public static class Verification extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Document extends StripeObject { /** - * The back of a document returned by a [file upload](#create_file) with a `purpose` value - * of `identity_document`. + * The back of a document returned by a file upload with a {@code purpose} + * value of {@code identity_document}. */ @SerializedName("back") @Getter(lombok.AccessLevel.NONE) @@ -363,15 +364,16 @@ public static class Document extends StripeObject { ExpandableField back; /** - * The front of a document returned by a [file upload](#create_file) with a `purpose` value - * of `identity_document`. + * The front of a document returned by a file upload with a {@code purpose} + * value of {@code identity_document}. */ @SerializedName("front") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) ExpandableField front; - /** Get id of expandable `back` object. */ + /** Get ID of expandable {@code back} object. */ public String getBack() { return (this.back != null) ? this.back.getId() : null; } @@ -380,7 +382,7 @@ public void setBack(String id) { this.back = ApiResource.setExpandableFieldId(id, this.back); } - /** Get expanded `back`. */ + /** Get expanded {@code back}. */ public File getBackObject() { return (this.back != null) ? this.back.getExpanded() : null; } @@ -389,7 +391,7 @@ public void setBackObject(File expandableObject) { this.back = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `front` object. */ + /** Get ID of expandable {@code front} object. */ public String getFront() { return (this.front != null) ? this.front.getId() : null; } @@ -398,7 +400,7 @@ public void setFront(String id) { this.front = ApiResource.setExpandableFieldId(id, this.front); } - /** Get expanded `front`. */ + /** Get expanded {@code front}. */ public File getFrontObject() { return (this.front != null) ? this.front.getExpanded() : null; } @@ -415,10 +417,10 @@ public void setFrontObject(File expandableObject) { @EqualsAndHashCode(callSuper = false) public static class Requirements extends StripeObject { /** - * If `disabled_reason` is present, all cards will decline authorizations with - * `cardholder_verification_required` reason. + * If {@code disabled_reason} is present, all cards will decline authorizations with {@code + * cardholder_verification_required} reason. * - *

One of `listed`, `rejected.listed`, or `under_review`. + *

One of {@code listed}, {@code rejected.listed}, or {@code under_review}. */ @SerializedName("disabled_reason") String disabledReason; @@ -440,8 +442,8 @@ public static class SpendingLimit extends StripeObject { Long amount; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * on which to apply the spending limit. Leave this blank to limit all charges. */ @SerializedName("categories") @@ -450,7 +452,8 @@ public static class SpendingLimit extends StripeObject { /** * The time interval or event with which to apply this spending limit towards. * - *

One of `all_time`, `daily`, `monthly`, `per_authorization`, `weekly`, or `yearly`. + *

One of {@code all_time}, {@code daily}, {@code monthly}, {@code per_authorization}, {@code + * weekly}, or {@code yearly}. */ @SerializedName("interval") String interval; diff --git a/src/main/java/com/stripe/model/issuing/Dispute.java b/src/main/java/com/stripe/model/issuing/Dispute.java index a0e27672e44..029d3629854 100644 --- a/src/main/java/com/stripe/model/issuing/Dispute.java +++ b/src/main/java/com/stripe/model/issuing/Dispute.java @@ -24,8 +24,8 @@ @EqualsAndHashCode(callSuper = false) public class Dispute extends ApiResource implements HasId, MetadataStore { /** - * Disputed amount. Usually the amount of the `disputed_transaction`, but can differ (usually - * because of currency fluctuation or because only part of the order is disputed). + * Disputed amount. Usually the amount of the {@code disputed_transaction}, but can differ + * (usually because of currency fluctuation or because only part of the order is disputed). */ @SerializedName("amount") Long amount; @@ -34,7 +34,7 @@ public class Dispute extends ApiResource implements HasId, MetadataStoreEqual to `issuing.dispute`. + *

Equal to {@code issuing.dispute}. */ @SerializedName("object") String object; - /** Reason for this dispute. One of `fraudulent` or `other`. */ + /** Reason for this dispute. One of {@code fraudulent} or {@code other}. */ @SerializedName("reason") String reason; - /** Current status of dispute. One of `unsubmitted`, `under_review`, `won`, or `lost`. */ + /** + * Current status of dispute. One of {@code unsubmitted}, {@code under_review}, {@code won}, or + * {@code lost}. + */ @SerializedName("status") String status; - /** Get id of expandable `disputedTransaction` object. */ + /** Get ID of expandable {@code disputedTransaction} object. */ public String getDisputedTransaction() { return (this.disputedTransaction != null) ? this.disputedTransaction.getId() : null; } @@ -92,7 +95,7 @@ public void setDisputedTransaction(String id) { this.disputedTransaction = ApiResource.setExpandableFieldId(id, this.disputedTransaction); } - /** Get expanded `disputedTransaction`. */ + /** Get expanded {@code disputedTransaction}. */ public Transaction getDisputedTransactionObject() { return (this.disputedTransaction != null) ? this.disputedTransaction.getExpanded() : null; } @@ -243,15 +246,15 @@ public static Dispute retrieve( @EqualsAndHashCode(callSuper = false) public static class Evidence extends StripeObject { /** - * Evidence to support a fraudulent dispute. This will only be present if your dispute's - * `reason` is `fraudulent`. + * Evidence to support a fraudulent dispute. This will only be present if your dispute's {@code + * reason} is {@code fraudulent}. */ @SerializedName("fraudulent") EvidenceFraudulent fraudulent; /** * Evidence to support an uncategorized dispute. This will only be present if your dispute's - * `reason` is `other`. + * {@code reason} is {@code other}. */ @SerializedName("other") EvidenceOther other; @@ -266,15 +269,15 @@ public static class EvidenceFraudulent extends StripeObject { String disputeExplanation; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional file evidence - * supporting your dispute. + * (ID of a file upload) Additional + * file evidence supporting your dispute. */ @SerializedName("uncategorized_file") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) ExpandableField uncategorizedFile; - /** Get id of expandable `uncategorizedFile` object. */ + /** Get ID of expandable {@code uncategorizedFile} object. */ public String getUncategorizedFile() { return (this.uncategorizedFile != null) ? this.uncategorizedFile.getId() : null; } @@ -283,7 +286,7 @@ public void setUncategorizedFile(String id) { this.uncategorizedFile = ApiResource.setExpandableFieldId(id, this.uncategorizedFile); } - /** Get expanded `uncategorizedFile`. */ + /** Get expanded {@code uncategorizedFile}. */ public File getUncategorizedFileObject() { return (this.uncategorizedFile != null) ? this.uncategorizedFile.getExpanded() : null; } @@ -303,15 +306,15 @@ public static class EvidenceOther extends StripeObject { String disputeExplanation; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional file evidence - * supporting your dispute. + * (ID of a file upload) Additional + * file evidence supporting your dispute. */ @SerializedName("uncategorized_file") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) ExpandableField uncategorizedFile; - /** Get id of expandable `uncategorizedFile` object. */ + /** Get ID of expandable {@code uncategorizedFile} object. */ public String getUncategorizedFile() { return (this.uncategorizedFile != null) ? this.uncategorizedFile.getId() : null; } @@ -320,7 +323,7 @@ public void setUncategorizedFile(String id) { this.uncategorizedFile = ApiResource.setExpandableFieldId(id, this.uncategorizedFile); } - /** Get expanded `uncategorizedFile`. */ + /** Get expanded {@code uncategorizedFile}. */ public File getUncategorizedFileObject() { return (this.uncategorizedFile != null) ? this.uncategorizedFile.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/issuing/MerchantData.java b/src/main/java/com/stripe/model/issuing/MerchantData.java index 89159ea9999..e02d29c2e58 100644 --- a/src/main/java/com/stripe/model/issuing/MerchantData.java +++ b/src/main/java/com/stripe/model/issuing/MerchantData.java @@ -11,8 +11,9 @@ @EqualsAndHashCode(callSuper = false) public class MerchantData extends StripeObject { /** - * A categorization of the seller's type of business. See our [merchant categories - * guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. + * A categorization of the seller's type of business. See our merchant categories guide for a + * list of possible values. */ @SerializedName("category") String category; diff --git a/src/main/java/com/stripe/model/issuing/Transaction.java b/src/main/java/com/stripe/model/issuing/Transaction.java index fe2292853bb..9f499d4daf0 100644 --- a/src/main/java/com/stripe/model/issuing/Transaction.java +++ b/src/main/java/com/stripe/model/issuing/Transaction.java @@ -29,15 +29,15 @@ public class Transaction extends ApiResource @SerializedName("amount") Long amount; - /** The `Authorization` object that led to this transaction. */ + /** The {@code Authorization} object that led to this transaction. */ @SerializedName("authorization") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) ExpandableField authorization; /** - * ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated - * with this transaction. + * ID of the balance transaction + * associated with this transaction. */ @SerializedName("balance_transaction") @Getter(lombok.AccessLevel.NONE) @@ -61,15 +61,15 @@ public class Transaction extends ApiResource Long created; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; /** - * If you've disputed the transaction, the ID of the [dispute - * object](https://stripe.com/docs/api/issuing/disputes/object). + * If you've disputed the transaction, the ID of the dispute object. */ @SerializedName("dispute") @Getter(lombok.AccessLevel.NONE) @@ -82,15 +82,15 @@ public class Transaction extends ApiResource String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; /** - * The amount that the merchant will receive, denominated in `merchant_currency`. It will be - * different from `amount` if the merchant is taking payment in a different currency. + * The amount that the merchant will receive, denominated in {@code merchant_currency}. It will be + * different from {@code amount} if the merchant is taking payment in a different currency. */ @SerializedName("merchant_amount") Long merchantAmount; @@ -113,7 +113,7 @@ public class Transaction extends ApiResource /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `issuing.transaction`. + *

Equal to {@code issuing.transaction}. */ @SerializedName("object") String object; @@ -121,13 +121,13 @@ public class Transaction extends ApiResource /** * The nature of the transaction. * - *

One of `capture`, `cash_withdrawal`, `dispute`, `dispute_loss`, `refund`, or - * `refund_reversal`. + *

One of {@code capture}, {@code cash_withdrawal}, {@code dispute}, {@code dispute_loss}, + * {@code refund}, or {@code refund_reversal}. */ @SerializedName("type") String type; - /** Get id of expandable `authorization` object. */ + /** Get ID of expandable {@code authorization} object. */ public String getAuthorization() { return (this.authorization != null) ? this.authorization.getId() : null; } @@ -136,7 +136,7 @@ public void setAuthorization(String id) { this.authorization = ApiResource.setExpandableFieldId(id, this.authorization); } - /** Get expanded `authorization`. */ + /** Get expanded {@code authorization}. */ public Authorization getAuthorizationObject() { return (this.authorization != null) ? this.authorization.getExpanded() : null; } @@ -146,7 +146,7 @@ public void setAuthorizationObject(Authorization expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `balanceTransaction` object. */ + /** Get ID of expandable {@code balanceTransaction} object. */ public String getBalanceTransaction() { return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null; } @@ -155,7 +155,7 @@ public void setBalanceTransaction(String id) { this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction); } - /** Get expanded `balanceTransaction`. */ + /** Get expanded {@code balanceTransaction}. */ public BalanceTransaction getBalanceTransactionObject() { return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null; } @@ -165,7 +165,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `card` object. */ + /** Get ID of expandable {@code card} object. */ public String getCard() { return (this.card != null) ? this.card.getId() : null; } @@ -174,7 +174,7 @@ public void setCard(String id) { this.card = ApiResource.setExpandableFieldId(id, this.card); } - /** Get expanded `card`. */ + /** Get expanded {@code card}. */ public Card getCardObject() { return (this.card != null) ? this.card.getExpanded() : null; } @@ -183,7 +183,7 @@ public void setCardObject(Card expandableObject) { this.card = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `cardholder` object. */ + /** Get ID of expandable {@code cardholder} object. */ public String getCardholder() { return (this.cardholder != null) ? this.cardholder.getId() : null; } @@ -192,7 +192,7 @@ public void setCardholder(String id) { this.cardholder = ApiResource.setExpandableFieldId(id, this.cardholder); } - /** Get expanded `cardholder`. */ + /** Get expanded {@code cardholder}. */ public Cardholder getCardholderObject() { return (this.cardholder != null) ? this.cardholder.getExpanded() : null; } @@ -201,7 +201,7 @@ public void setCardholderObject(Cardholder expandableObject) { this.cardholder = new ExpandableField(expandableObject.getId(), expandableObject); } - /** Get id of expandable `dispute` object. */ + /** Get ID of expandable {@code dispute} object. */ public String getDispute() { return (this.dispute != null) ? this.dispute.getId() : null; } @@ -210,7 +210,7 @@ public void setDispute(String id) { this.dispute = ApiResource.setExpandableFieldId(id, this.dispute); } - /** Get expanded `dispute`. */ + /** Get expanded {@code dispute}. */ public Dispute getDisputeObject() { return (this.dispute != null) ? this.dispute.getExpanded() : null; } diff --git a/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java b/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java index 4e8880194ab..4e543827728 100644 --- a/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java +++ b/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java @@ -38,9 +38,9 @@ public class EarlyFraudWarning extends ApiResource implements HasId { Long created; /** - * The type of fraud labelled by the issuer. One of `card_never_received`, - * `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, - * `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. + * The type of fraud labelled by the issuer. One of {@code card_never_received}, {@code + * fraudulent_card_application}, {@code made_with_counterfeit_card}, {@code made_with_lost_card}, + * {@code made_with_stolen_card}, {@code misc}, {@code unauthorized_use_of_card}. */ @SerializedName("fraud_type") String fraudType; @@ -51,8 +51,8 @@ public class EarlyFraudWarning extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -60,12 +60,12 @@ public class EarlyFraudWarning extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `radar.early_fraud_warning`. + *

Equal to {@code radar.early_fraud_warning}. */ @SerializedName("object") String object; - /** Get id of expandable `charge` object. */ + /** Get ID of expandable {@code charge} object. */ public String getCharge() { return (this.charge != null) ? this.charge.getId() : null; } @@ -74,7 +74,7 @@ public void setCharge(String id) { this.charge = ApiResource.setExpandableFieldId(id, this.charge); } - /** Get expanded `charge`. */ + /** Get expanded {@code charge}. */ public Charge getChargeObject() { return (this.charge != null) ? this.charge.getExpanded() : null; } @@ -112,8 +112,8 @@ public static EarlyFraudWarningCollection list( /** * Retrieves the details of an early fraud warning that has previously been created. * - *

Please refer to the early fraud warning object - * reference for more details. + *

Please refer to the early + * fraud warning object reference for more details. */ public static EarlyFraudWarning retrieve(String earlyFraudWarning) throws StripeException { return retrieve(earlyFraudWarning, (Map) null, (RequestOptions) null); @@ -122,8 +122,8 @@ public static EarlyFraudWarning retrieve(String earlyFraudWarning) throws Stripe /** * Retrieves the details of an early fraud warning that has previously been created. * - *

Please refer to the early fraud warning object - * reference for more details. + *

Please refer to the early + * fraud warning object reference for more details. */ public static EarlyFraudWarning retrieve(String earlyFraudWarning, RequestOptions options) throws StripeException { @@ -133,8 +133,8 @@ public static EarlyFraudWarning retrieve(String earlyFraudWarning, RequestOption /** * Retrieves the details of an early fraud warning that has previously been created. * - *

Please refer to the early fraud warning object - * reference for more details. + *

Please refer to the early + * fraud warning object reference for more details. */ public static EarlyFraudWarning retrieve( String earlyFraudWarning, Map params, RequestOptions options) @@ -152,8 +152,8 @@ public static EarlyFraudWarning retrieve( /** * Retrieves the details of an early fraud warning that has previously been created. * - *

Please refer to the early fraud warning object - * reference for more details. + *

Please refer to the early + * fraud warning object reference for more details. */ public static EarlyFraudWarning retrieve( String earlyFraudWarning, EarlyFraudWarningRetrieveParams params, RequestOptions options) diff --git a/src/main/java/com/stripe/model/radar/ValueList.java b/src/main/java/com/stripe/model/radar/ValueList.java index adbbf7ad2d1..9bee1d7fc78 100644 --- a/src/main/java/com/stripe/model/radar/ValueList.java +++ b/src/main/java/com/stripe/model/radar/ValueList.java @@ -42,8 +42,8 @@ public class ValueList extends ApiResource implements HasId, MetadataStoreEqual to `radar.value_list`. + *

Equal to {@code radar.value_list}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/radar/ValueListItem.java b/src/main/java/com/stripe/model/radar/ValueListItem.java index 3fe73ab024f..f01e133c2ec 100644 --- a/src/main/java/com/stripe/model/radar/ValueListItem.java +++ b/src/main/java/com/stripe/model/radar/ValueListItem.java @@ -36,8 +36,8 @@ public class ValueListItem extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -45,7 +45,7 @@ public class ValueListItem extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `radar.value_list_item`. + *

Equal to {@code radar.value_list_item}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/reporting/ReportRun.java b/src/main/java/com/stripe/model/reporting/ReportRun.java index 979479be236..34d51dbc3b2 100644 --- a/src/main/java/com/stripe/model/reporting/ReportRun.java +++ b/src/main/java/com/stripe/model/reporting/ReportRun.java @@ -26,8 +26,8 @@ public class ReportRun extends ApiResource implements HasId { Long created; /** - * If something should go wrong during the run, a message about the failure (populated when - * `status=failed`). + * If something should go wrong during the run, a message about the failure (populated when {@code + * status=failed}). */ @SerializedName("error") String error; @@ -37,14 +37,14 @@ public class ReportRun extends ApiResource implements HasId { @SerializedName("id") String id; - /** Always `true`: reports can only be run on live-mode data. */ + /** Always {@code true}: reports can only be run on live-mode data. */ @SerializedName("livemode") Boolean livemode; /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `reporting.report_run`. + *

Equal to {@code reporting.report_run}. */ @SerializedName("object") String object; @@ -53,30 +53,31 @@ public class ReportRun extends ApiResource implements HasId { Parameters parameters; /** - * The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to - * run, such as `"balance.summary.1"`. + * The ID of the report + * type to run, such as {@code "balance.summary.1"}. */ @SerializedName("report_type") String reportType; /** - * The file object representing the result of the report run (populated when `status=succeeded`). + * The file object representing the result of the report run (populated when {@code + * status=succeeded}). */ @SerializedName("result") File result; /** - * Status of this report run. This will be `pending` when the run is initially created. When the - * run finishes, this will be set to `succeeded` and the `result` field will be populated. Rarely, - * we may encounter an error, at which point this will be set to `failed` and the `error` field - * will be populated. + * Status of this report run. This will be {@code pending} when the run is initially created. When + * the run finishes, this will be set to {@code succeeded} and the {@code result} field will be + * populated. Rarely, we may encounter an error, at which point this will be set to {@code failed} + * and the {@code error} field will be populated. */ @SerializedName("status") String status; /** - * Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured - * in seconds since the Unix epoch. + * Timestamp at which this run successfully finished (populated when {@code status=succeeded}). + * Measured in seconds since the Unix epoch. */ @SerializedName("succeeded_at") Long succeededAt; diff --git a/src/main/java/com/stripe/model/reporting/ReportType.java b/src/main/java/com/stripe/model/reporting/ReportType.java index 0269ec6a52c..19afb5aa8e4 100644 --- a/src/main/java/com/stripe/model/reporting/ReportType.java +++ b/src/main/java/com/stripe/model/reporting/ReportType.java @@ -34,15 +34,14 @@ public class ReportType extends ApiResource implements HasId { /** * List of column names that are included by default when this Report Type gets run. (If the - * Report Type doesn't support the `columns` parameter, this will be null.) + * Report Type doesn't support the {@code columns} parameter, this will be null.) */ @SerializedName("default_columns") List defaultColumns; /** - * The [ID of the Report - * Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as - * `balance.summary.1`. + * The ID of the + * Report Type, such as {@code balance.summary.1}. */ @Getter(onMethod_ = {@Override}) @SerializedName("id") @@ -55,7 +54,7 @@ public class ReportType extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `reporting.report_type`. + *

Equal to {@code reporting.report_type}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java b/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java index a8c62809a2f..5da90e2f7eb 100644 --- a/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java +++ b/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java @@ -40,8 +40,8 @@ public class ScheduledQueryRun extends ApiResource implements HasId { String id; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -49,7 +49,7 @@ public class ScheduledQueryRun extends ApiResource implements HasId { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `scheduled_query_run`. + *

Equal to {@code scheduled_query_run}. */ @SerializedName("object") String object; @@ -63,8 +63,8 @@ public class ScheduledQueryRun extends ApiResource implements HasId { String sql; /** - * The query's execution status, which will be `completed` for successful runs, and `canceled`, - * `failed`, or `timed_out` otherwise. + * The query's execution status, which will be {@code completed} for successful runs, and {@code + * canceled}, {@code failed}, or {@code timed_out} otherwise. */ @SerializedName("status") String status; diff --git a/src/main/java/com/stripe/model/terminal/ConnectionToken.java b/src/main/java/com/stripe/model/terminal/ConnectionToken.java index d1f77eda011..9508004a317 100644 --- a/src/main/java/com/stripe/model/terminal/ConnectionToken.java +++ b/src/main/java/com/stripe/model/terminal/ConnectionToken.java @@ -22,7 +22,7 @@ public class ConnectionToken extends ApiResource { /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `terminal.connection_token`. + *

Equal to {@code terminal.connection_token}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/terminal/Location.java b/src/main/java/com/stripe/model/terminal/Location.java index 09531364684..bc63d7dc37f 100644 --- a/src/main/java/com/stripe/model/terminal/Location.java +++ b/src/main/java/com/stripe/model/terminal/Location.java @@ -38,8 +38,8 @@ public class Location extends ApiResource implements HasId, MetadataStoreEqual to `terminal.location`. + *

Equal to {@code terminal.location}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/model/terminal/Reader.java b/src/main/java/com/stripe/model/terminal/Reader.java index 67adf5cf24e..a2955f91103 100644 --- a/src/main/java/com/stripe/model/terminal/Reader.java +++ b/src/main/java/com/stripe/model/terminal/Reader.java @@ -28,7 +28,7 @@ public class Reader extends ApiResource implements HasId, MetadataStore @SerializedName("device_sw_version") String deviceSwVersion; - /** Type of reader, one of `bbpos_chipper2x` or `verifone_P400`. */ + /** Type of reader, one of {@code bbpos_chipper2x} or {@code verifone_P400}. */ @SerializedName("device_type") String deviceType; @@ -46,8 +46,8 @@ public class Reader extends ApiResource implements HasId, MetadataStore String label; /** - * Has the value `true` if the object exists in live mode or the value `false` if the object - * exists in test mode. + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the + * object exists in test mode. */ @SerializedName("livemode") Boolean livemode; @@ -67,7 +67,7 @@ public class Reader extends ApiResource implements HasId, MetadataStore /** * String representing the object's type. Objects of the same type share the same value. * - *

Equal to `terminal.reader`. + *

Equal to {@code terminal.reader}. */ @SerializedName("object") String object; diff --git a/src/main/java/com/stripe/param/AccountCreateParams.java b/src/main/java/com/stripe/param/AccountCreateParams.java index ae63607a618..9f74f0b98df 100644 --- a/src/main/java/com/stripe/param/AccountCreateParams.java +++ b/src/main/java/com/stripe/param/AccountCreateParams.java @@ -12,7 +12,10 @@ @Getter public class AccountCreateParams extends ApiRequestParams { - /** An [account token](#create_account_token), used to securely provide details to the account. */ + /** + * An account token, used to + * securely provide details to the account. + */ @SerializedName("account_token") String accountToken; @@ -25,8 +28,8 @@ public class AccountCreateParams extends ApiRequestParams { Object businessType; /** - * Information about the company or business. This field is null unless `business_type` is set to - * `company`, `government_entity`, or `non_profit`. + * Information about the company or business. This field is null unless {@code business_type} is + * set to {@code company}, {@code government_entity}, or {@code non_profit}. */ @SerializedName("company") Company company; @@ -35,14 +38,15 @@ public class AccountCreateParams extends ApiRequestParams { * The country in which the account holder resides, or in which the business is legally * established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the * United States and the business for which you're creating an account is legally represented in - * Canada, you would use `CA` as the country for the account being created. + * Canada, you would use {@code CA} as the country for the account being created. */ @SerializedName("country") String country; /** * Three-letter ISO currency code representing the default currency for the account. This must be - * a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). + * a currency that Stripe supports in the account's + * country. */ @SerializedName("default_currency") String defaultCurrency; @@ -60,14 +64,13 @@ public class AccountCreateParams extends ApiRequestParams { /** * A card or bank account to attach to the account. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in - * the `external_account` parameter for [bank - * account](https://stripe.com/docs/api#account_create_bank_account) creation.
- *
- * By default, providing an external account sets it as the new default external account for its - * currency, and deletes the old default if one exists. To add additional external accounts - * without replacing the existing default for the currency, use the bank account or card creation - * API. + * returned by Stripe.js, or a dictionary, as + * documented in the {@code external_account} parameter for bank account creation. + * <br><br>By default, providing an external account sets it as the new default + * external account for its currency, and deletes the old default if one exists. To add additional + * external accounts without replacing the existing default for the currency, use the bank account + * or card creation API. */ @SerializedName("external_account") String externalAccount; @@ -82,8 +85,8 @@ public class AccountCreateParams extends ApiRequestParams { Map extraParams; /** - * Information about the person represented by the account. This field is null unless - * `business_type` is set to `individual`. + * Information about the person represented by the account. This field is null unless {@code + * business_type} is set to {@code individual}. */ @SerializedName("individual") Individual individual; @@ -91,7 +94,8 @@ public class AccountCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -109,15 +113,17 @@ public class AccountCreateParams extends ApiRequestParams { Settings settings; /** - * Details on the account's acceptance of the [Stripe Services - * Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + * Details on the account's acceptance of the Stripe Services + * Agreement. */ @SerializedName("tos_acceptance") TosAcceptance tosAcceptance; /** - * The type of Stripe account to create. Currently must be `custom`, as only [Custom - * accounts](https://stripe.com/docs/connect/custom-accounts) may be created via the API. + * The type of Stripe account to create. Currently must be {@code custom}, as only Custom accounts may be created via + * the API. */ @SerializedName("type") Type type; @@ -216,7 +222,8 @@ public AccountCreateParams build() { } /** - * An [account token](#create_account_token), used to securely provide details to the account. + * An account token, used to + * securely provide details to the account. */ public Builder setAccountToken(String accountToken) { this.accountToken = accountToken; @@ -242,8 +249,8 @@ public Builder setBusinessType(String businessType) { } /** - * Information about the company or business. This field is null unless `business_type` is set - * to `company`, `government_entity`, or `non_profit`. + * Information about the company or business. This field is null unless {@code business_type} is + * set to {@code company}, {@code government_entity}, or {@code non_profit}. */ public Builder setCompany(Company company) { this.company = company; @@ -254,7 +261,7 @@ public Builder setCompany(Company company) { * The country in which the account holder resides, or in which the business is legally * established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in * the United States and the business for which you're creating an account is legally - * represented in Canada, you would use `CA` as the country for the account being created. + * represented in Canada, you would use {@code CA} as the country for the account being created. */ public Builder setCountry(String country) { this.country = country; @@ -263,8 +270,8 @@ public Builder setCountry(String country) { /** * Three-letter ISO currency code representing the default currency for the account. This must - * be a currency that [Stripe supports in the account's - * country](https://stripe.com/docs/payouts). + * be a currency that Stripe supports in the account's + * country. */ public Builder setDefaultCurrency(String defaultCurrency) { this.defaultCurrency = defaultCurrency; @@ -308,14 +315,13 @@ public Builder addAllExpand(List elements) { /** * A card or bank account to attach to the account. You can provide either a token, like the - * ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as - * documented in the `external_account` parameter for [bank - * account](https://stripe.com/docs/api#account_create_bank_account) creation.
- *
- * By default, providing an external account sets it as the new default external account for its - * currency, and deletes the old default if one exists. To add additional external accounts - * without replacing the existing default for the currency, use the bank account or card - * creation API. + * ones returned by Stripe.js, or a dictionary, + * as documented in the {@code external_account} parameter for bank account creation. + * <br><br>By default, providing an external account sets it as the new default + * external account for its currency, and deletes the old default if one exists. To add + * additional external accounts without replacing the existing default for the currency, use the + * bank account or card creation API. */ public Builder setExternalAccount(String externalAccount) { this.externalAccount = externalAccount; @@ -349,8 +355,8 @@ public Builder putAllExtraParam(Map map) { } /** - * Information about the person represented by the account. This field is null unless - * `business_type` is set to `individual`. + * Information about the person represented by the account. This field is null unless {@code + * business_type} is set to {@code individual}. */ public Builder setIndividual(Individual individual) { this.individual = individual; @@ -416,8 +422,9 @@ public Builder setSettings(Settings settings) { } /** - * Details on the account's acceptance of the [Stripe Services - * Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + * Details on the account's acceptance of the Stripe Services + * Agreement. */ public Builder setTosAcceptance(TosAcceptance tosAcceptance) { this.tosAcceptance = tosAcceptance; @@ -425,8 +432,9 @@ public Builder setTosAcceptance(TosAcceptance tosAcceptance) { } /** - * The type of Stripe account to create. Currently must be `custom`, as only [Custom - * accounts](https://stripe.com/docs/connect/custom-accounts) may be created via the API. + * The type of Stripe account to create. Currently must be {@code custom}, as only Custom accounts may be created via + * the API. */ public Builder setType(Type type) { this.type = type; @@ -446,8 +454,9 @@ public static class BusinessProfile { Map extraParams; /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). - * MCCs are used to classify businesses based on the goods or services they provide. + * The merchant category code for the + * account. MCCs are used to classify businesses based on the goods or services they + * provide. */ @SerializedName("mcc") String mcc; @@ -559,8 +568,9 @@ public Builder putAllExtraParam(Map map) { } /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). - * MCCs are used to classify businesses based on the goods or services they provide. + * The merchant category code for the + * account. MCCs are used to classify businesses based on the goods or services they + * provide. */ public Builder setMcc(String mcc) { this.mcc = mcc; @@ -623,20 +633,19 @@ public static class Company { AddressKanji addressKanji; /** - * Whether the company's directors have been provided. Set this Boolean to `true` after creating - * all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for - * accounts with a `relationship.director` requirement. This value is not automatically set to - * `true` after creating directors, so it needs to be updated to indicate all directors have - * been provided. + * Whether the company's directors have been provided. Set this Boolean to {@code true} after + * creating all the company's directors with the + * Persons API for accounts with a {@code relationship.director} requirement. This value is + * not automatically set to {@code true} after creating directors, so it needs to be updated to + * indicate all directors have been provided. */ @SerializedName("directors_provided") Boolean directorsProvided; /** - * Whether the company's executives have been provided. Set this Boolean to `true` after - * creating all the company's executives with [the Persons - * API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` - * requirement. + * Whether the company's executives have been provided. Set this Boolean to {@code true} after + * creating all the company's executives with the + * Persons API for accounts with a {@code relationship.executive} requirement. */ @SerializedName("executives_provided") Boolean executivesProvided; @@ -663,9 +672,9 @@ public static class Company { String nameKanji; /** - * Whether the company's owners have been provided. Set this Boolean to `true` after creating - * all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for - * accounts with a `relationship.owner` requirement. + * Whether the company's owners have been provided. Set this Boolean to {@code true} after + * creating all the company's owners with the + * Persons API for accounts with a {@code relationship.owner} requirement. */ @SerializedName("owners_provided") Boolean ownersProvided; @@ -686,7 +695,9 @@ public static class Company { @SerializedName("tax_id") String taxId; - /** The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ + /** + * The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only). + */ @SerializedName("tax_id_registrar") String taxIdRegistrar; @@ -810,11 +821,11 @@ public Builder setAddressKanji(AddressKanji addressKanji) { } /** - * Whether the company's directors have been provided. Set this Boolean to `true` after - * creating all the company's directors with [the Persons - * API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` - * requirement. This value is not automatically set to `true` after creating directors, so it - * needs to be updated to indicate all directors have been provided. + * Whether the company's directors have been provided. Set this Boolean to {@code true} after + * creating all the company's directors with the + * Persons API for accounts with a {@code relationship.director} requirement. This value + * is not automatically set to {@code true} after creating directors, so it needs to be + * updated to indicate all directors have been provided. */ public Builder setDirectorsProvided(Boolean directorsProvided) { this.directorsProvided = directorsProvided; @@ -822,10 +833,10 @@ public Builder setDirectorsProvided(Boolean directorsProvided) { } /** - * Whether the company's executives have been provided. Set this Boolean to `true` after - * creating all the company's executives with [the Persons - * API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` - * requirement. + * Whether the company's executives have been provided. Set this Boolean to {@code true} after + * creating all the company's executives with the Persons API for accounts with a {@code + * relationship.executive} requirement. */ public Builder setExecutivesProvided(Boolean executivesProvided) { this.executivesProvided = executivesProvided; @@ -877,9 +888,9 @@ public Builder setNameKanji(String nameKanji) { } /** - * Whether the company's owners have been provided. Set this Boolean to `true` after creating - * all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for - * accounts with a `relationship.owner` requirement. + * Whether the company's owners have been provided. Set this Boolean to {@code true} after + * creating all the company's owners with the + * Persons API for accounts with a {@code relationship.owner} requirement. */ public Builder setOwnersProvided(Boolean ownersProvided) { this.ownersProvided = ownersProvided; @@ -914,7 +925,9 @@ public Builder setTaxId(String taxId) { return this; } - /** The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ + /** + * The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only). + */ public Builder setTaxIdRegistrar(String taxIdRegistrar) { this.taxIdRegistrar = taxIdRegistrar; return this; @@ -940,8 +953,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1026,8 +1039,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1095,8 +1108,8 @@ public static class AddressKana { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1190,8 +1203,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1265,8 +1278,8 @@ public static class AddressKanji { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1360,8 +1373,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1500,9 +1513,10 @@ public Builder putAllExtraParam(Map map) { @Getter public static class Document { /** - * The back of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. The uploaded file needs to be a color image (smaller than - * 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image + * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ @SerializedName("back") String back; @@ -1518,9 +1532,10 @@ public static class Document { Map extraParams; /** - * The front of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. The uploaded file needs to be a color image (smaller than - * 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image + * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ @SerializedName("front") String front; @@ -1548,9 +1563,10 @@ public Document build() { } /** - * The back of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. The uploaded file needs to be a color image (smaller than - * 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image + * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -1586,8 +1602,9 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of a document returned by a [file upload](#create_file) with a `purpose` - * value of `additional_verification`. The uploaded file needs to be a color image + * The front of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ public Builder setFront(String front) { @@ -1684,15 +1701,19 @@ public static class Individual { @SerializedName("first_name_kanji") String firstNameKanji; - /** The individual's gender (International regulations require either "male" or "female"). */ + /** + * The individual's gender (International regulations require either "male" or + * "female"). + */ @SerializedName("gender") String gender; /** * The government-issued ID number of the individual, as appropriate for the representative’s * country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in - * Canada). Instead of the number itself, you can also provide a [PII token created with - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * Canada). Instead of the number itself, you can also provide a PII token created with + * Stripe.js. */ @SerializedName("id_number") String idNumber; @@ -1716,8 +1737,8 @@ public static class Individual { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -1922,7 +1943,10 @@ public Builder setFirstNameKanji(String firstNameKanji) { return this; } - /** The individual's gender (International regulations require either "male" or "female"). */ + /** + * The individual's gender (International regulations require either "male" or + * "female"). + */ public Builder setGender(String gender) { this.gender = gender; return this; @@ -1931,8 +1955,9 @@ public Builder setGender(String gender) { /** * The government-issued ID number of the individual, as appropriate for the representative’s * country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number - * in Canada). Instead of the number itself, you can also provide a [PII token created with - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * in Canada). Instead of the number itself, you can also provide a PII token created with + * Stripe.js. */ public Builder setIdNumber(String idNumber) { this.idNumber = idNumber; @@ -2015,8 +2040,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -2101,8 +2126,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -2170,8 +2195,8 @@ public static class AddressKana { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -2265,8 +2290,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -2340,8 +2365,8 @@ public static class AddressKanji { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -2435,8 +2460,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -2693,9 +2718,10 @@ public Builder putAllExtraParam(Map map) { @Getter public static class AdditionalDocument { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("back") String back; @@ -2711,9 +2737,10 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("front") String front; @@ -2741,9 +2768,10 @@ public AdditionalDocument build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -2781,9 +2809,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -2795,9 +2824,10 @@ public Builder setFront(String front) { @Getter public static class Document { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("back") String back; @@ -2813,9 +2843,10 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("front") String front; @@ -2843,9 +2874,10 @@ public Document build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -2881,9 +2913,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -3024,16 +3057,16 @@ public static class Branding { Map extraParams; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the - * account. Must be square and at least 128px x 128px. + * (ID of a file upload) An icon for + * the account. Must be square and at least 128px x 128px. */ @SerializedName("icon") String icon; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account - * that will be used in Checkout instead of the icon and without the account's name next to it - * if provided. Must be at least 128px x 128px. + * (ID of a file upload) A logo for + * the account that will be used in Checkout instead of the icon and without the account's + * name next to it if provided. Must be at least 128px x 128px. */ @SerializedName("logo") String logo; @@ -3097,8 +3130,8 @@ public Builder putAllExtraParam(Map map) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the - * account. Must be square and at least 128px x 128px. + * (ID of a file upload) An icon + * for the account. Must be square and at least 128px x 128px. */ public Builder setIcon(String icon) { this.icon = icon; @@ -3106,9 +3139,9 @@ public Builder setIcon(String icon) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the - * account that will be used in Checkout instead of the icon and without the account's name - * next to it if provided. Must be at least 128px x 128px. + * (ID of a file upload) A logo for + * the account that will be used in Checkout instead of the icon and without the account's + * name next to it if provided. Must be at least 128px x 128px. */ public Builder setLogo(String logo) { this.logo = logo; @@ -3143,8 +3176,8 @@ public static class CardPayments { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. - * `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic + * prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code + * statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic * portion. */ @SerializedName("statement_descriptor_prefix") @@ -3212,8 +3245,8 @@ public Builder putAllExtraParam(Map map) { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. - * `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic + * prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code + * statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic * portion. */ public Builder setStatementDescriptorPrefix(String statementDescriptorPrefix) { @@ -3334,7 +3367,7 @@ public static class Payments { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. + * prefixes any dynamic {@code statement_descriptor} specified on the charge. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -3416,7 +3449,7 @@ public Builder putAllExtraParam(Map map) { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. + * prefixes any dynamic {@code statement_descriptor} specified on the charge. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -3447,8 +3480,9 @@ public Builder setStatementDescriptorKanji(String statementDescriptorKanji) { public static class Payouts { /** * A Boolean indicating whether Stripe should try to reclaim negative balances from an - * attached bank account. For details, see [Understanding Connect Account - * Balances](https://stripe.com/docs/connect/account-balances). + * attached bank account. For details, see Understanding Connect Account + * Balances. */ @SerializedName("debit_negative_balances") Boolean debitNegativeBalances; @@ -3464,8 +3498,9 @@ public static class Payouts { /** * Details on when funds from charges are available, and when they are paid out to an external - * account. For details, see our [Setting Bank and Debit Card - * Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation. + * account. For details, see our Setting Bank and + * Debit Card Payouts documentation. */ @SerializedName("schedule") Schedule schedule; @@ -3512,8 +3547,9 @@ public Payouts build() { /** * A Boolean indicating whether Stripe should try to reclaim negative balances from an - * attached bank account. For details, see [Understanding Connect Account - * Balances](https://stripe.com/docs/connect/account-balances). + * attached bank account. For details, see Understanding Connect Account + * Balances. */ public Builder setDebitNegativeBalances(Boolean debitNegativeBalances) { this.debitNegativeBalances = debitNegativeBalances; @@ -3550,9 +3586,9 @@ public Builder putAllExtraParam(Map map) { /** * Details on when funds from charges are available, and when they are paid out to an - * external account. For details, see our [Setting Bank and Debit Card - * Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) - * documentation. + * external account. For details, see our Setting Bank and + * Debit Card Payouts documentation. */ public Builder setSchedule(Schedule schedule) { this.schedule = schedule; @@ -3572,9 +3608,10 @@ public Builder setStatementDescriptor(String statementDescriptor) { @Getter public static class Schedule { /** - * The number of days charge funds are held before being paid out. May also be set to - * `minimum`, representing the lowest available value for the account country. Default is - * `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`. + * The number of days charge funds are held before being paid out. May also be set to {@code + * minimum}, representing the lowest available value for the account country. Default is + * {@code minimum}. The {@code delay_days} parameter does not apply when the {@code + * interval} is {@code manual}. */ @SerializedName("delay_days") Object delayDays; @@ -3590,8 +3627,8 @@ public static class Schedule { Map extraParams; /** - * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or - * `monthly`. Default is `daily`. + * How frequently available funds are paid out. One of: {@code daily}, {@code manual}, + * {@code weekly}, or {@code monthly}. Default is {@code daily}. */ @SerializedName("interval") Interval interval; @@ -3599,15 +3636,16 @@ public static class Schedule { /** * The day of the month when available funds are paid out, specified as a number between * 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead - * sent on the last day of a shorter month. Required and applicable only if `interval` is - * `monthly`. + * sent on the last day of a shorter month. Required and applicable only if {@code interval} + * is {@code monthly}. */ @SerializedName("monthly_anchor") Long monthlyAnchor; /** - * The day of the week when available funds are paid out, specified as `monday`, `tuesday`, - * etc. (required and applicable only if `interval` is `weekly`.) + * The day of the week when available funds are paid out, specified as {@code monday}, + * {@code tuesday}, etc. (required and applicable only if {@code interval} is {@code + * weekly}.) */ @SerializedName("weekly_anchor") WeeklyAnchor weeklyAnchor; @@ -3652,8 +3690,9 @@ public Schedule build() { /** * The number of days charge funds are held before being paid out. May also be set to - * `minimum`, representing the lowest available value for the account country. Default is - * `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`. + * {@code minimum}, representing the lowest available value for the account country. + * Default is {@code minimum}. The {@code delay_days} parameter does not apply when the + * {@code interval} is {@code manual}. */ public Builder setDelayDays(DelayDays delayDays) { this.delayDays = delayDays; @@ -3662,8 +3701,9 @@ public Builder setDelayDays(DelayDays delayDays) { /** * The number of days charge funds are held before being paid out. May also be set to - * `minimum`, representing the lowest available value for the account country. Default is - * `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`. + * {@code minimum}, representing the lowest available value for the account country. + * Default is {@code minimum}. The {@code delay_days} parameter does not apply when the + * {@code interval} is {@code manual}. */ public Builder setDelayDays(Long delayDays) { this.delayDays = delayDays; @@ -3699,8 +3739,8 @@ public Builder putAllExtraParam(Map map) { } /** - * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or - * `monthly`. Default is `daily`. + * How frequently available funds are paid out. One of: {@code daily}, {@code manual}, + * {@code weekly}, or {@code monthly}. Default is {@code daily}. */ public Builder setInterval(Interval interval) { this.interval = interval; @@ -3710,8 +3750,8 @@ public Builder setInterval(Interval interval) { /** * The day of the month when available funds are paid out, specified as a number between * 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead - * sent on the last day of a shorter month. Required and applicable only if `interval` is - * `monthly`. + * sent on the last day of a shorter month. Required and applicable only if {@code + * interval} is {@code monthly}. */ public Builder setMonthlyAnchor(Long monthlyAnchor) { this.monthlyAnchor = monthlyAnchor; @@ -3719,8 +3759,9 @@ public Builder setMonthlyAnchor(Long monthlyAnchor) { } /** - * The day of the week when available funds are paid out, specified as `monday`, - * `tuesday`, etc. (required and applicable only if `interval` is `weekly`.) + * The day of the week when available funds are paid out, specified as {@code monday}, + * {@code tuesday}, etc. (required and applicable only if {@code interval} is {@code + * weekly}.) */ public Builder setWeeklyAnchor(WeeklyAnchor weeklyAnchor) { this.weeklyAnchor = weeklyAnchor; diff --git a/src/main/java/com/stripe/param/AccountLinkCreateParams.java b/src/main/java/com/stripe/param/AccountLinkCreateParams.java index 990a39f70a1..69b74eb6b8e 100644 --- a/src/main/java/com/stripe/param/AccountLinkCreateParams.java +++ b/src/main/java/com/stripe/param/AccountLinkCreateParams.java @@ -15,8 +15,8 @@ public class AccountLinkCreateParams extends ApiRequestParams { String account; /** - * Which information the platform needs to collect from the user. One of `currently_due` or - * `eventually_due`. Default is `currently_due`. + * Which information the platform needs to collect from the user. One of {@code currently_due} or + * {@code eventually_due}. Default is {@code currently_due}. */ @SerializedName("collect") Collect collect; @@ -46,8 +46,8 @@ public class AccountLinkCreateParams extends ApiRequestParams { String successUrl; /** - * The type of account link the user is requesting. Possible values are - * `custom_account_verification` or `custom_account_update`. + * The type of account link the user is requesting. Possible values are {@code + * custom_account_verification} or {@code custom_account_update}. */ @SerializedName("type") String type; @@ -107,8 +107,8 @@ public Builder setAccount(String account) { } /** - * Which information the platform needs to collect from the user. One of `currently_due` or - * `eventually_due`. Default is `currently_due`. + * Which information the platform needs to collect from the user. One of {@code currently_due} + * or {@code eventually_due}. Default is {@code currently_due}. */ public Builder setCollect(Collect collect) { this.collect = collect; @@ -183,8 +183,8 @@ public Builder setSuccessUrl(String successUrl) { } /** - * The type of account link the user is requesting. Possible values are - * `custom_account_verification` or `custom_account_update`. + * The type of account link the user is requesting. Possible values are {@code + * custom_account_verification} or {@code custom_account_update}. */ public Builder setType(String type) { this.type = type; diff --git a/src/main/java/com/stripe/param/AccountListParams.java b/src/main/java/com/stripe/param/AccountListParams.java index ebcd8c63c71..043bc64532b 100644 --- a/src/main/java/com/stripe/param/AccountListParams.java +++ b/src/main/java/com/stripe/param/AccountListParams.java @@ -14,10 +14,10 @@ public class AccountListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -43,10 +43,10 @@ public class AccountListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -105,10 +105,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -177,10 +177,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/AccountPersonsParams.java b/src/main/java/com/stripe/param/AccountPersonsParams.java index 5a0d5e61ced..f9e91b91065 100644 --- a/src/main/java/com/stripe/param/AccountPersonsParams.java +++ b/src/main/java/com/stripe/param/AccountPersonsParams.java @@ -11,10 +11,10 @@ @Getter public class AccountPersonsParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -47,10 +47,10 @@ public class AccountPersonsParams extends ApiRequestParams { Relationship relationship; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -99,10 +99,10 @@ public AccountPersonsParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -180,10 +180,10 @@ public Builder setRelationship(Relationship relationship) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/AccountRejectParams.java b/src/main/java/com/stripe/param/AccountRejectParams.java index 21fbeddb46b..496e6d99bcb 100644 --- a/src/main/java/com/stripe/param/AccountRejectParams.java +++ b/src/main/java/com/stripe/param/AccountRejectParams.java @@ -23,7 +23,10 @@ public class AccountRejectParams extends ApiRequestParams { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ + /** + * The reason for rejecting the account. Can be {@code fraud}, {@code terms_of_service}, or {@code + * other}. + */ @SerializedName("reason") String reason; @@ -101,7 +104,10 @@ public Builder putAllExtraParam(Map map) { return this; } - /** The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ + /** + * The reason for rejecting the account. Can be {@code fraud}, {@code terms_of_service}, or + * {@code other}. + */ public Builder setReason(String reason) { this.reason = reason; return this; diff --git a/src/main/java/com/stripe/param/AccountUpdateParams.java b/src/main/java/com/stripe/param/AccountUpdateParams.java index 3e58087e9c0..47dea4c74c8 100644 --- a/src/main/java/com/stripe/param/AccountUpdateParams.java +++ b/src/main/java/com/stripe/param/AccountUpdateParams.java @@ -12,7 +12,10 @@ @Getter public class AccountUpdateParams extends ApiRequestParams { - /** An [account token](#create_account_token), used to securely provide details to the account. */ + /** + * An account token, used to + * securely provide details to the account. + */ @SerializedName("account_token") Object accountToken; @@ -25,15 +28,16 @@ public class AccountUpdateParams extends ApiRequestParams { Object businessType; /** - * Information about the company or business. This field is null unless `business_type` is set to - * `company`, `government_entity`, or `non_profit`. + * Information about the company or business. This field is null unless {@code business_type} is + * set to {@code company}, {@code government_entity}, or {@code non_profit}. */ @SerializedName("company") Company company; /** * Three-letter ISO currency code representing the default currency for the account. This must be - * a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). + * a currency that Stripe supports in the account's + * country. */ @SerializedName("default_currency") Object defaultCurrency; @@ -52,14 +56,13 @@ public class AccountUpdateParams extends ApiRequestParams { /** * A card or bank account to attach to the account. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in - * the `external_account` parameter for [bank - * account](https://stripe.com/docs/api#account_create_bank_account) creation.
- *
- * By default, providing an external account sets it as the new default external account for its - * currency, and deletes the old default if one exists. To add additional external accounts - * without replacing the existing default for the currency, use the bank account or card creation - * API. + * returned by Stripe.js, or a dictionary, as + * documented in the {@code external_account} parameter for bank account creation. + * <br><br>By default, providing an external account sets it as the new default + * external account for its currency, and deletes the old default if one exists. To add additional + * external accounts without replacing the existing default for the currency, use the bank account + * or card creation API. */ @SerializedName("external_account") Object externalAccount; @@ -74,8 +77,8 @@ public class AccountUpdateParams extends ApiRequestParams { Map extraParams; /** - * Information about the person represented by the account. This field is null unless - * `business_type` is set to `individual`. + * Information about the person represented by the account. This field is null unless {@code + * business_type} is set to {@code individual}. */ @SerializedName("individual") Individual individual; @@ -83,7 +86,8 @@ public class AccountUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -101,8 +105,9 @@ public class AccountUpdateParams extends ApiRequestParams { Settings settings; /** - * Details on the account's acceptance of the [Stripe Services - * Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + * Details on the account's acceptance of the Stripe Services + * Agreement. */ @SerializedName("tos_acceptance") TosAcceptance tosAcceptance; @@ -191,7 +196,8 @@ public AccountUpdateParams build() { } /** - * An [account token](#create_account_token), used to securely provide details to the account. + * An account token, used to + * securely provide details to the account. */ public Builder setAccountToken(String accountToken) { this.accountToken = accountToken; @@ -199,7 +205,8 @@ public Builder setAccountToken(String accountToken) { } /** - * An [account token](#create_account_token), used to securely provide details to the account. + * An account token, used to + * securely provide details to the account. */ public Builder setAccountToken(EmptyParam accountToken) { this.accountToken = accountToken; @@ -231,8 +238,8 @@ public Builder setBusinessType(EmptyParam businessType) { } /** - * Information about the company or business. This field is null unless `business_type` is set - * to `company`, `government_entity`, or `non_profit`. + * Information about the company or business. This field is null unless {@code business_type} is + * set to {@code company}, {@code government_entity}, or {@code non_profit}. */ public Builder setCompany(Company company) { this.company = company; @@ -241,8 +248,8 @@ public Builder setCompany(Company company) { /** * Three-letter ISO currency code representing the default currency for the account. This must - * be a currency that [Stripe supports in the account's - * country](https://stripe.com/docs/payouts). + * be a currency that Stripe supports in the account's + * country. */ public Builder setDefaultCurrency(String defaultCurrency) { this.defaultCurrency = defaultCurrency; @@ -251,8 +258,8 @@ public Builder setDefaultCurrency(String defaultCurrency) { /** * Three-letter ISO currency code representing the default currency for the account. This must - * be a currency that [Stripe supports in the account's - * country](https://stripe.com/docs/payouts). + * be a currency that Stripe supports in the account's + * country. */ public Builder setDefaultCurrency(EmptyParam defaultCurrency) { this.defaultCurrency = defaultCurrency; @@ -307,14 +314,13 @@ public Builder addAllExpand(List elements) { /** * A card or bank account to attach to the account. You can provide either a token, like the - * ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as - * documented in the `external_account` parameter for [bank - * account](https://stripe.com/docs/api#account_create_bank_account) creation.
- *
- * By default, providing an external account sets it as the new default external account for its - * currency, and deletes the old default if one exists. To add additional external accounts - * without replacing the existing default for the currency, use the bank account or card - * creation API. + * ones returned by Stripe.js, or a dictionary, + * as documented in the {@code external_account} parameter for bank account creation. + * <br><br>By default, providing an external account sets it as the new default + * external account for its currency, and deletes the old default if one exists. To add + * additional external accounts without replacing the existing default for the currency, use the + * bank account or card creation API. */ public Builder setExternalAccount(String externalAccount) { this.externalAccount = externalAccount; @@ -323,14 +329,13 @@ public Builder setExternalAccount(String externalAccount) { /** * A card or bank account to attach to the account. You can provide either a token, like the - * ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as - * documented in the `external_account` parameter for [bank - * account](https://stripe.com/docs/api#account_create_bank_account) creation.
- *
- * By default, providing an external account sets it as the new default external account for its - * currency, and deletes the old default if one exists. To add additional external accounts - * without replacing the existing default for the currency, use the bank account or card - * creation API. + * ones returned by Stripe.js, or a dictionary, + * as documented in the {@code external_account} parameter for bank account creation. + * <br><br>By default, providing an external account sets it as the new default + * external account for its currency, and deletes the old default if one exists. To add + * additional external accounts without replacing the existing default for the currency, use the + * bank account or card creation API. */ public Builder setExternalAccount(EmptyParam externalAccount) { this.externalAccount = externalAccount; @@ -364,8 +369,8 @@ public Builder putAllExtraParam(Map map) { } /** - * Information about the person represented by the account. This field is null unless - * `business_type` is set to `individual`. + * Information about the person represented by the account. This field is null unless {@code + * business_type} is set to {@code individual}. */ public Builder setIndividual(Individual individual) { this.individual = individual; @@ -431,8 +436,9 @@ public Builder setSettings(Settings settings) { } /** - * Details on the account's acceptance of the [Stripe Services - * Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + * Details on the account's acceptance of the Stripe Services + * Agreement. */ public Builder setTosAcceptance(TosAcceptance tosAcceptance) { this.tosAcceptance = tosAcceptance; @@ -452,8 +458,9 @@ public static class BusinessProfile { Map extraParams; /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). - * MCCs are used to classify businesses based on the goods or services they provide. + * The merchant category code for the + * account. MCCs are used to classify businesses based on the goods or services they + * provide. */ @SerializedName("mcc") Object mcc; @@ -565,8 +572,9 @@ public Builder putAllExtraParam(Map map) { } /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). - * MCCs are used to classify businesses based on the goods or services they provide. + * The merchant category code for the + * account. MCCs are used to classify businesses based on the goods or services they + * provide. */ public Builder setMcc(String mcc) { this.mcc = mcc; @@ -574,8 +582,9 @@ public Builder setMcc(String mcc) { } /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). - * MCCs are used to classify businesses based on the goods or services they provide. + * The merchant category code for the + * account. MCCs are used to classify businesses based on the goods or services they + * provide. */ public Builder setMcc(EmptyParam mcc) { this.mcc = mcc; @@ -677,20 +686,19 @@ public static class Company { AddressKanji addressKanji; /** - * Whether the company's directors have been provided. Set this Boolean to `true` after creating - * all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for - * accounts with a `relationship.director` requirement. This value is not automatically set to - * `true` after creating directors, so it needs to be updated to indicate all directors have - * been provided. + * Whether the company's directors have been provided. Set this Boolean to {@code true} after + * creating all the company's directors with the + * Persons API for accounts with a {@code relationship.director} requirement. This value is + * not automatically set to {@code true} after creating directors, so it needs to be updated to + * indicate all directors have been provided. */ @SerializedName("directors_provided") Boolean directorsProvided; /** - * Whether the company's executives have been provided. Set this Boolean to `true` after - * creating all the company's executives with [the Persons - * API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` - * requirement. + * Whether the company's executives have been provided. Set this Boolean to {@code true} after + * creating all the company's executives with the + * Persons API for accounts with a {@code relationship.executive} requirement. */ @SerializedName("executives_provided") Boolean executivesProvided; @@ -717,9 +725,9 @@ public static class Company { Object nameKanji; /** - * Whether the company's owners have been provided. Set this Boolean to `true` after creating - * all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for - * accounts with a `relationship.owner` requirement. + * Whether the company's owners have been provided. Set this Boolean to {@code true} after + * creating all the company's owners with the + * Persons API for accounts with a {@code relationship.owner} requirement. */ @SerializedName("owners_provided") Boolean ownersProvided; @@ -740,7 +748,9 @@ public static class Company { @SerializedName("tax_id") Object taxId; - /** The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ + /** + * The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only). + */ @SerializedName("tax_id_registrar") Object taxIdRegistrar; @@ -864,11 +874,11 @@ public Builder setAddressKanji(AddressKanji addressKanji) { } /** - * Whether the company's directors have been provided. Set this Boolean to `true` after - * creating all the company's directors with [the Persons - * API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` - * requirement. This value is not automatically set to `true` after creating directors, so it - * needs to be updated to indicate all directors have been provided. + * Whether the company's directors have been provided. Set this Boolean to {@code true} after + * creating all the company's directors with the + * Persons API for accounts with a {@code relationship.director} requirement. This value + * is not automatically set to {@code true} after creating directors, so it needs to be + * updated to indicate all directors have been provided. */ public Builder setDirectorsProvided(Boolean directorsProvided) { this.directorsProvided = directorsProvided; @@ -876,10 +886,10 @@ public Builder setDirectorsProvided(Boolean directorsProvided) { } /** - * Whether the company's executives have been provided. Set this Boolean to `true` after - * creating all the company's executives with [the Persons - * API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` - * requirement. + * Whether the company's executives have been provided. Set this Boolean to {@code true} after + * creating all the company's executives with the Persons API for accounts with a {@code + * relationship.executive} requirement. */ public Builder setExecutivesProvided(Boolean executivesProvided) { this.executivesProvided = executivesProvided; @@ -949,9 +959,9 @@ public Builder setNameKanji(EmptyParam nameKanji) { } /** - * Whether the company's owners have been provided. Set this Boolean to `true` after creating - * all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for - * accounts with a `relationship.owner` requirement. + * Whether the company's owners have been provided. Set this Boolean to {@code true} after + * creating all the company's owners with the + * Persons API for accounts with a {@code relationship.owner} requirement. */ public Builder setOwnersProvided(Boolean ownersProvided) { this.ownersProvided = ownersProvided; @@ -1002,13 +1012,17 @@ public Builder setTaxId(EmptyParam taxId) { return this; } - /** The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ + /** + * The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only). + */ public Builder setTaxIdRegistrar(String taxIdRegistrar) { this.taxIdRegistrar = taxIdRegistrar; return this; } - /** The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ + /** + * The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only). + */ public Builder setTaxIdRegistrar(EmptyParam taxIdRegistrar) { this.taxIdRegistrar = taxIdRegistrar; return this; @@ -1040,8 +1054,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -1132,8 +1146,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1141,8 +1155,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -1234,8 +1248,8 @@ public static class AddressKana { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -1335,8 +1349,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1344,8 +1358,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -1449,8 +1463,8 @@ public static class AddressKanji { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -1550,8 +1564,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1559,8 +1573,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -1729,9 +1743,10 @@ public Builder putAllExtraParam(Map map) { @Getter public static class Document { /** - * The back of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. The uploaded file needs to be a color image (smaller than - * 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image + * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ @SerializedName("back") Object back; @@ -1747,9 +1762,10 @@ public static class Document { Map extraParams; /** - * The front of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. The uploaded file needs to be a color image (smaller than - * 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image + * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ @SerializedName("front") Object front; @@ -1777,9 +1793,10 @@ public Document build() { } /** - * The back of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. The uploaded file needs to be a color image (smaller than - * 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image + * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -1787,9 +1804,10 @@ public Builder setBack(String back) { } /** - * The back of a document returned by a [file upload](#create_file) with a `purpose` value - * of `additional_verification`. The uploaded file needs to be a color image (smaller than - * 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image + * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ public Builder setBack(EmptyParam back) { this.back = back; @@ -1825,8 +1843,9 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of a document returned by a [file upload](#create_file) with a `purpose` - * value of `additional_verification`. The uploaded file needs to be a color image + * The front of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ public Builder setFront(String front) { @@ -1835,8 +1854,9 @@ public Builder setFront(String front) { } /** - * The front of a document returned by a [file upload](#create_file) with a `purpose` - * value of `additional_verification`. The uploaded file needs to be a color image + * The front of a document returned by a file upload with a {@code purpose} + * value of {@code additional_verification}. The uploaded file needs to be a color image * (smaller than 8,000px by 8,000px), in JPG or PNG format, and less than 10 MB in size. */ public Builder setFront(EmptyParam front) { @@ -1933,15 +1953,19 @@ public static class Individual { @SerializedName("first_name_kanji") Object firstNameKanji; - /** The individual's gender (International regulations require either "male" or "female"). */ + /** + * The individual's gender (International regulations require either "male" or + * "female"). + */ @SerializedName("gender") Object gender; /** * The government-issued ID number of the individual, as appropriate for the representative’s * country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in - * Canada). Instead of the number itself, you can also provide a [PII token created with - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * Canada). Instead of the number itself, you can also provide a PII token created with + * Stripe.js. */ @SerializedName("id_number") Object idNumber; @@ -1965,8 +1989,8 @@ public static class Individual { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -2195,13 +2219,19 @@ public Builder setFirstNameKanji(EmptyParam firstNameKanji) { return this; } - /** The individual's gender (International regulations require either "male" or "female"). */ + /** + * The individual's gender (International regulations require either "male" or + * "female"). + */ public Builder setGender(String gender) { this.gender = gender; return this; } - /** The individual's gender (International regulations require either "male" or "female"). */ + /** + * The individual's gender (International regulations require either "male" or + * "female"). + */ public Builder setGender(EmptyParam gender) { this.gender = gender; return this; @@ -2210,8 +2240,9 @@ public Builder setGender(EmptyParam gender) { /** * The government-issued ID number of the individual, as appropriate for the representative’s * country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number - * in Canada). Instead of the number itself, you can also provide a [PII token created with - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * in Canada). Instead of the number itself, you can also provide a PII token created with + * Stripe.js. */ public Builder setIdNumber(String idNumber) { this.idNumber = idNumber; @@ -2221,8 +2252,9 @@ public Builder setIdNumber(String idNumber) { /** * The government-issued ID number of the individual, as appropriate for the representative’s * country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number - * in Canada). Instead of the number itself, you can also provide a [PII token created with - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * in Canada). Instead of the number itself, you can also provide a PII token created with + * Stripe.js. */ public Builder setIdNumber(EmptyParam idNumber) { this.idNumber = idNumber; @@ -2341,8 +2373,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -2433,8 +2465,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -2442,8 +2474,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -2535,8 +2567,8 @@ public static class AddressKana { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -2636,8 +2668,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -2645,8 +2677,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -2750,8 +2782,8 @@ public static class AddressKanji { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -2851,8 +2883,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -2860,8 +2892,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -3148,9 +3180,10 @@ public Builder putAllExtraParam(Map map) { @Getter public static class AdditionalDocument { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("back") Object back; @@ -3166,9 +3199,10 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("front") Object front; @@ -3196,9 +3230,10 @@ public AdditionalDocument build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -3206,9 +3241,10 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(EmptyParam back) { this.back = back; @@ -3246,9 +3282,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -3256,9 +3293,10 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(EmptyParam front) { this.front = front; @@ -3270,9 +3308,10 @@ public Builder setFront(EmptyParam front) { @Getter public static class Document { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("back") Object back; @@ -3288,9 +3327,10 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("front") Object front; @@ -3318,9 +3358,10 @@ public Document build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -3328,9 +3369,10 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(EmptyParam back) { this.back = back; @@ -3366,9 +3408,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -3376,9 +3419,10 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(EmptyParam front) { this.front = front; @@ -3519,16 +3563,16 @@ public static class Branding { Map extraParams; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the - * account. Must be square and at least 128px x 128px. + * (ID of a file upload) An icon for + * the account. Must be square and at least 128px x 128px. */ @SerializedName("icon") Object icon; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account - * that will be used in Checkout instead of the icon and without the account's name next to it - * if provided. Must be at least 128px x 128px. + * (ID of a file upload) A logo for + * the account that will be used in Checkout instead of the icon and without the account's + * name next to it if provided. Must be at least 128px x 128px. */ @SerializedName("logo") Object logo; @@ -3592,8 +3636,8 @@ public Builder putAllExtraParam(Map map) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the - * account. Must be square and at least 128px x 128px. + * (ID of a file upload) An icon + * for the account. Must be square and at least 128px x 128px. */ public Builder setIcon(String icon) { this.icon = icon; @@ -3601,8 +3645,8 @@ public Builder setIcon(String icon) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the - * account. Must be square and at least 128px x 128px. + * (ID of a file upload) An icon + * for the account. Must be square and at least 128px x 128px. */ public Builder setIcon(EmptyParam icon) { this.icon = icon; @@ -3610,9 +3654,9 @@ public Builder setIcon(EmptyParam icon) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the - * account that will be used in Checkout instead of the icon and without the account's name - * next to it if provided. Must be at least 128px x 128px. + * (ID of a file upload) A logo for + * the account that will be used in Checkout instead of the icon and without the account's + * name next to it if provided. Must be at least 128px x 128px. */ public Builder setLogo(String logo) { this.logo = logo; @@ -3620,9 +3664,9 @@ public Builder setLogo(String logo) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the - * account that will be used in Checkout instead of the icon and without the account's name - * next to it if provided. Must be at least 128px x 128px. + * (ID of a file upload) A logo for + * the account that will be used in Checkout instead of the icon and without the account's + * name next to it if provided. Must be at least 128px x 128px. */ public Builder setLogo(EmptyParam logo) { this.logo = logo; @@ -3663,8 +3707,8 @@ public static class CardPayments { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. - * `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic + * prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code + * statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic * portion. */ @SerializedName("statement_descriptor_prefix") @@ -3732,8 +3776,8 @@ public Builder putAllExtraParam(Map map) { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. - * `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic + * prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code + * statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic * portion. */ public Builder setStatementDescriptorPrefix(String statementDescriptorPrefix) { @@ -3743,8 +3787,8 @@ public Builder setStatementDescriptorPrefix(String statementDescriptorPrefix) { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. - * `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic + * prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code + * statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic * portion. */ public Builder setStatementDescriptorPrefix(EmptyParam statementDescriptorPrefix) { @@ -3865,7 +3909,7 @@ public static class Payments { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. + * prefixes any dynamic {@code statement_descriptor} specified on the charge. */ @SerializedName("statement_descriptor") Object statementDescriptor; @@ -3947,7 +3991,7 @@ public Builder putAllExtraParam(Map map) { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. + * prefixes any dynamic {@code statement_descriptor} specified on the charge. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -3956,7 +4000,7 @@ public Builder setStatementDescriptor(String statementDescriptor) { /** * The default text that appears on credit card statements when a charge is made. This field - * prefixes any dynamic `statement_descriptor` specified on the charge. + * prefixes any dynamic {@code statement_descriptor} specified on the charge. */ public Builder setStatementDescriptor(EmptyParam statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -4005,8 +4049,9 @@ public Builder setStatementDescriptorKanji(EmptyParam statementDescriptorKanji) public static class Payouts { /** * A Boolean indicating whether Stripe should try to reclaim negative balances from an - * attached bank account. For details, see [Understanding Connect Account - * Balances](https://stripe.com/docs/connect/account-balances). + * attached bank account. For details, see Understanding Connect Account + * Balances. */ @SerializedName("debit_negative_balances") Boolean debitNegativeBalances; @@ -4022,8 +4067,9 @@ public static class Payouts { /** * Details on when funds from charges are available, and when they are paid out to an external - * account. For details, see our [Setting Bank and Debit Card - * Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation. + * account. For details, see our Setting Bank and + * Debit Card Payouts documentation. */ @SerializedName("schedule") Schedule schedule; @@ -4070,8 +4116,9 @@ public Payouts build() { /** * A Boolean indicating whether Stripe should try to reclaim negative balances from an - * attached bank account. For details, see [Understanding Connect Account - * Balances](https://stripe.com/docs/connect/account-balances). + * attached bank account. For details, see Understanding Connect Account + * Balances. */ public Builder setDebitNegativeBalances(Boolean debitNegativeBalances) { this.debitNegativeBalances = debitNegativeBalances; @@ -4108,9 +4155,9 @@ public Builder putAllExtraParam(Map map) { /** * Details on when funds from charges are available, and when they are paid out to an - * external account. For details, see our [Setting Bank and Debit Card - * Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) - * documentation. + * external account. For details, see our Setting Bank and + * Debit Card Payouts documentation. */ public Builder setSchedule(Schedule schedule) { this.schedule = schedule; @@ -4139,9 +4186,10 @@ public Builder setStatementDescriptor(EmptyParam statementDescriptor) { @Getter public static class Schedule { /** - * The number of days charge funds are held before being paid out. May also be set to - * `minimum`, representing the lowest available value for the account country. Default is - * `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`. + * The number of days charge funds are held before being paid out. May also be set to {@code + * minimum}, representing the lowest available value for the account country. Default is + * {@code minimum}. The {@code delay_days} parameter does not apply when the {@code + * interval} is {@code manual}. */ @SerializedName("delay_days") Object delayDays; @@ -4157,8 +4205,8 @@ public static class Schedule { Map extraParams; /** - * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or - * `monthly`. Default is `daily`. + * How frequently available funds are paid out. One of: {@code daily}, {@code manual}, + * {@code weekly}, or {@code monthly}. Default is {@code daily}. */ @SerializedName("interval") Interval interval; @@ -4166,15 +4214,16 @@ public static class Schedule { /** * The day of the month when available funds are paid out, specified as a number between * 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead - * sent on the last day of a shorter month. Required and applicable only if `interval` is - * `monthly`. + * sent on the last day of a shorter month. Required and applicable only if {@code interval} + * is {@code monthly}. */ @SerializedName("monthly_anchor") Long monthlyAnchor; /** - * The day of the week when available funds are paid out, specified as `monday`, `tuesday`, - * etc. (required and applicable only if `interval` is `weekly`.) + * The day of the week when available funds are paid out, specified as {@code monday}, + * {@code tuesday}, etc. (required and applicable only if {@code interval} is {@code + * weekly}.) */ @SerializedName("weekly_anchor") WeeklyAnchor weeklyAnchor; @@ -4219,8 +4268,9 @@ public Schedule build() { /** * The number of days charge funds are held before being paid out. May also be set to - * `minimum`, representing the lowest available value for the account country. Default is - * `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`. + * {@code minimum}, representing the lowest available value for the account country. + * Default is {@code minimum}. The {@code delay_days} parameter does not apply when the + * {@code interval} is {@code manual}. */ public Builder setDelayDays(DelayDays delayDays) { this.delayDays = delayDays; @@ -4229,8 +4279,9 @@ public Builder setDelayDays(DelayDays delayDays) { /** * The number of days charge funds are held before being paid out. May also be set to - * `minimum`, representing the lowest available value for the account country. Default is - * `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`. + * {@code minimum}, representing the lowest available value for the account country. + * Default is {@code minimum}. The {@code delay_days} parameter does not apply when the + * {@code interval} is {@code manual}. */ public Builder setDelayDays(Long delayDays) { this.delayDays = delayDays; @@ -4266,8 +4317,8 @@ public Builder putAllExtraParam(Map map) { } /** - * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or - * `monthly`. Default is `daily`. + * How frequently available funds are paid out. One of: {@code daily}, {@code manual}, + * {@code weekly}, or {@code monthly}. Default is {@code daily}. */ public Builder setInterval(Interval interval) { this.interval = interval; @@ -4277,8 +4328,8 @@ public Builder setInterval(Interval interval) { /** * The day of the month when available funds are paid out, specified as a number between * 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead - * sent on the last day of a shorter month. Required and applicable only if `interval` is - * `monthly`. + * sent on the last day of a shorter month. Required and applicable only if {@code + * interval} is {@code monthly}. */ public Builder setMonthlyAnchor(Long monthlyAnchor) { this.monthlyAnchor = monthlyAnchor; @@ -4286,8 +4337,9 @@ public Builder setMonthlyAnchor(Long monthlyAnchor) { } /** - * The day of the week when available funds are paid out, specified as `monday`, - * `tuesday`, etc. (required and applicable only if `interval` is `weekly`.) + * The day of the week when available funds are paid out, specified as {@code monday}, + * {@code tuesday}, etc. (required and applicable only if {@code interval} is {@code + * weekly}.) */ public Builder setWeeklyAnchor(WeeklyAnchor weeklyAnchor) { this.weeklyAnchor = weeklyAnchor; diff --git a/src/main/java/com/stripe/param/ApplePayDomainListParams.java b/src/main/java/com/stripe/param/ApplePayDomainListParams.java index 4a7e523915b..8f2737fa91b 100644 --- a/src/main/java/com/stripe/param/ApplePayDomainListParams.java +++ b/src/main/java/com/stripe/param/ApplePayDomainListParams.java @@ -14,10 +14,10 @@ public class ApplePayDomainListParams extends ApiRequestParams { String domainName; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -43,10 +43,10 @@ public class ApplePayDomainListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -100,10 +100,10 @@ public Builder setDomainName(String domainName) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -172,10 +172,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/ApplicationFeeListParams.java b/src/main/java/com/stripe/param/ApplicationFeeListParams.java index 537a4d1f43a..1ddce1c7d80 100644 --- a/src/main/java/com/stripe/param/ApplicationFeeListParams.java +++ b/src/main/java/com/stripe/param/ApplicationFeeListParams.java @@ -18,10 +18,10 @@ public class ApplicationFeeListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -47,10 +47,10 @@ public class ApplicationFeeListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -120,10 +120,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -192,10 +192,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/BalanceTransactionListParams.java b/src/main/java/com/stripe/param/BalanceTransactionListParams.java index 92a41af7d0e..a14f6809a27 100644 --- a/src/main/java/com/stripe/param/BalanceTransactionListParams.java +++ b/src/main/java/com/stripe/param/BalanceTransactionListParams.java @@ -17,18 +17,18 @@ public class BalanceTransactionListParams extends ApiRequestParams { Object created; /** - * Only return transactions in a certain currency. Three-letter [ISO currency - * code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported - * currency](https://stripe.com/docs/currencies). + * Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. + * Must be a supported currency. */ @SerializedName("currency") String currency; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -65,18 +65,18 @@ public class BalanceTransactionListParams extends ApiRequestParams { String source; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, - * `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, - * `stripe_fee`, or `network_cost`. + * Only returns transactions of the given type. One of: {@code charge}, {@code refund}, {@code + * adjustment}, {@code application_fee}, {@code application_fee_refund}, {@code transfer}, {@code + * payment}, {@code payout}, {@code payout_failure}, {@code stripe_fee}, or {@code network_cost}. */ @SerializedName("type") String type; @@ -170,9 +170,9 @@ public Builder setCreated(Long created) { } /** - * Only return transactions in a certain currency. Three-letter [ISO currency - * code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported - * currency](https://stripe.com/docs/currencies). + * Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. + * Must be a supported currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -180,10 +180,10 @@ public Builder setCurrency(String currency) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -267,10 +267,10 @@ public Builder setSource(String source) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -278,9 +278,10 @@ public Builder setStartingAfter(String startingAfter) { } /** - * Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, - * `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, - * `payout_failure`, `stripe_fee`, or `network_cost`. + * Only returns transactions of the given type. One of: {@code charge}, {@code refund}, {@code + * adjustment}, {@code application_fee}, {@code application_fee_refund}, {@code transfer}, + * {@code payment}, {@code payout}, {@code payout_failure}, {@code stripe_fee}, or {@code + * network_cost}. */ public Builder setType(String type) { this.type = type; diff --git a/src/main/java/com/stripe/param/BankAccountVerifyParams.java b/src/main/java/com/stripe/param/BankAccountVerifyParams.java index 9d164c2a23d..22c96808b38 100644 --- a/src/main/java/com/stripe/param/BankAccountVerifyParams.java +++ b/src/main/java/com/stripe/param/BankAccountVerifyParams.java @@ -11,8 +11,8 @@ @Getter public class BankAccountVerifyParams extends ApiRequestParams { /** - * Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank - * account. + * Two positive integers, in cents, equal to the values of the microdeposits sent to the + * bank account. */ @SerializedName("amounts") List amounts; diff --git a/src/main/java/com/stripe/param/BitcoinReceiverListParams.java b/src/main/java/com/stripe/param/BitcoinReceiverListParams.java index b076c490d74..54a981563ab 100644 --- a/src/main/java/com/stripe/param/BitcoinReceiverListParams.java +++ b/src/main/java/com/stripe/param/BitcoinReceiverListParams.java @@ -15,10 +15,10 @@ public class BitcoinReceiverListParams extends ApiRequestParams { Boolean active; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -48,10 +48,10 @@ public class BitcoinReceiverListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -120,10 +120,10 @@ public Builder setActive(Boolean active) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -198,10 +198,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/BitcoinTransactionCollectionListParams.java b/src/main/java/com/stripe/param/BitcoinTransactionCollectionListParams.java index 773a5ed107e..a6a35b49181 100644 --- a/src/main/java/com/stripe/param/BitcoinTransactionCollectionListParams.java +++ b/src/main/java/com/stripe/param/BitcoinTransactionCollectionListParams.java @@ -15,10 +15,10 @@ public class BitcoinTransactionCollectionListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -44,10 +44,10 @@ public class BitcoinTransactionCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -102,10 +102,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -174,10 +174,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CapabilityUpdateParams.java b/src/main/java/com/stripe/param/CapabilityUpdateParams.java index 14e1e4b864c..0e9dbfe2636 100644 --- a/src/main/java/com/stripe/param/CapabilityUpdateParams.java +++ b/src/main/java/com/stripe/param/CapabilityUpdateParams.java @@ -26,7 +26,7 @@ public class CapabilityUpdateParams extends ApiRequestParams { /** * Passing true requests the capability for the account, if it is not already requested. A * requested capability may not immediately become active. Any requirements to activate the - * capability are returned in the `requirements` arrays. + * capability are returned in the {@code requirements} arrays. */ @SerializedName("requested") Boolean requested; @@ -109,7 +109,7 @@ public Builder putAllExtraParam(Map map) { /** * Passing true requests the capability for the account, if it is not already requested. A * requested capability may not immediately become active. Any requirements to activate the - * capability are returned in the `requirements` arrays. + * capability are returned in the {@code requirements} arrays. */ public Builder setRequested(Boolean requested) { this.requested = requested; diff --git a/src/main/java/com/stripe/param/ChargeCaptureParams.java b/src/main/java/com/stripe/param/ChargeCaptureParams.java index 82099357671..1edda678370 100644 --- a/src/main/java/com/stripe/param/ChargeCaptureParams.java +++ b/src/main/java/com/stripe/param/ChargeCaptureParams.java @@ -49,9 +49,9 @@ public class ChargeCaptureParams extends ApiRequestParams { String receiptEmail; /** - * For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value - * as the complete description of a charge on your customers’ statements. Must contain at least - * one letter, maximum 22 characters. + * For card charges, use {@code statement_descriptor_suffix} instead. Otherwise, you can use this + * value as the complete description of a charge on your customers’ statements. Must contain at + * least one letter, maximum 22 characters. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -66,17 +66,17 @@ public class ChargeCaptureParams extends ApiRequestParams { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. [See the Connect - * documentation](https://stripe.com/docs/connect/destination-charges) for details. + * destination charge. See the + * Connect documentation for details. */ @SerializedName("transfer_data") TransferData transferData; /** - * A string that identifies this transaction as part of a group. `transfer_group` may only be - * provided if it has not been set. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. {@code transfer_group} may only + * be provided if it has not been set. See the Connect + * documentation for details. */ @SerializedName("transfer_group") String transferGroup; @@ -231,9 +231,9 @@ public Builder setReceiptEmail(String receiptEmail) { } /** - * For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this - * value as the complete description of a charge on your customers’ statements. Must contain at - * least one letter, maximum 22 characters. + * For card charges, use {@code statement_descriptor_suffix} instead. Otherwise, you can use + * this value as the complete description of a charge on your customers’ statements. Must + * contain at least one letter, maximum 22 characters. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -253,8 +253,8 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. [See the Connect - * documentation](https://stripe.com/docs/connect/destination-charges) for details. + * destination charge. See the + * Connect documentation for details. */ public Builder setTransferData(TransferData transferData) { this.transferData = transferData; @@ -262,10 +262,10 @@ public Builder setTransferData(TransferData transferData) { } /** - * A string that identifies this transaction as part of a group. `transfer_group` may only be - * provided if it has not been set. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. {@code transfer_group} may only + * be provided if it has not been set. See the Connect + * documentation for details. */ public Builder setTransferGroup(String transferGroup) { this.transferGroup = transferGroup; diff --git a/src/main/java/com/stripe/param/ChargeCreateParams.java b/src/main/java/com/stripe/param/ChargeCreateParams.java index ddcecec15fb..2336225a88a 100644 --- a/src/main/java/com/stripe/param/ChargeCreateParams.java +++ b/src/main/java/com/stripe/param/ChargeCreateParams.java @@ -12,11 +12,12 @@ public class ChargeCreateParams extends ApiRequestParams { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how much - * to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) - * (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum - * amount is $0.50 US or [equivalent in charge - * currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount - * value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). + * to charge in the smallest currency + * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The + * minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ @SerializedName("amount") Long amount; @@ -26,25 +27,27 @@ public class ChargeCreateParams extends ApiRequestParams { /** * A fee in %s that will be applied to the charge and transferred to the application owner's - * Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in - * order to take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). + * Stripe account. The request must be made with an OAuth key or the {@code Stripe-Account} header + * in order to take an application fee. For more information, see the application fees documentation. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; /** - * Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues - * an authorization (or pre-authorization), and will need to be [captured](#capture_charge) later. - * Uncaptured charges expire in _seven days_. For more information, see the [authorizing charges - * and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. + * Whether to immediately capture the charge. Defaults to {@code true}. When {@code false}, the + * charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire + * in seven days. For more information, see the authorizing charges and settling + * later documentation. */ @SerializedName("capture") Boolean capture; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -54,10 +57,10 @@ public class ChargeCreateParams extends ApiRequestParams { String customer; /** - * An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web - * interface alongside the charge. Note that if you use Stripe to send automatic email receipts to - * your customers, your receipt emails will include the `description` of the charge(s) that they - * are describing. + * An arbitrary string which you can attach to a {@code Charge} object. It is displayed when in + * the web interface alongside the charge. Note that if you use Stripe to send automatic email + * receipts to your customers, your receipt emails will include the {@code description} of the + * charge(s) that they are describing. */ @SerializedName("description") String description; @@ -81,27 +84,29 @@ public class ChargeCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** * The Stripe account ID for which these funds are intended. Automatically set if you use the - * `destination` parameter. For details, see [Creating Separate Charges and - * Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). + * {@code destination} parameter. For details, see Creating Separate Charges + * and Transfers. */ @SerializedName("on_behalf_of") String onBehalfOf; /** - * The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) - * will be sent. The receipt will not be sent until the charge is paid, and no receipts will be - * sent for test mode charges. If this charge is for a - * [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will - * override the customer's email address. If `receipt_email` is specified for a charge in live - * mode, a receipt will be sent regardless of your [email - * settings](https://dashboard.stripe.com/account/emails). + * The email address to which this charge's receipt will be sent. The receipt will + * not be sent until the charge is paid, and no receipts will be sent for test mode charges. If + * this charge is for a Customer, the + * email address specified here will override the customer's email address. If {@code + * receipt_email} is specified for a charge in live mode, a receipt will be sent regardless of + * your email settings. */ @SerializedName("receipt_email") String receiptEmail; @@ -111,24 +116,25 @@ public class ChargeCreateParams extends ApiRequestParams { Shipping shipping; /** - * A payment source to be charged. This can be the ID of a - * [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank - * account](https://stripe.com/docs/api#bank_accounts), a - * [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), - * or a [connected - * account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For - * certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank - * accounts](https://stripe.com/docs/api#bank_accounts), and attached - * [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated - * customer. + * A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected + * account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the + * associated customer. */ @SerializedName("source") String source; /** - * For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value - * as the complete description of a charge on your customers’ statements. Must contain at least - * one letter, maximum 22 characters. + * For card charges, use {@code statement_descriptor_suffix} instead. Otherwise, you can use this + * value as the complete description of a charge on your customers’ statements. Must contain at + * least one letter, maximum 22 characters. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -143,15 +149,16 @@ public class ChargeCreateParams extends ApiRequestParams { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. [See the Connect - * documentation](https://stripe.com/docs/connect/destination-charges) for details. + * destination charge. See the + * Connect documentation for details. */ @SerializedName("transfer_data") TransferData transferData; /** - * A string that identifies this transaction as part of a group. For details, see [Grouping - * transactions](https://stripe.com/docs/connect/charges-transfers#grouping-transactions). + * A string that identifies this transaction as part of a group. For details, see Grouping + * transactions. */ @SerializedName("transfer_group") String transferGroup; @@ -266,12 +273,12 @@ public ChargeCreateParams build() { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how - * much to charge in the [smallest currency - * unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or - * 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent - * in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). - * The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of - * $999,999.99). + * much to charge in the smallest + * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal + * currency). The minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ public Builder setAmount(Long amount) { this.amount = amount; @@ -285,9 +292,9 @@ public Builder setApplicationFee(Long applicationFee) { /** * A fee in %s that will be applied to the charge and transferred to the application owner's - * Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in - * order to take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). + * Stripe account. The request must be made with an OAuth key or the {@code Stripe-Account} + * header in order to take an application fee. For more information, see the application fees documentation. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -295,11 +302,12 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { } /** - * Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge - * issues an authorization (or pre-authorization), and will need to be - * [captured](#capture_charge) later. Uncaptured charges expire in _seven days_. For more - * information, see the [authorizing charges and settling - * later](https://stripe.com/docs/charges/placing-a-hold) documentation. + * Whether to immediately capture the charge. Defaults to {@code true}. When {@code false}, the + * charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges + * expire in seven days. For more information, see the authorizing charges and settling + * later documentation. */ public Builder setCapture(Boolean capture) { this.capture = capture; @@ -307,8 +315,9 @@ public Builder setCapture(Boolean capture) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -322,9 +331,9 @@ public Builder setCustomer(String customer) { } /** - * An arbitrary string which you can attach to a `Charge` object. It is displayed when in the - * web interface alongside the charge. Note that if you use Stripe to send automatic email - * receipts to your customers, your receipt emails will include the `description` of the + * An arbitrary string which you can attach to a {@code Charge} object. It is displayed when in + * the web interface alongside the charge. Note that if you use Stripe to send automatic email + * receipts to your customers, your receipt emails will include the {@code description} of the * charge(s) that they are describing. */ public Builder setDescription(String description) { @@ -417,8 +426,9 @@ public Builder putAllMetadata(Map map) { /** * The Stripe account ID for which these funds are intended. Automatically set if you use the - * `destination` parameter. For details, see [Creating Separate Charges and - * Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). + * {@code destination} parameter. For details, see Creating Separate + * Charges and Transfers. */ public Builder setOnBehalfOf(String onBehalfOf) { this.onBehalfOf = onBehalfOf; @@ -426,13 +436,13 @@ public Builder setOnBehalfOf(String onBehalfOf) { } /** - * The email address to which this charge's - * [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be - * sent until the charge is paid, and no receipts will be sent for test mode charges. If this - * charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address - * specified here will override the customer's email address. If `receipt_email` is specified - * for a charge in live mode, a receipt will be sent regardless of your [email - * settings](https://dashboard.stripe.com/account/emails). + * The email address to which this charge's receipt will be sent. The receipt will + * not be sent until the charge is paid, and no receipts will be sent for test mode charges. If + * this charge is for a Customer, the + * email address specified here will override the customer's email address. If {@code + * receipt_email} is specified for a charge in live mode, a receipt will be sent regardless of + * your email settings. */ public Builder setReceiptEmail(String receiptEmail) { this.receiptEmail = receiptEmail; @@ -446,16 +456,17 @@ public Builder setShipping(Shipping shipping) { } /** - * A payment source to be charged. This can be the ID of a - * [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank - * account](https://stripe.com/docs/api#bank_accounts), a - * [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), - * or a [connected - * account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For - * certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank - * accounts](https://stripe.com/docs/api#bank_accounts), and attached - * [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated - * customer. + * A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected + * account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the + * associated customer. */ public Builder setSource(String source) { this.source = source; @@ -463,9 +474,9 @@ public Builder setSource(String source) { } /** - * For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this - * value as the complete description of a charge on your customers’ statements. Must contain at - * least one letter, maximum 22 characters. + * For card charges, use {@code statement_descriptor_suffix} instead. Otherwise, you can use + * this value as the complete description of a charge on your customers’ statements. Must + * contain at least one letter, maximum 22 characters. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -485,8 +496,8 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. [See the Connect - * documentation](https://stripe.com/docs/connect/destination-charges) for details. + * destination charge. See the + * Connect documentation for details. */ public Builder setTransferData(TransferData transferData) { this.transferData = transferData; @@ -494,8 +505,9 @@ public Builder setTransferData(TransferData transferData) { } /** - * A string that identifies this transaction as part of a group. For details, see [Grouping - * transactions](https://stripe.com/docs/connect/charges-transfers#grouping-transactions). + * A string that identifies this transaction as part of a group. For details, see Grouping + * transactions. */ public Builder setTransferGroup(String transferGroup) { this.transferGroup = transferGroup; @@ -510,9 +522,9 @@ public static class Destination { String account; /** - * The amount to transfer to the destination account without creating an `Application Fee` - * object. Cannot be combined with the `application_fee` parameter. Must be less than or equal - * to the charge amount. + * The amount to transfer to the destination account without creating an {@code Application Fee} + * object. Cannot be combined with the {@code application_fee} parameter. Must be less than or + * equal to the charge amount. */ @SerializedName("amount") Long amount; @@ -555,9 +567,9 @@ public Builder setAccount(String account) { } /** - * The amount to transfer to the destination account without creating an `Application Fee` - * object. Cannot be combined with the `application_fee` parameter. Must be less than or equal - * to the charge amount. + * The amount to transfer to the destination account without creating an {@code Application + * Fee} object. Cannot be combined with the {@code application_fee} parameter. Must be less + * than or equal to the charge amount. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -736,8 +748,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -822,8 +834,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; diff --git a/src/main/java/com/stripe/param/ChargeListParams.java b/src/main/java/com/stripe/param/ChargeListParams.java index 50aa10da66c..50aa6282ff6 100644 --- a/src/main/java/com/stripe/param/ChargeListParams.java +++ b/src/main/java/com/stripe/param/ChargeListParams.java @@ -18,10 +18,10 @@ public class ChargeListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -53,10 +53,10 @@ public class ChargeListParams extends ApiRequestParams { String paymentIntent; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -140,10 +140,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -221,10 +221,10 @@ public Builder setPaymentIntent(String paymentIntent) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/ChargeUpdateParams.java b/src/main/java/com/stripe/param/ChargeUpdateParams.java index 5c7dbdda25f..f0b7bc899e0 100644 --- a/src/main/java/com/stripe/param/ChargeUpdateParams.java +++ b/src/main/java/com/stripe/param/ChargeUpdateParams.java @@ -22,8 +22,8 @@ public class ChargeUpdateParams extends ApiRequestParams { /** * An arbitrary string which you can attach to a charge object. It is displayed when in the web * interface alongside the charge. Note that if you use Stripe to send automatic email receipts to - * your customers, your receipt emails will include the `description` of the charge(s) that they - * are describing. + * your customers, your receipt emails will include the {@code description} of the charge(s) that + * they are describing. */ @SerializedName("description") Object description; @@ -43,9 +43,10 @@ public class ChargeUpdateParams extends ApiRequestParams { /** * A set of key-value pairs you can attach to a charge giving information about its riskiness. If - * you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. - * If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe - * will use the information you send to improve our fraud detection algorithms. + * you believe a charge is fraudulent, include a {@code user_report} key with a value of {@code + * fraudulent}. If you believe a charge is safe, include a {@code user_report} key with a value of + * {@code safe}. Stripe will use the information you send to improve our fraud detection + * algorithms. */ @SerializedName("fraud_details") FraudDetails fraudDetails; @@ -53,7 +54,8 @@ public class ChargeUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -70,10 +72,10 @@ public class ChargeUpdateParams extends ApiRequestParams { Shipping shipping; /** - * A string that identifies this transaction as part of a group. `transfer_group` may only be - * provided if it has not been set. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. {@code transfer_group} may only + * be provided if it has not been set. See the Connect + * documentation for details. */ @SerializedName("transfer_group") Object transferGroup; @@ -157,8 +159,8 @@ public Builder setCustomer(EmptyParam customer) { /** * An arbitrary string which you can attach to a charge object. It is displayed when in the web * interface alongside the charge. Note that if you use Stripe to send automatic email receipts - * to your customers, your receipt emails will include the `description` of the charge(s) that - * they are describing. + * to your customers, your receipt emails will include the {@code description} of the charge(s) + * that they are describing. */ public Builder setDescription(String description) { this.description = description; @@ -168,8 +170,8 @@ public Builder setDescription(String description) { /** * An arbitrary string which you can attach to a charge object. It is displayed when in the web * interface alongside the charge. Note that if you use Stripe to send automatic email receipts - * to your customers, your receipt emails will include the `description` of the charge(s) that - * they are describing. + * to your customers, your receipt emails will include the {@code description} of the charge(s) + * that they are describing. */ public Builder setDescription(EmptyParam description) { this.description = description; @@ -230,9 +232,10 @@ public Builder putAllExtraParam(Map map) { /** * A set of key-value pairs you can attach to a charge giving information about its riskiness. - * If you believe a charge is fraudulent, include a `user_report` key with a value of - * `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of - * `safe`. Stripe will use the information you send to improve our fraud detection algorithms. + * If you believe a charge is fraudulent, include a {@code user_report} key with a value of + * {@code fraudulent}. If you believe a charge is safe, include a {@code user_report} key with a + * value of {@code safe}. Stripe will use the information you send to improve our fraud + * detection algorithms. */ public Builder setFraudDetails(FraudDetails fraudDetails) { this.fraudDetails = fraudDetails; @@ -290,10 +293,10 @@ public Builder setShipping(Shipping shipping) { } /** - * A string that identifies this transaction as part of a group. `transfer_group` may only be - * provided if it has not been set. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. {@code transfer_group} may only + * be provided if it has not been set. See the Connect + * documentation for details. */ public Builder setTransferGroup(String transferGroup) { this.transferGroup = transferGroup; @@ -301,10 +304,10 @@ public Builder setTransferGroup(String transferGroup) { } /** - * A string that identifies this transaction as part of a group. `transfer_group` may only be - * provided if it has not been set. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. {@code transfer_group} may only + * be provided if it has not been set. See the Connect + * documentation for details. */ public Builder setTransferGroup(EmptyParam transferGroup) { this.transferGroup = transferGroup; @@ -323,7 +326,7 @@ public static class FraudDetails { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Either `safe` or `fraudulent`. */ + /** Either {@code safe} or {@code fraudulent}. */ @SerializedName("user_report") EnumParam userReport; @@ -372,13 +375,13 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Either `safe` or `fraudulent`. */ + /** Either {@code safe} or {@code fraudulent}. */ public Builder setUserReport(UserReport userReport) { this.userReport = userReport; return this; } - /** Either `safe` or `fraudulent`. */ + /** Either {@code safe} or {@code fraudulent}. */ public Builder setUserReport(EmptyParam userReport) { this.userReport = userReport; return this; @@ -572,8 +575,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -664,8 +667,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -673,8 +676,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; diff --git a/src/main/java/com/stripe/param/CountrySpecListParams.java b/src/main/java/com/stripe/param/CountrySpecListParams.java index addbc904427..775842f4dad 100644 --- a/src/main/java/com/stripe/param/CountrySpecListParams.java +++ b/src/main/java/com/stripe/param/CountrySpecListParams.java @@ -11,10 +11,10 @@ @Getter public class CountrySpecListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class CountrySpecListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public CountrySpecListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CouponCreateParams.java b/src/main/java/com/stripe/param/CouponCreateParams.java index 7b9165e2ced..bc7c82916f7 100644 --- a/src/main/java/com/stripe/param/CouponCreateParams.java +++ b/src/main/java/com/stripe/param/CouponCreateParams.java @@ -13,27 +13,28 @@ public class CouponCreateParams extends ApiRequestParams { /** * A positive integer representing the amount to subtract from an invoice total (required if - * `percent_off` is not passed). + * {@code percent_off} is not passed). */ @SerializedName("amount_off") Long amountOff; /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the - * `amount_off` parameter (required if `amount_off` is passed). + * Three-letter ISO code for the currency of the + * {@code amount_off} parameter (required if {@code amount_off} is passed). */ @SerializedName("currency") String currency; /** - * Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`. + * Specifies how long the discount will be in effect. Can be {@code forever}, {@code once}, or + * {@code repeating}. */ @SerializedName("duration") Duration duration; /** - * Required only if `duration` is `repeating`, in which case it must be a positive integer that - * specifies the number of months the discount will be in effect. + * Required only if {@code duration} is {@code repeating}, in which case it must be a positive + * integer that specifies the number of months the discount will be in effect. */ @SerializedName("duration_in_months") Long durationInMonths; @@ -54,8 +55,8 @@ public class CouponCreateParams extends ApiRequestParams { /** * Unique string of your choice that will be used to identify this coupon when applying it to a * customer. This is often a specific code you'll give to your customer to use when signing up - * (e.g., `FALL25OFF`). If you don't want to specify a particular code, you can leave the ID blank - * and we'll generate a random code for you. + * (e.g., {@code FALL25OFF}). If you don't want to specify a particular code, you can leave the ID + * blank and we'll generate a random code for you. */ @SerializedName("id") String id; @@ -71,21 +72,22 @@ public class CouponCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default - * the `id` is shown if `name` is not set. + * the {@code id} is shown if {@code name} is not set. */ @SerializedName("name") String name; /** * A positive float larger than 0, and smaller or equal to 100, that represents the discount the - * coupon will apply (required if `amount_off` is not passed). + * coupon will apply (required if {@code amount_off} is not passed). */ @SerializedName("percent_off") BigDecimal percentOff; @@ -172,7 +174,7 @@ public CouponCreateParams build() { /** * A positive integer representing the amount to subtract from an invoice total (required if - * `percent_off` is not passed). + * {@code percent_off} is not passed). */ public Builder setAmountOff(Long amountOff) { this.amountOff = amountOff; @@ -180,8 +182,8 @@ public Builder setAmountOff(Long amountOff) { } /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the - * `amount_off` parameter (required if `amount_off` is passed). + * Three-letter ISO code for the currency of + * the {@code amount_off} parameter (required if {@code amount_off} is passed). */ public Builder setCurrency(String currency) { this.currency = currency; @@ -189,7 +191,8 @@ public Builder setCurrency(String currency) { } /** - * Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`. + * Specifies how long the discount will be in effect. Can be {@code forever}, {@code once}, or + * {@code repeating}. */ public Builder setDuration(Duration duration) { this.duration = duration; @@ -197,8 +200,8 @@ public Builder setDuration(Duration duration) { } /** - * Required only if `duration` is `repeating`, in which case it must be a positive integer that - * specifies the number of months the discount will be in effect. + * Required only if {@code duration} is {@code repeating}, in which case it must be a positive + * integer that specifies the number of months the discount will be in effect. */ public Builder setDurationInMonths(Long durationInMonths) { this.durationInMonths = durationInMonths; @@ -260,8 +263,8 @@ public Builder putAllExtraParam(Map map) { /** * Unique string of your choice that will be used to identify this coupon when applying it to a * customer. This is often a specific code you'll give to your customer to use when signing up - * (e.g., `FALL25OFF`). If you don't want to specify a particular code, you can leave the ID - * blank and we'll generate a random code for you. + * (e.g., {@code FALL25OFF}). If you don't want to specify a particular code, you can leave the + * ID blank and we'll generate a random code for you. */ public Builder setId(String id) { this.id = id; @@ -306,7 +309,7 @@ public Builder putAllMetadata(Map map) { /** * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default - * the `id` is shown if `name` is not set. + * the {@code id} is shown if {@code name} is not set. */ public Builder setName(String name) { this.name = name; @@ -315,7 +318,7 @@ public Builder setName(String name) { /** * A positive float larger than 0, and smaller or equal to 100, that represents the discount the - * coupon will apply (required if `amount_off` is not passed). + * coupon will apply (required if {@code amount_off} is not passed). */ public Builder setPercentOff(BigDecimal percentOff) { this.percentOff = percentOff; diff --git a/src/main/java/com/stripe/param/CouponListParams.java b/src/main/java/com/stripe/param/CouponListParams.java index eb526393cb5..c06e1ec7db3 100644 --- a/src/main/java/com/stripe/param/CouponListParams.java +++ b/src/main/java/com/stripe/param/CouponListParams.java @@ -11,17 +11,17 @@ @Getter public class CouponListParams extends ApiRequestParams { /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string with + * an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ @SerializedName("created") Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -47,10 +47,10 @@ public class CouponListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -99,8 +99,9 @@ public CouponListParams build() { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Created created) { this.created = created; @@ -108,8 +109,9 @@ public Builder setCreated(Created created) { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Long created) { this.created = created; @@ -117,10 +119,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -189,10 +191,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CouponUpdateParams.java b/src/main/java/com/stripe/param/CouponUpdateParams.java index b65301b6c31..ecf302641df 100644 --- a/src/main/java/com/stripe/param/CouponUpdateParams.java +++ b/src/main/java/com/stripe/param/CouponUpdateParams.java @@ -27,14 +27,15 @@ public class CouponUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default - * the `id` is shown if `name` is not set. + * the {@code id} is shown if {@code name} is not set. */ @SerializedName("name") Object name; @@ -148,7 +149,7 @@ public Builder putAllMetadata(Map map) { /** * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default - * the `id` is shown if `name` is not set. + * the {@code id} is shown if {@code name} is not set. */ public Builder setName(String name) { this.name = name; @@ -157,7 +158,7 @@ public Builder setName(String name) { /** * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default - * the `id` is shown if `name` is not set. + * the {@code id} is shown if {@code name} is not set. */ public Builder setName(EmptyParam name) { this.name = name; diff --git a/src/main/java/com/stripe/param/CreditNoteCreateParams.java b/src/main/java/com/stripe/param/CreditNoteCreateParams.java index 915ce02e2b8..344e15fc8f9 100644 --- a/src/main/java/com/stripe/param/CreditNoteCreateParams.java +++ b/src/main/java/com/stripe/param/CreditNoteCreateParams.java @@ -12,13 +12,13 @@ @Getter public class CreditNoteCreateParams extends ApiRequestParams { - /** The integer amount in **%s** representing the total amount of the credit note. */ + /** The integer amount in %s representing the total amount of the credit note. */ @SerializedName("amount") Long amount; /** - * The integer amount in **%s** representing the amount to credit the customer's balance, which - * will be automatically applied to their next invoice. + * The integer amount in %s representing the amount to credit the customer's + * balance, which will be automatically applied to their next invoice. */ @SerializedName("credit_amount") Long creditAmount; @@ -51,18 +51,22 @@ public class CreditNoteCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; - /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ + /** + * The integer amount in %s representing the amount that is credited outside of + * Stripe. + */ @SerializedName("out_of_band_amount") Long outOfBandAmount; /** - * Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or - * `product_unsatisfactory`. + * Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code + * order_change}, or {@code product_unsatisfactory}. */ @SerializedName("reason") Reason reason; @@ -72,8 +76,8 @@ public class CreditNoteCreateParams extends ApiRequestParams { String refund; /** - * The integer amount in **%s** representing the amount to refund. If set, a refund will be - * created for the charge associated with the invoice. + * The integer amount in %s representing the amount to refund. If set, a refund + * will be created for the charge associated with the invoice. */ @SerializedName("refund_amount") Long refundAmount; @@ -151,15 +155,17 @@ public CreditNoteCreateParams build() { this.refundAmount); } - /** The integer amount in **%s** representing the total amount of the credit note. */ + /** + * The integer amount in %s representing the total amount of the credit note. + */ public Builder setAmount(Long amount) { this.amount = amount; return this; } /** - * The integer amount in **%s** representing the amount to credit the customer's balance, which - * will be automatically applied to their next invoice. + * The integer amount in %s representing the amount to credit the customer's + * balance, which will be automatically applied to their next invoice. */ public Builder setCreditAmount(Long creditAmount) { this.creditAmount = creditAmount; @@ -282,15 +288,18 @@ public Builder putAllMetadata(Map map) { return this; } - /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ + /** + * The integer amount in %s representing the amount that is credited outside of + * Stripe. + */ public Builder setOutOfBandAmount(Long outOfBandAmount) { this.outOfBandAmount = outOfBandAmount; return this; } /** - * Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or - * `product_unsatisfactory`. + * Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code + * order_change}, or {@code product_unsatisfactory}. */ public Builder setReason(Reason reason) { this.reason = reason; @@ -304,8 +313,8 @@ public Builder setRefund(String refund) { } /** - * The integer amount in **%s** representing the amount to refund. If set, a refund will be - * created for the charge associated with the invoice. + * The integer amount in %s representing the amount to refund. If set, a refund + * will be created for the charge associated with the invoice. */ public Builder setRefundAmount(Long refundAmount) { this.refundAmount = refundAmount; @@ -316,15 +325,15 @@ public Builder setRefundAmount(Long refundAmount) { @Getter public static class Line { /** - * The line item amount to credit. Only valid when `type` is `invoice_line_item` and the - * referenced invoice line item does not have a quantity, only an amount. + * The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item} and + * the referenced invoice line item does not have a quantity, only an amount. */ @SerializedName("amount") Long amount; /** - * The description of the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The description of the credit note line item. Only valid when the {@code type} is {@code + * custom_line_item}. */ @SerializedName("description") String description; @@ -338,7 +347,10 @@ public static class Line { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. */ + /** + * The invoice line item to credit. Only valid when the {@code type} is {@code + * invoice_line_item}. + */ @SerializedName("invoice_line_item") String invoiceLineItem; @@ -347,27 +359,30 @@ public static class Line { Long quantity; /** - * The tax rates which apply to the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The tax rates which apply to the credit note line item. Only valid when the {@code type} is + * {@code custom_line_item}. */ @SerializedName("tax_rates") Object taxRates; - /** Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. */ + /** + * Type of the credit note line item, one of {@code invoice_line_item} or {@code + * custom_line_item}. + */ @SerializedName("type") Type type; /** - * The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be - * multiplied by the quantity to get the full amount to credit for this line item. Only valid - * when `type` is `custom_line_item`. + * The integer unit amount in %s of the credit note line item. This {@code + * unit_amount} will be multiplied by the quantity to get the full amount to credit for this + * line item. Only valid when {@code type} is {@code custom_line_item}. */ @SerializedName("unit_amount") Long unitAmount; /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ @SerializedName("unit_amount_decimal") BigDecimal unitAmountDecimal; @@ -431,8 +446,8 @@ public Line build() { } /** - * The line item amount to credit. Only valid when `type` is `invoice_line_item` and the - * referenced invoice line item does not have a quantity, only an amount. + * The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item} + * and the referenced invoice line item does not have a quantity, only an amount. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -440,8 +455,8 @@ public Builder setAmount(Long amount) { } /** - * The description of the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The description of the credit note line item. Only valid when the {@code type} is {@code + * custom_line_item}. */ public Builder setDescription(String description) { this.description = description; @@ -474,7 +489,10 @@ public Builder putAllExtraParam(Map map) { return this; } - /** The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. */ + /** + * The invoice line item to credit. Only valid when the {@code type} is {@code + * invoice_line_item}. + */ public Builder setInvoiceLineItem(String invoiceLineItem) { this.invoiceLineItem = invoiceLineItem; return this; @@ -515,8 +533,8 @@ public Builder addAllTaxRate(List elements) { } /** - * The tax rates which apply to the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The tax rates which apply to the credit note line item. Only valid when the {@code type} is + * {@code custom_line_item}. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -524,24 +542,27 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * The tax rates which apply to the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The tax rates which apply to the credit note line item. Only valid when the {@code type} is + * {@code custom_line_item}. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; return this; } - /** Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. */ + /** + * Type of the credit note line item, one of {@code invoice_line_item} or {@code + * custom_line_item}. + */ public Builder setType(Type type) { this.type = type; return this; } /** - * The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be - * multiplied by the quantity to get the full amount to credit for this line item. Only valid - * when `type` is `custom_line_item`. + * The integer unit amount in %s of the credit note line item. This {@code + * unit_amount} will be multiplied by the quantity to get the full amount to credit for this + * line item. Only valid when {@code type} is {@code custom_line_item}. */ public Builder setUnitAmount(Long unitAmount) { this.unitAmount = unitAmount; @@ -549,8 +570,8 @@ public Builder setUnitAmount(Long unitAmount) { } /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. + * Only one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { this.unitAmountDecimal = unitAmountDecimal; diff --git a/src/main/java/com/stripe/param/CreditNoteLineItemCollectionListParams.java b/src/main/java/com/stripe/param/CreditNoteLineItemCollectionListParams.java index 703ec86e2ee..5769eda2a2a 100644 --- a/src/main/java/com/stripe/param/CreditNoteLineItemCollectionListParams.java +++ b/src/main/java/com/stripe/param/CreditNoteLineItemCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class CreditNoteLineItemCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class CreditNoteLineItemCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public CreditNoteLineItemCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CreditNoteListParams.java b/src/main/java/com/stripe/param/CreditNoteListParams.java index 75e7a489b25..3ad54f70029 100644 --- a/src/main/java/com/stripe/param/CreditNoteListParams.java +++ b/src/main/java/com/stripe/param/CreditNoteListParams.java @@ -15,10 +15,10 @@ public class CreditNoteListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -48,10 +48,10 @@ public class CreditNoteListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -111,10 +111,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -189,10 +189,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CreditNotePreviewParams.java b/src/main/java/com/stripe/param/CreditNotePreviewParams.java index 4f0e557a790..9b1773ba760 100644 --- a/src/main/java/com/stripe/param/CreditNotePreviewParams.java +++ b/src/main/java/com/stripe/param/CreditNotePreviewParams.java @@ -12,13 +12,13 @@ @Getter public class CreditNotePreviewParams extends ApiRequestParams { - /** The integer amount in **%s** representing the total amount of the credit note. */ + /** The integer amount in %s representing the total amount of the credit note. */ @SerializedName("amount") Long amount; /** - * The integer amount in **%s** representing the amount to credit the customer's balance, which - * will be automatically applied to their next invoice. + * The integer amount in %s representing the amount to credit the customer's + * balance, which will be automatically applied to their next invoice. */ @SerializedName("credit_amount") Long creditAmount; @@ -51,18 +51,22 @@ public class CreditNotePreviewParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; - /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ + /** + * The integer amount in %s representing the amount that is credited outside of + * Stripe. + */ @SerializedName("out_of_band_amount") Long outOfBandAmount; /** - * Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or - * `product_unsatisfactory`. + * Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code + * order_change}, or {@code product_unsatisfactory}. */ @SerializedName("reason") Reason reason; @@ -72,8 +76,8 @@ public class CreditNotePreviewParams extends ApiRequestParams { String refund; /** - * The integer amount in **%s** representing the amount to refund. If set, a refund will be - * created for the charge associated with the invoice. + * The integer amount in %s representing the amount to refund. If set, a refund + * will be created for the charge associated with the invoice. */ @SerializedName("refund_amount") Long refundAmount; @@ -151,15 +155,17 @@ public CreditNotePreviewParams build() { this.refundAmount); } - /** The integer amount in **%s** representing the total amount of the credit note. */ + /** + * The integer amount in %s representing the total amount of the credit note. + */ public Builder setAmount(Long amount) { this.amount = amount; return this; } /** - * The integer amount in **%s** representing the amount to credit the customer's balance, which - * will be automatically applied to their next invoice. + * The integer amount in %s representing the amount to credit the customer's + * balance, which will be automatically applied to their next invoice. */ public Builder setCreditAmount(Long creditAmount) { this.creditAmount = creditAmount; @@ -282,15 +288,18 @@ public Builder putAllMetadata(Map map) { return this; } - /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ + /** + * The integer amount in %s representing the amount that is credited outside of + * Stripe. + */ public Builder setOutOfBandAmount(Long outOfBandAmount) { this.outOfBandAmount = outOfBandAmount; return this; } /** - * Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or - * `product_unsatisfactory`. + * Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code + * order_change}, or {@code product_unsatisfactory}. */ public Builder setReason(Reason reason) { this.reason = reason; @@ -304,8 +313,8 @@ public Builder setRefund(String refund) { } /** - * The integer amount in **%s** representing the amount to refund. If set, a refund will be - * created for the charge associated with the invoice. + * The integer amount in %s representing the amount to refund. If set, a refund + * will be created for the charge associated with the invoice. */ public Builder setRefundAmount(Long refundAmount) { this.refundAmount = refundAmount; @@ -316,15 +325,15 @@ public Builder setRefundAmount(Long refundAmount) { @Getter public static class Line { /** - * The line item amount to credit. Only valid when `type` is `invoice_line_item` and the - * referenced invoice line item does not have a quantity, only an amount. + * The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item} and + * the referenced invoice line item does not have a quantity, only an amount. */ @SerializedName("amount") Long amount; /** - * The description of the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The description of the credit note line item. Only valid when the {@code type} is {@code + * custom_line_item}. */ @SerializedName("description") String description; @@ -338,7 +347,10 @@ public static class Line { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. */ + /** + * The invoice line item to credit. Only valid when the {@code type} is {@code + * invoice_line_item}. + */ @SerializedName("invoice_line_item") String invoiceLineItem; @@ -347,27 +359,30 @@ public static class Line { Long quantity; /** - * The tax rates which apply to the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The tax rates which apply to the credit note line item. Only valid when the {@code type} is + * {@code custom_line_item}. */ @SerializedName("tax_rates") Object taxRates; - /** Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. */ + /** + * Type of the credit note line item, one of {@code invoice_line_item} or {@code + * custom_line_item}. + */ @SerializedName("type") Type type; /** - * The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be - * multiplied by the quantity to get the full amount to credit for this line item. Only valid - * when `type` is `custom_line_item`. + * The integer unit amount in %s of the credit note line item. This {@code + * unit_amount} will be multiplied by the quantity to get the full amount to credit for this + * line item. Only valid when {@code type} is {@code custom_line_item}. */ @SerializedName("unit_amount") Long unitAmount; /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ @SerializedName("unit_amount_decimal") BigDecimal unitAmountDecimal; @@ -431,8 +446,8 @@ public Line build() { } /** - * The line item amount to credit. Only valid when `type` is `invoice_line_item` and the - * referenced invoice line item does not have a quantity, only an amount. + * The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item} + * and the referenced invoice line item does not have a quantity, only an amount. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -440,8 +455,8 @@ public Builder setAmount(Long amount) { } /** - * The description of the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The description of the credit note line item. Only valid when the {@code type} is {@code + * custom_line_item}. */ public Builder setDescription(String description) { this.description = description; @@ -474,7 +489,10 @@ public Builder putAllExtraParam(Map map) { return this; } - /** The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. */ + /** + * The invoice line item to credit. Only valid when the {@code type} is {@code + * invoice_line_item}. + */ public Builder setInvoiceLineItem(String invoiceLineItem) { this.invoiceLineItem = invoiceLineItem; return this; @@ -515,8 +533,8 @@ public Builder addAllTaxRate(List elements) { } /** - * The tax rates which apply to the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The tax rates which apply to the credit note line item. Only valid when the {@code type} is + * {@code custom_line_item}. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -524,24 +542,27 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * The tax rates which apply to the credit note line item. Only valid when the `type` is - * `custom_line_item`. + * The tax rates which apply to the credit note line item. Only valid when the {@code type} is + * {@code custom_line_item}. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; return this; } - /** Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. */ + /** + * Type of the credit note line item, one of {@code invoice_line_item} or {@code + * custom_line_item}. + */ public Builder setType(Type type) { this.type = type; return this; } /** - * The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be - * multiplied by the quantity to get the full amount to credit for this line item. Only valid - * when `type` is `custom_line_item`. + * The integer unit amount in %s of the credit note line item. This {@code + * unit_amount} will be multiplied by the quantity to get the full amount to credit for this + * line item. Only valid when {@code type} is {@code custom_line_item}. */ public Builder setUnitAmount(Long unitAmount) { this.unitAmount = unitAmount; @@ -549,8 +570,8 @@ public Builder setUnitAmount(Long unitAmount) { } /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. + * Only one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { this.unitAmountDecimal = unitAmountDecimal; diff --git a/src/main/java/com/stripe/param/CreditNoteUpdateParams.java b/src/main/java/com/stripe/param/CreditNoteUpdateParams.java index 2663e548aa5..8f8a0ec471a 100644 --- a/src/main/java/com/stripe/param/CreditNoteUpdateParams.java +++ b/src/main/java/com/stripe/param/CreditNoteUpdateParams.java @@ -31,7 +31,8 @@ public class CreditNoteUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java index 102733918eb..a0d5e23d9ce 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java @@ -11,18 +11,20 @@ @Getter public class CustomerBalanceTransactionCollectionCreateParams extends ApiRequestParams { /** - * The integer amount in **%s** to apply to the customer's balance. Pass a negative amount to - * credit the customer's balance, and pass in a positive amount to debit the customer's balance. + * The integer amount in %s to apply to the customer's balance. Pass a negative + * amount to credit the customer's balance, and pass in a positive amount to debit the customer's + * balance. */ @SerializedName("amount") Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). If the - * customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) - * is set, this value must match it. If the customer's `currency` is not set, it will be updated - * to this value. + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. If + * the customer's {@code + * currency} is set, this value must match it. If the customer's {@code currency} is not set, + * it will be updated to this value. */ @SerializedName("currency") String currency; @@ -47,7 +49,8 @@ public class CustomerBalanceTransactionCollectionCreateParams extends ApiRequest /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -96,8 +99,9 @@ public CustomerBalanceTransactionCollectionCreateParams build() { } /** - * The integer amount in **%s** to apply to the customer's balance. Pass a negative amount to - * credit the customer's balance, and pass in a positive amount to debit the customer's balance. + * The integer amount in %s to apply to the customer's balance. Pass a negative + * amount to credit the customer's balance, and pass in a positive amount to debit the + * customer's balance. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -105,12 +109,12 @@ public Builder setAmount(Long amount) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). If the - * customer's - * [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, - * this value must match it. If the customer's `currency` is not set, it will be updated to this - * value. + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. If the customer's {@code + * currency} is set, this value must match it. If the customer's {@code currency} is not + * set, it will be updated to this value. */ public Builder setCurrency(String currency) { this.currency = currency; diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java index 75b5f8c4ff8..90b27185e41 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class CustomerBalanceTransactionCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class CustomerBalanceTransactionCollectionListParams extends ApiRequestPa Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public CustomerBalanceTransactionCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -156,10 +156,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java index bc039ce2d37..f9ff61f11c5 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java @@ -31,7 +31,8 @@ public class CustomerBalanceTransactionUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java index 5c2ef122c54..a772a2364b8 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java @@ -11,10 +11,10 @@ @Getter public class CustomerBalanceTransactionsParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class CustomerBalanceTransactionsParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public CustomerBalanceTransactionsParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CustomerCreateParams.java b/src/main/java/com/stripe/param/CustomerCreateParams.java index c365139be9a..7701088dd29 100644 --- a/src/main/java/com/stripe/param/CustomerCreateParams.java +++ b/src/main/java/com/stripe/param/CustomerCreateParams.java @@ -36,7 +36,7 @@ public class CustomerCreateParams extends ApiRequestParams { /** * Customer's email address. It's displayed alongside the customer in your dashboard and can be - * useful for searching and tracking. This may be up to *512 characters*. + * useful for searching and tracking. This may be up to 512 characters. */ @SerializedName("email") String email; @@ -68,7 +68,8 @@ public class CustomerCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -95,7 +96,7 @@ public class CustomerCreateParams extends ApiRequestParams { @SerializedName("source") String source; - /** The customer's tax exemption. One of `none`, `exempt`, or `reverse`. */ + /** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */ @SerializedName("tax_exempt") EnumParam taxExempt; @@ -244,7 +245,7 @@ public Builder setDescription(String description) { /** * Customer's email address. It's displayed alongside the customer in your dashboard and can be - * useful for searching and tracking. This may be up to *512 characters*. + * useful for searching and tracking. This may be up to 512 characters. */ public Builder setEmail(String email) { this.email = email; @@ -404,13 +405,13 @@ public Builder setSource(String source) { return this; } - /** The customer's tax exemption. One of `none`, `exempt`, or `reverse`. */ + /** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */ public Builder setTaxExempt(TaxExempt taxExempt) { this.taxExempt = taxExempt; return this; } - /** The customer's tax exemption. One of `none`, `exempt`, or `reverse`. */ + /** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */ public Builder setTaxExempt(EmptyParam taxExempt) { this.taxExempt = taxExempt; return this; @@ -450,8 +451,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -536,8 +537,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -928,8 +929,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1014,8 +1015,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1089,9 +1090,10 @@ public static class TaxIdData { Map extraParams; /** - * Type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, - * `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, - * `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, or `ca_qst`. + * Type of the tax ID, one of {@code eu_vat}, {@code nz_gst}, {@code au_abn}, {@code in_gst}, + * {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc}, {@code sg_uen}, {@code + * ru_inn}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat}, {@code th_vat}, {@code + * jp_cn}, {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn}, or {@code ca_qst}. */ @SerializedName("type") Type type; @@ -1149,9 +1151,11 @@ public Builder putAllExtraParam(Map map) { } /** - * Type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, - * `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, - * `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, or `ca_qst`. + * Type of the tax ID, one of {@code eu_vat}, {@code nz_gst}, {@code au_abn}, {@code in_gst}, + * {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc}, {@code sg_uen}, {@code + * ru_inn}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat}, {@code th_vat}, + * {@code jp_cn}, {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn}, or {@code + * ca_qst}. */ public Builder setType(Type type) { this.type = type; diff --git a/src/main/java/com/stripe/param/CustomerListParams.java b/src/main/java/com/stripe/param/CustomerListParams.java index 5987c32b95b..e90c4af6f5e 100644 --- a/src/main/java/com/stripe/param/CustomerListParams.java +++ b/src/main/java/com/stripe/param/CustomerListParams.java @@ -13,15 +13,17 @@ public class CustomerListParams extends ApiRequestParams { @SerializedName("created") Object created; - /** A filter on the list based on the customer's `email` field. The value must be a string. */ + /** + * A filter on the list based on the customer's {@code email} field. The value must be a string. + */ @SerializedName("email") String email; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -47,10 +49,10 @@ public class CustomerListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -113,17 +115,19 @@ public Builder setCreated(Long created) { return this; } - /** A filter on the list based on the customer's `email` field. The value must be a string. */ + /** + * A filter on the list based on the customer's {@code email} field. The value must be a string. + */ public Builder setEmail(String email) { this.email = email; return this; } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -192,10 +196,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/CustomerUpdateParams.java b/src/main/java/com/stripe/param/CustomerUpdateParams.java index c7414839210..1c42592aca3 100644 --- a/src/main/java/com/stripe/param/CustomerUpdateParams.java +++ b/src/main/java/com/stripe/param/CustomerUpdateParams.java @@ -28,15 +28,15 @@ public class CustomerUpdateParams extends ApiRequestParams { Object coupon; /** - * If you are using payment methods created via the PaymentMethods API, see the - * [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) + * If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method * parameter. * *

Provide the ID of a payment source already attached to this customer to make it this * customer's default payment source. * - *

If you want to add a new payment source and make it the default, see the - * [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. + *

If you want to add a new payment source and make it the default, see the source property. */ @SerializedName("default_source") Object defaultSource; @@ -50,7 +50,7 @@ public class CustomerUpdateParams extends ApiRequestParams { /** * Customer's email address. It's displayed alongside the customer in your dashboard and can be - * useful for searching and tracking. This may be up to *512 characters*. + * useful for searching and tracking. This may be up to 512 characters. */ @SerializedName("email") Object email; @@ -82,7 +82,8 @@ public class CustomerUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -106,7 +107,7 @@ public class CustomerUpdateParams extends ApiRequestParams { @SerializedName("source") Object source; - /** The customer's tax exemption. One of `none`, `exempt`, or `reverse`. */ + /** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */ @SerializedName("tax_exempt") EnumParam taxExempt; @@ -114,8 +115,8 @@ public class CustomerUpdateParams extends ApiRequestParams { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the customer's - * trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ @SerializedName("trial_end") Object trialEnd; @@ -256,15 +257,16 @@ public Builder setCoupon(EmptyParam coupon) { } /** - * If you are using payment methods created via the PaymentMethods API, see the - * [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) + * If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method * parameter. * *

Provide the ID of a payment source already attached to this customer to make it this * customer's default payment source. * - *

If you want to add a new payment source and make it the default, see the - * [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. + *

If you want to add a new payment source and make it the default, see the source + * property. */ public Builder setDefaultSource(String defaultSource) { this.defaultSource = defaultSource; @@ -272,15 +274,16 @@ public Builder setDefaultSource(String defaultSource) { } /** - * If you are using payment methods created via the PaymentMethods API, see the - * [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) + * If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method * parameter. * *

Provide the ID of a payment source already attached to this customer to make it this * customer's default payment source. * - *

If you want to add a new payment source and make it the default, see the - * [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. + *

If you want to add a new payment source and make it the default, see the source + * property. */ public Builder setDefaultSource(EmptyParam defaultSource) { this.defaultSource = defaultSource; @@ -307,7 +310,7 @@ public Builder setDescription(EmptyParam description) { /** * Customer's email address. It's displayed alongside the customer in your dashboard and can be - * useful for searching and tracking. This may be up to *512 characters*. + * useful for searching and tracking. This may be up to 512 characters. */ public Builder setEmail(String email) { this.email = email; @@ -316,7 +319,7 @@ public Builder setEmail(String email) { /** * Customer's email address. It's displayed alongside the customer in your dashboard and can be - * useful for searching and tracking. This may be up to *512 characters*. + * useful for searching and tracking. This may be up to 512 characters. */ public Builder setEmail(EmptyParam email) { this.email = email; @@ -497,13 +500,13 @@ public Builder setSource(EmptyParam source) { return this; } - /** The customer's tax exemption. One of `none`, `exempt`, or `reverse`. */ + /** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */ public Builder setTaxExempt(TaxExempt taxExempt) { this.taxExempt = taxExempt; return this; } - /** The customer's tax exemption. One of `none`, `exempt`, or `reverse`. */ + /** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */ public Builder setTaxExempt(EmptyParam taxExempt) { this.taxExempt = taxExempt; return this; @@ -513,8 +516,8 @@ public Builder setTaxExempt(EmptyParam taxExempt) { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the - * customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ public Builder setTrialEnd(TrialEnd trialEnd) { this.trialEnd = trialEnd; @@ -525,8 +528,8 @@ public Builder setTrialEnd(TrialEnd trialEnd) { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the - * customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ public Builder setTrialEnd(Long trialEnd) { this.trialEnd = trialEnd; @@ -541,8 +544,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -633,8 +636,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -642,8 +645,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -1097,8 +1100,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -1189,8 +1192,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1198,8 +1201,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; diff --git a/src/main/java/com/stripe/param/DisputeListParams.java b/src/main/java/com/stripe/param/DisputeListParams.java index e9c68a993ff..d9bb82f3f7d 100644 --- a/src/main/java/com/stripe/param/DisputeListParams.java +++ b/src/main/java/com/stripe/param/DisputeListParams.java @@ -18,10 +18,10 @@ public class DisputeListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -51,10 +51,10 @@ public class DisputeListParams extends ApiRequestParams { String paymentIntent; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -129,10 +129,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -207,10 +207,10 @@ public Builder setPaymentIntent(String paymentIntent) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/DisputeUpdateParams.java b/src/main/java/com/stripe/param/DisputeUpdateParams.java index b80b412e554..191b850497a 100644 --- a/src/main/java/com/stripe/param/DisputeUpdateParams.java +++ b/src/main/java/com/stripe/param/DisputeUpdateParams.java @@ -35,15 +35,16 @@ public class DisputeUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the + * Whether to immediately submit evidence to the bank. If {@code false}, evidence is staged on the * dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank - * by making another request with this attribute set to `true` (the default). + * by making another request with this attribute set to {@code true} (the default). */ @SerializedName("submit") Boolean submit; @@ -171,9 +172,9 @@ public Builder putAllMetadata(Map map) { } /** - * Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the - * dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the - * bank by making another request with this attribute set to `true` (the default). + * Whether to immediately submit evidence to the bank. If {@code false}, evidence is staged on + * the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the + * bank by making another request with this attribute set to {@code true} (the default). */ public Builder setSubmit(Boolean submit) { this.submit = submit; @@ -196,8 +197,8 @@ public static class Evidence { Object billingAddress; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription - * cancellation policy, as shown to the customer. + * (ID of a file upload) Your + * subscription cancellation policy, as shown to the customer. */ @SerializedName("cancellation_policy") Object cancellationPolicy; @@ -217,10 +218,10 @@ public static class Evidence { Object cancellationRebuttal; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with - * the customer that you feel is relevant to your case. Examples include emails proving that the - * customer received the product or service, or demonstrating their use of or satisfaction with - * the product or service. + * (ID of a file upload) Any + * communication with the customer that you feel is relevant to your case. Examples include + * emails proving that the customer received the product or service, or demonstrating their use + * of or satisfaction with the product or service. */ @SerializedName("customer_communication") Object customerCommunication; @@ -238,17 +239,17 @@ public static class Evidence { Object customerPurchaseIp; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or - * contract showing the customer's signature. + * (ID of a file upload) A relevant + * document or contract showing the customer's signature. */ @SerializedName("customer_signature") Object customerSignature; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the - * prior charge that can uniquely identify the charge, such as a receipt, shipping label, work - * order, etc. This document should be paired with a similar document from the disputed payment - * that proves the two payments are separate. + * (ID of a file upload) Documentation + * for the prior charge that can uniquely identify the charge, such as a receipt, shipping + * label, work order, etc. This document should be paired with a similar document from the + * disputed payment that proves the two payments are separate. */ @SerializedName("duplicate_charge_documentation") Object duplicateChargeDocumentation; @@ -283,15 +284,15 @@ public static class Evidence { Object productDescription; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message - * sent to the customer notifying them of the charge. + * (ID of a file upload) Any receipt or + * message sent to the customer notifying them of the charge. */ @SerializedName("receipt") Object receipt; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as - * shown to the customer. + * (ID of a file upload) Your refund + * policy, as shown to the customer. */ @SerializedName("refund_policy") Object refundPolicy; @@ -318,9 +319,9 @@ public static class Evidence { Object serviceDate; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a service was provided to the customer. This could include a copy of a signed - * contract, work order, or other form of written agreement. + * (ID of a file upload) Documentation + * showing proof that a service was provided to the customer. This could include a copy of a + * signed contract, work order, or other form of written agreement. */ @SerializedName("service_documentation") Object serviceDocumentation; @@ -347,10 +348,10 @@ public static class Evidence { Object shippingDate; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a product was shipped to the customer at the same address the customer provided to - * you. This could include a copy of the shipment receipt, shipping label, etc. It should show - * the customer's full shipping address, if possible. + * (ID of a file upload) Documentation + * showing proof that a product was shipped to the customer at the same address the customer + * provided to you. This could include a copy of the shipment receipt, shipping label, etc. It + * should show the customer's full shipping address, if possible. */ @SerializedName("shipping_documentation") Object shippingDocumentation; @@ -363,8 +364,8 @@ public static class Evidence { Object shippingTrackingNumber; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence - * or statements. + * (ID of a file upload) Any additional + * evidence or statements. */ @SerializedName("uncategorized_file") Object uncategorizedFile; @@ -559,8 +560,8 @@ public Builder setBillingAddress(EmptyParam billingAddress) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription - * cancellation policy, as shown to the customer. + * (ID of a file upload) Your + * subscription cancellation policy, as shown to the customer. */ public Builder setCancellationPolicy(String cancellationPolicy) { this.cancellationPolicy = cancellationPolicy; @@ -568,8 +569,8 @@ public Builder setCancellationPolicy(String cancellationPolicy) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription - * cancellation policy, as shown to the customer. + * (ID of a file upload) Your + * subscription cancellation policy, as shown to the customer. */ public Builder setCancellationPolicy(EmptyParam cancellationPolicy) { this.cancellationPolicy = cancellationPolicy; @@ -613,10 +614,10 @@ public Builder setCancellationRebuttal(EmptyParam cancellationRebuttal) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with - * the customer that you feel is relevant to your case. Examples include emails proving that - * the customer received the product or service, or demonstrating their use of or satisfaction - * with the product or service. + * (ID of a file upload) Any + * communication with the customer that you feel is relevant to your case. Examples include + * emails proving that the customer received the product or service, or demonstrating their + * use of or satisfaction with the product or service. */ public Builder setCustomerCommunication(String customerCommunication) { this.customerCommunication = customerCommunication; @@ -624,10 +625,10 @@ public Builder setCustomerCommunication(String customerCommunication) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with - * the customer that you feel is relevant to your case. Examples include emails proving that - * the customer received the product or service, or demonstrating their use of or satisfaction - * with the product or service. + * (ID of a file upload) Any + * communication with the customer that you feel is relevant to your case. Examples include + * emails proving that the customer received the product or service, or demonstrating their + * use of or satisfaction with the product or service. */ public Builder setCustomerCommunication(EmptyParam customerCommunication) { this.customerCommunication = customerCommunication; @@ -671,8 +672,8 @@ public Builder setCustomerPurchaseIp(EmptyParam customerPurchaseIp) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or - * contract showing the customer's signature. + * (ID of a file upload) A relevant + * document or contract showing the customer's signature. */ public Builder setCustomerSignature(String customerSignature) { this.customerSignature = customerSignature; @@ -680,8 +681,8 @@ public Builder setCustomerSignature(String customerSignature) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or - * contract showing the customer's signature. + * (ID of a file upload) A relevant + * document or contract showing the customer's signature. */ public Builder setCustomerSignature(EmptyParam customerSignature) { this.customerSignature = customerSignature; @@ -689,10 +690,10 @@ public Builder setCustomerSignature(EmptyParam customerSignature) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the - * prior charge that can uniquely identify the charge, such as a receipt, shipping label, work - * order, etc. This document should be paired with a similar document from the disputed - * payment that proves the two payments are separate. + * (ID of a file upload) + * Documentation for the prior charge that can uniquely identify the charge, such as a + * receipt, shipping label, work order, etc. This document should be paired with a similar + * document from the disputed payment that proves the two payments are separate. */ public Builder setDuplicateChargeDocumentation(String duplicateChargeDocumentation) { this.duplicateChargeDocumentation = duplicateChargeDocumentation; @@ -700,10 +701,10 @@ public Builder setDuplicateChargeDocumentation(String duplicateChargeDocumentati } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the - * prior charge that can uniquely identify the charge, such as a receipt, shipping label, work - * order, etc. This document should be paired with a similar document from the disputed - * payment that proves the two payments are separate. + * (ID of a file upload) + * Documentation for the prior charge that can uniquely identify the charge, such as a + * receipt, shipping label, work order, etc. This document should be paired with a similar + * document from the disputed payment that proves the two payments are separate. */ public Builder setDuplicateChargeDocumentation(EmptyParam duplicateChargeDocumentation) { this.duplicateChargeDocumentation = duplicateChargeDocumentation; @@ -789,8 +790,8 @@ public Builder setProductDescription(EmptyParam productDescription) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message - * sent to the customer notifying them of the charge. + * (ID of a file upload) Any receipt + * or message sent to the customer notifying them of the charge. */ public Builder setReceipt(String receipt) { this.receipt = receipt; @@ -798,8 +799,8 @@ public Builder setReceipt(String receipt) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message - * sent to the customer notifying them of the charge. + * (ID of a file upload) Any receipt + * or message sent to the customer notifying them of the charge. */ public Builder setReceipt(EmptyParam receipt) { this.receipt = receipt; @@ -807,8 +808,8 @@ public Builder setReceipt(EmptyParam receipt) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as - * shown to the customer. + * (ID of a file upload) Your refund + * policy, as shown to the customer. */ public Builder setRefundPolicy(String refundPolicy) { this.refundPolicy = refundPolicy; @@ -816,8 +817,8 @@ public Builder setRefundPolicy(String refundPolicy) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as - * shown to the customer. + * (ID of a file upload) Your refund + * policy, as shown to the customer. */ public Builder setRefundPolicy(EmptyParam refundPolicy) { this.refundPolicy = refundPolicy; @@ -879,9 +880,9 @@ public Builder setServiceDate(EmptyParam serviceDate) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a service was provided to the customer. This could include a copy of a signed - * contract, work order, or other form of written agreement. + * (ID of a file upload) + * Documentation showing proof that a service was provided to the customer. This could include + * a copy of a signed contract, work order, or other form of written agreement. */ public Builder setServiceDocumentation(String serviceDocumentation) { this.serviceDocumentation = serviceDocumentation; @@ -889,9 +890,9 @@ public Builder setServiceDocumentation(String serviceDocumentation) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a service was provided to the customer. This could include a copy of a signed - * contract, work order, or other form of written agreement. + * (ID of a file upload) + * Documentation showing proof that a service was provided to the customer. This could include + * a copy of a signed contract, work order, or other form of written agreement. */ public Builder setServiceDocumentation(EmptyParam serviceDocumentation) { this.serviceDocumentation = serviceDocumentation; @@ -953,10 +954,10 @@ public Builder setShippingDate(EmptyParam shippingDate) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a product was shipped to the customer at the same address the customer provided - * to you. This could include a copy of the shipment receipt, shipping label, etc. It should - * show the customer's full shipping address, if possible. + * (ID of a file upload) + * Documentation showing proof that a product was shipped to the customer at the same address + * the customer provided to you. This could include a copy of the shipment receipt, shipping + * label, etc. It should show the customer's full shipping address, if possible. */ public Builder setShippingDocumentation(String shippingDocumentation) { this.shippingDocumentation = shippingDocumentation; @@ -964,10 +965,10 @@ public Builder setShippingDocumentation(String shippingDocumentation) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing - * proof that a product was shipped to the customer at the same address the customer provided - * to you. This could include a copy of the shipment receipt, shipping label, etc. It should - * show the customer's full shipping address, if possible. + * (ID of a file upload) + * Documentation showing proof that a product was shipped to the customer at the same address + * the customer provided to you. This could include a copy of the shipment receipt, shipping + * label, etc. It should show the customer's full shipping address, if possible. */ public Builder setShippingDocumentation(EmptyParam shippingDocumentation) { this.shippingDocumentation = shippingDocumentation; @@ -993,8 +994,8 @@ public Builder setShippingTrackingNumber(EmptyParam shippingTrackingNumber) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence - * or statements. + * (ID of a file upload) Any + * additional evidence or statements. */ public Builder setUncategorizedFile(String uncategorizedFile) { this.uncategorizedFile = uncategorizedFile; @@ -1002,8 +1003,8 @@ public Builder setUncategorizedFile(String uncategorizedFile) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence - * or statements. + * (ID of a file upload) Any + * additional evidence or statements. */ public Builder setUncategorizedFile(EmptyParam uncategorizedFile) { this.uncategorizedFile = uncategorizedFile; diff --git a/src/main/java/com/stripe/param/EventListParams.java b/src/main/java/com/stripe/param/EventListParams.java index 31ab5df6038..407b3354004 100644 --- a/src/main/java/com/stripe/param/EventListParams.java +++ b/src/main/java/com/stripe/param/EventListParams.java @@ -21,10 +21,10 @@ public class EventListParams extends ApiRequestParams { Boolean deliverySuccess; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -50,10 +50,10 @@ public class EventListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -67,8 +67,8 @@ public class EventListParams extends ApiRequestParams { /** * An array of up to 20 strings containing specific event names. The list will be filtered to - * include only events with a matching event property. You may pass either `type` or `types`, but - * not both. + * include only events with a matching event property. You may pass either {@code type} or {@code + * types}, but not both. */ @SerializedName("types") List types; @@ -151,10 +151,10 @@ public Builder setDeliverySuccess(Boolean deliverySuccess) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -223,10 +223,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/ExchangeRateListParams.java b/src/main/java/com/stripe/param/ExchangeRateListParams.java index b67f705bcdc..4baff001303 100644 --- a/src/main/java/com/stripe/param/ExchangeRateListParams.java +++ b/src/main/java/com/stripe/param/ExchangeRateListParams.java @@ -11,10 +11,10 @@ @Getter public class ExchangeRateListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is the currency that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with the - * exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order - * to fetch the previous page of the list. + * A cursor for use in pagination. {@code ending_before} is the currency that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * the exchange rate for currency X your subsequent call can include {@code ending_before=obj_bar} + * in order to fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class ExchangeRateListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is the currency that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with the - * exchange rate for currency X, your subsequent call can include `starting_after=X` in order to - * fetch the next page of the list. + * A cursor for use in pagination. {@code starting_after} is the currency that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with the + * exchange rate for currency X, your subsequent call can include {@code starting_after=X} in + * order to fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public ExchangeRateListParams build() { } /** - * A cursor for use in pagination. `ending_before` is the currency that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with the - * exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in - * order to fetch the previous page of the list. + * A cursor for use in pagination. {@code ending_before} is the currency that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * the exchange rate for currency X your subsequent call can include {@code + * ending_before=obj_bar} in order to fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is the currency that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with the - * exchange rate for currency X, your subsequent call can include `starting_after=X` in order to - * fetch the next page of the list. + * A cursor for use in pagination. {@code starting_after} is the currency that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with the exchange rate for currency X, your subsequent call can include {@code + * starting_after=X} in order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java b/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java index 470607cafca..74e75afaf90 100644 --- a/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java @@ -21,7 +21,7 @@ public class ExternalAccountCollectionCreateParams extends ApiRequestParams { @SerializedName("expand") List expand; - /** Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** Please refer to full documentation instead. */ @SerializedName("external_account") String externalAccount; @@ -37,7 +37,8 @@ public class ExternalAccountCollectionCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -115,7 +116,7 @@ public Builder addAllExpand(List elements) { return this; } - /** Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** Please refer to full documentation instead. */ public Builder setExternalAccount(String externalAccount) { this.externalAccount = externalAccount; return this; diff --git a/src/main/java/com/stripe/param/ExternalAccountCollectionListParams.java b/src/main/java/com/stripe/param/ExternalAccountCollectionListParams.java index f7f43515769..479ae016dd1 100644 --- a/src/main/java/com/stripe/param/ExternalAccountCollectionListParams.java +++ b/src/main/java/com/stripe/param/ExternalAccountCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class ExternalAccountCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class ExternalAccountCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public ExternalAccountCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java b/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java index 7f26ab8a20d..6905fd73a18 100644 --- a/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java +++ b/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java @@ -16,7 +16,10 @@ public class ExternalAccountUpdateParams extends ApiRequestParams { @SerializedName("account_holder_name") Object accountHolderName; - /** The type of entity that holds the account. This can be either `individual` or `company`. */ + /** + * The type of entity that holds the account. This can be either {@code individual} or {@code + * company}. + */ @SerializedName("account_holder_type") EnumParam accountHolderType; @@ -72,7 +75,8 @@ public class ExternalAccountUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -181,13 +185,19 @@ public Builder setAccountHolderName(EmptyParam accountHolderName) { return this; } - /** The type of entity that holds the account. This can be either `individual` or `company`. */ + /** + * The type of entity that holds the account. This can be either {@code individual} or {@code + * company}. + */ public Builder setAccountHolderType(AccountHolderType accountHolderType) { this.accountHolderType = accountHolderType; return this; } - /** The type of entity that holds the account. This can be either `individual` or `company`. */ + /** + * The type of entity that holds the account. This can be either {@code individual} or {@code + * company}. + */ public Builder setAccountHolderType(EmptyParam accountHolderType) { this.accountHolderType = accountHolderType; return this; diff --git a/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java b/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java index a77746045e8..7aac8b9cf7a 100644 --- a/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java @@ -11,8 +11,8 @@ @Getter public class FeeRefundCollectionCreateParams extends ApiRequestParams { /** - * A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to - * the remaining unrefunded amount of the fee. + * A positive integer, in %s, representing how much of this fee to refund. Can refund + * only up to the remaining unrefunded amount of the fee. */ @SerializedName("amount") Long amount; @@ -33,7 +33,8 @@ public class FeeRefundCollectionCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -69,8 +70,8 @@ public FeeRefundCollectionCreateParams build() { } /** - * A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up - * to the remaining unrefunded amount of the fee. + * A positive integer, in %s, representing how much of this fee to refund. Can refund + * only up to the remaining unrefunded amount of the fee. */ public Builder setAmount(Long amount) { this.amount = amount; diff --git a/src/main/java/com/stripe/param/FeeRefundCollectionListParams.java b/src/main/java/com/stripe/param/FeeRefundCollectionListParams.java index b58b4d7e44a..c1197ceb4b5 100644 --- a/src/main/java/com/stripe/param/FeeRefundCollectionListParams.java +++ b/src/main/java/com/stripe/param/FeeRefundCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class FeeRefundCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class FeeRefundCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public FeeRefundCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/FeeRefundUpdateParams.java b/src/main/java/com/stripe/param/FeeRefundUpdateParams.java index 1b6ef021148..5886029baa7 100644 --- a/src/main/java/com/stripe/param/FeeRefundUpdateParams.java +++ b/src/main/java/com/stripe/param/FeeRefundUpdateParams.java @@ -26,7 +26,8 @@ public class FeeRefundUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/FileLinkCreateParams.java b/src/main/java/com/stripe/param/FileLinkCreateParams.java index 07c861a5ba9..8557efe556e 100644 --- a/src/main/java/com/stripe/param/FileLinkCreateParams.java +++ b/src/main/java/com/stripe/param/FileLinkCreateParams.java @@ -28,9 +28,10 @@ public class FileLinkCreateParams extends ApiRequestParams { Map extraParams; /** - * The ID of the file. The file's `purpose` must be one of the following: `business_icon`, - * `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, - * `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`. + * The ID of the file. The file's {@code purpose} must be one of the following: {@code + * business_icon}, {@code business_logo}, {@code customer_signature}, {@code dispute_evidence}, + * {@code finance_report_run}, {@code pci_document}, {@code sigma_scheduled_query}, or {@code + * tax_document_user_upload}. */ @SerializedName("file") String file; @@ -38,7 +39,8 @@ public class FileLinkCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -136,9 +138,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The ID of the file. The file's `purpose` must be one of the following: `business_icon`, - * `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, - * `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`. + * The ID of the file. The file's {@code purpose} must be one of the following: {@code + * business_icon}, {@code business_logo}, {@code customer_signature}, {@code dispute_evidence}, + * {@code finance_report_run}, {@code pci_document}, {@code sigma_scheduled_query}, or {@code + * tax_document_user_upload}. */ public Builder setFile(String file) { this.file = file; diff --git a/src/main/java/com/stripe/param/FileLinkListParams.java b/src/main/java/com/stripe/param/FileLinkListParams.java index 2eaf0c55bca..9fad2a21302 100644 --- a/src/main/java/com/stripe/param/FileLinkListParams.java +++ b/src/main/java/com/stripe/param/FileLinkListParams.java @@ -14,10 +14,10 @@ public class FileLinkListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -51,10 +51,10 @@ public class FileLinkListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -123,10 +123,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -207,10 +207,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/FileLinkUpdateParams.java b/src/main/java/com/stripe/param/FileLinkUpdateParams.java index 4c3adae4d0b..7ac837976ad 100644 --- a/src/main/java/com/stripe/param/FileLinkUpdateParams.java +++ b/src/main/java/com/stripe/param/FileLinkUpdateParams.java @@ -16,8 +16,8 @@ public class FileLinkUpdateParams extends ApiRequestParams { List expand; /** - * A future timestamp after which the link will no longer be usable, or `now` to expire the link - * immediately. + * A future timestamp after which the link will no longer be usable, or {@code now} to expire the + * link immediately. */ @SerializedName("expires_at") Object expiresAt; @@ -34,7 +34,8 @@ public class FileLinkUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -95,8 +96,8 @@ public Builder addAllExpand(List elements) { } /** - * A future timestamp after which the link will no longer be usable, or `now` to expire the link - * immediately. + * A future timestamp after which the link will no longer be usable, or {@code now} to expire + * the link immediately. */ public Builder setExpiresAt(ExpiresAt expiresAt) { this.expiresAt = expiresAt; @@ -104,8 +105,8 @@ public Builder setExpiresAt(ExpiresAt expiresAt) { } /** - * A future timestamp after which the link will no longer be usable, or `now` to expire the link - * immediately. + * A future timestamp after which the link will no longer be usable, or {@code now} to expire + * the link immediately. */ public Builder setExpiresAt(Long expiresAt) { this.expiresAt = expiresAt; @@ -113,8 +114,8 @@ public Builder setExpiresAt(Long expiresAt) { } /** - * A future timestamp after which the link will no longer be usable, or `now` to expire the link - * immediately. + * A future timestamp after which the link will no longer be usable, or {@code now} to expire + * the link immediately. */ public Builder setExpiresAt(EmptyParam expiresAt) { this.expiresAt = expiresAt; diff --git a/src/main/java/com/stripe/param/InvoiceCreateParams.java b/src/main/java/com/stripe/param/InvoiceCreateParams.java index 94f61260fe3..d510fbfd376 100644 --- a/src/main/java/com/stripe/param/InvoiceCreateParams.java +++ b/src/main/java/com/stripe/param/InvoiceCreateParams.java @@ -15,25 +15,26 @@ public class InvoiceCreateParams extends ApiRequestParams { /** * A fee in %s that will be applied to the invoice and transferred to the application owner's * Stripe account. The request must be made with an OAuth key or the Stripe-Account header in - * order to take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#invoices). + * order to take an application fee. For more information, see the application fees documentation. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; /** - * Controls whether Stripe will perform [automatic - * collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. - * When `false`, the invoice's state will not automatically advance without an explicit action. + * Controls whether Stripe will perform automatic collection + * of the invoice. When {@code false}, the invoice's state will not automatically advance without + * an explicit action. */ @SerializedName("auto_advance") Boolean autoAdvance; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay this invoice using the default source attached to the customer. When sending an - * invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to - * `charge_automatically`. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay this invoice using the default source attached to the customer. When + * sending an invoice, Stripe will email this invoice to the customer with payment instructions. + * Defaults to {@code charge_automatically}. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -48,7 +49,7 @@ public class InvoiceCreateParams extends ApiRequestParams { /** * The number of days from when the invoice is created until it is due. Valid only for invoices - * where `collection_method=send_invoice`. + * where {@code collection_method=send_invoice}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -69,7 +70,7 @@ public class InvoiceCreateParams extends ApiRequestParams { @SerializedName("default_source") String defaultSource; - /** The tax rates that will apply to any line item that does not have `tax_rates` set. */ + /** The tax rates that will apply to any line item that does not have {@code tax_rates} set. */ @SerializedName("default_tax_rates") List defaultTaxRates; @@ -81,8 +82,8 @@ public class InvoiceCreateParams extends ApiRequestParams { String description; /** - * The date on which payment for this invoice is due. Valid only for invoices where - * `collection_method=send_invoice`. + * The date on which payment for this invoice is due. Valid only for invoices where {@code + * collection_method=send_invoice}. */ @SerializedName("due_date") Long dueDate; @@ -107,7 +108,8 @@ public class InvoiceCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -115,8 +117,8 @@ public class InvoiceCreateParams extends ApiRequestParams { /** * Extra information about a charge for the customer's credit card statement. It must contain at * least one letter. If not specified and this invoice is part of a subscription, the default - * `statement_descriptor` will be set to the first subscription item's product's - * `statement_descriptor`. + * {@code statement_descriptor} will be set to the first subscription item's product's {@code + * statement_descriptor}. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -134,7 +136,8 @@ public class InvoiceCreateParams extends ApiRequestParams { /** * The percent tax rate applied to the invoice, represented as a decimal number. This field has * been deprecated and will be removed in a future API version, for further information view the - * [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * migration docs for {@code + * tax_rates}. */ @SerializedName("tax_percent") BigDecimal taxPercent; @@ -258,8 +261,8 @@ public InvoiceCreateParams build() { /** * A fee in %s that will be applied to the invoice and transferred to the application owner's * Stripe account. The request must be made with an OAuth key or the Stripe-Account header in - * order to take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#invoices). + * order to take an application fee. For more information, see the application fees documentation. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -267,9 +270,10 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { } /** - * Controls whether Stripe will perform [automatic - * collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. - * When `false`, the invoice's state will not automatically advance without an explicit action. + * Controls whether Stripe will perform automatic + * collection of the invoice. When {@code false}, the invoice's state will not automatically + * advance without an explicit action. */ public Builder setAutoAdvance(Boolean autoAdvance) { this.autoAdvance = autoAdvance; @@ -277,10 +281,10 @@ public Builder setAutoAdvance(Boolean autoAdvance) { } /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay this invoice using the default source attached to the customer. When sending - * an invoice, Stripe will email this invoice to the customer with payment instructions. - * Defaults to `charge_automatically`. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay this invoice using the default source attached to the customer. + * When sending an invoice, Stripe will email this invoice to the customer with payment + * instructions. Defaults to {@code charge_automatically}. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -335,7 +339,7 @@ public Builder setCustomer(String customer) { /** * The number of days from when the invoice is created until it is due. Valid only for invoices - * where `collection_method=send_invoice`. + * where {@code collection_method=send_invoice}. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -398,8 +402,8 @@ public Builder setDescription(String description) { } /** - * The date on which payment for this invoice is due. Valid only for invoices where - * `collection_method=send_invoice`. + * The date on which payment for this invoice is due. Valid only for invoices where {@code + * collection_method=send_invoice}. */ public Builder setDueDate(Long dueDate) { this.dueDate = dueDate; @@ -493,8 +497,8 @@ public Builder putAllMetadata(Map map) { /** * Extra information about a charge for the customer's credit card statement. It must contain at * least one letter. If not specified and this invoice is part of a subscription, the default - * `statement_descriptor` will be set to the first subscription item's product's - * `statement_descriptor`. + * {@code statement_descriptor} will be set to the first subscription item's product's {@code + * statement_descriptor}. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -516,7 +520,8 @@ public Builder setSubscription(String subscription) { /** * The percent tax rate applied to the invoice, represented as a decimal number. This field has * been deprecated and will be removed in a future API version, for further information view the - * [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * migration docs for {@code + * tax_rates}. */ public Builder setTaxPercent(BigDecimal taxPercent) { this.taxPercent = taxPercent; diff --git a/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java b/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java index 216b7ed3fa3..51ecb9b3aa3 100644 --- a/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java +++ b/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java @@ -11,9 +11,10 @@ @Getter public class InvoiceFinalizeInvoiceParams extends ApiRequestParams { /** - * Controls whether Stripe will perform [automatic - * collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. - * When `false`, the invoice's state will not automatically advance without an explicit action. + * Controls whether Stripe will perform automatic collection + * of the invoice. When {@code false}, the invoice's state will not automatically advance without + * an explicit action. */ @SerializedName("auto_advance") Boolean autoAdvance; @@ -55,9 +56,10 @@ public InvoiceFinalizeInvoiceParams build() { } /** - * Controls whether Stripe will perform [automatic - * collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. - * When `false`, the invoice's state will not automatically advance without an explicit action. + * Controls whether Stripe will perform automatic + * collection of the invoice. When {@code false}, the invoice's state will not automatically + * advance without an explicit action. */ public Builder setAutoAdvance(Boolean autoAdvance) { this.autoAdvance = autoAdvance; diff --git a/src/main/java/com/stripe/param/InvoiceItemCreateParams.java b/src/main/java/com/stripe/param/InvoiceItemCreateParams.java index d3317979e22..f813ec26e13 100644 --- a/src/main/java/com/stripe/param/InvoiceItemCreateParams.java +++ b/src/main/java/com/stripe/param/InvoiceItemCreateParams.java @@ -12,15 +12,15 @@ @Getter public class InvoiceItemCreateParams extends ApiRequestParams { /** - * The integer amount in **%s** of the charge to be applied to the upcoming invoice. Passing in a - * negative `amount` will reduce the `amount_due` on the invoice. + * The integer amount in %s of the charge to be applied to the upcoming invoice. + * Passing in a negative {@code amount} will reduce the {@code amount_due} on the invoice. */ @SerializedName("amount") Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -67,7 +67,8 @@ public class InvoiceItemCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -90,23 +91,23 @@ public class InvoiceItemCreateParams extends ApiRequestParams { String subscription; /** - * The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice - * do not apply to this invoice item. + * The tax rates which apply to the invoice item. When set, the {@code default_tax_rates} on the + * invoice do not apply to this invoice item. */ @SerializedName("tax_rates") List taxRates; /** - * The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This - * `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative - * `unit_amount` will reduce the `amount_due` on the invoice. + * The integer unit amount in %s of the charge to be applied to the upcoming + * invoice. This {@code unit_amount} will be multiplied by the quantity to get the full amount. + * Passing in a negative {@code unit_amount} will reduce the {@code amount_due} on the invoice. */ @SerializedName("unit_amount") Long unitAmount; /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of - * `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ @SerializedName("unit_amount_decimal") BigDecimal unitAmountDecimal; @@ -200,8 +201,9 @@ public InvoiceItemCreateParams build() { } /** - * The integer amount in **%s** of the charge to be applied to the upcoming invoice. Passing in - * a negative `amount` will reduce the `amount_due` on the invoice. + * The integer amount in %s of the charge to be applied to the upcoming + * invoice. Passing in a negative {@code amount} will reduce the {@code amount_due} on the + * invoice. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -209,8 +211,9 @@ public Builder setAmount(Long amount) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -381,9 +384,9 @@ public Builder addAllTaxRate(List elements) { } /** - * The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This - * `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a - * negative `unit_amount` will reduce the `amount_due` on the invoice. + * The integer unit amount in %s of the charge to be applied to the upcoming + * invoice. This {@code unit_amount} will be multiplied by the quantity to get the full amount. + * Passing in a negative {@code unit_amount} will reduce the {@code amount_due} on the invoice. */ public Builder setUnitAmount(Long unitAmount) { this.unitAmount = unitAmount; @@ -391,8 +394,8 @@ public Builder setUnitAmount(Long unitAmount) { } /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { this.unitAmountDecimal = unitAmountDecimal; diff --git a/src/main/java/com/stripe/param/InvoiceItemListParams.java b/src/main/java/com/stripe/param/InvoiceItemListParams.java index f88bf2ed24d..3a5072b0c30 100644 --- a/src/main/java/com/stripe/param/InvoiceItemListParams.java +++ b/src/main/java/com/stripe/param/InvoiceItemListParams.java @@ -21,10 +21,10 @@ public class InvoiceItemListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -57,18 +57,18 @@ public class InvoiceItemListParams extends ApiRequestParams { Long limit; /** - * Set to `true` to only show pending invoice items, which are not yet attached to any invoices. - * Set to `false` to only show invoice items already attached to invoices. If unspecified, no - * filter is applied. + * Set to {@code true} to only show pending invoice items, which are not yet attached to any + * invoices. Set to {@code false} to only show invoice items already attached to invoices. If + * unspecified, no filter is applied. */ @SerializedName("pending") Boolean pending; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -151,10 +151,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -232,9 +232,9 @@ public Builder setLimit(Long limit) { } /** - * Set to `true` to only show pending invoice items, which are not yet attached to any invoices. - * Set to `false` to only show invoice items already attached to invoices. If unspecified, no - * filter is applied. + * Set to {@code true} to only show pending invoice items, which are not yet attached to any + * invoices. Set to {@code false} to only show invoice items already attached to invoices. If + * unspecified, no filter is applied. */ public Builder setPending(Boolean pending) { this.pending = pending; @@ -242,10 +242,10 @@ public Builder setPending(Boolean pending) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java b/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java index 9d9a463742b..ec596993ec7 100644 --- a/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java +++ b/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java @@ -13,8 +13,8 @@ @Getter public class InvoiceItemUpdateParams extends ApiRequestParams { /** - * The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want - * to apply a credit to the customer's account, pass a negative amount. + * The integer amount in %s of the charge to be applied to the upcoming invoice. + * If you want to apply a credit to the customer's account, pass a negative amount. */ @SerializedName("amount") Long amount; @@ -50,7 +50,8 @@ public class InvoiceItemUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -64,23 +65,24 @@ public class InvoiceItemUpdateParams extends ApiRequestParams { Long quantity; /** - * The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice - * do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates. + * The tax rates which apply to the invoice item. When set, the {@code default_tax_rates} on the + * invoice do not apply to this invoice item. Pass an empty string to remove previously-defined + * tax rates. */ @SerializedName("tax_rates") Object taxRates; /** - * The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This - * unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a - * credit to the customer's account, pass a negative unit_amount. + * The integer unit amount in %s of the charge to be applied to the upcoming + * invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you + * want to apply a credit to the customer's account, pass a negative unit_amount. */ @SerializedName("unit_amount") Long unitAmount; /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of - * `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ @SerializedName("unit_amount_decimal") Object unitAmountDecimal; @@ -154,8 +156,8 @@ public InvoiceItemUpdateParams build() { } /** - * The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want - * to apply a credit to the customer's account, pass a negative amount. + * The integer amount in %s of the charge to be applied to the upcoming + * invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -309,7 +311,7 @@ public Builder addAllTaxRate(List elements) { } /** - * The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the + * The tax rates which apply to the invoice item. When set, the {@code default_tax_rates} on the * invoice do not apply to this invoice item. Pass an empty string to remove previously-defined * tax rates. */ @@ -319,7 +321,7 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the + * The tax rates which apply to the invoice item. When set, the {@code default_tax_rates} on the * invoice do not apply to this invoice item. Pass an empty string to remove previously-defined * tax rates. */ @@ -329,9 +331,9 @@ public Builder setTaxRates(List taxRates) { } /** - * The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This - * unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a - * credit to the customer's account, pass a negative unit_amount. + * The integer unit amount in %s of the charge to be applied to the upcoming + * invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you + * want to apply a credit to the customer's account, pass a negative unit_amount. */ public Builder setUnitAmount(Long unitAmount) { this.unitAmount = unitAmount; @@ -339,8 +341,8 @@ public Builder setUnitAmount(Long unitAmount) { } /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { this.unitAmountDecimal = unitAmountDecimal; @@ -348,8 +350,8 @@ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { } /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ public Builder setUnitAmountDecimal(EmptyParam unitAmountDecimal) { this.unitAmountDecimal = unitAmountDecimal; diff --git a/src/main/java/com/stripe/param/InvoiceLineItemCollectionListParams.java b/src/main/java/com/stripe/param/InvoiceLineItemCollectionListParams.java index 49cdcb4f3d8..7803c1fca58 100644 --- a/src/main/java/com/stripe/param/InvoiceLineItemCollectionListParams.java +++ b/src/main/java/com/stripe/param/InvoiceLineItemCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class InvoiceLineItemCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class InvoiceLineItemCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public InvoiceLineItemCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/InvoiceListParams.java b/src/main/java/com/stripe/param/InvoiceListParams.java index c6fbc03cc78..d162c4c2554 100644 --- a/src/main/java/com/stripe/param/InvoiceListParams.java +++ b/src/main/java/com/stripe/param/InvoiceListParams.java @@ -11,8 +11,8 @@ @Getter public class InvoiceListParams extends ApiRequestParams { /** - * The collection method of the invoice to retrieve. Either `charge_automatically` or - * `send_invoice`. + * The collection method of the invoice to retrieve. Either {@code charge_automatically} or {@code + * send_invoice}. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -28,10 +28,10 @@ public class InvoiceListParams extends ApiRequestParams { Object dueDate; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -57,17 +57,18 @@ public class InvoiceListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn - * more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + * The status of the invoice, one of {@code draft}, {@code open}, {@code paid}, {@code + * uncollectible}, or {@code void}. Learn more */ @SerializedName("status") Status status; @@ -145,8 +146,8 @@ public InvoiceListParams build() { } /** - * The collection method of the invoice to retrieve. Either `charge_automatically` or - * `send_invoice`. + * The collection method of the invoice to retrieve. Either {@code charge_automatically} or + * {@code send_invoice}. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -180,10 +181,10 @@ public Builder setDueDate(Long dueDate) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -252,10 +253,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -263,8 +264,9 @@ public Builder setStartingAfter(String startingAfter) { } /** - * The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn - * more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + * The status of the invoice, one of {@code draft}, {@code open}, {@code paid}, {@code + * uncollectible}, or {@code void}. Learn more */ public Builder setStatus(Status status) { this.status = status; diff --git a/src/main/java/com/stripe/param/InvoicePayParams.java b/src/main/java/com/stripe/param/InvoicePayParams.java index 1c59d21e855..8d1d1cbde17 100644 --- a/src/main/java/com/stripe/param/InvoicePayParams.java +++ b/src/main/java/com/stripe/param/InvoicePayParams.java @@ -24,14 +24,15 @@ public class InvoicePayParams extends ApiRequestParams { Map extraParams; /** - * In cases where the source used to pay the invoice has insufficient funds, passing - * `forgive=true` controls whether a charge should be attempted for the full amount available on + * In cases where the source used to pay the invoice has insufficient funds, passing {@code + * forgive=true} controls whether a charge should be attempted for the full amount available on * the source, up to the amount to fully pay the invoice. This effectively forgives the difference * between the amount available on the source and the amount due. * - *

Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the - * right amount. An example for this case is with ACH Credit Transfers and wires: if the amount - * wired is less than the amount due by a small amount, you might want to forgive the difference. + *

Passing {@code forgive=false} will fail the charge if the source hasn't been pre-funded with + * the right amount. An example for this case is with ACH Credit Transfers and wires: if the + * amount wired is less than the amount due by a small amount, you might want to forgive the + * difference. */ @SerializedName("forgive") Boolean forgive; @@ -162,14 +163,14 @@ public Builder putAllExtraParam(Map map) { } /** - * In cases where the source used to pay the invoice has insufficient funds, passing - * `forgive=true` controls whether a charge should be attempted for the full amount available on + * In cases where the source used to pay the invoice has insufficient funds, passing {@code + * forgive=true} controls whether a charge should be attempted for the full amount available on * the source, up to the amount to fully pay the invoice. This effectively forgives the * difference between the amount available on the source and the amount due. * - *

Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the - * right amount. An example for this case is with ACH Credit Transfers and wires: if the amount - * wired is less than the amount due by a small amount, you might want to forgive the + *

Passing {@code forgive=false} will fail the charge if the source hasn't been pre-funded + * with the right amount. An example for this case is with ACH Credit Transfers and wires: if + * the amount wired is less than the amount due by a small amount, you might want to forgive the * difference. */ public Builder setForgive(Boolean forgive) { diff --git a/src/main/java/com/stripe/param/InvoiceUpcomingParams.java b/src/main/java/com/stripe/param/InvoiceUpcomingParams.java index 26fbb0259f7..3e7b55259cd 100644 --- a/src/main/java/com/stripe/param/InvoiceUpcomingParams.java +++ b/src/main/java/com/stripe/param/InvoiceUpcomingParams.java @@ -13,11 +13,11 @@ @Getter public class InvoiceUpcomingParams extends ApiRequestParams { /** - * The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the - * invoice returned will preview updating or creating a subscription with that coupon. Otherwise, - * it will preview applying that coupon to the customer for the next upcoming invoice from among - * the customer's subscriptions. The invoice can be previewed without a coupon by passing this - * value as an empty string. + * The code of the coupon to apply. If {@code subscription} or {@code subscription_items} is + * provided, the invoice returned will preview updating or creating a subscription with that + * coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming + * invoice from among the customer's subscriptions. The invoice can be previewed without a coupon + * by passing this value as an empty string. */ @SerializedName("coupon") String coupon; @@ -52,26 +52,27 @@ public class InvoiceUpcomingParams extends ApiRequestParams { /** * The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If - * not provided, but a `subscription_items` is provided, you will preview creating a subscription - * with those items. If neither `subscription` nor `subscription_items` is provided, you will - * retrieve the next upcoming invoice from among the customer's subscriptions. + * not provided, but a {@code subscription_items} is provided, you will preview creating a + * subscription with those items. If neither {@code subscription} nor {@code subscription_items} + * is provided, you will retrieve the next upcoming invoice from among the customer's + * subscriptions. */ @SerializedName("subscription") String subscription; /** - * For new subscriptions, a future timestamp to anchor the subscription's [billing - * cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date - * of the first full invoice, and, for plans with `month` or `year` intervals, the day of the - * month for subsequent invoices. For existing subscriptions, the value can only be set to `now` - * or `unchanged`. + * For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to + * determine the date of the first full invoice, and, for plans with {@code month} or {@code year} + * intervals, the day of the month for subsequent invoices. For existing subscriptions, the value + * can only be set to {@code now} or {@code unchanged}. */ @SerializedName("subscription_billing_cycle_anchor") Object subscriptionBillingCycleAnchor; /** * Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if - * within the current period and prorations have been enabled using `proration_behavior`.` + * within the current period and prorations have been enabled using {@code proration_behavior}.` */ @SerializedName("subscription_cancel_at") Object subscriptionCancelAt; @@ -88,8 +89,8 @@ public class InvoiceUpcomingParams extends ApiRequestParams { /** * If provided, the invoice returned will preview updating or creating a subscription with these - * default tax rates. The default tax rates will apply to any line item that does not have - * `tax_rates` set. + * default tax rates. The default tax rates will apply to any line item that does not have {@code + * tax_rates} set. */ @SerializedName("subscription_default_tax_rates") Object subscriptionDefaultTaxRates; @@ -100,36 +101,38 @@ public class InvoiceUpcomingParams extends ApiRequestParams { /** * If previewing an update to a subscription, this decides whether the preview will show the - * result of applying prorations or not. If set, one of `subscription_items` or `subscription`, - * and one of `subscription_items` or `subscription_trial_end` are required. + * result of applying prorations or not. If set, one of {@code subscription_items} or {@code + * subscription}, and one of {@code subscription_items} or {@code subscription_trial_end} are + * required. */ @SerializedName("subscription_prorate") Boolean subscriptionProrate; /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a - * trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or - * `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, + * or starting a trial), or if an item's {@code quantity} changes. Valid values are {@code + * create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In - * order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ @SerializedName("subscription_proration_behavior") SubscriptionProrationBehavior subscriptionProrationBehavior; /** - * If previewing an update to a subscription, and doing proration, `subscription_proration_date` - * forces the proration to be calculated as though the update was done at the specified time. The - * time given must be within the current subscription period, and cannot be before the - * subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, - * or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to - * false. + * If previewing an update to a subscription, and doing proration, {@code + * subscription_proration_date} forces the proration to be calculated as though the update was + * done at the specified time. The time given must be within the current subscription period, and + * cannot be before the subscription was on its current plan. If set, {@code subscription}, and + * one of {@code subscription_items}, or {@code subscription_trial_end} are required. Also, {@code + * subscription_proration} cannot be set to false. */ @SerializedName("subscription_proration_date") Long subscriptionProrationDate; @@ -140,24 +143,26 @@ public class InvoiceUpcomingParams extends ApiRequestParams { /** * If provided, the invoice returned will preview updating or creating a subscription with that - * tax percent. If set, one of `subscription_items` or `subscription` is required. This field has - * been deprecated and will be removed in a future API version, for further information view the - * [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * tax percent. If set, one of {@code subscription_items} or {@code subscription} is required. + * This field has been deprecated and will be removed in a future API version, for further + * information view the migration + * docs for {@code tax_rates}. */ @SerializedName("subscription_tax_percent") BigDecimal subscriptionTaxPercent; /** * If provided, the invoice returned will preview updating or creating a subscription with that - * trial end. If set, one of `subscription_items` or `subscription` is required. + * trial end. If set, one of {@code subscription_items} or {@code subscription} is required. */ @SerializedName("subscription_trial_end") Object subscriptionTrialEnd; /** - * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting - * `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting - * this flag to `true` together with `subscription_trial_end` is not allowed. + * Indicates if a plan's {@code trial_period_days} should be applied to the subscription. Setting + * {@code subscription_trial_end} per subscription is preferred, and this defaults to {@code + * false}. Setting this flag to {@code true} together with {@code subscription_trial_end} is not + * allowed. */ @SerializedName("subscription_trial_from_plan") Boolean subscriptionTrialFromPlan; @@ -276,11 +281,11 @@ public InvoiceUpcomingParams build() { } /** - * The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the - * invoice returned will preview updating or creating a subscription with that coupon. - * Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice - * from among the customer's subscriptions. The invoice can be previewed without a coupon by - * passing this value as an empty string. + * The code of the coupon to apply. If {@code subscription} or {@code subscription_items} is + * provided, the invoice returned will preview updating or creating a subscription with that + * coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming + * invoice from among the customer's subscriptions. The invoice can be previewed without a + * coupon by passing this value as an empty string. */ public Builder setCoupon(String coupon) { this.coupon = coupon; @@ -382,9 +387,9 @@ public Builder setSchedule(String schedule) { /** * The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If - * not provided, but a `subscription_items` is provided, you will preview creating a - * subscription with those items. If neither `subscription` nor `subscription_items` is - * provided, you will retrieve the next upcoming invoice from among the customer's + * not provided, but a {@code subscription_items} is provided, you will preview creating a + * subscription with those items. If neither {@code subscription} nor {@code subscription_items} + * is provided, you will retrieve the next upcoming invoice from among the customer's * subscriptions. */ public Builder setSubscription(String subscription) { @@ -393,11 +398,11 @@ public Builder setSubscription(String subscription) { } /** - * For new subscriptions, a future timestamp to anchor the subscription's [billing - * cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the - * date of the first full invoice, and, for plans with `month` or `year` intervals, the day of - * the month for subsequent invoices. For existing subscriptions, the value can only be set to - * `now` or `unchanged`. + * For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to + * determine the date of the first full invoice, and, for plans with {@code month} or {@code + * year} intervals, the day of the month for subsequent invoices. For existing subscriptions, + * the value can only be set to {@code now} or {@code unchanged}. */ public Builder setSubscriptionBillingCycleAnchor( SubscriptionBillingCycleAnchor subscriptionBillingCycleAnchor) { @@ -406,11 +411,11 @@ public Builder setSubscriptionBillingCycleAnchor( } /** - * For new subscriptions, a future timestamp to anchor the subscription's [billing - * cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the - * date of the first full invoice, and, for plans with `month` or `year` intervals, the day of - * the month for subsequent invoices. For existing subscriptions, the value can only be set to - * `now` or `unchanged`. + * For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to + * determine the date of the first full invoice, and, for plans with {@code month} or {@code + * year} intervals, the day of the month for subsequent invoices. For existing subscriptions, + * the value can only be set to {@code now} or {@code unchanged}. */ public Builder setSubscriptionBillingCycleAnchor(Long subscriptionBillingCycleAnchor) { this.subscriptionBillingCycleAnchor = subscriptionBillingCycleAnchor; @@ -419,7 +424,7 @@ public Builder setSubscriptionBillingCycleAnchor(Long subscriptionBillingCycleAn /** * Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if - * within the current period and prorations have been enabled using `proration_behavior`.` + * within the current period and prorations have been enabled using {@code proration_behavior}.` */ public Builder setSubscriptionCancelAt(Long subscriptionCancelAt) { this.subscriptionCancelAt = subscriptionCancelAt; @@ -428,7 +433,7 @@ public Builder setSubscriptionCancelAt(Long subscriptionCancelAt) { /** * Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if - * within the current period and prorations have been enabled using `proration_behavior`.` + * within the current period and prorations have been enabled using {@code proration_behavior}.` */ public Builder setSubscriptionCancelAt(EmptyParam subscriptionCancelAt) { this.subscriptionCancelAt = subscriptionCancelAt; @@ -482,7 +487,7 @@ public Builder addAllSubscriptionDefaultTaxRate(List elements) { /** * If provided, the invoice returned will preview updating or creating a subscription with these * default tax rates. The default tax rates will apply to any line item that does not have - * `tax_rates` set. + * {@code tax_rates} set. */ public Builder setSubscriptionDefaultTaxRates(EmptyParam subscriptionDefaultTaxRates) { this.subscriptionDefaultTaxRates = subscriptionDefaultTaxRates; @@ -492,7 +497,7 @@ public Builder setSubscriptionDefaultTaxRates(EmptyParam subscriptionDefaultTaxR /** * If provided, the invoice returned will preview updating or creating a subscription with these * default tax rates. The default tax rates will apply to any line item that does not have - * `tax_rates` set. + * {@code tax_rates} set. */ public Builder setSubscriptionDefaultTaxRates(List subscriptionDefaultTaxRates) { this.subscriptionDefaultTaxRates = subscriptionDefaultTaxRates; @@ -527,8 +532,9 @@ public Builder addAllSubscriptionItem(List elements) { /** * If previewing an update to a subscription, this decides whether the preview will show the - * result of applying prorations or not. If set, one of `subscription_items` or `subscription`, - * and one of `subscription_items` or `subscription_trial_end` are required. + * result of applying prorations or not. If set, one of {@code subscription_items} or {@code + * subscription}, and one of {@code subscription_items} or {@code subscription_trial_end} are + * required. */ public Builder setSubscriptionProrate(Boolean subscriptionProrate) { this.subscriptionProrate = subscriptionProrate; @@ -536,18 +542,19 @@ public Builder setSubscriptionProrate(Boolean subscriptionProrate) { } /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting - * a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, - * or `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code + * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. + * Valid values are {@code create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). - * In order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ public Builder setSubscriptionProrationBehavior( SubscriptionProrationBehavior subscriptionProrationBehavior) { @@ -556,12 +563,12 @@ public Builder setSubscriptionProrationBehavior( } /** - * If previewing an update to a subscription, and doing proration, `subscription_proration_date` - * forces the proration to be calculated as though the update was done at the specified time. - * The time given must be within the current subscription period, and cannot be before the - * subscription was on its current plan. If set, `subscription`, and one of - * `subscription_items`, or `subscription_trial_end` are required. Also, - * `subscription_proration` cannot be set to false. + * If previewing an update to a subscription, and doing proration, {@code + * subscription_proration_date} forces the proration to be calculated as though the update was + * done at the specified time. The time given must be within the current subscription period, + * and cannot be before the subscription was on its current plan. If set, {@code subscription}, + * and one of {@code subscription_items}, or {@code subscription_trial_end} are required. Also, + * {@code subscription_proration} cannot be set to false. */ public Builder setSubscriptionProrationDate(Long subscriptionProrationDate) { this.subscriptionProrationDate = subscriptionProrationDate; @@ -576,9 +583,10 @@ public Builder setSubscriptionStartDate(Long subscriptionStartDate) { /** * If provided, the invoice returned will preview updating or creating a subscription with that - * tax percent. If set, one of `subscription_items` or `subscription` is required. This field - * has been deprecated and will be removed in a future API version, for further information view - * the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * tax percent. If set, one of {@code subscription_items} or {@code subscription} is required. + * This field has been deprecated and will be removed in a future API version, for further + * information view the migration + * docs for {@code tax_rates}. */ public Builder setSubscriptionTaxPercent(BigDecimal subscriptionTaxPercent) { this.subscriptionTaxPercent = subscriptionTaxPercent; @@ -587,7 +595,7 @@ public Builder setSubscriptionTaxPercent(BigDecimal subscriptionTaxPercent) { /** * If provided, the invoice returned will preview updating or creating a subscription with that - * trial end. If set, one of `subscription_items` or `subscription` is required. + * trial end. If set, one of {@code subscription_items} or {@code subscription} is required. */ public Builder setSubscriptionTrialEnd(SubscriptionTrialEnd subscriptionTrialEnd) { this.subscriptionTrialEnd = subscriptionTrialEnd; @@ -596,7 +604,7 @@ public Builder setSubscriptionTrialEnd(SubscriptionTrialEnd subscriptionTrialEnd /** * If provided, the invoice returned will preview updating or creating a subscription with that - * trial end. If set, one of `subscription_items` or `subscription` is required. + * trial end. If set, one of {@code subscription_items} or {@code subscription} is required. */ public Builder setSubscriptionTrialEnd(Long subscriptionTrialEnd) { this.subscriptionTrialEnd = subscriptionTrialEnd; @@ -604,9 +612,10 @@ public Builder setSubscriptionTrialEnd(Long subscriptionTrialEnd) { } /** - * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting - * `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting - * this flag to `true` together with `subscription_trial_end` is not allowed. + * Indicates if a plan's {@code trial_period_days} should be applied to the subscription. + * Setting {@code subscription_trial_end} per subscription is preferred, and this defaults to + * {@code false}. Setting this flag to {@code true} together with {@code subscription_trial_end} + * is not allowed. */ public Builder setSubscriptionTrialFromPlan(Boolean subscriptionTrialFromPlan) { this.subscriptionTrialFromPlan = subscriptionTrialFromPlan; @@ -616,14 +625,14 @@ public Builder setSubscriptionTrialFromPlan(Boolean subscriptionTrialFromPlan) { @Getter public static class InvoiceItem { - /** The integer amount in **%s** of previewed invoice item. */ + /** The integer amount in %s of previewed invoice item. */ @SerializedName("amount") Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only - * applicable to new invoice items. + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. Only applicable to new invoice items. */ @SerializedName("currency") String currency; @@ -661,8 +670,8 @@ public static class InvoiceItem { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -679,16 +688,16 @@ public static class InvoiceItem { Object taxRates; /** - * The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This - * unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a - * credit to the customer's account, pass a negative unit_amount. + * The integer unit amount in %s of the charge to be applied to the upcoming + * invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you + * want to apply a credit to the customer's account, pass a negative unit_amount. */ @SerializedName("unit_amount") Long unitAmount; /** - * Same as `unit_amount`, but accepts a decimal string with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal string with at most 12 decimal places. + * Only one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ @SerializedName("unit_amount_decimal") BigDecimal unitAmountDecimal; @@ -766,16 +775,16 @@ public InvoiceItem build() { this.unitAmountDecimal); } - /** The integer amount in **%s** of previewed invoice item. */ + /** The integer amount in %s of previewed invoice item. */ public Builder setAmount(Long amount) { this.amount = amount; return this; } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only - * applicable to new invoice items. + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. Only applicable to new invoice items. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -912,9 +921,9 @@ public Builder setTaxRates(List taxRates) { } /** - * The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This - * unit_amount will be multiplied by the quantity to get the full amount. If you want to apply - * a credit to the customer's account, pass a negative unit_amount. + * The integer unit amount in %s of the charge to be applied to the upcoming + * invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you + * want to apply a credit to the customer's account, pass a negative unit_amount. */ public Builder setUnitAmount(Long unitAmount) { this.unitAmount = unitAmount; @@ -922,8 +931,8 @@ public Builder setUnitAmount(Long unitAmount) { } /** - * Same as `unit_amount`, but accepts a decimal string with at most 12 decimal places. Only - * one of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal string with at most 12 decimal places. + * Only one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { this.unitAmountDecimal = unitAmountDecimal; @@ -1025,13 +1034,13 @@ public static class SubscriptionItem { Object billingThresholds; /** - * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` - * and the current plan's `usage_type` is `metered`. + * Delete all usage for a given subscription item. Allowed only when {@code deleted} is set to + * {@code true} and the current plan's {@code usage_type} is {@code metered}. */ @SerializedName("clear_usage") Boolean clearUsage; - /** A flag that, if set to `true`, will delete the specified item. */ + /** A flag that, if set to {@code true}, will delete the specified item. */ @SerializedName("deleted") Boolean deleted; @@ -1051,8 +1060,8 @@ public static class SubscriptionItem { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -1066,11 +1075,11 @@ public static class SubscriptionItem { Long quantity; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ @SerializedName("tax_rates") Object taxRates; @@ -1154,15 +1163,15 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { } /** - * Delete all usage for a given subscription item. Allowed only when `deleted` is set to - * `true` and the current plan's `usage_type` is `metered`. + * Delete all usage for a given subscription item. Allowed only when {@code deleted} is set to + * {@code true} and the current plan's {@code usage_type} is {@code metered}. */ public Builder setClearUsage(Boolean clearUsage) { this.clearUsage = clearUsage; return this; } - /** A flag that, if set to `true`, will delete the specified item. */ + /** A flag that, if set to {@code true}, will delete the specified item. */ public Builder setDeleted(Boolean deleted) { this.deleted = deleted; return this; @@ -1267,11 +1276,11 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -1279,11 +1288,11 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; diff --git a/src/main/java/com/stripe/param/InvoiceUpdateParams.java b/src/main/java/com/stripe/param/InvoiceUpdateParams.java index 768cc850e93..d17ee7860b5 100644 --- a/src/main/java/com/stripe/param/InvoiceUpdateParams.java +++ b/src/main/java/com/stripe/param/InvoiceUpdateParams.java @@ -15,37 +15,39 @@ public class InvoiceUpdateParams extends ApiRequestParams { /** * A fee in %s that will be applied to the invoice and transferred to the application owner's * Stripe account. The request must be made with an OAuth key or the Stripe-Account header in - * order to take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#invoices). + * order to take an application fee. For more information, see the application fees documentation. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; /** - * Controls whether Stripe will perform [automatic - * collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. + * Controls whether Stripe will perform automatic collection + * of the invoice. */ @SerializedName("auto_advance") Boolean autoAdvance; /** - * Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` - * invoices. + * Either {@code charge_automatically} or {@code send_invoice}. This field can be updated only on + * {@code draft} invoices. */ @SerializedName("collection_method") CollectionMethod collectionMethod; /** - * A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` - * is specified, the list specified will replace the existing custom field list on this invoice. - * Pass an empty string to remove previously-defined fields. + * A list of up to 4 custom fields to be displayed on the invoice. If a value for {@code + * custom_fields} is specified, the list specified will replace the existing custom field list on + * this invoice. Pass an empty string to remove previously-defined fields. */ @SerializedName("custom_fields") Object customFields; /** * The number of days from which the invoice is created until it is due. Only valid for invoices - * where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. + * where {@code collection_method=send_invoice}. This field can only be updated on {@code draft} + * invoices. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -67,8 +69,8 @@ public class InvoiceUpdateParams extends ApiRequestParams { Object defaultSource; /** - * The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an - * empty string to remove previously-defined tax rates. + * The tax rates that will apply to any line item that does not have {@code tax_rates} set. Pass + * an empty string to remove previously-defined tax rates. */ @SerializedName("default_tax_rates") Object defaultTaxRates; @@ -81,8 +83,8 @@ public class InvoiceUpdateParams extends ApiRequestParams { Object description; /** - * The date on which payment for this invoice is due. Only valid for invoices where - * `collection_method=send_invoice`. This field can only be updated on `draft` invoices. + * The date on which payment for this invoice is due. Only valid for invoices where {@code + * collection_method=send_invoice}. This field can only be updated on {@code draft} invoices. */ @SerializedName("due_date") Long dueDate; @@ -107,7 +109,8 @@ public class InvoiceUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -115,8 +118,8 @@ public class InvoiceUpdateParams extends ApiRequestParams { /** * Extra information about a charge for the customer's credit card statement. It must contain at * least one letter. If not specified and this invoice is part of a subscription, the default - * `statement_descriptor` will be set to the first subscription item's product's - * `statement_descriptor`. + * {@code statement_descriptor} will be set to the first subscription item's product's {@code + * statement_descriptor}. */ @SerializedName("statement_descriptor") Object statementDescriptor; @@ -124,9 +127,10 @@ public class InvoiceUpdateParams extends ApiRequestParams { /** * The percent tax rate applied to the invoice, represented as a non-negative decimal number (with * at most four decimal places) between 0 and 100. To unset a previously-set value, pass an empty - * string. This field can be updated only on `draft` invoices. This field has been deprecated and - * will be removed in a future API version, for further information view the [migration - * docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * string. This field can be updated only on {@code draft} invoices. This field has been + * deprecated and will be removed in a future API version, for further information view the migration docs for {@code + * tax_rates}. */ @SerializedName("tax_percent") Object taxPercent; @@ -240,8 +244,8 @@ public InvoiceUpdateParams build() { /** * A fee in %s that will be applied to the invoice and transferred to the application owner's * Stripe account. The request must be made with an OAuth key or the Stripe-Account header in - * order to take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#invoices). + * order to take an application fee. For more information, see the application fees documentation. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -249,8 +253,9 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { } /** - * Controls whether Stripe will perform [automatic - * collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. + * Controls whether Stripe will perform automatic + * collection of the invoice. */ public Builder setAutoAdvance(Boolean autoAdvance) { this.autoAdvance = autoAdvance; @@ -258,8 +263,8 @@ public Builder setAutoAdvance(Boolean autoAdvance) { } /** - * Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` - * invoices. + * Either {@code charge_automatically} or {@code send_invoice}. This field can be updated only + * on {@code draft} invoices. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -295,8 +300,8 @@ public Builder addAllCustomField(List elements) { } /** - * A list of up to 4 custom fields to be displayed on the invoice. If a value for - * `custom_fields` is specified, the list specified will replace the existing custom field list + * A list of up to 4 custom fields to be displayed on the invoice. If a value for {@code + * custom_fields} is specified, the list specified will replace the existing custom field list * on this invoice. Pass an empty string to remove previously-defined fields. */ public Builder setCustomFields(EmptyParam customFields) { @@ -305,8 +310,8 @@ public Builder setCustomFields(EmptyParam customFields) { } /** - * A list of up to 4 custom fields to be displayed on the invoice. If a value for - * `custom_fields` is specified, the list specified will replace the existing custom field list + * A list of up to 4 custom fields to be displayed on the invoice. If a value for {@code + * custom_fields} is specified, the list specified will replace the existing custom field list * on this invoice. Pass an empty string to remove previously-defined fields. */ public Builder setCustomFields(List customFields) { @@ -316,7 +321,8 @@ public Builder setCustomFields(List customFields) { /** * The number of days from which the invoice is created until it is due. Only valid for invoices - * where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. + * where {@code collection_method=send_invoice}. This field can only be updated on {@code draft} + * invoices. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -392,8 +398,8 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an - * empty string to remove previously-defined tax rates. + * The tax rates that will apply to any line item that does not have {@code tax_rates} set. Pass + * an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -401,8 +407,8 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an - * empty string to remove previously-defined tax rates. + * The tax rates that will apply to any line item that does not have {@code tax_rates} set. Pass + * an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(List defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -428,8 +434,8 @@ public Builder setDescription(EmptyParam description) { } /** - * The date on which payment for this invoice is due. Only valid for invoices where - * `collection_method=send_invoice`. This field can only be updated on `draft` invoices. + * The date on which payment for this invoice is due. Only valid for invoices where {@code + * collection_method=send_invoice}. This field can only be updated on {@code draft} invoices. */ public Builder setDueDate(Long dueDate) { this.dueDate = dueDate; @@ -529,8 +535,8 @@ public Builder putAllMetadata(Map map) { /** * Extra information about a charge for the customer's credit card statement. It must contain at * least one letter. If not specified and this invoice is part of a subscription, the default - * `statement_descriptor` will be set to the first subscription item's product's - * `statement_descriptor`. + * {@code statement_descriptor} will be set to the first subscription item's product's {@code + * statement_descriptor}. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -540,8 +546,8 @@ public Builder setStatementDescriptor(String statementDescriptor) { /** * Extra information about a charge for the customer's credit card statement. It must contain at * least one letter. If not specified and this invoice is part of a subscription, the default - * `statement_descriptor` will be set to the first subscription item's product's - * `statement_descriptor`. + * {@code statement_descriptor} will be set to the first subscription item's product's {@code + * statement_descriptor}. */ public Builder setStatementDescriptor(EmptyParam statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -551,9 +557,10 @@ public Builder setStatementDescriptor(EmptyParam statementDescriptor) { /** * The percent tax rate applied to the invoice, represented as a non-negative decimal number * (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass - * an empty string. This field can be updated only on `draft` invoices. This field has been - * deprecated and will be removed in a future API version, for further information view the - * [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * an empty string. This field can be updated only on {@code draft} invoices. This field has + * been deprecated and will be removed in a future API version, for further information view the + * migration docs for {@code + * tax_rates}. */ public Builder setTaxPercent(BigDecimal taxPercent) { this.taxPercent = taxPercent; @@ -563,9 +570,10 @@ public Builder setTaxPercent(BigDecimal taxPercent) { /** * The percent tax rate applied to the invoice, represented as a non-negative decimal number * (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass - * an empty string. This field can be updated only on `draft` invoices. This field has been - * deprecated and will be removed in a future API version, for further information view the - * [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * an empty string. This field can be updated only on {@code draft} invoices. This field has + * been deprecated and will be removed in a future API version, for further information view the + * migration docs for {@code + * tax_rates}. */ public Builder setTaxPercent(EmptyParam taxPercent) { this.taxPercent = taxPercent; diff --git a/src/main/java/com/stripe/param/IssuerFraudRecordListParams.java b/src/main/java/com/stripe/param/IssuerFraudRecordListParams.java index 14997fc3468..7d7c012c730 100644 --- a/src/main/java/com/stripe/param/IssuerFraudRecordListParams.java +++ b/src/main/java/com/stripe/param/IssuerFraudRecordListParams.java @@ -15,10 +15,10 @@ public class IssuerFraudRecordListParams extends ApiRequestParams { String charge; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -44,10 +44,10 @@ public class IssuerFraudRecordListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -102,10 +102,10 @@ public Builder setCharge(String charge) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -174,10 +174,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/OrderCreateParams.java b/src/main/java/com/stripe/param/OrderCreateParams.java index 565cb38019c..4424e81a872 100644 --- a/src/main/java/com/stripe/param/OrderCreateParams.java +++ b/src/main/java/com/stripe/param/OrderCreateParams.java @@ -18,8 +18,8 @@ public class OrderCreateParams extends ApiRequestParams { String coupon; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -27,8 +27,8 @@ public class OrderCreateParams extends ApiRequestParams { /** * The ID of an existing customer to use for this order. If provided, the customer email and * shipping address will be used to create the order. Subsequently, the customer will also be - * charged to pay the order. If `email` or `shipping` are also provided, they will override the - * values retrieved from the customer object. + * charged to pay the order. If {@code email} or {@code shipping} are also provided, they will + * override the values retrieved from the customer object. */ @SerializedName("customer") String customer; @@ -57,14 +57,15 @@ public class OrderCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * Shipping address for the order. Required if any of the SKUs are for products that have - * `shippable` set to true. + * Shipping address for the order. Required if any of the SKUs are for products that have {@code + * shippable} set to true. */ @SerializedName("shipping") Shipping shipping; @@ -137,8 +138,9 @@ public Builder setCoupon(String coupon) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -148,8 +150,8 @@ public Builder setCurrency(String currency) { /** * The ID of an existing customer to use for this order. If provided, the customer email and * shipping address will be used to create the order. Subsequently, the customer will also be - * charged to pay the order. If `email` or `shipping` are also provided, they will override the - * values retrieved from the customer object. + * charged to pay the order. If {@code email} or {@code shipping} are also provided, they will + * override the values retrieved from the customer object. */ public Builder setCustomer(String customer) { this.customer = customer; @@ -267,8 +269,8 @@ public Builder putAllMetadata(Map map) { } /** - * Shipping address for the order. Required if any of the SKUs are for products that have - * `shippable` set to true. + * Shipping address for the order. Required if any of the SKUs are for products that have {@code + * shippable} set to true. */ public Builder setShipping(Shipping shipping) { this.shipping = shipping; @@ -301,8 +303,8 @@ public static class Item { String parent; /** - * The quantity of this order item. When type is `sku`, this is the number of instances of the - * SKU to be ordered. + * The quantity of this order item. When type is {@code sku}, this is the number of instances of + * the SKU to be ordered. */ @SerializedName("quantity") Long quantity; @@ -406,8 +408,8 @@ public Builder setParent(String parent) { } /** - * The quantity of this order item. When type is `sku`, this is the number of instances of the - * SKU to be ordered. + * The quantity of this order item. When type is {@code sku}, this is the number of instances + * of the SKU to be ordered. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; @@ -542,8 +544,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -628,8 +630,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; diff --git a/src/main/java/com/stripe/param/OrderListParams.java b/src/main/java/com/stripe/param/OrderListParams.java index 71dd34ff5fd..a8246743bf5 100644 --- a/src/main/java/com/stripe/param/OrderListParams.java +++ b/src/main/java/com/stripe/param/OrderListParams.java @@ -19,10 +19,10 @@ public class OrderListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -52,17 +52,17 @@ public class OrderListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or - * `refunded`. + * Only return orders that have the given status. One of {@code created}, {@code paid}, {@code + * fulfilled}, or {@code refunded}. */ @SerializedName("status") String status; @@ -162,10 +162,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -260,10 +260,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -271,8 +271,8 @@ public Builder setStartingAfter(String startingAfter) { } /** - * Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or - * `refunded`. + * Only return orders that have the given status. One of {@code created}, {@code paid}, {@code + * fulfilled}, or {@code refunded}. */ public Builder setStatus(String status) { this.status = status; diff --git a/src/main/java/com/stripe/param/OrderPayParams.java b/src/main/java/com/stripe/param/OrderPayParams.java index a25eff4744d..21b42b4fe8f 100644 --- a/src/main/java/com/stripe/param/OrderPayParams.java +++ b/src/main/java/com/stripe/param/OrderPayParams.java @@ -12,17 +12,17 @@ public class OrderPayParams extends ApiRequestParams { /** * A fee in %s that will be applied to the order and transferred to the application owner's Stripe - * account. The request must be made with an OAuth key or the `Stripe-Account` header in order to - * take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). + * account. The request must be made with an OAuth key or the {@code Stripe-Account} header in + * order to take an application fee. For more information, see the application fees documentation. */ @SerializedName("application_fee") Long applicationFee; /** * The ID of an existing customer that will be charged for this order. If no customer was attached - * to the order at creation, either `source` or `customer` is required. Otherwise, the specified - * customer will be charged instead of the one attached to the order. + * to the order at creation, either {@code source} or {@code customer} is required. Otherwise, the + * specified customer will be charged instead of the one attached to the order. */ @SerializedName("customer") String customer; @@ -50,17 +50,18 @@ public class OrderPayParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * A [Token](https://stripe.com/docs/api#tokens)'s or a - * [Source](https://stripe.com/docs/api#sources)'s ID, as returned by - * [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at - * creation, either `source` or `customer` is required. Otherwise, the specified source will be - * charged intead of the customer attached to the order. + * A Token's or a Source's ID, as returned by Elements. If no customer was attached to the order + * at creation, either {@code source} or {@code customer} is required. Otherwise, the specified + * source will be charged intead of the customer attached to the order. */ @SerializedName("source") String source; @@ -115,9 +116,9 @@ public OrderPayParams build() { /** * A fee in %s that will be applied to the order and transferred to the application owner's - * Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in - * order to take an application fee. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). + * Stripe account. The request must be made with an OAuth key or the {@code Stripe-Account} + * header in order to take an application fee. For more information, see the application fees documentation. */ public Builder setApplicationFee(Long applicationFee) { this.applicationFee = applicationFee; @@ -126,8 +127,8 @@ public Builder setApplicationFee(Long applicationFee) { /** * The ID of an existing customer that will be charged for this order. If no customer was - * attached to the order at creation, either `source` or `customer` is required. Otherwise, the - * specified customer will be charged instead of the one attached to the order. + * attached to the order at creation, either {@code source} or {@code customer} is required. + * Otherwise, the specified customer will be charged instead of the one attached to the order. */ public Builder setCustomer(String customer) { this.customer = customer; @@ -222,11 +223,11 @@ public Builder putAllMetadata(Map map) { } /** - * A [Token](https://stripe.com/docs/api#tokens)'s or a - * [Source](https://stripe.com/docs/api#sources)'s ID, as returned by - * [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at - * creation, either `source` or `customer` is required. Otherwise, the specified source will be - * charged intead of the customer attached to the order. + * A Token's or a Source's ID, as returned by Elements. If no customer was attached to the + * order at creation, either {@code source} or {@code customer} is required. Otherwise, the + * specified source will be charged intead of the customer attached to the order. */ public Builder setSource(String source) { this.source = source; diff --git a/src/main/java/com/stripe/param/OrderReturnListParams.java b/src/main/java/com/stripe/param/OrderReturnListParams.java index 8be321cc1a0..576e8a322f5 100644 --- a/src/main/java/com/stripe/param/OrderReturnListParams.java +++ b/src/main/java/com/stripe/param/OrderReturnListParams.java @@ -15,10 +15,10 @@ public class OrderReturnListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -48,10 +48,10 @@ public class OrderReturnListParams extends ApiRequestParams { String order; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -117,10 +117,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -195,10 +195,10 @@ public Builder setOrder(String order) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/OrderReturnOrderParams.java b/src/main/java/com/stripe/param/OrderReturnOrderParams.java index ede94168d81..cefff8ef8e9 100644 --- a/src/main/java/com/stripe/param/OrderReturnOrderParams.java +++ b/src/main/java/com/stripe/param/OrderReturnOrderParams.java @@ -150,7 +150,7 @@ public static class Item { @SerializedName("amount") Long amount; - /** If returning a `tax` item, use description to disambiguate which one to return. */ + /** If returning a {@code tax} item, use description to disambiguate which one to return. */ @SerializedName("description") String description; @@ -167,11 +167,11 @@ public static class Item { @SerializedName("parent") String parent; - /** When type is `sku`, this is the number of instances of the SKU to be returned. */ + /** When type is {@code sku}, this is the number of instances of the SKU to be returned. */ @SerializedName("quantity") Long quantity; - /** The type of this order item. Must be `sku`, `tax`, or `shipping`. */ + /** The type of this order item. Must be {@code sku}, {@code tax}, or {@code shipping}. */ @SerializedName("type") Type type; @@ -219,7 +219,7 @@ public Builder setAmount(Long amount) { return this; } - /** If returning a `tax` item, use description to disambiguate which one to return. */ + /** If returning a {@code tax} item, use description to disambiguate which one to return. */ public Builder setDescription(String description) { this.description = description; return this; @@ -257,13 +257,13 @@ public Builder setParent(String parent) { return this; } - /** When type is `sku`, this is the number of instances of the SKU to be returned. */ + /** When type is {@code sku}, this is the number of instances of the SKU to be returned. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; return this; } - /** The type of this order item. Must be `sku`, `tax`, or `shipping`. */ + /** The type of this order item. Must be {@code sku}, {@code tax}, or {@code shipping}. */ public Builder setType(Type type) { this.type = type; return this; diff --git a/src/main/java/com/stripe/param/OrderUpdateParams.java b/src/main/java/com/stripe/param/OrderUpdateParams.java index c5aff9749a1..55145f1f31d 100644 --- a/src/main/java/com/stripe/param/OrderUpdateParams.java +++ b/src/main/java/com/stripe/param/OrderUpdateParams.java @@ -34,15 +34,16 @@ public class OrderUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * The shipping method to select for fulfilling this order. If specified, must be one of the `id`s - * of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing - * selected shipping method, updating `items` as necessary. + * The shipping method to select for fulfilling this order. If specified, must be one of the + * {@code id}s of a shipping method in the {@code shipping_methods} array. If specified, will + * overwrite the existing selected shipping method, updating {@code items} as necessary. */ @SerializedName("selected_shipping_method") Object selectedShippingMethod; @@ -52,9 +53,9 @@ public class OrderUpdateParams extends ApiRequestParams { Shipping shipping; /** - * Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More - * detail in the [Orders - * Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). + * Current order status. One of {@code created}, {@code paid}, {@code canceled}, {@code + * fulfilled}, or {@code returned}. More detail in the Orders Guide. */ @SerializedName("status") Status status; @@ -205,8 +206,8 @@ public Builder putAllMetadata(Map map) { /** * The shipping method to select for fulfilling this order. If specified, must be one of the - * `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the - * existing selected shipping method, updating `items` as necessary. + * {@code id}s of a shipping method in the {@code shipping_methods} array. If specified, will + * overwrite the existing selected shipping method, updating {@code items} as necessary. */ public Builder setSelectedShippingMethod(String selectedShippingMethod) { this.selectedShippingMethod = selectedShippingMethod; @@ -215,8 +216,8 @@ public Builder setSelectedShippingMethod(String selectedShippingMethod) { /** * The shipping method to select for fulfilling this order. If specified, must be one of the - * `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the - * existing selected shipping method, updating `items` as necessary. + * {@code id}s of a shipping method in the {@code shipping_methods} array. If specified, will + * overwrite the existing selected shipping method, updating {@code items} as necessary. */ public Builder setSelectedShippingMethod(EmptyParam selectedShippingMethod) { this.selectedShippingMethod = selectedShippingMethod; @@ -230,9 +231,9 @@ public Builder setShipping(Shipping shipping) { } /** - * Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More - * detail in the [Orders - * Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). + * Current order status. One of {@code created}, {@code paid}, {@code canceled}, {@code + * fulfilled}, or {@code returned}. More detail in the Orders Guide. */ public Builder setStatus(Status status) { this.status = status; @@ -242,7 +243,7 @@ public Builder setStatus(Status status) { @Getter public static class Shipping { - /** The name of the carrier like `USPS`, `UPS`, or `FedEx`. */ + /** The name of the carrier like {@code USPS}, {@code UPS}, or {@code FedEx}. */ @SerializedName("carrier") Object carrier; @@ -281,13 +282,13 @@ public Shipping build() { return new Shipping(this.carrier, this.extraParams, this.trackingNumber); } - /** The name of the carrier like `USPS`, `UPS`, or `FedEx`. */ + /** The name of the carrier like {@code USPS}, {@code UPS}, or {@code FedEx}. */ public Builder setCarrier(String carrier) { this.carrier = carrier; return this; } - /** The name of the carrier like `USPS`, `UPS`, or `FedEx`. */ + /** The name of the carrier like {@code USPS}, {@code UPS}, or {@code FedEx}. */ public Builder setCarrier(EmptyParam carrier) { this.carrier = carrier; return this; diff --git a/src/main/java/com/stripe/param/PaymentIntentCancelParams.java b/src/main/java/com/stripe/param/PaymentIntentCancelParams.java index bb3fde4f633..45bed3bfc3f 100644 --- a/src/main/java/com/stripe/param/PaymentIntentCancelParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentCancelParams.java @@ -11,8 +11,8 @@ @Getter public class PaymentIntentCancelParams extends ApiRequestParams { /** - * Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, - * `requested_by_customer`, or `abandoned` + * Reason for canceling this PaymentIntent. Possible values are {@code duplicate}, {@code + * fraudulent}, {@code requested_by_customer}, or {@code abandoned} */ @SerializedName("cancellation_reason") CancellationReason cancellationReason; @@ -54,8 +54,8 @@ public PaymentIntentCancelParams build() { } /** - * Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, - * `requested_by_customer`, or `abandoned` + * Reason for canceling this PaymentIntent. Possible values are {@code duplicate}, {@code + * fraudulent}, {@code requested_by_customer}, or {@code abandoned} */ public Builder setCancellationReason(CancellationReason cancellationReason) { this.cancellationReason = cancellationReason; diff --git a/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java b/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java index 68736417f72..ebf67ee096d 100644 --- a/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java @@ -12,16 +12,16 @@ public class PaymentIntentCaptureParams extends ApiRequestParams { /** * The amount to capture from the PaymentIntent, which must be less than or equal to the original - * amount. Any additional amount will be automatically refunded. Defaults to the full - * `amount_capturable` if not provided. + * amount. Any additional amount will be automatically refunded. Defaults to the full {@code + * amount_capturable} if not provided. */ @SerializedName("amount_to_capture") Long amountToCapture; /** * The amount of the application fee (if any) that will be applied to the payment and transferred - * to the application owner's Stripe account. For more information, see the PaymentIntents [use - * case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * to the application owner's Stripe account. For more information, see the PaymentIntents use case for connected accounts. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; @@ -56,8 +56,8 @@ public class PaymentIntentCaptureParams extends ApiRequestParams { /** * The parameters used to automatically create a Transfer when the payment is captured. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected accounts. */ @SerializedName("transfer_data") TransferData transferData; @@ -113,7 +113,7 @@ public PaymentIntentCaptureParams build() { /** * The amount to capture from the PaymentIntent, which must be less than or equal to the * original amount. Any additional amount will be automatically refunded. Defaults to the full - * `amount_capturable` if not provided. + * {@code amount_capturable} if not provided. */ public Builder setAmountToCapture(Long amountToCapture) { this.amountToCapture = amountToCapture; @@ -123,8 +123,8 @@ public Builder setAmountToCapture(Long amountToCapture) { /** * The amount of the application fee (if any) that will be applied to the payment and * transferred to the application owner's Stripe account. For more information, see the - * PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * PaymentIntents use case for + * connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -205,8 +205,9 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * The parameters used to automatically create a Transfer when the payment is captured. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected + * accounts. */ public Builder setTransferData(TransferData transferData) { this.transferData = transferData; diff --git a/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java b/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java index 4af5b50279e..49d9d9cea25 100644 --- a/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java @@ -13,8 +13,8 @@ @Getter public class PaymentIntentConfirmParams extends ApiRequestParams { /** - * Set to `true` to fail the payment attempt if the PaymentIntent transitions into - * `requires_action`. This parameter is intended for simpler integrations that do not handle + * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code + * requires_action}. This parameter is intended for simpler integrations that do not handle * customer actions. */ @SerializedName("error_on_requires_action") @@ -42,18 +42,18 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { Object mandateData; /** - * Set to `true` to indicate that the customer is not in your checkout flow during this payment - * attempt, and therefore is unable to authenticate. This parameter is intended for scenarios - * where you collect card details and [charge them - * later](https://stripe.com/docs/payments/cards/charging-saved-cards). + * Set to {@code true} to indicate that the customer is not in your checkout flow during this + * payment attempt, and therefore is unable to authenticate. This parameter is intended for + * scenarios where you collect card details and charge them later. */ @SerializedName("off_session") Object offSession; /** - * ID of the payment method (a PaymentMethod, Card, or [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to - * this PaymentIntent. + * ID of the payment method (a PaymentMethod, Card, or compatible Source + * object) to attach to this PaymentIntent. */ @SerializedName("payment_method") String paymentMethod; @@ -76,19 +76,21 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { String returnUrl; /** - * If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment - * method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save - * the payment method to the customer. Defaults to `false`. + * If the PaymentIntent has a {@code payment_method} and a {@code customer} or if you're attaching + * a payment method to the PaymentIntent in this request, you can pass {@code + * save_payment_method=true} to save the payment method to the customer. Defaults to {@code + * false}. * *

If the payment method is already saved to a customer, this does nothing. If this type of * payment method cannot be saved to a customer, the request will error. * - *

_Note that saving a payment method using this parameter does not guarantee that the payment - * method can be charged._ To ensure that only payment methods which can be charged are saved to a - * customer, you can [manually - * save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method - * in response to the [`payment_intent.succeeded` - * webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded). + *

Note that saving a payment method using this parameter does not guarantee that the + * payment method can be charged. To ensure that only payment methods which can be charged + * are saved to a customer, you can manually save + * the payment method in response to the {@code + * payment_intent.succeeded} webhook. */ @SerializedName("save_payment_method") Boolean savePaymentMethod; @@ -96,24 +98,24 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

Use `on_session` if you intend to only reuse the payment method when your customer is - * present in your checkout flow. Use `off_session` if your customer may or may not be in your - * checkout flow. + *

Use {@code on_session} if you intend to only reuse the payment method when your customer is + * present in your checkout flow. Use {@code off_session} if your customer may or may not be in + * your checkout flow. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure - * that they are authenticated while processing this PaymentIntent. You will then be able to - * collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and comply + * with regional legislation and network rules. For example, if your customer is impacted by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. * - *

If `setup_future_usage` is already set and you are performing a request using a publishable - * key, you may only update the value from `on_session` to `off_session`. + *

If {@code setup_future_usage} is already set and you are performing a request using a + * publishable key, you may only update the value from {@code on_session} to {@code off_session}. */ @SerializedName("setup_future_usage") EnumParam setupFutureUsage; @@ -124,15 +126,16 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { /** * This is a legacy field that will be removed in the future. It is the ID of the Source object to - * attach to this PaymentIntent. Please use the `payment_method` field instead, which also - * supports Cards and [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) objects. + * attach to this PaymentIntent. Please use the {@code payment_method} field instead, which also + * supports Cards and compatible Source + * objects. */ @SerializedName("source") String source; /** - * Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle + * Set to {@code true} only when using manual confirmation and the iOS or Android SDKs to handle * additional authentication steps. */ @SerializedName("use_stripe_sdk") @@ -227,8 +230,8 @@ public PaymentIntentConfirmParams build() { } /** - * Set to `true` to fail the payment attempt if the PaymentIntent transitions into - * `requires_action`. This parameter is intended for simpler integrations that do not handle + * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code + * requires_action}. This parameter is intended for simpler integrations that do not handle * customer actions. */ public Builder setErrorOnRequiresAction(Boolean errorOnRequiresAction) { @@ -301,10 +304,10 @@ public Builder setMandateData(MandateData mandateData) { } /** - * Set to `true` to indicate that the customer is not in your checkout flow during this payment - * attempt, and therefore is unable to authenticate. This parameter is intended for scenarios - * where you collect card details and [charge them - * later](https://stripe.com/docs/payments/cards/charging-saved-cards). + * Set to {@code true} to indicate that the customer is not in your checkout flow during this + * payment attempt, and therefore is unable to authenticate. This parameter is intended for + * scenarios where you collect card details and charge them later. */ public Builder setOffSession(Boolean offSession) { this.offSession = offSession; @@ -312,10 +315,10 @@ public Builder setOffSession(Boolean offSession) { } /** - * Set to `true` to indicate that the customer is not in your checkout flow during this payment - * attempt, and therefore is unable to authenticate. This parameter is intended for scenarios - * where you collect card details and [charge them - * later](https://stripe.com/docs/payments/cards/charging-saved-cards). + * Set to {@code true} to indicate that the customer is not in your checkout flow during this + * payment attempt, and therefore is unable to authenticate. This parameter is intended for + * scenarios where you collect card details and charge them later. */ public Builder setOffSession(OffSession offSession) { this.offSession = offSession; @@ -323,9 +326,9 @@ public Builder setOffSession(OffSession offSession) { } /** - * ID of the payment method (a PaymentMethod, Card, or [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to - * this PaymentIntent. + * ID of the payment method (a PaymentMethod, Card, or compatible Source + * object) to attach to this PaymentIntent. */ public Builder setPaymentMethod(String paymentMethod) { this.paymentMethod = paymentMethod; @@ -362,19 +365,21 @@ public Builder setReturnUrl(String returnUrl) { } /** - * If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment - * method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save - * the payment method to the customer. Defaults to `false`. + * If the PaymentIntent has a {@code payment_method} and a {@code customer} or if you're + * attaching a payment method to the PaymentIntent in this request, you can pass {@code + * save_payment_method=true} to save the payment method to the customer. Defaults to {@code + * false}. * *

If the payment method is already saved to a customer, this does nothing. If this type of * payment method cannot be saved to a customer, the request will error. * - *

_Note that saving a payment method using this parameter does not guarantee that the - * payment method can be charged._ To ensure that only payment methods which can be charged are - * saved to a customer, you can [manually - * save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method - * in response to the [`payment_intent.succeeded` - * webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded). + *

Note that saving a payment method using this parameter does not guarantee that the + * payment method can be charged. To ensure that only payment methods which can be charged + * are saved to a customer, you can manually save + * the payment method in response to the {@code + * payment_intent.succeeded} webhook. */ public Builder setSavePaymentMethod(Boolean savePaymentMethod) { this.savePaymentMethod = savePaymentMethod; @@ -384,24 +389,25 @@ public Builder setSavePaymentMethod(Boolean savePaymentMethod) { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

Use `on_session` if you intend to only reuse the payment method when your customer is - * present in your checkout flow. Use `off_session` if your customer may or may not be in your - * checkout flow. + *

Use {@code on_session} if you intend to only reuse the payment method when your customer + * is present in your checkout flow. Use {@code off_session} if your customer may or may not be + * in your checkout flow. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will - * ensure that they are authenticated while processing this PaymentIntent. You will then be able - * to collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and + * comply with regional legislation and network rules. For example, if your customer is impacted + * by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. * - *

If `setup_future_usage` is already set and you are performing a request using a - * publishable key, you may only update the value from `on_session` to `off_session`. + *

If {@code setup_future_usage} is already set and you are performing a request using a + * publishable key, you may only update the value from {@code on_session} to {@code + * off_session}. */ public Builder setSetupFutureUsage(SetupFutureUsage setupFutureUsage) { this.setupFutureUsage = setupFutureUsage; @@ -411,24 +417,25 @@ public Builder setSetupFutureUsage(SetupFutureUsage setupFutureUsage) { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

Use `on_session` if you intend to only reuse the payment method when your customer is - * present in your checkout flow. Use `off_session` if your customer may or may not be in your - * checkout flow. + *

Use {@code on_session} if you intend to only reuse the payment method when your customer + * is present in your checkout flow. Use {@code off_session} if your customer may or may not be + * in your checkout flow. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will - * ensure that they are authenticated while processing this PaymentIntent. You will then be able - * to collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and + * comply with regional legislation and network rules. For example, if your customer is impacted + * by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. * - *

If `setup_future_usage` is already set and you are performing a request using a - * publishable key, you may only update the value from `on_session` to `off_session`. + *

If {@code setup_future_usage} is already set and you are performing a request using a + * publishable key, you may only update the value from {@code on_session} to {@code + * off_session}. */ public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) { this.setupFutureUsage = setupFutureUsage; @@ -449,9 +456,10 @@ public Builder setShipping(EmptyParam shipping) { /** * This is a legacy field that will be removed in the future. It is the ID of the Source object - * to attach to this PaymentIntent. Please use the `payment_method` field instead, which also - * supports Cards and [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) objects. + * to attach to this PaymentIntent. Please use the {@code payment_method} field instead, which + * also supports Cards and compatible Source + * objects. */ public Builder setSource(String source) { this.source = source; @@ -459,7 +467,7 @@ public Builder setSource(String source) { } /** - * Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle + * Set to {@code true} only when using manual confirmation and the iOS or Android SDKs to handle * additional authentication steps. */ public Builder setUseStripeSdk(Boolean useStripeSdk) { @@ -565,8 +573,8 @@ public static class CustomerAcceptance { Online online; /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ @SerializedName("type") Type type; @@ -658,8 +666,8 @@ public Builder setOnline(Online online) { } /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ public Builder setType(Type type) { this.type = type; @@ -912,8 +920,8 @@ public static class Card { /** * Installment configuration for payments attempted on this PaymentIntent (Mexico Only). * - *

For more information, see the [installments integration - * guide](https://stripe.com/docs/payments/installments). + *

For more information, see the installments integration guide. */ @SerializedName("installments") Installments installments; @@ -928,13 +936,14 @@ public static class Card { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish - * to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on - * how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our SCA + * Engine. */ @SerializedName("request_three_d_secure") RequestThreeDSecure requestThreeDSecure; @@ -999,8 +1008,8 @@ public Builder putAllExtraParam(Map map) { /** * Installment configuration for payments attempted on this PaymentIntent (Mexico Only). * - *

For more information, see the [installments integration - * guide](https://stripe.com/docs/payments/installments). + *

For more information, see the installments integration guide. */ public Builder setInstallments(Installments installments) { this.installments = installments; @@ -1019,13 +1028,14 @@ public Builder setMoto(Boolean moto) { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you - * wish to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information - * on how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our + * SCA Engine. */ public Builder setRequestThreeDSecure(RequestThreeDSecure requestThreeDSecure) { this.requestThreeDSecure = requestThreeDSecure; @@ -1144,8 +1154,8 @@ public Builder setPlan(EmptyParam plan) { @Getter public static class Plan { /** - * For `fixed_count` installment plans, this is the number of installment payments your - * customer will make to their credit card. + * For {@code fixed_count} installment plans, this is the number of installment payments + * your customer will make to their credit card. */ @SerializedName("count") Long count; @@ -1161,13 +1171,13 @@ public static class Plan { Map extraParams; /** - * For `fixed_count` installment plans, this is the interval between installment payments - * your customer will make to their credit card. One of `month`. + * For {@code fixed_count} installment plans, this is the interval between installment + * payments your customer will make to their credit card. One of {@code month}. */ @SerializedName("interval") Interval interval; - /** Type of installment plan, one of `fixed_count`. */ + /** Type of installment plan, one of {@code fixed_count}. */ @SerializedName("type") Type type; @@ -1197,8 +1207,8 @@ public Plan build() { } /** - * For `fixed_count` installment plans, this is the number of installment payments your - * customer will make to their credit card. + * For {@code fixed_count} installment plans, this is the number of installment payments + * your customer will make to their credit card. */ public Builder setCount(Long count) { this.count = count; @@ -1236,15 +1246,15 @@ public Builder putAllExtraParam(Map map) { } /** - * For `fixed_count` installment plans, this is the interval between installment - * payments your customer will make to their credit card. One of `month`. + * For {@code fixed_count} installment plans, this is the interval between installment + * payments your customer will make to their credit card. One of {@code month}. */ public Builder setInterval(Interval interval) { this.interval = interval; return this; } - /** Type of installment plan, one of `fixed_count`. */ + /** Type of installment plan, one of {@code fixed_count}. */ public Builder setType(Type type) { this.type = type; return this; @@ -1438,8 +1448,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1524,8 +1534,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; diff --git a/src/main/java/com/stripe/param/PaymentIntentCreateParams.java b/src/main/java/com/stripe/param/PaymentIntentCreateParams.java index 5f4bc1c8c8e..21118eec9a4 100644 --- a/src/main/java/com/stripe/param/PaymentIntentCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentCreateParams.java @@ -13,19 +13,20 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how much - * to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) - * (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum - * amount is $0.50 US or [equivalent in charge - * currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount - * value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). + * to charge in the smallest currency + * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The + * minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ @SerializedName("amount") Long amount; /** * The amount of the application fee (if any) that will be applied to the payment and transferred - * to the application owner's Stripe account. For more information, see the PaymentIntents [use - * case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * to the application owner's Stripe account. For more information, see the PaymentIntents use case for connected accounts. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; @@ -35,10 +36,12 @@ public class PaymentIntentCreateParams extends ApiRequestParams { CaptureMethod captureMethod; /** - * Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this - * PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a - * PaymentIntent at the same time, parameters available in the - * [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. + * Set to {@code true} to attempt to confirm this PaymentIntent + * immediately. This parameter defaults to {@code false}. When creating and confirming a + * PaymentIntent at the same time, parameters available in the confirm API may also be + * provided. */ @SerializedName("confirm") Boolean confirm; @@ -47,8 +50,8 @@ public class PaymentIntentCreateParams extends ApiRequestParams { ConfirmationMethod confirmationMethod; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -68,9 +71,9 @@ public class PaymentIntentCreateParams extends ApiRequestParams { String description; /** - * Set to `true` to fail the payment attempt if the PaymentIntent transitions into - * `requires_action`. This parameter is intended for simpler integrations that do not handle - * customer actions. This can only be set when `confirm=true` is supplied. + * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code + * requires_action}. This parameter is intended for simpler integrations that do not handle + * customer actions. This can only be set when {@code confirm=true} is supplied. */ @SerializedName("error_on_requires_action") Boolean errorOnRequiresAction; @@ -89,15 +92,17 @@ public class PaymentIntentCreateParams extends ApiRequestParams { Map extraParams; /** - * ID of the mandate to be used for this payment. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * ID of the mandate to be used for this payment. This parameter can only be used with {@code + * confirm=true}. */ @SerializedName("mandate") String mandate; /** - * This hash contains details about the Mandate to create. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * This hash contains details about the Mandate to create. This parameter can only be used with {@code + * confirm=true}. */ @SerializedName("mandate_data") MandateData mandateData; @@ -105,38 +110,41 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * Set to `true` to indicate that the customer is not in your checkout flow during this payment - * attempt, and therefore is unable to authenticate. This parameter is intended for scenarios - * where you collect card details and [charge them - * later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be - * used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * Set to {@code true} to indicate that the customer is not in your checkout flow during this + * payment attempt, and therefore is unable to authenticate. This parameter is intended for + * scenarios where you collect card details and charge them later. This + * parameter can only be used with {@code + * confirm=true}. */ @SerializedName("off_session") Object offSession; /** * The Stripe account ID for which these funds are intended. For details, see the PaymentIntents - * [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * use case for connected + * accounts. */ @SerializedName("on_behalf_of") String onBehalfOf; /** - * ID of the payment method (a PaymentMethod, Card, or [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to - * this PaymentIntent. + * ID of the payment method (a PaymentMethod, Card, or compatible Source + * object) to attach to this PaymentIntent. * - *

If neither the `payment_method` parameter nor the `source` parameter are provided with - * `confirm=true`, `source` will be automatically populated with `customer.default_source` to - * improve the migration experience for users of the Charges API. We recommend that you explicitly - * provide the `payment_method` going forward. + *

If neither the {@code payment_method} parameter nor the {@code source} parameter are + * provided with {@code confirm=true}, {@code source} will be automatically populated with {@code + * customer.default_source} to improve the migration experience for users of the Charges API. We + * recommend that you explicitly provide the {@code payment_method} going forward. */ @SerializedName("payment_method") String paymentMethod; @@ -147,7 +155,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this - * is not provided, defaults to ["card"]. + * is not provided, defaults to ["card"]. */ @SerializedName("payment_method_types") List paymentMethodTypes; @@ -159,26 +167,29 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. If you'd prefer to redirect to a mobile application, you can - * alternatively supply an application URI scheme. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * alternatively supply an application URI scheme. This parameter can only be used with {@code + * confirm=true}. */ @SerializedName("return_url") String returnUrl; /** - * If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment - * method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save - * the payment method to the customer. Defaults to `false`. + * If the PaymentIntent has a {@code payment_method} and a {@code customer} or if you're attaching + * a payment method to the PaymentIntent in this request, you can pass {@code + * save_payment_method=true} to save the payment method to the customer. Defaults to {@code + * false}. * *

If the payment method is already saved to a customer, this does nothing. If this type of * payment method cannot be saved to a customer, the request will error. * - *

_Note that saving a payment method using this parameter does not guarantee that the payment - * method can be charged._ To ensure that only payment methods which can be charged are saved to a - * customer, you can [manually - * save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method - * in response to the [`payment_intent.succeeded` - * webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded). + *

Note that saving a payment method using this parameter does not guarantee that the + * payment method can be charged. To ensure that only payment methods which can be charged + * are saved to a customer, you can manually save + * the payment method in response to the {@code + * payment_intent.succeeded} webhook. */ @SerializedName("save_payment_method") Boolean savePaymentMethod; @@ -186,20 +197,20 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

For more, learn to [save card details after a - * payment](https://stripe.com/docs/payments/save-after-payment). + *

For more, learn to save card + * details after a payment. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure - * that they are authenticated while processing this PaymentIntent. You will then be able to - * collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and comply + * with regional legislation and network rules. For example, if your customer is impacted by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. */ @SerializedName("setup_future_usage") SetupFutureUsage setupFutureUsage; @@ -210,13 +221,14 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * This is a legacy field that will be removed in the future. It is the ID of the Source object to - * attach to this PaymentIntent. Please use the `payment_method` field instead, which also - * supports Cards and [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) objects.If neither the - * `payment_method` parameter nor the `source` parameter are provided with `confirm=true`, this - * field will be automatically populated with `customer.default_source` to improve the migration - * experience for users of the Charges API. We recommend that you explicitly provide the `source` - * or `payment_method` parameter going forward. + * attach to this PaymentIntent. Please use the {@code payment_method} field instead, which also + * supports Cards and compatible Source + * objects.If neither the {@code payment_method} parameter nor the {@code source} parameter are + * provided with {@code confirm=true}, this field will be automatically populated with {@code + * customer.default_source} to improve the migration experience for users of the Charges API. We + * recommend that you explicitly provide the {@code source} or {@code payment_method} parameter + * going forward. */ @SerializedName("source") String source; @@ -238,21 +250,22 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * The parameters used to automatically create a Transfer when the payment succeeds. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected accounts. */ @SerializedName("transfer_data") TransferData transferData; /** - * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use - * case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts + * for details. */ @SerializedName("transfer_group") String transferGroup; /** - * Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle + * Set to {@code true} only when using manual confirmation and the iOS or Android SDKs to handle * additional authentication steps. */ @SerializedName("use_stripe_sdk") @@ -423,12 +436,12 @@ public PaymentIntentCreateParams build() { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how - * much to charge in the [smallest currency - * unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or - * 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent - * in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). - * The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of - * $999,999.99). + * much to charge in the smallest + * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal + * currency). The minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ public Builder setAmount(Long amount) { this.amount = amount; @@ -438,8 +451,8 @@ public Builder setAmount(Long amount) { /** * The amount of the application fee (if any) that will be applied to the payment and * transferred to the application owner's Stripe account. For more information, see the - * PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * PaymentIntents use case for + * connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -453,10 +466,12 @@ public Builder setCaptureMethod(CaptureMethod captureMethod) { } /** - * Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) - * this PaymentIntent immediately. This parameter defaults to `false`. When creating and - * confirming a PaymentIntent at the same time, parameters available in the - * [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. + * Set to {@code true} to attempt to confirm this PaymentIntent + * immediately. This parameter defaults to {@code false}. When creating and confirming a + * PaymentIntent at the same time, parameters available in the confirm API may also be + * provided. */ public Builder setConfirm(Boolean confirm) { this.confirm = confirm; @@ -469,8 +484,9 @@ public Builder setConfirmationMethod(ConfirmationMethod confirmationMethod) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -496,9 +512,9 @@ public Builder setDescription(String description) { } /** - * Set to `true` to fail the payment attempt if the PaymentIntent transitions into - * `requires_action`. This parameter is intended for simpler integrations that do not handle - * customer actions. This can only be set when `confirm=true` is supplied. + * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code + * requires_action}. This parameter is intended for simpler integrations that do not handle + * customer actions. This can only be set when {@code confirm=true} is supplied. */ public Builder setErrorOnRequiresAction(Boolean errorOnRequiresAction) { this.errorOnRequiresAction = errorOnRequiresAction; @@ -558,8 +574,9 @@ public Builder putAllExtraParam(Map map) { } /** - * ID of the mandate to be used for this payment. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * ID of the mandate to be used for this payment. This parameter can only be used with {@code + * confirm=true}. */ public Builder setMandate(String mandate) { this.mandate = mandate; @@ -568,7 +585,9 @@ public Builder setMandate(String mandate) { /** * This hash contains details about the Mandate to create. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * {@code + * confirm=true}. */ public Builder setMandateData(MandateData mandateData) { this.mandateData = mandateData; @@ -602,12 +621,13 @@ public Builder putAllMetadata(Map map) { } /** - * Set to `true` to indicate that the customer is not in your checkout flow during this payment - * attempt, and therefore is unable to authenticate. This parameter is intended for scenarios - * where you collect card details and [charge them - * later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only - * be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * Set to {@code true} to indicate that the customer is not in your checkout flow during this + * payment attempt, and therefore is unable to authenticate. This parameter is intended for + * scenarios where you collect card details and charge them later. + * This parameter can only be used with {@code + * confirm=true}. */ public Builder setOffSession(Boolean offSession) { this.offSession = offSession; @@ -615,12 +635,13 @@ public Builder setOffSession(Boolean offSession) { } /** - * Set to `true` to indicate that the customer is not in your checkout flow during this payment - * attempt, and therefore is unable to authenticate. This parameter is intended for scenarios - * where you collect card details and [charge them - * later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only - * be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * Set to {@code true} to indicate that the customer is not in your checkout flow during this + * payment attempt, and therefore is unable to authenticate. This parameter is intended for + * scenarios where you collect card details and charge them later. + * This parameter can only be used with {@code + * confirm=true}. */ public Builder setOffSession(OffSession offSession) { this.offSession = offSession; @@ -629,7 +650,8 @@ public Builder setOffSession(OffSession offSession) { /** * The Stripe account ID for which these funds are intended. For details, see the PaymentIntents - * [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * use case for connected + * accounts. */ public Builder setOnBehalfOf(String onBehalfOf) { this.onBehalfOf = onBehalfOf; @@ -637,14 +659,14 @@ public Builder setOnBehalfOf(String onBehalfOf) { } /** - * ID of the payment method (a PaymentMethod, Card, or [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to - * this PaymentIntent. + * ID of the payment method (a PaymentMethod, Card, or compatible Source + * object) to attach to this PaymentIntent. * - *

If neither the `payment_method` parameter nor the `source` parameter are provided with - * `confirm=true`, `source` will be automatically populated with `customer.default_source` to - * improve the migration experience for users of the Charges API. We recommend that you - * explicitly provide the `payment_method` going forward. + *

If neither the {@code payment_method} parameter nor the {@code source} parameter are + * provided with {@code confirm=true}, {@code source} will be automatically populated with + * {@code customer.default_source} to improve the migration experience for users of the Charges + * API. We recommend that you explicitly provide the {@code payment_method} going forward. */ public Builder setPaymentMethod(String paymentMethod) { this.paymentMethod = paymentMethod; @@ -692,8 +714,9 @@ public Builder setReceiptEmail(String receiptEmail) { /** * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. If you'd prefer to redirect to a mobile application, you - * can alternatively supply an application URI scheme. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + * can alternatively supply an application URI scheme. This parameter can only be used with {@code + * confirm=true}. */ public Builder setReturnUrl(String returnUrl) { this.returnUrl = returnUrl; @@ -701,19 +724,21 @@ public Builder setReturnUrl(String returnUrl) { } /** - * If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment - * method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save - * the payment method to the customer. Defaults to `false`. + * If the PaymentIntent has a {@code payment_method} and a {@code customer} or if you're + * attaching a payment method to the PaymentIntent in this request, you can pass {@code + * save_payment_method=true} to save the payment method to the customer. Defaults to {@code + * false}. * *

If the payment method is already saved to a customer, this does nothing. If this type of * payment method cannot be saved to a customer, the request will error. * - *

_Note that saving a payment method using this parameter does not guarantee that the - * payment method can be charged._ To ensure that only payment methods which can be charged are - * saved to a customer, you can [manually - * save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method - * in response to the [`payment_intent.succeeded` - * webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded). + *

Note that saving a payment method using this parameter does not guarantee that the + * payment method can be charged. To ensure that only payment methods which can be charged + * are saved to a customer, you can manually save + * the payment method in response to the {@code + * payment_intent.succeeded} webhook. */ public Builder setSavePaymentMethod(Boolean savePaymentMethod) { this.savePaymentMethod = savePaymentMethod; @@ -723,20 +748,20 @@ public Builder setSavePaymentMethod(Boolean savePaymentMethod) { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

For more, learn to [save card details after a - * payment](https://stripe.com/docs/payments/save-after-payment). + *

For more, learn to save card + * details after a payment. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will - * ensure that they are authenticated while processing this PaymentIntent. You will then be able - * to collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and + * comply with regional legislation and network rules. For example, if your customer is impacted + * by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. */ public Builder setSetupFutureUsage(SetupFutureUsage setupFutureUsage) { this.setupFutureUsage = setupFutureUsage; @@ -751,13 +776,14 @@ public Builder setShipping(Shipping shipping) { /** * This is a legacy field that will be removed in the future. It is the ID of the Source object - * to attach to this PaymentIntent. Please use the `payment_method` field instead, which also - * supports Cards and [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) objects.If neither - * the `payment_method` parameter nor the `source` parameter are provided with `confirm=true`, - * this field will be automatically populated with `customer.default_source` to improve the - * migration experience for users of the Charges API. We recommend that you explicitly provide - * the `source` or `payment_method` parameter going forward. + * to attach to this PaymentIntent. Please use the {@code payment_method} field instead, which + * also supports Cards and compatible Source + * objects.If neither the {@code payment_method} parameter nor the {@code source} parameter are + * provided with {@code confirm=true}, this field will be automatically populated with {@code + * customer.default_source} to improve the migration experience for users of the Charges API. We + * recommend that you explicitly provide the {@code source} or {@code payment_method} parameter + * going forward. */ public Builder setSource(String source) { this.source = source; @@ -786,8 +812,9 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * The parameters used to automatically create a Transfer when the payment succeeds. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected + * accounts. */ public Builder setTransferData(TransferData transferData) { this.transferData = transferData; @@ -795,9 +822,9 @@ public Builder setTransferData(TransferData transferData) { } /** - * A string that identifies the resulting payment as part of a group. See the PaymentIntents - * [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for - * details. + * A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected + * accounts for details. */ public Builder setTransferGroup(String transferGroup) { this.transferGroup = transferGroup; @@ -805,7 +832,7 @@ public Builder setTransferGroup(String transferGroup) { } /** - * Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle + * Set to {@code true} only when using manual confirmation and the iOS or Android SDKs to handle * additional authentication steps. */ public Builder setUseStripeSdk(Boolean useStripeSdk) { @@ -911,8 +938,8 @@ public static class CustomerAcceptance { Online online; /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ @SerializedName("type") Type type; @@ -1004,8 +1031,8 @@ public Builder setOnline(Online online) { } /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ public Builder setType(Type type) { this.type = type; @@ -1258,8 +1285,8 @@ public static class Card { /** * Installment configuration for payments attempted on this PaymentIntent (Mexico Only). * - *

For more information, see the [installments integration - * guide](https://stripe.com/docs/payments/installments). + *

For more information, see the installments integration guide. */ @SerializedName("installments") Installments installments; @@ -1274,13 +1301,14 @@ public static class Card { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish - * to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on - * how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our SCA + * Engine. */ @SerializedName("request_three_d_secure") RequestThreeDSecure requestThreeDSecure; @@ -1345,8 +1373,8 @@ public Builder putAllExtraParam(Map map) { /** * Installment configuration for payments attempted on this PaymentIntent (Mexico Only). * - *

For more information, see the [installments integration - * guide](https://stripe.com/docs/payments/installments). + *

For more information, see the installments integration guide. */ public Builder setInstallments(Installments installments) { this.installments = installments; @@ -1365,13 +1393,14 @@ public Builder setMoto(Boolean moto) { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you - * wish to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information - * on how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our + * SCA Engine. */ public Builder setRequestThreeDSecure(RequestThreeDSecure requestThreeDSecure) { this.requestThreeDSecure = requestThreeDSecure; @@ -1490,8 +1519,8 @@ public Builder setPlan(EmptyParam plan) { @Getter public static class Plan { /** - * For `fixed_count` installment plans, this is the number of installment payments your - * customer will make to their credit card. + * For {@code fixed_count} installment plans, this is the number of installment payments + * your customer will make to their credit card. */ @SerializedName("count") Long count; @@ -1507,13 +1536,13 @@ public static class Plan { Map extraParams; /** - * For `fixed_count` installment plans, this is the interval between installment payments - * your customer will make to their credit card. One of `month`. + * For {@code fixed_count} installment plans, this is the interval between installment + * payments your customer will make to their credit card. One of {@code month}. */ @SerializedName("interval") Interval interval; - /** Type of installment plan, one of `fixed_count`. */ + /** Type of installment plan, one of {@code fixed_count}. */ @SerializedName("type") Type type; @@ -1543,8 +1572,8 @@ public Plan build() { } /** - * For `fixed_count` installment plans, this is the number of installment payments your - * customer will make to their credit card. + * For {@code fixed_count} installment plans, this is the number of installment payments + * your customer will make to their credit card. */ public Builder setCount(Long count) { this.count = count; @@ -1582,15 +1611,15 @@ public Builder putAllExtraParam(Map map) { } /** - * For `fixed_count` installment plans, this is the interval between installment - * payments your customer will make to their credit card. One of `month`. + * For {@code fixed_count} installment plans, this is the interval between installment + * payments your customer will make to their credit card. One of {@code month}. */ public Builder setInterval(Interval interval) { this.interval = interval; return this; } - /** Type of installment plan, one of `fixed_count`. */ + /** Type of installment plan, one of {@code fixed_count}. */ public Builder setType(Type type) { this.type = type; return this; @@ -1784,8 +1813,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1870,8 +1899,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1940,8 +1969,8 @@ public static class TransferData { * capped at the total transaction amount and if no amount is set, the full amount is * transferred. * - *

If you intend to collect a fee and you need a more robust reporting experience, using - * [application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount) + *

If you intend to collect a fee and you need a more robust reporting experience, using application_fee_amount * might be a better fit for your integration. */ @SerializedName("amount") @@ -1950,7 +1979,7 @@ public static class TransferData { /** * If specified, successful charges will be attributed to the destination account for tax * reporting, and the funds from charges will be transferred to the destination account. The ID - * of the resulting transfer will be returned on the successful charge's `transfer` field. + * of the resulting transfer will be returned on the successful charge's {@code transfer} field. */ @SerializedName("destination") String destination; @@ -1991,8 +2020,8 @@ public TransferData build() { * capped at the total transaction amount and if no amount is set, the full amount is * transferred. * - *

If you intend to collect a fee and you need a more robust reporting experience, using - * [application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount) + *

If you intend to collect a fee and you need a more robust reporting experience, using application_fee_amount * might be a better fit for your integration. */ public Builder setAmount(Long amount) { @@ -2003,7 +2032,8 @@ public Builder setAmount(Long amount) { /** * If specified, successful charges will be attributed to the destination account for tax * reporting, and the funds from charges will be transferred to the destination account. The - * ID of the resulting transfer will be returned on the successful charge's `transfer` field. + * ID of the resulting transfer will be returned on the successful charge's {@code transfer} + * field. */ public Builder setDestination(String destination) { this.destination = destination; diff --git a/src/main/java/com/stripe/param/PaymentIntentListParams.java b/src/main/java/com/stripe/param/PaymentIntentListParams.java index e58672c5344..e740922eb05 100644 --- a/src/main/java/com/stripe/param/PaymentIntentListParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentListParams.java @@ -11,8 +11,8 @@ @Getter public class PaymentIntentListParams extends ApiRequestParams { /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string with + * an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ @SerializedName("created") Object created; @@ -22,10 +22,10 @@ public class PaymentIntentListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -51,10 +51,10 @@ public class PaymentIntentListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -108,8 +108,9 @@ public PaymentIntentListParams build() { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Created created) { this.created = created; @@ -117,8 +118,9 @@ public Builder setCreated(Created created) { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Long created) { this.created = created; @@ -132,10 +134,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -204,10 +206,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java b/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java index 02ead63e3d2..964a1e92f76 100644 --- a/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java @@ -14,26 +14,27 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how much - * to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) - * (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum - * amount is $0.50 US or [equivalent in charge - * currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount - * value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). + * to charge in the smallest currency + * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The + * minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ @SerializedName("amount") Long amount; /** - * The amount of the application fee (if any) for the resulting payment. See the PaymentIntents - * [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for - * details. + * The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts + * for details. */ @SerializedName("application_fee_amount") Object applicationFeeAmount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") Object currency; @@ -68,15 +69,16 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * ID of the payment method (a PaymentMethod, Card, or [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to - * this PaymentIntent. + * ID of the payment method (a PaymentMethod, Card, or compatible Source + * object) to attach to this PaymentIntent. */ @SerializedName("payment_method") Object paymentMethod; @@ -90,19 +92,21 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { Object receiptEmail; /** - * If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment - * method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save - * the payment method to the customer. Defaults to `false`. + * If the PaymentIntent has a {@code payment_method} and a {@code customer} or if you're attaching + * a payment method to the PaymentIntent in this request, you can pass {@code + * save_payment_method=true} to save the payment method to the customer. Defaults to {@code + * false}. * *

If the payment method is already saved to a customer, this does nothing. If this type of * payment method cannot be saved to a customer, the request will error. * - *

_Note that saving a payment method using this parameter does not guarantee that the payment - * method can be charged._ To ensure that only payment methods which can be charged are saved to a - * customer, you can [manually - * save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method - * in response to the [`payment_intent.succeeded` - * webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded). + *

Note that saving a payment method using this parameter does not guarantee that the + * payment method can be charged. To ensure that only payment methods which can be charged + * are saved to a customer, you can manually save + * the payment method in response to the {@code + * payment_intent.succeeded} webhook. */ @SerializedName("save_payment_method") Boolean savePaymentMethod; @@ -110,24 +114,24 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

Use `on_session` if you intend to only reuse the payment method when your customer is - * present in your checkout flow. Use `off_session` if your customer may or may not be in your - * checkout flow. + *

Use {@code on_session} if you intend to only reuse the payment method when your customer is + * present in your checkout flow. Use {@code off_session} if your customer may or may not be in + * your checkout flow. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure - * that they are authenticated while processing this PaymentIntent. You will then be able to - * collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and comply + * with regional legislation and network rules. For example, if your customer is impacted by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. * - *

If `setup_future_usage` is already set and you are performing a request using a publishable - * key, you may only update the value from `on_session` to `off_session`. + *

If {@code setup_future_usage} is already set and you are performing a request using a + * publishable key, you may only update the value from {@code on_session} to {@code off_session}. */ @SerializedName("setup_future_usage") EnumParam setupFutureUsage; @@ -138,9 +142,10 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * This is a legacy field that will be removed in the future. It is the ID of the Source object to - * attach to this PaymentIntent. Please use the `payment_method` field instead, which also - * supports Cards and [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) objects. + * attach to this PaymentIntent. Please use the {@code payment_method} field instead, which also + * supports Cards and compatible Source + * objects. */ @SerializedName("source") Object source; @@ -162,16 +167,17 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * The parameters used to automatically create a Transfer when the payment succeeds. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected accounts. */ @SerializedName("transfer_data") TransferData transferData; /** - * A string that identifies the resulting payment as part of a group. `transfer_group` may only be - * provided if it has not been set. See the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * A string that identifies the resulting payment as part of a group. {@code transfer_group} may + * only be provided if it has not been set. See the PaymentIntents use case for connected accounts + * for details. */ @SerializedName("transfer_group") Object transferGroup; @@ -286,12 +292,12 @@ public PaymentIntentUpdateParams build() { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how - * much to charge in the [smallest currency - * unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or - * 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent - * in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). - * The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of - * $999,999.99). + * much to charge in the smallest + * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal + * currency). The minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ public Builder setAmount(Long amount) { this.amount = amount; @@ -300,8 +306,8 @@ public Builder setAmount(Long amount) { /** * The amount of the application fee (if any) for the resulting payment. See the PaymentIntents - * [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for - * details. + * use case for connected + * accounts for details. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -310,8 +316,8 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { /** * The amount of the application fee (if any) for the resulting payment. See the PaymentIntents - * [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for - * details. + * use case for connected + * accounts for details. */ public Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -319,8 +325,9 @@ public Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -328,8 +335,9 @@ public Builder setCurrency(String currency) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(EmptyParam currency) { this.currency = currency; @@ -451,9 +459,9 @@ public Builder putAllMetadata(Map map) { } /** - * ID of the payment method (a PaymentMethod, Card, or [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to - * this PaymentIntent. + * ID of the payment method (a PaymentMethod, Card, or compatible Source + * object) to attach to this PaymentIntent. */ public Builder setPaymentMethod(String paymentMethod) { this.paymentMethod = paymentMethod; @@ -461,9 +469,9 @@ public Builder setPaymentMethod(String paymentMethod) { } /** - * ID of the payment method (a PaymentMethod, Card, or [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to - * this PaymentIntent. + * ID of the payment method (a PaymentMethod, Card, or compatible Source + * object) to attach to this PaymentIntent. */ public Builder setPaymentMethod(EmptyParam paymentMethod) { this.paymentMethod = paymentMethod; @@ -509,19 +517,21 @@ public Builder setReceiptEmail(EmptyParam receiptEmail) { } /** - * If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment - * method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save - * the payment method to the customer. Defaults to `false`. + * If the PaymentIntent has a {@code payment_method} and a {@code customer} or if you're + * attaching a payment method to the PaymentIntent in this request, you can pass {@code + * save_payment_method=true} to save the payment method to the customer. Defaults to {@code + * false}. * *

If the payment method is already saved to a customer, this does nothing. If this type of * payment method cannot be saved to a customer, the request will error. * - *

_Note that saving a payment method using this parameter does not guarantee that the - * payment method can be charged._ To ensure that only payment methods which can be charged are - * saved to a customer, you can [manually - * save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method - * in response to the [`payment_intent.succeeded` - * webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded). + *

Note that saving a payment method using this parameter does not guarantee that the + * payment method can be charged. To ensure that only payment methods which can be charged + * are saved to a customer, you can manually save + * the payment method in response to the {@code + * payment_intent.succeeded} webhook. */ public Builder setSavePaymentMethod(Boolean savePaymentMethod) { this.savePaymentMethod = savePaymentMethod; @@ -531,24 +541,25 @@ public Builder setSavePaymentMethod(Boolean savePaymentMethod) { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

Use `on_session` if you intend to only reuse the payment method when your customer is - * present in your checkout flow. Use `off_session` if your customer may or may not be in your - * checkout flow. + *

Use {@code on_session} if you intend to only reuse the payment method when your customer + * is present in your checkout flow. Use {@code off_session} if your customer may or may not be + * in your checkout flow. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will - * ensure that they are authenticated while processing this PaymentIntent. You will then be able - * to collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and + * comply with regional legislation and network rules. For example, if your customer is impacted + * by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. * - *

If `setup_future_usage` is already set and you are performing a request using a - * publishable key, you may only update the value from `on_session` to `off_session`. + *

If {@code setup_future_usage} is already set and you are performing a request using a + * publishable key, you may only update the value from {@code on_session} to {@code + * off_session}. */ public Builder setSetupFutureUsage(SetupFutureUsage setupFutureUsage) { this.setupFutureUsage = setupFutureUsage; @@ -558,24 +569,25 @@ public Builder setSetupFutureUsage(SetupFutureUsage setupFutureUsage) { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

Use `on_session` if you intend to only reuse the payment method when your customer is - * present in your checkout flow. Use `off_session` if your customer may or may not be in your - * checkout flow. + *

Use {@code on_session} if you intend to only reuse the payment method when your customer + * is present in your checkout flow. Use {@code off_session} if your customer may or may not be + * in your checkout flow. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will - * ensure that they are authenticated while processing this PaymentIntent. You will then be able - * to collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and + * comply with regional legislation and network rules. For example, if your customer is impacted + * by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. * - *

If `setup_future_usage` is already set and you are performing a request using a - * publishable key, you may only update the value from `on_session` to `off_session`. + *

If {@code setup_future_usage} is already set and you are performing a request using a + * publishable key, you may only update the value from {@code on_session} to {@code + * off_session}. */ public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) { this.setupFutureUsage = setupFutureUsage; @@ -596,9 +608,10 @@ public Builder setShipping(EmptyParam shipping) { /** * This is a legacy field that will be removed in the future. It is the ID of the Source object - * to attach to this PaymentIntent. Please use the `payment_method` field instead, which also - * supports Cards and [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) objects. + * to attach to this PaymentIntent. Please use the {@code payment_method} field instead, which + * also supports Cards and compatible Source + * objects. */ public Builder setSource(String source) { this.source = source; @@ -607,9 +620,10 @@ public Builder setSource(String source) { /** * This is a legacy field that will be removed in the future. It is the ID of the Source object - * to attach to this PaymentIntent. Please use the `payment_method` field instead, which also - * supports Cards and [compatible - * Source](https://stripe.com/docs/payments/payment-methods#compatibility) objects. + * to attach to this PaymentIntent. Please use the {@code payment_method} field instead, which + * also supports Cards and compatible Source + * objects. */ public Builder setSource(EmptyParam source) { this.source = source; @@ -658,8 +672,9 @@ public Builder setStatementDescriptorSuffix(EmptyParam statementDescriptorSuffix /** * The parameters used to automatically create a Transfer when the payment succeeds. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected + * accounts. */ public Builder setTransferData(TransferData transferData) { this.transferData = transferData; @@ -667,9 +682,10 @@ public Builder setTransferData(TransferData transferData) { } /** - * A string that identifies the resulting payment as part of a group. `transfer_group` may only - * be provided if it has not been set. See the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * A string that identifies the resulting payment as part of a group. {@code transfer_group} may + * only be provided if it has not been set. See the PaymentIntents use case for connected + * accounts for details. */ public Builder setTransferGroup(String transferGroup) { this.transferGroup = transferGroup; @@ -677,9 +693,10 @@ public Builder setTransferGroup(String transferGroup) { } /** - * A string that identifies the resulting payment as part of a group. `transfer_group` may only - * be provided if it has not been set. See the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * A string that identifies the resulting payment as part of a group. {@code transfer_group} may + * only be provided if it has not been set. See the PaymentIntents use case for connected + * accounts for details. */ public Builder setTransferGroup(EmptyParam transferGroup) { this.transferGroup = transferGroup; @@ -858,8 +875,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -950,8 +967,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -959,8 +976,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; diff --git a/src/main/java/com/stripe/param/PaymentMethodCreateParams.java b/src/main/java/com/stripe/param/PaymentMethodCreateParams.java index 7edc5a947ec..c131e432149 100644 --- a/src/main/java/com/stripe/param/PaymentMethodCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodCreateParams.java @@ -11,7 +11,8 @@ @Getter public class PaymentMethodCreateParams extends ApiRequestParams { /** - * If this is a `au_becs_debit` PaymentMethod, this hash contains details about the bank account. + * If this is a {@code au_becs_debit} PaymentMethod, this hash contains details about the bank + * account. */ @SerializedName("au_becs_debit") AuBecsDebit auBecsDebit; @@ -24,17 +25,17 @@ public class PaymentMethodCreateParams extends ApiRequestParams { BillingDetails billingDetails; /** - * If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards - * compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express - * Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When - * creating with a card number, you must meet the requirements for [PCI - * compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend - * using Stripe.js instead of interacting with this API directly. + * If this is a {@code card} PaymentMethod, this hash contains the user's card details. For + * backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, + * Amex Express Checkout, or legacy Checkout) into the card hash with format {@code card: {token: + * "tok_visa"}}. When creating with a card number, you must meet the requirements for PCI compliance. We + * strongly recommend using Stripe.js instead of interacting with this API directly. */ @SerializedName("card") Object card; - /** The `Customer` to whom the original PaymentMethod is attached. */ + /** The {@code Customer} to whom the original PaymentMethod is attached. */ @SerializedName("customer") String customer; @@ -51,12 +52,16 @@ public class PaymentMethodCreateParams extends ApiRequestParams { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. */ + /** + * If this is an {@code fpx} PaymentMethod, this hash contains details about the FPX payment + * method. + */ @SerializedName("fpx") Fpx fpx; /** - * If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. + * If this is an {@code ideal} PaymentMethod, this hash contains details about the iDEAL payment + * method. */ @SerializedName("ideal") Ideal ideal; @@ -64,7 +69,8 @@ public class PaymentMethodCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -74,8 +80,8 @@ public class PaymentMethodCreateParams extends ApiRequestParams { String paymentMethod; /** - * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank - * account. + * If this is a {@code sepa_debit} PaymentMethod, this hash contains details about the SEPA debit + * bank account. */ @SerializedName("sepa_debit") SepaDebit sepaDebit; @@ -83,9 +89,9 @@ public class PaymentMethodCreateParams extends ApiRequestParams { /** * The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name * matching this value. It contains additional information specific to the PaymentMethod type. - * Required unless `payment_method` is specified (see the [Cloning - * PaymentMethods](https://stripe.com/docs/payments/payment-methods/connect#cloning-payment-methods) - * guide) + * Required unless {@code payment_method} is specified (see the Cloning + * PaymentMethods guide) */ @SerializedName("type") Type type; @@ -164,7 +170,7 @@ public PaymentMethodCreateParams build() { } /** - * If this is a `au_becs_debit` PaymentMethod, this hash contains details about the bank + * If this is a {@code au_becs_debit} PaymentMethod, this hash contains details about the bank * account. */ public Builder setAuBecsDebit(AuBecsDebit auBecsDebit) { @@ -182,12 +188,12 @@ public Builder setBillingDetails(BillingDetails billingDetails) { } /** - * If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards - * compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex - * Express Checkout, or legacy Checkout) into the card hash with format `card: {token: - * "tok_visa"}`. When creating with a card number, you must meet the requirements for [PCI - * compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly - * recommend using Stripe.js instead of interacting with this API directly. + * If this is a {@code card} PaymentMethod, this hash contains the user's card details. For + * backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, + * Amex Express Checkout, or legacy Checkout) into the card hash with format {@code card: + * {token: "tok_visa"}}. When creating with a card number, you must meet the requirements for PCI compliance. We + * strongly recommend using Stripe.js instead of interacting with this API directly. */ public Builder setCard(CardDetails card) { this.card = card; @@ -195,19 +201,19 @@ public Builder setCard(CardDetails card) { } /** - * If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards - * compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex - * Express Checkout, or legacy Checkout) into the card hash with format `card: {token: - * "tok_visa"}`. When creating with a card number, you must meet the requirements for [PCI - * compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly - * recommend using Stripe.js instead of interacting with this API directly. + * If this is a {@code card} PaymentMethod, this hash contains the user's card details. For + * backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, + * Amex Express Checkout, or legacy Checkout) into the card hash with format {@code card: + * {token: "tok_visa"}}. When creating with a card number, you must meet the requirements for PCI compliance. We + * strongly recommend using Stripe.js instead of interacting with this API directly. */ public Builder setCard(Token card) { this.card = card; return this; } - /** The `Customer` to whom the original PaymentMethod is attached. */ + /** The {@code Customer} to whom the original PaymentMethod is attached. */ public Builder setCustomer(String customer) { this.customer = customer; return this; @@ -266,7 +272,8 @@ public Builder putAllExtraParam(Map map) { } /** - * If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. + * If this is an {@code fpx} PaymentMethod, this hash contains details about the FPX payment + * method. */ public Builder setFpx(Fpx fpx) { this.fpx = fpx; @@ -274,7 +281,7 @@ public Builder setFpx(Fpx fpx) { } /** - * If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment + * If this is an {@code ideal} PaymentMethod, this hash contains details about the iDEAL payment * method. */ public Builder setIdeal(Ideal ideal) { @@ -315,8 +322,8 @@ public Builder setPaymentMethod(String paymentMethod) { } /** - * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank - * account. + * If this is a {@code sepa_debit} PaymentMethod, this hash contains details about the SEPA + * debit bank account. */ public Builder setSepaDebit(SepaDebit sepaDebit) { this.sepaDebit = sepaDebit; @@ -326,9 +333,9 @@ public Builder setSepaDebit(SepaDebit sepaDebit) { /** * The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a * name matching this value. It contains additional information specific to the PaymentMethod - * type. Required unless `payment_method` is specified (see the [Cloning - * PaymentMethods](https://stripe.com/docs/payments/payment-methods/connect#cloning-payment-methods) - * guide) + * type. Required unless {@code payment_method} is specified (see the Cloning + * PaymentMethods guide) */ public Builder setType(Type type) { this.type = type; @@ -529,8 +536,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -615,8 +622,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; diff --git a/src/main/java/com/stripe/param/PaymentMethodListParams.java b/src/main/java/com/stripe/param/PaymentMethodListParams.java index 0a285079c64..692a520b27f 100644 --- a/src/main/java/com/stripe/param/PaymentMethodListParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodListParams.java @@ -15,10 +15,10 @@ public class PaymentMethodListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -44,15 +44,15 @@ public class PaymentMethodListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; - /** A required filter on the list, based on the object `type` field. */ + /** A required filter on the list, based on the object {@code type} field. */ @SerializedName("type") Type type; @@ -111,10 +111,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -183,17 +183,17 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; return this; } - /** A required filter on the list, based on the object `type` field. */ + /** A required filter on the list, based on the object {@code type} field. */ public Builder setType(Type type) { this.type = type; return this; diff --git a/src/main/java/com/stripe/param/PaymentMethodUpdateParams.java b/src/main/java/com/stripe/param/PaymentMethodUpdateParams.java index 8ca3a5fcf8a..92e2016875c 100644 --- a/src/main/java/com/stripe/param/PaymentMethodUpdateParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodUpdateParams.java @@ -18,7 +18,7 @@ public class PaymentMethodUpdateParams extends ApiRequestParams { @SerializedName("billing_details") BillingDetails billingDetails; - /** If this is a `card` PaymentMethod, this hash contains the user's card details. */ + /** If this is a {@code card} PaymentMethod, this hash contains the user's card details. */ @SerializedName("card") Card card; @@ -38,14 +38,15 @@ public class PaymentMethodUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank - * account. + * If this is a {@code sepa_debit} PaymentMethod, this hash contains details about the SEPA debit + * bank account. */ @SerializedName("sepa_debit") SepaDebit sepaDebit; @@ -102,7 +103,7 @@ public Builder setBillingDetails(BillingDetails billingDetails) { return this; } - /** If this is a `card` PaymentMethod, this hash contains the user's card details. */ + /** If this is a {@code card} PaymentMethod, this hash contains the user's card details. */ public Builder setCard(Card card) { this.card = card; return this; @@ -187,8 +188,8 @@ public Builder putAllMetadata(Map map) { } /** - * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank - * account. + * If this is a {@code sepa_debit} PaymentMethod, this hash contains details about the SEPA + * debit bank account. */ public Builder setSepaDebit(SepaDebit sepaDebit) { this.sepaDebit = sepaDebit; @@ -330,8 +331,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -422,8 +423,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -431,8 +432,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; diff --git a/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java b/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java index 852ed7ae7df..aba3cfa69bd 100644 --- a/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java @@ -26,12 +26,13 @@ public class PaymentSourceCollectionCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; - /** Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** Please refer to full documentation instead. */ @SerializedName("source") String source; @@ -143,7 +144,7 @@ public Builder putAllMetadata(Map map) { return this; } - /** Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** Please refer to full documentation instead. */ public Builder setSource(String source) { this.source = source; return this; diff --git a/src/main/java/com/stripe/param/PaymentSourceCollectionListParams.java b/src/main/java/com/stripe/param/PaymentSourceCollectionListParams.java index 4f35dc24843..930abab4c23 100644 --- a/src/main/java/com/stripe/param/PaymentSourceCollectionListParams.java +++ b/src/main/java/com/stripe/param/PaymentSourceCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class PaymentSourceCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -44,10 +44,10 @@ public class PaymentSourceCollectionListParams extends ApiRequestParams { String object; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -96,10 +96,10 @@ public PaymentSourceCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -174,10 +174,10 @@ public Builder setObject(String object) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/PayoutCreateParams.java b/src/main/java/com/stripe/param/PayoutCreateParams.java index 5b36ab3a8b9..6b3323f2091 100644 --- a/src/main/java/com/stripe/param/PayoutCreateParams.java +++ b/src/main/java/com/stripe/param/PayoutCreateParams.java @@ -15,8 +15,8 @@ public class PayoutCreateParams extends ApiRequestParams { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -48,15 +48,17 @@ public class PayoutCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * The method used to send this payout, which can be `standard` or `instant`. `instant` is only - * supported for payouts to debit cards. (See [Instant payouts for marketplaces for more - * information](https://stripe.com/blog/instant-payouts-for-marketplaces).) + * The method used to send this payout, which can be {@code standard} or {@code instant}. {@code + * instant} is only supported for payouts to debit cards. (See Instant payouts for + * marketplaces for more information.) */ @SerializedName("method") Method method; @@ -64,16 +66,16 @@ public class PayoutCreateParams extends ApiRequestParams { /** * The balance type of your Stripe balance to draw this payout from. Balances for different * payment sources are kept separately. You can find the amounts with the balances API. One of - * `bank_account` or `card`. + * {@code bank_account} or {@code card}. */ @SerializedName("source_type") SourceType sourceType; /** * A string to be displayed on the recipient's bank or card statement. This may be at most 22 - * characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an - * error. Note: Most banks will truncate this information and/or display it inconsistently. Some - * may not display it at all. + * characters. Attempting to use a {@code statement_descriptor} longer than 22 characters will + * return an error. Note: Most banks will truncate this information and/or display it + * inconsistently. Some may not display it at all. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -148,8 +150,9 @@ public Builder setAmount(Long amount) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -250,9 +253,10 @@ public Builder putAllMetadata(Map map) { } /** - * The method used to send this payout, which can be `standard` or `instant`. `instant` is only - * supported for payouts to debit cards. (See [Instant payouts for marketplaces for more - * information](https://stripe.com/blog/instant-payouts-for-marketplaces).) + * The method used to send this payout, which can be {@code standard} or {@code instant}. {@code + * instant} is only supported for payouts to debit cards. (See Instant payouts for + * marketplaces for more information.) */ public Builder setMethod(Method method) { this.method = method; @@ -262,7 +266,7 @@ public Builder setMethod(Method method) { /** * The balance type of your Stripe balance to draw this payout from. Balances for different * payment sources are kept separately. You can find the amounts with the balances API. One of - * `bank_account` or `card`. + * {@code bank_account} or {@code card}. */ public Builder setSourceType(SourceType sourceType) { this.sourceType = sourceType; @@ -271,9 +275,9 @@ public Builder setSourceType(SourceType sourceType) { /** * A string to be displayed on the recipient's bank or card statement. This may be at most 22 - * characters. Attempting to use a `statement_descriptor` longer than 22 characters will return - * an error. Note: Most banks will truncate this information and/or display it inconsistently. - * Some may not display it at all. + * characters. Attempting to use a {@code statement_descriptor} longer than 22 characters will + * return an error. Note: Most banks will truncate this information and/or display it + * inconsistently. Some may not display it at all. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; diff --git a/src/main/java/com/stripe/param/PayoutListParams.java b/src/main/java/com/stripe/param/PayoutListParams.java index 95ca094b81f..7efea1fdfc2 100644 --- a/src/main/java/com/stripe/param/PayoutListParams.java +++ b/src/main/java/com/stripe/param/PayoutListParams.java @@ -21,10 +21,10 @@ public class PayoutListParams extends ApiRequestParams { String destination; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -50,15 +50,18 @@ public class PayoutListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; - /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ + /** + * Only return payouts that have the given status: {@code pending}, {@code paid}, {@code failed}, + * or {@code canceled}. + */ @SerializedName("status") String status; @@ -147,10 +150,10 @@ public Builder setDestination(String destination) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -219,10 +222,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -230,7 +233,8 @@ public Builder setStartingAfter(String startingAfter) { } /** - * Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. + * Only return payouts that have the given status: {@code pending}, {@code paid}, {@code + * failed}, or {@code canceled}. */ public Builder setStatus(String status) { this.status = status; diff --git a/src/main/java/com/stripe/param/PayoutUpdateParams.java b/src/main/java/com/stripe/param/PayoutUpdateParams.java index c30a1c02be8..4c8ee5d01fe 100644 --- a/src/main/java/com/stripe/param/PayoutUpdateParams.java +++ b/src/main/java/com/stripe/param/PayoutUpdateParams.java @@ -26,7 +26,8 @@ public class PayoutUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/PersonCollectionCreateParams.java b/src/main/java/com/stripe/param/PersonCollectionCreateParams.java index b980d659b75..ea441ff403a 100644 --- a/src/main/java/com/stripe/param/PersonCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/PersonCollectionCreateParams.java @@ -57,15 +57,18 @@ public class PersonCollectionCreateParams extends ApiRequestParams { @SerializedName("first_name_kanji") String firstNameKanji; - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ @SerializedName("gender") String gender; /** * The person's ID number, as appropriate for their country. For example, a social security number * in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also - * provide a [PII token provided by - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * provide a PII token provided by + * Stripe.js. */ @SerializedName("id_number") String idNumber; @@ -89,14 +92,15 @@ public class PersonCollectionCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide - * details to the person. + * A person token, used to securely + * provide details to the person. */ @SerializedName("person_token") String personToken; @@ -346,7 +350,10 @@ public Builder setFirstNameKanji(String firstNameKanji) { return this; } - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ public Builder setGender(String gender) { this.gender = gender; return this; @@ -355,8 +362,8 @@ public Builder setGender(String gender) { /** * The person's ID number, as appropriate for their country. For example, a social security * number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you - * can also provide a [PII token provided by - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * can also provide a PII token + * provided by Stripe.js. */ public Builder setIdNumber(String idNumber) { this.idNumber = idNumber; @@ -414,8 +421,8 @@ public Builder putAllMetadata(Map map) { } /** - * A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide - * details to the person. + * A person token, used to securely + * provide details to the person. */ public Builder setPersonToken(String personToken) { this.personToken = personToken; @@ -454,8 +461,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -540,8 +547,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -607,8 +614,8 @@ public static class AddressKana { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -702,8 +709,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -776,8 +783,8 @@ public static class AddressKanji { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -871,8 +878,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1303,9 +1310,10 @@ public Builder putAllExtraParam(Map map) { @Getter public static class AdditionalDocument { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("back") String back; @@ -1320,9 +1328,10 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("front") String front; @@ -1350,9 +1359,10 @@ public AdditionalDocument build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -1388,9 +1398,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -1402,9 +1413,10 @@ public Builder setFront(String front) { @Getter public static class Document { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("back") String back; @@ -1419,9 +1431,10 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("front") String front; @@ -1449,9 +1462,10 @@ public Document build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -1487,9 +1501,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; diff --git a/src/main/java/com/stripe/param/PersonCollectionListParams.java b/src/main/java/com/stripe/param/PersonCollectionListParams.java index b238fe06b72..feddc2ccf40 100644 --- a/src/main/java/com/stripe/param/PersonCollectionListParams.java +++ b/src/main/java/com/stripe/param/PersonCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class PersonCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -47,10 +47,10 @@ public class PersonCollectionListParams extends ApiRequestParams { Relationship relationship; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -99,10 +99,10 @@ public PersonCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -180,10 +180,10 @@ public Builder setRelationship(Relationship relationship) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/PersonUpdateParams.java b/src/main/java/com/stripe/param/PersonUpdateParams.java index af54c3b4d23..ad3143e5768 100644 --- a/src/main/java/com/stripe/param/PersonUpdateParams.java +++ b/src/main/java/com/stripe/param/PersonUpdateParams.java @@ -57,15 +57,18 @@ public class PersonUpdateParams extends ApiRequestParams { @SerializedName("first_name_kanji") Object firstNameKanji; - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ @SerializedName("gender") Object gender; /** * The person's ID number, as appropriate for their country. For example, a social security number * in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also - * provide a [PII token provided by - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * provide a PII token provided by + * Stripe.js. */ @SerializedName("id_number") Object idNumber; @@ -89,14 +92,15 @@ public class PersonUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide - * details to the person. + * A person token, used to securely + * provide details to the person. */ @SerializedName("person_token") Object personToken; @@ -370,13 +374,19 @@ public Builder setFirstNameKanji(EmptyParam firstNameKanji) { return this; } - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ public Builder setGender(String gender) { this.gender = gender; return this; } - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ public Builder setGender(EmptyParam gender) { this.gender = gender; return this; @@ -385,8 +395,8 @@ public Builder setGender(EmptyParam gender) { /** * The person's ID number, as appropriate for their country. For example, a social security * number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you - * can also provide a [PII token provided by - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * can also provide a PII token + * provided by Stripe.js. */ public Builder setIdNumber(String idNumber) { this.idNumber = idNumber; @@ -396,8 +406,8 @@ public Builder setIdNumber(String idNumber) { /** * The person's ID number, as appropriate for their country. For example, a social security * number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you - * can also provide a [PII token provided by - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * can also provide a PII token + * provided by Stripe.js. */ public Builder setIdNumber(EmptyParam idNumber) { this.idNumber = idNumber; @@ -479,8 +489,8 @@ public Builder putAllMetadata(Map map) { } /** - * A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide - * details to the person. + * A person token, used to securely + * provide details to the person. */ public Builder setPersonToken(String personToken) { this.personToken = personToken; @@ -488,8 +498,8 @@ public Builder setPersonToken(String personToken) { } /** - * A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide - * details to the person. + * A person token, used to securely + * provide details to the person. */ public Builder setPersonToken(EmptyParam personToken) { this.personToken = personToken; @@ -540,8 +550,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -632,8 +642,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -641,8 +651,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -732,8 +742,8 @@ public static class AddressKana { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -833,8 +843,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -842,8 +852,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -945,8 +955,8 @@ public static class AddressKanji { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -1046,8 +1056,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1055,8 +1065,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -1520,9 +1530,10 @@ public Builder putAllExtraParam(Map map) { @Getter public static class AdditionalDocument { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("back") Object back; @@ -1537,9 +1548,10 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("front") Object front; @@ -1567,9 +1579,10 @@ public AdditionalDocument build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -1577,9 +1590,10 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(EmptyParam back) { this.back = back; @@ -1615,9 +1629,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -1625,9 +1640,10 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(EmptyParam front) { this.front = front; @@ -1639,9 +1655,10 @@ public Builder setFront(EmptyParam front) { @Getter public static class Document { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("back") Object back; @@ -1656,9 +1673,10 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and less + * than 10 MB in size. */ @SerializedName("front") Object front; @@ -1686,9 +1704,10 @@ public Document build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -1696,9 +1715,10 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(EmptyParam back) { this.back = back; @@ -1734,9 +1754,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -1744,9 +1765,10 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(EmptyParam front) { this.front = front; diff --git a/src/main/java/com/stripe/param/PlanCreateParams.java b/src/main/java/com/stripe/param/PlanCreateParams.java index 74e4b2d7ecb..d51ab7e12c1 100644 --- a/src/main/java/com/stripe/param/PlanCreateParams.java +++ b/src/main/java/com/stripe/param/PlanCreateParams.java @@ -11,16 +11,16 @@ @Getter public class PlanCreateParams extends ApiRequestParams { - /** Whether the plan is currently available for new subscriptions. Defaults to `true`. */ + /** Whether the plan is currently available for new subscriptions. Defaults to {@code true}. */ @SerializedName("active") Boolean active; /** - * Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are - * `sum` for summing up all usage during a period, `last_during_period` for picking the last usage - * record reported within a period, `last_ever` for picking the last usage record ever (across - * period bounds) or `max` which picks the usage record with the maximum reported usage during a - * period. Defaults to `sum`. + * Specifies a usage aggregation strategy for plans of {@code usage_type=metered}. Allowed values + * are {@code sum} for summing up all usage during a period, {@code last_during_period} for + * picking the last usage record reported within a period, {@code last_ever} for picking the last + * usage record ever (across period bounds) or {@code max} which picks the usage record with the + * maximum reported usage during a period. Defaults to {@code sum}. */ @SerializedName("aggregate_usage") AggregateUsage aggregateUsage; @@ -33,25 +33,26 @@ public class PlanCreateParams extends ApiRequestParams { Long amount; /** - * Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of - * `amount` and `amount_decimal` can be set. + * Same as {@code amount}, but accepts a decimal value with at most 12 decimal places. Only one of + * {@code amount} and {@code amount_decimal} can be set. */ @SerializedName("amount_decimal") BigDecimal amountDecimal; /** - * Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` - * indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` - * (for plans with `usage_type=licensed`), or per unit of total usage (for plans with - * `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a - * tiering strategy as defined using the `tiers` and `tiers_mode` attributes. + * Describes how to compute the price per period. Either {@code per_unit} or {@code tiered}. + * {@code per_unit} indicates that the fixed amount (specified in {@code amount}) will be charged + * per unit in {@code quantity} (for plans with {@code usage_type=licensed}), or per unit of total + * usage (for plans with {@code usage_type=metered}). {@code tiered} indicates that the unit + * pricing will be computed using a tiering strategy as defined using the {@code tiers} and {@code + * tiers_mode} attributes. */ @SerializedName("billing_scheme") BillingScheme billingScheme; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -77,13 +78,15 @@ public class PlanCreateParams extends ApiRequestParams { @SerializedName("id") String id; - /** Specifies billing frequency. Either `day`, `week`, `month` or `year`. */ + /** + * Specifies billing frequency. Either {@code day}, {@code week}, {@code month} or {@code year}. + */ @SerializedName("interval") Interval interval; /** - * The number of intervals between subscription billings. For example, `interval=month` and - * `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 + * The number of intervals between subscription billings. For example, {@code interval=month} and + * {@code interval_count=3} bills every 3 months. Maximum of one year interval allowed (1 year, 12 * months, or 52 weeks). */ @SerializedName("interval_count") @@ -92,7 +95,8 @@ public class PlanCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -105,39 +109,40 @@ public class PlanCreateParams extends ApiRequestParams { Object product; /** - * Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to - * `tiered`. See also the documentation for `billing_scheme`. + * Each element represents a pricing tier. This parameter requires {@code billing_scheme} to be + * set to {@code tiered}. See also the documentation for {@code billing_scheme}. */ @SerializedName("tiers") List tiers; /** - * Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based - * tiering, the maximum quantity within a period determines the per unit price, in `graduated` - * tiering pricing can successively change as the quantity grows. + * Defines if the tiering price should be {@code graduated} or {@code volume} based. In {@code + * volume}-based tiering, the maximum quantity within a period determines the per unit price, in + * {@code graduated} tiering pricing can successively change as the quantity grows. */ @SerializedName("tiers_mode") TiersMode tiersMode; /** * Apply a transformation to the reported usage or set quantity before computing the billed price. - * Cannot be combined with `tiers`. + * Cannot be combined with {@code tiers}. */ @SerializedName("transform_usage") TransformUsage transformUsage; /** - * Default number of trial days when subscribing a customer to this plan using - * [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + * Default number of trial days when subscribing a customer to this plan using {@code + * trial_from_plan=true}. */ @SerializedName("trial_period_days") Long trialPeriodDays; /** - * Configures how the quantity per period should be determined, can be either `metered` or - * `licensed`. `licensed` will automatically bill the `quantity` set for a plan when adding it to - * a subscription, `metered` will aggregate the total usage based on usage records. Defaults to - * `licensed`. + * Configures how the quantity per period should be determined, can be either {@code metered} or + * {@code licensed}. {@code licensed} will automatically bill the {@code quantity} set for a plan + * when adding it to a subscription, {@code metered} will aggregate the total usage based on usage + * records. Defaults to {@code licensed}. */ @SerializedName("usage_type") UsageType usageType; @@ -250,18 +255,18 @@ public PlanCreateParams build() { this.usageType); } - /** Whether the plan is currently available for new subscriptions. Defaults to `true`. */ + /** Whether the plan is currently available for new subscriptions. Defaults to {@code true}. */ public Builder setActive(Boolean active) { this.active = active; return this; } /** - * Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are - * `sum` for summing up all usage during a period, `last_during_period` for picking the last - * usage record reported within a period, `last_ever` for picking the last usage record ever - * (across period bounds) or `max` which picks the usage record with the maximum reported usage - * during a period. Defaults to `sum`. + * Specifies a usage aggregation strategy for plans of {@code usage_type=metered}. Allowed + * values are {@code sum} for summing up all usage during a period, {@code last_during_period} + * for picking the last usage record reported within a period, {@code last_ever} for picking the + * last usage record ever (across period bounds) or {@code max} which picks the usage record + * with the maximum reported usage during a period. Defaults to {@code sum}. */ public Builder setAggregateUsage(AggregateUsage aggregateUsage) { this.aggregateUsage = aggregateUsage; @@ -278,8 +283,8 @@ public Builder setAmount(Long amount) { } /** - * Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of - * `amount` and `amount_decimal` can be set. + * Same as {@code amount}, but accepts a decimal value with at most 12 decimal places. Only one + * of {@code amount} and {@code amount_decimal} can be set. */ public Builder setAmountDecimal(BigDecimal amountDecimal) { this.amountDecimal = amountDecimal; @@ -287,11 +292,12 @@ public Builder setAmountDecimal(BigDecimal amountDecimal) { } /** - * Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` - * indicates that the fixed amount (specified in `amount`) will be charged per unit in - * `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with - * `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a - * tiering strategy as defined using the `tiers` and `tiers_mode` attributes. + * Describes how to compute the price per period. Either {@code per_unit} or {@code tiered}. + * {@code per_unit} indicates that the fixed amount (specified in {@code amount}) will be + * charged per unit in {@code quantity} (for plans with {@code usage_type=licensed}), or per + * unit of total usage (for plans with {@code usage_type=metered}). {@code tiered} indicates + * that the unit pricing will be computed using a tiering strategy as defined using the {@code + * tiers} and {@code tiers_mode} attributes. */ public Builder setBillingScheme(BillingScheme billingScheme) { this.billingScheme = billingScheme; @@ -299,8 +305,9 @@ public Builder setBillingScheme(BillingScheme billingScheme) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -369,16 +376,18 @@ public Builder setId(String id) { return this; } - /** Specifies billing frequency. Either `day`, `week`, `month` or `year`. */ + /** + * Specifies billing frequency. Either {@code day}, {@code week}, {@code month} or {@code year}. + */ public Builder setInterval(Interval interval) { this.interval = interval; return this; } /** - * The number of intervals between subscription billings. For example, `interval=month` and - * `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 - * months, or 52 weeks). + * The number of intervals between subscription billings. For example, {@code interval=month} + * and {@code interval_count=3} bills every 3 months. Maximum of one year interval allowed (1 + * year, 12 months, or 52 weeks). */ public Builder setIntervalCount(Long intervalCount) { this.intervalCount = intervalCount; @@ -454,9 +463,9 @@ public Builder addAllTier(List elements) { } /** - * Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based - * tiering, the maximum quantity within a period determines the per unit price, in `graduated` - * tiering pricing can successively change as the quantity grows. + * Defines if the tiering price should be {@code graduated} or {@code volume} based. In {@code + * volume}-based tiering, the maximum quantity within a period determines the per unit price, in + * {@code graduated} tiering pricing can successively change as the quantity grows. */ public Builder setTiersMode(TiersMode tiersMode) { this.tiersMode = tiersMode; @@ -465,7 +474,7 @@ public Builder setTiersMode(TiersMode tiersMode) { /** * Apply a transformation to the reported usage or set quantity before computing the billed - * price. Cannot be combined with `tiers`. + * price. Cannot be combined with {@code tiers}. */ public Builder setTransformUsage(TransformUsage transformUsage) { this.transformUsage = transformUsage; @@ -473,8 +482,9 @@ public Builder setTransformUsage(TransformUsage transformUsage) { } /** - * Default number of trial days when subscribing a customer to this plan using - * [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + * Default number of trial days when subscribing a customer to this plan using {@code + * trial_from_plan=true}. */ public Builder setTrialPeriodDays(Long trialPeriodDays) { this.trialPeriodDays = trialPeriodDays; @@ -482,10 +492,10 @@ public Builder setTrialPeriodDays(Long trialPeriodDays) { } /** - * Configures how the quantity per period should be determined, can be either `metered` or - * `licensed`. `licensed` will automatically bill the `quantity` set for a plan when adding it - * to a subscription, `metered` will aggregate the total usage based on usage records. Defaults - * to `licensed`. + * Configures how the quantity per period should be determined, can be either {@code metered} or + * {@code licensed}. {@code licensed} will automatically bill the {@code quantity} set for a + * plan when adding it to a subscription, {@code metered} will aggregate the total usage based + * on usage records. Defaults to {@code licensed}. */ public Builder setUsageType(UsageType usageType) { this.usageType = usageType; @@ -495,7 +505,7 @@ public Builder setUsageType(UsageType usageType) { @Getter public static class Product { - /** Whether the product is currently available for purchase. Defaults to `true`. */ + /** Whether the product is currently available for purchase. Defaults to {@code true}. */ @SerializedName("active") Boolean active; @@ -518,8 +528,8 @@ public static class Product { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -536,9 +546,9 @@ public static class Product { * most banks display this information consistently, some may display it incorrectly or not at * all. * - *

This may be up to 22 characters. The statement description may not include `<`, `>`, - * `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. - * Non-ASCII characters are automatically stripped. + *

This may be up to 22 characters. The statement description may not include {@code <}, + * {@code >}, {@code \}, {@code "}, {@code '} characters, and will appear on your customer's + * statement in capital letters. Non-ASCII characters are automatically stripped. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -598,7 +608,7 @@ public Product build() { this.unitLabel); } - /** Whether the product is currently available for purchase. Defaults to `true`. */ + /** Whether the product is currently available for purchase. Defaults to {@code true}. */ public Builder setActive(Boolean active) { this.active = active; return this; @@ -679,9 +689,9 @@ public Builder setName(String name) { * most banks display this information consistently, some may display it incorrectly or not at * all. * - *

This may be up to 22 characters. The statement description may not include `<`, - * `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital - * letters. Non-ASCII characters are automatically stripped. + *

This may be up to 22 characters. The statement description may not include {@code <}, + * {@code >}, {@code \}, {@code "}, {@code '} characters, and will appear on your customer's + * statement in capital letters. Non-ASCII characters are automatically stripped. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -717,8 +727,9 @@ public static class Tier { Long flatAmount; /** - * Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units - * of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. + * Same as {@code flat_amount}, but accepts a decimal value representing an integer in the minor + * units of the currency. Only one of {@code flat_amount} and {@code flat_amount_decimal} can be + * set. */ @SerializedName("flat_amount_decimal") BigDecimal flatAmountDecimal; @@ -728,15 +739,15 @@ public static class Tier { Long unitAmount; /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only + * one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ @SerializedName("unit_amount_decimal") BigDecimal unitAmountDecimal; /** * Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the - * previous tier adding one. Use `inf` to define a fallback tier. + * previous tier adding one. Use {@code inf} to define a fallback tier. */ @SerializedName("up_to") Object upTo; @@ -819,8 +830,9 @@ public Builder setFlatAmount(Long flatAmount) { } /** - * Same as `flat_amount`, but accepts a decimal value representing an integer in the minor - * units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. + * Same as {@code flat_amount}, but accepts a decimal value representing an integer in the + * minor units of the currency. Only one of {@code flat_amount} and {@code + * flat_amount_decimal} can be set. */ public Builder setFlatAmountDecimal(BigDecimal flatAmountDecimal) { this.flatAmountDecimal = flatAmountDecimal; @@ -834,8 +846,8 @@ public Builder setUnitAmount(Long unitAmount) { } /** - * Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one - * of `unit_amount` and `unit_amount_decimal` can be set. + * Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. + * Only one of {@code unit_amount} and {@code unit_amount_decimal} can be set. */ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { this.unitAmountDecimal = unitAmountDecimal; @@ -844,7 +856,7 @@ public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) { /** * Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the - * previous tier adding one. Use `inf` to define a fallback tier. + * previous tier adding one. Use {@code inf} to define a fallback tier. */ public Builder setUpTo(UpTo upTo) { this.upTo = upTo; @@ -853,7 +865,7 @@ public Builder setUpTo(UpTo upTo) { /** * Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the - * previous tier adding one. Use `inf` to define a fallback tier. + * previous tier adding one. Use {@code inf} to define a fallback tier. */ public Builder setUpTo(Long upTo) { this.upTo = upTo; @@ -889,7 +901,7 @@ public static class TransformUsage { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** After division, either round the result `up` or `down`. */ + /** After division, either round the result {@code up} or {@code down}. */ @SerializedName("round") Round round; @@ -947,7 +959,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** After division, either round the result `up` or `down`. */ + /** After division, either round the result {@code up} or {@code down}. */ public Builder setRound(Round round) { this.round = round; return this; diff --git a/src/main/java/com/stripe/param/PlanListParams.java b/src/main/java/com/stripe/param/PlanListParams.java index efbcd27d140..3bdde58c71a 100644 --- a/src/main/java/com/stripe/param/PlanListParams.java +++ b/src/main/java/com/stripe/param/PlanListParams.java @@ -11,23 +11,24 @@ @Getter public class PlanListParams extends ApiRequestParams { /** - * Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). + * Only return plans that are active or inactive (e.g., pass {@code false} to list all inactive + * plans). */ @SerializedName("active") Boolean active; /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string with + * an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ @SerializedName("created") Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -57,10 +58,10 @@ public class PlanListParams extends ApiRequestParams { String product; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -119,7 +120,7 @@ public PlanListParams build() { } /** - * Only return plans that are active or inactive (e.g., pass `false` to list all inactive + * Only return plans that are active or inactive (e.g., pass {@code false} to list all inactive * plans). */ public Builder setActive(Boolean active) { @@ -128,8 +129,9 @@ public Builder setActive(Boolean active) { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Created created) { this.created = created; @@ -137,8 +139,9 @@ public Builder setCreated(Created created) { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Long created) { this.created = created; @@ -146,10 +149,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -224,10 +227,10 @@ public Builder setProduct(String product) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/PlanUpdateParams.java b/src/main/java/com/stripe/param/PlanUpdateParams.java index 842d58d533d..dcd013a0554 100644 --- a/src/main/java/com/stripe/param/PlanUpdateParams.java +++ b/src/main/java/com/stripe/param/PlanUpdateParams.java @@ -31,7 +31,8 @@ public class PlanUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -48,8 +49,9 @@ public class PlanUpdateParams extends ApiRequestParams { Object product; /** - * Default number of trial days when subscribing a customer to this plan using - * [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + * Default number of trial days when subscribing a customer to this plan using {@code + * trial_from_plan=true}. */ @SerializedName("trial_period_days") Long trialPeriodDays; @@ -217,8 +219,9 @@ public Builder setProduct(EmptyParam product) { } /** - * Default number of trial days when subscribing a customer to this plan using - * [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + * Default number of trial days when subscribing a customer to this plan using {@code + * trial_from_plan=true}. */ public Builder setTrialPeriodDays(Long trialPeriodDays) { this.trialPeriodDays = trialPeriodDays; diff --git a/src/main/java/com/stripe/param/ProductCreateParams.java b/src/main/java/com/stripe/param/ProductCreateParams.java index 55c431e72f1..c2d912b124f 100644 --- a/src/main/java/com/stripe/param/ProductCreateParams.java +++ b/src/main/java/com/stripe/param/ProductCreateParams.java @@ -11,7 +11,7 @@ @Getter public class ProductCreateParams extends ApiRequestParams { - /** Whether the product is currently available for purchase. Defaults to `true`. */ + /** Whether the product is currently available for purchase. Defaults to {@code true}. */ @SerializedName("active") Boolean active; @@ -21,14 +21,14 @@ public class ProductCreateParams extends ApiRequestParams { /** * A short one-line description of the product, meant to be displayable to the customer. May only - * be set if type=`good`. + * be set if type={@code good}. */ @SerializedName("caption") String caption; /** * An array of Connect application names or identifiers that should not be able to order the SKUs - * for this product. May only be set if type=`good`. + * for this product. May only be set if type={@code good}. */ @SerializedName("deactivate_on") List deactivateOn; @@ -63,7 +63,7 @@ public class ProductCreateParams extends ApiRequestParams { /** * A list of up to 8 URLs of images for this product, meant to be displayable to the customer. May - * only be set if type=`good`. + * only be set if type={@code good}. */ @SerializedName("images") List images; @@ -71,7 +71,8 @@ public class ProductCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -85,14 +86,15 @@ public class ProductCreateParams extends ApiRequestParams { /** * The dimensions of this product for shipping purposes. A SKU associated with this product can - * override this value by having its own `package_dimensions`. May only be set if type=`good`. + * override this value by having its own {@code package_dimensions}. May only be set if + * type={@code good}. */ @SerializedName("package_dimensions") PackageDimensions packageDimensions; /** - * Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set if - * type=`good`. + * Whether this product is shipped (i.e., physical goods). Defaults to {@code true}. May only be + * set if type={@code good}. */ @SerializedName("shippable") Boolean shippable; @@ -102,18 +104,19 @@ public class ProductCreateParams extends ApiRequestParams { * most banks display this information consistently, some may display it incorrectly or not at * all. * - *

This may be up to 22 characters. The statement description may not include `<`, `>`, - * `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. - * Non-ASCII characters are automatically stripped. It must contain at least one letter. + *

This may be up to 22 characters. The statement description may not include {@code <}, {@code + * >}, {@code \}, {@code "}, {@code '} characters, and will appear on your customer's statement in + * capital letters. Non-ASCII characters are automatically stripped. It must contain at least one + * letter. */ @SerializedName("statement_descriptor") String statementDescriptor; /** - * The type of the product. Defaults to `service` if not explicitly specified, enabling use of - * this product with Subscriptions and Plans. Set this parameter to `good` to use this product - * with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for - * compatibility reasons. + * The type of the product. Defaults to {@code service} if not explicitly specified, enabling use + * of this product with Subscriptions and Plans. Set this parameter to {@code good} to use this + * product with Orders and SKUs. On API versions before {@code 2018-02-05}, this field defaults to + * {@code good} for compatibility reasons. */ @SerializedName("type") Type type; @@ -125,7 +128,9 @@ public class ProductCreateParams extends ApiRequestParams { @SerializedName("unit_label") String unitLabel; - /** A URL of a publicly-accessible webpage for this product. May only be set if type=`good`. */ + /** + * A URL of a publicly-accessible webpage for this product. May only be set if type={@code good}. + */ @SerializedName("url") String url; @@ -227,7 +232,7 @@ public ProductCreateParams build() { this.url); } - /** Whether the product is currently available for purchase. Defaults to `true`. */ + /** Whether the product is currently available for purchase. Defaults to {@code true}. */ public Builder setActive(Boolean active) { this.active = active; return this; @@ -261,7 +266,7 @@ public Builder addAllAttribute(List elements) { /** * A short one-line description of the product, meant to be displayable to the customer. May - * only be set if type=`good`. + * only be set if type={@code good}. */ public Builder setCaption(String caption) { this.caption = caption; @@ -428,7 +433,8 @@ public Builder setName(String name) { /** * The dimensions of this product for shipping purposes. A SKU associated with this product can - * override this value by having its own `package_dimensions`. May only be set if type=`good`. + * override this value by having its own {@code package_dimensions}. May only be set if + * type={@code good}. */ public Builder setPackageDimensions(PackageDimensions packageDimensions) { this.packageDimensions = packageDimensions; @@ -436,8 +442,8 @@ public Builder setPackageDimensions(PackageDimensions packageDimensions) { } /** - * Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set - * if type=`good`. + * Whether this product is shipped (i.e., physical goods). Defaults to {@code true}. May only be + * set if type={@code good}. */ public Builder setShippable(Boolean shippable) { this.shippable = shippable; @@ -449,9 +455,10 @@ public Builder setShippable(Boolean shippable) { * most banks display this information consistently, some may display it incorrectly or not at * all. * - *

This may be up to 22 characters. The statement description may not include `<`, `>`, - * `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. - * Non-ASCII characters are automatically stripped. It must contain at least one letter. + *

This may be up to 22 characters. The statement description may not include {@code <}, + * {@code >}, {@code \}, {@code "}, {@code '} characters, and will appear on your customer's + * statement in capital letters. Non-ASCII characters are automatically stripped. It must + * contain at least one letter. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -459,10 +466,10 @@ public Builder setStatementDescriptor(String statementDescriptor) { } /** - * The type of the product. Defaults to `service` if not explicitly specified, enabling use of - * this product with Subscriptions and Plans. Set this parameter to `good` to use this product - * with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for - * compatibility reasons. + * The type of the product. Defaults to {@code service} if not explicitly specified, enabling + * use of this product with Subscriptions and Plans. Set this parameter to {@code good} to use + * this product with Orders and SKUs. On API versions before {@code 2018-02-05}, this field + * defaults to {@code good} for compatibility reasons. */ public Builder setType(Type type) { this.type = type; @@ -478,7 +485,10 @@ public Builder setUnitLabel(String unitLabel) { return this; } - /** A URL of a publicly-accessible webpage for this product. May only be set if type=`good`. */ + /** + * A URL of a publicly-accessible webpage for this product. May only be set if type={@code + * good}. + */ public Builder setUrl(String url) { this.url = url; return this; diff --git a/src/main/java/com/stripe/param/ProductListParams.java b/src/main/java/com/stripe/param/ProductListParams.java index 3d1f28e5247..4539329697e 100644 --- a/src/main/java/com/stripe/param/ProductListParams.java +++ b/src/main/java/com/stripe/param/ProductListParams.java @@ -11,7 +11,7 @@ @Getter public class ProductListParams extends ApiRequestParams { /** - * Only return products that are active or inactive (e.g., pass `false` to list all inactive + * Only return products that are active or inactive (e.g., pass {@code false} to list all inactive * products). */ @SerializedName("active") @@ -22,10 +22,10 @@ public class ProductListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -59,10 +59,10 @@ public class ProductListParams extends ApiRequestParams { Boolean shippable; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -144,8 +144,8 @@ public ProductListParams build() { } /** - * Only return products that are active or inactive (e.g., pass `false` to list all inactive - * products). + * Only return products that are active or inactive (e.g., pass {@code false} to list all + * inactive products). */ public Builder setActive(Boolean active) { this.active = active; @@ -165,10 +165,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -269,10 +269,10 @@ public Builder setShippable(Boolean shippable) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/ProductUpdateParams.java b/src/main/java/com/stripe/param/ProductUpdateParams.java index 9b021d1d2ef..bde027900d7 100644 --- a/src/main/java/com/stripe/param/ProductUpdateParams.java +++ b/src/main/java/com/stripe/param/ProductUpdateParams.java @@ -17,24 +17,24 @@ public class ProductUpdateParams extends ApiRequestParams { Boolean active; /** - * A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., - * `["color", "size"]`). If a value for `attributes` is specified, the list specified will replace - * the existing attributes list on this product. Any attributes not present after the update will - * be deleted from the SKUs for this product. + * A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., {@code + * ["color", "size"]}). If a value for {@code attributes} is specified, the list specified will + * replace the existing attributes list on this product. Any attributes not present after the + * update will be deleted from the SKUs for this product. */ @SerializedName("attributes") Object attributes; /** * A short one-line description of the product, meant to be displayable to the customer. May only - * be set if `type=good`. + * be set if {@code type=good}. */ @SerializedName("caption") Object caption; /** * An array of Connect application names or identifiers that should not be able to order the SKUs - * for this product. May only be set if `type=good`. + * for this product. May only be set if {@code type=good}. */ @SerializedName("deactivate_on") List deactivateOn; @@ -62,7 +62,7 @@ public class ProductUpdateParams extends ApiRequestParams { /** * A list of up to 8 URLs of images for this product, meant to be displayable to the customer. May - * only be set if `type=good`. + * only be set if {@code type=good}. */ @SerializedName("images") Object images; @@ -70,7 +70,8 @@ public class ProductUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -84,14 +85,15 @@ public class ProductUpdateParams extends ApiRequestParams { /** * The dimensions of this product for shipping purposes. A SKU associated with this product can - * override this value by having its own `package_dimensions`. May only be set if `type=good`. + * override this value by having its own {@code package_dimensions}. May only be set if {@code + * type=good}. */ @SerializedName("package_dimensions") Object packageDimensions; /** - * Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set if - * `type=good`. + * Whether this product is shipped (i.e., physical goods). Defaults to {@code true}. May only be + * set if {@code type=good}. */ @SerializedName("shippable") Boolean shippable; @@ -101,10 +103,10 @@ public class ProductUpdateParams extends ApiRequestParams { * most banks display this information consistently, some may display it incorrectly or not at * all. * - *

This may be up to 22 characters. The statement description may not include `<`, `>`, - * `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. - * Non-ASCII characters are automatically stripped. It must contain at least one letter. May only - * be set if `type=service`. + *

This may be up to 22 characters. The statement description may not include {@code <}, {@code + * >}, {@code \}, {@code "}, {@code '} characters, and will appear on your customer's statement in + * capital letters. Non-ASCII characters are automatically stripped. It must contain at least one + * letter. May only be set if {@code type=service}. */ @SerializedName("statement_descriptor") Object statementDescriptor; @@ -112,12 +114,14 @@ public class ProductUpdateParams extends ApiRequestParams { /** * A label that represents units of this product in Stripe and on customers’ receipts and * invoices. When set, this will be included in associated invoice line item descriptions. May - * only be set if `type=service`. + * only be set if {@code type=service}. */ @SerializedName("unit_label") Object unitLabel; - /** A URL of a publicly-accessible webpage for this product. May only be set if `type=good`. */ + /** + * A URL of a publicly-accessible webpage for this product. May only be set if {@code type=good}. + */ @SerializedName("url") Object url; @@ -244,8 +248,8 @@ public Builder addAllAttribute(List elements) { } /** - * A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., - * `["color", "size"]`). If a value for `attributes` is specified, the list specified will + * A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., {@code + * ["color", "size"]}). If a value for {@code attributes} is specified, the list specified will * replace the existing attributes list on this product. Any attributes not present after the * update will be deleted from the SKUs for this product. */ @@ -255,8 +259,8 @@ public Builder setAttributes(EmptyParam attributes) { } /** - * A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., - * `["color", "size"]`). If a value for `attributes` is specified, the list specified will + * A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., {@code + * ["color", "size"]}). If a value for {@code attributes} is specified, the list specified will * replace the existing attributes list on this product. Any attributes not present after the * update will be deleted from the SKUs for this product. */ @@ -267,7 +271,7 @@ public Builder setAttributes(List attributes) { /** * A short one-line description of the product, meant to be displayable to the customer. May - * only be set if `type=good`. + * only be set if {@code type=good}. */ public Builder setCaption(String caption) { this.caption = caption; @@ -276,7 +280,7 @@ public Builder setCaption(String caption) { /** * A short one-line description of the product, meant to be displayable to the customer. May - * only be set if `type=good`. + * only be set if {@code type=good}. */ public Builder setCaption(EmptyParam caption) { this.caption = caption; @@ -411,7 +415,7 @@ public Builder addAllImage(List elements) { /** * A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - * May only be set if `type=good`. + * May only be set if {@code type=good}. */ public Builder setImages(EmptyParam images) { this.images = images; @@ -420,7 +424,7 @@ public Builder setImages(EmptyParam images) { /** * A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - * May only be set if `type=good`. + * May only be set if {@code type=good}. */ public Builder setImages(List images) { this.images = images; @@ -473,7 +477,8 @@ public Builder setName(EmptyParam name) { /** * The dimensions of this product for shipping purposes. A SKU associated with this product can - * override this value by having its own `package_dimensions`. May only be set if `type=good`. + * override this value by having its own {@code package_dimensions}. May only be set if {@code + * type=good}. */ public Builder setPackageDimensions(PackageDimensions packageDimensions) { this.packageDimensions = packageDimensions; @@ -482,7 +487,8 @@ public Builder setPackageDimensions(PackageDimensions packageDimensions) { /** * The dimensions of this product for shipping purposes. A SKU associated with this product can - * override this value by having its own `package_dimensions`. May only be set if `type=good`. + * override this value by having its own {@code package_dimensions}. May only be set if {@code + * type=good}. */ public Builder setPackageDimensions(EmptyParam packageDimensions) { this.packageDimensions = packageDimensions; @@ -490,8 +496,8 @@ public Builder setPackageDimensions(EmptyParam packageDimensions) { } /** - * Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set - * if `type=good`. + * Whether this product is shipped (i.e., physical goods). Defaults to {@code true}. May only be + * set if {@code type=good}. */ public Builder setShippable(Boolean shippable) { this.shippable = shippable; @@ -503,10 +509,10 @@ public Builder setShippable(Boolean shippable) { * most banks display this information consistently, some may display it incorrectly or not at * all. * - *

This may be up to 22 characters. The statement description may not include `<`, `>`, - * `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. - * Non-ASCII characters are automatically stripped. It must contain at least one letter. May - * only be set if `type=service`. + *

This may be up to 22 characters. The statement description may not include {@code <}, + * {@code >}, {@code \}, {@code "}, {@code '} characters, and will appear on your customer's + * statement in capital letters. Non-ASCII characters are automatically stripped. It must + * contain at least one letter. May only be set if {@code type=service}. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -518,10 +524,10 @@ public Builder setStatementDescriptor(String statementDescriptor) { * most banks display this information consistently, some may display it incorrectly or not at * all. * - *

This may be up to 22 characters. The statement description may not include `<`, `>`, - * `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. - * Non-ASCII characters are automatically stripped. It must contain at least one letter. May - * only be set if `type=service`. + *

This may be up to 22 characters. The statement description may not include {@code <}, + * {@code >}, {@code \}, {@code "}, {@code '} characters, and will appear on your customer's + * statement in capital letters. Non-ASCII characters are automatically stripped. It must + * contain at least one letter. May only be set if {@code type=service}. */ public Builder setStatementDescriptor(EmptyParam statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -531,7 +537,7 @@ public Builder setStatementDescriptor(EmptyParam statementDescriptor) { /** * A label that represents units of this product in Stripe and on customers’ receipts and * invoices. When set, this will be included in associated invoice line item descriptions. May - * only be set if `type=service`. + * only be set if {@code type=service}. */ public Builder setUnitLabel(String unitLabel) { this.unitLabel = unitLabel; @@ -541,20 +547,26 @@ public Builder setUnitLabel(String unitLabel) { /** * A label that represents units of this product in Stripe and on customers’ receipts and * invoices. When set, this will be included in associated invoice line item descriptions. May - * only be set if `type=service`. + * only be set if {@code type=service}. */ public Builder setUnitLabel(EmptyParam unitLabel) { this.unitLabel = unitLabel; return this; } - /** A URL of a publicly-accessible webpage for this product. May only be set if `type=good`. */ + /** + * A URL of a publicly-accessible webpage for this product. May only be set if {@code + * type=good}. + */ public Builder setUrl(String url) { this.url = url; return this; } - /** A URL of a publicly-accessible webpage for this product. May only be set if `type=good`. */ + /** + * A URL of a publicly-accessible webpage for this product. May only be set if {@code + * type=good}. + */ public Builder setUrl(EmptyParam url) { this.url = url; return this; diff --git a/src/main/java/com/stripe/param/RecipientCreateParams.java b/src/main/java/com/stripe/param/RecipientCreateParams.java index a8b31e48b8b..e40b28d408c 100644 --- a/src/main/java/com/stripe/param/RecipientCreateParams.java +++ b/src/main/java/com/stripe/param/RecipientCreateParams.java @@ -12,25 +12,25 @@ public class RecipientCreateParams extends ApiRequestParams { /** * A bank account to attach to the recipient. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's - * bank account details, with the options described below. + * returned by Stripe.js, or a dictionary + * containing a user's bank account details, with the options described below. */ @SerializedName("bank_account") String bankAccount; /** - * A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit - * card is not valid, recipient creation will fail. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's - * debit card details, with the options described below. Although not all information is required, - * the extra info helps prevent fraud. + * A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. If the + * debit card is not valid, recipient creation will fail. You can provide either a token, like the + * ones returned by Stripe.js, or a dictionary + * containing a user's debit card details, with the options described below. Although not all + * information is required, the extra info helps prevent fraud. */ @SerializedName("card") String card; /** - * An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the - * recipient in the web interface. + * An arbitrary string which you can attach to a {@code Recipient} object. It is displayed + * alongside the recipient in the web interface. */ @SerializedName("description") String description; @@ -58,27 +58,28 @@ public class RecipientCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * The recipient's full, legal name. For type `individual`, should be in the format `First Last`, - * `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, - * incorporated name. + * The recipient's full, legal name. For type {@code individual}, should be in the format {@code + * First Last}, {@code First Middle Last}, or {@code First M Last} (no prefixes or suffixes). For + * {@code corporation}, the full, incorporated name. */ @SerializedName("name") String name; /** - * The recipient's tax ID, as a string. For type `individual`, the full SSN; for type - * `corporation`, the full EIN. + * The recipient's tax ID, as a string. For type {@code individual}, the full SSN; for type {@code + * corporation}, the full EIN. */ @SerializedName("tax_id") String taxId; - /** Type of the recipient: either `individual` or `corporation`. */ + /** Type of the recipient: either {@code individual} or {@code corporation}. */ @SerializedName("type") String type; @@ -147,8 +148,8 @@ public RecipientCreateParams build() { /** * A bank account to attach to the recipient. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a - * user's bank account details, with the options described below. + * returned by Stripe.js, or a dictionary + * containing a user's bank account details, with the options described below. */ public Builder setBankAccount(String bankAccount) { this.bankAccount = bankAccount; @@ -156,11 +157,11 @@ public Builder setBankAccount(String bankAccount) { } /** - * A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit - * card is not valid, recipient creation will fail. You can provide either a token, like the - * ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a - * user's debit card details, with the options described below. Although not all information is - * required, the extra info helps prevent fraud. + * A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. If + * the debit card is not valid, recipient creation will fail. You can provide either a token, + * like the ones returned by Stripe.js, or a + * dictionary containing a user's debit card details, with the options described below. Although + * not all information is required, the extra info helps prevent fraud. */ public Builder setCard(String card) { this.card = card; @@ -168,8 +169,8 @@ public Builder setCard(String card) { } /** - * An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside - * the recipient in the web interface. + * An arbitrary string which you can attach to a {@code Recipient} object. It is displayed + * alongside the recipient in the web interface. */ public Builder setDescription(String description) { this.description = description; @@ -264,9 +265,9 @@ public Builder putAllMetadata(Map map) { } /** - * The recipient's full, legal name. For type `individual`, should be in the format `First - * Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, - * the full, incorporated name. + * The recipient's full, legal name. For type {@code individual}, should be in the format {@code + * First Last}, {@code First Middle Last}, or {@code First M Last} (no prefixes or suffixes). + * For {@code corporation}, the full, incorporated name. */ public Builder setName(String name) { this.name = name; @@ -274,15 +275,15 @@ public Builder setName(String name) { } /** - * The recipient's tax ID, as a string. For type `individual`, the full SSN; for type - * `corporation`, the full EIN. + * The recipient's tax ID, as a string. For type {@code individual}, the full SSN; for type + * {@code corporation}, the full EIN. */ public Builder setTaxId(String taxId) { this.taxId = taxId; return this; } - /** Type of the recipient: either `individual` or `corporation`. */ + /** Type of the recipient: either {@code individual} or {@code corporation}. */ public Builder setType(String type) { this.type = type; return this; diff --git a/src/main/java/com/stripe/param/RecipientListParams.java b/src/main/java/com/stripe/param/RecipientListParams.java index 1854a64a88b..5220710d9f1 100644 --- a/src/main/java/com/stripe/param/RecipientListParams.java +++ b/src/main/java/com/stripe/param/RecipientListParams.java @@ -14,10 +14,10 @@ public class RecipientListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -43,10 +43,10 @@ public class RecipientListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -122,10 +122,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -194,10 +194,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/RecipientUpdateParams.java b/src/main/java/com/stripe/param/RecipientUpdateParams.java index 3ba599167e7..9379e261177 100644 --- a/src/main/java/com/stripe/param/RecipientUpdateParams.java +++ b/src/main/java/com/stripe/param/RecipientUpdateParams.java @@ -13,20 +13,21 @@ public class RecipientUpdateParams extends ApiRequestParams { /** * A bank account to attach to the recipient. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's - * bank account details, with the options described below. + * returned by Stripe.js, or a dictionary + * containing a user's bank account details, with the options described below. */ @SerializedName("bank_account") Object bankAccount; /** * A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide - * either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a - * dictionary containing a user's debit card details, with the options described below. Passing - * `card` will create a new card, make it the new recipient default card, and delete the old - * recipient default (if one exists). If you want to add additional debit cards instead of - * replacing the existing default, use the [card creation API](#create_card). Whenever you attach - * a card to a recipient, Stripe will automatically validate the debit card. + * either a token, like the ones returned by Stripe.js, or a dictionary containing a user's + * debit card details, with the options described below. Passing {@code card} will create a new + * card, make it the new recipient default card, and delete the old recipient default (if one + * exists). If you want to add additional debit cards instead of replacing the existing default, + * use the card creation API. Whenever you + * attach a card to a recipient, Stripe will automatically validate the debit card. */ @SerializedName("card") Object card; @@ -36,8 +37,8 @@ public class RecipientUpdateParams extends ApiRequestParams { Object defaultCard; /** - * An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the - * recipient in the web interface. + * An arbitrary string which you can attach to a {@code Recipient} object. It is displayed + * alongside the recipient in the web interface. */ @SerializedName("description") Object description; @@ -65,22 +66,23 @@ public class RecipientUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * The recipient's full, legal name. For type `individual`, should be in the format `First Last`, - * `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, - * incorporated name. + * The recipient's full, legal name. For type {@code individual}, should be in the format {@code + * First Last}, {@code First Middle Last}, or {@code First M Last} (no prefixes or suffixes). For + * {@code corporation}, the full, incorporated name. */ @SerializedName("name") Object name; /** - * The recipient's tax ID, as a string. For type `individual`, the full SSN; for type - * `corporation`, the full EIN. + * The recipient's tax ID, as a string. For type {@code individual}, the full SSN; for type {@code + * corporation}, the full EIN. */ @SerializedName("tax_id") Object taxId; @@ -150,8 +152,8 @@ public RecipientUpdateParams build() { /** * A bank account to attach to the recipient. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a - * user's bank account details, with the options described below. + * returned by Stripe.js, or a dictionary + * containing a user's bank account details, with the options described below. */ public Builder setBankAccount(String bankAccount) { this.bankAccount = bankAccount; @@ -160,8 +162,8 @@ public Builder setBankAccount(String bankAccount) { /** * A bank account to attach to the recipient. You can provide either a token, like the ones - * returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a - * user's bank account details, with the options described below. + * returned by Stripe.js, or a dictionary + * containing a user's bank account details, with the options described below. */ public Builder setBankAccount(EmptyParam bankAccount) { this.bankAccount = bankAccount; @@ -170,13 +172,13 @@ public Builder setBankAccount(EmptyParam bankAccount) { /** * A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can - * provide either a token, like the ones returned by - * [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's debit - * card details, with the options described below. Passing `card` will create a new card, make - * it the new recipient default card, and delete the old recipient default (if one exists). If - * you want to add additional debit cards instead of replacing the existing default, use the - * [card creation API](#create_card). Whenever you attach a card to a recipient, Stripe will - * automatically validate the debit card. + * provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's + * debit card details, with the options described below. Passing {@code card} will create a new + * card, make it the new recipient default card, and delete the old recipient default (if one + * exists). If you want to add additional debit cards instead of replacing the existing default, + * use the card creation API. Whenever you + * attach a card to a recipient, Stripe will automatically validate the debit card. */ public Builder setCard(String card) { this.card = card; @@ -185,13 +187,13 @@ public Builder setCard(String card) { /** * A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can - * provide either a token, like the ones returned by - * [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's debit - * card details, with the options described below. Passing `card` will create a new card, make - * it the new recipient default card, and delete the old recipient default (if one exists). If - * you want to add additional debit cards instead of replacing the existing default, use the - * [card creation API](#create_card). Whenever you attach a card to a recipient, Stripe will - * automatically validate the debit card. + * provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's + * debit card details, with the options described below. Passing {@code card} will create a new + * card, make it the new recipient default card, and delete the old recipient default (if one + * exists). If you want to add additional debit cards instead of replacing the existing default, + * use the card creation API. Whenever you + * attach a card to a recipient, Stripe will automatically validate the debit card. */ public Builder setCard(EmptyParam card) { this.card = card; @@ -211,8 +213,8 @@ public Builder setDefaultCard(EmptyParam defaultCard) { } /** - * An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside - * the recipient in the web interface. + * An arbitrary string which you can attach to a {@code Recipient} object. It is displayed + * alongside the recipient in the web interface. */ public Builder setDescription(String description) { this.description = description; @@ -220,8 +222,8 @@ public Builder setDescription(String description) { } /** - * An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside - * the recipient in the web interface. + * An arbitrary string which you can attach to a {@code Recipient} object. It is displayed + * alongside the recipient in the web interface. */ public Builder setDescription(EmptyParam description) { this.description = description; @@ -325,9 +327,9 @@ public Builder putAllMetadata(Map map) { } /** - * The recipient's full, legal name. For type `individual`, should be in the format `First - * Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, - * the full, incorporated name. + * The recipient's full, legal name. For type {@code individual}, should be in the format {@code + * First Last}, {@code First Middle Last}, or {@code First M Last} (no prefixes or suffixes). + * For {@code corporation}, the full, incorporated name. */ public Builder setName(String name) { this.name = name; @@ -335,9 +337,9 @@ public Builder setName(String name) { } /** - * The recipient's full, legal name. For type `individual`, should be in the format `First - * Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, - * the full, incorporated name. + * The recipient's full, legal name. For type {@code individual}, should be in the format {@code + * First Last}, {@code First Middle Last}, or {@code First M Last} (no prefixes or suffixes). + * For {@code corporation}, the full, incorporated name. */ public Builder setName(EmptyParam name) { this.name = name; @@ -345,8 +347,8 @@ public Builder setName(EmptyParam name) { } /** - * The recipient's tax ID, as a string. For type `individual`, the full SSN; for type - * `corporation`, the full EIN. + * The recipient's tax ID, as a string. For type {@code individual}, the full SSN; for type + * {@code corporation}, the full EIN. */ public Builder setTaxId(String taxId) { this.taxId = taxId; @@ -354,8 +356,8 @@ public Builder setTaxId(String taxId) { } /** - * The recipient's tax ID, as a string. For type `individual`, the full SSN; for type - * `corporation`, the full EIN. + * The recipient's tax ID, as a string. For type {@code individual}, the full SSN; for type + * {@code corporation}, the full EIN. */ public Builder setTaxId(EmptyParam taxId) { this.taxId = taxId; diff --git a/src/main/java/com/stripe/param/RefundCollectionListParams.java b/src/main/java/com/stripe/param/RefundCollectionListParams.java index e90d49f3ef3..d243b6efac1 100644 --- a/src/main/java/com/stripe/param/RefundCollectionListParams.java +++ b/src/main/java/com/stripe/param/RefundCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class RefundCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class RefundCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public RefundCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/RefundCreateParams.java b/src/main/java/com/stripe/param/RefundCreateParams.java index cf230550c93..c5a362c532a 100644 --- a/src/main/java/com/stripe/param/RefundCreateParams.java +++ b/src/main/java/com/stripe/param/RefundCreateParams.java @@ -32,7 +32,8 @@ public class RefundCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/RefundListParams.java b/src/main/java/com/stripe/param/RefundListParams.java index c7a0620ec87..46f60eff6f9 100644 --- a/src/main/java/com/stripe/param/RefundListParams.java +++ b/src/main/java/com/stripe/param/RefundListParams.java @@ -18,10 +18,10 @@ public class RefundListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -51,10 +51,10 @@ public class RefundListParams extends ApiRequestParams { String paymentIntent; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -129,10 +129,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -207,10 +207,10 @@ public Builder setPaymentIntent(String paymentIntent) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/RefundUpdateParams.java b/src/main/java/com/stripe/param/RefundUpdateParams.java index 33b589eb9d5..82a187a1583 100644 --- a/src/main/java/com/stripe/param/RefundUpdateParams.java +++ b/src/main/java/com/stripe/param/RefundUpdateParams.java @@ -26,7 +26,8 @@ public class RefundUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/ReviewListParams.java b/src/main/java/com/stripe/param/ReviewListParams.java index dfa66847328..d6978849c56 100644 --- a/src/main/java/com/stripe/param/ReviewListParams.java +++ b/src/main/java/com/stripe/param/ReviewListParams.java @@ -14,10 +14,10 @@ public class ReviewListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -43,10 +43,10 @@ public class ReviewListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -105,10 +105,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -177,10 +177,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/SetupIntentCancelParams.java b/src/main/java/com/stripe/param/SetupIntentCancelParams.java index cca1d769427..f03a49b4690 100644 --- a/src/main/java/com/stripe/param/SetupIntentCancelParams.java +++ b/src/main/java/com/stripe/param/SetupIntentCancelParams.java @@ -11,8 +11,8 @@ @Getter public class SetupIntentCancelParams extends ApiRequestParams { /** - * Reason for canceling this SetupIntent. Possible values are `abandoned`, - * `requested_by_customer`, or `duplicate` + * Reason for canceling this SetupIntent. Possible values are {@code abandoned}, {@code + * requested_by_customer}, or {@code duplicate} */ @SerializedName("cancellation_reason") CancellationReason cancellationReason; @@ -54,8 +54,8 @@ public SetupIntentCancelParams build() { } /** - * Reason for canceling this SetupIntent. Possible values are `abandoned`, - * `requested_by_customer`, or `duplicate` + * Reason for canceling this SetupIntent. Possible values are {@code abandoned}, {@code + * requested_by_customer}, or {@code duplicate} */ public Builder setCancellationReason(CancellationReason cancellationReason) { this.cancellationReason = cancellationReason; diff --git a/src/main/java/com/stripe/param/SetupIntentConfirmParams.java b/src/main/java/com/stripe/param/SetupIntentConfirmParams.java index f2d812c798b..5dbc238c20b 100644 --- a/src/main/java/com/stripe/param/SetupIntentConfirmParams.java +++ b/src/main/java/com/stripe/param/SetupIntentConfirmParams.java @@ -272,8 +272,8 @@ public static class CustomerAcceptance { Online online; /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ @SerializedName("type") Type type; @@ -365,8 +365,8 @@ public Builder setOnline(Online online) { } /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ public Builder setType(Type type) { this.type = type; @@ -626,13 +626,14 @@ public static class Card { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish - * to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on - * how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our SCA + * Engine. */ @SerializedName("request_three_d_secure") RequestThreeDSecure requestThreeDSecure; @@ -700,13 +701,14 @@ public Builder setMoto(Boolean moto) { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you - * wish to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information - * on how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our + * SCA Engine. */ public Builder setRequestThreeDSecure(RequestThreeDSecure requestThreeDSecure) { this.requestThreeDSecure = requestThreeDSecure; diff --git a/src/main/java/com/stripe/param/SetupIntentCreateParams.java b/src/main/java/com/stripe/param/SetupIntentCreateParams.java index ce73560ea60..e4c4c7cb97c 100644 --- a/src/main/java/com/stripe/param/SetupIntentCreateParams.java +++ b/src/main/java/com/stripe/param/SetupIntentCreateParams.java @@ -11,9 +11,9 @@ @Getter public class SetupIntentCreateParams extends ApiRequestParams { /** - * Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to - * `false`. If the payment method attached is a card, a return_url may be provided in case - * additional authentication is required. + * Set to {@code true} to attempt to confirm this SetupIntent immediately. This parameter defaults + * to {@code false}. If the payment method attached is a card, a return_url may be provided in + * case additional authentication is required. */ @SerializedName("confirm") Boolean confirm; @@ -45,8 +45,9 @@ public class SetupIntentCreateParams extends ApiRequestParams { Map extraParams; /** - * This hash contains details about the Mandate to create. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). + * This hash contains details about the Mandate to create. This parameter can only be used with {@code + * confirm=true}. */ @SerializedName("mandate_data") MandateData mandateData; @@ -54,7 +55,8 @@ public class SetupIntentCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -76,7 +78,7 @@ public class SetupIntentCreateParams extends ApiRequestParams { /** * The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this - * is not provided, defaults to ["card"]. + * is not provided, defaults to ["card"]. */ @SerializedName("payment_method_types") List paymentMethodTypes; @@ -84,8 +86,9 @@ public class SetupIntentCreateParams extends ApiRequestParams { /** * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. If you'd prefer to redirect to a mobile application, you can - * alternatively supply an application URI scheme. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). + * alternatively supply an application URI scheme. This parameter can only be used with {@code + * confirm=true}. */ @SerializedName("return_url") String returnUrl; @@ -96,7 +99,7 @@ public class SetupIntentCreateParams extends ApiRequestParams { /** * Indicates how the payment method is intended to be used in the future. If not provided, this - * value defaults to `off_session`. + * value defaults to {@code off_session}. */ @SerializedName("usage") Usage usage; @@ -185,9 +188,9 @@ public SetupIntentCreateParams build() { } /** - * Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to - * `false`. If the payment method attached is a card, a return_url may be provided in case - * additional authentication is required. + * Set to {@code true} to attempt to confirm this SetupIntent immediately. This parameter + * defaults to {@code false}. If the payment method attached is a card, a return_url may be + * provided in case additional authentication is required. */ public Builder setConfirm(Boolean confirm) { this.confirm = confirm; @@ -266,7 +269,8 @@ public Builder putAllExtraParam(Map map) { /** * This hash contains details about the Mandate to create. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). + * {@code + * confirm=true}. */ public Builder setMandateData(MandateData mandateData) { this.mandateData = mandateData; @@ -349,8 +353,9 @@ public Builder addAllPaymentMethodType(List elements) { /** * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. If you'd prefer to redirect to a mobile application, you - * can alternatively supply an application URI scheme. This parameter can only be used with - * [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). + * can alternatively supply an application URI scheme. This parameter can only be used with {@code + * confirm=true}. */ public Builder setReturnUrl(String returnUrl) { this.returnUrl = returnUrl; @@ -367,7 +372,7 @@ public Builder setSingleUse(SingleUse singleUse) { /** * Indicates how the payment method is intended to be used in the future. If not provided, this - * value defaults to `off_session`. + * value defaults to {@code off_session}. */ public Builder setUsage(Usage usage) { this.usage = usage; @@ -472,8 +477,8 @@ public static class CustomerAcceptance { Online online; /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ @SerializedName("type") Type type; @@ -565,8 +570,8 @@ public Builder setOnline(Online online) { } /** - * The type of customer acceptance information included with the Mandate. One of `online` or - * `offline`. + * The type of customer acceptance information included with the Mandate. One of {@code + * online} or {@code offline}. */ public Builder setType(Type type) { this.type = type; @@ -826,13 +831,14 @@ public static class Card { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish - * to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on - * how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our SCA + * Engine. */ @SerializedName("request_three_d_secure") RequestThreeDSecure requestThreeDSecure; @@ -900,13 +906,14 @@ public Builder setMoto(Boolean moto) { /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your - * customers for authentication based on risk level and [other - * requirements](https://stripe.com/docs/strong-customer-authentication). However, if you - * wish to request 3D Secure based on logic from your own fraud engine, provide this option. - * Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. - * Read our guide on [manually requesting 3D - * Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information - * on how this configuration interacts with Radar and our SCA Engine. + * customers for authentication based on risk level and other requirements. + * However, if you wish to request 3D Secure based on logic from your own fraud engine, + * provide this option. Permitted values include: {@code automatic} or {@code any}. If not + * provided, defaults to {@code automatic}. Read our guide on manually requesting 3D + * Secure for more information on how this configuration interacts with Radar and our + * SCA Engine. */ public Builder setRequestThreeDSecure(RequestThreeDSecure requestThreeDSecure) { this.requestThreeDSecure = requestThreeDSecure; @@ -935,19 +942,20 @@ public enum RequestThreeDSecure implements ApiRequestParams.EnumParam { public static class SingleUse { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how - * much to charge in the [smallest currency - * unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or - * 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent - * in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). - * The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of - * $999,999.99). + * much to charge in the smallest + * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal + * currency). The minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 + * for a USD charge of $999,999.99). */ @SerializedName("amount") Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ @SerializedName("currency") String currency; @@ -985,12 +993,12 @@ public SingleUse build() { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how - * much to charge in the [smallest currency - * unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or - * 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent - * in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). - * The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of - * $999,999.99). + * much to charge in the smallest + * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal + * currency). The minimum amount is $0.50 US or equivalent in + * charge currency. The amount value supports up to eight digits (e.g., a value of + * 99999999 for a USD charge of $999,999.99). */ public Builder setAmount(Long amount) { this.amount = amount; @@ -998,8 +1006,9 @@ public Builder setAmount(Long amount) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; diff --git a/src/main/java/com/stripe/param/SetupIntentListParams.java b/src/main/java/com/stripe/param/SetupIntentListParams.java index 437f2be2ce9..5642592b10f 100644 --- a/src/main/java/com/stripe/param/SetupIntentListParams.java +++ b/src/main/java/com/stripe/param/SetupIntentListParams.java @@ -11,8 +11,8 @@ @Getter public class SetupIntentListParams extends ApiRequestParams { /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string with + * an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ @SerializedName("created") Object created; @@ -22,10 +22,10 @@ public class SetupIntentListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -55,10 +55,10 @@ public class SetupIntentListParams extends ApiRequestParams { String paymentMethod; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -117,8 +117,9 @@ public SetupIntentListParams build() { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Created created) { this.created = created; @@ -126,8 +127,9 @@ public Builder setCreated(Created created) { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Long created) { this.created = created; @@ -141,10 +143,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -219,10 +221,10 @@ public Builder setPaymentMethod(String paymentMethod) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/SetupIntentUpdateParams.java b/src/main/java/com/stripe/param/SetupIntentUpdateParams.java index 5a14936517d..f43c48822af 100644 --- a/src/main/java/com/stripe/param/SetupIntentUpdateParams.java +++ b/src/main/java/com/stripe/param/SetupIntentUpdateParams.java @@ -40,7 +40,8 @@ public class SetupIntentUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -54,7 +55,7 @@ public class SetupIntentUpdateParams extends ApiRequestParams { /** * The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If - * this is not provided, defaults to ["card"]. + * this is not provided, defaults to ["card"]. */ @SerializedName("payment_method_types") List paymentMethodTypes; diff --git a/src/main/java/com/stripe/param/SkuCreateParams.java b/src/main/java/com/stripe/param/SkuCreateParams.java index badce05f03a..16412676198 100644 --- a/src/main/java/com/stripe/param/SkuCreateParams.java +++ b/src/main/java/com/stripe/param/SkuCreateParams.java @@ -13,21 +13,21 @@ @Getter public class SkuCreateParams extends ApiRequestParams { - /** Whether the SKU is available for purchase. Default to `true`. */ + /** Whether the SKU is available for purchase. Default to {@code true}. */ @SerializedName("active") Boolean active; /** * A dictionary of attributes and values for the attributes defined by the product. If, for - * example, a product's attributes are `["size", "gender"]`, a valid SKU has the following - * dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. + * example, a product's attributes are {@code ["size", "gender"]}, a valid SKU has the following + * dictionary of attributes: {@code {"size": "Medium", "gender": "Unisex"}}. */ @SerializedName("attributes") Map attributes; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -63,7 +63,8 @@ public class SkuCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -79,7 +80,9 @@ public class SkuCreateParams extends ApiRequestParams { @SerializedName("price") Long price; - /** The ID of the product this SKU is associated with. Must be a product with type `good`. */ + /** + * The ID of the product this SKU is associated with. Must be a product with type {@code good}. + */ @SerializedName("product") String product; @@ -156,7 +159,7 @@ public SkuCreateParams build() { this.product); } - /** Whether the SKU is available for purchase. Default to `true`. */ + /** Whether the SKU is available for purchase. Default to {@code true}. */ public Builder setActive(Boolean active) { this.active = active; return this; @@ -189,8 +192,9 @@ public Builder putAllAttribute(Map map) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -311,7 +315,9 @@ public Builder setPrice(Long price) { return this; } - /** The ID of the product this SKU is associated with. Must be a product with type `good`. */ + /** + * The ID of the product this SKU is associated with. Must be a product with type {@code good}. + */ public Builder setProduct(String product) { this.product = product; return this; @@ -329,17 +335,21 @@ public static class Inventory { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** The count of inventory available. Required if `type` is `finite`. */ + /** The count of inventory available. Required if {@code type} is {@code finite}. */ @SerializedName("quantity") Long quantity; - /** Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ + /** + * Inventory type. Possible values are {@code finite}, {@code bucket} (not quantified), and + * {@code infinite}. + */ @SerializedName("type") Type type; /** - * An indicator of the inventory available. Possible values are `in_stock`, `limited`, and - * `out_of_stock`. Will be present if and only if `type` is `bucket`. + * An indicator of the inventory available. Possible values are {@code in_stock}, {@code + * limited}, and {@code out_of_stock}. Will be present if and only if {@code type} is {@code + * bucket}. */ @SerializedName("value") EnumParam value; @@ -395,14 +405,15 @@ public Builder putAllExtraParam(Map map) { return this; } - /** The count of inventory available. Required if `type` is `finite`. */ + /** The count of inventory available. Required if {@code type} is {@code finite}. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; return this; } /** - * Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. + * Inventory type. Possible values are {@code finite}, {@code bucket} (not quantified), and + * {@code infinite}. */ public Builder setType(Type type) { this.type = type; @@ -410,8 +421,9 @@ public Builder setType(Type type) { } /** - * An indicator of the inventory available. Possible values are `in_stock`, `limited`, and - * `out_of_stock`. Will be present if and only if `type` is `bucket`. + * An indicator of the inventory available. Possible values are {@code in_stock}, {@code + * limited}, and {@code out_of_stock}. Will be present if and only if {@code type} is {@code + * bucket}. */ public Builder setValue(Value value) { this.value = value; @@ -419,8 +431,9 @@ public Builder setValue(Value value) { } /** - * An indicator of the inventory available. Possible values are `in_stock`, `limited`, and - * `out_of_stock`. Will be present if and only if `type` is `bucket`. + * An indicator of the inventory available. Possible values are {@code in_stock}, {@code + * limited}, and {@code out_of_stock}. Will be present if and only if {@code type} is {@code + * bucket}. */ public Builder setValue(EmptyParam value) { this.value = value; diff --git a/src/main/java/com/stripe/param/SkuListParams.java b/src/main/java/com/stripe/param/SkuListParams.java index 376e669e075..c81a4c66230 100644 --- a/src/main/java/com/stripe/param/SkuListParams.java +++ b/src/main/java/com/stripe/param/SkuListParams.java @@ -11,7 +11,7 @@ @Getter public class SkuListParams extends ApiRequestParams { /** - * Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive + * Only return SKUs that are active or inactive (e.g., pass {@code false} to list all inactive * products). */ @SerializedName("active") @@ -19,18 +19,19 @@ public class SkuListParams extends ApiRequestParams { /** * Only return SKUs that have the specified key-value pairs in this partially constructed - * dictionary. Can be specified only if `product` is also supplied. For instance, if the - * associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` - * returns all the SKUs for this product that have `color` set to `red`. + * dictionary. Can be specified only if {@code product} is also supplied. For instance, if the + * associated product has attributes {@code ["color", "size"]}, passing in {@code + * attributes[color]=red} returns all the SKUs for this product that have {@code color} set to + * {@code red}. */ @SerializedName("attributes") Map attributes; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -53,8 +54,8 @@ public class SkuListParams extends ApiRequestParams { List ids; /** - * Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs - * that are out of stock). If no value is provided, all SKUs are returned. + * Only return SKUs that are either in stock or out of stock (e.g., pass {@code false} to list all + * SKUs that are out of stock). If no value is provided, all SKUs are returned. */ @SerializedName("in_stock") Boolean inStock; @@ -66,15 +67,17 @@ public class SkuListParams extends ApiRequestParams { @SerializedName("limit") Long limit; - /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ + /** + * The ID of the product whose SKUs will be retrieved. Must be a product with type {@code good}. + */ @SerializedName("product") String product; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -143,7 +146,7 @@ public SkuListParams build() { } /** - * Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive + * Only return SKUs that are active or inactive (e.g., pass {@code false} to list all inactive * products). */ public Builder setActive(Boolean active) { @@ -178,10 +181,10 @@ public Builder putAllAttribute(Map map) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -267,8 +270,8 @@ public Builder addAllId(List elements) { } /** - * Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all - * SKUs that are out of stock). If no value is provided, all SKUs are returned. + * Only return SKUs that are either in stock or out of stock (e.g., pass {@code false} to list + * all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ public Builder setInStock(Boolean inStock) { this.inStock = inStock; @@ -284,17 +287,19 @@ public Builder setLimit(Long limit) { return this; } - /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ + /** + * The ID of the product whose SKUs will be retrieved. Must be a product with type {@code good}. + */ public Builder setProduct(String product) { this.product = product; return this; } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/SkuUpdateParams.java b/src/main/java/com/stripe/param/SkuUpdateParams.java index 136ce68d305..3847f3298f5 100644 --- a/src/main/java/com/stripe/param/SkuUpdateParams.java +++ b/src/main/java/com/stripe/param/SkuUpdateParams.java @@ -19,7 +19,7 @@ public class SkuUpdateParams extends ApiRequestParams { /** * A dictionary of attributes and values for the attributes defined by the product. When - * specified, `attributes` will partially update the existing attributes dictionary on the + * specified, {@code attributes} will partially update the existing attributes dictionary on the * product, with the postcondition that a value must be present for each attribute key on the * product. */ @@ -27,8 +27,8 @@ public class SkuUpdateParams extends ApiRequestParams { Map attributes; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") Object currency; @@ -57,7 +57,8 @@ public class SkuUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -75,7 +76,7 @@ public class SkuUpdateParams extends ApiRequestParams { /** * The ID of the product that this SKU should belong to. The product must exist, have the same set - * of attribute names as the SKU's current product, and be of type `good`. + * of attribute names as the SKU's current product, and be of type {@code good}. */ @SerializedName("product") Object product; @@ -181,8 +182,9 @@ public Builder putAllAttribute(Map map) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -190,8 +192,9 @@ public Builder setCurrency(String currency) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(EmptyParam currency) { this.currency = currency; @@ -317,7 +320,7 @@ public Builder setPrice(Long price) { /** * The ID of the product that this SKU should belong to. The product must exist, have the same - * set of attribute names as the SKU's current product, and be of type `good`. + * set of attribute names as the SKU's current product, and be of type {@code good}. */ public Builder setProduct(String product) { this.product = product; @@ -326,7 +329,7 @@ public Builder setProduct(String product) { /** * The ID of the product that this SKU should belong to. The product must exist, have the same - * set of attribute names as the SKU's current product, and be of type `good`. + * set of attribute names as the SKU's current product, and be of type {@code good}. */ public Builder setProduct(EmptyParam product) { this.product = product; @@ -345,17 +348,21 @@ public static class Inventory { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** The count of inventory available. Required if `type` is `finite`. */ + /** The count of inventory available. Required if {@code type} is {@code finite}. */ @SerializedName("quantity") Long quantity; - /** Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ + /** + * Inventory type. Possible values are {@code finite}, {@code bucket} (not quantified), and + * {@code infinite}. + */ @SerializedName("type") Type type; /** - * An indicator of the inventory available. Possible values are `in_stock`, `limited`, and - * `out_of_stock`. Will be present if and only if `type` is `bucket`. + * An indicator of the inventory available. Possible values are {@code in_stock}, {@code + * limited}, and {@code out_of_stock}. Will be present if and only if {@code type} is {@code + * bucket}. */ @SerializedName("value") EnumParam value; @@ -411,14 +418,15 @@ public Builder putAllExtraParam(Map map) { return this; } - /** The count of inventory available. Required if `type` is `finite`. */ + /** The count of inventory available. Required if {@code type} is {@code finite}. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; return this; } /** - * Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. + * Inventory type. Possible values are {@code finite}, {@code bucket} (not quantified), and + * {@code infinite}. */ public Builder setType(Type type) { this.type = type; @@ -426,8 +434,9 @@ public Builder setType(Type type) { } /** - * An indicator of the inventory available. Possible values are `in_stock`, `limited`, and - * `out_of_stock`. Will be present if and only if `type` is `bucket`. + * An indicator of the inventory available. Possible values are {@code in_stock}, {@code + * limited}, and {@code out_of_stock}. Will be present if and only if {@code type} is {@code + * bucket}. */ public Builder setValue(Value value) { this.value = value; @@ -435,8 +444,9 @@ public Builder setValue(Value value) { } /** - * An indicator of the inventory available. Possible values are `in_stock`, `limited`, and - * `out_of_stock`. Will be present if and only if `type` is `bucket`. + * An indicator of the inventory available. Possible values are {@code in_stock}, {@code + * limited}, and {@code out_of_stock}. Will be present if and only if {@code type} is {@code + * bucket}. */ public Builder setValue(EmptyParam value) { this.value = value; diff --git a/src/main/java/com/stripe/param/SourceCreateParams.java b/src/main/java/com/stripe/param/SourceCreateParams.java index 93626cdc27d..e976c293b9c 100644 --- a/src/main/java/com/stripe/param/SourceCreateParams.java +++ b/src/main/java/com/stripe/param/SourceCreateParams.java @@ -13,22 +13,23 @@ public class SourceCreateParams extends ApiRequestParams { /** * Amount associated with the source. This is the amount for which the source will be chargeable - * once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where - * charge amount may not be specified until funds land. + * once ready. Required for {@code single_use} sources. Not supported for {@code receiver} type + * sources, where charge amount may not be specified until funds land. */ @SerializedName("amount") Long amount; /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with - * the source. This is the currency for which the source will be chargeable once ready. + * Three-letter ISO code for the currency + * associated with the source. This is the currency for which the source will be chargeable once + * ready. */ @SerializedName("currency") String currency; /** - * The `Customer` to whom the original source is attached to. Must be set when the original source - * is not a `Source` (e.g., `Card`). + * The {@code Customer} to whom the original source is attached to. Must be set when the original + * source is not a {@code Source} (e.g., {@code Card}). */ @SerializedName("customer") String customer; @@ -47,8 +48,9 @@ public class SourceCreateParams extends ApiRequestParams { Map extraParams; /** - * The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, - * `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. + * The authentication {@code flow} of the source to create. {@code flow} is one of {@code + * redirect}, {@code receiver}, {@code code_verification}, {@code none}. It is generally inferred + * unless a type supports multiple flows. */ @SerializedName("flow") Flow flow; @@ -75,15 +77,15 @@ public class SourceCreateParams extends ApiRequestParams { Owner owner; /** - * Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` - * is `receiver`). + * Optional parameters for the receiver flow. Can be set only if the source is a receiver ({@code + * flow} is {@code receiver}). */ @SerializedName("receiver") Receiver receiver; /** * Parameters required for the redirect flow. Required if the source is authenticated by a - * redirect (`flow` is `redirect`). + * redirect ({@code flow} is {@code redirect}). */ @SerializedName("redirect") Redirect redirect; @@ -97,9 +99,9 @@ public class SourceCreateParams extends ApiRequestParams { /** * An arbitrary string to be displayed on your customer's statement. As an example, if your - * website is `RunClub` and the item you're charging for is a race ticket, you may want to specify - * a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display - * this information, some may not display it at all. + * website is {@code RunClub} and the item you're charging for is a race ticket, you may want to + * specify a {@code statement_descriptor} of {@code RunClub 5K race ticket.} While many payment + * types will display this information, some may not display it at all. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -112,9 +114,10 @@ public class SourceCreateParams extends ApiRequestParams { String token; /** - * The `type` of the source to create. Required unless `customer` and `original_source` are - * specified (see the [Cloning card - * Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) + * The {@code type} of the source to create. Required unless {@code customer} and {@code + * original_source} are specified (see the Cloning card Sources + * guide) */ @SerializedName("type") String type; @@ -222,8 +225,8 @@ public SourceCreateParams build() { /** * Amount associated with the source. This is the amount for which the source will be chargeable - * once ready. Required for `single_use` sources. Not supported for `receiver` type sources, - * where charge amount may not be specified until funds land. + * once ready. Required for {@code single_use} sources. Not supported for {@code receiver} type + * sources, where charge amount may not be specified until funds land. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -231,8 +234,9 @@ public Builder setAmount(Long amount) { } /** - * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with - * the source. This is the currency for which the source will be chargeable once ready. + * Three-letter ISO code for the currency + * associated with the source. This is the currency for which the source will be chargeable once + * ready. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -240,8 +244,8 @@ public Builder setCurrency(String currency) { } /** - * The `Customer` to whom the original source is attached to. Must be set when the original - * source is not a `Source` (e.g., `Card`). + * The {@code Customer} to whom the original source is attached to. Must be set when the + * original source is not a {@code Source} (e.g., {@code Card}). */ public Builder setCustomer(String customer) { this.customer = customer; @@ -301,8 +305,9 @@ public Builder putAllExtraParam(Map map) { } /** - * The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, - * `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. + * The authentication {@code flow} of the source to create. {@code flow} is one of {@code + * redirect}, {@code receiver}, {@code code_verification}, {@code none}. It is generally + * inferred unless a type supports multiple flows. */ public Builder setFlow(Flow flow) { this.flow = flow; @@ -361,7 +366,7 @@ public Builder setOwner(Owner owner) { /** * Optional parameters for the receiver flow. Can be set only if the source is a receiver - * (`flow` is `receiver`). + * ({@code flow} is {@code receiver}). */ public Builder setReceiver(Receiver receiver) { this.receiver = receiver; @@ -370,7 +375,7 @@ public Builder setReceiver(Receiver receiver) { /** * Parameters required for the redirect flow. Required if the source is authenticated by a - * redirect (`flow` is `redirect`). + * redirect ({@code flow} is {@code redirect}). */ public Builder setRedirect(Redirect redirect) { this.redirect = redirect; @@ -388,9 +393,9 @@ public Builder setSourceOrder(SourceOrder sourceOrder) { /** * An arbitrary string to be displayed on your customer's statement. As an example, if your - * website is `RunClub` and the item you're charging for is a race ticket, you may want to - * specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will - * display this information, some may not display it at all. + * website is {@code RunClub} and the item you're charging for is a race ticket, you may want to + * specify a {@code statement_descriptor} of {@code RunClub 5K race ticket.} While many payment + * types will display this information, some may not display it at all. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -407,9 +412,10 @@ public Builder setToken(String token) { } /** - * The `type` of the source to create. Required unless `customer` and `original_source` are - * specified (see the [Cloning card - * Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) + * The {@code type} of the source to create. Required unless {@code customer} and {@code + * original_source} are specified (see the Cloning card Sources + * guide) */ public Builder setType(String type) { this.type = type; @@ -434,7 +440,7 @@ public static class Mandate { @SerializedName("amount") Object amount; - /** The currency specified by the mandate. (Must match `currency` of the source) */ + /** The currency specified by the mandate. (Must match {@code currency} of the source) */ @SerializedName("currency") String currency; @@ -448,19 +454,20 @@ public static class Mandate { Map extraParams; /** - * The interval of debits permitted by the mandate. Either `one_time` (just permitting a single - * debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or - * `variable`(for debits with any frequency) + * The interval of debits permitted by the mandate. Either {@code one_time} (just permitting a + * single debit), {@code scheduled} (with debits on an agreed schedule or for clearly-defined + * events), or {@code variable}(for debits with any frequency) */ @SerializedName("interval") Interval interval; /** * The method Stripe should use to notify the customer of upcoming debit instructions and/or - * mandate confirmation as required by the underlying debit network. Either `email` (an email is - * sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to - * your webhooks endpoint and you should handle the notification) or `none` (the underlying - * debit network does not require any notification). + * mandate confirmation as required by the underlying debit network. Either {@code email} (an + * email is sent directly to the customer), {@code manual} (a {@code + * source.mandate_notification} event is sent to your webhooks endpoint and you should handle + * the notification) or {@code none} (the underlying debit network does not require any + * notification). */ @SerializedName("notification_method") NotificationMethod notificationMethod; @@ -529,7 +536,7 @@ public Builder setAmount(EmptyParam amount) { return this; } - /** The currency specified by the mandate. (Must match `currency` of the source) */ + /** The currency specified by the mandate. (Must match {@code currency} of the source) */ public Builder setCurrency(String currency) { this.currency = currency; return this; @@ -562,9 +569,9 @@ public Builder putAllExtraParam(Map map) { } /** - * The interval of debits permitted by the mandate. Either `one_time` (just permitting a - * single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined - * events), or `variable`(for debits with any frequency) + * The interval of debits permitted by the mandate. Either {@code one_time} (just permitting a + * single debit), {@code scheduled} (with debits on an agreed schedule or for clearly-defined + * events), or {@code variable}(for debits with any frequency) */ public Builder setInterval(Interval interval) { this.interval = interval; @@ -573,10 +580,11 @@ public Builder setInterval(Interval interval) { /** * The method Stripe should use to notify the customer of upcoming debit instructions and/or - * mandate confirmation as required by the underlying debit network. Either `email` (an email - * is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent - * to your webhooks endpoint and you should handle the notification) or `none` (the underlying - * debit network does not require any notification). + * mandate confirmation as required by the underlying debit network. Either {@code email} (an + * email is sent directly to the customer), {@code manual} (a {@code + * source.mandate_notification} event is sent to your webhooks endpoint and you should handle + * the notification) or {@code none} (the underlying debit network does not require any + * notification). */ public Builder setNotificationMethod(NotificationMethod notificationMethod) { this.notificationMethod = notificationMethod; @@ -606,28 +614,29 @@ public static class Acceptance { String ip; /** - * The parameters required to store a mandate accepted offline. Should only be set if - * `mandate[type]` is `offline` + * The parameters required to store a mandate accepted offline. Should only be set if {@code + * mandate[type]} is {@code offline} */ @SerializedName("offline") Offline offline; /** - * The parameters required to store a mandate accepted online. Should only be set if - * `mandate[type]` is `online` + * The parameters required to store a mandate accepted online. Should only be set if {@code + * mandate[type]} is {@code online} */ @SerializedName("online") Online online; /** - * The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or - * `refused` (the mandate was refused). + * The status of the mandate acceptance. Either {@code accepted} (the mandate was accepted) or + * {@code refused} (the mandate was refused). */ @SerializedName("status") Status status; /** - * The type of acceptance information included with the mandate. Either `online` or `offline` + * The type of acceptance information included with the mandate. Either {@code online} or + * {@code offline} */ @SerializedName("type") Type type; @@ -735,8 +744,8 @@ public Builder setIp(String ip) { } /** - * The parameters required to store a mandate accepted offline. Should only be set if - * `mandate[type]` is `offline` + * The parameters required to store a mandate accepted offline. Should only be set if {@code + * mandate[type]} is {@code offline} */ public Builder setOffline(Offline offline) { this.offline = offline; @@ -744,8 +753,8 @@ public Builder setOffline(Offline offline) { } /** - * The parameters required to store a mandate accepted online. Should only be set if - * `mandate[type]` is `online` + * The parameters required to store a mandate accepted online. Should only be set if {@code + * mandate[type]} is {@code online} */ public Builder setOnline(Online online) { this.online = online; @@ -753,8 +762,8 @@ public Builder setOnline(Online online) { } /** - * The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or - * `refused` (the mandate was refused). + * The status of the mandate acceptance. Either {@code accepted} (the mandate was accepted) + * or {@code refused} (the mandate was refused). */ public Builder setStatus(Status status) { this.status = status; @@ -762,8 +771,8 @@ public Builder setStatus(Status status) { } /** - * The type of acceptance information included with the mandate. Either `online` or - * `offline` + * The type of acceptance information included with the mandate. Either {@code online} or + * {@code offline} */ public Builder setType(Type type) { this.type = type; @@ -783,8 +792,8 @@ public Builder setUserAgent(String userAgent) { @Getter public static class Offline { /** - * An email to contact you with if a copy of the mandate is requested, required if `type` is - * `offline`. + * An email to contact you with if a copy of the mandate is requested, required if {@code + * type} is {@code offline}. */ @SerializedName("contact_email") String contactEmail; @@ -819,8 +828,8 @@ public Offline build() { } /** - * An email to contact you with if a copy of the mandate is requested, required if `type` - * is `offline`. + * An email to contact you with if a copy of the mandate is requested, required if {@code + * type} is {@code offline}. */ public Builder setContactEmail(String contactEmail) { this.contactEmail = contactEmail; @@ -1159,8 +1168,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1245,8 +1254,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1321,8 +1330,8 @@ public static class Receiver { /** * The method Stripe should use to request information needed to process a refund or mispayment. - * Either `email` (an email is sent directly to the customer) or `manual` (a - * `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each + * Either {@code email} (an email is sent directly to the customer) or {@code manual} (a {@code + * source.refund_attributes_required} event is sent to your webhooks endpoint). Refer to each * payment method's documentation to learn which refund attributes may be required. */ @SerializedName("refund_attributes_method") @@ -1376,9 +1385,10 @@ public Builder putAllExtraParam(Map map) { /** * The method Stripe should use to request information needed to process a refund or - * mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a - * `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each - * payment method's documentation to learn which refund attributes may be required. + * mispayment. Either {@code email} (an email is sent directly to the customer) or {@code + * manual} (a {@code source.refund_attributes_required} event is sent to your webhooks + * endpoint). Refer to each payment method's documentation to learn which refund attributes + * may be required. */ public Builder setRefundAttributesMethod(RefundAttributesMethod refundAttributesMethod) { this.refundAttributesMethod = refundAttributesMethod; @@ -1495,8 +1505,8 @@ public static class SourceOrder { List items; /** - * Shipping address for the order. Required if any of the SKUs are for products that have - * `shippable` set to true. + * Shipping address for the order. Required if any of the SKUs are for products that have {@code + * shippable} set to true. */ @SerializedName("shipping") Shipping shipping; @@ -1577,7 +1587,7 @@ public Builder addAllItem(List elements) { /** * Shipping address for the order. Required if any of the SKUs are for products that have - * `shippable` set to true. + * {@code shippable} set to true. */ public Builder setShipping(Shipping shipping) { this.shipping = shipping; @@ -1610,8 +1620,8 @@ public static class Item { String parent; /** - * The quantity of this order item. When type is `sku`, this is the number of instances of the - * SKU to be ordered. + * The quantity of this order item. When type is {@code sku}, this is the number of instances + * of the SKU to be ordered. */ @SerializedName("quantity") Long quantity; @@ -1717,8 +1727,8 @@ public Builder setParent(String parent) { } /** - * The quantity of this order item. When type is `sku`, this is the number of instances of - * the SKU to be ordered. + * The quantity of this order item. When type is {@code sku}, this is the number of + * instances of the SKU to be ordered. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; @@ -1900,8 +1910,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1987,8 +1997,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; diff --git a/src/main/java/com/stripe/param/SourceSourceTransactionsParams.java b/src/main/java/com/stripe/param/SourceSourceTransactionsParams.java index 948e9728eab..ad5ae5df00c 100644 --- a/src/main/java/com/stripe/param/SourceSourceTransactionsParams.java +++ b/src/main/java/com/stripe/param/SourceSourceTransactionsParams.java @@ -11,10 +11,10 @@ @Getter public class SourceSourceTransactionsParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class SourceSourceTransactionsParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public SourceSourceTransactionsParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/SourceUpdateParams.java b/src/main/java/com/stripe/param/SourceUpdateParams.java index b4eeaaa2dd8..7dbf2a8c1c4 100644 --- a/src/main/java/com/stripe/param/SourceUpdateParams.java +++ b/src/main/java/com/stripe/param/SourceUpdateParams.java @@ -38,7 +38,8 @@ public class SourceUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -229,7 +230,7 @@ public static class Mandate { @SerializedName("amount") Object amount; - /** The currency specified by the mandate. (Must match `currency` of the source) */ + /** The currency specified by the mandate. (Must match {@code currency} of the source) */ @SerializedName("currency") Object currency; @@ -243,19 +244,20 @@ public static class Mandate { Map extraParams; /** - * The interval of debits permitted by the mandate. Either `one_time` (just permitting a single - * debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or - * `variable`(for debits with any frequency) + * The interval of debits permitted by the mandate. Either {@code one_time} (just permitting a + * single debit), {@code scheduled} (with debits on an agreed schedule or for clearly-defined + * events), or {@code variable}(for debits with any frequency) */ @SerializedName("interval") Interval interval; /** * The method Stripe should use to notify the customer of upcoming debit instructions and/or - * mandate confirmation as required by the underlying debit network. Either `email` (an email is - * sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to - * your webhooks endpoint and you should handle the notification) or `none` (the underlying - * debit network does not require any notification). + * mandate confirmation as required by the underlying debit network. Either {@code email} (an + * email is sent directly to the customer), {@code manual} (a {@code + * source.mandate_notification} event is sent to your webhooks endpoint and you should handle + * the notification) or {@code none} (the underlying debit network does not require any + * notification). */ @SerializedName("notification_method") NotificationMethod notificationMethod; @@ -324,13 +326,13 @@ public Builder setAmount(EmptyParam amount) { return this; } - /** The currency specified by the mandate. (Must match `currency` of the source) */ + /** The currency specified by the mandate. (Must match {@code currency} of the source) */ public Builder setCurrency(String currency) { this.currency = currency; return this; } - /** The currency specified by the mandate. (Must match `currency` of the source) */ + /** The currency specified by the mandate. (Must match {@code currency} of the source) */ public Builder setCurrency(EmptyParam currency) { this.currency = currency; return this; @@ -363,9 +365,9 @@ public Builder putAllExtraParam(Map map) { } /** - * The interval of debits permitted by the mandate. Either `one_time` (just permitting a - * single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined - * events), or `variable`(for debits with any frequency) + * The interval of debits permitted by the mandate. Either {@code one_time} (just permitting a + * single debit), {@code scheduled} (with debits on an agreed schedule or for clearly-defined + * events), or {@code variable}(for debits with any frequency) */ public Builder setInterval(Interval interval) { this.interval = interval; @@ -374,10 +376,11 @@ public Builder setInterval(Interval interval) { /** * The method Stripe should use to notify the customer of upcoming debit instructions and/or - * mandate confirmation as required by the underlying debit network. Either `email` (an email - * is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent - * to your webhooks endpoint and you should handle the notification) or `none` (the underlying - * debit network does not require any notification). + * mandate confirmation as required by the underlying debit network. Either {@code email} (an + * email is sent directly to the customer), {@code manual} (a {@code + * source.mandate_notification} event is sent to your webhooks endpoint and you should handle + * the notification) or {@code none} (the underlying debit network does not require any + * notification). */ public Builder setNotificationMethod(NotificationMethod notificationMethod) { this.notificationMethod = notificationMethod; @@ -407,28 +410,29 @@ public static class Acceptance { Object ip; /** - * The parameters required to store a mandate accepted offline. Should only be set if - * `mandate[type]` is `offline` + * The parameters required to store a mandate accepted offline. Should only be set if {@code + * mandate[type]} is {@code offline} */ @SerializedName("offline") Offline offline; /** - * The parameters required to store a mandate accepted online. Should only be set if - * `mandate[type]` is `online` + * The parameters required to store a mandate accepted online. Should only be set if {@code + * mandate[type]} is {@code online} */ @SerializedName("online") Online online; /** - * The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or - * `refused` (the mandate was refused). + * The status of the mandate acceptance. Either {@code accepted} (the mandate was accepted) or + * {@code refused} (the mandate was refused). */ @SerializedName("status") Status status; /** - * The type of acceptance information included with the mandate. Either `online` or `offline` + * The type of acceptance information included with the mandate. Either {@code online} or + * {@code offline} */ @SerializedName("type") Type type; @@ -542,8 +546,8 @@ public Builder setIp(EmptyParam ip) { } /** - * The parameters required to store a mandate accepted offline. Should only be set if - * `mandate[type]` is `offline` + * The parameters required to store a mandate accepted offline. Should only be set if {@code + * mandate[type]} is {@code offline} */ public Builder setOffline(Offline offline) { this.offline = offline; @@ -551,8 +555,8 @@ public Builder setOffline(Offline offline) { } /** - * The parameters required to store a mandate accepted online. Should only be set if - * `mandate[type]` is `online` + * The parameters required to store a mandate accepted online. Should only be set if {@code + * mandate[type]} is {@code online} */ public Builder setOnline(Online online) { this.online = online; @@ -560,8 +564,8 @@ public Builder setOnline(Online online) { } /** - * The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or - * `refused` (the mandate was refused). + * The status of the mandate acceptance. Either {@code accepted} (the mandate was accepted) + * or {@code refused} (the mandate was refused). */ public Builder setStatus(Status status) { this.status = status; @@ -569,8 +573,8 @@ public Builder setStatus(Status status) { } /** - * The type of acceptance information included with the mandate. Either `online` or - * `offline` + * The type of acceptance information included with the mandate. Either {@code online} or + * {@code offline} */ public Builder setType(Type type) { this.type = type; @@ -599,8 +603,8 @@ public Builder setUserAgent(EmptyParam userAgent) { @Getter public static class Offline { /** - * An email to contact you with if a copy of the mandate is requested, required if `type` is - * `offline`. + * An email to contact you with if a copy of the mandate is requested, required if {@code + * type} is {@code offline}. */ @SerializedName("contact_email") Object contactEmail; @@ -635,8 +639,8 @@ public Offline build() { } /** - * An email to contact you with if a copy of the mandate is requested, required if `type` - * is `offline`. + * An email to contact you with if a copy of the mandate is requested, required if {@code + * type} is {@code offline}. */ public Builder setContactEmail(String contactEmail) { this.contactEmail = contactEmail; @@ -644,8 +648,8 @@ public Builder setContactEmail(String contactEmail) { } /** - * An email to contact you with if a copy of the mandate is requested, required if `type` - * is `offline`. + * An email to contact you with if a copy of the mandate is requested, required if {@code + * type} is {@code offline}. */ public Builder setContactEmail(EmptyParam contactEmail) { this.contactEmail = contactEmail; @@ -1017,8 +1021,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -1109,8 +1113,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1118,8 +1122,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -1221,8 +1225,8 @@ public static class SourceOrder { List items; /** - * Shipping address for the order. Required if any of the SKUs are for products that have - * `shippable` set to true. + * Shipping address for the order. Required if any of the SKUs are for products that have {@code + * shippable} set to true. */ @SerializedName("shipping") Shipping shipping; @@ -1303,7 +1307,7 @@ public Builder addAllItem(List elements) { /** * Shipping address for the order. Required if any of the SKUs are for products that have - * `shippable` set to true. + * {@code shippable} set to true. */ public Builder setShipping(Shipping shipping) { this.shipping = shipping; @@ -1336,8 +1340,8 @@ public static class Item { Object parent; /** - * The quantity of this order item. When type is `sku`, this is the number of instances of the - * SKU to be ordered. + * The quantity of this order item. When type is {@code sku}, this is the number of instances + * of the SKU to be ordered. */ @SerializedName("quantity") Long quantity; @@ -1459,8 +1463,8 @@ public Builder setParent(EmptyParam parent) { } /** - * The quantity of this order item. When type is `sku`, this is the number of instances of - * the SKU to be ordered. + * The quantity of this order item. When type is {@code sku}, this is the number of + * instances of the SKU to be ordered. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; @@ -1670,8 +1674,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -1763,8 +1767,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1772,8 +1776,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; diff --git a/src/main/java/com/stripe/param/SubscriptionCreateParams.java b/src/main/java/com/stripe/param/SubscriptionCreateParams.java index 14b15832fec..db006631bb8 100644 --- a/src/main/java/com/stripe/param/SubscriptionCreateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionCreateParams.java @@ -17,7 +17,8 @@ public class SubscriptionCreateParams extends ApiRequestParams { * percentage of the subscription invoice subtotal that will be transferred to the application * owner's Stripe account. The request must be made by a platform account on a connected account * in order to set an application fee percentage. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * documentation. */ @SerializedName("application_fee_percent") BigDecimal applicationFeePercent; @@ -31,10 +32,10 @@ public class SubscriptionCreateParams extends ApiRequestParams { Long backdateStartDate; /** - * A future timestamp to anchor the subscription's [billing - * cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date - * of the first full invoice, and, for plans with `month` or `year` intervals, the day of the - * month for subsequent invoices. + * A future timestamp to anchor the subscription's billing cycle. This is used to + * determine the date of the first full invoice, and, for plans with {@code month} or {@code year} + * intervals, the day of the month for subsequent invoices. */ @SerializedName("billing_cycle_anchor") Long billingCycleAnchor; @@ -48,8 +49,9 @@ public class SubscriptionCreateParams extends ApiRequestParams { /** * A timestamp at which the subscription should cancel. If set to a date before the current period - * ends, this will cause a proration if prorations have been enabled using `proration_behavior`. - * If set during a future period, this will always cause a proration for that period. + * ends, this will cause a proration if prorations have been enabled using {@code + * proration_behavior}. If set during a future period, this will always cause a proration for that + * period. */ @SerializedName("cancel_at") Long cancelAt; @@ -61,10 +63,10 @@ public class SubscriptionCreateParams extends ApiRequestParams { Boolean cancelAtPeriodEnd; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay this subscription at the end of the cycle using the default source attached to - * the customer. When sending an invoice, Stripe will email your customer an invoice with payment - * instructions. Defaults to `charge_automatically`. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay this subscription at the end of the cycle using the default source + * attached to the customer. When sending an invoice, Stripe will email your customer an invoice + * with payment instructions. Defaults to {@code charge_automatically}. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -82,7 +84,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { /** * Number of days a customer has to pay invoices generated by this subscription. Valid only for - * subscriptions where `collection_method` is set to `send_invoice`. + * subscriptions where {@code collection_method} is set to {@code send_invoice}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -104,8 +106,9 @@ public class SubscriptionCreateParams extends ApiRequestParams { String defaultSource; /** - * The tax rates that will apply to any subscription item that does not have `tax_rates` set. - * Invoices created will have their `default_tax_rates` populated from the subscription. + * The tax rates that will apply to any subscription item that does not have {@code tax_rates} + * set. Invoices created will have their {@code default_tax_rates} populated from the + * subscription. */ @SerializedName("default_tax_rates") Object defaultTaxRates; @@ -130,7 +133,8 @@ public class SubscriptionCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -140,47 +144,48 @@ public class SubscriptionCreateParams extends ApiRequestParams { Boolean offSession; /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA regulation - * may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to - * learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does not * create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) - * to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ @SerializedName("payment_behavior") PaymentBehavior paymentBehavior; /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given - * subscription at the specified interval. + * calling Create an invoice for the + * given subscription at the specified interval. */ @SerializedName("pending_invoice_item_interval") Object pendingInvoiceItemInterval; /** - * This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with - * `proration_behavior=create_prorations` and `prorate=false` can be replaced with - * `proration_behavior=none`. + * This field has been renamed to {@code proration_behavior}. {@code prorate=true} can be replaced + * with {@code proration_behavior=create_prorations} and {@code prorate=false} can be replaced + * with {@code proration_behavior=none}. */ @SerializedName("prorate") Boolean prorate; /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the - * `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. + * Determines how to handle prorations resulting + * from the {@code billing_cycle_anchor}. Valid values are {@code create_prorations} or {@code + * none}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is - * `create_prorations`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. Prorations can be disabled by passing {@code none}. If no value is passed, the + * default is {@code create_prorations}. */ @SerializedName("proration_behavior") ProrationBehavior prorationBehavior; @@ -189,10 +194,11 @@ public class SubscriptionCreateParams extends ApiRequestParams { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax to * the final amount in each billing period. For example, a plan which charges $10/month with a - * `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an - * empty string. This field has been deprecated and will be removed in a future API version, for - * further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) - * for `tax_rates`. + * {@code tax_percent} of {@code 20.0} will charge $12 per invoice. To unset a previously-set + * value, pass an empty string. This field has been deprecated and will be removed in a future API + * version, for further information view the migration docs for {@code + * tax_rates}. */ @SerializedName("tax_percent") Object taxPercent; @@ -209,16 +215,16 @@ public class SubscriptionCreateParams extends ApiRequestParams { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the customer's - * trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ @SerializedName("trial_end") Object trialEnd; /** - * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting - * `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to - * `true` together with `trial_end` is not allowed. + * Indicates if a plan's {@code trial_period_days} should be applied to the subscription. Setting + * {@code trial_end} per subscription is preferred, and this defaults to {@code false}. Setting + * this flag to {@code true} together with {@code trial_end} is not allowed. */ @SerializedName("trial_from_plan") Boolean trialFromPlan; @@ -383,8 +389,8 @@ public SubscriptionCreateParams build() { * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. The request must be made by a platform account on a * connected account in order to set an application fee percentage. For more information, see - * the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * the application fees documentation. */ public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) { this.applicationFeePercent = applicationFeePercent; @@ -402,10 +408,10 @@ public Builder setBackdateStartDate(Long backdateStartDate) { } /** - * A future timestamp to anchor the subscription's [billing - * cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the - * date of the first full invoice, and, for plans with `month` or `year` intervals, the day of - * the month for subsequent invoices. + * A future timestamp to anchor the subscription's billing cycle. This is used to + * determine the date of the first full invoice, and, for plans with {@code month} or {@code + * year} intervals, the day of the month for subsequent invoices. */ public Builder setBillingCycleAnchor(Long billingCycleAnchor) { this.billingCycleAnchor = billingCycleAnchor; @@ -432,8 +438,8 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { /** * A timestamp at which the subscription should cancel. If set to a date before the current - * period ends, this will cause a proration if prorations have been enabled using - * `proration_behavior`. If set during a future period, this will always cause a proration for + * period ends, this will cause a proration if prorations have been enabled using {@code + * proration_behavior}. If set during a future period, this will always cause a proration for * that period. */ public Builder setCancelAt(Long cancelAt) { @@ -450,10 +456,10 @@ public Builder setCancelAtPeriodEnd(Boolean cancelAtPeriodEnd) { } /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay this subscription at the end of the cycle using the default source attached to - * the customer. When sending an invoice, Stripe will email your customer an invoice with - * payment instructions. Defaults to `charge_automatically`. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay this subscription at the end of the cycle using the default source + * attached to the customer. When sending an invoice, Stripe will email your customer an invoice + * with payment instructions. Defaults to {@code charge_automatically}. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -477,7 +483,7 @@ public Builder setCustomer(String customer) { /** * Number of days a customer has to pay invoices generated by this subscription. Valid only for - * subscriptions where `collection_method` is set to `send_invoice`. + * subscriptions where {@code collection_method} is set to {@code send_invoice}. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -533,8 +539,9 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * The tax rates that will apply to any subscription item that does not have `tax_rates` set. - * Invoices created will have their `default_tax_rates` populated from the subscription. + * The tax rates that will apply to any subscription item that does not have {@code tax_rates} + * set. Invoices created will have their {@code default_tax_rates} populated from the + * subscription. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -542,8 +549,9 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * The tax rates that will apply to any subscription item that does not have `tax_rates` set. - * Invoices created will have their `default_tax_rates` populated from the subscription. + * The tax rates that will apply to any subscription item that does not have {@code tax_rates} + * set. Invoices created will have their {@code default_tax_rates} populated from the + * subscription. */ public Builder setDefaultTaxRates(List defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -661,19 +669,19 @@ public Builder setOffSession(Boolean offSession) { } /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA - * regulation may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing - * to learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does * not create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the - * [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ public Builder setPaymentBehavior(PaymentBehavior paymentBehavior) { this.paymentBehavior = paymentBehavior; @@ -682,8 +690,8 @@ public Builder setPaymentBehavior(PaymentBehavior paymentBehavior) { /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given - * subscription at the specified interval. + * calling Create an invoice for the + * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval( PendingInvoiceItemInterval pendingInvoiceItemInterval) { @@ -693,8 +701,8 @@ public Builder setPendingInvoiceItemInterval( /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given - * subscription at the specified interval. + * calling Create an invoice for the + * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterval) { this.pendingInvoiceItemInterval = pendingInvoiceItemInterval; @@ -702,9 +710,9 @@ public Builder setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterv } /** - * This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with - * `proration_behavior=create_prorations` and `prorate=false` can be replaced with - * `proration_behavior=none`. + * This field has been renamed to {@code proration_behavior}. {@code prorate=true} can be + * replaced with {@code proration_behavior=create_prorations} and {@code prorate=false} can be + * replaced with {@code proration_behavior=none}. */ public Builder setProrate(Boolean prorate) { this.prorate = prorate; @@ -712,13 +720,14 @@ public Builder setProrate(Boolean prorate) { } /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from - * the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. + * Determines how to handle prorations + * resulting from the {@code billing_cycle_anchor}. Valid values are {@code create_prorations} + * or {@code none}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. Prorations can be disabled by passing `none`. If no value is passed, the default - * is `create_prorations`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. Prorations can be disabled by passing {@code none}. If no value is passed, the + * default is {@code create_prorations}. */ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { this.prorationBehavior = prorationBehavior; @@ -729,10 +738,11 @@ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax * to the final amount in each billing period. For example, a plan which charges $10/month with - * a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass - * an empty string. This field has been deprecated and will be removed in a future API version, - * for further information view the [migration - * docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * a {@code tax_percent} of {@code 20.0} will charge $12 per invoice. To unset a previously-set + * value, pass an empty string. This field has been deprecated and will be removed in a future + * API version, for further information view the migration docs for {@code + * tax_rates}. */ public Builder setTaxPercent(BigDecimal taxPercent) { this.taxPercent = taxPercent; @@ -743,10 +753,11 @@ public Builder setTaxPercent(BigDecimal taxPercent) { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax * to the final amount in each billing period. For example, a plan which charges $10/month with - * a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass - * an empty string. This field has been deprecated and will be removed in a future API version, - * for further information view the [migration - * docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * a {@code tax_percent} of {@code 20.0} will charge $12 per invoice. To unset a previously-set + * value, pass an empty string. This field has been deprecated and will be removed in a future + * API version, for further information view the migration docs for {@code + * tax_rates}. */ public Builder setTaxPercent(EmptyParam taxPercent) { this.taxPercent = taxPercent; @@ -767,8 +778,8 @@ public Builder setTransferData(TransferData transferData) { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the - * customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ public Builder setTrialEnd(TrialEnd trialEnd) { this.trialEnd = trialEnd; @@ -779,8 +790,8 @@ public Builder setTrialEnd(TrialEnd trialEnd) { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the - * customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ public Builder setTrialEnd(Long trialEnd) { this.trialEnd = trialEnd; @@ -788,9 +799,9 @@ public Builder setTrialEnd(Long trialEnd) { } /** - * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting - * `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to - * `true` together with `trial_end` is not allowed. + * Indicates if a plan's {@code trial_period_days} should be applied to the subscription. + * Setting {@code trial_end} per subscription is preferred, and this defaults to {@code false}. + * Setting this flag to {@code true} together with {@code trial_end} is not allowed. */ public Builder setTrialFromPlan(Boolean trialFromPlan) { this.trialFromPlan = trialFromPlan; @@ -823,9 +834,9 @@ public static class BillingThresholds { Map extraParams; /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, - * `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; - * otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. If + * true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was last + * reached; otherwise, the value will remain unchanged. */ @SerializedName("reset_billing_cycle_anchor") Boolean resetBillingCycleAnchor; @@ -888,9 +899,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. + * If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was + * last reached; otherwise, the value will remain unchanged. */ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { this.resetBillingCycleAnchor = resetBillingCycleAnchor; @@ -920,8 +931,8 @@ public static class Item { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -935,11 +946,11 @@ public static class Item { Long quantity; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ @SerializedName("tax_rates") Object taxRates; @@ -1100,11 +1111,11 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -1112,11 +1123,11 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; @@ -1206,13 +1217,16 @@ public static class PendingInvoiceItemInterval { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. */ + /** + * Specifies invoicing frequency. Either {@code day}, {@code week}, {@code month} or {@code + * year}. + */ @SerializedName("interval") Interval interval; /** - * The number of intervals between invoices. For example, `interval=month` and - * `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 + * The number of intervals between invoices. For example, {@code interval=month} and {@code + * interval_count=3} bills every 3 months. Maximum of one year interval allowed (1 year, 12 * months, or 52 weeks). */ @SerializedName("interval_count") @@ -1269,15 +1283,18 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. */ + /** + * Specifies invoicing frequency. Either {@code day}, {@code week}, {@code month} or {@code + * year}. + */ public Builder setInterval(Interval interval) { this.interval = interval; return this; } /** - * The number of intervals between invoices. For example, `interval=month` and - * `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 + * The number of intervals between invoices. For example, {@code interval=month} and {@code + * interval_count=3} bills every 3 months. Maximum of one year interval allowed (1 year, 12 * months, or 52 weeks). */ public Builder setIntervalCount(Long intervalCount) { diff --git a/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java b/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java index 1c91feb43ed..049f025a6ef 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java @@ -34,25 +34,26 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA regulation - * may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to - * learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does not * create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) - * to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ @SerializedName("payment_behavior") PaymentBehavior paymentBehavior; @@ -62,35 +63,37 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { String plan; /** - * Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) - * switching plans during a billing cycle. This field has been deprecated and will be removed in a - * future API version. Use `proration_behavior=create_prorations` as a replacement for - * `prorate=true` and `proration_behavior=none` for `prorate=false`. + * Flag indicating whether to prorate switching plans + * during a billing cycle. This field has been deprecated and will be removed in a future API + * version. Use {@code proration_behavior=create_prorations} as a replacement for {@code + * prorate=true} and {@code proration_behavior=none} for {@code prorate=false}. */ @SerializedName("prorate") Boolean prorate; /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a - * trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or - * `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, + * or starting a trial), or if an item's {@code quantity} changes. Valid values are {@code + * create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In - * order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ @SerializedName("proration_behavior") ProrationBehavior prorationBehavior; /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply the same proration that was previewed with the [upcoming - * invoice](#retrieve_customer_invoice) endpoint. + * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. */ @SerializedName("proration_date") Long prorationDate; @@ -104,11 +107,11 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { String subscription; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override - * the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ @SerializedName("tax_rates") Object taxRates; @@ -283,19 +286,19 @@ public Builder putAllMetadata(Map map) { } /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA - * regulation may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing - * to learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does * not create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the - * [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ public Builder setPaymentBehavior(PaymentBehavior paymentBehavior) { this.paymentBehavior = paymentBehavior; @@ -309,11 +312,11 @@ public Builder setPlan(String plan) { } /** - * Flag indicating whether to - * [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a - * billing cycle. This field has been deprecated and will be removed in a future API version. - * Use `proration_behavior=create_prorations` as a replacement for `prorate=true` and - * `proration_behavior=none` for `prorate=false`. + * Flag indicating whether to prorate switching plans + * during a billing cycle. This field has been deprecated and will be removed in a future API + * version. Use {@code proration_behavior=create_prorations} as a replacement for {@code + * prorate=true} and {@code proration_behavior=none} for {@code prorate=false}. */ public Builder setProrate(Boolean prorate) { this.prorate = prorate; @@ -321,18 +324,19 @@ public Builder setProrate(Boolean prorate) { } /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting - * a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, - * or `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code + * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. + * Valid values are {@code create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). - * In order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { this.prorationBehavior = prorationBehavior; @@ -341,8 +345,8 @@ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply the same proration that was previewed with the [upcoming - * invoice](#retrieve_customer_invoice) endpoint. + * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. */ public Builder setProrationDate(Long prorationDate) { this.prorationDate = prorationDate; @@ -390,11 +394,11 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -402,11 +406,11 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; diff --git a/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java b/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java index 58712b1c68a..1988c02d2d7 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java @@ -9,8 +9,8 @@ @Getter public class SubscriptionItemDeleteParams extends ApiRequestParams { /** - * Delete all usage for the given subscription item. Allowed only when the current plan's - * `usage_type` is `metered`. + * Delete all usage for the given subscription item. Allowed only when the current plan's {@code + * usage_type} is {@code metered}. */ @SerializedName("clear_usage") Boolean clearUsage; @@ -25,16 +25,17 @@ public class SubscriptionItemDeleteParams extends ApiRequestParams { Map extraParams; /** - * Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) - * switching plans during a billing cycle. + * Flag indicating whether to prorate switching plans + * during a billing cycle. */ @SerializedName("prorate") Boolean prorate; /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply the same proration that was previewed with the [upcoming - * invoice](#retrieve_customer_invoice) endpoint. + * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. */ @SerializedName("proration_date") Long prorationDate; @@ -67,8 +68,8 @@ public SubscriptionItemDeleteParams build() { } /** - * Delete all usage for the given subscription item. Allowed only when the current plan's - * `usage_type` is `metered`. + * Delete all usage for the given subscription item. Allowed only when the current plan's {@code + * usage_type} is {@code metered}. */ public Builder setClearUsage(Boolean clearUsage) { this.clearUsage = clearUsage; @@ -102,9 +103,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Flag indicating whether to - * [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a - * billing cycle. + * Flag indicating whether to prorate switching plans + * during a billing cycle. */ public Builder setProrate(Boolean prorate) { this.prorate = prorate; @@ -113,8 +114,8 @@ public Builder setProrate(Boolean prorate) { /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply the same proration that was previewed with the [upcoming - * invoice](#retrieve_customer_invoice) endpoint. + * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. */ public Builder setProrationDate(Long prorationDate) { this.prorationDate = prorationDate; diff --git a/src/main/java/com/stripe/param/SubscriptionItemListParams.java b/src/main/java/com/stripe/param/SubscriptionItemListParams.java index 4adf53d6b4d..23dea972baa 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemListParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemListParams.java @@ -11,10 +11,10 @@ @Getter public class SubscriptionItemListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class SubscriptionItemListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -96,10 +96,10 @@ public SubscriptionItemListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -168,10 +168,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java b/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java index 51a15314e75..08758c91b9b 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java @@ -34,7 +34,8 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -44,19 +45,19 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { Boolean offSession; /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA regulation - * may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to - * learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does not * create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) - * to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ @SerializedName("payment_behavior") PaymentBehavior paymentBehavior; @@ -66,35 +67,37 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { Object plan; /** - * Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) - * switching plans during a billing cycle. This field has been deprecated and will be removed in a - * future API version. Use `proration_behavior=create_prorations` as a replacement for - * `prorate=true` and `proration_behavior=none` for `prorate=false`. + * Flag indicating whether to prorate switching plans + * during a billing cycle. This field has been deprecated and will be removed in a future API + * version. Use {@code proration_behavior=create_prorations} as a replacement for {@code + * prorate=true} and {@code proration_behavior=none} for {@code prorate=false}. */ @SerializedName("prorate") Boolean prorate; /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a - * trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or - * `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, + * or starting a trial), or if an item's {@code quantity} changes. Valid values are {@code + * create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In - * order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ @SerializedName("proration_behavior") ProrationBehavior prorationBehavior; /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply the same proration that was previewed with the [upcoming - * invoice](#retrieve_customer_invoice) endpoint. + * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. */ @SerializedName("proration_date") Long prorationDate; @@ -104,11 +107,11 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { Long quantity; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override - * the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ @SerializedName("tax_rates") Object taxRates; @@ -289,19 +292,19 @@ public Builder setOffSession(Boolean offSession) { } /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA - * regulation may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing - * to learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does * not create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the - * [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ public Builder setPaymentBehavior(PaymentBehavior paymentBehavior) { this.paymentBehavior = paymentBehavior; @@ -321,11 +324,11 @@ public Builder setPlan(EmptyParam plan) { } /** - * Flag indicating whether to - * [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a - * billing cycle. This field has been deprecated and will be removed in a future API version. - * Use `proration_behavior=create_prorations` as a replacement for `prorate=true` and - * `proration_behavior=none` for `prorate=false`. + * Flag indicating whether to prorate switching plans + * during a billing cycle. This field has been deprecated and will be removed in a future API + * version. Use {@code proration_behavior=create_prorations} as a replacement for {@code + * prorate=true} and {@code proration_behavior=none} for {@code prorate=false}. */ public Builder setProrate(Boolean prorate) { this.prorate = prorate; @@ -333,18 +336,19 @@ public Builder setProrate(Boolean prorate) { } /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting - * a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, - * or `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code + * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. + * Valid values are {@code create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). - * In order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { this.prorationBehavior = prorationBehavior; @@ -353,8 +357,8 @@ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply the same proration that was previewed with the [upcoming - * invoice](#retrieve_customer_invoice) endpoint. + * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. */ public Builder setProrationDate(Long prorationDate) { this.prorationDate = prorationDate; @@ -396,11 +400,11 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -408,11 +412,11 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; diff --git a/src/main/java/com/stripe/param/SubscriptionItemUsageRecordSummariesParams.java b/src/main/java/com/stripe/param/SubscriptionItemUsageRecordSummariesParams.java index 26e5d7d14e9..3b7691a5649 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemUsageRecordSummariesParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemUsageRecordSummariesParams.java @@ -11,10 +11,10 @@ @Getter public class SubscriptionItemUsageRecordSummariesParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class SubscriptionItemUsageRecordSummariesParams extends ApiRequestParams Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public SubscriptionItemUsageRecordSummariesParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -156,10 +156,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/SubscriptionListParams.java b/src/main/java/com/stripe/param/SubscriptionListParams.java index 32c4ac01e17..b709e71e9c2 100644 --- a/src/main/java/com/stripe/param/SubscriptionListParams.java +++ b/src/main/java/com/stripe/param/SubscriptionListParams.java @@ -11,8 +11,8 @@ @Getter public class SubscriptionListParams extends ApiRequestParams { /** - * The collection method of the subscriptions to retrieve. Either `charge_automatically` or - * `send_invoice`. + * The collection method of the subscriptions to retrieve. Either {@code charge_automatically} or + * {@code send_invoice}. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -31,10 +31,10 @@ public class SubscriptionListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -64,19 +64,20 @@ public class SubscriptionListParams extends ApiRequestParams { String plan; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * The status of the subscriptions to retrieve. One of: `incomplete`, `incomplete_expired`, - * `trialing`, `active`, `past_due`, `unpaid`, `canceled`, or `all`. Passing in a value of - * `canceled` will return all canceled subscriptions, including those belonging to deleted - * customers. Passing in a value of `all` will return subscriptions of all statuses. + * The status of the subscriptions to retrieve. One of: {@code incomplete}, {@code + * incomplete_expired}, {@code trialing}, {@code active}, {@code past_due}, {@code unpaid}, {@code + * canceled}, or {@code all}. Passing in a value of {@code canceled} will return all canceled + * subscriptions, including those belonging to deleted customers. Passing in a value of {@code + * all} will return subscriptions of all statuses. */ @SerializedName("status") Status status; @@ -155,8 +156,8 @@ public SubscriptionListParams build() { } /** - * The collection method of the subscriptions to retrieve. Either `charge_automatically` or - * `send_invoice`. + * The collection method of the subscriptions to retrieve. Either {@code charge_automatically} + * or {@code send_invoice}. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -200,10 +201,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -278,10 +279,10 @@ public Builder setPlan(String plan) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -289,10 +290,11 @@ public Builder setStartingAfter(String startingAfter) { } /** - * The status of the subscriptions to retrieve. One of: `incomplete`, `incomplete_expired`, - * `trialing`, `active`, `past_due`, `unpaid`, `canceled`, or `all`. Passing in a value of - * `canceled` will return all canceled subscriptions, including those belonging to deleted - * customers. Passing in a value of `all` will return subscriptions of all statuses. + * The status of the subscriptions to retrieve. One of: {@code incomplete}, {@code + * incomplete_expired}, {@code trialing}, {@code active}, {@code past_due}, {@code unpaid}, + * {@code canceled}, or {@code all}. Passing in a value of {@code canceled} will return all + * canceled subscriptions, including those belonging to deleted customers. Passing in a value of + * {@code all} will return subscriptions of all statuses. */ public Builder setStatus(Status status) { this.status = status; diff --git a/src/main/java/com/stripe/param/SubscriptionScheduleCancelParams.java b/src/main/java/com/stripe/param/SubscriptionScheduleCancelParams.java index cf0d9562a7e..91787fce2d3 100644 --- a/src/main/java/com/stripe/param/SubscriptionScheduleCancelParams.java +++ b/src/main/java/com/stripe/param/SubscriptionScheduleCancelParams.java @@ -24,16 +24,16 @@ public class SubscriptionScheduleCancelParams extends ApiRequestParams { Map extraParams; /** - * If the subscription schedule is `active`, indicates whether or not to generate a final invoice - * that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults - * to `true`. + * If the subscription schedule is {@code active}, indicates whether or not to generate a final + * invoice that contains any un-invoiced metered usage and new/pending proration invoice items. + * Defaults to {@code true}. */ @SerializedName("invoice_now") Boolean invoiceNow; /** - * If the subscription schedule is `active`, indicates if the cancellation should be prorated. - * Defaults to `true`. + * If the subscription schedule is {@code active}, indicates if the cancellation should be + * prorated. Defaults to {@code true}. */ @SerializedName("prorate") Boolean prorate; @@ -118,9 +118,9 @@ public Builder putAllExtraParam(Map map) { } /** - * If the subscription schedule is `active`, indicates whether or not to generate a final + * If the subscription schedule is {@code active}, indicates whether or not to generate a final * invoice that contains any un-invoiced metered usage and new/pending proration invoice items. - * Defaults to `true`. + * Defaults to {@code true}. */ public Builder setInvoiceNow(Boolean invoiceNow) { this.invoiceNow = invoiceNow; @@ -128,8 +128,8 @@ public Builder setInvoiceNow(Boolean invoiceNow) { } /** - * If the subscription schedule is `active`, indicates if the cancellation should be prorated. - * Defaults to `true`. + * If the subscription schedule is {@code active}, indicates if the cancellation should be + * prorated. Defaults to {@code true}. */ public Builder setProrate(Boolean prorate) { this.prorate = prorate; diff --git a/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java b/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java index 8bf64324c1c..bfb1f4da480 100644 --- a/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java @@ -21,10 +21,10 @@ public class SubscriptionScheduleCreateParams extends ApiRequestParams { DefaultSettings defaultSettings; /** - * Configures how the subscription schedule behaves when it ends. Possible values are `release` or - * `cancel` with the default being `release`. `release` will end the subscription schedule and - * keep the underlying subscription running.`cancel` will end the subscription schedule and cancel - * the underlying subscription. + * Configures how the subscription schedule behaves when it ends. Possible values are {@code + * release} or {@code cancel} with the default being {@code release}. {@code release} will end the + * subscription schedule and keep the underlying subscription running.{@code cancel} will end the + * subscription schedule and cancel the underlying subscription. */ @SerializedName("end_behavior") EndBehavior endBehavior; @@ -55,24 +55,26 @@ public class SubscriptionScheduleCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** * List representing phases of the subscription schedule. Each phase can be customized to have - * different durations, plans, and coupons. If there are multiple phases, the `end_date` of one - * phase will always equal the `start_date` of the next phase. + * different durations, plans, and coupons. If there are multiple phases, the {@code end_date} of + * one phase will always equal the {@code start_date} of the next phase. */ @SerializedName("phases") List phases; /** - * When the subscription schedule starts. We recommend using `now` so that it starts the + * When the subscription schedule starts. We recommend using {@code now} so that it starts the * subscription immediately. You can also use a Unix timestamp to backdate the subscription so * that it starts on a past date, or set a future date for the subscription to start on. When you - * backdate, the `billing_cycle_anchor` of the subscription is equivalent to the `start_date`. + * backdate, the {@code billing_cycle_anchor} of the subscription is equivalent to the {@code + * start_date}. */ @SerializedName("start_date") Object startDate; @@ -148,10 +150,10 @@ public Builder setDefaultSettings(DefaultSettings defaultSettings) { } /** - * Configures how the subscription schedule behaves when it ends. Possible values are `release` - * or `cancel` with the default being `release`. `release` will end the subscription schedule - * and keep the underlying subscription running.`cancel` will end the subscription schedule and - * cancel the underlying subscription. + * Configures how the subscription schedule behaves when it ends. Possible values are {@code + * release} or {@code cancel} with the default being {@code release}. {@code release} will end + * the subscription schedule and keep the underlying subscription running.{@code cancel} will + * end the subscription schedule and cancel the underlying subscription. */ public Builder setEndBehavior(EndBehavior endBehavior) { this.endBehavior = endBehavior; @@ -275,11 +277,11 @@ public Builder addAllPhase(List elements) { } /** - * When the subscription schedule starts. We recommend using `now` so that it starts the + * When the subscription schedule starts. We recommend using {@code now} so that it starts the * subscription immediately. You can also use a Unix timestamp to backdate the subscription so * that it starts on a past date, or set a future date for the subscription to start on. When - * you backdate, the `billing_cycle_anchor` of the subscription is equivalent to the - * `start_date`. + * you backdate, the {@code billing_cycle_anchor} of the subscription is equivalent to the + * {@code start_date}. */ public Builder setStartDate(Long startDate) { this.startDate = startDate; @@ -287,11 +289,11 @@ public Builder setStartDate(Long startDate) { } /** - * When the subscription schedule starts. We recommend using `now` so that it starts the + * When the subscription schedule starts. We recommend using {@code now} so that it starts the * subscription immediately. You can also use a Unix timestamp to backdate the subscription so * that it starts on a past date, or set a future date for the subscription to start on. When - * you backdate, the `billing_cycle_anchor` of the subscription is equivalent to the - * `start_date`. + * you backdate, the {@code billing_cycle_anchor} of the subscription is equivalent to the + * {@code start_date}. */ public Builder setStartDate(StartDate startDate) { this.startDate = startDate; @@ -309,10 +311,11 @@ public static class DefaultSettings { Object billingThresholds; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the default - * source attached to the customer. When sending an invoice, Stripe will email your customer an - * invoice with payment instructions. Defaults to `charge_automatically` on creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle using + * the default source attached to the customer. When sending an invoice, Stripe will email your + * customer an invoice with payment instructions. Defaults to {@code charge_automatically} on + * creation. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -395,11 +398,11 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { } /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the - * default source attached to the customer. When sending an invoice, Stripe will email your - * customer an invoice with payment instructions. Defaults to `charge_automatically` on - * creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle + * using the default source attached to the customer. When sending an invoice, Stripe will + * email your customer an invoice with payment instructions. Defaults to {@code + * charge_automatically} on creation. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -466,9 +469,9 @@ public static class BillingThresholds { Map extraParams; /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. + * If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was + * last reached; otherwise, the value will remain unchanged. */ @SerializedName("reset_billing_cycle_anchor") Boolean resetBillingCycleAnchor; @@ -534,9 +537,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is + * reached. If true, {@code billing_cycle_anchor} will be updated to the date/time the + * threshold was last reached; otherwise, the value will remain unchanged. */ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { this.resetBillingCycleAnchor = resetBillingCycleAnchor; @@ -549,8 +552,8 @@ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { public static class InvoiceSettings { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -585,8 +588,8 @@ public InvoiceSettings build() { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -648,8 +651,8 @@ public static class Phase { * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. The request must be made by a platform account on a * connected account in order to set an application fee percentage. For more information, see - * the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * the application fees documentation. */ @SerializedName("application_fee_percent") BigDecimal applicationFeePercent; @@ -662,10 +665,11 @@ public static class Phase { Object billingThresholds; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the default - * source attached to the customer. When sending an invoice, Stripe will email your customer an - * invoice with payment instructions. Defaults to `charge_automatically` on creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle using + * the default source attached to the customer. When sending an invoice, Stripe will email your + * customer an invoice with payment instructions. Defaults to {@code charge_automatically} on + * creation. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -683,20 +687,20 @@ public static class Phase { String defaultPaymentMethod; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the - * Subscription's - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), - * which means they will be the Invoice's - * [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) - * for any Invoices issued by the Subscription during this Phase. When updating, pass an empty - * string to remove previously-defined tax rates. + * A list of Tax Rate ids. These Tax Rates + * will set the Subscription's {@code + * default_tax_rates}, which means they will be the Invoice's {@code + * default_tax_rates} for any Invoices issued by the Subscription during this Phase. When + * updating, pass an empty string to remove previously-defined tax rates. */ @SerializedName("default_tax_rates") Object defaultTaxRates; /** - * The date at which this phase of the subscription schedule ends. If set, `iterations` must not - * be set. + * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * must not be set. */ @SerializedName("end_date") Long endDate; @@ -715,9 +719,10 @@ public static class Phase { InvoiceSettings invoiceSettings; /** - * Integer representing the multiplier applied to the plan interval. For example, `iterations=2` - * applied to a plan with `interval=month` and `interval_count=3` results in a phase of duration - * `2 * 3 months = 6 months`. If set, `end_date` must not be set. + * Integer representing the multiplier applied to the plan interval. For example, {@code + * iterations=2} applied to a plan with {@code interval=month} and {@code interval_count=3} + * results in a phase of duration {@code 2 * 3 months = 6 months}. If set, {@code end_date} must + * not be set. */ @SerializedName("iterations") Long iterations; @@ -733,10 +738,11 @@ public static class Phase { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax * to the final amount in each billing period during thise phase of the schedule. For example, a - * plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To - * unset a previously-set value, pass an empty string. This field has been deprecated and will - * be removed in a future API version, for further information view the [migration - * docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * plan which charges $10/month with a {@code tax_percent} of {@code 20.0} will charge $12 per + * invoice. To unset a previously-set value, pass an empty string. This field has been + * deprecated and will be removed in a future API version, for further information view the migration docs for {@code + * tax_rates}. */ @SerializedName("tax_percent") BigDecimal taxPercent; @@ -750,7 +756,7 @@ public static class Phase { /** * Sets the phase to trialing from the start date to this date. Must be before the phase end - * date, can not be combined with `trial` + * date, can not be combined with {@code trial} */ @SerializedName("trial_end") Long trialEnd; @@ -843,8 +849,8 @@ public Phase build() { * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. The request must be made by a platform account on a * connected account in order to set an application fee percentage. For more information, see - * the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * the application fees documentation. */ public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) { this.applicationFeePercent = applicationFeePercent; @@ -870,11 +876,11 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { } /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the - * default source attached to the customer. When sending an invoice, Stripe will email your - * customer an invoice with payment instructions. Defaults to `charge_automatically` on - * creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle + * using the default source attached to the customer. When sending an invoice, Stripe will + * email your customer an invoice with payment instructions. Defaults to {@code + * charge_automatically} on creation. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -926,13 +932,13 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set - * the Subscription's - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), - * which means they will be the Invoice's - * [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) - * for any Invoices issued by the Subscription during this Phase. When updating, pass an empty - * string to remove previously-defined tax rates. + * A list of Tax Rate ids. These Tax Rates + * will set the Subscription's {@code + * default_tax_rates}, which means they will be the Invoice's {@code + * default_tax_rates} for any Invoices issued by the Subscription during this Phase. When + * updating, pass an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -940,13 +946,13 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set - * the Subscription's - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), - * which means they will be the Invoice's - * [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) - * for any Invoices issued by the Subscription during this Phase. When updating, pass an empty - * string to remove previously-defined tax rates. + * A list of Tax Rate ids. These Tax Rates + * will set the Subscription's {@code + * default_tax_rates}, which means they will be the Invoice's {@code + * default_tax_rates} for any Invoices issued by the Subscription during this Phase. When + * updating, pass an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(List defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -954,8 +960,8 @@ public Builder setDefaultTaxRates(List defaultTaxRates) { } /** - * The date at which this phase of the subscription schedule ends. If set, `iterations` must - * not be set. + * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * must not be set. */ public Builder setEndDate(Long endDate) { this.endDate = endDate; @@ -995,9 +1001,10 @@ public Builder setInvoiceSettings(InvoiceSettings invoiceSettings) { } /** - * Integer representing the multiplier applied to the plan interval. For example, - * `iterations=2` applied to a plan with `interval=month` and `interval_count=3` results in a - * phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. + * Integer representing the multiplier applied to the plan interval. For example, {@code + * iterations=2} applied to a plan with {@code interval=month} and {@code interval_count=3} + * results in a phase of duration {@code 2 * 3 months = 6 months}. If set, {@code end_date} + * must not be set. */ public Builder setIterations(Long iterations) { this.iterations = iterations; @@ -1034,10 +1041,11 @@ public Builder addAllPlan(List elements) { * A non-negative decimal (with at most four decimal places) between 0 and 100. This * represents the percentage of the subscription invoice subtotal that will be calculated and * added as tax to the final amount in each billing period during thise phase of the schedule. - * For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 - * per invoice. To unset a previously-set value, pass an empty string. This field has been - * deprecated and will be removed in a future API version, for further information view the - * [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * For example, a plan which charges $10/month with a {@code tax_percent} of {@code 20.0} will + * charge $12 per invoice. To unset a previously-set value, pass an empty string. This field + * has been deprecated and will be removed in a future API version, for further information + * view the migration docs for + * {@code tax_rates}. */ public Builder setTaxPercent(BigDecimal taxPercent) { this.taxPercent = taxPercent; @@ -1055,7 +1063,7 @@ public Builder setTrial(Boolean trial) { /** * Sets the phase to trialing from the start date to this date. Must be before the phase end - * date, can not be combined with `trial` + * date, can not be combined with {@code trial} */ public Builder setTrialEnd(Long trialEnd) { this.trialEnd = trialEnd; @@ -1079,9 +1087,9 @@ public static class BillingThresholds { Map extraParams; /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. + * If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was + * last reached; otherwise, the value will remain unchanged. */ @SerializedName("reset_billing_cycle_anchor") Boolean resetBillingCycleAnchor; @@ -1145,9 +1153,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is + * reached. If true, {@code billing_cycle_anchor} will be updated to the date/time the + * threshold was last reached; otherwise, the value will remain unchanged. */ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { this.resetBillingCycleAnchor = resetBillingCycleAnchor; @@ -1160,8 +1168,8 @@ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { public static class InvoiceSettings { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -1196,8 +1204,8 @@ public InvoiceSettings build() { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -1258,18 +1266,18 @@ public static class Plan { String plan; /** - * Quantity for the given plan. Can be set only if the plan's `usage_type` is `licensed` and - * not `metered`. + * Quantity for the given plan. Can be set only if the plan's {@code usage_type} is {@code + * licensed} and not {@code metered}. */ @SerializedName("quantity") Long quantity; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ @SerializedName("tax_rates") Object taxRates; @@ -1363,8 +1371,8 @@ public Builder setPlan(String plan) { } /** - * Quantity for the given plan. Can be set only if the plan's `usage_type` is `licensed` and - * not `metered`. + * Quantity for the given plan. Can be set only if the plan's {@code usage_type} is {@code + * licensed} and not {@code metered}. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; @@ -1400,11 +1408,11 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax + * Rates will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -1412,11 +1420,11 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax + * Rates will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; diff --git a/src/main/java/com/stripe/param/SubscriptionScheduleListParams.java b/src/main/java/com/stripe/param/SubscriptionScheduleListParams.java index fde351da4e1..9fd9e30c847 100644 --- a/src/main/java/com/stripe/param/SubscriptionScheduleListParams.java +++ b/src/main/java/com/stripe/param/SubscriptionScheduleListParams.java @@ -27,10 +27,10 @@ public class SubscriptionScheduleListParams extends ApiRequestParams { String customer; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -64,10 +64,10 @@ public class SubscriptionScheduleListParams extends ApiRequestParams { Boolean scheduled; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -183,10 +183,10 @@ public Builder setCustomer(String customer) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -273,10 +273,10 @@ public Builder setScheduled(Boolean scheduled) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java b/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java index 38a07e684b4..98167ba911c 100644 --- a/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java @@ -17,10 +17,10 @@ public class SubscriptionScheduleUpdateParams extends ApiRequestParams { DefaultSettings defaultSettings; /** - * Configures how the subscription schedule behaves when it ends. Possible values are `release` or - * `cancel` with the default being `release`. `release` will end the subscription schedule and - * keep the underlying subscription running.`cancel` will end the subscription schedule and cancel - * the underlying subscription. + * Configures how the subscription schedule behaves when it ends. Possible values are {@code + * release} or {@code cancel} with the default being {@code release}. {@code release} will end the + * subscription schedule and keep the underlying subscription running.{@code cancel} will end the + * subscription schedule and cancel the underlying subscription. */ @SerializedName("end_behavior") EndBehavior endBehavior; @@ -41,23 +41,24 @@ public class SubscriptionScheduleUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** * List representing phases of the subscription schedule. Each phase can be customized to have - * different durations, plans, and coupons. If there are multiple phases, the `end_date` of one - * phase will always equal the `start_date` of the next phase. Note that past phases can be - * omitted. + * different durations, plans, and coupons. If there are multiple phases, the {@code end_date} of + * one phase will always equal the {@code start_date} of the next phase. Note that past phases can + * be omitted. */ @SerializedName("phases") List phases; /** * If the update changes the current phase, indicates if the changes should be prorated. Defaults - * to `true`. + * to {@code true}. */ @SerializedName("prorate") Boolean prorate; @@ -117,10 +118,10 @@ public Builder setDefaultSettings(DefaultSettings defaultSettings) { } /** - * Configures how the subscription schedule behaves when it ends. Possible values are `release` - * or `cancel` with the default being `release`. `release` will end the subscription schedule - * and keep the underlying subscription running.`cancel` will end the subscription schedule and - * cancel the underlying subscription. + * Configures how the subscription schedule behaves when it ends. Possible values are {@code + * release} or {@code cancel} with the default being {@code release}. {@code release} will end + * the subscription schedule and keep the underlying subscription running.{@code cancel} will + * end the subscription schedule and cancel the underlying subscription. */ public Builder setEndBehavior(EndBehavior endBehavior) { this.endBehavior = endBehavior; @@ -233,7 +234,7 @@ public Builder addAllPhase(List elements) { /** * If the update changes the current phase, indicates if the changes should be prorated. - * Defaults to `true`. + * Defaults to {@code true}. */ public Builder setProrate(Boolean prorate) { this.prorate = prorate; @@ -251,10 +252,11 @@ public static class DefaultSettings { Object billingThresholds; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the default - * source attached to the customer. When sending an invoice, Stripe will email your customer an - * invoice with payment instructions. Defaults to `charge_automatically` on creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle using + * the default source attached to the customer. When sending an invoice, Stripe will email your + * customer an invoice with payment instructions. Defaults to {@code charge_automatically} on + * creation. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -337,11 +339,11 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { } /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the - * default source attached to the customer. When sending an invoice, Stripe will email your - * customer an invoice with payment instructions. Defaults to `charge_automatically` on - * creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle + * using the default source attached to the customer. When sending an invoice, Stripe will + * email your customer an invoice with payment instructions. Defaults to {@code + * charge_automatically} on creation. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -418,9 +420,9 @@ public static class BillingThresholds { Map extraParams; /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. + * If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was + * last reached; otherwise, the value will remain unchanged. */ @SerializedName("reset_billing_cycle_anchor") Boolean resetBillingCycleAnchor; @@ -486,9 +488,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is + * reached. If true, {@code billing_cycle_anchor} will be updated to the date/time the + * threshold was last reached; otherwise, the value will remain unchanged. */ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { this.resetBillingCycleAnchor = resetBillingCycleAnchor; @@ -501,8 +503,8 @@ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { public static class InvoiceSettings { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -537,8 +539,8 @@ public InvoiceSettings build() { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -600,8 +602,8 @@ public static class Phase { * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. The request must be made by a platform account on a * connected account in order to set an application fee percentage. For more information, see - * the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * the application fees documentation. */ @SerializedName("application_fee_percent") BigDecimal applicationFeePercent; @@ -614,10 +616,11 @@ public static class Phase { Object billingThresholds; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the default - * source attached to the customer. When sending an invoice, Stripe will email your customer an - * invoice with payment instructions. Defaults to `charge_automatically` on creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle using + * the default source attached to the customer. When sending an invoice, Stripe will email your + * customer an invoice with payment instructions. Defaults to {@code charge_automatically} on + * creation. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -635,20 +638,20 @@ public static class Phase { Object defaultPaymentMethod; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the - * Subscription's - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), - * which means they will be the Invoice's - * [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) - * for any Invoices issued by the Subscription during this Phase. When updating, pass an empty - * string to remove previously-defined tax rates. + * A list of Tax Rate ids. These Tax Rates + * will set the Subscription's {@code + * default_tax_rates}, which means they will be the Invoice's {@code + * default_tax_rates} for any Invoices issued by the Subscription during this Phase. When + * updating, pass an empty string to remove previously-defined tax rates. */ @SerializedName("default_tax_rates") Object defaultTaxRates; /** - * The date at which this phase of the subscription schedule ends. If set, `iterations` must not - * be set. + * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * must not be set. */ @SerializedName("end_date") Object endDate; @@ -667,9 +670,10 @@ public static class Phase { InvoiceSettings invoiceSettings; /** - * Integer representing the multiplier applied to the plan interval. For example, `iterations=2` - * applied to a plan with `interval=month` and `interval_count=3` results in a phase of duration - * `2 * 3 months = 6 months`. If set, `end_date` must not be set. + * Integer representing the multiplier applied to the plan interval. For example, {@code + * iterations=2} applied to a plan with {@code interval=month} and {@code interval_count=3} + * results in a phase of duration {@code 2 * 3 months = 6 months}. If set, {@code end_date} must + * not be set. */ @SerializedName("iterations") Long iterations; @@ -682,8 +686,8 @@ public static class Phase { List plans; /** - * The date at which this phase of the subscription schedule starts or `now`. Must be set on the - * first phase. + * The date at which this phase of the subscription schedule starts or {@code now}. Must be set + * on the first phase. */ @SerializedName("start_date") Object startDate; @@ -692,10 +696,11 @@ public static class Phase { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax * to the final amount in each billing period during thise phase of the schedule. For example, a - * plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To - * unset a previously-set value, pass an empty string. This field has been deprecated and will - * be removed in a future API version, for further information view the [migration - * docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * plan which charges $10/month with a {@code tax_percent} of {@code 20.0} will charge $12 per + * invoice. To unset a previously-set value, pass an empty string. This field has been + * deprecated and will be removed in a future API version, for further information view the migration docs for {@code + * tax_rates}. */ @SerializedName("tax_percent") BigDecimal taxPercent; @@ -709,7 +714,7 @@ public static class Phase { /** * Sets the phase to trialing from the start date to this date. Must be before the phase end - * date, can not be combined with `trial` + * date, can not be combined with {@code trial} */ @SerializedName("trial_end") Object trialEnd; @@ -807,8 +812,8 @@ public Phase build() { * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. The request must be made by a platform account on a * connected account in order to set an application fee percentage. For more information, see - * the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * the application fees documentation. */ public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) { this.applicationFeePercent = applicationFeePercent; @@ -834,11 +839,11 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { } /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay the underlying subscription at the end of each billing cycle using the - * default source attached to the customer. When sending an invoice, Stripe will email your - * customer an invoice with payment instructions. Defaults to `charge_automatically` on - * creation. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay the underlying subscription at the end of each billing cycle + * using the default source attached to the customer. When sending an invoice, Stripe will + * email your customer an invoice with payment instructions. Defaults to {@code + * charge_automatically} on creation. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -906,13 +911,13 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set - * the Subscription's - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), - * which means they will be the Invoice's - * [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) - * for any Invoices issued by the Subscription during this Phase. When updating, pass an empty - * string to remove previously-defined tax rates. + * A list of Tax Rate ids. These Tax Rates + * will set the Subscription's {@code + * default_tax_rates}, which means they will be the Invoice's {@code + * default_tax_rates} for any Invoices issued by the Subscription during this Phase. When + * updating, pass an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -920,13 +925,13 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set - * the Subscription's - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), - * which means they will be the Invoice's - * [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) - * for any Invoices issued by the Subscription during this Phase. When updating, pass an empty - * string to remove previously-defined tax rates. + * A list of Tax Rate ids. These Tax Rates + * will set the Subscription's {@code + * default_tax_rates}, which means they will be the Invoice's {@code + * default_tax_rates} for any Invoices issued by the Subscription during this Phase. When + * updating, pass an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(List defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -934,8 +939,8 @@ public Builder setDefaultTaxRates(List defaultTaxRates) { } /** - * The date at which this phase of the subscription schedule ends. If set, `iterations` must - * not be set. + * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * must not be set. */ public Builder setEndDate(Long endDate) { this.endDate = endDate; @@ -943,8 +948,8 @@ public Builder setEndDate(Long endDate) { } /** - * The date at which this phase of the subscription schedule ends. If set, `iterations` must - * not be set. + * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * must not be set. */ public Builder setEndDate(EndDate endDate) { this.endDate = endDate; @@ -984,9 +989,10 @@ public Builder setInvoiceSettings(InvoiceSettings invoiceSettings) { } /** - * Integer representing the multiplier applied to the plan interval. For example, - * `iterations=2` applied to a plan with `interval=month` and `interval_count=3` results in a - * phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. + * Integer representing the multiplier applied to the plan interval. For example, {@code + * iterations=2} applied to a plan with {@code interval=month} and {@code interval_count=3} + * results in a phase of duration {@code 2 * 3 months = 6 months}. If set, {@code end_date} + * must not be set. */ public Builder setIterations(Long iterations) { this.iterations = iterations; @@ -1020,8 +1026,8 @@ public Builder addAllPlan(List elements) { } /** - * The date at which this phase of the subscription schedule starts or `now`. Must be set on - * the first phase. + * The date at which this phase of the subscription schedule starts or {@code now}. Must be + * set on the first phase. */ public Builder setStartDate(Long startDate) { this.startDate = startDate; @@ -1029,8 +1035,8 @@ public Builder setStartDate(Long startDate) { } /** - * The date at which this phase of the subscription schedule starts or `now`. Must be set on - * the first phase. + * The date at which this phase of the subscription schedule starts or {@code now}. Must be + * set on the first phase. */ public Builder setStartDate(StartDate startDate) { this.startDate = startDate; @@ -1041,10 +1047,11 @@ public Builder setStartDate(StartDate startDate) { * A non-negative decimal (with at most four decimal places) between 0 and 100. This * represents the percentage of the subscription invoice subtotal that will be calculated and * added as tax to the final amount in each billing period during thise phase of the schedule. - * For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 - * per invoice. To unset a previously-set value, pass an empty string. This field has been - * deprecated and will be removed in a future API version, for further information view the - * [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * For example, a plan which charges $10/month with a {@code tax_percent} of {@code 20.0} will + * charge $12 per invoice. To unset a previously-set value, pass an empty string. This field + * has been deprecated and will be removed in a future API version, for further information + * view the migration docs for + * {@code tax_rates}. */ public Builder setTaxPercent(BigDecimal taxPercent) { this.taxPercent = taxPercent; @@ -1062,7 +1069,7 @@ public Builder setTrial(Boolean trial) { /** * Sets the phase to trialing from the start date to this date. Must be before the phase end - * date, can not be combined with `trial` + * date, can not be combined with {@code trial} */ public Builder setTrialEnd(Long trialEnd) { this.trialEnd = trialEnd; @@ -1071,7 +1078,7 @@ public Builder setTrialEnd(Long trialEnd) { /** * Sets the phase to trialing from the start date to this date. Must be before the phase end - * date, can not be combined with `trial` + * date, can not be combined with {@code trial} */ public Builder setTrialEnd(TrialEnd trialEnd) { this.trialEnd = trialEnd; @@ -1095,9 +1102,9 @@ public static class BillingThresholds { Map extraParams; /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. + * If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was + * last reached; otherwise, the value will remain unchanged. */ @SerializedName("reset_billing_cycle_anchor") Boolean resetBillingCycleAnchor; @@ -1161,9 +1168,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is + * reached. If true, {@code billing_cycle_anchor} will be updated to the date/time the + * threshold was last reached; otherwise, the value will remain unchanged. */ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { this.resetBillingCycleAnchor = resetBillingCycleAnchor; @@ -1176,8 +1183,8 @@ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { public static class InvoiceSettings { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -1212,8 +1219,8 @@ public InvoiceSettings build() { /** * Number of days within which a customer must pay invoices generated by this subscription - * schedule. This value will be `null` for subscription schedules where - * `billing=charge_automatically`. + * schedule. This value will be {@code null} for subscription schedules where {@code + * billing=charge_automatically}. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -1274,18 +1281,18 @@ public static class Plan { Object plan; /** - * Quantity for the given plan. Can be set only if the plan's `usage_type` is `licensed` and - * not `metered`. + * Quantity for the given plan. Can be set only if the plan's {@code usage_type} is {@code + * licensed} and not {@code metered}. */ @SerializedName("quantity") Long quantity; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ @SerializedName("tax_rates") Object taxRates; @@ -1385,8 +1392,8 @@ public Builder setPlan(EmptyParam plan) { } /** - * Quantity for the given plan. Can be set only if the plan's `usage_type` is `licensed` and - * not `metered`. + * Quantity for the given plan. Can be set only if the plan's {@code usage_type} is {@code + * licensed} and not {@code metered}. */ public Builder setQuantity(Long quantity) { this.quantity = quantity; @@ -1422,11 +1429,11 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax + * Rates will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -1434,11 +1441,11 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax + * Rates will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; diff --git a/src/main/java/com/stripe/param/SubscriptionUpdateParams.java b/src/main/java/com/stripe/param/SubscriptionUpdateParams.java index 64b36aeafae..75adb50a4fd 100644 --- a/src/main/java/com/stripe/param/SubscriptionUpdateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionUpdateParams.java @@ -17,15 +17,16 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * percentage of the subscription invoice subtotal that will be transferred to the application * owner's Stripe account. The request must be made by a platform account on a connected account * in order to set an application fee percentage. For more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * documentation. */ @SerializedName("application_fee_percent") BigDecimal applicationFeePercent; /** - * Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle - * anchor to the current time. For more information, see the billing cycle - * [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + * Either {@code now} or {@code unchanged}. Setting the value to {@code now} resets the + * subscription's billing cycle anchor to the current time. For more information, see the billing + * cycle documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -39,8 +40,9 @@ public class SubscriptionUpdateParams extends ApiRequestParams { /** * A timestamp at which the subscription should cancel. If set to a date before the current period - * ends, this will cause a proration if prorations have been enabled using `proration_behavior`. - * If set during a future period, this will always cause a proration for that period. + * ends, this will cause a proration if prorations have been enabled using {@code + * proration_behavior}. If set during a future period, this will always cause a proration for that + * period. */ @SerializedName("cancel_at") Object cancelAt; @@ -52,10 +54,10 @@ public class SubscriptionUpdateParams extends ApiRequestParams { Boolean cancelAtPeriodEnd; /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay this subscription at the end of the cycle using the default source attached to - * the customer. When sending an invoice, Stripe will email your customer an invoice with payment - * instructions. Defaults to `charge_automatically`. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay this subscription at the end of the cycle using the default source + * attached to the customer. When sending an invoice, Stripe will email your customer an invoice + * with payment instructions. Defaults to {@code charge_automatically}. */ @SerializedName("collection_method") CollectionMethod collectionMethod; @@ -69,7 +71,7 @@ public class SubscriptionUpdateParams extends ApiRequestParams { /** * Number of days a customer has to pay invoices generated by this subscription. Valid only for - * subscriptions where `collection_method` is set to `send_invoice`. + * subscriptions where {@code collection_method} is set to {@code send_invoice}. */ @SerializedName("days_until_due") Long daysUntilDue; @@ -91,9 +93,9 @@ public class SubscriptionUpdateParams extends ApiRequestParams { Object defaultSource; /** - * The tax rates that will apply to any subscription item that does not have `tax_rates` set. - * Invoices created will have their `default_tax_rates` populated from the subscription. Pass an - * empty string to remove previously-defined tax rates. + * The tax rates that will apply to any subscription item that does not have {@code tax_rates} + * set. Invoices created will have their {@code default_tax_rates} populated from the + * subscription. Pass an empty string to remove previously-defined tax rates. */ @SerializedName("default_tax_rates") Object defaultTaxRates; @@ -118,7 +120,8 @@ public class SubscriptionUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -128,62 +131,63 @@ public class SubscriptionUpdateParams extends ApiRequestParams { Boolean offSession; /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA regulation - * may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to - * learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does not * create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) - * to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ @SerializedName("payment_behavior") PaymentBehavior paymentBehavior; /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given - * subscription at the specified interval. + * calling Create an invoice for the + * given subscription at the specified interval. */ @SerializedName("pending_invoice_item_interval") Object pendingInvoiceItemInterval; /** - * This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with - * `proration_behavior=create_prorations` and `prorate=false` can be replaced with - * `proration_behavior=none`. + * This field has been renamed to {@code proration_behavior}. {@code prorate=true} can be replaced + * with {@code proration_behavior=create_prorations} and {@code prorate=false} can be replaced + * with {@code proration_behavior=none}. */ @SerializedName("prorate") Boolean prorate; /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a - * trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or - * `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, + * or starting a trial), or if an item's {@code quantity} changes. Valid values are {@code + * create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In - * order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ @SerializedName("proration_behavior") ProrationBehavior prorationBehavior; /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply exactly the same proration that was previewed with [upcoming - * invoice](#retrieve_customer_invoice) endpoint. It can also be used to implement custom - * proration logic, such as prorating by day instead of by second, by providing the time that you - * wish to use for proration calculations. + * time. This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. It + * can also be used to implement custom proration logic, such as prorating by day instead of by + * second, by providing the time that you wish to use for proration calculations. */ @SerializedName("proration_date") Long prorationDate; @@ -192,10 +196,11 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax to * the final amount in each billing period. For example, a plan which charges $10/month with a - * `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an - * empty string. This field has been deprecated and will be removed in a future API version, for - * further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) - * for `tax_rates`. + * {@code tax_percent} of {@code 20.0} will charge $12 per invoice. To unset a previously-set + * value, pass an empty string. This field has been deprecated and will be removed in a future API + * version, for further information view the migration docs for {@code + * tax_rates}. */ @SerializedName("tax_percent") Object taxPercent; @@ -212,16 +217,16 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the customer's - * trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ @SerializedName("trial_end") Object trialEnd; /** - * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting - * `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to - * `true` together with `trial_end` is not allowed. + * Indicates if a plan's {@code trial_period_days} should be applied to the subscription. Setting + * {@code trial_end} per subscription is preferred, and this defaults to {@code false}. Setting + * this flag to {@code true} together with {@code trial_end} is not allowed. */ @SerializedName("trial_from_plan") Boolean trialFromPlan; @@ -369,8 +374,8 @@ public SubscriptionUpdateParams build() { * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. The request must be made by a platform account on a * connected account in order to set an application fee percentage. For more information, see - * the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * the application fees documentation. */ public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) { this.applicationFeePercent = applicationFeePercent; @@ -378,9 +383,10 @@ public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) { } /** - * Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing - * cycle anchor to the current time. For more information, see the billing cycle - * [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + * Either {@code now} or {@code unchanged}. Setting the value to {@code now} resets the + * subscription's billing cycle anchor to the current time. For more information, see the + * billing cycle documentation. */ public Builder setBillingCycleAnchor(BillingCycleAnchor billingCycleAnchor) { this.billingCycleAnchor = billingCycleAnchor; @@ -407,8 +413,8 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { /** * A timestamp at which the subscription should cancel. If set to a date before the current - * period ends, this will cause a proration if prorations have been enabled using - * `proration_behavior`. If set during a future period, this will always cause a proration for + * period ends, this will cause a proration if prorations have been enabled using {@code + * proration_behavior}. If set during a future period, this will always cause a proration for * that period. */ public Builder setCancelAt(Long cancelAt) { @@ -418,8 +424,8 @@ public Builder setCancelAt(Long cancelAt) { /** * A timestamp at which the subscription should cancel. If set to a date before the current - * period ends, this will cause a proration if prorations have been enabled using - * `proration_behavior`. If set during a future period, this will always cause a proration for + * period ends, this will cause a proration if prorations have been enabled using {@code + * proration_behavior}. If set during a future period, this will always cause a proration for * that period. */ public Builder setCancelAt(EmptyParam cancelAt) { @@ -436,10 +442,10 @@ public Builder setCancelAtPeriodEnd(Boolean cancelAtPeriodEnd) { } /** - * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will - * attempt to pay this subscription at the end of the cycle using the default source attached to - * the customer. When sending an invoice, Stripe will email your customer an invoice with - * payment instructions. Defaults to `charge_automatically`. + * Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically, + * Stripe will attempt to pay this subscription at the end of the cycle using the default source + * attached to the customer. When sending an invoice, Stripe will email your customer an invoice + * with payment instructions. Defaults to {@code charge_automatically}. */ public Builder setCollectionMethod(CollectionMethod collectionMethod) { this.collectionMethod = collectionMethod; @@ -466,7 +472,7 @@ public Builder setCoupon(EmptyParam coupon) { /** * Number of days a customer has to pay invoices generated by this subscription. Valid only for - * subscriptions where `collection_method` is set to `send_invoice`. + * subscriptions where {@code collection_method} is set to {@code send_invoice}. */ public Builder setDaysUntilDue(Long daysUntilDue) { this.daysUntilDue = daysUntilDue; @@ -542,9 +548,9 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * The tax rates that will apply to any subscription item that does not have `tax_rates` set. - * Invoices created will have their `default_tax_rates` populated from the subscription. Pass an - * empty string to remove previously-defined tax rates. + * The tax rates that will apply to any subscription item that does not have {@code tax_rates} + * set. Invoices created will have their {@code default_tax_rates} populated from the + * subscription. Pass an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -552,9 +558,9 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * The tax rates that will apply to any subscription item that does not have `tax_rates` set. - * Invoices created will have their `default_tax_rates` populated from the subscription. Pass an - * empty string to remove previously-defined tax rates. + * The tax rates that will apply to any subscription item that does not have {@code tax_rates} + * set. Invoices created will have their {@code default_tax_rates} populated from the + * subscription. Pass an empty string to remove previously-defined tax rates. */ public Builder setDefaultTaxRates(List defaultTaxRates) { this.defaultTaxRates = defaultTaxRates; @@ -672,19 +678,19 @@ public Builder setOffSession(Boolean offSession) { } /** - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice - * cannot be paid. Creating subscriptions with this status allows you to manage scenarios where - * additional user actions are needed to pay a subscription's invoice. For example, SCA - * regulation may require 3DS authentication to complete payment. See the [SCA Migration - * Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing - * to learn more. This is the default behavior. + * Use {@code allow_incomplete} to create subscriptions with {@code status=incomplete} if the + * first invoice cannot be paid. Creating subscriptions with this status allows you to manage + * scenarios where additional user actions are needed to pay a subscription's invoice. For + * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * Guide for Billing to learn more. This is the default behavior. * - *

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a + *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a * subscription's first invoice cannot be paid. For example, if a payment method requires 3DS * authentication due to SCA regulation and further user action is needed, this parameter does * not create a subscription and returns an error instead. This was the default behavior for API - * versions prior to 2019-03-14. See the - * [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * versions prior to 2019-03-14. See the changelog to learn more. */ public Builder setPaymentBehavior(PaymentBehavior paymentBehavior) { this.paymentBehavior = paymentBehavior; @@ -693,8 +699,8 @@ public Builder setPaymentBehavior(PaymentBehavior paymentBehavior) { /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given - * subscription at the specified interval. + * calling Create an invoice for the + * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval( PendingInvoiceItemInterval pendingInvoiceItemInterval) { @@ -704,8 +710,8 @@ public Builder setPendingInvoiceItemInterval( /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given - * subscription at the specified interval. + * calling Create an invoice for the + * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterval) { this.pendingInvoiceItemInterval = pendingInvoiceItemInterval; @@ -713,9 +719,9 @@ public Builder setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterv } /** - * This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with - * `proration_behavior=create_prorations` and `prorate=false` can be replaced with - * `proration_behavior=none`. + * This field has been renamed to {@code proration_behavior}. {@code prorate=true} can be + * replaced with {@code proration_behavior=create_prorations} and {@code prorate=false} can be + * replaced with {@code proration_behavior=none}. */ public Builder setProrate(Boolean prorate) { this.prorate = prorate; @@ -723,18 +729,19 @@ public Builder setProrate(Boolean prorate) { } /** - * Determines how to handle - * [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing - * cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting - * a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, - * or `always_invoice`. + * Determines how to handle prorations when the + * billing cycle changes (e.g., when switching plans, resetting {@code + * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. + * Valid values are {@code create_prorations}, {@code none}, or {@code always_invoice}. * - *

Passing `create_prorations` will cause proration invoice items to be created when - * applicable. These proration items will only be invoiced immediately under [certain - * conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). - * In order to always invoice immediately for prorations, pass `always_invoice`. + *

Passing {@code create_prorations} will cause proration invoice items to be created when + * applicable. These proration items will only be invoiced immediately under certain + * conditions. In order to always invoice immediately for prorations, pass {@code + * always_invoice}. * - *

Prorations can be disabled by passing `none`. + *

Prorations can be disabled by passing {@code none}. */ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { this.prorationBehavior = prorationBehavior; @@ -743,10 +750,10 @@ public Builder setProrationBehavior(ProrationBehavior prorationBehavior) { /** * If set, the proration will be calculated as though the subscription was updated at the given - * time. This can be used to apply exactly the same proration that was previewed with [upcoming - * invoice](#retrieve_customer_invoice) endpoint. It can also be used to implement custom - * proration logic, such as prorating by day instead of by second, by providing the time that - * you wish to use for proration calculations. + * time. This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. + * It can also be used to implement custom proration logic, such as prorating by day instead of + * by second, by providing the time that you wish to use for proration calculations. */ public Builder setProrationDate(Long prorationDate) { this.prorationDate = prorationDate; @@ -757,10 +764,11 @@ public Builder setProrationDate(Long prorationDate) { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax * to the final amount in each billing period. For example, a plan which charges $10/month with - * a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass - * an empty string. This field has been deprecated and will be removed in a future API version, - * for further information view the [migration - * docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * a {@code tax_percent} of {@code 20.0} will charge $12 per invoice. To unset a previously-set + * value, pass an empty string. This field has been deprecated and will be removed in a future + * API version, for further information view the migration docs for {@code + * tax_rates}. */ public Builder setTaxPercent(BigDecimal taxPercent) { this.taxPercent = taxPercent; @@ -771,10 +779,11 @@ public Builder setTaxPercent(BigDecimal taxPercent) { * A non-negative decimal (with at most four decimal places) between 0 and 100. This represents * the percentage of the subscription invoice subtotal that will be calculated and added as tax * to the final amount in each billing period. For example, a plan which charges $10/month with - * a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass - * an empty string. This field has been deprecated and will be removed in a future API version, - * for further information view the [migration - * docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + * a {@code tax_percent} of {@code 20.0} will charge $12 per invoice. To unset a previously-set + * value, pass an empty string. This field has been deprecated and will be removed in a future + * API version, for further information view the migration docs for {@code + * tax_rates}. */ public Builder setTaxPercent(EmptyParam taxPercent) { this.taxPercent = taxPercent; @@ -805,8 +814,8 @@ public Builder setTransferData(EmptyParam transferData) { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the - * customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ public Builder setTrialEnd(TrialEnd trialEnd) { this.trialEnd = trialEnd; @@ -817,8 +826,8 @@ public Builder setTrialEnd(TrialEnd trialEnd) { * Unix timestamp representing the end of the trial period the customer will get before being * charged for the first time. This will always overwrite any trials that might apply via a * subscribed plan. If set, trial_end will override the default trial period of the plan the - * customer is being subscribed to. The special value `now` can be provided to end the - * customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + * customer is being subscribed to. The special value {@code now} can be provided to end the + * customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. */ public Builder setTrialEnd(Long trialEnd) { this.trialEnd = trialEnd; @@ -826,9 +835,9 @@ public Builder setTrialEnd(Long trialEnd) { } /** - * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting - * `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to - * `true` together with `trial_end` is not allowed. + * Indicates if a plan's {@code trial_period_days} should be applied to the subscription. + * Setting {@code trial_end} per subscription is preferred, and this defaults to {@code false}. + * Setting this flag to {@code true} together with {@code trial_end} is not allowed. */ public Builder setTrialFromPlan(Boolean trialFromPlan) { this.trialFromPlan = trialFromPlan; @@ -852,9 +861,9 @@ public static class BillingThresholds { Map extraParams; /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, - * `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; - * otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. If + * true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was last + * reached; otherwise, the value will remain unchanged. */ @SerializedName("reset_billing_cycle_anchor") Boolean resetBillingCycleAnchor; @@ -917,9 +926,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If - * true, `billing_cycle_anchor` will be updated to the date/time the threshold was last - * reached; otherwise, the value will remain unchanged. + * Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached. + * If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was + * last reached; otherwise, the value will remain unchanged. */ public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) { this.resetBillingCycleAnchor = resetBillingCycleAnchor; @@ -938,13 +947,13 @@ public static class Item { Object billingThresholds; /** - * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` - * and the current plan's `usage_type` is `metered`. + * Delete all usage for a given subscription item. Allowed only when {@code deleted} is set to + * {@code true} and the current plan's {@code usage_type} is {@code metered}. */ @SerializedName("clear_usage") Boolean clearUsage; - /** A flag that, if set to `true`, will delete the specified item. */ + /** A flag that, if set to {@code true}, will delete the specified item. */ @SerializedName("deleted") Boolean deleted; @@ -964,8 +973,8 @@ public static class Item { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -979,11 +988,11 @@ public static class Item { Long quantity; /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ @SerializedName("tax_rates") Object taxRates; @@ -1067,15 +1076,15 @@ public Builder setBillingThresholds(EmptyParam billingThresholds) { } /** - * Delete all usage for a given subscription item. Allowed only when `deleted` is set to - * `true` and the current plan's `usage_type` is `metered`. + * Delete all usage for a given subscription item. Allowed only when {@code deleted} is set to + * {@code true} and the current plan's {@code usage_type} is {@code metered}. */ public Builder setClearUsage(Boolean clearUsage) { this.clearUsage = clearUsage; return this; } - /** A flag that, if set to `true`, will delete the specified item. */ + /** A flag that, if set to {@code true}, will delete the specified item. */ public Builder setDeleted(Boolean deleted) { this.deleted = deleted; return this; @@ -1192,11 +1201,11 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(EmptyParam taxRates) { this.taxRates = taxRates; @@ -1204,11 +1213,11 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will - * override the - * [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) - * on the Subscription. When updating, pass an empty string to remove previously-defined tax - * rates. + * A list of Tax Rate ids. These Tax Rates + * will override the {@code + * default_tax_rates} on the Subscription. When updating, pass an empty string to remove + * previously-defined tax rates. */ public Builder setTaxRates(List taxRates) { this.taxRates = taxRates; @@ -1298,13 +1307,16 @@ public static class PendingInvoiceItemInterval { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. */ + /** + * Specifies invoicing frequency. Either {@code day}, {@code week}, {@code month} or {@code + * year}. + */ @SerializedName("interval") Interval interval; /** - * The number of intervals between invoices. For example, `interval=month` and - * `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 + * The number of intervals between invoices. For example, {@code interval=month} and {@code + * interval_count=3} bills every 3 months. Maximum of one year interval allowed (1 year, 12 * months, or 52 weeks). */ @SerializedName("interval_count") @@ -1361,15 +1373,18 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. */ + /** + * Specifies invoicing frequency. Either {@code day}, {@code week}, {@code month} or {@code + * year}. + */ public Builder setInterval(Interval interval) { this.interval = interval; return this; } /** - * The number of intervals between invoices. For example, `interval=month` and - * `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 + * The number of intervals between invoices. For example, {@code interval=month} and {@code + * interval_count=3} bills every 3 months. Maximum of one year interval allowed (1 year, 12 * months, or 52 weeks). */ public Builder setIntervalCount(Long intervalCount) { diff --git a/src/main/java/com/stripe/param/TaxIdCollectionCreateParams.java b/src/main/java/com/stripe/param/TaxIdCollectionCreateParams.java index 65d13800ebb..ee24d8336fb 100644 --- a/src/main/java/com/stripe/param/TaxIdCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/TaxIdCollectionCreateParams.java @@ -24,9 +24,10 @@ public class TaxIdCollectionCreateParams extends ApiRequestParams { Map extraParams; /** - * Type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, - * `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, - * `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, or `ca_qst`. + * Type of the tax ID, one of {@code eu_vat}, {@code nz_gst}, {@code au_abn}, {@code in_gst}, + * {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc}, {@code sg_uen}, {@code ru_inn}, + * {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat}, {@code th_vat}, {@code jp_cn}, + * {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn}, or {@code ca_qst}. */ @SerializedName("type") Type type; @@ -114,9 +115,10 @@ public Builder putAllExtraParam(Map map) { } /** - * Type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, - * `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, - * `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, or `ca_qst`. + * Type of the tax ID, one of {@code eu_vat}, {@code nz_gst}, {@code au_abn}, {@code in_gst}, + * {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc}, {@code sg_uen}, {@code + * ru_inn}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat}, {@code th_vat}, {@code + * jp_cn}, {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn}, or {@code ca_qst}. */ public Builder setType(Type type) { this.type = type; diff --git a/src/main/java/com/stripe/param/TaxIdCollectionListParams.java b/src/main/java/com/stripe/param/TaxIdCollectionListParams.java index 024c7fc50e5..02e63becbc3 100644 --- a/src/main/java/com/stripe/param/TaxIdCollectionListParams.java +++ b/src/main/java/com/stripe/param/TaxIdCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class TaxIdCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class TaxIdCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public TaxIdCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/TaxRateCreateParams.java b/src/main/java/com/stripe/param/TaxRateCreateParams.java index 03ae8d306a2..2ce96b00342 100644 --- a/src/main/java/com/stripe/param/TaxRateCreateParams.java +++ b/src/main/java/com/stripe/param/TaxRateCreateParams.java @@ -53,7 +53,8 @@ public class TaxRateCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/TaxRateListParams.java b/src/main/java/com/stripe/param/TaxRateListParams.java index de07b2e0692..7c46a3ca7ab 100644 --- a/src/main/java/com/stripe/param/TaxRateListParams.java +++ b/src/main/java/com/stripe/param/TaxRateListParams.java @@ -19,10 +19,10 @@ public class TaxRateListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -56,10 +56,10 @@ public class TaxRateListParams extends ApiRequestParams { Object percentage; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -141,10 +141,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -233,10 +233,10 @@ public Builder setPercentage(Long percentage) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/TaxRateUpdateParams.java b/src/main/java/com/stripe/param/TaxRateUpdateParams.java index 502b4798da9..b28c0f9f9e7 100644 --- a/src/main/java/com/stripe/param/TaxRateUpdateParams.java +++ b/src/main/java/com/stripe/param/TaxRateUpdateParams.java @@ -49,7 +49,8 @@ public class TaxRateUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/ThreeDSecureCreateParams.java b/src/main/java/com/stripe/param/ThreeDSecureCreateParams.java index 7b9c52c6f4a..21f33a965b0 100644 --- a/src/main/java/com/stripe/param/ThreeDSecureCreateParams.java +++ b/src/main/java/com/stripe/param/ThreeDSecureCreateParams.java @@ -19,8 +19,8 @@ public class ThreeDSecureCreateParams extends ApiRequestParams { String card; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -107,8 +107,9 @@ public Builder setCard(String card) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; diff --git a/src/main/java/com/stripe/param/TokenCreateParams.java b/src/main/java/com/stripe/param/TokenCreateParams.java index cc535886dab..c1d855cab02 100644 --- a/src/main/java/com/stripe/param/TokenCreateParams.java +++ b/src/main/java/com/stripe/param/TokenCreateParams.java @@ -21,9 +21,10 @@ public class TokenCreateParams extends ApiRequestParams { /** * The customer (owned by the application's account) for which to create a token. This can be used - * only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or - * [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see - * [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). + * only with an OAuth access token + * or Stripe-Account header. For more + * details, see Cloning + * Saved Payment Methods. */ @SerializedName("customer") String customer; @@ -115,10 +116,11 @@ public Builder setCard(String card) { /** * The customer (owned by the application's account) for which to create a token. This can be - * used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or - * [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, - * see [Cloning Saved Payment - * Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). + * used only with an OAuth access + * token or Stripe-Account + * header. For more details, see Cloning Saved Payment + * Methods. */ public Builder setCustomer(String customer) { this.customer = customer; @@ -194,14 +196,14 @@ public Builder setPii(Pii pii) { public static class BankAccount { /** * The name of the person or business that owns the bank account.This field is required when - * attaching the bank account to a `Customer` object. + * attaching the bank account to a {@code Customer} object. */ @SerializedName("account_holder_name") String accountHolderName; /** - * The type of entity that holds the account. It can be `company` or `individual`. This field is - * required when attaching the bank account to a `Customer` object. + * The type of entity that holds the account. It can be {@code company} or {@code individual}. + * This field is required when attaching the bank account to a {@code Customer} object. */ @SerializedName("account_holder_type") AccountHolderType accountHolderType; @@ -215,8 +217,8 @@ public static class BankAccount { String country; /** - * The currency the bank account is in. This must be a country/currency pairing that [Stripe - * supports.](docs/payouts) + * The currency the bank account is in. This must be a country/currency pairing that Stripe supports. */ @SerializedName("currency") String currency; @@ -233,8 +235,8 @@ public static class BankAccount { /** * The routing number, sort code, or other country-appropriateinstitution number for the bank * account. For US bank accounts, this is required and should bethe ACH routing number, not the - * wire routing number. If you are providing an IBAN for`account_number`, this field is not - * required. + * wire routing number. If you are providing an IBAN for{@code account_number}, this field is + * not required. */ @SerializedName("routing_number") String routingNumber; @@ -289,7 +291,7 @@ public BankAccount build() { /** * The name of the person or business that owns the bank account.This field is required when - * attaching the bank account to a `Customer` object. + * attaching the bank account to a {@code Customer} object. */ public Builder setAccountHolderName(String accountHolderName) { this.accountHolderName = accountHolderName; @@ -297,8 +299,8 @@ public Builder setAccountHolderName(String accountHolderName) { } /** - * The type of entity that holds the account. It can be `company` or `individual`. This field - * is required when attaching the bank account to a `Customer` object. + * The type of entity that holds the account. It can be {@code company} or {@code individual}. + * This field is required when attaching the bank account to a {@code Customer} object. */ public Builder setAccountHolderType(AccountHolderType accountHolderType) { this.accountHolderType = accountHolderType; @@ -318,8 +320,8 @@ public Builder setCountry(String country) { } /** - * The currency the bank account is in. This must be a country/currency pairing that [Stripe - * supports.](docs/payouts) + * The currency the bank account is in. This must be a country/currency pairing that Stripe supports. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -355,8 +357,8 @@ public Builder putAllExtraParam(Map map) { /** * The routing number, sort code, or other country-appropriateinstitution number for the bank * account. For US bank accounts, this is required and should bethe ACH routing number, not - * the wire routing number. If you are providing an IBAN for`account_number`, this field is - * not required. + * the wire routing number. If you are providing an IBAN for{@code account_number}, this field + * is not required. */ public Builder setRoutingNumber(String routingNumber) { this.routingNumber = routingNumber; @@ -636,15 +638,18 @@ public static class Person { @SerializedName("first_name_kanji") String firstNameKanji; - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ @SerializedName("gender") String gender; /** * The person's ID number, as appropriate for their country. For example, a social security * number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you - * can also provide a [PII token provided by - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * can also provide a PII token + * provided by Stripe.js. */ @SerializedName("id_number") String idNumber; @@ -668,8 +673,8 @@ public static class Person { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -883,7 +888,10 @@ public Builder setFirstNameKanji(String firstNameKanji) { return this; } - /** The person's gender (International regulations require either "male" or "female"). */ + /** + * The person's gender (International regulations require either "male" or + * "female"). + */ public Builder setGender(String gender) { this.gender = gender; return this; @@ -892,8 +900,8 @@ public Builder setGender(String gender) { /** * The person's ID number, as appropriate for their country. For example, a social security * number in the U.S., social insurance number in Canada, etc. Instead of the number itself, - * you can also provide a [PII token provided by - * Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). + * you can also provide a PII + * token provided by Stripe.js. */ public Builder setIdNumber(String idNumber) { this.idNumber = idNumber; @@ -982,8 +990,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1068,8 +1076,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1137,8 +1145,8 @@ public static class AddressKana { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1232,8 +1240,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1307,8 +1315,8 @@ public static class AddressKanji { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1402,8 +1410,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1839,9 +1847,10 @@ public Builder putAllExtraParam(Map map) { @Getter public static class AdditionalDocument { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("back") String back; @@ -1857,9 +1866,10 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("front") String front; @@ -1887,9 +1897,10 @@ public AdditionalDocument build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -1925,9 +1936,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -1939,9 +1951,10 @@ public Builder setFront(String front) { @Getter public static class Document { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("back") String back; @@ -1957,9 +1970,10 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by - * 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ @SerializedName("front") String front; @@ -1987,9 +2001,10 @@ public Document build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -2025,9 +2040,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px - * by 8,000px), in JPG or PNG format, and less than 10 MB in size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded file + * needs to be a color image (smaller than 8,000px by 8,000px), in JPG or PNG format, and + * less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -2049,7 +2065,7 @@ public static class Pii { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** The `id_number` for the PII, in string form. */ + /** The {@code id_number} for the PII, in string form. */ @SerializedName("id_number") String idNumber; @@ -2098,7 +2114,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** The `id_number` for the PII, in string form. */ + /** The {@code id_number} for the PII, in string form. */ public Builder setIdNumber(String idNumber) { this.idNumber = idNumber; return this; diff --git a/src/main/java/com/stripe/param/TopupCreateParams.java b/src/main/java/com/stripe/param/TopupCreateParams.java index 67a966c4261..83167a7c861 100644 --- a/src/main/java/com/stripe/param/TopupCreateParams.java +++ b/src/main/java/com/stripe/param/TopupCreateParams.java @@ -15,8 +15,8 @@ public class TopupCreateParams extends ApiRequestParams { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency code, + * in lowercase. Must be a supported currency. */ @SerializedName("currency") String currency; @@ -41,7 +41,8 @@ public class TopupCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -49,8 +50,8 @@ public class TopupCreateParams extends ApiRequestParams { /** * The ID of a source to transfer funds from. For most users, this should be left unspecified * which will use the bank account that was set up in the dashboard for the specified currency. In - * test mode, this can be a test bank token (see [Testing - * Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). + * test mode, this can be a test bank token (see Testing Top-ups). */ @SerializedName("source") String source; @@ -131,8 +132,9 @@ public Builder setAmount(Long amount) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -226,8 +228,8 @@ public Builder putAllMetadata(Map map) { /** * The ID of a source to transfer funds from. For most users, this should be left unspecified * which will use the bank account that was set up in the dashboard for the specified currency. - * In test mode, this can be a test bank token (see [Testing - * Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). + * In test mode, this can be a test bank token (see Testing Top-ups). */ public Builder setSource(String source) { this.source = source; diff --git a/src/main/java/com/stripe/param/TopupListParams.java b/src/main/java/com/stripe/param/TopupListParams.java index 513cce95a82..be8809da050 100644 --- a/src/main/java/com/stripe/param/TopupListParams.java +++ b/src/main/java/com/stripe/param/TopupListParams.java @@ -15,17 +15,17 @@ public class TopupListParams extends ApiRequestParams { Object amount; /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string with + * an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ @SerializedName("created") Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -51,17 +51,17 @@ public class TopupListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or - * `succeeded`. + * Only return top-ups that have the given status. One of {@code canceled}, {@code failed}, {@code + * pending} or {@code succeeded}. */ @SerializedName("status") Status status; @@ -132,8 +132,9 @@ public Builder setAmount(Long amount) { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Created created) { this.created = created; @@ -141,8 +142,9 @@ public Builder setCreated(Created created) { } /** - * A filter on the list, based on the object `created` field. The value can be a string with an - * integer Unix timestamp, or it can be a dictionary with a number of different query options. + * A filter on the list, based on the object {@code created} field. The value can be a string + * with an integer Unix timestamp, or it can be a dictionary with a number of different query + * options. */ public Builder setCreated(Long created) { this.created = created; @@ -150,10 +152,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -222,10 +224,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -233,8 +235,8 @@ public Builder setStartingAfter(String startingAfter) { } /** - * Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or - * `succeeded`. + * Only return top-ups that have the given status. One of {@code canceled}, {@code failed}, + * {@code pending} or {@code succeeded}. */ public Builder setStatus(Status status) { this.status = status; diff --git a/src/main/java/com/stripe/param/TopupUpdateParams.java b/src/main/java/com/stripe/param/TopupUpdateParams.java index d7adec74b1d..a64107b48e1 100644 --- a/src/main/java/com/stripe/param/TopupUpdateParams.java +++ b/src/main/java/com/stripe/param/TopupUpdateParams.java @@ -31,7 +31,8 @@ public class TopupUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/TransferCreateParams.java b/src/main/java/com/stripe/param/TransferCreateParams.java index 2b9e7dcf182..c1cf00afe9b 100644 --- a/src/main/java/com/stripe/param/TransferCreateParams.java +++ b/src/main/java/com/stripe/param/TransferCreateParams.java @@ -14,7 +14,7 @@ public class TransferCreateParams extends ApiRequestParams { @SerializedName("amount") Long amount; - /** 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ + /** 3-letter ISO code for currency. */ @SerializedName("currency") String currency; @@ -23,8 +23,9 @@ public class TransferCreateParams extends ApiRequestParams { String description; /** - * The ID of a connected Stripe account. See the Connect - * documentation for details. + * The ID of a connected Stripe account. <a + * href="/docs/connect/charges-transfers">See the Connect documentation</a> for + * details. */ @SerializedName("destination") String destination; @@ -45,7 +46,8 @@ public class TransferCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -53,24 +55,24 @@ public class TransferCreateParams extends ApiRequestParams { /** * You can use this parameter to transfer funds from a charge before they are added to your * available balance. A pending balance will transfer immediately but the funds will not become - * available until the original charge becomes available. [See the Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for - * details. + * available until the original charge becomes available. See the Connect + * documentation for details. */ @SerializedName("source_transaction") String sourceTransaction; /** - * The source balance to use for this transfer. One of `bank_account` or `card`. For most users, - * this will default to `card`. + * The source balance to use for this transfer. One of {@code bank_account} or {@code card}. For + * most users, this will default to {@code card}. */ @SerializedName("source_type") SourceType sourceType; /** - * A string that identifies this transaction as part of a group. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. See the Connect + * documentation for details. */ @SerializedName("transfer_group") String transferGroup; @@ -144,7 +146,7 @@ public Builder setAmount(Long amount) { return this; } - /** 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ + /** 3-letter ISO code for currency. */ public Builder setCurrency(String currency) { this.currency = currency; return this; @@ -157,8 +159,9 @@ public Builder setDescription(String description) { } /** - * The ID of a connected Stripe account. See the - * Connect documentation for details. + * The ID of a connected Stripe account. <a + * href="/docs/connect/charges-transfers">See the Connect documentation</a> + * for details. */ public Builder setDestination(String destination) { this.destination = destination; @@ -246,9 +249,9 @@ public Builder putAllMetadata(Map map) { /** * You can use this parameter to transfer funds from a charge before they are added to your * available balance. A pending balance will transfer immediately but the funds will not become - * available until the original charge becomes available. [See the Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for - * details. + * available until the original charge becomes available. See the + * Connect documentation for details. */ public Builder setSourceTransaction(String sourceTransaction) { this.sourceTransaction = sourceTransaction; @@ -256,8 +259,8 @@ public Builder setSourceTransaction(String sourceTransaction) { } /** - * The source balance to use for this transfer. One of `bank_account` or `card`. For most users, - * this will default to `card`. + * The source balance to use for this transfer. One of {@code bank_account} or {@code card}. For + * most users, this will default to {@code card}. */ public Builder setSourceType(SourceType sourceType) { this.sourceType = sourceType; @@ -265,9 +268,9 @@ public Builder setSourceType(SourceType sourceType) { } /** - * A string that identifies this transaction as part of a group. See the [Connect - * documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for - * details. + * A string that identifies this transaction as part of a group. See the Connect + * documentation for details. */ public Builder setTransferGroup(String transferGroup) { this.transferGroup = transferGroup; diff --git a/src/main/java/com/stripe/param/TransferListParams.java b/src/main/java/com/stripe/param/TransferListParams.java index a7a21dfd4e4..eee29c25723 100644 --- a/src/main/java/com/stripe/param/TransferListParams.java +++ b/src/main/java/com/stripe/param/TransferListParams.java @@ -18,10 +18,10 @@ public class TransferListParams extends ApiRequestParams { String destination; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -47,10 +47,10 @@ public class TransferListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -129,10 +129,10 @@ public Builder setDestination(String destination) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -201,10 +201,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java b/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java index f039270bf9f..76b2a310810 100644 --- a/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java @@ -41,7 +41,8 @@ public class TransferReversalCollectionCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/TransferReversalCollectionListParams.java b/src/main/java/com/stripe/param/TransferReversalCollectionListParams.java index c748ede855c..ddff38349ed 100644 --- a/src/main/java/com/stripe/param/TransferReversalCollectionListParams.java +++ b/src/main/java/com/stripe/param/TransferReversalCollectionListParams.java @@ -11,10 +11,10 @@ @Getter public class TransferReversalCollectionListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class TransferReversalCollectionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public TransferReversalCollectionListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/TransferReversalUpdateParams.java b/src/main/java/com/stripe/param/TransferReversalUpdateParams.java index 29e6d9e4640..5d391e19999 100644 --- a/src/main/java/com/stripe/param/TransferReversalUpdateParams.java +++ b/src/main/java/com/stripe/param/TransferReversalUpdateParams.java @@ -26,7 +26,8 @@ public class TransferReversalUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/TransferUpdateParams.java b/src/main/java/com/stripe/param/TransferUpdateParams.java index 6ec9b8788e5..2a0915abddb 100644 --- a/src/main/java/com/stripe/param/TransferUpdateParams.java +++ b/src/main/java/com/stripe/param/TransferUpdateParams.java @@ -31,7 +31,8 @@ public class TransferUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/UsageRecordCreateOnSubscriptionItemParams.java b/src/main/java/com/stripe/param/UsageRecordCreateOnSubscriptionItemParams.java index 11c2ab03ec7..d74dcc488b1 100644 --- a/src/main/java/com/stripe/param/UsageRecordCreateOnSubscriptionItemParams.java +++ b/src/main/java/com/stripe/param/UsageRecordCreateOnSubscriptionItemParams.java @@ -11,11 +11,11 @@ @Getter public class UsageRecordCreateOnSubscriptionItemParams extends ApiRequestParams { /** - * Valid values are `increment` (default) or `set`. When using `increment` the specified - * `quantity` will be added to the usage at the specified timestamp. The `set` action will - * overwrite the usage quantity at that timestamp. If the subscription has [billing - * thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), - * `increment` is the only allowed value. + * Valid values are {@code increment} (default) or {@code set}. When using {@code increment} the + * specified {@code quantity} will be added to the usage at the specified timestamp. The {@code + * set} action will overwrite the usage quantity at that timestamp. If the subscription has billing + * thresholds, {@code increment} is the only allowed value. */ @SerializedName("action") Action action; @@ -39,7 +39,7 @@ public class UsageRecordCreateOnSubscriptionItemParams extends ApiRequestParams /** * The timestamp for the usage event. This timestamp must be within the current billing period of - * the subscription of the provided `subscription_item`. + * the subscription of the provided {@code subscription_item}. */ @SerializedName("timestamp") Long timestamp; @@ -79,11 +79,11 @@ public UsageRecordCreateOnSubscriptionItemParams build() { } /** - * Valid values are `increment` (default) or `set`. When using `increment` the specified - * `quantity` will be added to the usage at the specified timestamp. The `set` action will - * overwrite the usage quantity at that timestamp. If the subscription has [billing - * thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), - * `increment` is the only allowed value. + * Valid values are {@code increment} (default) or {@code set}. When using {@code increment} the + * specified {@code quantity} will be added to the usage at the specified timestamp. The {@code + * set} action will overwrite the usage quantity at that timestamp. If the subscription has billing + * thresholds, {@code increment} is the only allowed value. */ public Builder setAction(Action action) { this.action = action; @@ -151,7 +151,7 @@ public Builder setQuantity(Long quantity) { /** * The timestamp for the usage event. This timestamp must be within the current billing period - * of the subscription of the provided `subscription_item`. + * of the subscription of the provided {@code subscription_item}. */ public Builder setTimestamp(Long timestamp) { this.timestamp = timestamp; diff --git a/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java b/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java index 2865693a2d6..1f3728ab667 100644 --- a/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java +++ b/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java @@ -18,15 +18,15 @@ public class WebhookEndpointCreateParams extends ApiRequestParams { ApiVersion apiVersion; /** - * Whether this endpoint should receive events from connected accounts (`true`), or from your - * account (`false`). Defaults to `false`. + * Whether this endpoint should receive events from connected accounts ({@code true}), or from + * your account ({@code false}). Defaults to {@code false}. */ @SerializedName("connect") Boolean connect; /** - * The list of events to enable for this endpoint. You may specify `['*']` to enable all events, - * except those that require explicit selection. + * The list of events to enable for this endpoint. You may specify {@code ['*']} to enable all + * events, except those that require explicit selection. */ @SerializedName("enabled_events") List enabledEvents; @@ -101,8 +101,8 @@ public Builder setApiVersion(ApiVersion apiVersion) { } /** - * Whether this endpoint should receive events from connected accounts (`true`), or from your - * account (`false`). Defaults to `false`. + * Whether this endpoint should receive events from connected accounts ({@code true}), or from + * your account ({@code false}). Defaults to {@code false}. */ public Builder setConnect(Boolean connect) { this.connect = connect; diff --git a/src/main/java/com/stripe/param/WebhookEndpointListParams.java b/src/main/java/com/stripe/param/WebhookEndpointListParams.java index 7b0ceb16e10..14f808b72a6 100644 --- a/src/main/java/com/stripe/param/WebhookEndpointListParams.java +++ b/src/main/java/com/stripe/param/WebhookEndpointListParams.java @@ -11,10 +11,10 @@ @Getter public class WebhookEndpointListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class WebhookEndpointListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public WebhookEndpointListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java b/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java index 781ef3e065d..4bc77d5cc8b 100644 --- a/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java +++ b/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java @@ -16,8 +16,8 @@ public class WebhookEndpointUpdateParams extends ApiRequestParams { Boolean disabled; /** - * The list of events to enable for this endpoint. You may specify `['*']` to enable all events, - * except those that require explicit selection. + * The list of events to enable for this endpoint. You may specify {@code ['*']} to enable all + * events, except those that require explicit selection. */ @SerializedName("enabled_events") List enabledEvents; diff --git a/src/main/java/com/stripe/param/checkout/SessionCreateParams.java b/src/main/java/com/stripe/param/checkout/SessionCreateParams.java index 917a519e07d..909372ebb10 100644 --- a/src/main/java/com/stripe/param/checkout/SessionCreateParams.java +++ b/src/main/java/com/stripe/param/checkout/SessionCreateParams.java @@ -30,12 +30,12 @@ public class SessionCreateParams extends ApiRequestParams { String clientReferenceId; /** - * ID of an existing customer, if one exists. Only supported for Checkout Sessions in `payment` or - * `subscription` mode, but not Checkout Sessions in `setup` mode. The email stored on the - * customer will be used to prefill the email field on the Checkout page. If the customer changes - * their email on the Checkout page, the Customer object will be updated with the new email. If - * blank for Checkout Sessions in `payment` or `subscription` mode, Checkout will create a new - * customer object based on information provided during the session. + * ID of an existing customer, if one exists. Only supported for Checkout Sessions in {@code + * payment} or {@code subscription} mode, but not Checkout Sessions in {@code setup} mode. The + * email stored on the customer will be used to prefill the email field on the Checkout page. If + * the customer changes their email on the Checkout page, the Customer object will be updated with + * the new email. If blank for Checkout Sessions in {@code payment} or {@code subscription} mode, + * Checkout will create a new customer object based on information provided during the session. */ @SerializedName("customer") String customer; @@ -44,7 +44,7 @@ public class SessionCreateParams extends ApiRequestParams { * If provided, this value will be used when the Customer object is created. If not provided, * customers will be asked to enter their email address. Use this parameter to prefill customer * data if you already have an email on file. To access information about the customer once a - * session is complete, use the `customer` field. + * session is complete, use the {@code customer} field. */ @SerializedName("customer_email") String customerEmail; @@ -64,14 +64,14 @@ public class SessionCreateParams extends ApiRequestParams { /** * A list of items the customer is purchasing. Use this parameter for one-time payments or adding - * invoice line items to a subscription (used in conjunction with `subscription_data`). + * invoice line items to a subscription (used in conjunction with {@code subscription_data}). */ @SerializedName("line_items") List lineItems; /** - * The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's - * locale is used. + * The IETF language tag of the locale Checkout is displayed in. If blank or {@code auto}, the + * browser's locale is used. */ @SerializedName("locale") Locale locale; @@ -79,47 +79,52 @@ public class SessionCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; - /** The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`. */ + /** + * The mode of the Checkout Session, one of {@code payment}, {@code setup}, or {@code + * subscription}. + */ @SerializedName("mode") Mode mode; /** - * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in - * `payment` mode. + * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in {@code + * payment} mode. */ @SerializedName("payment_intent_data") PaymentIntentData paymentIntentData; /** * A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept. - * The only supported values today are `card` and `ideal`. + * The only supported values today are {@code card} and {@code ideal}. */ @SerializedName("payment_method_types") List paymentMethodTypes; /** - * A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` - * mode. + * A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in {@code + * setup} mode. */ @SerializedName("setup_intent_data") SetupIntentData setupIntentData; /** * Describes the type of transaction being performed by Checkout in order to customize relevant - * text on the page, such as the submit button. `submit_type` can only be specified on Checkout - * Sessions in `payment` mode, but not Checkout Sessions in `subscription` or `setup` mode. + * text on the page, such as the submit button. {@code submit_type} can only be specified on + * Checkout Sessions in {@code payment} mode, but not Checkout Sessions in {@code subscription} or + * {@code setup} mode. */ @SerializedName("submit_type") SubmitType submitType; /** - * A subset of parameters to be passed to subscription creation for Checkout Sessions in - * `subscription` mode. + * A subset of parameters to be passed to subscription creation for Checkout Sessions in {@code + * subscription} mode. */ @SerializedName("subscription_data") SubscriptionData subscriptionData; @@ -127,7 +132,8 @@ public class SessionCreateParams extends ApiRequestParams { /** * The URL to which Stripe should send customers when payment or setup is complete. If you’d like * access to the Checkout Session for the successful payment, read more about it in our guide on - * [fulfilling your payments with webhooks](/docs/payments/checkout/fulfillment#webhooks). + * fulfilling your + * payments with webhooks. */ @SerializedName("success_url") String successUrl; @@ -255,12 +261,13 @@ public Builder setClientReferenceId(String clientReferenceId) { } /** - * ID of an existing customer, if one exists. Only supported for Checkout Sessions in `payment` - * or `subscription` mode, but not Checkout Sessions in `setup` mode. The email stored on the - * customer will be used to prefill the email field on the Checkout page. If the customer - * changes their email on the Checkout page, the Customer object will be updated with the new - * email. If blank for Checkout Sessions in `payment` or `subscription` mode, Checkout will - * create a new customer object based on information provided during the session. + * ID of an existing customer, if one exists. Only supported for Checkout Sessions in {@code + * payment} or {@code subscription} mode, but not Checkout Sessions in {@code setup} mode. The + * email stored on the customer will be used to prefill the email field on the Checkout page. If + * the customer changes their email on the Checkout page, the Customer object will be updated + * with the new email. If blank for Checkout Sessions in {@code payment} or {@code subscription} + * mode, Checkout will create a new customer object based on information provided during the + * session. */ public Builder setCustomer(String customer) { this.customer = customer; @@ -271,7 +278,7 @@ public Builder setCustomer(String customer) { * If provided, this value will be used when the Customer object is created. If not provided, * customers will be asked to enter their email address. Use this parameter to prefill customer * data if you already have an email on file. To access information about the customer once a - * session is complete, use the `customer` field. + * session is complete, use the {@code customer} field. */ public Builder setCustomerEmail(String customerEmail) { this.customerEmail = customerEmail; @@ -357,7 +364,7 @@ public Builder addAllLineItem(List elements) { } /** - * The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the + * The IETF language tag of the locale Checkout is displayed in. If blank or {@code auto}, the * browser's locale is used. */ public Builder setLocale(Locale locale) { @@ -391,15 +398,18 @@ public Builder putAllMetadata(Map map) { return this; } - /** The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`. */ + /** + * The mode of the Checkout Session, one of {@code payment}, {@code setup}, or {@code + * subscription}. + */ public Builder setMode(Mode mode) { this.mode = mode; return this; } /** - * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in - * `payment` mode. + * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in {@code + * payment} mode. */ public Builder setPaymentIntentData(PaymentIntentData paymentIntentData) { this.paymentIntentData = paymentIntentData; @@ -433,8 +443,8 @@ public Builder addAllPaymentMethodType(List elements) { } /** - * A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` - * mode. + * A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in {@code + * setup} mode. */ public Builder setSetupIntentData(SetupIntentData setupIntentData) { this.setupIntentData = setupIntentData; @@ -443,8 +453,9 @@ public Builder setSetupIntentData(SetupIntentData setupIntentData) { /** * Describes the type of transaction being performed by Checkout in order to customize relevant - * text on the page, such as the submit button. `submit_type` can only be specified on Checkout - * Sessions in `payment` mode, but not Checkout Sessions in `subscription` or `setup` mode. + * text on the page, such as the submit button. {@code submit_type} can only be specified on + * Checkout Sessions in {@code payment} mode, but not Checkout Sessions in {@code subscription} + * or {@code setup} mode. */ public Builder setSubmitType(SubmitType submitType) { this.submitType = submitType; @@ -452,8 +463,8 @@ public Builder setSubmitType(SubmitType submitType) { } /** - * A subset of parameters to be passed to subscription creation for Checkout Sessions in - * `subscription` mode. + * A subset of parameters to be passed to subscription creation for Checkout Sessions in {@code + * subscription} mode. */ public Builder setSubscriptionData(SubscriptionData subscriptionData) { this.subscriptionData = subscriptionData; @@ -463,8 +474,8 @@ public Builder setSubscriptionData(SubscriptionData subscriptionData) { /** * The URL to which Stripe should send customers when payment or setup is complete. If you’d * like access to the Checkout Session for the successful payment, read more about it in our - * guide on [fulfilling your payments with - * webhooks](/docs/payments/checkout/fulfillment#webhooks). + * guide on fulfilling + * your payments with webhooks. */ public Builder setSuccessUrl(String successUrl) { this.successUrl = successUrl; @@ -479,8 +490,9 @@ public static class LineItem { Long amount; /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ @SerializedName("currency") String currency; @@ -565,8 +577,9 @@ public Builder setAmount(Long amount) { } /** - * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in - * lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -650,9 +663,10 @@ public static class PaymentIntentData { /** * The amount of the application fee (if any) that will be applied to the payment and * transferred to the application owner's Stripe account. To use an application fee, the request - * must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. - * For more information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * must be made on behalf of another account, using the {@code Stripe-Account} header or an + * OAuth key. For more information, see the PaymentIntents use case for connected + * accounts. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; @@ -677,15 +691,16 @@ public static class PaymentIntentData { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; /** * The Stripe account ID for which these funds are intended. For details, see the PaymentIntents - * [use case for connected accounts](/docs/payments/connected-accounts). + * use case for connected + * accounts. */ @SerializedName("on_behalf_of") String onBehalfOf; @@ -697,20 +712,20 @@ public static class PaymentIntentData { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the - * transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

For more, learn to [save card details after a - * payment](https://stripe.com/docs/payments/save-after-payment). + *

For more, learn to save card + * details after a payment. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with - * regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will - * ensure that they are authenticated while processing this PaymentIntent. You will then be able - * to collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and + * comply with regional legislation and network rules. For example, if your customer is impacted + * by SCA, using {@code + * off_session} will ensure that they are authenticated while processing this PaymentIntent. You + * will then be able to collect off-session + * payments for this customer. */ @SerializedName("setup_future_usage") SetupFutureUsage setupFutureUsage; @@ -737,8 +752,9 @@ public static class PaymentIntentData { /** * The parameters used to automatically create a Transfer when the payment succeeds. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected + * accounts. */ @SerializedName("transfer_data") TransferData transferData; @@ -819,9 +835,10 @@ public PaymentIntentData build() { /** * The amount of the application fee (if any) that will be applied to the payment and * transferred to the application owner's Stripe account. To use an application fee, the - * request must be made on behalf of another account, using the `Stripe-Account` header or an - * OAuth key. For more information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * request must be made on behalf of another account, using the {@code Stripe-Account} header + * or an OAuth key. For more information, see the PaymentIntents use case for connected + * accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -894,7 +911,8 @@ public Builder putAllMetadata(Map map) { /** * The Stripe account ID for which these funds are intended. For details, see the - * PaymentIntents [use case for connected accounts](/docs/payments/connected-accounts). + * PaymentIntents use case for + * connected accounts. */ public Builder setOnBehalfOf(String onBehalfOf) { this.onBehalfOf = onBehalfOf; @@ -910,20 +928,20 @@ public Builder setReceiptEmail(String receiptEmail) { /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * - *

If present, the payment method used with this PaymentIntent can be - * [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after - * the transaction completes. + *

If present, the payment method used with this PaymentIntent can be attached to a Customer, even + * after the transaction completes. * - *

For more, learn to [save card details after a - * payment](https://stripe.com/docs/payments/save-after-payment). + *

For more, learn to save + * card details after a payment. * - *

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply - * with regional legislation and network rules. For example, if your customer is impacted by - * [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will - * ensure that they are authenticated while processing this PaymentIntent. You will then be - * able to collect [off-session - * payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) - * for this customer. + *

Stripe uses {@code setup_future_usage} to dynamically optimize your payment flow and + * comply with regional legislation and network rules. For example, if your customer is + * impacted by SCA, using + * {@code off_session} will ensure that they are authenticated while processing this + * PaymentIntent. You will then be able to collect off-session + * payments for this customer. */ public Builder setSetupFutureUsage(SetupFutureUsage setupFutureUsage) { this.setupFutureUsage = setupFutureUsage; @@ -958,8 +976,9 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * The parameters used to automatically create a Transfer when the payment succeeds. For more - * information, see the PaymentIntents [use case for connected - * accounts](https://stripe.com/docs/payments/connected-accounts). + * information, see the PaymentIntents use case for connected + * accounts. */ public Builder setTransferData(TransferData transferData) { this.transferData = transferData; @@ -1114,8 +1133,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -1201,8 +1220,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -1269,7 +1288,8 @@ public static class TransferData { /** * If specified, successful charges will be attributed to the destination account for tax * reporting, and the funds from charges will be transferred to the destination account. The - * ID of the resulting transfer will be returned on the successful charge's `transfer` field. + * ID of the resulting transfer will be returned on the successful charge's {@code transfer} + * field. */ @SerializedName("destination") String destination; @@ -1305,7 +1325,7 @@ public TransferData build() { /** * If specified, successful charges will be attributed to the destination account for tax * reporting, and the funds from charges will be transferred to the destination account. The - * ID of the resulting transfer will be returned on the successful charge's `transfer` + * ID of the resulting transfer will be returned on the successful charge's {@code transfer} * field. */ public Builder setDestination(String destination) { @@ -1392,8 +1412,8 @@ public static class SetupIntentData { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -1504,9 +1524,9 @@ public static class SubscriptionData { * A non-negative decimal between 0 and 100, with at most two decimal places. This represents * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. To use an application fee percent, the request must be - * made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For - * more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * made on behalf of another account, using the {@code Stripe-Account} header or an OAuth key. + * For more information, see the application fees documentation. */ @SerializedName("application_fee_percent") BigDecimal applicationFeePercent; @@ -1522,7 +1542,7 @@ public static class SubscriptionData { /** * A list of items, each with an attached plan, that the customer is subscribing to. Use this - * parameter for subscriptions. To create one-time payments, use `line_items`. + * parameter for subscriptions. To create one-time payments, use {@code line_items}. */ @SerializedName("items") List items; @@ -1530,8 +1550,8 @@ public static class SubscriptionData { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -1544,8 +1564,9 @@ public static class SubscriptionData { Long trialEnd; /** - * Indicates if a plan’s `trial_period_days` should be applied to the subscription. Setting - * `trial_end` on `subscription_data` is preferred. Defaults to `false`. + * Indicates if a plan’s {@code trial_period_days} should be applied to the subscription. + * Setting {@code trial_end} on {@code subscription_data} is preferred. Defaults to {@code + * false}. */ @SerializedName("trial_from_plan") Boolean trialFromPlan; @@ -1609,9 +1630,9 @@ public SubscriptionData build() { * A non-negative decimal between 0 and 100, with at most two decimal places. This represents * the percentage of the subscription invoice subtotal that will be transferred to the * application owner's Stripe account. To use an application fee percent, the request must be - * made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For - * more information, see the application fees - * [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * made on behalf of another account, using the {@code Stripe-Account} header or an OAuth key. + * For more information, see the application fees documentation. */ public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) { this.applicationFeePercent = applicationFeePercent; @@ -1706,8 +1727,9 @@ public Builder setTrialEnd(Long trialEnd) { } /** - * Indicates if a plan’s `trial_period_days` should be applied to the subscription. Setting - * `trial_end` on `subscription_data` is preferred. Defaults to `false`. + * Indicates if a plan’s {@code trial_period_days} should be applied to the subscription. + * Setting {@code trial_end} on {@code subscription_data} is preferred. Defaults to {@code + * false}. */ public Builder setTrialFromPlan(Boolean trialFromPlan) { this.trialFromPlan = trialFromPlan; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java index 85b30e56544..a6762231980 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java @@ -25,10 +25,10 @@ public class AuthorizationApproveParams extends ApiRequestParams { Map extraParams; /** - * If the authorization's `is_held_amount_controllable` property is `true`, you may provide this - * value to control how much to hold for the authorization. Must be positive (use - * [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an - * authorization request). + * If the authorization's {@code is_held_amount_controllable} property is {@code true}, you may + * provide this value to control how much to hold for the authorization. Must be positive (use {@code decline} to + * decline an authorization request). */ @SerializedName("held_amount") Long heldAmount; @@ -36,7 +36,8 @@ public class AuthorizationApproveParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Object metadata; @@ -121,10 +122,10 @@ public Builder putAllExtraParam(Map map) { } /** - * If the authorization's `is_held_amount_controllable` property is `true`, you may provide this - * value to control how much to hold for the authorization. Must be positive (use - * [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an - * authorization request). + * If the authorization's {@code is_held_amount_controllable} property is {@code true}, you may + * provide this value to control how much to hold for the authorization. Must be positive (use + * {@code decline} to + * decline an authorization request). */ public Builder setHeldAmount(Long heldAmount) { this.heldAmount = heldAmount; @@ -162,8 +163,8 @@ public Builder putAllMetadata(Map map) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(EmptyParam metadata) { this.metadata = metadata; @@ -173,8 +174,8 @@ public Builder setMetadata(EmptyParam metadata) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(Map metadata) { this.metadata = metadata; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java index d8a714c9865..170404ab3b2 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java @@ -27,7 +27,8 @@ public class AuthorizationDeclineParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Object metadata; @@ -138,8 +139,8 @@ public Builder putAllMetadata(Map map) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(EmptyParam metadata) { this.metadata = metadata; @@ -149,8 +150,8 @@ public Builder setMetadata(EmptyParam metadata) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(Map metadata) { this.metadata = metadata; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationListParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationListParams.java index f7cd0c934ac..d78f071326d 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationListParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationListParams.java @@ -23,10 +23,10 @@ public class AuthorizationListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -52,16 +52,17 @@ public class AuthorizationListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. + * Only return authorizations with the given status. One of {@code pending}, {@code closed}, or + * {@code reversed}. */ @SerializedName("status") Status status; @@ -149,10 +150,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -221,10 +222,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -232,7 +233,8 @@ public Builder setStartingAfter(String startingAfter) { } /** - * Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. + * Only return authorizations with the given status. One of {@code pending}, {@code closed}, or + * {@code reversed}. */ public Builder setStatus(Status status) { this.status = status; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java index 58ebf2148b7..3068d29bcb7 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java @@ -27,7 +27,8 @@ public class AuthorizationUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Object metadata; @@ -138,8 +139,8 @@ public Builder putAllMetadata(Map map) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(EmptyParam metadata) { this.metadata = metadata; @@ -149,8 +150,8 @@ public Builder setMetadata(EmptyParam metadata) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(Map metadata) { this.metadata = metadata; diff --git a/src/main/java/com/stripe/param/issuing/CardCreateParams.java b/src/main/java/com/stripe/param/issuing/CardCreateParams.java index 650b822b596..5dceff18192 100644 --- a/src/main/java/com/stripe/param/issuing/CardCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardCreateParams.java @@ -11,21 +11,21 @@ @Getter public class CardCreateParams extends ApiRequestParams { /** - * Spending rules that give you some control over how your cards can be used. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more + * Spending rules that give you some control over how your cards can be used. Refer to our authorizations documentation for more * details. */ @SerializedName("authorization_controls") AuthorizationControls authorizationControls; /** - * The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the - * card will be associated. + * The Cardholder object with + * which the card will be associated. */ @SerializedName("cardholder") String cardholder; - /** The currency for the card. This currently must be `usd`. */ + /** The currency for the card. This currently must be {@code usd}. */ @SerializedName("currency") String currency; @@ -45,7 +45,8 @@ public class CardCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -54,7 +55,9 @@ public class CardCreateParams extends ApiRequestParams { @SerializedName("replacement_for") String replacementFor; - /** If `replacement_for` is specified, this should indicate why that card is being replaced. */ + /** + * If {@code replacement_for} is specified, this should indicate why that card is being replaced. + */ @SerializedName("replacement_reason") ReplacementReason replacementReason; @@ -62,11 +65,11 @@ public class CardCreateParams extends ApiRequestParams { @SerializedName("shipping") Shipping shipping; - /** Whether authorizations can be approved on this card. Defaults to `inactive`. */ + /** Whether authorizations can be approved on this card. Defaults to {@code inactive}. */ @SerializedName("status") Status status; - /** The type of card to issue. Possible values are `physical` or `virtual`. */ + /** The type of card to issue. Possible values are {@code physical} or {@code virtual}. */ @SerializedName("type") Type type; @@ -139,9 +142,9 @@ public CardCreateParams build() { } /** - * Spending rules that give you some control over how your cards can be used. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more - * details. + * Spending rules that give you some control over how your cards can be used. Refer to our authorizations documentation for + * more details. */ public Builder setAuthorizationControls(AuthorizationControls authorizationControls) { this.authorizationControls = authorizationControls; @@ -149,15 +152,15 @@ public Builder setAuthorizationControls(AuthorizationControls authorizationContr } /** - * The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the - * card will be associated. + * The Cardholder object + * with which the card will be associated. */ public Builder setCardholder(String cardholder) { this.cardholder = cardholder; return this; } - /** The currency for the card. This currently must be `usd`. */ + /** The currency for the card. This currently must be {@code usd}. */ public Builder setCurrency(String currency) { this.currency = currency; return this; @@ -247,7 +250,10 @@ public Builder setReplacementFor(String replacementFor) { return this; } - /** If `replacement_for` is specified, this should indicate why that card is being replaced. */ + /** + * If {@code replacement_for} is specified, this should indicate why that card is being + * replaced. + */ public Builder setReplacementReason(ReplacementReason replacementReason) { this.replacementReason = replacementReason; return this; @@ -259,13 +265,13 @@ public Builder setShipping(Shipping shipping) { return this; } - /** Whether authorizations can be approved on this card. Defaults to `inactive`. */ + /** Whether authorizations can be approved on this card. Defaults to {@code inactive}. */ public Builder setStatus(Status status) { this.status = status; return this; } - /** The type of card to issue. Possible values are `physical` or `virtual`. */ + /** The type of card to issue. Possible values are {@code physical} or {@code virtual}. */ public Builder setType(Type type) { this.type = type; return this; @@ -275,16 +281,16 @@ public Builder setType(Type type) { @Getter public static class AuthorizationControls { /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations permitted on this card. */ @SerializedName("allowed_categories") List allowedCategories; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations to always decline on this card. */ @SerializedName("blocked_categories") @@ -473,8 +479,8 @@ public static class SpendingLimit { Long amount; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * on which to apply the spending limit. Leave this blank to limit all charges. */ @SerializedName("categories") @@ -3413,8 +3419,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -3499,8 +3505,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; diff --git a/src/main/java/com/stripe/param/issuing/CardListParams.java b/src/main/java/com/stripe/param/issuing/CardListParams.java index 8ba8b8d689e..9a172aac21a 100644 --- a/src/main/java/com/stripe/param/issuing/CardListParams.java +++ b/src/main/java/com/stripe/param/issuing/CardListParams.java @@ -19,10 +19,10 @@ public class CardListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -68,22 +68,22 @@ public class CardListParams extends ApiRequestParams { String source; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * Only return cards that have the given status. One of `active`, `inactive`, `canceled`, `lost`, - * or `stolen`. + * Only return cards that have the given status. One of {@code active}, {@code inactive}, {@code + * canceled}, {@code lost}, or {@code stolen}. */ @SerializedName("status") Status status; - /** Only return cards that have the given type. One of `virtual` or `physical`. */ + /** Only return cards that have the given type. One of {@code virtual} or {@code physical}. */ @SerializedName("type") Type type; @@ -189,10 +189,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -291,10 +291,10 @@ public Builder setSource(String source) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -302,15 +302,15 @@ public Builder setStartingAfter(String startingAfter) { } /** - * Only return cards that have the given status. One of `active`, `inactive`, `canceled`, - * `lost`, or `stolen`. + * Only return cards that have the given status. One of {@code active}, {@code inactive}, {@code + * canceled}, {@code lost}, or {@code stolen}. */ public Builder setStatus(Status status) { this.status = status; return this; } - /** Only return cards that have the given type. One of `virtual` or `physical`. */ + /** Only return cards that have the given type. One of {@code virtual} or {@code physical}. */ public Builder setType(Type type) { this.type = type; return this; diff --git a/src/main/java/com/stripe/param/issuing/CardUpdateParams.java b/src/main/java/com/stripe/param/issuing/CardUpdateParams.java index a88c2dd48ff..87169f1e40e 100644 --- a/src/main/java/com/stripe/param/issuing/CardUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardUpdateParams.java @@ -12,8 +12,8 @@ @Getter public class CardUpdateParams extends ApiRequestParams { /** - * Spending rules that give you some control over how your cards can be used. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more + * Spending rules that give you some control over how your cards can be used. Refer to our authorizations documentation for more * details. */ @SerializedName("authorization_controls") @@ -35,7 +35,8 @@ public class CardUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Object metadata; @@ -79,9 +80,9 @@ public CardUpdateParams build() { } /** - * Spending rules that give you some control over how your cards can be used. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more - * details. + * Spending rules that give you some control over how your cards can be used. Refer to our authorizations documentation for + * more details. */ public Builder setAuthorizationControls(AuthorizationControls authorizationControls) { this.authorizationControls = authorizationControls; @@ -171,8 +172,8 @@ public Builder putAllMetadata(Map map) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(EmptyParam metadata) { this.metadata = metadata; @@ -182,8 +183,8 @@ public Builder setMetadata(EmptyParam metadata) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(Map metadata) { this.metadata = metadata; @@ -200,16 +201,16 @@ public Builder setStatus(Status status) { @Getter public static class AuthorizationControls { /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations permitted on this card. */ @SerializedName("allowed_categories") List allowedCategories; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations to always decline on this card. */ @SerializedName("blocked_categories") @@ -398,8 +399,8 @@ public static class SpendingLimit { Long amount; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * on which to apply the spending limit. Leave this blank to limit all charges. */ @SerializedName("categories") diff --git a/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java b/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java index aa15fb403f5..f9e3b537f41 100644 --- a/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java @@ -12,8 +12,8 @@ public class CardholderCreateParams extends ApiRequestParams { /** * Spending rules that give you control over how your cardholders can make charges. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more - * details. + * authorizations documentation for + * more details. */ @SerializedName("authorization_controls") AuthorizationControls authorizationControls; @@ -22,7 +22,7 @@ public class CardholderCreateParams extends ApiRequestParams { @SerializedName("billing") Billing billing; - /** Additional information about a `business_entity` cardholder. */ + /** Additional information about a {@code business_entity} cardholder. */ @SerializedName("company") Company company; @@ -43,7 +43,7 @@ public class CardholderCreateParams extends ApiRequestParams { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Additional information about an `individual` cardholder. */ + /** Additional information about an {@code individual} cardholder. */ @SerializedName("individual") Individual individual; @@ -54,7 +54,8 @@ public class CardholderCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -64,19 +65,21 @@ public class CardholderCreateParams extends ApiRequestParams { String name; /** - * The cardholder's phone number. This will be transformed to - * [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. + * The cardholder's phone number. This will be transformed to E.164 if it is not provided in that format + * already. */ @SerializedName("phone_number") String phoneNumber; /** - * Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. + * Specifies whether to permit authorizations on this cardholder's cards. Defaults to {@code + * active}. */ @SerializedName("status") Status status; - /** One of `individual` or `business_entity`. */ + /** One of {@code individual} or {@code business_entity}. */ @SerializedName("type") Type type; @@ -160,8 +163,8 @@ public CardholderCreateParams build() { /** * Spending rules that give you control over how your cardholders can make charges. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more - * details. + * authorizations documentation for + * more details. */ public Builder setAuthorizationControls(AuthorizationControls authorizationControls) { this.authorizationControls = authorizationControls; @@ -174,7 +177,7 @@ public Builder setBilling(Billing billing) { return this; } - /** Additional information about a `business_entity` cardholder. */ + /** Additional information about a {@code business_entity} cardholder. */ public Builder setCompany(Company company) { this.company = company; return this; @@ -238,7 +241,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Additional information about an `individual` cardholder. */ + /** Additional information about an {@code individual} cardholder. */ public Builder setIndividual(Individual individual) { this.individual = individual; return this; @@ -283,8 +286,9 @@ public Builder setName(String name) { } /** - * The cardholder's phone number. This will be transformed to - * [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. + * The cardholder's phone number. This will be transformed to E.164 if it is not provided in that format + * already. */ public Builder setPhoneNumber(String phoneNumber) { this.phoneNumber = phoneNumber; @@ -292,14 +296,15 @@ public Builder setPhoneNumber(String phoneNumber) { } /** - * Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. + * Specifies whether to permit authorizations on this cardholder's cards. Defaults to {@code + * active}. */ public Builder setStatus(Status status) { this.status = status; return this; } - /** One of `individual` or `business_entity`. */ + /** One of {@code individual} or {@code business_entity}. */ public Builder setType(Type type) { this.type = type; return this; @@ -309,16 +314,16 @@ public Builder setType(Type type) { @Getter public static class AuthorizationControls { /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations permitted on this card. */ @SerializedName("allowed_categories") List allowedCategories; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations to always decline on this card. */ @SerializedName("blocked_categories") @@ -502,8 +507,8 @@ public static class SpendingLimit { Long amount; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * on which to apply the spending limit. Leave this blank to limit all charges. */ @SerializedName("categories") @@ -3402,8 +3407,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -3488,8 +3493,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -3899,8 +3904,8 @@ public Builder putAllExtraParam(Map map) { @Getter public static class Document { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") String back; @@ -3916,8 +3921,8 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") String front; @@ -3945,8 +3950,8 @@ public Document build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setBack(String back) { this.back = back; @@ -3982,8 +3987,8 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setFront(String front) { this.front = front; diff --git a/src/main/java/com/stripe/param/issuing/CardholderListParams.java b/src/main/java/com/stripe/param/issuing/CardholderListParams.java index 6a4e5ea2681..563ef7be3e4 100644 --- a/src/main/java/com/stripe/param/issuing/CardholderListParams.java +++ b/src/main/java/com/stripe/param/issuing/CardholderListParams.java @@ -19,10 +19,10 @@ public class CardholderListParams extends ApiRequestParams { String email; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -56,21 +56,25 @@ public class CardholderListParams extends ApiRequestParams { String phoneNumber; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. + * Only return cardholders that have the given status. One of {@code active}, {@code inactive}, or + * {@code blocked}. */ @SerializedName("status") Status status; - /** Only return cardholders that have the given type. One of `individual` or `business_entity`. */ + /** + * Only return cardholders that have the given type. One of {@code individual} or {@code + * business_entity}. + */ @SerializedName("type") Type type; @@ -161,10 +165,10 @@ public Builder setEmail(String email) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -245,10 +249,10 @@ public Builder setPhoneNumber(String phoneNumber) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -256,8 +260,8 @@ public Builder setStartingAfter(String startingAfter) { } /** - * Only return cardholders that have the given status. One of `active`, `inactive`, or - * `blocked`. + * Only return cardholders that have the given status. One of {@code active}, {@code inactive}, + * or {@code blocked}. */ public Builder setStatus(Status status) { this.status = status; @@ -265,7 +269,8 @@ public Builder setStatus(Status status) { } /** - * Only return cardholders that have the given type. One of `individual` or `business_entity`. + * Only return cardholders that have the given type. One of {@code individual} or {@code + * business_entity}. */ public Builder setType(Type type) { this.type = type; diff --git a/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java b/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java index 5737da9f43b..40a698b401c 100644 --- a/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java @@ -12,8 +12,8 @@ @Getter public class CardholderUpdateParams extends ApiRequestParams { /** - * Spending rules that give you some control over how your cards can be used. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more + * Spending rules that give you some control over how your cards can be used. Refer to our authorizations documentation for more * details. */ @SerializedName("authorization_controls") @@ -23,7 +23,7 @@ public class CardholderUpdateParams extends ApiRequestParams { @SerializedName("billing") Billing billing; - /** Additional information about a `business_entity` cardholder. */ + /** Additional information about a {@code business_entity} cardholder. */ @SerializedName("company") Company company; @@ -44,7 +44,7 @@ public class CardholderUpdateParams extends ApiRequestParams { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Additional information about an `individual` cardholder. */ + /** Additional information about an {@code individual} cardholder. */ @SerializedName("individual") Individual individual; @@ -55,7 +55,8 @@ public class CardholderUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -137,9 +138,9 @@ public CardholderUpdateParams build() { } /** - * Spending rules that give you some control over how your cards can be used. Refer to our - * [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more - * details. + * Spending rules that give you some control over how your cards can be used. Refer to our authorizations documentation for + * more details. */ public Builder setAuthorizationControls(AuthorizationControls authorizationControls) { this.authorizationControls = authorizationControls; @@ -152,7 +153,7 @@ public Builder setBilling(Billing billing) { return this; } - /** Additional information about a `business_entity` cardholder. */ + /** Additional information about a {@code business_entity} cardholder. */ public Builder setCompany(Company company) { this.company = company; return this; @@ -222,7 +223,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Additional information about an `individual` cardholder. */ + /** Additional information about an {@code individual} cardholder. */ public Builder setIndividual(Individual individual) { this.individual = individual; return this; @@ -282,16 +283,16 @@ public Builder setStatus(Status status) { @Getter public static class AuthorizationControls { /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations permitted on this card. */ @SerializedName("allowed_categories") List allowedCategories; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * of authorizations to always decline on this card. */ @SerializedName("blocked_categories") @@ -481,8 +482,8 @@ public static class SpendingLimit { Long amount; /** - * Array of strings containing - * [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + * Array of strings containing categories * on which to apply the spending limit. Leave this blank to limit all charges. */ @SerializedName("categories") @@ -3381,8 +3382,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -3473,8 +3474,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -3482,8 +3483,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; @@ -3935,8 +3936,8 @@ public Builder putAllExtraParam(Map map) { @Getter public static class Document { /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") Object back; @@ -3952,8 +3953,8 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") Object front; @@ -3981,8 +3982,8 @@ public Document build() { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setBack(String back) { this.back = back; @@ -3990,8 +3991,8 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setBack(EmptyParam back) { this.back = back; @@ -4027,8 +4028,8 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setFront(String front) { this.front = front; @@ -4036,8 +4037,8 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a [file upload](#create_file) with a `purpose` value of - * `identity_document`. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setFront(EmptyParam front) { this.front = front; diff --git a/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java b/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java index 32c2c706c95..15da420b5fb 100644 --- a/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java @@ -22,7 +22,7 @@ public class DisputeCreateParams extends ApiRequestParams { /** * A hash containing all the evidence related to the dispute. This should have a single key, equal - * to the provided `reason`, mapping to an appropriate evidence object. + * to the provided {@code reason}, mapping to an appropriate evidence object. */ @SerializedName("evidence") Evidence evidence; @@ -43,7 +43,8 @@ public class DisputeCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -116,7 +117,7 @@ public Builder setDisputedTransaction(String disputedTransaction) { /** * A hash containing all the evidence related to the dispute. This should have a single key, - * equal to the provided `reason`, mapping to an appropriate evidence object. + * equal to the provided {@code reason}, mapping to an appropriate evidence object. */ public Builder setEvidence(Evidence evidence) { this.evidence = evidence; @@ -220,15 +221,15 @@ public static class Evidence { Map extraParams; /** - * Evidence to support a fraudulent dispute. Only provide this if your dispute's `reason` is - * `fraudulent`. + * Evidence to support a fraudulent dispute. Only provide this if your dispute's {@code reason} + * is {@code fraudulent}. */ @SerializedName("fraudulent") Fraudulent fraudulent; /** - * Evidence to support an uncategorized dispute. Only provide this if your dispute's `reason` is - * `other`. + * Evidence to support an uncategorized dispute. Only provide this if your dispute's {@code + * reason} is {@code other}. */ @SerializedName("other") Other other; @@ -282,8 +283,8 @@ public Builder putAllExtraParam(Map map) { } /** - * Evidence to support a fraudulent dispute. Only provide this if your dispute's `reason` is - * `fraudulent`. + * Evidence to support a fraudulent dispute. Only provide this if your dispute's {@code + * reason} is {@code fraudulent}. */ public Builder setFraudulent(Fraudulent fraudulent) { this.fraudulent = fraudulent; @@ -291,8 +292,8 @@ public Builder setFraudulent(Fraudulent fraudulent) { } /** - * Evidence to support an uncategorized dispute. Only provide this if your dispute's `reason` - * is `other`. + * Evidence to support an uncategorized dispute. Only provide this if your dispute's {@code + * reason} is {@code other}. */ public Builder setOther(Other other) { this.other = other; @@ -316,8 +317,8 @@ public static class Fraudulent { Map extraParams; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional file - * evidence supporting your dispute. + * (ID of a file upload) Additional + * file evidence supporting your dispute. */ @SerializedName("uncategorized_file") String uncategorizedFile; @@ -380,8 +381,8 @@ public Builder putAllExtraParam(Map map) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional file - * evidence supporting your dispute. + * (ID of a file upload) Additional + * file evidence supporting your dispute. */ public Builder setUncategorizedFile(String uncategorizedFile) { this.uncategorizedFile = uncategorizedFile; @@ -406,8 +407,8 @@ public static class Other { Map extraParams; /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional file - * evidence supporting your dispute. + * (ID of a file upload) Additional + * file evidence supporting your dispute. */ @SerializedName("uncategorized_file") String uncategorizedFile; @@ -470,8 +471,8 @@ public Builder putAllExtraParam(Map map) { } /** - * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional file - * evidence supporting your dispute. + * (ID of a file upload) Additional + * file evidence supporting your dispute. */ public Builder setUncategorizedFile(String uncategorizedFile) { this.uncategorizedFile = uncategorizedFile; diff --git a/src/main/java/com/stripe/param/issuing/DisputeListParams.java b/src/main/java/com/stripe/param/issuing/DisputeListParams.java index 6fa38b7b2ee..c94e4563c0f 100644 --- a/src/main/java/com/stripe/param/issuing/DisputeListParams.java +++ b/src/main/java/com/stripe/param/issuing/DisputeListParams.java @@ -19,10 +19,10 @@ public class DisputeListParams extends ApiRequestParams { String disputedTransaction; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -48,10 +48,10 @@ public class DisputeListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -123,10 +123,10 @@ public Builder setDisputedTransaction(String disputedTransaction) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -195,10 +195,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java b/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java index dc27fe728ea..997f7f49f7e 100644 --- a/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java @@ -26,7 +26,8 @@ public class DisputeUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/issuing/TransactionListParams.java b/src/main/java/com/stripe/param/issuing/TransactionListParams.java index d591fbab0d7..960ffb370ae 100644 --- a/src/main/java/com/stripe/param/issuing/TransactionListParams.java +++ b/src/main/java/com/stripe/param/issuing/TransactionListParams.java @@ -27,10 +27,10 @@ public class TransactionListParams extends ApiRequestParams { String dispute; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -56,10 +56,10 @@ public class TransactionListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -153,10 +153,10 @@ public Builder setDispute(String dispute) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -225,10 +225,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java b/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java index c6dd68a60a4..8f28b8fc27a 100644 --- a/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java @@ -27,7 +27,8 @@ public class TransactionUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Object metadata; @@ -138,8 +139,8 @@ public Builder putAllMetadata(Map map) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(EmptyParam metadata) { this.metadata = metadata; @@ -149,8 +150,8 @@ public Builder setMetadata(EmptyParam metadata) { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset - * by posting an empty value to them. All keys can be unset by posting an empty value to - * `metadata`. + * by posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ public Builder setMetadata(Map metadata) { this.metadata = metadata; diff --git a/src/main/java/com/stripe/param/radar/EarlyFraudWarningListParams.java b/src/main/java/com/stripe/param/radar/EarlyFraudWarningListParams.java index baa8546ddca..867f4014c52 100644 --- a/src/main/java/com/stripe/param/radar/EarlyFraudWarningListParams.java +++ b/src/main/java/com/stripe/param/radar/EarlyFraudWarningListParams.java @@ -15,10 +15,10 @@ public class EarlyFraudWarningListParams extends ApiRequestParams { String charge; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -44,10 +44,10 @@ public class EarlyFraudWarningListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -102,10 +102,10 @@ public Builder setCharge(String charge) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -174,10 +174,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/radar/ValueListCreateParams.java b/src/main/java/com/stripe/param/radar/ValueListCreateParams.java index 9d23c3b3510..fe5121ee954 100644 --- a/src/main/java/com/stripe/param/radar/ValueListCreateParams.java +++ b/src/main/java/com/stripe/param/radar/ValueListCreateParams.java @@ -28,9 +28,9 @@ public class ValueListCreateParams extends ApiRequestParams { Map extraParams; /** - * Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, - * `ip_address`, `country`, `string`, or `case_sensitive_string`. Use `string` if the item type is - * unknown or mixed. + * Type of the items in the value list. One of {@code card_fingerprint}, {@code card_bin}, {@code + * email}, {@code ip_address}, {@code country}, {@code string}, or {@code case_sensitive_string}. + * Use {@code string} if the item type is unknown or mixed. */ @SerializedName("item_type") ItemType itemType; @@ -38,7 +38,8 @@ public class ValueListCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -144,9 +145,9 @@ public Builder putAllExtraParam(Map map) { } /** - * Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, - * `ip_address`, `country`, `string`, or `case_sensitive_string`. Use `string` if the item type - * is unknown or mixed. + * Type of the items in the value list. One of {@code card_fingerprint}, {@code card_bin}, + * {@code email}, {@code ip_address}, {@code country}, {@code string}, or {@code + * case_sensitive_string}. Use {@code string} if the item type is unknown or mixed. */ public Builder setItemType(ItemType itemType) { this.itemType = itemType; diff --git a/src/main/java/com/stripe/param/radar/ValueListItemListParams.java b/src/main/java/com/stripe/param/radar/ValueListItemListParams.java index 87ad8a33608..5e6bb9abbed 100644 --- a/src/main/java/com/stripe/param/radar/ValueListItemListParams.java +++ b/src/main/java/com/stripe/param/radar/ValueListItemListParams.java @@ -14,10 +14,10 @@ public class ValueListItemListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -43,17 +43,17 @@ public class ValueListItemListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; /** - * Return items belonging to the parent list whose value matches the specified value (using an "is - * like" match). + * Return items belonging to the parent list whose value matches the specified value (using an + * "is like" match). */ @SerializedName("value") String value; @@ -126,10 +126,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -198,10 +198,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; @@ -210,7 +210,7 @@ public Builder setStartingAfter(String startingAfter) { /** * Return items belonging to the parent list whose value matches the specified value (using an - * "is like" match). + * "is like" match). */ public Builder setValue(String value) { this.value = value; diff --git a/src/main/java/com/stripe/param/radar/ValueListListParams.java b/src/main/java/com/stripe/param/radar/ValueListListParams.java index e39d3ad1933..64d61e05b48 100644 --- a/src/main/java/com/stripe/param/radar/ValueListListParams.java +++ b/src/main/java/com/stripe/param/radar/ValueListListParams.java @@ -22,10 +22,10 @@ public class ValueListListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -51,10 +51,10 @@ public class ValueListListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -135,10 +135,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -207,10 +207,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java b/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java index b1d813cd6f1..b99b480211f 100644 --- a/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java +++ b/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java @@ -31,7 +31,8 @@ public class ValueListUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java b/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java index 31b650c6247..1c506231177 100644 --- a/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java +++ b/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java @@ -25,15 +25,16 @@ public class ReportRunCreateParams extends ApiRequestParams { /** * Parameters specifying how the report should be run. Different Report Types have different - * required and optional parameters, listed in the [API Access to - * Reports](https://stripe.com/docs/reporting/statements/api) documentation. + * required and optional parameters, listed in the API Access to Reports + * documentation. */ @SerializedName("parameters") Parameters parameters; /** - * The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to - * run, such as `"balance.summary.1"`. + * The ID of the report + * type to run, such as {@code "balance.summary.1"}. */ @SerializedName("report_type") String reportType; @@ -122,8 +123,9 @@ public Builder putAllExtraParam(Map map) { /** * Parameters specifying how the report should be run. Different Report Types have different - * required and optional parameters, listed in the [API Access to - * Reports](https://stripe.com/docs/reporting/statements/api) documentation. + * required and optional parameters, listed in the API Access to Reports + * documentation. */ public Builder setParameters(Parameters parameters) { this.parameters = parameters; @@ -131,8 +133,8 @@ public Builder setParameters(Parameters parameters) { } /** - * The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to - * run, such as `"balance.summary.1"`. + * The ID of the report + * type to run, such as {@code "balance.summary.1"}. */ public Builder setReportType(String reportType) { this.reportType = reportType; diff --git a/src/main/java/com/stripe/param/reporting/ReportRunListParams.java b/src/main/java/com/stripe/param/reporting/ReportRunListParams.java index c826bab88d7..0c280b871fb 100644 --- a/src/main/java/com/stripe/param/reporting/ReportRunListParams.java +++ b/src/main/java/com/stripe/param/reporting/ReportRunListParams.java @@ -14,10 +14,10 @@ public class ReportRunListParams extends ApiRequestParams { Object created; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -43,10 +43,10 @@ public class ReportRunListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -105,10 +105,10 @@ public Builder setCreated(Long created) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -177,10 +177,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/sigma/ScheduledQueryRunListParams.java b/src/main/java/com/stripe/param/sigma/ScheduledQueryRunListParams.java index 77c9e482ec2..a186e87a8da 100644 --- a/src/main/java/com/stripe/param/sigma/ScheduledQueryRunListParams.java +++ b/src/main/java/com/stripe/param/sigma/ScheduledQueryRunListParams.java @@ -11,10 +11,10 @@ @Getter public class ScheduledQueryRunListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class ScheduledQueryRunListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public ScheduledQueryRunListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/terminal/LocationCreateParams.java b/src/main/java/com/stripe/param/terminal/LocationCreateParams.java index fc0a8bd24d6..e56a334f7c2 100644 --- a/src/main/java/com/stripe/param/terminal/LocationCreateParams.java +++ b/src/main/java/com/stripe/param/terminal/LocationCreateParams.java @@ -34,7 +34,8 @@ public class LocationCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -171,8 +172,8 @@ public static class Address { String city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") String country; @@ -257,8 +258,8 @@ public Builder setCity(String city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; diff --git a/src/main/java/com/stripe/param/terminal/LocationListParams.java b/src/main/java/com/stripe/param/terminal/LocationListParams.java index 6e6a3be400b..b3b6f715d47 100644 --- a/src/main/java/com/stripe/param/terminal/LocationListParams.java +++ b/src/main/java/com/stripe/param/terminal/LocationListParams.java @@ -11,10 +11,10 @@ @Getter public class LocationListParams extends ApiRequestParams { /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -40,10 +40,10 @@ public class LocationListParams extends ApiRequestParams { Long limit; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -83,10 +83,10 @@ public LocationListParams build() { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -155,10 +155,10 @@ public Builder setLimit(Long limit) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java b/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java index 550544c2b24..2568f2d45c4 100644 --- a/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java +++ b/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java @@ -35,7 +35,8 @@ public class LocationUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; @@ -178,8 +179,8 @@ public static class Address { Object city; /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ @SerializedName("country") Object country; @@ -270,8 +271,8 @@ public Builder setCity(EmptyParam city) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(String country) { this.country = country; @@ -279,8 +280,8 @@ public Builder setCountry(String country) { } /** - * Two-letter country code ([ISO 3166-1 - * alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + * Two-letter country code (ISO + * 3166-1 alpha-2). */ public Builder setCountry(EmptyParam country) { this.country = country; diff --git a/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java b/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java index b14058ece38..3228d89ce4d 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java @@ -40,7 +40,8 @@ public class ReaderCreateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata; diff --git a/src/main/java/com/stripe/param/terminal/ReaderListParams.java b/src/main/java/com/stripe/param/terminal/ReaderListParams.java index 4ad46ee69f8..d4646ad06f6 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderListParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderListParams.java @@ -15,10 +15,10 @@ public class ReaderListParams extends ApiRequestParams { DeviceType deviceType; /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ @SerializedName("ending_before") String endingBefore; @@ -48,10 +48,10 @@ public class ReaderListParams extends ApiRequestParams { String location; /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the - * list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, - * your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of - * the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, ending with + * {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to + * fetch the next page of the list. */ @SerializedName("starting_after") String startingAfter; @@ -120,10 +120,10 @@ public Builder setDeviceType(DeviceType deviceType) { } /** - * A cursor for use in pagination. `ending_before` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, starting with - * `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the - * previous page of the list. + * A cursor for use in pagination. {@code ending_before} is an object ID that defines your place + * in the list. For instance, if you make a list request and receive 100 objects, starting with + * {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to + * fetch the previous page of the list. */ public Builder setEndingBefore(String endingBefore) { this.endingBefore = endingBefore; @@ -198,10 +198,10 @@ public Builder setLocation(String location) { } /** - * A cursor for use in pagination. `starting_after` is an object ID that defines your place in - * the list. For instance, if you make a list request and receive 100 objects, ending with - * `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the - * next page of the list. + * A cursor for use in pagination. {@code starting_after} is an object ID that defines your + * place in the list. For instance, if you make a list request and receive 100 objects, ending + * with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in + * order to fetch the next page of the list. */ public Builder setStartingAfter(String startingAfter) { this.startingAfter = startingAfter; diff --git a/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java b/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java index e86c58d0e85..64f0d8133c5 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java @@ -31,7 +31,8 @@ public class ReaderUpdateParams extends ApiRequestParams { /** * Set of key-value pairs that you can attach to an object. This can be useful for storing * additional information about the object in a structured format. Individual keys can be unset by - * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * posting an empty value to them. All keys can be unset by posting an empty value to {@code + * metadata}. */ @SerializedName("metadata") Map metadata;