mp-js-api 0.0.32 → 0.0.34

package/src/index.ts

@@ -13,9 +13,12 @@ import { Household, HouseholdRecord } from './tables/households';
 import { Participant, ParticipantRecord } from './tables/participants';
 import { EventParticipant, EventParticipantRecord } from './tables/event-participants';
 import { GroupParticipant, GroupParticipantRecord } from './tables/group-participants';
+import { ParticipationDetails, ParticipationDetailsRecord } from './tables/participation-details';
 import { ContactAttribute, ContactAttributeRecord, ContactWithAttribute } from './tables/contact-attributes';
 import { FormResponse, FormResponseRecord } from './tables/form-responses';
 import { FormResponseAnswer, FormResponseAnswerRecord } from './tables/from-response-answers';
+import { FormField, FormFieldRecord } from './tables/form-fields';
+import { ContactRelationship, ContactRelationshipRecord } from './tables/contact-relationships';
 import { ContactEmailAddress, ContactEmailAddressRecord, ContactWithEmailAddress, ContactWithEmailAddresses } from './tables/contact-email-addresses';
 import { AttachedFile } from './tables/files';
 
@@ -47,6 +50,10 @@ export type CreateGroupParticipantPayload = WithRequired<
   Partial<GroupParticipant>,
   'groupID' | 'participantID' | 'groupRoleID' | 'startDate'
 >;
+export type CreateParticipationDetailsPayload = WithRequired<
+  Partial<ParticipationDetails>,
+  'eventParticipantID' | 'participationItemID'
+>;
 export type CreateContactAttributePayload = WithRequired<
   Partial<ContactAttribute>,
   'attributeID' | 'contactID' | 'startDate'
@@ -59,10 +66,18 @@ export type CreateFormResponseAnswerPayload = WithRequired<
   Omit<Partial<FormResponseAnswer>, 'formResponseAnswerID'>,
   'formFieldID' | 'formResponseID'
 >;
+export type CreateFormFieldPayload = WithRequired<
+  Omit<Partial<FormField>, 'formFieldID'>,
+  'formID' | 'fieldLabel' | 'fieldOrder' | 'fieldTypeID' | 'required'
+>;
 export type CreateContactEmailAddressPayload = WithRequired<
   Omit<Partial<ContactEmailAddress>, 'emailAddressID'>,
   'emailAddress' | 'contactID'
 >;
+export type CreateContactRelationshipPayload = WithRequired<
+  Omit<Partial<ContactRelationship>, 'contactRelationshipID'>,
+  'contactID' | 'relationshipID' | 'relatedContactID'
+>;
 export type CreateFilePayload = WithRequired<
   Omit<Partial<AttachedFile>, 'FileId'>,
   'Description' | 'IsDefaultImage'
@@ -149,10 +164,22 @@ export type MPInstance = {
     id: number,
     mpQuery?: MPGetQuery
   ): Promise<GroupParticipant | undefined | { error: ErrorDetails; }>;
+  getParticipationDetail(
+    id: number,
+    mpQuery?: MPGetQuery
+  ): Promise<ParticipationDetails | undefined | { error: ErrorDetails; }>;
   getFormResponse(
     id: number,
     mpQuery?: MPGetQuery
   ): Promise<FormResponse | undefined | { error: ErrorDetails; }>;
