@workbuddy/sdk-js-vnext 1.0.58 → 1.0.60

package/index.js

@@ -520,7 +520,7 @@ export class WorkBuddyClient {
     this.settings = {
       entityStatuses: {
         /**
-         * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier
+         * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user
          * Operation: PublicApiEntityStatusController_list
          */
         list: (params = {}, options = {}) => this.request('PublicApiEntityStatusController_list', params, options),
@@ -684,6 +684,24 @@ export class WorkBuddyClient {
             this.request('PublicApiCustomFieldController_listItemCustomFields', params, options),
         },
       },
+      roles: {
+        clientPortal: {
+          /**
+           * Roles assignable to customer login contacts (UserType.Client). Includes custom client roles; includes built-in system client roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.
+           * Operation: PublicApiPortalRoleController_listClientPortal
+           */
+          list: (params = {}, options = {}) =>
+            this.request('PublicApiPortalRoleController_listClientPortal', params, options),
+        },
+        contractorPortal: {
+          /**
+           * Roles assignable to contractor login contacts (UserType.Subcontractor). Includes custom contractor roles; includes built-in system contractor roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.
+           * Operation: PublicApiPortalRoleController_listContractorPortal
+           */
+          list: (params = {}, options = {}) =>
+            this.request('PublicApiPortalRoleController_listContractorPortal', params, options),
+        },
+      },
     };
 
     this.attachments = {
@@ -731,28 +749,12 @@ export class WorkBuddyClient {
         contacts: {
           invite: {
             /**
-             * Promote an existing contact to external user and send invite (CRM)
+             * Invite contact (CRM)
              * Operation: PublicCrmCustomerController_inviteContact
              */
             inviteContact: (params = {}, options = {}) =>
               this.request('PublicCrmCustomerController_inviteContact', params, options),
           },
-          activate: {
-            /**
-             * Unlock portal login for an external user (CRM)
-             * Operation: PublicCrmCustomerController_activateContact
-             */
-            activateContact: (params = {}, options = {}) =>
-              this.request('PublicCrmCustomerController_activateContact', params, options),
-          },
-          deactivate: {
-            /**
-             * Lock portal login for an external user (CRM)
-             * Operation: PublicCrmCustomerController_deactivateContact
-             */
-            deactivateContact: (params = {}, options = {}) =>
-              this.request('PublicCrmCustomerController_deactivateContact', params, options),
-          },
           /**
            * List contacts for customer (contacts + external users)
            * Operation: PublicCrmCustomerController_listContacts
@@ -766,23 +768,11 @@ export class WorkBuddyClient {
           pages: (params = {}, options = {}) =>
             this.paginatePages('PublicCrmCustomerController_listContacts', params, options),
           /**
-           * Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
+           * Create customer contact
            * Operation: PublicCrmCustomerController_createContact
            */
           createContact: (params = {}, options = {}) =>
             this.request('PublicCrmCustomerController_createContact', params, options),
-          /**
-           * Get customer contact by ID
-           * Operation: PublicCrmCustomerController_getContact
-           */
-          getContact: (params = {}, options = {}) =>
-            this.request('PublicCrmCustomerController_getContact', params, options),
-          /**
-           * Update customer contact
-           * Operation: PublicCrmCustomerController_updateContact
-           */
-          updateContact: (params = {}, options = {}) =>
-            this.request('PublicCrmCustomerController_updateContact', params, options),
           /**
            * Delete customer contact
            * Operation: PublicCrmCustomerController_deleteContact
@@ -855,28 +845,12 @@ export class WorkBuddyClient {
         contacts: {
           invite: {
             /**
-             * Promote an existing contact to external user and send invite (CRM > Contractors)
+             * Invite contact (CRM > Contractors)
              * Operation: PublicCrmContractorController_inviteContact
              */
             inviteContact: (params = {}, options = {}) =>
               this.request('PublicCrmContractorController_inviteContact', params, options),
           },
-          activate: {
-            /**
-             * Unlock portal login for an external user (CRM > Contractors)
-             * Operation: PublicCrmContractorController_activateContact
-             */
-            activateContact: (params = {}, options = {}) =>
-              this.request('PublicCrmContractorController_activateContact', params, options),
-          },
-          deactivate: {
-            /**
-             * Lock portal login for an external user (CRM > Contractors)
-             * Operation: PublicCrmContractorController_deactivateContact
-             */
-            deactivateContact: (params = {}, options = {}) =>
-              this.request('PublicCrmContractorController_deactivateContact', params, options),
-          },
           /**
            * List contacts for contractor (contacts + external users)
            * Operation: PublicCrmContractorController_listContacts
@@ -890,23 +864,11 @@ export class WorkBuddyClient {
           pages: (params = {}, options = {}) =>
             this.paginatePages('PublicCrmContractorController_listContacts', params, options),
           /**
-           * Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
+           * Create contractor contact
            * Operation: PublicCrmContractorController_createContact
            */
           createContact: (params = {}, options = {}) =>
             this.request('PublicCrmContractorController_createContact', params, options),
-          /**
-           * Get contractor contact by ID
-           * Operation: PublicCrmContractorController_getContact
-           */
-          getContact: (params = {}, options = {}) =>
-            this.request('PublicCrmContractorController_getContact', params, options),
-          /**
-           * Update contractor contact
-           * Operation: PublicCrmContractorController_updateContact
-           */
-          updateContact: (params = {}, options = {}) =>
-            this.request('PublicCrmContractorController_updateContact', params, options),
           /**
            * Delete contractor contact
            * Operation: PublicCrmContractorController_deleteContact
@@ -1007,8 +969,16 @@ export class WorkBuddyClient {
         get: (params = {}, options = {}) => this.request('PublicCrmExternalUserController_getById', params, options),
       },
       contacts: {
+        status: {
+          /**
+           * Update contact status
+           * Operation: PublicCrmContactController_updateStatus
+           */
+          updateStatus: (params = {}, options = {}) =>
+            this.request('PublicCrmContactController_updateStatus', params, options),
+        },
         /**
-         * List contacts (Basic and Login contacts)
+         * List contacts (contacts + external users)
          * Operation: PublicCrmContactController_list
          */
         list: (params = {}, options = {}) => this.request('PublicCrmContactController_list', params, options),
@@ -1021,6 +991,11 @@ export class WorkBuddyClient {
          * Operation: PublicCrmContactController_getById
          */
         get: (params = {}, options = {}) => this.request('PublicCrmContactController_getById', params, options),
+        /**
+         * Update contact
+         * Operation: PublicCrmContactController_update
+         */
+        update: (params = {}, options = {}) => this.request('PublicCrmContactController_update', params, options),
       },
       invites: {
         /**
@@ -1792,7 +1767,7 @@ export const operations = [
     actionName: 'list',
     displayName: 'List entity statuses',
     description:
-      'Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier',
+      'Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user',
     method: 'GET',
     path: '/settings/entity-statuses/{entity}',
     pathParams: ['entity'],
@@ -2085,6 +2060,32 @@ export const operations = [
     queryParams: [],
     hasRequestBody: false,
   },
+  {
+    operationId: 'PublicApiPortalRoleController_listClientPortal',
+    resourcePath: ['settings', 'roles', 'clientPortal'],
+    actionName: 'list',
+    displayName: 'List client portal roles',
+    description:
+      'Roles assignable to customer login contacts (UserType.Client). Includes custom client roles; includes built-in system client roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.',
+    method: 'GET',
+    path: '/settings/roles/client-portal',
+    pathParams: [],
+    queryParams: [],
+    hasRequestBody: false,
+  },
+  {
+    operationId: 'PublicApiPortalRoleController_listContractorPortal',
+    resourcePath: ['settings', 'roles', 'contractorPortal'],
+    actionName: 'list',
+    displayName: 'List contractor portal roles',
+    description:
+      'Roles assignable to contractor login contacts (UserType.Subcontractor). Includes custom contractor roles; includes built-in system contractor roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.',
+    method: 'GET',
+    path: '/settings/roles/contractor-portal',
+    pathParams: [],
+    queryParams: [],
+    hasRequestBody: false,
+  },
   {
     operationId: 'PublicAttachmentController_createUploadSession',
     resourcePath: ['attachments'],
@@ -2695,40 +2696,14 @@ export const operations = [
     operationId: 'PublicCrmCustomerController_createContact',
     resourcePath: ['crm', 'customers', 'contacts'],
     actionName: 'createContact',
-    displayName:
-      'Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
-    description:
-      'Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
+    displayName: 'Create customer contact',
+    description: 'Create customer contact',
     method: 'POST',
     path: '/customers/{customerId}/contacts',
     pathParams: ['customerId'],
     queryParams: [],
     hasRequestBody: true,
   },
-  {
-    operationId: 'PublicCrmCustomerController_getContact',
-    resourcePath: ['crm', 'customers', 'contacts'],
-    actionName: 'getContact',
-    displayName: 'Get customer contact by ID',
-    description: 'Get customer contact by ID',
-    method: 'GET',
-    path: '/customers/{customerId}/contacts/{contactId}',
-    pathParams: ['customerId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: false,
-  },
-  {
-    operationId: 'PublicCrmCustomerController_updateContact',
-    resourcePath: ['crm', 'customers', 'contacts'],
-    actionName: 'updateContact',
-    displayName: 'Update customer contact',
-    description: 'Update customer contact',
-    method: 'PATCH',
-    path: '/customers/{customerId}/contacts/{contactId}',
-    pathParams: ['customerId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: true,
-  },
   {
     operationId: 'PublicCrmCustomerController_deleteContact',
     resourcePath: ['crm', 'customers', 'contacts'],
@@ -2745,38 +2720,14 @@ export const operations = [
     operationId: 'PublicCrmCustomerController_inviteContact',
     resourcePath: ['crm', 'customers', 'contacts', 'invite'],
     actionName: 'inviteContact',
-    displayName: 'Promote an existing contact to external user and send invite (CRM)',
-    description: 'Promote an existing contact to external user and send invite (CRM)',
+    displayName: 'Invite contact (CRM)',
+    description: 'Invite contact (CRM)',
     method: 'POST',
     path: '/customers/{customerId}/contacts/{contactId}/invite',
     pathParams: ['customerId', 'contactId'],
     queryParams: [],
     hasRequestBody: true,
   },
-  {
-    operationId: 'PublicCrmCustomerController_activateContact',
-    resourcePath: ['crm', 'customers', 'contacts', 'activate'],
-    actionName: 'activateContact',
-    displayName: 'Unlock portal login for an external user (CRM)',
-    description: 'Unlock portal login for an external user (CRM)',
-    method: 'POST',
-    path: '/customers/{customerId}/contacts/{contactId}/activate',
-    pathParams: ['customerId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: false,
-  },
-  {
-    operationId: 'PublicCrmCustomerController_deactivateContact',
-    resourcePath: ['crm', 'customers', 'contacts', 'deactivate'],
-    actionName: 'deactivateContact',
-    displayName: 'Lock portal login for an external user (CRM)',
-    description: 'Lock portal login for an external user (CRM)',
-    method: 'POST',
-    path: '/customers/{customerId}/contacts/{contactId}/deactivate',
-    pathParams: ['customerId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: false,
-  },
   {
     operationId: 'PublicCrmCustomerController_listSites',
     resourcePath: ['crm', 'customers', 'sites'],
@@ -2897,40 +2848,14 @@ export const operations = [
     operationId: 'PublicCrmContractorController_createContact',
     resourcePath: ['crm', 'contractors', 'contacts'],
     actionName: 'createContact',
-    displayName:
-      'Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
-    description:
-      'Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
+    displayName: 'Create contractor contact',
+    description: 'Create contractor contact',
     method: 'POST',
     path: '/contractors/{contractorId}/contacts',
     pathParams: ['contractorId'],
     queryParams: [],
     hasRequestBody: true,
   },
-  {
-    operationId: 'PublicCrmContractorController_getContact',
-    resourcePath: ['crm', 'contractors', 'contacts'],
-    actionName: 'getContact',
-    displayName: 'Get contractor contact by ID',
-    description: 'Get contractor contact by ID',
-    method: 'GET',
-    path: '/contractors/{contractorId}/contacts/{contactId}',
-    pathParams: ['contractorId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: false,
-  },
-  {
-    operationId: 'PublicCrmContractorController_updateContact',
-    resourcePath: ['crm', 'contractors', 'contacts'],
-    actionName: 'updateContact',
-    displayName: 'Update contractor contact',
-    description: 'Update contractor contact',
-    method: 'PATCH',
-    path: '/contractors/{contractorId}/contacts/{contactId}',
-    pathParams: ['contractorId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: true,
-  },
   {
     operationId: 'PublicCrmContractorController_deleteContact',
     resourcePath: ['crm', 'contractors', 'contacts'],
@@ -2947,38 +2872,14 @@ export const operations = [
     operationId: 'PublicCrmContractorController_inviteContact',
     resourcePath: ['crm', 'contractors', 'contacts', 'invite'],
     actionName: 'inviteContact',
-    displayName: 'Promote an existing contact to external user and send invite (CRM > Contractors)',
-    description: 'Promote an existing contact to external user and send invite (CRM > Contractors)',
+    displayName: 'Invite contact (CRM > Contractors)',
+    description: 'Invite contact (CRM > Contractors)',
     method: 'POST',
     path: '/contractors/{contractorId}/contacts/{contactId}/invite',
     pathParams: ['contractorId', 'contactId'],
     queryParams: [],
     hasRequestBody: true,
   },
-  {
-    operationId: 'PublicCrmContractorController_activateContact',
-    resourcePath: ['crm', 'contractors', 'contacts', 'activate'],
-    actionName: 'activateContact',
-    displayName: 'Unlock portal login for an external user (CRM > Contractors)',
-    description: 'Unlock portal login for an external user (CRM > Contractors)',
-    method: 'POST',
-    path: '/contractors/{contractorId}/contacts/{contactId}/activate',
-    pathParams: ['contractorId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: false,
-  },
-  {
-    operationId: 'PublicCrmContractorController_deactivateContact',
-    resourcePath: ['crm', 'contractors', 'contacts', 'deactivate'],
-    actionName: 'deactivateContact',
-    displayName: 'Lock portal login for an external user (CRM > Contractors)',
-    description: 'Lock portal login for an external user (CRM > Contractors)',
-    method: 'POST',
-    path: '/contractors/{contractorId}/contacts/{contactId}/deactivate',
-    pathParams: ['contractorId', 'contactId'],
-    queryParams: [],
-    hasRequestBody: false,
-  },
   {
     operationId: 'PublicCrmSupplierController_list',
     resourcePath: ['crm', 'suppliers'],
@@ -3099,8 +3000,8 @@ export const operations = [
     actionName: 'list',
     paginatedItemsActionName: 'all',
     paginatedPagesActionName: 'pages',
-    displayName: 'List contacts (Basic and Login contacts)',
-    description: 'List contacts (Basic and Login contacts)',
+    displayName: 'List contacts (contacts + external users)',
+    description: 'List contacts (contacts + external users)',
     method: 'GET',
     path: '/contacts',
     pathParams: [],
@@ -3119,6 +3020,30 @@ export const operations = [
     queryParams: [],
     hasRequestBody: false,
   },
+  {
+    operationId: 'PublicCrmContactController_update',
+    resourcePath: ['crm', 'contacts'],
+    actionName: 'update',
+    displayName: 'Update contact',
+    description: 'Update contact',
+    method: 'PATCH',
+    path: '/contacts/{id}',
+    pathParams: ['id'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
+  {
+    operationId: 'PublicCrmContactController_updateStatus',
+    resourcePath: ['crm', 'contacts', 'status'],
+    actionName: 'updateStatus',
+    displayName: 'Update contact status',
+    description: 'Update contact status',
+    method: 'PATCH',
+    path: '/contacts/{id}/status',
+    pathParams: ['id'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
   {
     operationId: 'PublicCrmInviteController_list',
     resourcePath: ['crm', 'invites'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workbuddy/sdk-js-vnext",
-  "version": "1.0.58",
+  "version": "1.0.60",
   "description": "WorkBuddy Public API JavaScript client",
   "license": "MIT",
   "type": "module",