@portone/server-sdk
    Preparing search index...

    Type Alias PartnerClient

    포트원 API 클라이언트를 생성합니다.

    type PartnerClient = {
        createPlatformPartners: (
            options: { test?: boolean; partners: CreatePlatformPartnerBody[] },
        ) => Promise<CreatePlatformPartnersResponse>;
        connectPartnerCounterparty: (
            options: { id: string; test?: boolean },
        ) => Promise<ConnectPartnerCounterpartyResponse>;
        connectBulkPartnerCounterparty: (
            options?: { test?: boolean; filter?: PlatformPartnerFilterInput },
        ) => Promise<ConnectBulkPartnerCounterpartyResponse>;
        disconnectPartnerCounterparty: (
            options: { id: string; test?: boolean },
        ) => Promise<DisconnectPartnerCounterpartyResponse>;
        disconnectBulkPartnerCounterparty: (
            options?: { test?: boolean; filter?: PlatformPartnerFilterInput },
        ) => Promise<DisconnectBulkPartnerCounterpartyResponse>;
        archivePlatformPartner: (
            options: { id: string; test?: boolean },
        ) => Promise<ArchivePlatformPartnerResponse>;
        recoverPlatformPartner: (
            options: { id: string; test?: boolean },
        ) => Promise<RecoverPlatformPartnerResponse>;
        getPlatformPartner: (
            options: { id: string; test?: boolean },
        ) => Promise<PlatformPartner>;
        updatePlatformPartner: (
            options: {
                id: string;
                test?: boolean;
                name?: string;
                contact?: UpdatePlatformPartnerBodyContact;
                account?: UpdatePlatformPartnerBodyAccount;
                defaultContractId?: string;
                memo?: string;
                tags?: string[];
                type?: UpdatePlatformPartnerBodyType;
                userDefinedProperties?: PlatformProperties;
            },
        ) => Promise<UpdatePlatformPartnerResponse>;
        getPlatformPartners: (
            options?: {
                test?: boolean;
                page?: PageInput;
                filter?: PlatformPartnerFilterInput;
            },
        ) => Promise<GetPlatformPartnersResponse>;
        createPlatformPartner: (
            options: {
                test?: boolean;
                id?: string;
                name: string;
                contact: CreatePlatformPartnerBodyContact;
                account: CreatePlatformPartnerBodyAccount;
                defaultContractId: string;
                memo?: string;
                tags: string[];
                type: CreatePlatformPartnerBodyType;
                userDefinedProperties?: PlatformProperties;
            },
        ) => Promise<CreatePlatformPartnerResponse>;
    }
    Index

    Properties

    createPlatformPartners connectPartnerCounterparty connectBulkPartnerCounterparty disconnectPartnerCounterparty disconnectBulkPartnerCounterparty archivePlatformPartner recoverPlatformPartner getPlatformPartner updatePlatformPartner getPlatformPartners createPlatformPartner

    Properties

    createPlatformPartners: (
        options: { test?: boolean; partners: CreatePlatformPartnerBody[] },
    ) => Promise<CreatePlatformPartnersResponse>

    파트너 다건 생성

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

    CreatePlatformPartnersError

    connectPartnerCounterparty: (
        options: { id: string; test?: boolean },
    ) => Promise<ConnectPartnerCounterpartyResponse>

    파트너 거래처 연동

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

    ConnectPartnerCounterpartyError

    connectBulkPartnerCounterparty: (
        options?: { test?: boolean; filter?: PlatformPartnerFilterInput },
    ) => Promise<ConnectBulkPartnerCounterpartyResponse>

    파트너 일괄 거래처 연동

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

    ConnectBulkPartnerCounterpartyError

    disconnectPartnerCounterparty: (
        options: { id: string; test?: boolean },
    ) => Promise<DisconnectPartnerCounterpartyResponse>

    파트너 거래처 연동 해제

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

    DisconnectPartnerCounterpartyError

    disconnectBulkPartnerCounterparty: (
        options?: { test?: boolean; filter?: PlatformPartnerFilterInput },
    ) => Promise<DisconnectBulkPartnerCounterpartyResponse>

    파트너 일괄 거래처 연동 해제

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

    DisconnectBulkPartnerCounterpartyError

    archivePlatformPartner: (
        options: { id: string; test?: boolean },
    ) => Promise<ArchivePlatformPartnerResponse>

    파트너 보관

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

    ArchivePlatformPartnerError

    recoverPlatformPartner: (
        options: { id: string; test?: boolean },
    ) => Promise<RecoverPlatformPartnerResponse>

    파트너 복원

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

    RecoverPlatformPartnerError

    getPlatformPartner: (
        options: { id: string; test?: boolean },
    ) => Promise<PlatformPartner>

    파트너 조회

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

    GetPlatformPartnerError

    updatePlatformPartner: (
        options: {
            id: string;
            test?: boolean;
            name?: string;
            contact?: UpdatePlatformPartnerBodyContact;
            account?: UpdatePlatformPartnerBodyAccount;
            defaultContractId?: string;
            memo?: string;
            tags?: string[];
            type?: UpdatePlatformPartnerBodyType;
            userDefinedProperties?: PlatformProperties;
        },
    ) => Promise<UpdatePlatformPartnerResponse>

    파트너 수정

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

    UpdatePlatformPartnerError

    getPlatformPartners: (
        options?: {
            test?: boolean;
            page?: PageInput;
            filter?: PlatformPartnerFilterInput;
        },
    ) => Promise<GetPlatformPartnersResponse>

    파트너 다건 조회

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

    GetPlatformPartnersError

    createPlatformPartner: (
        options: {
            test?: boolean;
            id?: string;
            name: string;
            contact: CreatePlatformPartnerBodyContact;
            account: CreatePlatformPartnerBodyAccount;
            defaultContractId: string;
            memo?: string;
            tags: string[];
            type: CreatePlatformPartnerBodyType;
            userDefinedProperties?: PlatformProperties;
        },
    ) => Promise<CreatePlatformPartnerResponse>

    파트너 생성

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

    CreatePlatformPartnerError

    Settings

    Member Visibility

    On This Page

    Properties