+  getFormField(
+    id: number,
+    mpQuery?: MPGetQuery
+  ): Promise<FormField | undefined | { error: ErrorDetails; }>;
+  getContactRelationship(
+    id: number,
+    mpQuery?: MPGetQuery
+  ): Promise<ContactRelationship | undefined | { error: ErrorDetails; }>;
 
   getContacts(
     mpQuery: AtLeastOne<MPGetQuery>
@@ -193,6 +220,15 @@ export type MPInstance = {
   getFormResponseAnswers(
     mpQuery: AtLeastOne<MPGetQuery>
   ): Promise<FormResponseAnswer[] | { error: ErrorDetails; }>;
+  getParticipationDetails(
+    mpQuery: AtLeastOne<MPGetQuery>
+  ): Promise<ParticipationDetails[] | { error: ErrorDetails; }>;
+  getFormFields(
+    mpQuery: AtLeastOne<MPGetQuery>
+  ): Promise<FormField[] | { error: ErrorDetails; }>;
+  getContactRelationships(
+    mpQuery: AtLeastOne<MPGetQuery>
+  ): Promise<ContactRelationship[] | { error: ErrorDetails; }>;
 
   createContact(
     data: CreateContactPayload,
@@ -234,6 +270,30 @@ export type MPInstance = {
     data: CreateContactEmailAddressPayload[],
     mpQuery?: MPCreateQuery
   ): Promise<ContactEmailAddress[] | { error: ErrorDetails; }>;
+  createParticipationDetail(
+    data: CreateParticipationDetailsPayload,
+    mpQuery?: MPCreateQuery
+  ): Promise<ParticipationDetails | { error: ErrorDetails; }>;
+  createParticipationDetails(
+    data: CreateParticipationDetailsPayload[],
+    mpQuery?: MPCreateQuery
+  ): Promise<ParticipationDetails[] | { error: ErrorDetails; }>;
+  createFormField(
+    data: CreateFormFieldPayload,
+    mpQuery?: MPCreateQuery
+  ): Promise<FormField | { error: ErrorDetails; }>;
+  createFormFields(
+    data: CreateFormFieldPayload[],
+    mpQuery?: MPCreateQuery
+  ): Promise<FormField[] | { error: ErrorDetails; }>;
+  createContactRelationship(
+    data: CreateContactRelationshipPayload,
+    mpQuery?: MPCreateQuery
+  ): Promise<ContactRelationship | { error: ErrorDetails; }>;
+  createContactRelationships(
+    data: CreateContactRelationshipPayload[],
+    mpQuery?: MPCreateQuery
+  ): Promise<ContactRelationship[] | { error: ErrorDetails; }>;
 
   updateContacts(
     contacts: WithRequired<Partial<Contact>, 'contactID'>[],
@@ -255,6 +315,18 @@ export type MPInstance = {
     participants: WithRequired<Partial<FormResponseAnswer>, 'formResponseAnswerID'>[],
     mpQuery?: MPUpdateQuery
   ): Promise<FormResponseAnswer[] | { error: ErrorDetails; }>;
+  updateParticipationDetails(
+    details: WithRequired<Partial<ParticipationDetails>, 'participationDetailID'>[],
+    mpQuery?: MPUpdateQuery
+  ): Promise<ParticipationDetails[] | { error: ErrorDetails; }>;
+  updateFormFields(
+    fields: WithRequired<Partial<FormField>, 'formFieldID'>[],
+    mpQuery?: MPUpdateQuery
+  ): Promise<FormField[] | { error: ErrorDetails; }>;
+  updateContactRelationships(
+    relationships: WithRequired<Partial<ContactRelationship>, 'contactRelationshipID'>[],
+    mpQuery?: MPUpdateQuery
+  ): Promise<ContactRelationship[] | { error: ErrorDetails; }>;
 
   getFiles(table: string, recordId: number, mpQuery?: MPGetQuery)
     : Promise<AttachedFile[] | { error: ErrorDetails; }>;
@@ -370,11 +442,26 @@ export const createMPInstance = ({ auth }: { auth: { username: string; password:
         { path: `/tables/group_participants`, id, mpQuery }
       );
     },
+    async getParticipationDetail(id, mpQuery = {}) {
+      return getOne<ParticipationDetails>(
+        { path: `/tables/participation_details`, id, mpQuery }
+      );
+    },
     async getFormResponse(id, mpQuery = {}) {
       return getOne<FormResponse>(
         { path: `/tables/form_responses`, id, mpQuery }
       );
     },
+    async getFormField(id, mpQuery = {}) {
+      return getOne<FormField>(
+        { path: `/tables/form_fields`, id, mpQuery }
+      );
+    },
+    async getContactRelationship(id, mpQuery = {}) {
+      return getOne<ContactRelationship>(
+        { path: `/tables/contact_relationships`, id, mpQuery }
+      );
+    },
     async getContacts(mpQuery) {
       return getMany<Contact>(
         { path: `/tables/contacts`, mpQuery }
@@ -449,6 +536,21 @@ export const createMPInstance = ({ auth }: { auth: { username: string; password:
         { path: `/tables/form_response_answers`, mpQuery }
       );
     },
+    async getParticipationDetails(mpQuery) {
+      return getMany<ParticipationDetails>(
+        { path: `/tables/participation_details`, mpQuery }
+      );
+    },
+    async getFormFields(mpQuery) {
+      return getMany<FormField>(
+        { path: `/tables/form_fields`, mpQuery }
+      );
+    },
+    async getContactRelationships(mpQuery) {
+      return getMany<ContactRelationship>(
+        { path: `/tables/contact_relationships`, mpQuery }
+      );
+    },
 
     async createContact(data, mpQuery = {}) {
       return createOne<Contact>(
@@ -500,6 +602,36 @@ export const createMPInstance = ({ auth }: { auth: { username: string; password:
         { path: `/tables/contact_email_addresses`, mpQuery, data }
       );
     },
+    async createParticipationDetail(data, mpQuery) {
+      return createOne<ParticipationDetails>(
+        { path: `/tables/participation_details`, mpQuery, data }
+      );
+    },
+    async createParticipationDetails(data, mpQuery) {
+      return createMany<ParticipationDetails>(
+        { path: `/tables/participation_details`, mpQuery, data }
+      );
+    },
+    async createFormField(data, mpQuery) {
+      return createOne<FormField>(
+        { path: `/tables/form_fields`, mpQuery, data }
+      );
+    },
+    async createFormFields(data, mpQuery) {
+      return createMany<FormField>(
+        { path: `/tables/form_fields`, mpQuery, data }
+      );
+    },
+    async createContactRelationship(data, mpQuery) {
+      return createOne<ContactRelationship>(
+        { path: `/tables/contact_relationships`, mpQuery, data }
+      );
+    },
+    async createContactRelationships(data, mpQuery) {
+      return createMany<ContactRelationship>(
+        { path: `/tables/contact_relationships`, mpQuery, data }
+      );
+    },
     async updateContacts(data, mpQuery) {
       return updateMany<Contact>(
         { path: `/tables/contacts`, mpQuery, data }
@@ -525,6 +657,21 @@ export const createMPInstance = ({ auth }: { auth: { username: string; password:
         { path: `/tables/form_response_answers`, mpQuery, data }
       );
     },
+    async updateParticipationDetails(data, mpQuery) {
+      return updateMany<ParticipationDetails>(
+        { path: `/tables/participation_details`, mpQuery, data }
+      );
+    },
+    async updateFormFields(data, mpQuery) {
+      return updateMany<FormField>(
+        { path: `/tables/form_fields`, mpQuery, data }
+      );
+    },
+    async updateContactRelationships(data, mpQuery) {
+      return updateMany<ContactRelationship>(
+        { path: `/tables/contact_relationships`, mpQuery, data }
+      );
+    },
 
     async getFiles(table, recordId) {
       return getMany<AttachedFile>(
@@ -561,15 +708,18 @@ export {
   Group,
   EventParticipant,
   GroupParticipant,
+  ParticipationDetails,
   Household,
   Address,
   FormResponse,
   FormResponseAnswer,
+  FormField,
   ContactAttribute,
   ContactWithAttribute,
   ContactEmailAddress,
   ContactWithEmailAddress,
   ContactWithEmailAddresses,
+  ContactRelationship,
 
   // Communications endpoint types
   Communication,

package/src/tables/contact-relationships.ts

@@ -0,0 +1,22 @@
+export interface ContactRelationshipRecord {
+	Contact_Relationship_ID: number;
+	Contact_ID: number;
+	Relationship_ID: number;
+	Related_Contact_ID: number;
+	Start_Date: string | null;
+	End_Date: string | null;
+	Notes: string | null;
+	_Triggered_By: number | null;
+}
+
+
+export interface ContactRelationship {
+	contactRelationshipID: number;
+	contactID: number;
+	relationshipID: number;
+	relatedContactID: number;
+	startDate: string | null;
+	endDate: string | null;
+	notes: string | null;
+	readonly _triggeredBy: number | null;
+}

package/src/tables/form-fields.ts

@@ -0,0 +1,30 @@
+export interface FormFieldRecord {
+	Form_Field_ID: number;
+	Form_ID: number;
+	Field_Label: string;
+	Field_Order: number;
+	Field_Type_ID: number;
+	Field_Values: string | null;
+	Required: boolean;
+	Placement_Required: boolean;
+	Alternate_Label: string | null;
+	Is_Hidden: boolean;
+	Depends_On: number | null;
+	Depends_On_Value: string | null;
+}
+
+
+export interface FormField {
+	formFieldID: number;
+	formID: number;
+	fieldLabel: string;
+	fieldOrder: number;
+	fieldTypeID: number;
+	fieldValues: string | null;
+	required: boolean;
+	placementRequired: boolean;
+	alternateLabel: string | null;
+	isHidden: boolean;
+	dependsOn: number | null;
+	dependsOnValue: string | null;
+}

package/src/tables/participation-details.ts

@@ -0,0 +1,15 @@
+export interface ParticipationDetailsRecord {
+  Participation_Detail_ID: number;
+  Event_Participant_ID: number;
+  Participation_Item_ID: number;
+  Numeric_Value: number | null;
+  Notes: string | null;
+}
+
+export interface ParticipationDetails {
+  participationDetailID: number;
+  eventParticipantID: number;
+  participationItemID: number;
+  numericValue: number | null;
+  notes: string | null;
+}