portone_server_sdk.PartnerClient

portone_server_sdk.PartnerClient#

class portone_server_sdk.PartnerClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#

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

Methods

__init__(*, secret[, base_url, store_id])

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

archive_platform_partner(*, id)

파트너 복원

archive_platform_partner_async(*, id)

파트너 복원

create_platform_partner(*[, id, memo, ...])

파트너 생성

create_platform_partner_async(*[, id, memo, ...])

파트너 생성

create_platform_partners(*, partners)

파트너 다건 생성

create_platform_partners_async(*, partners)

파트너 다건 생성

get_platform_partner(*, id)

파트너 조회

get_platform_partner_async(*, id)

파트너 조회

get_platform_partners(*[, page, filter])

파트너 다건 조회

get_platform_partners_async(*[, page, filter])

파트너 다건 조회

recover_platform_partner(*, id)

파트너 복원

recover_platform_partner_async(*, id)

파트너 복원

update_platform_partner(*, id[, name, ...])

파트너 수정

update_platform_partner_async(*, id[, name, ...])

파트너 수정
get_platform_partners(*, page: PageInput | None = None, filter: PlatformPartnerFilterInput | None = None) → GetPlatformPartnersResponse#

파트너 다건 조회

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

Parameters:

  • page (PageInput, optional) – 요청할 페이지 정보

  • filter (PlatformPartnerFilterInput, optional) – 조회할 파트너 조건 필터

Raises:

GetPlatformPartnersError –

async get_platform_partners_async(*, page: PageInput | None = None, filter: PlatformPartnerFilterInput | None = None) → GetPlatformPartnersResponse#

파트너 다건 조회

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

Parameters:

  • page (PageInput, optional) – 요청할 페이지 정보

  • filter (PlatformPartnerFilterInput, optional) – 조회할 파트너 조건 필터

Raises:

GetPlatformPartnersError –

create_platform_partner(*, id: str | None = None, name: str, contact: CreatePlatformPartnerBodyContact, account: CreatePlatformPartnerBodyAccount, default_contract_id: str, memo: str | None = None, tags: list[str], type: CreatePlatformPartnerBodyType, user_defined_properties: PlatformProperties | None = None) → CreatePlatformPartnerResponse#

파트너 생성

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

Parameters:

  • id (str, optional) –

    파트너에 부여할 고유 아이디

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

  • name (str) – 파트너 법인명 혹은 이름

  • contact (CreatePlatformPartnerBodyContact) – 파트너 담당자 연락 정보

  • account (CreatePlatformPartnerBodyAccount) –

    정산 계좌

    파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.

  • default_contract_id (str) –

    기본 계약 아이디

    이미 존재하는 계약 아이디를 등록해야 합니다.

  • memo (str, optional) –

    파트너에 대한 메모

    총 256자까지 입력할 수 있습니다.

  • tags (list[str]) –

    파트너에 부여할 태그 리스트

    최대 10개까지 입력할 수 있습니다.

  • type (CreatePlatformPartnerBodyType) –

    파트너 유형별 추가 정보

    사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.

  • user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

CreatePlatformPartnerError –

async create_platform_partner_async(*, id: str | None = None, name: str, contact: CreatePlatformPartnerBodyContact, account: CreatePlatformPartnerBodyAccount, default_contract_id: str, memo: str | None = None, tags: list[str], type: CreatePlatformPartnerBodyType, user_defined_properties: PlatformProperties | None = None) → CreatePlatformPartnerResponse#

파트너 생성

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

Parameters:

  • id (str, optional) –

    파트너에 부여할 고유 아이디

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

  • name (str) – 파트너 법인명 혹은 이름

  • contact (CreatePlatformPartnerBodyContact) – 파트너 담당자 연락 정보

  • account (CreatePlatformPartnerBodyAccount) –

    정산 계좌

    파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.

  • default_contract_id (str) –

    기본 계약 아이디

    이미 존재하는 계약 아이디를 등록해야 합니다.

  • memo (str, optional) –

    파트너에 대한 메모

    총 256자까지 입력할 수 있습니다.

  • tags (list[str]) –

    파트너에 부여할 태그 리스트

    최대 10개까지 입력할 수 있습니다.

  • type (CreatePlatformPartnerBodyType) –

    파트너 유형별 추가 정보

    사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.

  • user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

