@tammsyr/admin-api-client 1.0.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/README.md +105 -68
  2. package/dist/ActivityLogs.d.ts.map +1 -1
  3. package/dist/AgentBranches.d.ts +6 -6
  4. package/dist/AgentBranches.d.ts.map +1 -1
  5. package/dist/AgentSettlements.d.ts +8 -8
  6. package/dist/AgentSettlements.d.ts.map +1 -1
  7. package/dist/Agents.d.ts +26 -96
  8. package/dist/Agents.d.ts.map +1 -1
  9. package/dist/Agents.js +36 -139
  10. package/dist/Agents.js.map +1 -1
  11. package/dist/Kyc.d.ts.map +1 -1
  12. package/dist/Kyc.js.map +1 -1
  13. package/dist/Notifications.d.ts.map +1 -1
  14. package/dist/Notifications.js.map +1 -1
  15. package/dist/Users.d.ts +67 -0
  16. package/dist/Users.d.ts.map +1 -0
  17. package/dist/Users.js +122 -0
  18. package/dist/Users.js.map +1 -0
  19. package/dist/data-contracts.d.ts +706 -145
  20. package/dist/data-contracts.d.ts.map +1 -1
  21. package/dist/index.js +1 -1
  22. package/dist/index.js.map +1 -1
  23. package/package.json +49 -54
package/README.md CHANGED
@@ -1,6 +1,18 @@
1
1
  # @tammsyr/admin-api-client
2
2
 
