com.moderntreasury.api.services.blocking.CounterpartyService.kt Maven / Gradle / Ivy

Go to download
// File generated from our OpenAPI spec by Stainless.

package com.moderntreasury.api.services.blocking

import com.moderntreasury.api.core.RequestOptions
import com.moderntreasury.api.models.Counterparty
import com.moderntreasury.api.models.CounterpartyCollectAccountParams
import com.moderntreasury.api.models.CounterpartyCollectAccountResponse
import com.moderntreasury.api.models.CounterpartyCreateParams
import com.moderntreasury.api.models.CounterpartyDeleteParams
import com.moderntreasury.api.models.CounterpartyListPage
import com.moderntreasury.api.models.CounterpartyListParams
import com.moderntreasury.api.models.CounterpartyRetrieveParams
import com.moderntreasury.api.models.CounterpartyUpdateParams

interface CounterpartyService {

    /** Create a new counterparty. */
    fun create(
        params: CounterpartyCreateParams,
        requestOptions: RequestOptions = RequestOptions.none()
    ): Counterparty

    /** Get details on a single counterparty. */
    fun retrieve(
        params: CounterpartyRetrieveParams,
        requestOptions: RequestOptions = RequestOptions.none()
    ): Counterparty

    /** Updates a given counterparty with new information. */
    fun update(
        params: CounterpartyUpdateParams,
        requestOptions: RequestOptions = RequestOptions.none()
    ): Counterparty

    /** Get a paginated list of all counterparties. */
    fun list(
        params: CounterpartyListParams,
        requestOptions: RequestOptions = RequestOptions.none()
    ): CounterpartyListPage

    /** Deletes a given counterparty. */
    fun delete(
        params: CounterpartyDeleteParams,
        requestOptions: RequestOptions = RequestOptions.none()
    )

    /** Send an email requesting account details. */
    fun collectAccount(
        params: CounterpartyCollectAccountParams,
        requestOptions: RequestOptions = RequestOptions.none()
    ): CounterpartyCollectAccountResponse
}