CreatePlatformPartnerError –

get_platform_partner(*, id: str) → PlatformPartner#

파트너 조회

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

Parameters:

id (str) – 조회하고 싶은 파트너 아이디

Raises:

GetPlatformPartnerError –

async get_platform_partner_async(*, id: str) → PlatformPartner#

파트너 조회

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

Parameters:

id (str) – 조회하고 싶은 파트너 아이디

Raises:

GetPlatformPartnerError –

update_platform_partner(*, id: str, name: str | None = None, contact: UpdatePlatformPartnerBodyContact | None = None, account: UpdatePlatformPartnerBodyAccount | None = None, default_contract_id: str | None = None, memo: str | None = None, tags: list[str] | None = None, type: UpdatePlatformPartnerBodyType | None = None, user_defined_properties: PlatformProperties | None = None) → UpdatePlatformPartnerResponse#

파트너 수정

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

Parameters:

  • id (str) – 업데이트할 파트너 아이디

  • name (str, optional) – 파트너 법인명 혹은 이름

  • contact (UpdatePlatformPartnerBodyContact, optional) – 파트너 담당자 연락 정보

  • account (UpdatePlatformPartnerBodyAccount, optional) – 정산 계좌

  • default_contract_id (str, optional) – 파트너에 설정된 기본 계약 아이디

  • memo (str, optional) – 파트너에 대한 메모

  • tags (list[str], optional) – 파트너의 태그 리스트

  • type (UpdatePlatformPartnerBodyType, optional) – 파트너 유형별 정보

  • user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

UpdatePlatformPartnerError –

async update_platform_partner_async(*, id: str, name: str | None = None, contact: UpdatePlatformPartnerBodyContact | None = None, account: UpdatePlatformPartnerBodyAccount | None = None, default_contract_id: str | None = None, memo: str | None = None, tags: list[str] | None = None, type: UpdatePlatformPartnerBodyType | None = None, user_defined_properties: PlatformProperties | None = None) → UpdatePlatformPartnerResponse#

파트너 수정

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

Parameters:

  • id (str) – 업데이트할 파트너 아이디

  • name (str, optional) – 파트너 법인명 혹은 이름

  • contact (UpdatePlatformPartnerBodyContact, optional) – 파트너 담당자 연락 정보

  • account (UpdatePlatformPartnerBodyAccount, optional) – 정산 계좌

  • default_contract_id (str, optional) – 파트너에 설정된 기본 계약 아이디

  • memo (str, optional) – 파트너에 대한 메모

  • tags (list[str], optional) – 파트너의 태그 리스트

  • type (UpdatePlatformPartnerBodyType, optional) – 파트너 유형별 정보

  • user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

UpdatePlatformPartnerError –

create_platform_partners(*, partners: list[CreatePlatformPartnerBody]) → CreatePlatformPartnersResponse#

파트너 다건 생성

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

Parameters:

partners (list[CreatePlatformPartnerBody]) – 생성할 파트너 리스트 정보

Raises:

CreatePlatformPartnersError –

async create_platform_partners_async(*, partners: list[CreatePlatformPartnerBody]) → CreatePlatformPartnersResponse#

파트너 다건 생성

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

Parameters:

partners (list[CreatePlatformPartnerBody]) – 생성할 파트너 리스트 정보

Raises:

CreatePlatformPartnersError –

archive_platform_partner(*, id: str) → ArchivePlatformPartnerResponse#

파트너 복원

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

Parameters:

id (str) – 파트너 아이디

Raises:

ArchivePlatformPartnerError –

async archive_platform_partner_async(*, id: str) → ArchivePlatformPartnerResponse#

파트너 복원

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

Parameters:

id (str) – 파트너 아이디

Raises:

ArchivePlatformPartnerError –

recover_platform_partner(*, id: str) → RecoverPlatformPartnerResponse#

파트너 복원

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

Parameters:

id (str) – 파트너 아이디

Raises:

RecoverPlatformPartnerError –

async recover_platform_partner_async(*, id: str) → RecoverPlatformPartnerResponse#

파트너 복원

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

Parameters:

id (str) – 파트너 아이디

Raises:

RecoverPlatformPartnerError –