@mediarithmics/plugins-nodejs-sdk/src/mediarithmics/api/datamart/RecommenderInterface.ts

This is the mediarithmics nodejs to help plugin developers bootstrapping their plugin without having to deal with most of the plugin boilerplate

import { Customizable } from '../../api/core/common/Customizable';
import { DataResponse } from '../../api/core/common/Response';

export type RecommenderResponse = DataResponse<RecommendationsWrapper>;

export interface RecommendationsWrapper {
  ts: number;
  proposals: ItemProposal[];
  recommendation_log?: string;
}

export type ProposalType = 'ITEM_PROPOSAL' | 'PRODUCT_PROPOSAL' | 'CATEGORY_PROPOSAL' | 'CONTENT_PROPOSAL';

export interface Proposal extends Customizable {
  $type: ProposalType;
  $id?: string;
  $gid?: string;
}

export interface ProductProposal extends Proposal {
  $price?: number;
  $salePrice?: number;
  $discountPercentage?: number;
  $currency?: string;
}

export interface ItemProposal extends ProductProposal {
  $name?: string;
  $brand?: string;
  $url?: string;
  $description?: string;
  $imageUrl?: string;
}

export interface ProfileEmailHandlebarsRootContext {
  private: {
    profileData: ProfileDataLayer;
  };
}

export interface ProfileDataLayer {
  [propsName: string]: string;
}

export interface ProfileDataArgs {
  defaultValue: string;
  fieldName: string;
}

export interface ProfileDataHelperOptions {
  name: string;
  hash: ProfileDataArgs;
  data: { root: ProfileEmailHandlebarsRootContext };
}