@friggframework/api-module-hubspot 1.1.5-canary.5.6b3e9b0.0 → 1.1.6-canary.c3fd6fe.0

package/CHANGELOG.md

@@ -1,3 +1,40 @@
+# v1.1.5 (Mon May 06 2024)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Sean Matthews ([@seanspeaks](https://github.com/seanspeaks)), for all your work!
+
+#### 🐛 Bug Fix
+
+- HubSpot API Method Updates [#5](https://github.com/friggframework/api-module-library/pull/5) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- remove .only ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- differentiate the two versions of batch association delete, generic and label specific ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- correct inherited parameter naming (confusion between object and object type) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- add method for clearing list ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Merge branch 'refs/heads/main' into feature/42m-needed-hubspot-api-methods ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- property update working ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- update implementation of properties methods ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- association label and association batch requests implemented and tested ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+- remove .only tests [#3](https://github.com/friggframework/api-module-library/pull/3) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- update to getListById to follow convention in this api at least [#3](https://github.com/friggframework/api-module-library/pull/3) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- add getList [#3](https://github.com/friggframework/api-module-library/pull/3) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- remove client reference [#3](https://github.com/friggframework/api-module-library/pull/3) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- add list addition, creation, deletion [#3](https://github.com/friggframework/api-module-library/pull/3) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- remove unnecessary dependency [#1](https://github.com/friggframework/api-module-library/pull/1) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- add methods and tests for list search and label retrieval [#1](https://github.com/friggframework/api-module-library/pull/1) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+
+#### ⚠️ Pushed to `main`
+
+- Publish ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
 # v1.1.4 (Wed Apr 17 2024)
 
 #### 🐛 Bug Fix

package/api.js

@@ -26,14 +26,16 @@ class Api extends OAuth2Requester {
             deals: '/crm/v3/objects/deals',
             dealById: (dealId) => `/crm/v3/objects/deals/${dealId}`,
             searchDeals: '/crm/v3/objects/deals/search',
-            readBatchAssociations: (fromObject, toObject) =>
-                `/crm/v4/associations/${fromObject}/${toObject}/batch/read`,
-            createBatchAssociations: (fromObject, toObject) =>
-                `/crm/v4/associations/${fromObject}/${toObject}/batch/create`,
-            createBatchAssociationsDefault: (fromObject, toObject) =>
-                `/crm/v4/associations/${fromObject}/${toObject}/batch/associate/default`,
-            deleteBatchAssociations: (fromObject, toObject) =>
-                `/crm/v4/associations/${fromObject}/${toObject}/batch/labels/archive`,
+            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}`,
@@ -65,7 +67,8 @@ class Api extends OAuth2Requester {
             lists: '/crm/v3/lists',
             listById: (listId) => `/crm/v3/lists/${listId}`,
             listSearch: '/crm/v3/lists/search',
-            listMembership: (listId) => `/crm/v3/lists/${listId}/memberships/add-and-remove`,
+            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`,
 
@@ -895,13 +898,13 @@ class Api extends OAuth2Requester {
         return this._get(options);
     }
 
-    async getBatchAssociations(fromObject, toObject, inputs) {
+    async getBatchAssociations(fromObjectType, toObjectType, inputs) {
         const postBody = {inputs};
 
         const options = {
             url:
                 this.baseUrl +
-                this.URLs.readBatchAssociations(fromObject, toObject),
+                this.URLs.readBatchAssociations(fromObjectType, toObjectType),
             body: postBody,
         };
 
@@ -910,13 +913,13 @@ class Api extends OAuth2Requester {
         return results;
     }
 
-    async createBatchAssociations(fromObject, toObject, inputs) {
+    async createBatchAssociations(fromObjectType, toObjectType, inputs) {
         const postBody = {inputs};
 
         const options = {
             url:
                 this.baseUrl +
-                this.URLs.createBatchAssociations(fromObject, toObject),
+                this.URLs.createBatchAssociations(fromObjectType, toObjectType),
             body: postBody,
         };
 
@@ -925,11 +928,11 @@ class Api extends OAuth2Requester {
         return results;
     }
 
-    async createBatchAssociationsDefault(fromObject, toObject, inputs) {
+    async createBatchAssociationsDefault(fromObjectType, toObjectType, inputs) {
         const options = {
             url:
                 this.baseUrl +
-                this.URLs.createBatchAssociationsDefault(fromObject, toObject),
+                this.URLs.createBatchAssociationsDefault(fromObjectType, toObjectType),
             body: {inputs},
         };
 
@@ -938,11 +941,23 @@ class Api extends OAuth2Requester {
         return results;
     }
 
-    async deleteBatchAssociations(fromObject, toObject, inputs) {
+    async deleteBatchAssociations(fromObjectType, toObjectType, inputs) {
         const options = {
             url:
                 this.baseUrl +
-                this.URLs.deleteBatchAssociations(fromObject, toObject),
+                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,
         };
@@ -1022,15 +1037,33 @@ class Api extends OAuth2Requester {
         return this._delete(options);
     }
 
-    async addToList(listId, recordIds)  {
+    async removeAllListMembers(listId) {
         const options = {
-            url: this.baseUrl + this.URLs.listMembership(listId),
+            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": recordIds
+                "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};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/api-module-hubspot",
-  "version": "1.1.5-canary.5.6b3e9b0.0",
+  "version": "1.1.6-canary.c3fd6fe.0",
   "prettier": "@friggframework/prettier-config",
   "description": "HubSpot API module that lets the Frigg Framework interact with HubSpot",
   "main": "index.js",
@@ -17,10 +17,11 @@
     "eslint": "^8.22.0",
     "jest": "^28.1.3",
     "jest-environment-jsdom": "^28.1.3",
+    "open": "^10.1.0",
     "prettier": "^2.7.1"
   },
   "dependencies": {
     "@friggframework/core": "^1.1.2"
   },
-  "gitHead": "6b3e9b043087fc09a9c0bb1bb2c078167b6896e9"
+  "gitHead": "c3fd6fed4e780d492e18d81d9b62782eb7165a49"
 }

package/tests/api.test.js

@@ -732,6 +732,10 @@ describe(`${config.label} API tests`, () => {
             // HS has a typo in the response "recordsIds" instead of "recordIds"
             expect(response.recordsIdsAdded).toHaveLength(1);
         })
+        it('Should remove all records from list', async () => {
+            const response = await api.removeAllListMembers(createdListId);
+            expect(response.status).toBe(204);
+        })
         it('Should delete a list', async () => {
             const response = await api.deleteList(createdListId);
             expect(response).toBeDefined();
@@ -859,7 +863,7 @@ describe(`${config.label} API tests`, () => {
                     to: {id: toCompany}
                 }
             });
-            const response = await api.deleteBatchAssociations(
+            const response = await api.deleteBatchAssociationLabels(
                 testObjType,
                 'COMPANY',
                 inputs
@@ -889,7 +893,7 @@ describe(`${config.label} API tests`, () => {
         });
     });
 
-    describe.only('Properties requests', () => {
+    describe('Properties requests', () => {
         let groupeName;
         it('Should retrieve a property', async () => {
             const response = await api.getPropertyByName('tests', 'word');