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

CounterpartyClient

final class CounterpartyClient extends AbstractClient (View source)

B2B 거래처 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
CreateB2bCounterpartyResponse
createB2bCounterparty(bool|null $test = null, string|null $counterpartyId = null, array|null $counterparty = null, array|null $options = null)

거래처 생성 기능입니다.

Future
createB2bCounterpartyAsync(bool|null $test = null, string|null $counterpartyId = null, array|null $counterparty = null, array|null $options = null)

거래처 생성 기능입니다.

DeleteB2bCounterpartyResponse
deleteB2bCounterparty(string|null $counterpartyId = null, bool|null $test = null)

거래처 삭제 기능입니다.

Future
deleteB2bCounterpartyAsync(string|null $counterpartyId = null, bool|null $test = null)

거래처 삭제 기능입니다.

GetB2bCounterpartiesResponse
getB2bCounterparties(bool|null $test = null, array|null $page = null, array|null $filter = null)

거래처 검색 기능입니다.

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

거래처 검색 기능입니다.

B2bCounterparty
getB2bCounterparty(string|null $counterpartyId = null, bool|null $test = null)

거래처 조회 기능입니다.

Future
getB2bCounterpartyAsync(string|null $counterpartyId = null, bool|null $test = null)

거래처 조회 기능입니다.

B2bCertificate
getB2bCounterpartyCertificate(string|null $brn = null, bool|null $test = null)

인증서 조회 기능입니다.

Future
getB2bCounterpartyCertificateAsync(string|null $brn = null, bool|null $test = null)

인증서 조회 기능입니다.

GetB2bCounterpartyCertificateRegistrationUrlResponse
getB2bCounterpartyCertificateRegistrationUrl(string|null $brn = null, bool|null $test = null)

사업자 인증서 등록 URL 조회 기능입니다.

Future
getB2bCounterpartyCertificateRegistrationUrlAsync(string|null $brn = null, bool|null $test = null)

사업자 인증서 등록 URL 조회 기능입니다.

UpdateB2bCounterpartyResponse
updateB2bCounterparty(string|null $counterpartyId = null, bool|null $test = null, array|null $counterparty = null, array|null $options = null)

거래처 정보 수정 기능입니다.

Future
updateB2bCounterpartyAsync(string|null $counterpartyId = null, bool|null $test = null, array|null $counterparty = null, array|null $options = null)

거래처 정보 수정 기능입니다.

ValidateB2bCounterpartyCertificateResponse
validateB2bCounterpartyCertificate(string|null $brn = null, bool|null $test = null)

사업자 인증서 유효성 검증 기능입니다.

