@tammsyr/admin-api-client 1.0.0

package/Permissions.ts

@@ -0,0 +1,130 @@
+/* eslint-disable */
+/* tslint:disable */
+// @ts-nocheck
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import {
+  CreateData,
+  CreatePermissionDto,
+  DeleteData,
+  DeleteError,
+  DeleteParams,
+  FindAllData,
+  FindAllParams,
+  FindByIdData,
+  FindByIdParams,
+  UpdateData,
+  UpdateParams,
+  UpdatePermissionDto,
+} from "./data-contracts";
+import { ContentType, HttpClient, RequestParams } from "./http-client";
+
+export class Permissions<SecurityDataType = unknown> {
+  http: HttpClient<SecurityDataType>;
+
+  constructor(http: HttpClient<SecurityDataType>) {
+    this.http = http;
+  }
+
+  /**
+   * @description Get a paginated list of all available permissions
+   *
+   * @tags Admin Permissions
+   * @name FindAll
+   * @summary List all permissions
+   * @request GET:/permissions
+   * @secure
+   */
+  findAll = (query: FindAllParams, params: RequestParams = {}) =>
+    this.http.request<FindAllData, any>({
+      path: `/permissions`,
+      method: "GET",
+      query: query,
+      secure: true,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Create a new permission
+   *
+   * @tags Admin Permissions
+   * @name Create
+   * @summary Create permission
+   * @request POST:/permissions
+   * @secure
+   */
+  create = (data: CreatePermissionDto, params: RequestParams = {}) =>
+    this.http.request<CreateData, void>({
+      path: `/permissions`,
+      method: "POST",
+      body: data,
+      secure: true,
+      type: ContentType.Json,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Get a specific permission by its ID
+   *
+   * @tags Admin Permissions
+   * @name FindById
+   * @summary Get permission by ID
+   * @request GET:/permissions/{id}
+   * @secure
+   */
+  findById = ({ id, ...query }: FindByIdParams, params: RequestParams = {}) =>
+    this.http.request<FindByIdData, void>({
+      path: `/permissions/${id}`,
+      method: "GET",
+      secure: true,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Update an existing permission
+   *
+   * @tags Admin Permissions
+   * @name Update
+   * @summary Update permission
+   * @request PATCH:/permissions/{id}
+   * @secure
+   */
+  update = (
+    { id, ...query }: UpdateParams,
+    data: UpdatePermissionDto,
+    params: RequestParams = {},
+  ) =>
+    this.http.request<UpdateData, void>({
+      path: `/permissions/${id}`,
+      method: "PATCH",
+      body: data,
+      secure: true,
+      type: ContentType.Json,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Delete a permission (must not be assigned to any roles or users)
+   *
+   * @tags Admin Permissions
+   * @name Delete
+   * @summary Delete permission
+   * @request DELETE:/permissions/{id}
+   * @secure
+   */
+  delete = ({ id, ...query }: DeleteParams, params: RequestParams = {}) =>
+    this.http.request<DeleteData, DeleteError>({
+      path: `/permissions/${id}`,
+      method: "DELETE",
+      secure: true,
+      format: "json",
+      ...params,
+    });
+}

package/README.md

@@ -0,0 +1,150 @@
+# @tamm/admin-api-client
+
+TypeScript client for TAMM Admin Service API - Auto-generated from OpenAPI specification.
+
+## Installation
+
+```bash
+npm install @tamm/admin-api-client
+```
+
+## Quick Start
+
+```typescript
+import { AdminApiClient } from '@tamm/admin-api-client';
+
+// Create client instance
+const adminClient = new AdminApiClient({
+  baseURL: 'http://localhost:3006',
+  token: 'your-jwt-token', // Optional, can be set later
+});
+
+// Login
+const loginResponse = await adminClient.auth.login({
+  email: 'admin@example.com',
+  password: 'password123',
+});
+
+// Store token
+adminClient.setToken(loginResponse.data.accessToken);
+
+// Use authenticated endpoints
+const admins = await adminClient.admins.getAll();
+const roles = await adminClient.roles.getAll();
+const permissions = await adminClient.permissions.getAll();
+```
+
+## API Reference
+
+### Available APIs
+
+- **`adminClient.auth`** - Authentication (login, logout)
+- **`adminClient.admins`** - Admin user management
+- **`adminClient.roles`** - Role management
+- **`adminClient.permissions`** - Permission management
+- **`adminClient.agents`** - Agent management
+- **`adminClient.agentBranches`** - Agent branch management
+- **`adminClient.agentSettlements`** - Agent settlement management
+- **`adminClient.kyc`** - KYC management
+- **`adminClient.notifications`** - Notification management
+- **`adminClient.activityLogs`** - Activity log queries
+- **`adminClient.seed`** - Database seeding (dev only)
+
+### Authentication
+
+```typescript
+// Set token during initialization
+const client = new AdminApiClient({
+  baseURL: 'http://localhost:3006',
+  token: 'your-token',
+});
+
+// Or set token later
+client.setToken('new-token');
+
+// Clear token
+client.clearToken();
+```
+
+### Using Individual API Classes
+
+```typescript
+import { Admins, HttpClient } from '@tamm/admin-api-client';
+
+const httpClient = new HttpClient({
+  baseURL: 'http://localhost:3006',
+  securityWorker: async (authData) => {
+    const token = localStorage.getItem('admin_token');
+    if (token) {
+      return {
+        headers: {
+          Authorization: `Bearer ${token}`,
+        },
+      };
+    }
+  },
+  secure: true,
+});
+
+const adminsApi = new Admins(httpClient);
+const allAdmins = await adminsApi.getAll();
+```
+
+## Types
+
+All TypeScript types are exported:
+
+```typescript
+import type {
+  LoginAdminDto,
+  AdminUserDto,
+  AdminRoleDto,
+  AdminPermissionDto,
+  // ... all other types
+} from '@tamm/admin-api-client';
+```
+
+## Error Handling
+
+```typescript
+try {
+  const response = await adminClient.admins.create(adminData);
+  console.log('Success:', response.data);
+} catch (error) {
+  if (error.response) {
+    // Server responded with error status
+    console.error('API Error:', error.response.status, error.response.data);
+  } else {
+    // Network error
+    console.error('Network Error:', error.message);
+  }
+}
+```
+
+## Configuration
+
+```typescript
+const client = new AdminApiClient({
+  baseURL: 'http://localhost:3006', // Admin Service URL
+  timeout: 10000, // Request timeout (ms)
+  token: 'your-jwt-token', // Optional auth token
+  headers: {
+    // Custom headers
+    'X-Custom-Header': 'value',
+  },
+});
+```
+
+## Versioning
+
+This package follows semantic versioning. Check the [changelog](./CHANGELOG.md) for version history.
+
+## Support
+
+- **Issues**: Report problems with generated code
+- **API Changes**: Contact backend team
+- **Documentation**: See [workflow guide](../../docs/admin-typescript-client-workflow.md)
+
+## License
+
+MIT

package/Roles.ts

@@ -0,0 +1,199 @@
+/* eslint-disable */
+/* tslint:disable */
+// @ts-nocheck
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import {
+  AddPermissionsData,
+  AddPermissionsParams,
+  AssignPermissionsDto,
+  CreateResult,
+  CreateRoleDto,
+  DeleteFail,
+  DeleteParams2,
+  DeleteResult,
+  FindAllParams2,
+  FindAllResult,
+  FindByIdParams2,
+  FindByIdResult,
+  LookupData,
+  LookupParams,
+  SetPermissionsData,
+  SetPermissionsParams,
+  UpdateParams2,
+  UpdateResult,
+  UpdateRoleDto,
+} from "./data-contracts";
+import { ContentType, HttpClient, RequestParams } from "./http-client";
+
+export class Roles<SecurityDataType = unknown> {
+  http: HttpClient<SecurityDataType>;
+
+  constructor(http: HttpClient<SecurityDataType>) {
+    this.http = http;
+  }
+
+  /**
+   * @description Get a paginated list of all roles without permissions - useful for dropdowns and lookups
+   *
+   * @tags Admin Roles
+   * @name Lookup
+   * @summary List all roles (lookup)
+   * @request GET:/roles/lookup
+   * @secure
+   */
+  lookup = (query: LookupParams, params: RequestParams = {}) =>
+    this.http.request<LookupData, any>({
+      path: `/roles/lookup`,
+      method: "GET",
+      query: query,
+      secure: true,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Get a paginated list of all roles with their permissions
+   *
+   * @tags Admin Roles
+   * @name FindAll
+   * @summary List all roles
+   * @request GET:/roles
+   * @secure
+   */
+  findAll = (query: FindAllParams2, params: RequestParams = {}) =>
+    this.http.request<FindAllResult, any>({
+      path: `/roles`,
+      method: "GET",
+      query: query,
+      secure: true,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Create a new role with optional permissions assignment
+   *
+   * @tags Admin Roles
+   * @name Create
+   * @summary Create role
+   * @request POST:/roles
+   * @secure
+   */
+  create = (data: CreateRoleDto, params: RequestParams = {}) =>
+    this.http.request<CreateResult, void>({
+      path: `/roles`,
+      method: "POST",
+      body: data,
+      secure: true,
+      type: ContentType.Json,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Get a specific role with its permissions
+   *
+   * @tags Admin Roles
+   * @name FindById
+   * @summary Get role by ID
+   * @request GET:/roles/{id}
+   * @secure
+   */
+  findById = ({ id, ...query }: FindByIdParams2, params: RequestParams = {}) =>
+    this.http.request<FindByIdResult, void>({
+      path: `/roles/${id}`,
+      method: "GET",
+      secure: true,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Update an existing role
+   *
+   * @tags Admin Roles
+   * @name Update
+   * @summary Update role
+   * @request PATCH:/roles/{id}
+   * @secure
+   */
+  update = (
+    { id, ...query }: UpdateParams2,
+    data: UpdateRoleDto,
+    params: RequestParams = {},
+  ) =>
+    this.http.request<UpdateResult, void>({
+      path: `/roles/${id}`,
+      method: "PATCH",
+      body: data,
+      secure: true,
+      type: ContentType.Json,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Delete a role (must not have assigned users)
+   *
+   * @tags Admin Roles
+   * @name Delete
+   * @summary Delete role
+   * @request DELETE:/roles/{id}
+   * @secure
+   */
+  delete = ({ id, ...query }: DeleteParams2, params: RequestParams = {}) =>
+    this.http.request<DeleteResult, DeleteFail>({
+      path: `/roles/${id}`,
+      method: "DELETE",
+      secure: true,
+      format: "json",
+      ...params,
+    });
+  /**
+   * @description Replace all permissions for a role
+   *
+   * @tags Admin Roles
+   * @name SetPermissions
+   * @summary Set role permissions
+   * @request PUT:/roles/{id}/permissions
+   * @secure
+   */
+  setPermissions = (
+    { id, ...query }: SetPermissionsParams,
+    data: AssignPermissionsDto,
+    params: RequestParams = {},
+  ) =>
+    this.http.request<SetPermissionsData, void>({
+      path: `/roles/${id}/permissions`,
+      method: "PUT",
+      body: data,
+      secure: true,
+      type: ContentType.Json,
+      ...params,
+    });
+  /**
+   * @description Add permissions to a role (additive)
+   *
+   * @tags Admin Roles
+   * @name AddPermissions
+   * @summary Add permissions to role
+   * @request POST:/roles/{id}/permissions
+   * @secure
+   */
+  addPermissions = (
+    { id, ...query }: AddPermissionsParams,
+    data: AssignPermissionsDto,
+    params: RequestParams = {},
+  ) =>
+    this.http.request<AddPermissionsData, void>({
+      path: `/roles/${id}/permissions`,
+      method: "POST",
+      body: data,
+      secure: true,
+      type: ContentType.Json,
+      ...params,
+    });
+}

package/Seed.ts

@@ -0,0 +1,48 @@
+/* eslint-disable */
+/* tslint:disable */
+// @ts-nocheck
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import {
+  SeedPermissionsAndRolesData,
+  SeedPermissionsRolesRequestDto,
+} from "./data-contracts";
+import { ContentType, HttpClient, RequestParams } from "./http-client";
+
+export class Seed<SecurityDataType = unknown> {
+  http: HttpClient<SecurityDataType>;
+
+  constructor(http: HttpClient<SecurityDataType>) {
+    this.http = http;
+  }
+
+  /**
+   * @description Seed all permissions and roles from enums. Optionally assign all permissions to super_admin role.
+   *
+   * @tags Admin Seed
+   * @name SeedPermissionsAndRoles
+   * @summary Seed permissions and roles
+   * @request POST:/seed/permissions-roles
+   * @secure
+   */
+  seedPermissionsAndRoles = (
+    data: SeedPermissionsRolesRequestDto,
+    params: RequestParams = {},
+  ) =>
+    this.http.request<SeedPermissionsAndRolesData, any>({
+      path: `/seed/permissions-roles`,
+      method: "POST",
+      body: data,
+      secure: true,
+      type: ContentType.Json,
+      format: "json",
+      ...params,
+    });
+}