Type Alias PartnerClient

Type declaration

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

  파트너 다건 조회

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

  Throws

  GetPlatformPartnersError

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

  파트너 생성

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

  Throws

  CreatePlatformPartnerError

• getPlatformPartner: (options: { id: string }) => Promise<PlatformPartner>

  파트너 조회

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

  Throws

  GetPlatformPartnerError

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

  파트너 수정

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

  Throws

  UpdatePlatformPartnerError

• createPlatformPartners: (
      options: { partners: CreatePlatformPartnerBody[] },
  ) => Promise<CreatePlatformPartnersResponse>

  파트너 다건 생성

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

  Throws

  CreatePlatformPartnersError

• archivePlatformPartner: (options: { id: string }) => Promise<ArchivePlatformPartnerResponse>

  파트너 복원

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

  Throws

  ArchivePlatformPartnerError

• recoverPlatformPartner: (options: { id: string }) => Promise<RecoverPlatformPartnerResponse>

  파트너 복원

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

  Throws

  RecoverPlatformPartnerError