datahub/wherehows-web/app/typings/api/datasets/party-entities.d.ts

import { ApiStatus } from 'wherehows-web/utils/api/shared';

/**
 * Describes the interface for a party entity
 */
export interface IPartyEntity {
  category: string;
  displayName: string;
  label: string;
}

/**
 * Describes the expected shape of the response for party entities endpoint
 */
export interface IPartyEntityResponse {
  status: ApiStatus;
  userEntities?: Array<IPartyEntity>;
  msg?: string;
}

/**
 * Describes a IUserEntityMap interface
 */
export interface IUserEntityMap {
  [label: string]: string;
}

/**
 * Describes the props resolved by the getUserEntities function
 */
export interface IPartyProps {
  userEntities: Array<IPartyEntity>;
  userEntitiesMaps: IUserEntityMap;
  userEntitiesSource: Array<keyof IUserEntityMap>;
}