fix: regression in getter method namings

Author: ayZagen

CHANGELOG.md

@@ -1,7 +1,18 @@
 ## 2.0.0 (2024-11-25)
 
 ### Breaking Changes
-
+* tenant administrator methods moved to separate entity
 * Sub entity method names are changed to be more user friendly and descriptive.
   List of changed methods:
 
+  | old               | new                 |
+  |-------------------|---------------------|
+  | `roles`           |                     |
+  | addPermissions    | assignPermissions   |
+  | removePermissions | unassignPermissions |
+  | removeRoles       | unassignRoles       |
+  | `roleGroups`      |                     |
+  | addRoles          | assignRoles         |
+  | addRoleGroups     | assignRoleGroups    |
+  | removeRoles       | unassignRoles       |
+

dist/plusauth-rest-js.cjs

@@ -259,31 +259,31 @@ var CustomDomainService = class extends HttpService {
    * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
    * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
    */
-  async getAll(queryParams) {
+  async getCustomDomains(queryParams) {
     return await this.http.get(`/custom-domain/${encodedQueryString(queryParams)}`);
   }
   /**
    * @param data Tenant Custom Domain object
    */
-  async register(data) {
+  async registerCustomDomain(data) {
     return await this.http.post(`/custom-domain/`, data);
   }
   /**
    * @param domain Custom Domain specifier
    */
-  async get(domain) {
+  async getCustomDomain(domain) {
     return await this.http.get(`/custom-domain/$${domain}`);
   }
   /**
    * @param domain Custom Domain specifier
    */
-  async remove(domain) {
+  async removeCustomDomain(domain) {
     return await this.http.delete(`/custom-domain/$${domain}`);
   }
   /**
    * @param domain Custom Domain specifier
    */
-  async verifyOwnership(domain) {
+  async verifyCustomDomainOwnership(domain) {
     return await this.http.get(`/custom-domain/$${domain}/verify`);
   }
 };
@@ -656,52 +656,52 @@ var RoleGroupService = class extends HttpService {
    * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
    * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
    */
-  async getAll(queryParams) {
+  async getRoleGroups(queryParams) {
     return await this.http.get(`/role-groups/${encodedQueryString(queryParams)}`);
   }
   /**
    * @param data Role Group object
    */
-  async create(data) {
+  async createRoleGroup(data) {
     return await this.http.post(`/role-groups/`, data);
   }
   /**
    * @param roleGroupId Role Group identifier
    */
-  async get(roleGroupId) {
+  async getRoleGroup(roleGroupId) {
     return await this.http.get(`/role-groups/${roleGroupId}`);
   }
   /**
    * @param roleGroupId Role Group identifier
    * @param data Object containing to be updated values
    */
-  async update(roleGroupId, data) {
+  async updateRoleGroup(roleGroupId, data) {
     return await this.http.patch(`/role-groups/${roleGroupId}`, data);
   }
   /**
    * @param roleGroupId Role Group identifier
    */
-  async remove(roleGroupId) {
+  async removeRoleGroup(roleGroupId) {
     return await this.http.delete(`/role-groups/${roleGroupId}`);
   }
   /**
    * @param roleGroupId Role Group identifier
    */
-  async getRoles(roleGroupId) {
+  async getRoleGroupRoles(roleGroupId) {
     return await this.http.get(`/role-groups/${roleGroupId}/roles`);
   }
   /**
    * @param roleGroupId Role Group identifier
    * @param roleIdList List of role ID's to be assigned to the role group
    */
-  async assignRoles(roleGroupId, roleIdList) {
+  async assignRolesToRoleGroup(roleGroupId, roleIdList) {
     return await this.http.post(`/role-groups/${roleGroupId}/roles`, roleIdList);
   }
   /**
    * @param roleGroupId Role Group identifier
    * @param roleIdList List of role ID's to be unassigned from the role group
    */
-  async unassignRoles(roleGroupId, roleIdList) {
+  async unassignRolesFromRoleGroup(roleGroupId, roleIdList) {
     return await this.http.delete(`/role-groups/${roleGroupId}/roles`, roleIdList);
   }
   /**
@@ -713,7 +713,7 @@ var RoleGroupService = class extends HttpService {
    * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
    * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
    */
-  async getUsers(roleGroupId, queryParams) {
+  async getRoleGroupUsers(roleGroupId, queryParams) {
     return await this.http.get(`/role-groups/${roleGroupId}/users${encodedQueryString(queryParams)}`);
   }
 };
@@ -750,20 +750,20 @@ var TenantAdministratorService = class extends HttpService {
    * @param tenantId Tenant identifier
    * @param invitationDetails Invitation details
    */
-  async invite(tenantId, invitationDetails) {
+  async inviteTenantAdministrator(tenantId, invitationDetails) {
     return await this.http.post(`/tenants/${tenantId}/invite`, invitationDetails);
   }
   /**
    * @param tenantId Tenant identifier
    */
-  async getAll(tenantId) {
+  async getTenantAdministrators(tenantId) {
     return await this.http.get(`/tenants/${tenantId}/administrators`);
   }
   /**
    * @param tenantId Tenant identifier
    * @param adminId Administrator identifier
    */
-  async remove(tenantId, adminId) {
+  async removeTenantAdministrator(tenantId, adminId) {
     return await this.http.delete(`/tenants/${tenantId}/administrators/${adminId}`);
   }
   /**

dist/plusauth-rest-js.d.ts

@@ -3135,7 +3135,7 @@ declare class CustomDomainService extends HttpService {
      * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
      * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
      */
-    getAll(queryParams?: {
+    getCustomDomains(queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;
@@ -3145,19 +3145,19 @@ declare class CustomDomainService extends HttpService {
     /**
      * @param data Tenant Custom Domain object
      */
-    register(data: CreateTenantCustomDomain): Promise<TenantCustomDomain>;
+    registerCustomDomain(data: CreateTenantCustomDomain): Promise<TenantCustomDomain>;
     /**
      * @param domain Custom Domain specifier
      */
-    get(domain: string): Promise<TenantCustomDomain>;
+    getCustomDomain(domain: string): Promise<TenantCustomDomain>;
     /**
      * @param domain Custom Domain specifier
      */
-    remove(domain: string): Promise<void>;
+    removeCustomDomain(domain: string): Promise<void>;
     /**
      * @param domain Custom Domain specifier
      */
-    verifyOwnership(domain: string): Promise<Record<string, any>>;
+    verifyCustomDomainOwnership(domain: string): Promise<Record<string, any>>;
 }
 
 /**
@@ -6294,7 +6294,7 @@ declare class RoleGroupService extends HttpService {
      * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
      * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
      */
-    getAll(queryParams?: {
+    getRoleGroups(queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;
@@ -6304,34 +6304,34 @@ declare class RoleGroupService extends HttpService {
     /**
      * @param data Role Group object
      */
-    create(data: CreateRoleGroup): Promise<RoleGroup>;
+    createRoleGroup(data: CreateRoleGroup): Promise<RoleGroup>;
     /**
      * @param roleGroupId Role Group identifier
      */
-    get(roleGroupId: string): Promise<RoleGroup>;
+    getRoleGroup(roleGroupId: string): Promise<RoleGroup>;
     /**
      * @param roleGroupId Role Group identifier
      * @param data Object containing to be updated values
      */
-    update(roleGroupId: string, data: UpdateRoleGroup): Promise<RoleGroup>;
+    updateRoleGroup(roleGroupId: string, data: UpdateRoleGroup): Promise<RoleGroup>;
     /**
      * @param roleGroupId Role Group identifier
      */
-    remove(roleGroupId: string): Promise<void>;
+    removeRoleGroup(roleGroupId: string): Promise<void>;
     /**
      * @param roleGroupId Role Group identifier
      */
-    getRoles(roleGroupId: string): Promise<Record<string, any>>;
+    getRoleGroupRoles(roleGroupId: string): Promise<Record<string, any>>;
     /**
      * @param roleGroupId Role Group identifier
      * @param roleIdList List of role ID's to be assigned to the role group
      */
-    assignRoles(roleGroupId: string, roleIdList: string[]): Promise<void>;
+    assignRolesToRoleGroup(roleGroupId: string, roleIdList: string[]): Promise<void>;
     /**
      * @param roleGroupId Role Group identifier
      * @param roleIdList List of role ID's to be unassigned from the role group
      */
-    unassignRoles(roleGroupId: string, roleIdList: string[]): Promise<void>;
+    unassignRolesFromRoleGroup(roleGroupId: string, roleIdList: string[]): Promise<void>;
     /**
      * @param roleGroupId Role Group identifier
      * @param queryParams Query parameters
@@ -6341,7 +6341,7 @@ declare class RoleGroupService extends HttpService {
      * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
      * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
      */
-    getUsers(roleGroupId: string, queryParams?: {
+    getRoleGroupUsers(roleGroupId: string, queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;
@@ -7701,19 +7701,19 @@ declare class TenantAdministratorService extends HttpService {
      * @param tenantId Tenant identifier
      * @param invitationDetails Invitation details
      */
-    invite(tenantId: string, invitationDetails: {
+    inviteTenantAdministrator(tenantId: string, invitationDetails: {
         email: string;
         permissions?: string[];
     }): Promise<void>;
     /**
      * @param tenantId Tenant identifier
      */
-    getAll(tenantId: string): Promise<TenantAdministrator[]>;
+    getTenantAdministrators(tenantId: string): Promise<TenantAdministrator[]>;
     /**
      * @param tenantId Tenant identifier
      * @param adminId Administrator identifier
      */
-    remove(tenantId: string, adminId: string): Promise<void>;
+    removeTenantAdministrator(tenantId: string, adminId: string): Promise<void>;
     /**
      * @param tenantId Tenant identifier
      * @param adminId Administrator identifier

dist/plusauth-rest-js.global.js

@@ -221,31 +221,31 @@ var CustomDomainService = class extends HttpService {
    * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
    * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
    */
-  async getAll(queryParams) {
+  async getCustomDomains(queryParams) {
     return await this.http.get(`/custom-domain/${encodedQueryString(queryParams)}`);
   }
   /**
    * @param data Tenant Custom Domain object
    */
-  async register(data) {
+  async registerCustomDomain(data) {
     return await this.http.post(`/custom-domain/`, data);
   }
   /**
    * @param domain Custom Domain specifier
    */
-  async get(domain) {
+  async getCustomDomain(domain) {
     return await this.http.get(`/custom-domain/$${domain}`);
   }
   /**
    * @param domain Custom Domain specifier
    */
-  async remove(domain) {
+  async removeCustomDomain(domain) {
     return await this.http.delete(`/custom-domain/$${domain}`);
   }
   /**
    * @param domain Custom Domain specifier
    */
-  async verifyOwnership(domain) {
+  async verifyCustomDomainOwnership(domain) {
     return await this.http.get(`/custom-domain/$${domain}/verify`);
   }
 };
@@ -618,52 +618,52 @@ var RoleGroupService = class extends HttpService {
    * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
    * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
    */
-  async getAll(queryParams) {
+  async getRoleGroups(queryParams) {
     return await this.http.get(`/role-groups/${encodedQueryString(queryParams)}`);
   }
   /**
    * @param data Role Group object
    */
-  async create(data) {
+  async createRoleGroup(data) {
     return await this.http.post(`/role-groups/`, data);
   }
   /**
    * @param roleGroupId Role Group identifier
    */
-  async get(roleGroupId) {
+  async getRoleGroup(roleGroupId) {
     return await this.http.get(`/role-groups/${roleGroupId}`);
   }
   /**
    * @param roleGroupId Role Group identifier
    * @param data Object containing to be updated values
    */
-  async update(roleGroupId, data) {
+  async updateRoleGroup(roleGroupId, data) {
     return await this.http.patch(`/role-groups/${roleGroupId}`, data);
   }
   /**
    * @param roleGroupId Role Group identifier
    */
-  async remove(roleGroupId) {
+  async removeRoleGroup(roleGroupId) {
     return await this.http.delete(`/role-groups/${roleGroupId}`);
   }
   /**
    * @param roleGroupId Role Group identifier
    */
-  async getRoles(roleGroupId) {
+  async getRoleGroupRoles(roleGroupId) {
     return await this.http.get(`/role-groups/${roleGroupId}/roles`);
   }
   /**
    * @param roleGroupId Role Group identifier
    * @param roleIdList List of role ID's to be assigned to the role group
    */
-  async assignRoles(roleGroupId, roleIdList) {
+  async assignRolesToRoleGroup(roleGroupId, roleIdList) {
     return await this.http.post(`/role-groups/${roleGroupId}/roles`, roleIdList);
   }
   /**
    * @param roleGroupId Role Group identifier
    * @param roleIdList List of role ID's to be unassigned from the role group
    */
-  async unassignRoles(roleGroupId, roleIdList) {
+  async unassignRolesFromRoleGroup(roleGroupId, roleIdList) {
     return await this.http.delete(`/role-groups/${roleGroupId}/roles`, roleIdList);
   }
   /**
@@ -675,7 +675,7 @@ var RoleGroupService = class extends HttpService {
    * @param queryParams.sort_by Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.
    * @param queryParams.fields Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
    */
-  async getUsers(roleGroupId, queryParams) {
+  async getRoleGroupUsers(roleGroupId, queryParams) {
     return await this.http.get(`/role-groups/${roleGroupId}/users${encodedQueryString(queryParams)}`);
   }
 };
@@ -712,20 +712,20 @@ var TenantAdministratorService = class extends HttpService {
    * @param tenantId Tenant identifier
    * @param invitationDetails Invitation details
    */
-  async invite(tenantId, invitationDetails) {
+  async inviteTenantAdministrator(tenantId, invitationDetails) {
     return await this.http.post(`/tenants/${tenantId}/invite`, invitationDetails);
   }
   /**
    * @param tenantId Tenant identifier
    */
-  async getAll(tenantId) {
+  async getTenantAdministrators(tenantId) {
     return await this.http.get(`/tenants/${tenantId}/administrators`);
   }
   /**
    * @param tenantId Tenant identifier
    * @param adminId Administrator identifier
    */
-  async remove(tenantId, adminId) {
+  async removeTenantAdministrator(tenantId, adminId) {
     return await this.http.delete(`/tenants/${tenantId}/administrators/${adminId}`);
   }
   /**