@handsondigital/idplugger-admin 2.2.0 → 2.2.1

package/README.md

@@ -1,4 +1,4 @@
-## @handsondigital/idplugger-admin@2.2.0
+## @handsondigital/idplugger-admin@2.2.1
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @handsondigital/idplugger-admin@2.2.0 --save
+npm install @handsondigital/idplugger-admin@2.2.1 --save
 ```
 
 _unPublished (not recommended):_
@@ -87,7 +87,7 @@ Class | Method | HTTP request | Description
 *StepsApi* | [**stepsAllow**](docs/StepsApi.md#stepsallow) | **POST** /v3/steps/allow | Inclui uma Step em um determinado endpoint
 *StepsApi* | [**stepsIndex**](docs/StepsApi.md#stepsindex) | **GET** /v3/steps | Retorna todas as steps existentes
 *StepsApi* | [**stepsUnallow**](docs/StepsApi.md#stepsunallow) | **POST** /v3/steps/disallow | Remove uma Step de um determinado endpoint
-*UserApi* | [**adminUsersList**](docs/UserApi.md#adminuserslist) | **GET** /v3/admin/user/ | Listar usuários da API
+*UserApi* | [**adminUsersList**](docs/UserApi.md#adminuserslist) | **GET** /v3/admin/user | Listar usuários da API
 *UserApi* | [**userGrantPermissions**](docs/UserApi.md#usergrantpermissions) | **POST** /v3/admin/user/grantpermissions | Dar permissões a um usuário na API
 *UserApi* | [**userRegister**](docs/UserApi.md#userregister) | **POST** /v3/admin/user/register | Registrar usuário na API
 *UserApi* | [**userResetPassword**](docs/UserApi.md#userresetpassword) | **POST** /v3/admin/user/resetpassword | Resetar senha do usuário na API

package/api.ts

@@ -6910,12 +6910,13 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
          * @param {string} [name] Filtrar por nome (busca parcial)
          * @param {string} [role] Filtrar por role exata
          * @param {string} [include] Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions
+         * @param {number} [perPage] Quantidade de registros por página
          * @param {number} [page] Número da página para paginação
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        adminUsersList: async (username?: string, email?: string, name?: string, role?: string, include?: string, page?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/v3/admin/user/`;
+        adminUsersList: async (username?: string, email?: string, name?: string, role?: string, include?: string, perPage?: number, page?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/v3/admin/user`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -6951,6 +6952,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
                 localVarQueryParameter['_include'] = include;
             }
 
+            if (perPage !== undefined) {
+                localVarQueryParameter['_per_page'] = perPage;
+            }
+
             if (page !== undefined) {
                 localVarQueryParameter['page'] = page;
             }
@@ -7178,12 +7183,13 @@ export const UserApiFp = function(configuration?: Configuration) {
          * @param {string} [name] Filtrar por nome (busca parcial)
          * @param {string} [role] Filtrar por role exata
          * @param {string} [include] Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions
+         * @param {number} [perPage] Quantidade de registros por página
          * @param {number} [page] Número da página para paginação
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async adminUsersList(username?: string, email?: string, name?: string, role?: string, include?: string, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminUsersList200Response>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.adminUsersList(username, email, name, role, include, page, options);
+        async adminUsersList(username?: string, email?: string, name?: string, role?: string, include?: string, perPage?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminUsersList200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.adminUsersList(username, email, name, role, include, perPage, page, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['UserApi.adminUsersList']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -7272,7 +7278,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
          * @throws {RequiredError}
          */
         adminUsersList(requestParameters: UserApiAdminUsersListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<AdminUsersList200Response> {
-            return localVarFp.adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.page, options).then((request) => request(axios, basePath));
+            return localVarFp.adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.perPage, requestParameters.page, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -7368,6 +7374,13 @@ export interface UserApiAdminUsersListRequest {
      */
     readonly include?: string
 
+    /**
+     * Quantidade de registros por página
+     * @type {number}
+     * @memberof UserApiAdminUsersList
+     */
+    readonly perPage?: number
+
     /**
      * Número da página para paginação
      * @type {number}
@@ -7469,7 +7482,7 @@ export class UserApi extends BaseAPI {
      * @memberof UserApi
      */
     public adminUsersList(requestParameters: UserApiAdminUsersListRequest = {}, options?: RawAxiosRequestConfig) {
-        return UserApiFp(this.configuration).adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.page, options).then((request) => request(this.axios, this.basePath));
+        return UserApiFp(this.configuration).adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.perPage, requestParameters.page, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/dist/api.d.ts

@@ -5206,11 +5206,12 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
      * @param {string} [name] Filtrar por nome (busca parcial)
      * @param {string} [role] Filtrar por role exata
      * @param {string} [include] Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions
+     * @param {number} [perPage] Quantidade de registros por página
      * @param {number} [page] Número da página para paginação
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    adminUsersList: (username?: string, email?: string, name?: string, role?: string, include?: string, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    adminUsersList: (username?: string, email?: string, name?: string, role?: string, include?: string, perPage?: number, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Dar permissões a um usuário na API
@@ -5266,11 +5267,12 @@ export declare const UserApiFp: (configuration?: Configuration) => {
      * @param {string} [name] Filtrar por nome (busca parcial)
      * @param {string} [role] Filtrar por role exata
      * @param {string} [include] Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions
+     * @param {number} [perPage] Quantidade de registros por página
      * @param {number} [page] Número da página para paginação
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    adminUsersList(username?: string, email?: string, name?: string, role?: string, include?: string, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminUsersList200Response>>;
+    adminUsersList(username?: string, email?: string, name?: string, role?: string, include?: string, perPage?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminUsersList200Response>>;
     /**
      *
      * @summary Dar permissões a um usuário na API
@@ -5403,6 +5405,12 @@ export interface UserApiAdminUsersListRequest {
      * @memberof UserApiAdminUsersList
      */
     readonly include?: string;
+    /**
+     * Quantidade de registros por página
+     * @type {number}
+     * @memberof UserApiAdminUsersList
+     */
+    readonly perPage?: number;
     /**
      * Número da página para paginação
      * @type {number}

package/dist/api.js

@@ -3978,22 +3978,23 @@ var UserApiAxiosParamCreator = function (configuration) {
          * @param {string} [name] Filtrar por nome (busca parcial)
          * @param {string} [role] Filtrar por role exata
          * @param {string} [include] Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions
+         * @param {number} [perPage] Quantidade de registros por página
          * @param {number} [page] Número da página para paginação
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        adminUsersList: function (username_1, email_1, name_1, role_1, include_1, page_1) {
+        adminUsersList: function (username_1, email_1, name_1, role_1, include_1, perPage_1, page_1) {
             var args_1 = [];
-            for (var _i = 6; _i < arguments.length; _i++) {
-                args_1[_i - 6] = arguments[_i];
+            for (var _i = 7; _i < arguments.length; _i++) {
+                args_1[_i - 7] = arguments[_i];
             }
-            return __awaiter(_this, __spreadArray([username_1, email_1, name_1, role_1, include_1, page_1], args_1, true), void 0, function (username, email, name, role, include, page, options) {
+            return __awaiter(_this, __spreadArray([username_1, email_1, name_1, role_1, include_1, perPage_1, page_1], args_1, true), void 0, function (username, email, name, role, include, perPage, page, options) {
                 var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
                 if (options === void 0) { options = {}; }
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
-                            localVarPath = "/v3/admin/user/";
+                            localVarPath = "/v3/admin/user";
                             localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
                             if (configuration) {
                                 baseOptions = configuration.baseOptions;
@@ -4023,6 +4024,9 @@ var UserApiAxiosParamCreator = function (configuration) {
                             if (include !== undefined) {
                                 localVarQueryParameter['_include'] = include;
                             }
+                            if (perPage !== undefined) {
+                                localVarQueryParameter['_per_page'] = perPage;
+                            }
                             if (page !== undefined) {
                                 localVarQueryParameter['page'] = page;
                             }
@@ -4290,17 +4294,18 @@ var UserApiFp = function (configuration) {
          * @param {string} [name] Filtrar por nome (busca parcial)
          * @param {string} [role] Filtrar por role exata
          * @param {string} [include] Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions
+         * @param {number} [perPage] Quantidade de registros por página
          * @param {number} [page] Número da página para paginação
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        adminUsersList: function (username, email, name, role, include, page, options) {
+        adminUsersList: function (username, email, name, role, include, perPage, page, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
                 var _a, _b, _c;
                 return __generator(this, function (_d) {
                     switch (_d.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.adminUsersList(username, email, name, role, include, page, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.adminUsersList(username, email, name, role, include, perPage, page, options)];
                         case 1:
                             localVarAxiosArgs = _d.sent();
                             localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -4445,7 +4450,7 @@ var UserApiFactory = function (configuration, basePath, axios) {
          */
         adminUsersList: function (requestParameters, options) {
             if (requestParameters === void 0) { requestParameters = {}; }
-            return localVarFp.adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.page, options).then(function (request) { return request(axios, basePath); });
+            return localVarFp.adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.perPage, requestParameters.page, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          *
@@ -4525,7 +4530,7 @@ var UserApi = /** @class */ (function (_super) {
     UserApi.prototype.adminUsersList = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.UserApiFp)(this.configuration).adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.page, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.UserApiFp)(this.configuration).adminUsersList(requestParameters.username, requestParameters.email, requestParameters.name, requestParameters.role, requestParameters.include, requestParameters.perPage, requestParameters.page, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      *

package/docs/UserApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *https://api.idplugger.com*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**adminUsersList**](#adminuserslist) | **GET** /v3/admin/user/ | Listar usuários da API|
+|[**adminUsersList**](#adminuserslist) | **GET** /v3/admin/user | Listar usuários da API|
 |[**userGrantPermissions**](#usergrantpermissions) | **POST** /v3/admin/user/grantpermissions | Dar permissões a um usuário na API|
 |[**userRegister**](#userregister) | **POST** /v3/admin/user/register | Registrar usuário na API|
 |[**userResetPassword**](#userresetpassword) | **POST** /v3/admin/user/resetpassword | Resetar senha do usuário na API|
@@ -31,6 +31,7 @@ let email: string; //Filtrar por email (busca parcial) (optional) (default to un
 let name: string; //Filtrar por nome (busca parcial) (optional) (default to undefined)
 let role: string; //Filtrar por role exata (optional) (default to undefined)
 let include: string; //Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions (optional) (default to undefined)
+let perPage: number; //Quantidade de registros por página (optional) (default to undefined)
 let page: number; //Número da página para paginação (optional) (default to undefined)
 
 const { status, data } = await apiInstance.adminUsersList(
@@ -39,6 +40,7 @@ const { status, data } = await apiInstance.adminUsersList(
     name,
     role,
     include,
+    perPage,
     page
 );
 ```
@@ -52,6 +54,7 @@ const { status, data } = await apiInstance.adminUsersList(
 | **name** | [**string**] | Filtrar por nome (busca parcial) | (optional) defaults to undefined|
 | **role** | [**string**] | Filtrar por role exata | (optional) defaults to undefined|
 | **include** | [**string**] | Incluir relacionamentos (separados por vírgula). Valores aceitos: permissions | (optional) defaults to undefined|
+| **perPage** | [**number**] | Quantidade de registros por página | (optional) defaults to undefined|
 | **page** | [**number**] | Número da página para paginação | (optional) defaults to undefined|
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handsondigital/idplugger-admin",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "OpenAPI client for @handsondigital/idplugger-admin",
   "author": "OpenAPI-Generator Contributors",
   "repository": {