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

    Type Alias PolicyClient

    type PolicyClient = {
        getPlatformDiscountSharePolicies: (
            options?: {
                page?: PageInput;
                filter?: PlatformDiscountSharePolicyFilterInput;
            },
        ) => Promise<GetPlatformDiscountSharePoliciesResponse>;
        createPlatformDiscountSharePolicy: (
            options: {
                id?: string;
                name: string;
                partnerShareRate: number;
                memo?: string;
            },
        ) => Promise<CreatePlatformDiscountSharePolicyResponse>;
        getPlatformDiscountSharePolicy: (
            options: { id: string },
        ) => Promise<PlatformDiscountSharePolicy>;
        updatePlatformDiscountSharePolicy: (
            options: {
                id: string;
                name?: string;
                partnerShareRate?: number;
                memo?: string;
            },
        ) => Promise<UpdatePlatformDiscountSharePolicyResponse>;
        archivePlatformDiscountSharePolicy: (
            options: { id: string },
        ) => Promise<ArchivePlatformDiscountSharePolicyResponse>;
        recoverPlatformDiscountSharePolicy: (
            options: { id: string },
        ) => Promise<RecoverPlatformDiscountSharePolicyResponse>;
        getPlatformAdditionalFeePolicies: (
            options?: {
                page?: PageInput;
                filter?: PlatformAdditionalFeePolicyFilterInput;
            },
        ) => Promise<GetPlatformAdditionalFeePoliciesResponse>;
        createPlatformAdditionalFeePolicy: (
            options: {
                id?: string;
                name: string;
                fee: PlatformFeeInput;
                memo?: string;
                vatPayer: PlatformPayer;
            },
        ) => Promise<CreatePlatformAdditionalFeePolicyResponse>;
        getPlatformAdditionalFeePolicy: (
            options: { id: string },
        ) => Promise<PlatformAdditionalFeePolicy>;
        updatePlatformAdditionalFeePolicy: (
            options: {
                id: string;
                fee?: PlatformFeeInput;
                name?: string;
                memo?: string;
                vatPayer?: PlatformPayer;
            },
        ) => Promise<UpdatePlatformAdditionalFeePolicyResponse>;
        archivePlatformAdditionalFeePolicy: (
            options: { id: string },
        ) => Promise<ArchivePlatformAdditionalFeePolicyResponse>;
        recoverPlatformAdditionalFeePolicy: (
            options: { id: string },
        ) => Promise<RecoverPlatformAdditionalFeePolicyResponse>;
        getPlatformContracts: (
            options?: { page?: PageInput; filter?: PlatformContractFilterInput },
        ) => Promise<GetPlatformContractsResponse>;
        createPlatformContract: (
            options: {
                id?: string;
                name: string;
                memo?: string;
                platformFee: PlatformFeeInput;
                settlementCycle: PlatformSettlementCycleInput;
                platformFeeVatPayer: PlatformPayer;
                subtractPaymentVatAmount: boolean;
            },
        ) => Promise<CreatePlatformContractResponse>;
        getPlatformContract: (options: { id: string }) => Promise<PlatformContract>;
        updatePlatformContract: (
            options: {
                id: string;
                name?: string;
                memo?: string;
                platformFee?: PlatformFeeInput;
                settlementCycle?: PlatformSettlementCycleInput;
                platformFeeVatPayer?: PlatformPayer;
                subtractPaymentVatAmount?: boolean;
            },
        ) => Promise<UpdatePlatformContractResponse>;
        archivePlatformContract: (
            options: { id: string },
        ) => Promise<ArchivePlatformContractResponse>;
        recoverPlatformContract: (
            options: { id: string },
        ) => Promise<RecoverPlatformContractResponse>;
    }
    Index

    Properties

    getPlatformDiscountSharePolicies: (
        options?: {
            page?: PageInput;
            filter?: PlatformDiscountSharePolicyFilterInput;
        },
    ) => Promise<GetPlatformDiscountSharePoliciesResponse>

    할인 분담 정책 다건 조회

    여러 할인 분담을 조회합니다.

    GetPlatformDiscountSharePoliciesError

    createPlatformDiscountSharePolicy: (
        options: {
            id?: string;
            name: string;
            partnerShareRate: number;
            memo?: string;
        },
    ) => Promise<CreatePlatformDiscountSharePolicyResponse>

    할인 분담 정책 생성

    새로운 할인 분담을 생성합니다.

    CreatePlatformDiscountSharePolicyError

    getPlatformDiscountSharePolicy: (
        options: { id: string },
    ) => Promise<PlatformDiscountSharePolicy>

    할인 분담 정책 조회

    주어진 아이디에 대응되는 할인 분담을 조회합니다.

    GetPlatformDiscountSharePolicyError

    updatePlatformDiscountSharePolicy: (
        options: {
            id: string;
            name?: string;
            partnerShareRate?: number;
            memo?: string;
        },
    ) => Promise<UpdatePlatformDiscountSharePolicyResponse>

    할인 분담 정책 수정

    주어진 아이디에 대응되는 할인 분담을 업데이트합니다.

    UpdatePlatformDiscountSharePolicyError

    archivePlatformDiscountSharePolicy: (
        options: { id: string },
    ) => Promise<ArchivePlatformDiscountSharePolicyResponse>

    할인 분담 정책 보관

    주어진 아이디에 대응되는 할인 분담을 보관합니다.

    ArchivePlatformDiscountSharePolicyError

    recoverPlatformDiscountSharePolicy: (
        options: { id: string },
    ) => Promise<RecoverPlatformDiscountSharePolicyResponse>

    할인 분담 정책 복원

    주어진 아이디에 대응되는 할인 분담을 복원합니다.

    RecoverPlatformDiscountSharePolicyError

    getPlatformAdditionalFeePolicies: (
        options?: {
            page?: PageInput;
            filter?: PlatformAdditionalFeePolicyFilterInput;
        },
    ) => Promise<GetPlatformAdditionalFeePoliciesResponse>

    추가 수수료 정책 다건 조회

    여러 추가 수수료 정책을 조회합니다.

    GetPlatformAdditionalFeePoliciesError

    createPlatformAdditionalFeePolicy: (
        options: {
            id?: string;
            name: string;
            fee: PlatformFeeInput;
            memo?: string;
            vatPayer: PlatformPayer;
        },
    ) => Promise<CreatePlatformAdditionalFeePolicyResponse>

    추가 수수료 정책 생성

    새로운 추가 수수료 정책을 생성합니다.

    CreatePlatformAdditionalFeePolicyError

    getPlatformAdditionalFeePolicy: (
        options: { id: string },
    ) => Promise<PlatformAdditionalFeePolicy>

    추가 수수료 정책 조회

    주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.

    GetPlatformAdditionalFeePolicyError

    updatePlatformAdditionalFeePolicy: (
        options: {
            id: string;
            fee?: PlatformFeeInput;
            name?: string;
            memo?: string;
            vatPayer?: PlatformPayer;
        },
    ) => Promise<UpdatePlatformAdditionalFeePolicyResponse>

    추가 수수료 정책 수정

    주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.

    UpdatePlatformAdditionalFeePolicyError

    archivePlatformAdditionalFeePolicy: (
        options: { id: string },
    ) => Promise<ArchivePlatformAdditionalFeePolicyResponse>

    추가 수수료 정책 보관

    주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.

    ArchivePlatformAdditionalFeePolicyError

    recoverPlatformAdditionalFeePolicy: (
        options: { id: string },
    ) => Promise<RecoverPlatformAdditionalFeePolicyResponse>

    추가 수수료 정책 복원

    주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.

    RecoverPlatformAdditionalFeePolicyError

    getPlatformContracts: (
        options?: { page?: PageInput; filter?: PlatformContractFilterInput },
    ) => Promise<GetPlatformContractsResponse>

    계약 다건 조회

    여러 계약을 조회합니다.

    GetPlatformContractsError

    createPlatformContract: (
        options: {
            id?: string;
            name: string;
            memo?: string;
            platformFee: PlatformFeeInput;
            settlementCycle: PlatformSettlementCycleInput;
            platformFeeVatPayer: PlatformPayer;
            subtractPaymentVatAmount: boolean;
        },
    ) => Promise<CreatePlatformContractResponse>

    계약 생성

    새로운 계약을 생성합니다.

    CreatePlatformContractError

    getPlatformContract: (options: { id: string }) => Promise<PlatformContract>

    계약 조회

    주어진 아이디에 대응되는 계약을 조회합니다.

    GetPlatformContractError

    updatePlatformContract: (
        options: {
            id: string;
            name?: string;
            memo?: string;
            platformFee?: PlatformFeeInput;
            settlementCycle?: PlatformSettlementCycleInput;
            platformFeeVatPayer?: PlatformPayer;
            subtractPaymentVatAmount?: boolean;
        },
    ) => Promise<UpdatePlatformContractResponse>

    계약 수정

    주어진 아이디에 대응되는 계약을 업데이트합니다.

    UpdatePlatformContractError

    archivePlatformContract: (
        options: { id: string },
    ) => Promise<ArchivePlatformContractResponse>

    계약 보관

    주어진 아이디에 대응되는 계약을 보관합니다.

    ArchivePlatformContractError

    recoverPlatformContract: (
        options: { id: string },
    ) => Promise<RecoverPlatformContractResponse>

    계약 복원

    주어진 아이디에 대응되는 계약을 복원합니다.

    RecoverPlatformContractError