@mediarithmics/plugins-nodejs-sdk/src/mediarithmics/api/plugin/audiencefeedconnector/AudienceFeedConnectorRequestInterface.ts

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

import { BatchUpdateContext } from '../../core/batchupdate/BatchUpdateInterface';
import { UserIdentifierInfo } from '../../reference/UserIdentifierInterface';
import { PluginProperty } from '../../core/plugin/PluginPropertyInterface';
import { UserProfileInfo } from '../../reference/UserProfileInfo';

export type UpdateType = 'UPSERT' | 'DELETE';

export interface UserSegmentUpdateRequest {
  feed_id: string;
  session_id: string;
  datamart_id: string;
  segment_id: string;
  user_identifiers: UserIdentifierInfo[];
  user_profiles: UserProfileInfo[];
  ts: number;
  operation: UpdateType;
}

export interface ExternalSegmentConnectionRequest {
  feed_id: string;
  datamart_id: string;
  segment_id: string;
}

export interface ExternalSegmentCreationRequest {
  feed_id: string;
  datamart_id: string;
  segment_id: string;
}

export interface AudienceFeedBatchContext extends BatchUpdateContext {
  endpoint: string;
  feed_id: string;
  feed_session_id: string;
  segment_id: string;
  datamart_id: string;
  grouping_key: string;
}

export const ExternalSegmentTroubleshootActions = ['FETCH_DESTINATION_AUDIENCE'] as const;
export type ExternalSegmentTroubleshootAction = (typeof ExternalSegmentTroubleshootActions)[number];

type ExternalSegmentTroubleshootBaseRequest = {
  feed_id: string;
  datamart_id: string;
  segment_id: string;
};

export type TroubleshootActionFetchDestinationAudience = ExternalSegmentTroubleshootBaseRequest & {
  action: 'FETCH_DESTINATION_AUDIENCE';
};

// This comment is just to have an example when an action with args will be implemented
//
// export type TroubleshootActionWithArgs = ExternalSegmentTroubleshootBaseRequest & {
//   action: 'ACTION_WITH_ARGS';
//   args: {}; // Put args for specific action
// };

export type ExternalSegmentTroubleshootRequest = TroubleshootActionFetchDestinationAudience; // | TroubleshootActionWithArgs;

export interface ExternalSegmentAuthenticationStatusQueryRequest {
  segment_id?: string;
  datamart_id: string;
  plugin_version_id: string;
  user_id: string;
  properties?: PluginProperty[];
}

export interface ExternalSegmentAuthenticationRequest {
  user_id: string;
  plugin_version_id: string;
  params?: { [key: string]: string };
}

export interface ExternalSegmentLogoutRequest {
  user_id: string;
  plugin_version_id: string;
  datamart_id: string;
}

export interface ExternalSegmentDynamicPropertyValuesQueryRequest {
  segment_id?: string;
  datamart_id: string;
  user_id: string;
  properties?: PluginProperty[];
}