1. class
  2. Cable8mm
  3. \
  4. PortonePhp
  5. \
  6. Client
  7. \
  8. PartnerClient

PartnerClient

final class PartnerClient extends AbstractClient (View source)

플랫폼 파트너 API 작업을 제공합니다.

Properties

protected RequestExecutor $executor from  AbstractClient

Methods

__construct(string $apiSecret, RequestExecutor|null $executor = null)

PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.

from  AbstractClient
array
__debugInfo()

인증 정보가 디버그 출력에 노출되지 않도록 빈 정보를 반환합니다.

from  AbstractClient
array
__serialize()

인증 정보가 직렬화되어 노출되지 않도록 직렬화를 거부합니다.

from  AbstractClient
void
__unserialize(array $data)

인증 정보가 포함된 객체의 역직렬화를 거부합니다.

from  AbstractClient
RequestExecutor
createExecutor(string $apiSecret)

No description

from  AbstractClient
object
callOperation(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

from  AbstractClient
Future
callOperationAsync(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

from  AbstractClient
object
callOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
Future
callOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
object
callOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
Future
callOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
string
callStringOperation(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
Future
callStringOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
string
callStringOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
Future
callStringOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
void
callUnitOperation(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
Future
callUnitOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
void
callUnitOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
Future
callUnitOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
void
callUnitOperationWithQuery(string $operation, string $method, string $path, array $query)

No description

from  AbstractClient
Future
callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)

No description

from  AbstractClient
ArchivePlatformPartnerResponse
archivePlatformPartner(string|null $id = null, bool|null $test = null)

파트너 보관 기능입니다.

Future
archivePlatformPartnerAsync(string|null $id = null, bool|null $test = null)

파트너 보관 기능입니다.

ConnectBulkPartnerCounterpartyResponse
connectBulkPartnerCounterparty(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 기능입니다.

Future
connectBulkPartnerCounterpartyAsync(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 기능입니다.

ConnectPartnerCounterpartyResponse
connectPartnerCounterparty(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 기능입니다.

Future
connectPartnerCounterpartyAsync(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 기능입니다.

CreatePlatformPartnerResponse
createPlatformPartner(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 생성 기능입니다.

Future
createPlatformPartnerAsync(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 생성 기능입니다.

CreatePlatformPartnersResponse
createPlatformPartners(bool|null $test = null, array|null $partners = null)

파트너 다건 생성 기능입니다.

Future
createPlatformPartnersAsync(bool|null $test = null, array|null $partners = null)

파트너 다건 생성 기능입니다.

DisconnectBulkPartnerCounterpartyResponse
disconnectBulkPartnerCounterparty(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 해제 기능입니다.

Future
disconnectBulkPartnerCounterpartyAsync(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 해제 기능입니다.

DisconnectPartnerCounterpartyResponse
disconnectPartnerCounterparty(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 해제 기능입니다.

Future
disconnectPartnerCounterpartyAsync(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 해제 기능입니다.

PlatformPartner
getPlatformPartner(string|null $id = null, bool|null $test = null)

파트너 조회 기능입니다.

Future
getPlatformPartnerAsync(string|null $id = null, bool|null $test = null)

파트너 조회 기능입니다.

GetPlatformPartnersResponse
getPlatformPartners(bool|null $test = null, array|null $page = null, array|null $filter = null)

파트너 다건 조회 기능입니다.

Future
getPlatformPartnersAsync(bool|null $test = null, array|null $page = null, array|null $filter = null)

파트너 다건 조회 기능입니다.

RecoverPlatformPartnerResponse
recoverPlatformPartner(string|null $id = null, bool|null $test = null)

파트너 복원 기능입니다.

Future
recoverPlatformPartnerAsync(string|null $id = null, bool|null $test = null)

파트너 복원 기능입니다.

UpdatePlatformPartnerResponse
updatePlatformPartner(string|null $id = null, bool|null $test = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 수정 기능입니다.

Future
updatePlatformPartnerAsync(string|null $id = null, bool|null $test = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 수정 기능입니다.

Details

in AbstractClient at line 31
__construct(string $apiSecret, RequestExecutor|null $executor = null)

PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.

Parameters

string $apiSecret

PortOne V2 API 요청 인증에 사용하는 API Secret입니다.
RequestExecutor|null $executor

부모 클라이언트와 공유하는 요청 실행기입니다.

in AbstractClient at line 39
array __debugInfo()

인증 정보가 디버그 출력에 노출되지 않도록 빈 정보를 반환합니다.

Return Value

array

in AbstractClient at line 50
array __serialize()

인증 정보가 직렬화되어 노출되지 않도록 직렬화를 거부합니다.

Return Value

array

in AbstractClient at line 58
void __unserialize(array $data)

인증 정보가 포함된 객체의 역직렬화를 거부합니다.

Parameters

array $data

Return Value

void

in AbstractClient at line 63
protected RequestExecutor createExecutor(string $apiSecret)

No description

Parameters

string $apiSecret

Return Value

RequestExecutor

in AbstractClient at line 72
protected object callOperation(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

Parameters

string $operation
string $method
string $path
array $parameters
string $responseClass
bool $requestBody

Return Value

object

in AbstractClient at line 91
protected Future callOperationAsync(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

Parameters

string $operation
string $method
string $path
array $parameters
string $responseClass
bool $requestBody

Return Value

Future

in AbstractClient at line 116
protected object callOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

object

in AbstractClient at line 136
protected Future callOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

Future

in AbstractClient at line 161
protected object callOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

object

in AbstractClient at line 181
protected Future callOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

Future

in AbstractClient at line 202
protected string callStringOperation(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

string

in AbstractClient at line 213
protected Future callStringOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

Future

in AbstractClient at line 230
protected string callStringOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

string

in AbstractClient at line 239
protected Future callStringOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

Future

in AbstractClient at line 245
protected void callUnitOperation(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

void

in AbstractClient at line 251
protected Future callUnitOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

Future

in AbstractClient at line 268
protected void callUnitOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

void

in AbstractClient at line 277
protected Future callUnitOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

Future

in AbstractClient at line 283
protected void callUnitOperationWithQuery(string $operation, string $method, string $path, array $query)

No description

Parameters

string $operation
string $method
string $path
array $query

Return Value

void

in AbstractClient at line 289
protected Future callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)

No description

Parameters

string $operation
string $method
string $path
array $query

Return Value

Future

at line 22
ArchivePlatformPartnerResponse archivePlatformPartner(string|null $id = null, bool|null $test = null)

파트너 보관 기능입니다.

주어진 아이디에 대응되는 파트너를 보관합니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

ArchivePlatformPartnerResponse

at line 35
Future archivePlatformPartnerAsync(string|null $id = null, bool|null $test = null)

파트너 보관 기능입니다.

주어진 아이디에 대응되는 파트너를 보관합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

Future

at line 47
ConnectBulkPartnerCounterpartyResponse connectBulkPartnerCounterparty(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 기능입니다.

파트너들을 일괄 거래처 연동합니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $filter

파트너 필터 입력 정보

Return Value

ConnectBulkPartnerCounterpartyResponse

at line 60
Future connectBulkPartnerCounterpartyAsync(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 기능입니다.

파트너들을 일괄 거래처 연동합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $filter

파트너 필터 입력 정보

Return Value

Future

at line 72
ConnectPartnerCounterpartyResponse connectPartnerCounterparty(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 기능입니다.

파트너를 거래처에 연동합니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

ConnectPartnerCounterpartyResponse

at line 85
Future connectPartnerCounterpartyAsync(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 기능입니다.

파트너를 거래처에 연동합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

Future

at line 105
CreatePlatformPartnerResponse createPlatformPartner(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 생성 기능입니다.

새로운 파트너를 생성합니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
string|null $id

파트너에 부여할 고유 아이디: 고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
string|null $name

파트너 법인명 혹은 이름
array|null $contact

파트너 담당자 정보
array|null $account

파트너 계좌 등록을 위한 정보: 파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.
string|null $defaultContractId

기본 계약 아이디: 이미 존재하는 계약 아이디를 등록해야 합니다.
string|null $memo

파트너에 대한 메모: 총 256자까지 입력할 수 있습니다.
array|null $tags

파트너에 부여할 태그 리스트: 최대 10개까지 입력할 수 있습니다.
array|null $type

파트너 생성을 위한 유형별 추가 정보: 사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.
array|null $userDefinedProperties

사용자 정의 속성

Return Value

CreatePlatformPartnerResponse

at line 126
Future createPlatformPartnerAsync(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 생성 기능입니다.

새로운 파트너를 생성합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
string|null $id

파트너에 부여할 고유 아이디: 고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
string|null $name

파트너 법인명 혹은 이름
array|null $contact

파트너 담당자 정보
array|null $account

파트너 계좌 등록을 위한 정보: 파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.
string|null $defaultContractId

기본 계약 아이디: 이미 존재하는 계약 아이디를 등록해야 합니다.
string|null $memo

파트너에 대한 메모: 총 256자까지 입력할 수 있습니다.
array|null $tags

파트너에 부여할 태그 리스트: 최대 10개까지 입력할 수 있습니다.
array|null $type

파트너 생성을 위한 유형별 추가 정보: 사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.
array|null $userDefinedProperties

사용자 정의 속성

Return Value

Future

at line 138
CreatePlatformPartnersResponse createPlatformPartners(bool|null $test = null, array|null $partners = null)

파트너 다건 생성 기능입니다.

새로운 파트너를 다건 생성합니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $partners

생성할 파트너 리스트 정보

Return Value

CreatePlatformPartnersResponse

at line 151
Future createPlatformPartnersAsync(bool|null $test = null, array|null $partners = null)

파트너 다건 생성 기능입니다.

새로운 파트너를 다건 생성합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $partners

생성할 파트너 리스트 정보

Return Value

Future

at line 163
DisconnectBulkPartnerCounterpartyResponse disconnectBulkPartnerCounterparty(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 해제 기능입니다.

파트너들을 일괄 거래처 연동 해제합니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $filter

파트너 필터 입력 정보

Return Value

DisconnectBulkPartnerCounterpartyResponse

at line 176
Future disconnectBulkPartnerCounterpartyAsync(bool|null $test = null, array|null $filter = null)

파트너 일괄 거래처 연동 해제 기능입니다.

파트너들을 일괄 거래처 연동 해제합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $filter

파트너 필터 입력 정보

Return Value

Future

at line 188
DisconnectPartnerCounterpartyResponse disconnectPartnerCounterparty(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 해제 기능입니다.

파트너를 거래처 연동 해제합니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

DisconnectPartnerCounterpartyResponse

at line 201
Future disconnectPartnerCounterpartyAsync(string|null $id = null, bool|null $test = null)

파트너 거래처 연동 해제 기능입니다.

파트너를 거래처 연동 해제합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

Future

at line 213
PlatformPartner getPlatformPartner(string|null $id = null, bool|null $test = null)

파트너 조회 기능입니다.

파트너 객체를 조회합니다.

Parameters

string|null $id

조회하고 싶은 파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

PlatformPartner

at line 226
Future getPlatformPartnerAsync(string|null $id = null, bool|null $test = null)

파트너 조회 기능입니다.

파트너 객체를 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

조회하고 싶은 파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

Future

at line 239
GetPlatformPartnersResponse getPlatformPartners(bool|null $test = null, array|null $page = null, array|null $filter = null)

파트너 다건 조회 기능입니다.

여러 파트너를 조회합니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보
array|null $filter

파트너 필터 입력 정보

Return Value

GetPlatformPartnersResponse

at line 253
Future getPlatformPartnersAsync(bool|null $test = null, array|null $page = null, array|null $filter = null)

파트너 다건 조회 기능입니다.

여러 파트너를 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보
array|null $filter

파트너 필터 입력 정보

Return Value

Future

at line 265
RecoverPlatformPartnerResponse recoverPlatformPartner(string|null $id = null, bool|null $test = null)

파트너 복원 기능입니다.

주어진 아이디에 대응되는 파트너를 복원합니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

RecoverPlatformPartnerResponse

at line 278
Future recoverPlatformPartnerAsync(string|null $id = null, bool|null $test = null)

파트너 복원 기능입니다.

주어진 아이디에 대응되는 파트너를 복원합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

Future

at line 298
UpdatePlatformPartnerResponse updatePlatformPartner(string|null $id = null, bool|null $test = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 수정 기능입니다.

주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.

Parameters

string|null $id

업데이트할 파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
string|null $name

파트너 법인명 혹은 이름
array|null $contact

파트너 담당자 업데이트를 위한 정보
array|null $account

파트너 계좌 업데이트를 위한 입력 정보
string|null $defaultContractId

파트너에 설정된 기본 계약 아이디
string|null $memo

파트너에 대한 메모
array|null $tags

파트너의 태그 리스트
array|null $type

파트너 업데이트를 위한 유형별 추가 정보: 파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.
array|null $userDefinedProperties

사용자 정의 속성

Return Value

UpdatePlatformPartnerResponse

at line 319
Future updatePlatformPartnerAsync(string|null $id = null, bool|null $test = null, string|null $name = null, array|null $contact = null, array|null $account = null, string|null $defaultContractId = null, string|null $memo = null, array|null $tags = null, array|null $type = null, array|null $userDefinedProperties = null)

파트너 수정 기능입니다.

주어진 아이디에 대응되는 파트너 정보를 업데이트합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

업데이트할 파트너 아이디
bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
string|null $name

파트너 법인명 혹은 이름
array|null $contact

파트너 담당자 업데이트를 위한 정보
array|null $account

파트너 계좌 업데이트를 위한 입력 정보
string|null $defaultContractId

파트너에 설정된 기본 계약 아이디
string|null $memo

파트너에 대한 메모
array|null $tags

파트너의 태그 리스트
array|null $type

파트너 업데이트를 위한 유형별 추가 정보: 파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.
array|null $userDefinedProperties

사용자 정의 속성

Return Value

Future