@friggframework/api-module-hubspot 1.2.0-canary.293.5731c31.0 → 2.0.0-next.0

package/api.js

@@ -1,4 +1,4 @@
-const { OAuth2Requester, get } = require('@friggframework/core');
+const {OAuth2Requester, get} = require('@friggframework/core');
 
 class Api extends OAuth2Requester {
     constructor(params) {
@@ -26,8 +26,16 @@ class Api extends OAuth2Requester {
             deals: '/crm/v3/objects/deals',
             dealById: (dealId) => `/crm/v3/objects/deals/${dealId}`,
             searchDeals: '/crm/v3/objects/deals/search',
-            getBatchAssociations: (fromObject, toObject) =>
-                `/crm/v3/associations/${fromObject}/${toObject}/batch/read`,
+            readBatchAssociations: (fromObjectType, toObjectType) =>
+                `/crm/v4/associations/${fromObjectType}/${toObjectType}/batch/read`,
+            createBatchAssociations: (fromObjectType, toObjectType) =>
+                `/crm/v4/associations/${fromObjectType}/${toObjectType}/batch/create`,
+            createBatchAssociationsDefault: (fromObjectType, toObjectType) =>
+                `/crm/v4/associations/${fromObjectType}/${toObjectType}/batch/associate/default`,
+            deleteBatchAssociations: (fromObjectType, toObjectType) =>
+                `/crm/v4/associations/${fromObjectType}/${toObjectType}/batch/archive`,
+            deleteBatchAssociationLabels: (fromObjectType, toObjectType) =>
+                `/crm/v4/associations/${fromObjectType}/${toObjectType}/batch/labels/archive`,
             v1DealInfo: (dealId) => `/deals/v1/deal/${dealId}`,
             getPipelineDetails: (objType) => `/crm/v3/pipelines/${objType}`,
             getOwnerById: (ownerId) => `/owners/v2/owners/${ownerId}`,
@@ -56,6 +64,13 @@ class Api extends OAuth2Requester {
             blogPostById: (blogPostId) => `/cms/v3/blogs/posts/${blogPostId}`,
             emailTemplates: '/content/api/v2/templates',
             emailTemplateById: (templateId) => `/content/api/v2/templates/${templateId}`,
+            lists: '/crm/v3/lists',
+            listById: (listId) => `/crm/v3/lists/${listId}`,
+            listSearch: '/crm/v3/lists/search',
+            listMemberships: (listId) => `/crm/v3/lists/${listId}/memberships`,
+            listMembershipsAddRemove: (listId) => `/crm/v3/lists/${listId}/memberships/add-and-remove`,
+            associations: (fromObject, toObject) => `/crm/v4/associations/${fromObject}/${toObject}`,
+            associationLabels: (fromObject, toObject) => `/crm/v4/associations/${fromObject}/${toObject}/labels`,
 
         };
 
@@ -67,10 +82,36 @@ class Api extends OAuth2Requester {
         this.access_token = get(params, 'access_token', null);
         this.refresh_token = get(params, 'refresh_token', null);
     }
+
     getAuthUri() {
         return this.authorizationUri;
     }
 
+    addJsonHeaders(options) {
+        const jsonHeaders = {
+            'Content-Type': 'application/json',
+            Accept: 'application/json',
+        };
+        options.headers = {
+            ...jsonHeaders,
+            ...options.headers,
+        }
+    }
+    async _post(options, stringify) {
+        this.addJsonHeaders(options);
+        return super._post(options, stringify);
+    }
+
+    async _patch(options, stringify) {
+        this.addJsonHeaders(options);
+        return super._patch(options, stringify);
+    }
+
+    async _put(options, stringify) {
+        this.addJsonHeaders(options);
+        return super._put(options, stringify);
+    }
+
     // **************************   Companies   **********************************
 
     async createCompany(body) {
@@ -79,10 +120,6 @@ class Api extends OAuth2Requester {
             body: {
                 properties: body,
             },
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
 
         return this._post(options);
@@ -100,10 +137,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.companyById(id),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
         return this._patch(options);
     }
@@ -112,10 +145,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.companySearch,
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
         return this._post(options);
     }
@@ -155,10 +184,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.getBatchCompaniesById,
             body,
-            headers: {
-                'content-type': 'application/json',
-                accept: 'application/json',
-            },
             query: {
                 archived: 'false',
             },
@@ -174,10 +199,6 @@ class Api extends OAuth2Requester {
             body: {
                 properties: body,
             },
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
 
         return this._post(options);
@@ -231,10 +252,6 @@ class Api extends OAuth2Requester {
             body: {
                 properties,
             },
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         }
         return this._patch(options);
     }
@@ -250,10 +267,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.getBatchContactsById,
             body,
-            headers: {
-                'content-type': 'application/json',
-                accept: 'application/json',
-            },
             query: {
                 archived: 'false',
             },
@@ -269,10 +282,6 @@ class Api extends OAuth2Requester {
             body: {
                 properties: body,
             },
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
 
         return this._post(options);
@@ -302,7 +311,7 @@ class Api extends OAuth2Requester {
     async getDealStageHistory(dealId) {
         const options = {
             url: this.baseUrl + this.URLs.v1DealInfo(dealId),
-            query: { includePropertyVersions: true },
+            query: {includePropertyVersions: true},
         };
         const res = await this._get(options);
         return res.properties.dealstage.versions;
@@ -352,9 +361,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.searchDeals,
             body: searchBody,
-            headers: {
-                'content-type': 'application/json',
-            },
         };
         return this._post(options);
     }
@@ -362,7 +368,7 @@ class Api extends OAuth2Requester {
     async updateDeal(params) {
         const dealId = get(params, 'dealId');
         const properties = get(params, 'properties');
-        const body = { properties };
+        const body = {properties};
         const options = {
             url: this.baseUrl + this.URLs.getDealById(dealId),
             body,
@@ -376,10 +382,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.contactList,
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
 
         return this._post(options);
@@ -413,10 +415,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.contactListById(listId),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
         return this._post(options);
     }
@@ -427,14 +425,8 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.customObjectSchemas,
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
+
 
         return this._post(options);
     }
@@ -459,17 +451,12 @@ class Api extends OAuth2Requester {
         return this._delete(options);
     }
 
-    async getCustomObjectSchema(objectType) {
+    async getCustomObjectSchema(objectType, query) {
         const options = {
             url:
                 this.baseUrl +
                 this.URLs.customObjectSchemaByObjectType(objectType),
         };
-
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._get(options);
     }
 
@@ -477,11 +464,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.customObjectSchemas,
         };
-
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._get(options);
     }
 
@@ -491,16 +473,7 @@ class Api extends OAuth2Requester {
                 this.baseUrl +
                 this.URLs.customObjectSchemaByObjectType(objectType),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._patch(options);
     }
 
@@ -510,15 +483,7 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.customObjects(objectType),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._post(options);
     }
 
@@ -526,15 +491,7 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.bulkCreateCustomObjects(objectType),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._post(options);
     }
 
@@ -543,11 +500,6 @@ class Api extends OAuth2Requester {
             url: this.baseUrl + this.URLs.customObjectById(objectType, objId),
             query: {},
         };
-
-        if (this.api_key) {
-            options.query.hapikey = this.api_key;
-        }
-
         return this._delete(options);
     }
 
@@ -557,13 +509,9 @@ class Api extends OAuth2Requester {
         const options = {
             method: 'POST',
             body: JSON.stringify(body),
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
             query: {},
         };
-
+        this.addJsonHeaders(options);
         if (this.api_key) {
             options.query.hapikey = this.api_key;
         }
@@ -576,11 +524,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.customObjectById(objectType, objId),
         };
-
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._get(options);
     }
 
