Skip to content

Commit

Permalink
Convert Markdown to HTML in Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ob-stripe committed Feb 11, 2020
1 parent e91e6c5 commit d72e2d2
Show file tree
Hide file tree
Showing 255 changed files with 7,316 additions and 6,472 deletions.
276 changes: 152 additions & 124 deletions src/main/java/com/stripe/model/Account.java

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/main/java/com/stripe/model/AccountLink.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public class AccountLink extends ApiResource {
/**
* String representing the object's type. Objects of the same type share the same value.
*
* <p>Equal to `account_link`.
* <p>Equal to {@code account_link}.
*/
@SerializedName("object")
String object;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/stripe/model/Address.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1
* alpha-2</a>).
*/
@SerializedName("country")
String country;
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/com/stripe/model/AlipayAccount.java
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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.
*
* <p>Equal to `alipay_account`.
* <p>Equal to {@code alipay_account}.
*/
@SerializedName("object")
String object;
Expand Down Expand Up @@ -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;
}
Expand All @@ -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;
}
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/stripe/model/ApplePayDomain.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ 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;

/**
* String representing the object's type. Objects of the same type share the same value.
*
* <p>Equal to `apple_pay_domain`.
* <p>Equal to {@code apple_pay_domain}.
*/
@SerializedName("object")
String object;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/stripe/model/Application.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>Equal to `application`.
* <p>Equal to {@code application}.
*/
@SerializedName("object")
String object;
Expand Down
32 changes: 16 additions & 16 deletions src/main/java/com/stripe/model/ApplicationFee.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>,
* in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
*/
@SerializedName("currency")
String currency;
Expand All @@ -71,23 +71,23 @@ 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;

/**
* String representing the object's type. Objects of the same type share the same value.
*
* <p>Equal to `application_fee`.
* <p>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)
Expand All @@ -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;
}
Expand All @@ -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;
}
Expand All @@ -123,7 +123,7 @@ public void setAccountObject(Account expandableObject) {
this.account = new ExpandableField<Account>(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;
}
Expand All @@ -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;
}
Expand All @@ -141,7 +141,7 @@ public void setApplicationObject(Application expandableObject) {
this.application = new ExpandableField<Application>(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;
}
Expand All @@ -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;
}
Expand All @@ -160,7 +160,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) {
new ExpandableField<BalanceTransaction>(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;
}
Expand All @@ -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;
}
Expand All @@ -178,7 +178,7 @@ public void setChargeObject(Charge expandableObject) {
this.charge = new ExpandableField<Charge>(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;
}
Expand All @@ -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;
}
Expand Down
38 changes: 20 additions & 18 deletions src/main/java/com/stripe/model/Balance.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,47 +18,48 @@
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 <a href="https://stripe.com/docs/api#transfers">Transfers API</a> or <a
* href="https://stripe.com/docs/api#payouts">Payouts API</a>. The available balance for each
* currency and payment type can be found in the {@code source_types} property.
*/
@SerializedName("available")
List<Balance.Money> 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<Balance.Money> 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;

/**
* String representing the object's type. Objects of the same type share the same value.
*
* <p>Equal to `balance`.
* <p>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<Balance.Money> pending;

/**
* Retrieves the current account balance, based on the authentication that was used to make the
* request. For a sample request, see <a
* href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative
* balances</a>.
* href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting
* for negative balances</a>.
*/
public static Balance retrieve() throws StripeException {
return retrieve((Map<String, Object>) null, (RequestOptions) null);
Expand All @@ -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 <a
* href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative
* balances</a>.
* href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting
* for negative balances</a>.
*/
public static Balance retrieve(RequestOptions options) throws StripeException {
return retrieve((Map<String, Object>) null, options);
Expand All @@ -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 <a
* href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative
* balances</a>.
* href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting
* for negative balances</a>.
*/
public static Balance retrieve(Map<String, Object> params, RequestOptions options)
throws StripeException {
Expand All @@ -89,8 +90,8 @@ public static Balance retrieve(Map<String, Object> params, RequestOptions option
/**
* Retrieves the current account balance, based on the authentication that was used to make the
* request. For a sample request, see <a
* href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative
* balances</a>.
* href="https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances">Accounting
* for negative balances</a>.
*/
public static Balance retrieve(BalanceRetrieveParams params, RequestOptions options)
throws StripeException {
Expand All @@ -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 <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency
* code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported
* currency</a>.
*/
@SerializedName("currency")
String currency;
Expand Down
Loading

0 comments on commit d72e2d2

Please sign in to comment.