mp-js-api 0.0.7 → 0.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mp-js-api",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "Node MinistryPlatform API",
   "main": "dist/index.js",
   "scripts": {

package/src/api.ts

@@ -24,13 +24,12 @@ export interface MPApiBase {
 
 export interface ErrorDetails {
   message: string;
-  name: string;
+  name?: string;
   code?: string;
   status?: number;
   method?: string;
   url?: string;
-  data: string;
-  error: true;
+  data?: string;
 }
 
 
@@ -77,7 +76,7 @@ export const createApiBase = ({ auth }: { auth: { username: string; password: st
     baseURL: 'https://mp.revival.com/ministryplatformapi',
   });
 
-  const getOne: APIGetOneInstance = async <T, R>({ id, path, mpOptions, config }) => {
+  const getOne: APIGetOneInstance = async <T, R>({ id, path, mpOptions, config }: APIGetParameter & { id: number; }) => {
     try {
       const url = `${path}/${id}` + stringifyURLParams(mpOptions);
       const res = await api.get<T>(url, {
@@ -94,9 +93,9 @@ export const createApiBase = ({ auth }: { auth: { username: string; password: st
     }
   };
 
-  const getMany: APIGetMultipleInstance = async <T, R>({ path, mpOptions, config }: APIGetParameter) => {
+  const getMany: APIGetMultipleInstance = async <T, R>({ id, path, mpOptions, config }: APIGetParameter) => {
     try {
-      const url = path + stringifyURLParams(mpOptions);
+      const url = id ? `${path}/${id}` : path + stringifyURLParams(mpOptions);
       const res = await api.get<T[]>(url, {
         ...config,
         headers: {
@@ -212,7 +211,6 @@ export const createApiBase = ({ auth }: { auth: { username: string; password: st
 
   const getError = function (error: AxiosError): ErrorDetails {
     return {
-      error: true,
       message: error.message,
       name: error.name,
       code: error.code,
@@ -269,6 +267,7 @@ export type MPCreateOptions = {
 export type MPUpdateOptions = MPCreateOptions;
 
 interface APIGetParameter {
+  id?: number;
   path: string;
   mpOptions?: MPGetOptions;
   config?: AxiosRequestConfig;
@@ -292,4 +291,6 @@ interface APIUpdateParameter<T> {
   params: T[],
   mpOptions?: MPCreateOptions;
   config?: AxiosRequestConfig;
-};
+};
+
+export type DateTimeIsoString = `${number}-${number}-${number}T${number}:${number}:${number}`;

package/src/index.ts

@@ -1,4 +1,4 @@
-import { createApiBase, MPApiBase, ErrorDetails, MPGetOptions, MPCreateOptions, MPUpdateOptions } from './api';
+import { createApiBase, MPApiBase, ErrorDetails, MPGetOptions, MPCreateOptions, MPUpdateOptions, DateTimeIsoString } from './api';
 import { convertToCamelCase, convertToSnakeCase, escapeSql, stringifyURLParams } from './utils/strings';
 import { Contact, ContactRecord } from './tables/contacts';
 import { Event, EventRecord } from './tables/events';
@@ -12,6 +12,7 @@ import { ContactAttribute, ContactAttributeRecord } from './tables/contact-attri
 import { FormResponse, FormResponseRecord } from './tables/form-responses';
 import { FormResponseAnswer } from './tables/from-response-answers';
 import { AxiosInstance } from 'axios';
+import { ContactEmailAddress, ContactEmailAddressRecord } from './tables/contact-email-addresses';
 
 
 type WithRequired<T, K extends keyof T> = T & Required<Pick<T, K>>;
@@ -53,6 +54,10 @@ export type CreateFormResponseAnswerParams = WithRequired<
   Omit<Partial<FormResponseAnswer>, 'formResponseAnswerID'>,
   'formFieldID' | 'formResponseID'
 >;
+export type CreateContactEmailAddressParams = WithRequired<
+  Omit<Partial<ContactEmailAddress>, 'emailAddressID'>,
+  'emailAddress' | 'contactID'
+>;
 
 
 export type MPInstance = {
@@ -110,6 +115,10 @@ export type MPInstance = {
   getContacts(
     options?: MPGetOptions
   ): Promise<Contact[] | { error: ErrorDetails; }>;
+  getContactEmailAddresses(
+    id?: number,
+    options?: MPGetOptions
+  ): Promise<ContactEmailAddress[] | { error: ErrorDetails; }>;
   getHouseholds(
     options?: MPGetOptions
   ): Promise<Household[] | { error: ErrorDetails; }>;
@@ -164,6 +173,10 @@ export type MPInstance = {
     params: CreateFormResponseAnswerParams[],
     options?: MPCreateOptions
   ): Promise<FormResponseAnswer[] | { error: ErrorDetails; }>;
+  createContactEmailAddress(
+    params: CreateContactEmailAddressParams[],
+    options?: MPCreateOptions
+  ): Promise<ContactEmailAddress[] | { error: ErrorDetails; }>;
 
   updateContacts(
     contacts: WithRequired<Partial<Contact>, 'contactID'>[],
@@ -254,6 +267,11 @@ export const createMPInstance = ({ auth }: { auth: { username: string; password:
         { path: `/tables/addresses`, mpOptions }
       );
     },
+    async getContactEmailAddresses(id, mpOptions = {}) {
+      return getMany<ContactEmailAddressRecord, ContactEmailAddress>(
+        { path: `/tables/contact_email_addresses`, id, mpOptions }
+      );
+    },
     async getParticipants(mpOptions = {}) {
       return getMany<ParticipantRecord, Participant>(
         { path: `/tables/participants`, mpOptions }
@@ -325,6 +343,11 @@ export const createMPInstance = ({ auth }: { auth: { username: string; password:
         { path: `/tables/form_response_answers`, mpOptions, params }
       );
     },
+    async createContactEmailAddress(params, mpOptions) {
+      return createMany<CreateContactEmailAddressParams, ContactEmailAddress>(
+        { path: `/tables/contact_email_addresses`, mpOptions, params }
+      );
+    },
     async updateContacts(params, mpOptions) {
       return update<Partial<Contact>, Contact>(
         { path: `/tables/contacts`, mpOptions, params }
@@ -350,7 +373,9 @@ export {
   Address,
   FormResponse,
   FormResponseAnswer,
+  ContactEmailAddress,
   ErrorDetails,
+  DateTimeIsoString,
   convertToCamelCase,
   convertToSnakeCase,
   stringifyURLParams,

package/src/tables/contact-email-addresses.ts

@@ -0,0 +1,19 @@
+import { DateTimeIsoString } from "../api";
+
+export interface ContactEmailAddressRecord {
+  Email_Address_ID: number;
+  Email_Address: string;
+  Contact_ID: number;
+  Email_Type_ID?: number;
+  End_Date?: DateTimeIsoString | null;
+  Notes?: string | null;
+}
+
+export interface ContactEmailAddress {
+  emailAddressID: number;
+  emailAddress: string;
+  contactID: number;
+  emailTypeID?: number;
+  endDate?: DateTimeIsoString | null;
+  notes?: string | null;
+}

package/src/utils/types.d.ts

@@ -1,7 +1,3 @@
-declare global {
-	interface String {
-    escapeSql(): string;
-  }
-}
+
 
 export {};