@@ -588,15 +531,7 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.bulkReadCustomObjects(objectType),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._post(options);
     }
 
@@ -605,11 +540,6 @@ class Api extends OAuth2Requester {
             url: this.baseUrl + this.URLs.customObjects(objectType),
             query,
         };
-
-        if (this.api_key) {
-            options.query.hapikey = this.api_key;
-        }
-
         return this._get(options);
     }
 
@@ -617,15 +547,7 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.customObjectsSearch(objectType),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._post(options);
     }
 
@@ -633,16 +555,7 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.customObjectById(objectType, objId),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
-
         return this._patch(options);
     }
 
@@ -650,14 +563,7 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.bulkUpdateCustomObjects(objectType),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
-        if (this.api_key) {
-            options.query = { hapikey: this.api_key };
-        }
         return this._post(options);
     }
 
@@ -679,10 +585,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.properties(objType),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
 
         return this._post(options);
@@ -708,10 +610,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: this.baseUrl + this.URLs.propertiesByName(objType, propName),
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-            },
         };
         return this._patch(options);
     }
@@ -749,7 +647,7 @@ class Api extends OAuth2Requester {
 
     // **************************   Pages   *****************************
 
-    async getLandingPages(query=''){
+    async getLandingPages(query = '') {
         const options = {
             url: `${this.baseUrl}${this.URLs.landingPages}`,
         };
@@ -759,28 +657,23 @@ class Api extends OAuth2Requester {
         return this._get(options);
     }
 
-    async getLandingPage(id){
+    async getLandingPage(id) {
         const options = {
             url: `${this.baseUrl}${this.URLs.landingPageById(id)}`,
         };
         return this._get(options);
     }
 
-    async updateLandingPage(objId, body, isDraft=false){
+    async updateLandingPage(objId, body, isDraft = false) {
         const draft = isDraft ? '/draft' : ''
         const options = {
             url: `${this.baseUrl}${this.URLs.landingPageById(objId)}${draft}`,
             body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._patch(options);
     }
 
-    async pushLandingPageDraftToLive(objId){
+    async pushLandingPageDraftToLive(objId) {
         const options = {
             url: `${this.baseUrl}${this.URLs.landingPageById(objId)}/draft/push-live`,
         };
@@ -794,16 +687,11 @@ class Api extends OAuth2Requester {
                 id: objId,
                 publishDate
             },
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._post(options);
     }
 
-    async getSitePages(query=''){
+    async getSitePages(query = '') {
         const options = {
             url: `${this.baseUrl}${this.URLs.sitePages}`,
         };
@@ -813,7 +701,7 @@ class Api extends OAuth2Requester {
         return this._get(options);
     }
 
-    async getSitePage(id){
+    async getSitePage(id) {
         const options = {
             url: `${this.baseUrl}${this.URLs.sitePageById(id)}`,
         };
@@ -821,21 +709,16 @@ class Api extends OAuth2Requester {
     }
 
 
-    async updateSitePage(objId, body, isDraft=false){
+    async updateSitePage(objId, body, isDraft = false) {
         const draft = isDraft ? '/draft' : ''
         const options = {
             url: `${this.baseUrl}${this.URLs.sitePageById(objId)}${draft}`,
             body: body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._patch(options);
     }
 
-    async pushSitePageDraftToLive(objId){
+    async pushSitePageDraftToLive(objId) {
         const options = {
             url: `${this.baseUrl}${this.URLs.sitePageById(objId)}/draft/push-live`,
         };
@@ -849,18 +732,13 @@ class Api extends OAuth2Requester {
                 id: objId,
                 publishDate
             },
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._post(options);
     }
 
     // **************************   Blogs   *****************************
 
-    async getBlogPosts(query=''){
+    async getBlogPosts(query = '') {
         const options = {
             url: `${this.baseUrl}${this.URLs.blogPosts}`,
         };
@@ -870,28 +748,23 @@ class Api extends OAuth2Requester {
         return this._get(options);
     }
 
-    async getBlogPost(id){
+    async getBlogPost(id) {
         const options = {
             url: `${this.baseUrl}${this.URLs.blogPostById(id)}`,
         };
         return this._get(options);
     }
 
-    async updateBlogPost(objId, body, isDraft=false) {
+    async updateBlogPost(objId, body, isDraft = false) {
         const draft = isDraft ? '/draft' : ''
         const options = {
             url: `${this.baseUrl}${this.URLs.blogPostById(objId)}${draft}`,
             body: body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._patch(options);
     }
 
-    async pushBlogPostDraftToLive(objId){
+    async pushBlogPostDraftToLive(objId) {
         const options = {
             url: `${this.baseUrl}${this.URLs.blogPostById(objId)}/draft/push-live`,
         };
@@ -905,18 +778,13 @@ class Api extends OAuth2Requester {
                 id: objId,
                 publishDate
             },
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._post(options);
     }
 
     // ***********************   Email Templates   **************************
 
-    async getEmailTemplates(query=''){
+    async getEmailTemplates(query = '') {
         const options = {
             url: `${this.baseUrl}${this.URLs.emailTemplates}`,
         };
@@ -926,7 +794,7 @@ class Api extends OAuth2Requester {
         return this._get(options);
     }
 
-    async getEmailTemplate(id){
+    async getEmailTemplate(id) {
         const options = {
             url: `${this.baseUrl}${this.URLs.emailTemplateById(id)}`,
         };
@@ -937,11 +805,6 @@ class Api extends OAuth2Requester {
         const options = {
             url: `${this.baseUrl}${this.URLs.emailTemplateById(objId)}`,
             body: body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._put(options);
     }
@@ -950,16 +813,11 @@ class Api extends OAuth2Requester {
         const options = {
             url: `${this.baseUrl}${this.URLs.emailTemplates}`,
             body: body,
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-
-            }
         };
         return this._post(options);
     }
 
-    async deleteEmailTemplate(id){
+    async deleteEmailTemplate(id) {
         const options = {
             url: `${this.baseUrl}${this.URLs.emailTemplateById(id)}`,
         };
@@ -973,7 +831,7 @@ class Api extends OAuth2Requester {
             url: this.baseUrl + this.URLs.userDetails,
         });
         const url2 = this.URLs.domain(this.access_token);
-        const res2 = await this._get({ url: this.baseUrl + url2 });
+        const res2 = await this._get({url: this.baseUrl + url2});
         return Object.assign(res1, res2);
     }
 
@@ -984,29 +842,73 @@ class Api extends OAuth2Requester {
         return this._get(options);
     }
 
-    async batchGetAssociations(params) {
-        const fromObject = get(params, 'fromObject');
-        const toObject = get(params, 'toObject');
-        const inputs = get(params, 'inputs');
+    async getBatchAssociations(fromObjectType, toObjectType, inputs) {
+        const postBody = {inputs};
+
+        const options = {
+            url:
+                this.baseUrl +
+                this.URLs.readBatchAssociations(fromObjectType, toObjectType),
+            body: postBody,
+        };
+
+        const res = await this._post(options);
+        const {results} = res;
+        return results;
+    }
 
-        const postBody = { inputs };
+    async createBatchAssociations(fromObjectType, toObjectType, inputs) {
+        const postBody = {inputs};
 
         const options = {
             url:
                 this.baseUrl +
-                this.URLs.getBatchAssociations(fromObject, toObject),
+                this.URLs.createBatchAssociations(fromObjectType, toObjectType),
             body: postBody,
-            headers: {
-                'content-type': 'application/json',
-                accept: 'application/json',
-            },
         };
 
         const res = await this._post(options);
-        const { results } = res;
+        const {results} = res;
+        return results;
+    }
+
+    async createBatchAssociationsDefault(fromObjectType, toObjectType, inputs) {
+        const options = {
+            url:
+                this.baseUrl +
+                this.URLs.createBatchAssociationsDefault(fromObjectType, toObjectType),
+            body: {inputs},
+        };
+
+        const res = await this._post(options);
+        const {results} = res;
         return results;
     }
 
+    async deleteBatchAssociations(fromObjectType, toObjectType, inputs) {
+        const options = {
+            url:
+                this.baseUrl +
+                this.URLs.deleteBatchAssociations(fromObjectType, toObjectType),
+            body: {inputs},
+            returnFullRes: true,
+        };
+
+        return this._post(options);
+    }
+
+    async deleteBatchAssociationLabels(fromObjectType, toObjectType, inputs) {
+        const options = {
+            url:
+                this.baseUrl +
+                this.URLs.deleteBatchAssociationLabels(fromObjectType, toObjectType),
+            body: {inputs},
+            returnFullRes: true,
+        };
+
+        return this._post(options);
+    }
+
     async _propertiesList(objType) {
         const props = await this.listProperties(objType);
         let propsString = '';
@@ -1016,6 +918,96 @@ class Api extends OAuth2Requester {
         propsString = propsString.slice(0, propsString.length - 1);
         return propsString;
     }
+
+    async getAssociationLabels(fromObjType, toObjType) {
+        const options = {
+            url: this.baseUrl + this.URLs.associationLabels(fromObjType, toObjType),
+        };
+        return this._get(options);
+    }
+
+    async createAssociationLabel(fromObjType, toObjType, label) {
+        const options = {
+            url: this.baseUrl + this.URLs.associationLabels(fromObjType, toObjType),
+            body: label
+        };
+        return this._post(options);
+    }
+
+    async deleteAssociationLabel(fromObjType, toObjType, associationTypeId) {
+        const options = {
+            url: this.baseUrl + this.URLs.associationLabels(fromObjType, toObjType) + `/${associationTypeId}`,
+        };
+        return this._delete(options, false);
+    }
+
+    async searchLists(query = "", offset = 0, count = 500, additionalProperties = []) {
+        const options = {
+            url: this.baseUrl + this.URLs.listSearch,
+            body: {
+                query,
+                offset,
+                count,
+                additionalProperties
+            },
+        };
+        return this._post(options);
+    }
+
+    async getListById(listId) {
+        const options = {
+            url: this.baseUrl + this.URLs.listById(listId),
+        };
+        return this._get(options);
+    }
+
+    async createList(name, objectTypeId, processingType = 'MANUAL', listFolderId = null) {
+        const options = {
+            url: this.baseUrl + this.URLs.lists,
+            body: {
+                name,
+                objectTypeId,
+                processingType,
+                listFolderId
+            },
+        };
+        return this._post(options);
+    }
+
+    async deleteList(listId) {
+        const options = {
+            url: this.baseUrl + this.URLs.listById(listId),
+        };
+        return this._delete(options);
+    }
+
+    async removeAllListMembers(listId) {
+        const options = {
+            url: this.baseUrl + this.URLs.listMemberships(listId),
+        };
+        return this._delete(options);
+    }
+
+    async addAndRemoveFromList(listId, idsToAdd, idsToRemove)  {
+        const options = {
+            url: this.baseUrl + this.URLs.listMembershipsAddRemove(listId),
+            body: {
+                "recordIdsToAdd": idsToAdd,
+                "recordIdsToRemove": idsToRemove
+            },
+        };
+        return this._put(options);
+    }
+
+    async addToList(listId, recordIds)  {
+        return this.addAndRemoveFromList(listId, recordIds, []);
+    }
+
+    async removeFromList(listId, recordIds)  {
+        return this.addAndRemoveFromList(listId, [], recordIds);
+    }
+
+
 }
 
-module.exports = { Api };
+module.exports = {Api};