Skip to content

Commit

Permalink
docs: add params class javadocs (#300)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] authored and stainless-bot committed Jan 7, 2025
1 parent 7754377 commit 29e9fe1
Show file tree
Hide file tree
Showing 159 changed files with 159 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** create account_collection_flow */
class AccountCollectionFlowCreateParams
constructor(
private val body: AccountCollectionFlowCreateBody,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects
import java.util.Optional

/** list account_collection_flows */
class AccountCollectionFlowListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** get account_collection_flow */
class AccountCollectionFlowRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import com.moderntreasury.api.core.toImmutable
import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects

/** update account_collection_flow */
class AccountCollectionFlowUpdateParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** Create an account detail for an external account. */
class AccountDetailCreateParams
constructor(
private val accountsType: AccountsType,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** Delete a single account detail for an external account. */
class AccountDetailDeleteParams
constructor(
private val accountsType: AccountsType,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects
import java.util.Optional

/** Get a list of account details for a single internal or external account. */
class AccountDetailListParams
constructor(
private val accountsType: AccountsType,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** Get a single account detail for a single internal or external account. */
class AccountDetailRetrieveParams
constructor(
private val accountsType: AccountsType,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import java.time.LocalDate
import java.util.Objects
import java.util.Optional

/** create balance reports */
class BalanceReportCreateParams
constructor(
private val internalAccountId: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import com.moderntreasury.api.core.toImmutable
import java.util.Objects
import java.util.Optional

/** Deletes a given balance report. */
class BalanceReportDeleteParams
constructor(
private val internalAccountId: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import java.time.LocalDate
import java.util.Objects
import java.util.Optional

/** Get all balance reports for a given internal account. */
class BalanceReportListParams
constructor(
private val internalAccountId: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** Get a single balance report for a given internal account. */
class BalanceReportRetrieveParams
constructor(
private val internalAccountId: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional

/** create bulk_request */
class BulkRequestCreateParams
constructor(
private val body: BulkRequestCreateBody,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** list bulk_requests */
class BulkRequestListParams
constructor(
private val actionType: ActionType?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** get bulk_request */
class BulkRequestRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** list bulk_results */
class BulkResultListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** get bulk_result */
class BulkResultRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** A test endpoint often used to confirm credentials and headers are being passed in correctly. */
class ClientPingParams
constructor(
private val additionalHeaders: Headers,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import java.time.LocalDate
import java.util.Objects
import java.util.Optional

/** Create a connection legal entity. */
class ConnectionLegalEntityCreateParams
constructor(
private val body: ConnectionLegalEntityCreateBody,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** Get a list of all connection legal entities. */
class ConnectionLegalEntityListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** Get details on a single connection legal entity. */
class ConnectionLegalEntityRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** Update a connection legal entity. */
class ConnectionLegalEntityUpdateParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects
import java.util.Optional

/** Get a list of all connections. */
class ConnectionListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** Send an email requesting account details. */
class CounterpartyCollectAccountParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import java.time.LocalDate
import java.util.Objects
import java.util.Optional

/** Create a new counterparty. */
class CounterpartyCreateParams
constructor(
private val body: CounterpartyCreateBody,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import com.moderntreasury.api.core.toImmutable
import java.util.Objects
import java.util.Optional

/** Deletes a given counterparty. */
class CounterpartyDeleteParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import java.time.format.DateTimeFormatter
import java.util.Objects
import java.util.Optional

/** Get a paginated list of all counterparties. */
class CounterpartyListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** Get details on a single counterparty. */
class CounterpartyRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import com.moderntreasury.api.core.toImmutable
import java.util.Objects
import java.util.Optional

/** Updates a given counterparty with new information. */
class CounterpartyUpdateParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import java.util.Objects
import java.util.Optional
import org.apache.hc.core5.http.ContentType

/** Create a document. */
class DocumentCreateParams
constructor(
private val documentableId: MultipartFormValue<String>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** Get a list of documents. */
class DocumentListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** Get an existing document. */
class DocumentRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import java.time.format.DateTimeFormatter
import java.util.Objects
import java.util.Optional

/** list events */
class EventListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** get event */
class EventRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional

/** create expected payment */
class ExpectedPaymentCreateParams
constructor(
private val body: ExpectedPaymentCreateBody,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import com.moderntreasury.api.core.toImmutable
import java.util.Objects
import java.util.Optional

/** delete expected payment */
class ExpectedPaymentDeleteParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import java.time.format.DateTimeFormatter
import java.util.Objects
import java.util.Optional

/** list expected_payments */
class ExpectedPaymentListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** get expected payment */
class ExpectedPaymentRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import java.time.LocalDate
import java.util.Objects
import java.util.Optional

/** update expected payment */
class ExpectedPaymentUpdateParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import com.moderntreasury.api.core.toImmutable
import java.util.Objects
import java.util.Optional

/** complete verification of external account */
class ExternalAccountCompleteVerificationParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** create external account */
class ExternalAccountCreateParams
constructor(
private val body: ExternalAccountCreateBody,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import com.moderntreasury.api.core.toImmutable
import java.util.Objects
import java.util.Optional

/** delete external account */
class ExternalAccountDeleteParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects
import java.util.Optional

/** list external accounts */
class ExternalAccountListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** show external account */
class ExternalAccountRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** update external account */
class ExternalAccountUpdateParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.moderntreasury.api.errors.ModernTreasuryInvalidDataException
import java.util.Objects
import java.util.Optional

/** verify external account */
class ExternalAccountVerifyParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional

/** create foreign_exchange_quote */
class ForeignExchangeQuoteCreateParams
constructor(
private val body: ForeignExchangeQuoteCreateBody,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import java.time.format.DateTimeFormatter
import java.util.Objects
import java.util.Optional

/** list foreign_exchange_quotes */
class ForeignExchangeQuoteListParams
constructor(
private val afterCursor: String?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.moderntreasury.api.core.http.Headers
import com.moderntreasury.api.core.http.QueryParams
import java.util.Objects

/** get foreign_exchange_quote */
class ForeignExchangeQuoteRetrieveParams
constructor(
private val id: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import java.time.LocalDate
import java.util.Objects
import java.util.Optional

/** Simulate Incoming Payment Detail */
class IncomingPaymentDetailCreateAsyncParams
constructor(
private val body: IncomingPaymentDetailCreateAsyncBody,
Expand Down
Loading

0 comments on commit 29e9fe1

Please sign in to comment.