Future
validateB2bCounterpartyCertificateAsync(string|null $brn = null, bool|null $test = 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 24
CreateB2bCounterpartyResponse createB2bCounterparty(bool|null $test = null, string|null $counterpartyId = null, array|null $counterparty = null, array|null $options = null)

거래처 생성 기능입니다.

거래처를 생성합니다.

Parameters

bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
string|null $counterpartyId

거래처 아이디: 입력하지 않으면 임의의 ID가 채번됩니다.
array|null $counterparty

거래처 입력 정보
array|null $options

거래처 생성 옵션

Return Value

CreateB2bCounterpartyResponse

at line 39
Future createB2bCounterpartyAsync(bool|null $test = null, string|null $counterpartyId = null, array|null $counterparty = null, array|null $options = null)

거래처 생성 기능입니다.

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

Parameters

bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
string|null $counterpartyId

거래처 아이디: 입력하지 않으면 임의의 ID가 채번됩니다.
array|null $counterparty

거래처 입력 정보
array|null $options

거래처 생성 옵션

Return Value

Future

at line 51
DeleteB2bCounterpartyResponse deleteB2bCounterparty(string|null $counterpartyId = null, bool|null $test = null)

거래처 삭제 기능입니다.

거래처를 삭제합니다.

Parameters

string|null $counterpartyId

거래처 ID
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

DeleteB2bCounterpartyResponse

at line 64
Future deleteB2bCounterpartyAsync(string|null $counterpartyId = null, bool|null $test = null)

거래처 삭제 기능입니다.

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

Parameters

string|null $counterpartyId

거래처 ID
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

Future

at line 77
GetB2bCounterpartiesResponse getB2bCounterparties(bool|null $test = null, array|null $page = null, array|null $filter = null)

거래처 검색 기능입니다.

거래처를 검색합니다.

Parameters

bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
array|null $page

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

거래처 검색 필터

Return Value

GetB2bCounterpartiesResponse

at line 91
Future getB2bCounterpartiesAsync(bool|null $test = null, array|null $page = null, array|null $filter = null)

거래처 검색 기능입니다.

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

Parameters

bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
array|null $page

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

거래처 검색 필터

Return Value

Future

at line 103
B2bCounterparty getB2bCounterparty(string|null $counterpartyId = null, bool|null $test = null)

거래처 조회 기능입니다.

거래처를 조회합니다.

Parameters

string|null $counterpartyId

거래처 ID
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

B2bCounterparty

at line 116
Future getB2bCounterpartyAsync(string|null $counterpartyId = null, bool|null $test = null)

거래처 조회 기능입니다.

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

Parameters

string|null $counterpartyId

거래처 ID
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

Future

at line 128
B2bCertificate getB2bCounterpartyCertificate(string|null $brn = null, bool|null $test = null)

인증서 조회 기능입니다.

연동 사업자의 인증서를 조회합니다.

Parameters

string|null $brn 사업자등록번호
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

B2bCertificate

at line 141
Future getB2bCounterpartyCertificateAsync(string|null $brn = null, bool|null $test = null)

인증서 조회 기능입니다.

연동 사업자의 인증서를 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $brn 사업자등록번호
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

Future

at line 153
GetB2bCounterpartyCertificateRegistrationUrlResponse getB2bCounterpartyCertificateRegistrationUrl(string|null $brn = null, bool|null $test = null)

사업자 인증서 등록 URL 조회 기능입니다.

연동 사업자의 인증서를 등록하기 위한 URL을 조회합니다.

Parameters

string|null $brn 사업자등록번호
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

GetB2bCounterpartyCertificateRegistrationUrlResponse

at line 166
Future getB2bCounterpartyCertificateRegistrationUrlAsync(string|null $brn = null, bool|null $test = null)

사업자 인증서 등록 URL 조회 기능입니다.

연동 사업자의 인증서를 등록하기 위한 URL을 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $brn 사업자등록번호
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

Future

at line 180
UpdateB2bCounterpartyResponse updateB2bCounterparty(string|null $counterpartyId = null, bool|null $test = null, array|null $counterparty = null, array|null $options = null)

거래처 정보 수정 기능입니다.

거래처 정보를 수정합니다.

Parameters

string|null $counterpartyId

거래처 ID
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
array|null $counterparty

거래처 입력 정보
array|null $options

거래처 생성 옵션: 사업자 정보 및 휴폐업 상태 조회 옵션입니다.

Return Value

UpdateB2bCounterpartyResponse

at line 195
Future updateB2bCounterpartyAsync(string|null $counterpartyId = null, bool|null $test = null, array|null $counterparty = null, array|null $options = null)

거래처 정보 수정 기능입니다.

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

Parameters

string|null $counterpartyId

거래처 ID
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
array|null $counterparty

거래처 입력 정보
array|null $options

거래처 생성 옵션: 사업자 정보 및 휴폐업 상태 조회 옵션입니다.

Return Value

Future

at line 207
ValidateB2bCounterpartyCertificateResponse validateB2bCounterpartyCertificate(string|null $brn = null, bool|null $test = null)

사업자 인증서 유효성 검증 기능입니다.

연동 사업자가 등록한 인증서의 유효성을 검증합니다.

Parameters

string|null $brn 사업자등록번호
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

ValidateB2bCounterpartyCertificateResponse

at line 220
Future validateB2bCounterpartyCertificateAsync(string|null $brn = null, bool|null $test = null)

사업자 인증서 유효성 검증 기능입니다.

연동 사업자가 등록한 인증서의 유효성을 검증합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $brn 사업자등록번호
bool|null $test

테스트 모드 여부: true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Return Value

Future