3
- TypeScript client for TAMM Admin Service API - Auto-generated from OpenAPI specification.
3
+ TypeScript client for TAMM Admin Service API. Auto-generated from OpenAPI specification.
4
+
5
+ ## Table of Contents
6
+
7
+ - [Installation](#installation)
8
+ - [Requirements](#requirements)
9
+ - [Quick Start](#quick-start)
10
+ - [API Reference](#api-reference)
11
+ - [Authentication](#authentication)
12
+ - [Configuration](#configuration)
13
+ - [Error Handling](#error-handling)
14
+ - [Types](#types)
15
+ - [Support](#support)
4
16
 
5
17
  ## Installation
6
18
 
@@ -8,58 +20,75 @@ TypeScript client for TAMM Admin Service API - Auto-generated from OpenAPI speci
8
20
  npm install @tammsyr/admin-api-client
9
21
  ```
10
22
 
23
+ **Peer dependency:** This package uses [axios](https://www.npmjs.com/package/axios) for HTTP requests. If your project doesn't already have it:
24
+
25
+ ```bash
26
+ npm install axios
27
+ ```
28
+
29
+ ## Requirements
30
+
31
+ - Node.js 18+
32
+ - TypeScript 5.x (optional, for type definitions)
33
+
11
34
  ## Quick Start
12
35
 
13
36
  ```typescript
14
37
  import { AdminApiClient } from '@tammsyr/admin-api-client';
15
38
 
16
- // Create client instance
17
- const adminClient = new AdminApiClient({
18
- baseURL: 'http://localhost:3006',
19
- token: 'your-jwt-token', // Optional, can be set later
20
- });
39
+ async function main() {
40
+ const adminClient = new AdminApiClient({
41
+ baseURL: 'http://localhost:3006/admin/v1',
42
+ });
21
43
 
22
- // Login
23
- const loginResponse = await adminClient.auth.login({
24
- email: 'admin@example.com',
25
- password: 'password123',
26
- });
44
+ const loginResponse = await adminClient.auth.login({
45
+ email: 'admin@example.com',
46
+ password: 'password123',
47
+ });
48
+
49
+ adminClient.setToken(loginResponse.data.accessToken);
27
50
 
28
- // Store token
29
- adminClient.setToken(loginResponse.data.accessToken);
51
+ const admins = await adminClient.admins.getAll();
52
+ const roles = await adminClient.roles.getAll();
53
+ }
30
54
 
31
- // Use authenticated endpoints
32
- const admins = await adminClient.admins.getAll();
33
- const roles = await adminClient.roles.getAll();
34
- const permissions = await adminClient.permissions.getAll();
55
+ main().catch(console.error);
35
56
  ```
36
57
 
58
+ **Important:** The `baseURL` must include the `/admin/v1` path. The Admin Service serves all routes under that prefix.
59
+
37
60
  ## API Reference
38
61
 
39
62
  ### Available APIs
40
63
 
41
- - **`adminClient.auth`** - Authentication (login, logout)
42
- - **`adminClient.admins`** - Admin user management
43
- - **`adminClient.roles`** - Role management
44
- - **`adminClient.permissions`** - Permission management
45
- - **`adminClient.agents`** - Agent management
46
- - **`adminClient.agentBranches`** - Agent branch management
47
- - **`adminClient.agentSettlements`** - Agent settlement management
48
- - **`adminClient.kyc`** - KYC management
49
- - **`adminClient.notifications`** - Notification management
50
- - **`adminClient.activityLogs`** - Activity log queries
51
- - **`adminClient.seed`** - Database seeding (dev only)
52
-
53
- ### Authentication
64
+ | Property | Description |
65
+ | ------------------------------ | --------------------------------------- |
66
+ | `adminClient.auth` | Authentication (login, logout, refresh) |
67
+ | `adminClient.admins` | Admin user management |
68
+ | `adminClient.roles` | Role management |
69
+ | `adminClient.permissions` | Permission management |
70
+ | `adminClient.agents` | Agent management |
71
+ | `adminClient.agentBranches` | Agent branch management |
72
+ | `adminClient.agentSettlements` | Agent settlement management |
73
+ | `adminClient.kyc` | KYC management |
74
+ | `adminClient.notifications` | Notification management |
75
+ | `adminClient.activityLogs` | Activity log queries |
76
+ | `adminClient.seed` | Database seeding (dev only) |
77
+
78
+ ## Authentication
54
79
 
55
80
  ```typescript
56
81
  // Set token during initialization
57
82
  const client = new AdminApiClient({
58
- baseURL: 'http://localhost:3006',
83
+ baseURL: 'http://localhost:3006/admin/v1',
59
84
  token: 'your-token',
60
85
  });
61
86
 
62
- // Or set token later
87
+ // Or set token after login
88
+ const res = await client.auth.login({ email, password });
89
+ client.setToken(res.data.accessToken);
90
+
91
+ // Update token later
63
92
  client.setToken('new-token');
64
93
 
65
94
  // Clear token
@@ -72,15 +101,11 @@ client.clearToken();
72
101
  import { Admins, HttpClient } from '@tammsyr/admin-api-client';
73
102
 
74
103
  const httpClient = new HttpClient({
75
- baseURL: 'http://localhost:3006',
104
+ baseURL: 'http://localhost:3006/admin/v1',
76
105
  securityWorker: async (authData) => {
77
- const token = localStorage.getItem('admin_token');
106
+ const token = authData?.token ?? localStorage.getItem('admin_token');
78
107
  if (token) {
79
- return {
80
- headers: {
81
- Authorization: `Bearer ${token}`,
82
- },
83
- };
108
+ return { headers: { Authorization: `Bearer ${token}` } };
84
109
  }
85
110
  },
86
111
  secure: true,
@@ -90,18 +115,32 @@ const adminsApi = new Admins(httpClient);
90
115
  const allAdmins = await adminsApi.getAll();
91
116
  ```
92
117
 
93
- ## Types
118
+ ## Configuration
94
119
 
95
- All TypeScript types are exported:
120
+ ```typescript
121
+ const client = new AdminApiClient({
122
+ baseURL: 'http://localhost:3006/admin/v1',
123
+ timeout: 10000,
124
+ token: 'your-jwt-token',
125
+ headers: {
126
+ 'X-Custom-Header': 'value',
127
+ },
128
+ });
129
+ ```
130
+
131
+ | Option | Type | Default | Description |
132
+ | --------- | ------------------------ | ---------------------------------- | ------------------------------------------------- |
133
+ | `baseURL` | `string` | `'http://localhost:3006/admin/v1'` | Admin Service base URL (must include `/admin/v1`) |
134
+ | `timeout` | `number` | `10000` | Request timeout in ms |
135
+ | `token` | `string` | — | JWT token for authenticated requests |
136
+ | `headers` | `Record<string, string>` | `{}` | Additional request headers |
137
+
138
+ **Environment-based URL example:**
96
139
 
97
140
  ```typescript
98
- import type {
99
- LoginAdminDto,
100
- AdminUserDto,
101
- AdminRoleDto,
102
- AdminPermissionDto,
103
- // ... all other types
104
- } from '@tammsyr/admin-api-client';
141
+ const baseURL = process.env.NODE_ENV === 'production' ? 'https://admin.tamm.com/admin/v1' : 'http://localhost:3006/admin/v1';
142
+
143
+ const client = new AdminApiClient({ baseURL });
105
144
  ```
106
145
 
107
146
  ## Error Handling
@@ -110,40 +149,38 @@ import type {
110
149
  try {
111
150
  const response = await adminClient.admins.create(adminData);
112
151
  console.log('Success:', response.data);
113
- } catch (error) {
114
- if (error.response) {
115
- // Server responded with error status
116
- console.error('API Error:', error.response.status, error.response.data);
152
+ } catch (err: any) {
153
+ if (err.response) {
154
+ console.error('API Error:', err.response.status, err.response.data);
117
155
  } else {
118
- // Network error
119
- console.error('Network Error:', error.message);
156
+ console.error('Network Error:', err.message);
120
157
  }
121
158
  }
122
159
  ```
123
160
 
124
- ## Configuration
161
+ ## Types
162
+
163
+ All request/response types are exported:
125
164
 
126
165
  ```typescript
127
- const client = new AdminApiClient({
128
- baseURL: 'http://localhost:3006', // Admin Service URL
129
- timeout: 10000, // Request timeout (ms)
130
- token: 'your-jwt-token', // Optional auth token
131
- headers: {
132
- // Custom headers
133
- 'X-Custom-Header': 'value',
134
- },
135
- });
166
+ import type {
167
+ AdminLoginRequestDto,
168
+ AdminUserDto,
169
+ AdminRoleDto,
170
+ AdminPermissionDto,
171
+ LoginData,
172
+ // ... other types
173
+ } from '@tammsyr/admin-api-client';
136
174
  ```
137
175
 
138
176
  ## Versioning
139
177
 
140
- This package follows semantic versioning. Check the [changelog](./CHANGELOG.md) for version history.
178
+ This package follows [semantic versioning](https://semver.org/).
141
179
 
142
180
  ## Support
143
181
 
144
- - **Issues**: Report problems with generated code
145
- - **API Changes**: Contact backend team
146
- - **Documentation**: See [workflow guide](../../docs/admin-typescript-client-workflow.md)
182
+ - **Issues:** Report problems with the package or generated code.
183
+ - **API changes:** Coordinate with the backend team; regenerate the client when the Admin Service API changes.
147
184
 
148
185
  ## License
149
186
 
package/dist/ActivityLogs.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ActivityLogs.d.ts","sourceRoot":"","sources":["../ActivityLogs.ts"],"names":[],"mappings":"AAYA,OAAO,EAAkB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE1D,qBAAa,YAAY,CAAC,gBAAgB,GAAG,OAAO;IAClD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,OAAO,GAAI,OAAO,cAAc,EAAE,SAAQ,aAAkB,4GAQvD;CACN"}
1
+ {"version":3,"file":"ActivityLogs.d.ts","sourceRoot":"","sources":["../ActivityLogs.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,cAAc,EAAkB,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE1D,qBAAa,YAAY,CAAC,gBAAgB,GAAG,OAAO;IAClD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,OAAO,GAAI,OAAO,cAAc,EAAE,SAAQ,aAAkB,4GAQvD;CACN"}
package/dist/AgentBranches.d.ts CHANGED
@@ -12,7 +12,7 @@ export declare class AgentBranches<SecurityDataType = unknown> {
12
12
  * @request GET:/agent-branches
13
13
  * @secure
14
14
  */
15
- listBranches: (query: ListBranchesParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
15
+ listBranches: (query: ListBranchesParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<ListBranchesData, any, {}>>;
16
16
  /**
17
17
  * No description
18
18
  *
@@ -22,7 +22,7 @@ export declare class AgentBranches<SecurityDataType = unknown> {
22
22
  * @request POST:/agent-branches
23
23
  * @secure
24
24
  */
25
- createBranch: (data: CreateBranchDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
25
+ createBranch: (data: CreateBranchDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<CreateBranchData, any, {}>>;
26
26
  /**
27
27
  * No description
28
28
  *
@@ -32,7 +32,7 @@ export declare class AgentBranches<SecurityDataType = unknown> {
32
32
  * @request GET:/agent-branches/{id}
33
33
  * @secure
34
34
  */
35
- getBranch: ({ id, ...query }: GetBranchParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
35
+ getBranch: ({ id, ...query }: GetBranchParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<GetBranchData, any, {}>>;
36
36
  /**
37
37
  * No description
38
38
  *
@@ -42,7 +42,7 @@ export declare class AgentBranches<SecurityDataType = unknown> {
42
42
  * @request PATCH:/agent-branches/{id}
43
43
  * @secure
44
44
  */
45
- updateBranch: ({ id, ...query }: UpdateBranchParams, data: UpdateBranchDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
45
+ updateBranch: ({ id, ...query }: UpdateBranchParams, data: UpdateBranchDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<UpdateBranchData, any, {}>>;
46
46
  /**
47
47
  * No description
48
48
  *
@@ -52,7 +52,7 @@ export declare class AgentBranches<SecurityDataType = unknown> {
52
52
  * @request DELETE:/agent-branches/{id}
53
53
  * @secure
54
54
  */
55
- deleteBranch: ({ id, ...query }: DeleteBranchParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
55
+ deleteBranch: ({ id, ...query }: DeleteBranchParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<DeleteBranchData, any, {}>>;
56
56
  /**
57
57
  * No description
58
58
  *
@@ -62,6 +62,6 @@ export declare class AgentBranches<SecurityDataType = unknown> {
62
62
  * @request PATCH:/agent-branches/{id}/status
63
63
  * @secure
64
64
  */
65
- updateBranchStatus: ({ id, ...query }: UpdateBranchStatusParams, data: UpdateBranchStatusDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
65
+ updateBranchStatus: ({ id, ...query }: UpdateBranchStatusParams, data: UpdateBranchStatusDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<UpdateBranchStatusData, any, {}>>;
66
66
  }
67
67
  //# sourceMappingURL=AgentBranches.d.ts.map
package/dist/AgentBranches.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"AgentBranches.d.ts","sourceRoot":"","sources":["../AgentBranches.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,eAAe,EAEf,kBAAkB,EAElB,eAAe,EAEf,kBAAkB,EAElB,eAAe,EACf,kBAAkB,EAElB,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAe,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvE,qBAAa,aAAa,CAAC,gBAAgB,GAAG,OAAO;IACnD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,YAAY,GAAI,OAAO,kBAAkB,EAAE,SAAQ,aAAkB,0DAOhE;IACL;;;;;;;;OAQG;IACH,YAAY,GAAI,MAAM,eAAe,EAAE,SAAQ,aAAkB,0DAQ5D;IACL;;;;;;;;OAQG;IACH,SAAS,GAAI,kBAAkB,eAAe,EAAE,SAAQ,aAAkB,0DAMrE;IACL;;;;;;;;OAQG;IACH,YAAY,GACV,kBAAkB,kBAAkB,EACpC,MAAM,eAAe,EACrB,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,YAAY,GACV,kBAAkB,kBAAkB,EACpC,SAAQ,aAAkB,0DAOvB;IACL;;;;;;;;OAQG;IACH,kBAAkB,GAChB,kBAAkB,wBAAwB,EAC1C,MAAM,qBAAqB,EAC3B,SAAQ,aAAkB,0DASvB;CACN"}
1
+ {"version":3,"file":"AgentBranches.d.ts","sourceRoot":"","sources":["../AgentBranches.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,eAAe,EAEf,kBAAkB,EAElB,eAAe,EAEf,kBAAkB,EAElB,eAAe,EACf,kBAAkB,EAElB,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAe,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvE,qBAAa,aAAa,CAAC,gBAAgB,GAAG,OAAO;IACnD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,YAAY,GAAI,OAAO,kBAAkB,EAAE,SAAQ,aAAkB,uEAOhE;IACL;;;;;;;;OAQG;IACH,YAAY,GAAI,MAAM,eAAe,EAAE,SAAQ,aAAkB,uEAQ5D;IACL;;;;;;;;OAQG;IACH,SAAS,GAAI,kBAAkB,eAAe,EAAE,SAAQ,aAAkB,oEAMrE;IACL;;;;;;;;OAQG;IACH,YAAY,GACV,kBAAkB,kBAAkB,EACpC,MAAM,eAAe,EACrB,SAAQ,aAAkB,uEASvB;IACL;;;;;;;;OAQG;IACH,YAAY,GACV,kBAAkB,kBAAkB,EACpC,SAAQ,aAAkB,uEAOvB;IACL;;;;;;;;OAQG;IACH,kBAAkB,GAChB,kBAAkB,wBAAwB,EAC1C,MAAM,qBAAqB,EAC3B,SAAQ,aAAkB,6EASvB;CACN"}
package/dist/AgentSettlements.d.ts CHANGED
@@ -12,7 +12,7 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
12
12
  * @request GET:/agent-settlements
13
13
  * @secure
14
14
  */
15
- listSettlements: (query: ListSettlementsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
15
+ listSettlements: (query: ListSettlementsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<ListSettlementsData, any, {}>>;
16
16
  /**
17
17
  * No description
18
18
  *
@@ -22,7 +22,7 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
22
22
  * @request POST:/agent-settlements
23
23
  * @secure
24
24
  */
25
- createSettlement: (data: CreateSettlementDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
25
+ createSettlement: (data: CreateSettlementDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<CreateSettlementData, any, {}>>;
26
26
  /**
27
27
  * No description
28
28
  *
@@ -32,7 +32,7 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
32
32
  * @request GET:/agent-settlements/{id}
33
33
  * @secure
34
34
  */
35
- getSettlement: ({ id, ...query }: GetSettlementParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
35
+ getSettlement: ({ id, ...query }: GetSettlementParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<GetSettlementData, any, {}>>;
36
36
  /**
37
37
  * No description
38
38
  *
@@ -42,7 +42,7 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
42
42
  * @request PATCH:/agent-settlements/{id}/status
43
43
  * @secure
44
44
  */
45
- updateSettlementStatus: ({ id, ...query }: UpdateSettlementStatusParams, data: UpdateSettlementStatusDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
45
+ updateSettlementStatus: ({ id, ...query }: UpdateSettlementStatusParams, data: UpdateSettlementStatusDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<UpdateSettlementStatusData, any, {}>>;
46
46
  /**
47
47
  * No description
48
48
  *
@@ -52,7 +52,7 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
52
52
  * @request PATCH:/agent-settlements/{id}/amounts
53
53
  * @secure
54
54
  */
55
- updateSettlementAmounts: ({ id, ...query }: UpdateSettlementAmountsParams, data: UpdateSettlementAmountsDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
55
+ updateSettlementAmounts: ({ id, ...query }: UpdateSettlementAmountsParams, data: UpdateSettlementAmountsDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<UpdateSettlementAmountsData, any, {}>>;
56
56
  /**
57
57
  * No description
58
58
  *
@@ -62,7 +62,7 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
62
62
  * @request GET:/agent-settlements/{id}/adjustments
63
63
  * @secure
64
64
  */
65
- getSettlementAdjustments: ({ id, ...query }: GetSettlementAdjustmentsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
65
+ getSettlementAdjustments: ({ id, ...query }: GetSettlementAdjustmentsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<GetSettlementAdjustmentsData, any, {}>>;
66
66
  /**
67
67
  * No description
68
68
  *
@@ -72,7 +72,7 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
72
72
  * @request POST:/agent-settlements/{id}/adjustments
73
73
  * @secure
74
74
  */
75
- addSettlementAdjustment: ({ id, ...query }: AddSettlementAdjustmentParams, data: AddAdjustmentDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
75
+ addSettlementAdjustment: ({ id, ...query }: AddSettlementAdjustmentParams, data: AddAdjustmentDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<AddSettlementAdjustmentData, any, {}>>;
76
76
  /**
77
77
  * No description
78
78
  *
@@ -82,6 +82,6 @@ export declare class AgentSettlements<SecurityDataType = unknown> {
82
82
  * @request POST:/agent-settlements/adjustments/{adjustmentId}/approve
83
83
  * @secure
84
84
  */
85
- approveAdjustment: ({ adjustmentId, ...query }: ApproveAdjustmentParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
85
+ approveAdjustment: ({ adjustmentId, ...query }: ApproveAdjustmentParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<ApproveAdjustmentData, any, {}>>;
86
86
  }
87
87
  //# sourceMappingURL=AgentSettlements.d.ts.map
package/dist/AgentSettlements.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"AgentSettlements.d.ts","sourceRoot":"","sources":["../AgentSettlements.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,gBAAgB,EAEhB,6BAA6B,EAE7B,uBAAuB,EAEvB,mBAAmB,EAEnB,8BAA8B,EAE9B,mBAAmB,EAEnB,qBAAqB,EAErB,0BAA0B,EAC1B,6BAA6B,EAE7B,yBAAyB,EACzB,4BAA4B,EAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAe,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvE,qBAAa,gBAAgB,CAAC,gBAAgB,GAAG,OAAO;IACtD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,eAAe,GACb,OAAO,qBAAqB,EAC5B,SAAQ,aAAkB,0DAQvB;IACL;;;;;;;;OAQG;IACH,gBAAgB,GAAI,MAAM,mBAAmB,EAAE,SAAQ,aAAkB,0DAQpE;IACL;;;;;;;;OAQG;IACH,aAAa,GACX,kBAAkB,mBAAmB,EACrC,SAAQ,aAAkB,0DAOvB;IACL;;;;;;;;OAQG;IACH,sBAAsB,GACpB,kBAAkB,4BAA4B,EAC9C,MAAM,yBAAyB,EAC/B,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,uBAAuB,GACrB,kBAAkB,6BAA6B,EAC/C,MAAM,0BAA0B,EAChC,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,wBAAwB,GACtB,kBAAkB,8BAA8B,EAChD,SAAQ,aAAkB,0DAOvB;IACL;;;;;;;;OAQG;IACH,uBAAuB,GACrB,kBAAkB,6BAA6B,EAC/C,MAAM,gBAAgB,EACtB,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,iBAAiB,GACf,4BAA4B,uBAAuB,EACnD,SAAQ,aAAkB,0DAOvB;CACN"}
1
+ {"version":3,"file":"AgentSettlements.d.ts","sourceRoot":"","sources":["../AgentSettlements.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,gBAAgB,EAEhB,6BAA6B,EAE7B,uBAAuB,EAEvB,mBAAmB,EAEnB,8BAA8B,EAE9B,mBAAmB,EAEnB,qBAAqB,EAErB,0BAA0B,EAC1B,6BAA6B,EAE7B,yBAAyB,EACzB,4BAA4B,EAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAe,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvE,qBAAa,gBAAgB,CAAC,gBAAgB,GAAG,OAAO;IACtD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,eAAe,GACb,OAAO,qBAAqB,EAC5B,SAAQ,aAAkB,0EAQvB;IACL;;;;;;;;OAQG;IACH,gBAAgB,GAAI,MAAM,mBAAmB,EAAE,SAAQ,aAAkB,2EAQpE;IACL;;;;;;;;OAQG;IACH,aAAa,GACX,kBAAkB,mBAAmB,EACrC,SAAQ,aAAkB,wEAOvB;IACL;;;;;;;;OAQG;IACH,sBAAsB,GACpB,kBAAkB,4BAA4B,EAC9C,MAAM,yBAAyB,EAC/B,SAAQ,aAAkB,iFASvB;IACL;;;;;;;;OAQG;IACH,uBAAuB,GACrB,kBAAkB,6BAA6B,EAC/C,MAAM,0BAA0B,EAChC,SAAQ,aAAkB,kFASvB;IACL;;;;;;;;OAQG;IACH,wBAAwB,GACtB,kBAAkB,8BAA8B,EAChD,SAAQ,aAAkB,mFAOvB;IACL;;;;;;;;OAQG;IACH,uBAAuB,GACrB,kBAAkB,6BAA6B,EAC/C,MAAM,gBAAgB,EACtB,SAAQ,aAAkB,kFASvB;IACL;;;;;;;;OAQG;IACH,iBAAiB,GACf,4BAA4B,uBAAuB,EACnD,SAAQ,aAAkB,4EAOvB;CACN"}
package/dist/Agents.d.ts CHANGED
@@ -1,8 +1,18 @@
1
- import { CalculateCommissionParams, CreateAgentCommissionParams, CreateAgentDto, CreateCommissionDto, DeleteAgentCommissionParams, DeleteAgentLimitParams, DeleteAgentParams, GetAgentCommissionsParams, GetAgentLimitsParams, GetAgentParams, ListAgentsParams, SetAgentLimitParams, SetAgentLimitsParams, SetLimitDto, SetLimitsDto, UpdateAgentCommissionParams, UpdateAgentDto, UpdateAgentParams, UpdateAgentStatusDto, UpdateAgentStatusParams, UpdateCommissionDto } from "./data-contracts";
1
+ import { CreateAgentDto, GetAgentParams, ListAgentsParams, UpdateAgentDto, UpdateAgentParams, UpsertAgentBranchesParams, UpsertAgentCommissionsParams, UpsertAgentLimitsParams, UpsertBranchesDto, UpsertCommissionsDto, UpsertLimitsDto } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  export declare class Agents<SecurityDataType = unknown> {
4
4
  http: HttpClient<SecurityDataType>;
5
5
  constructor(http: HttpClient<SecurityDataType>);
6
+ /**
7
+ * No description
8
+ *
9
+ * @tags Admin Agents
10
+ * @name GetStatistics
11
+ * @summary Get agent analytics widgets
12
+ * @request GET:/agents/statistics
13
+ * @secure
14
+ */
15
+ getStatistics: (params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").AgentStatisticsDto, any, {}>>;
6
16
  /**
7
17
  * No description
8
18
  *
@@ -12,7 +22,7 @@ export declare class Agents<SecurityDataType = unknown> {
12
22
  * @request GET:/agents
13
23
  * @secure
14
24
  */
15
- listAgents: (query: ListAgentsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
25
+ listAgents: (query: ListAgentsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").AgentListResponseDto, any, {}>>;
16
26
  /**
17
27
  * No description
18
28
  *
@@ -22,17 +32,17 @@ export declare class Agents<SecurityDataType = unknown> {
22
32
  * @request POST:/agents
23
33
  * @secure
24
34
  */
25
- createAgent: (data: CreateAgentDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
35
+ createAgent: (data: CreateAgentDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").CreateAgentResponseDto, any, {}>>;
26
36
  /**
27
37
  * No description
28
38
  *
29
39
  * @tags Admin Agents
30
40
  * @name GetAgent
31
- * @summary Get agent by ID
41
+ * @summary Get agent by ID with branches, commissions and limits
32
42
  * @request GET:/agents/{id}
33
43
  * @secure
34
44
  */
35
- getAgent: ({ id, ...query }: GetAgentParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
45
+ getAgent: ({ id, ...query }: GetAgentParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").AgentResponseDto, any, {}>>;
36
46
  /**
37
47
  * No description
38
48
  *
@@ -42,116 +52,36 @@ export declare class Agents<SecurityDataType = unknown> {
42
52
  * @request PATCH:/agents/{id}
43
53
  * @secure
44
54
  */
45
- updateAgent: ({ id, ...query }: UpdateAgentParams, data: UpdateAgentDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
46
- /**
47
- * No description
48
- *
49
- * @tags Admin Agents
50
- * @name DeleteAgent
51
- * @summary Delete an agent
52
- * @request DELETE:/agents/{id}
53
- * @secure
54
- */
55
- deleteAgent: ({ id, ...query }: DeleteAgentParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
55
+ updateAgent: ({ id, ...query }: UpdateAgentParams, data: UpdateAgentDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").UpdateAgentResponseDto, any, {}>>;
56
56
  /**
57
57
  * No description
58
58
  *
59
59
  * @tags Admin Agents
60
- * @name UpdateAgentStatus
61
- * @summary Update agent status
62
- * @request PATCH:/agents/{id}/status
60
+ * @name UpsertAgentBranches
61
+ * @summary Upsert agent branches (create new / update existing)
62
+ * @request POST:/agents/{id}/branches
63
63
  * @secure
64
64
  */
65
- updateAgentStatus: ({ id, ...query }: UpdateAgentStatusParams, data: UpdateAgentStatusDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
65
+ upsertAgentBranches: ({ id, ...query }: UpsertAgentBranchesParams, data: UpsertBranchesDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").BranchesUpsertResponseDto, any, {}>>;
66
66
  /**
67
67
  * No description
68
68
  *
69
69
  * @tags Admin Agents
70
- * @name GetAgentLimits
71
- * @summary Get agent limits
72
- * @request GET:/agents/{id}/limits
73
- * @secure
74
- */
75
- getAgentLimits: ({ id, ...query }: GetAgentLimitsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
76
- /**
77
- * No description
78
- *
79
- * @tags Admin Agents
80
- * @name SetAgentLimit
81
- * @summary Set agent limit
70
+ * @name UpsertAgentLimits
71
+ * @summary Upsert agent limits — matched by (limitType, currency)
82
72
  * @request POST:/agents/{id}/limits
83
73
  * @secure
84
74
  */
85
- setAgentLimit: ({ id, ...query }: SetAgentLimitParams, data: SetLimitDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
86
- /**
87
- * No description
88
- *
89
- * @tags Admin Agents
90
- * @name SetAgentLimits
91
- * @summary Set multiple agent limits
92
- * @request PUT:/agents/{id}/limits
93
- * @secure
94
- */
95
- setAgentLimits: ({ id, ...query }: SetAgentLimitsParams, data: SetLimitsDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
96
- /**
97
- * No description
98
- *
99
- * @tags Admin Agents
100
- * @name DeleteAgentLimit
101
- * @summary Delete an agent limit
102
- * @request DELETE:/agents/limits/{limitId}
103
- * @secure
104
- */
105
- deleteAgentLimit: ({ limitId, ...query }: DeleteAgentLimitParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
106
- /**
107
- * No description
108
- *
109
- * @tags Admin Agents
110
- * @name GetAgentCommissions
111
- * @summary Get agent commissions
112
- * @request GET:/agents/{id}/commissions
113
- * @secure
114
- */
115
- getAgentCommissions: ({ id, ...query }: GetAgentCommissionsParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
75
+ upsertAgentLimits: ({ id, ...query }: UpsertAgentLimitsParams, data: UpsertLimitsDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").AgentLimitsResponseDto, any, {}>>;
116
76
  /**
117
77
  * No description
118
78
  *
119
79
  * @tags Admin Agents
120
- * @name CreateAgentCommission
121
- * @summary Create agent commission
80
+ * @name UpsertAgentCommissions
81
+ * @summary Upsert agent commissions (create new / update existing)
122
82
  * @request POST:/agents/{id}/commissions
123
83
  * @secure
124
84
  */
125
- createAgentCommission: ({ id, ...query }: CreateAgentCommissionParams, data: CreateCommissionDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
126
- /**
127
- * No description
128
- *
129
- * @tags Admin Agents
130
- * @name UpdateAgentCommission
131
- * @summary Update agent commission
132
- * @request PATCH:/agents/commissions/{commissionId}
133
- * @secure
134
- */
135
- updateAgentCommission: ({ commissionId, ...query }: UpdateAgentCommissionParams, data: UpdateCommissionDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
136
- /**
137
- * No description
138
- *
139
- * @tags Admin Agents
140
- * @name DeleteAgentCommission
141
- * @summary Delete agent commission
142
- * @request DELETE:/agents/commissions/{commissionId}
143
- * @secure
144
- */
145
- deleteAgentCommission: ({ commissionId, ...query }: DeleteAgentCommissionParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
146
- /**
147
- * No description
148
- *
149
- * @tags Admin Agents
150
- * @name CalculateCommission
151
- * @summary Calculate commission for a transaction amount
152
- * @request POST:/agents/{id}/calculate-commission
153
- * @secure
154
- */
155
- calculateCommission: ({ id, ...query }: CalculateCommissionParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
85
+ upsertAgentCommissions: ({ id, ...query }: UpsertAgentCommissionsParams, data: UpsertCommissionsDto, params?: RequestParams) => Promise<import("axios").AxiosResponse<import("./data-contracts").AgentCommissionsResponseDto, any, {}>>;
156
86
  }
157
87
  //# sourceMappingURL=Agents.d.ts.map
package/dist/Agents.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Agents.d.ts","sourceRoot":"","sources":["../Agents.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,yBAAyB,EAEzB,2BAA2B,EAE3B,cAAc,EACd,mBAAmB,EAEnB,2BAA2B,EAG3B,sBAAsB,EACtB,iBAAiB,EAEjB,yBAAyB,EAGzB,oBAAoB,EACpB,cAAc,EAEd,gBAAgB,EAEhB,mBAAmB,EAEnB,oBAAoB,EACpB,WAAW,EACX,YAAY,EAEZ,2BAA2B,EAE3B,cAAc,EACd,iBAAiB,EAEjB,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAe,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvE,qBAAa,MAAM,CAAC,gBAAgB,GAAG,OAAO;IAC5C,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,UAAU,GAAI,OAAO,gBAAgB,EAAE,SAAQ,aAAkB,0DAO5D;IACL;;;;;;;;OAQG;IACH,WAAW,GAAI,MAAM,cAAc,EAAE,SAAQ,aAAkB,0DAQ1D;IACL;;;;;;;;OAQG;IACH,QAAQ,GAAI,kBAAkB,cAAc,EAAE,SAAQ,aAAkB,0DAMnE;IACL;;;;;;;;OAQG;IACH,WAAW,GACT,kBAAkB,iBAAiB,EACnC,MAAM,cAAc,EACpB,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,WAAW,GACT,kBAAkB,iBAAiB,EACnC,SAAQ,aAAkB,0DAOvB;IACL;;;;;;;;OAQG;IACH,iBAAiB,GACf,kBAAkB,uBAAuB,EACzC,MAAM,oBAAoB,EAC1B,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,cAAc,GACZ,kBAAkB,oBAAoB,EACtC,SAAQ,aAAkB,0DAQvB;IACL;;;;;;;;OAQG;IACH,aAAa,GACX,kBAAkB,mBAAmB,EACrC,MAAM,WAAW,EACjB,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,cAAc,GACZ,kBAAkB,oBAAoB,EACtC,MAAM,YAAY,EAClB,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,gBAAgB,GACd,uBAAuB,sBAAsB,EAC7C,SAAQ,aAAkB,0DAOvB;IACL;;;;;;;;OAQG;IACH,mBAAmB,GACjB,kBAAkB,yBAAyB,EAC3C,SAAQ,aAAkB,0DAQvB;IACL;;;;;;;;OAQG;IACH,qBAAqB,GACnB,kBAAkB,2BAA2B,EAC7C,MAAM,mBAAmB,EACzB,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,qBAAqB,GACnB,4BAA4B,2BAA2B,EACvD,MAAM,mBAAmB,EACzB,SAAQ,aAAkB,0DASvB;IACL;;;;;;;;OAQG;IACH,qBAAqB,GACnB,4BAA4B,2BAA2B,EACvD,SAAQ,aAAkB,0DAOvB;IACL;;;;;;;;OAQG;IACH,mBAAmB,GACjB,kBAAkB,yBAAyB,EAC3C,SAAQ,aAAkB,0DAOvB;CACN"}
1
+ {"version":3,"file":"Agents.d.ts","sourceRoot":"","sources":["../Agents.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,cAAc,EAEd,cAAc,EAGd,gBAAgB,EAEhB,cAAc,EACd,iBAAiB,EAEjB,yBAAyB,EAEzB,4BAA4B,EAE5B,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAe,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvE,qBAAa,MAAM,CAAC,gBAAgB,GAAG,OAAO;IAC5C,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;gBAEvB,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;IAI9C;;;;;;;;OAQG;IACH,aAAa,GAAI,SAAQ,aAAkB,oGAOtC;IACL;;;;;;;;OAQG;IACH,UAAU,GAAI,OAAO,gBAAgB,EAAE,SAAQ,aAAkB,sGAQ5D;IACL;;;;;;;;OAQG;IACH,WAAW,GAAI,MAAM,cAAc,EAAE,SAAQ,aAAkB,wGAS1D;IACL;;;;;;;;OAQG;IACH,QAAQ,GAAI,kBAAkB,cAAc,EAAE,SAAQ,aAAkB,kGAOnE;IACL;;;;;;;;OAQG;IACH,WAAW,GACT,kBAAkB,iBAAiB,EACnC,MAAM,cAAc,EACpB,SAAQ,aAAkB,wGAUvB;IACL;;;;;;;;OAQG;IACH,mBAAmB,GACjB,kBAAkB,yBAAyB,EAC3C,MAAM,iBAAiB,EACvB,SAAQ,aAAkB,2GAUvB;IACL;;;;;;;;OAQG;IACH,iBAAiB,GACf,kBAAkB,uBAAuB,EACzC,MAAM,eAAe,EACrB,SAAQ,aAAkB,wGAUvB;IACL;;;;;;;;OAQG;IACH,sBAAsB,GACpB,kBAAkB,4BAA4B,EAC9C,MAAM,oBAAoB,EAC1B,SAAQ,aAAkB,6GAUvB;CACN"}