fix: regression in getter method namings

Author: ayZagen

CHANGELOG.md

@@ -1,19 +1,7 @@
+## 2.0.0 (2024-11-25)
 
+### Breaking Changes
 
-## 2.0.0 (2024-11-25)
+* Sub entity method names are changed to be more user friendly and descriptive.
+  List of changed methods:
 
-* refactor: upgrade toolset ([0c4ed1a](https://github.com/PlusAuth/plusauth-rest-js/commit/0c4ed1a))
-* chore: release ([1679bc7](https://github.com/PlusAuth/plusauth-rest-js/commit/1679bc7))
-* chore: update dependencies ([8f92a8a](https://github.com/PlusAuth/plusauth-rest-js/commit/8f92a8a))
-* chore: update dependencies ([cb5841c](https://github.com/PlusAuth/plusauth-rest-js/commit/cb5841c))
-* chore: update dependencies ([768c904](https://github.com/PlusAuth/plusauth-rest-js/commit/768c904))
-* chore: update dependencies ([2a8222e](https://github.com/PlusAuth/plusauth-rest-js/commit/2a8222e))
-* chore: update dependencies ([5394c3e](https://github.com/PlusAuth/plusauth-rest-js/commit/5394c3e))
-* chore: update dependencies ([3251a46](https://github.com/PlusAuth/plusauth-rest-js/commit/3251a46))
-* chore: update dependencies ([937bee6](https://github.com/PlusAuth/plusauth-rest-js/commit/937bee6))
-* chore: update dependencies ([f972172](https://github.com/PlusAuth/plusauth-rest-js/commit/f972172))
-* chore: update dependencies ([9f17d5b](https://github.com/PlusAuth/plusauth-rest-js/commit/9f17d5b))
-* chore: update deps ([0cbfa58](https://github.com/PlusAuth/plusauth-rest-js/commit/0cbfa58))
-* chore: update eslint rules ([4778127](https://github.com/PlusAuth/plusauth-rest-js/commit/4778127))
-* chore: update version ([375593d](https://github.com/PlusAuth/plusauth-rest-js/commit/375593d))
-* feat!: subscription support (wip) ([be83398](https://github.com/PlusAuth/plusauth-rest-js/commit/be83398))

dist/plusauth-rest-js.cjs

@@ -449,7 +449,7 @@ var ResourceService = 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 listPermissions(resourceId, queryParams) {
+  async getPermissions(resourceId, queryParams) {
     return await this.http.get(`/resources/${resourceId}/permissions/${encodedQueryString(queryParams)}`);
   }
   /**
@@ -615,7 +615,7 @@ var RoleService = 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 listPermissions(roleId, queryParams) {
+  async getPermissions(roleId, queryParams) {
     return await this.http.get(`/roles/${roleId}/permissions${encodedQueryString(queryParams)}`);
   }
   /**
@@ -687,7 +687,7 @@ var RoleGroupService = class extends HttpService {
   /**
    * @param roleGroupId Role Group identifier
    */
-  async listRoles(roleGroupId) {
+  async getRoles(roleGroupId) {
     return await this.http.get(`/role-groups/${roleGroupId}/roles`);
   }
   /**
@@ -893,7 +893,7 @@ var UserService = 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 listPermissions(userId, queryParams) {
+  async getPermissions(userId, queryParams) {
     return await this.http.get(`/users/${userId}/permissions/${encodedQueryString(queryParams)}`);
   }
   /**
@@ -919,7 +919,7 @@ var UserService = 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 listRoles(userId, queryParams) {
+  async getRoles(userId, queryParams) {
     return await this.http.get(`/users/${userId}/roles/${encodedQueryString(queryParams)}`);
   }
   /**
@@ -945,7 +945,7 @@ var UserService = 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 listRoleGroups(userId, queryParams) {
+  async getRoleGroups(userId, queryParams) {
     return await this.http.get(`/users/${userId}/role-groups/${encodedQueryString(queryParams)}`);
   }
   /**

dist/plusauth-rest-js.d.ts

@@ -6147,7 +6147,7 @@ declare class ResourceService 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.
      */
-    listPermissions(resourceId: string, queryParams?: {
+    getPermissions(resourceId: string, queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;
@@ -6321,7 +6321,7 @@ declare class RoleGroupService extends HttpService {
     /**
      * @param roleGroupId Role Group identifier
      */
-    listRoles(roleGroupId: string): Promise<Record<string, any>>;
+    getRoles(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
@@ -6392,7 +6392,7 @@ declare class RoleService 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.
      */
-    listPermissions(roleId: string, queryParams?: {
+    getPermissions(roleId: string, queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;
@@ -13034,7 +13034,7 @@ declare class UserService 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.
      */
-    listPermissions(userId: string, queryParams?: {
+    getPermissions(userId: string, queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;
@@ -13060,7 +13060,7 @@ declare class UserService 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.
      */
-    listRoles(userId: string, queryParams?: {
+    getRoles(userId: string, queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;
@@ -13086,7 +13086,7 @@ declare class UserService 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.
      */
-    listRoleGroups(userId: string, queryParams?: {
+    getRoleGroups(userId: string, queryParams?: {
         limit?: number;
         offset?: number;
         q?: string;

dist/plusauth-rest-js.global.js

@@ -411,7 +411,7 @@ var ResourceService = 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 listPermissions(resourceId, queryParams) {
+  async getPermissions(resourceId, queryParams) {
     return await this.http.get(`/resources/${resourceId}/permissions/${encodedQueryString(queryParams)}`);
   }
   /**
@@ -577,7 +577,7 @@ var RoleService = 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 listPermissions(roleId, queryParams) {
+  async getPermissions(roleId, queryParams) {
     return await this.http.get(`/roles/${roleId}/permissions${encodedQueryString(queryParams)}`);
   }
   /**
@@ -649,7 +649,7 @@ var RoleGroupService = class extends HttpService {
   /**
    * @param roleGroupId Role Group identifier
    */
-  async listRoles(roleGroupId) {
+  async getRoles(roleGroupId) {
     return await this.http.get(`/role-groups/${roleGroupId}/roles`);
   }
   /**
@@ -855,7 +855,7 @@ var UserService = 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 listPermissions(userId, queryParams) {
+  async getPermissions(userId, queryParams) {
     return await this.http.get(`/users/${userId}/permissions/${encodedQueryString(queryParams)}`);
   }
   /**
@@ -881,7 +881,7 @@ var UserService = 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 listRoles(userId, queryParams) {
+  async getRoles(userId, queryParams) {
     return await this.http.get(`/users/${userId}/roles/${encodedQueryString(queryParams)}`);
   }
   /**
@@ -907,7 +907,7 @@ var UserService = 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 listRoleGroups(userId, queryParams) {
+  async getRoleGroups(userId, queryParams) {
     return await this.http.get(`/users/${userId}/role-groups/${encodedQueryString(queryParams)}`);
   }
   /**

dist/plusauth-rest-js.js

@@ -16,7 +16,7 @@ export class ResourceService 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 listPermissions(
+  async getPermissions(
     resourceId: string,
     queryParams?: {
       limit?: number

src/api/resources.ts

@@ -55,7 +55,7 @@ export class RoleGroupService extends HttpService {
   /**
    * @param roleGroupId Role Group identifier
    */
-  async listRoles(roleGroupId: string): Promise<Record<string, any>> {
+  async getRoles(roleGroupId: string): Promise<Record<string, any>> {
     return await this.http.get(`/role-groups/${roleGroupId}/roles`)
   }
 

src/api/roleGroups.ts

@@ -61,7 +61,7 @@ export class RoleService 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 listPermissions(
+  async getPermissions(
     roleId: string,
     queryParams?: {
       limit?: number

src/api/roles.ts

@@ -18,7 +18,7 @@ export class TicketService 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 listVerifyEmail(queryParams?: {
+  async getVerifyEmail(queryParams?: {
     limit?: number
     offset?: number
     q?: string

src/api/tickets.ts

@@ -88,7 +88,7 @@ export class UserService 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 listPermissions(
+  async getPermissions(
     userId: string,
     queryParams?: {
       limit?: number
@@ -126,7 +126,7 @@ export class UserService 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 listRoles(
+  async getRoles(
     userId: string,
     queryParams?: {
       limit?: number
@@ -164,7 +164,7 @@ export class UserService 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 listRoleGroups(
+  async getRoleGroups(
     userId: string,
     queryParams?: {
       limit?: number