PortOne Server SDK for JVM/io.portone.sdk.server.platform.partner/PartnerClient

PartnerClient

class PartnerClient(apiSecret: String, apiBase: String = "https://api.portone.io", storeId: String? = null) : Closeable

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Parameters

apiSecret

포트원 API Secret입니다.

apiBase

포트원 REST API 주소입니다. 기본값은 "https://api.portone.io"입니다.

storeId

하위 상점에 대해 기능을 사용할 때 필요한 하위 상점의 ID입니다.

Constructors

Link copied to clipboard
constructor(apiSecret: String, apiBase: String = "https://api.portone.io", storeId: String? = null)

Functions

Link copied to clipboard
@JvmName(name = "archivePlatformPartnerSuspend")
suspend fun archivePlatformPartner(id: String): ArchivePlatformPartnerResponse

파트너 복원

Link copied to clipboard
open override fun close()
Link copied to clipboard
@JvmName(name = "connectBulkPartnerMemberCompanySuspend")
suspend fun connectBulkPartnerMemberCompany(filter: PlatformPartnerFilterInput? = null): ConnectBulkPartnerMemberCompanyResponse

파트너 연동 사업자 일괄 연동

Link copied to clipboard
@JvmName(name = "connectPartnerMemberCompanySuspend")
suspend fun connectPartnerMemberCompany(id: String): ConnectPartnerMemberCompanyResponse

파트너 연동 사업자 연동

Link copied to clipboard
@JvmName(name = "createPlatformPartnerSuspend")
suspend fun createPlatformPartner(id: String? = null, name: String, contact: CreatePlatformPartnerBodyContact, account: CreatePlatformPartnerBodyAccount, defaultContractId: String, memo: String? = null, tags: List<String>, type: CreatePlatformPartnerBodyType, userDefinedProperties: PlatformProperties? = null): CreatePlatformPartnerResponse

파트너 생성

Link copied to clipboard
@JvmName(name = "createPlatformPartnersSuspend")
suspend fun createPlatformPartners(partners: List<CreatePlatformPartnerBody>): CreatePlatformPartnersResponse

파트너 다건 생성

Link copied to clipboard
@JvmName(name = "disconnectBulkPartnerMemberCompanySuspend")
suspend fun disconnectBulkPartnerMemberCompany(filter: PlatformPartnerFilterInput? = null): DisconnectBulkPartnerMemberCompanyResponse

파트너 연동 사업자 연동 해제

Link copied to clipboard
@JvmName(name = "disconnectPartnerMemberCompanySuspend")
suspend fun disconnectPartnerMemberCompany(id: String): DisconnectPartnerMemberCompanyResponse

연동 사업자 연동 해제

Link copied to clipboard
@JvmName(name = "getPlatformPartnerSuspend")
suspend fun getPlatformPartner(id: String): PlatformPartner

파트너 조회

Link copied to clipboard
@JvmName(name = "getPlatformPartnersSuspend")
suspend fun getPlatformPartners(page: PageInput? = null, filter: PlatformPartnerFilterInput? = null): GetPlatformPartnersResponse

파트너 다건 조회

Link copied to clipboard
@JvmName(name = "recoverPlatformPartnerSuspend")
suspend fun recoverPlatformPartner(id: String): RecoverPlatformPartnerResponse

파트너 복원

Link copied to clipboard
@JvmName(name = "updatePlatformPartnerSuspend")
suspend fun updatePlatformPartner(id: String, name: String? = null, contact: UpdatePlatformPartnerBodyContact? = null, account: UpdatePlatformPartnerBodyAccount? = null, defaultContractId: String? = null, memo: String? = null, tags: List<String>? = null, type: UpdatePlatformPartnerBodyType? = null, userDefinedProperties: PlatformProperties? = null): UpdatePlatformPartnerResponse

파트너 수정