b5-api-client 0.0.17 → 0.0.18
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.
- package/dist/APITester.js +1 -0
- package/dist/P2PMarketplaceAPIClient.d.ts +3 -2
- package/dist/P2PMarketplaceAPIClient.js +9 -3
- package/dist/types.d.ts +37 -0
- package/package.json +1 -1
- package/src/APITester.ts +1 -0
- package/src/P2PMarketplaceAPIClient.ts +11 -6
- package/src/types.ts +41 -0
package/dist/APITester.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderResponse, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse } from './types';
|
|
1
|
+
import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderResponse, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse, UsersResponse } from './types';
|
|
2
2
|
declare class P2PMarketplaceAPIClient {
|
|
3
3
|
private readonly client;
|
|
4
4
|
private readonly defaultHeaders;
|
|
@@ -11,8 +11,9 @@ declare class P2PMarketplaceAPIClient {
|
|
|
11
11
|
getOrderById(id: string, headers?: Record<string, string>): Promise<OrderResponse>;
|
|
12
12
|
createOrder(order: CreateOrderRequest, headers?: Record<string, string>): Promise<OrderResponse>;
|
|
13
13
|
takeOrder(order: TakeOrderRequest, headers?: Record<string, string>): Promise<OrderResponse>;
|
|
14
|
-
createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<Order>;
|
|
15
14
|
updateOrder(updateRequest: UpdateOrderRequest, headers?: Record<string, string>): Promise<Order>;
|
|
15
|
+
createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<UsersResponse>;
|
|
16
|
+
getUser(userId: string, headers?: Record<string, string>): Promise<UsersResponse>;
|
|
16
17
|
rateUser(rateUserRequest: RateUserRequest, headers?: Record<string, string>): Promise<any>;
|
|
17
18
|
registerPushToken(registerRequest: PushNotificationsRegisterRequest, headers?: Record<string, string>): Promise<any>;
|
|
18
19
|
getConfig<T>(): Promise<ConfigResponse<T>>;
|
|
@@ -109,16 +109,22 @@ class P2PMarketplaceAPIClient {
|
|
|
109
109
|
return this.post(url, order, headers);
|
|
110
110
|
});
|
|
111
111
|
}
|
|
112
|
+
updateOrder(updateRequest, headers) {
|
|
113
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
114
|
+
const url = '/api/orders/update';
|
|
115
|
+
return this.post(url, updateRequest, headers);
|
|
116
|
+
});
|
|
117
|
+
}
|
|
112
118
|
createUser(user, headers) {
|
|
113
119
|
return __awaiter(this, void 0, void 0, function* () {
|
|
114
120
|
const url = '/api/users';
|
|
115
121
|
return this.post(url, user, headers);
|
|
116
122
|
});
|
|
117
123
|
}
|
|
118
|
-
|
|
124
|
+
getUser(userId, headers) {
|
|
119
125
|
return __awaiter(this, void 0, void 0, function* () {
|
|
120
|
-
const url =
|
|
121
|
-
return this.
|
|
126
|
+
const url = `/api/users/${userId}`;
|
|
127
|
+
return this.get(url, headers);
|
|
122
128
|
});
|
|
123
129
|
}
|
|
124
130
|
rateUser(rateUserRequest, headers) {
|
package/dist/types.d.ts
CHANGED
|
@@ -38,10 +38,14 @@ export interface Order {
|
|
|
38
38
|
creatorRating: string;
|
|
39
39
|
transactionsCount: number;
|
|
40
40
|
chatId: string;
|
|
41
|
+
userMetrics?: UserMetrics[];
|
|
41
42
|
}
|
|
42
43
|
export interface OrderResponse {
|
|
43
44
|
orders: Order[];
|
|
44
45
|
}
|
|
46
|
+
export interface UsersResponse {
|
|
47
|
+
users: KioscoinUser[];
|
|
48
|
+
}
|
|
45
49
|
export interface PaymentMethod {
|
|
46
50
|
type: string;
|
|
47
51
|
alias?: string;
|
|
@@ -92,6 +96,7 @@ export interface TakeBuyOrderRequest {
|
|
|
92
96
|
hash?: string;
|
|
93
97
|
}
|
|
94
98
|
export interface CreateUserRequest {
|
|
99
|
+
id: string;
|
|
95
100
|
username: string;
|
|
96
101
|
}
|
|
97
102
|
export interface UpdateOrderRequest {
|
|
@@ -185,3 +190,35 @@ export interface ConfigResponse<T = any> {
|
|
|
185
190
|
}
|
|
186
191
|
export interface TestEventParams {
|
|
187
192
|
}
|
|
193
|
+
export interface UserMetrics {
|
|
194
|
+
userId: string;
|
|
195
|
+
avgTimeToLock: number;
|
|
196
|
+
avgTimeToRelease: number;
|
|
197
|
+
avgTimeToFiatSent: number;
|
|
198
|
+
}
|
|
199
|
+
export interface UserReview {
|
|
200
|
+
reviewId?: string;
|
|
201
|
+
rating?: number;
|
|
202
|
+
reviewedAt?: string;
|
|
203
|
+
}
|
|
204
|
+
export interface KioscoinUser {
|
|
205
|
+
id?: string;
|
|
206
|
+
username?: string;
|
|
207
|
+
lang?: string;
|
|
208
|
+
tradesCompleted?: number;
|
|
209
|
+
totalReviews?: number;
|
|
210
|
+
lastRating: string;
|
|
211
|
+
totalRating: string;
|
|
212
|
+
volumeTraded?: number;
|
|
213
|
+
admin?: boolean;
|
|
214
|
+
banned?: boolean;
|
|
215
|
+
showUsername?: boolean;
|
|
216
|
+
showVolumeTraded?: boolean;
|
|
217
|
+
lightningAddress?: string;
|
|
218
|
+
disputes?: number;
|
|
219
|
+
defaultCommunityId?: string;
|
|
220
|
+
timeToLock?: number;
|
|
221
|
+
timeToRelease?: number;
|
|
222
|
+
timeToFiatSent?: number;
|
|
223
|
+
reviews?: UserReview[];
|
|
224
|
+
}
|
package/package.json
CHANGED
package/src/APITester.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
|
|
2
|
-
import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderLockedEvent, OrderResponse, ReleaseOrderEvent as OrderReleasedEvent, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse } from './types';
|
|
2
|
+
import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderLockedEvent, OrderResponse, ReleaseOrderEvent as OrderReleasedEvent, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse, KioscoinUser, UsersResponse } from './types';
|
|
3
3
|
import { isPlainObject, camelCase, snakeCase, transform } from 'lodash';
|
|
4
4
|
|
|
5
5
|
class P2PMarketplaceAPIClient {
|
|
@@ -96,16 +96,21 @@ class P2PMarketplaceAPIClient {
|
|
|
96
96
|
return this.post<OrderResponse>(url, order, headers);
|
|
97
97
|
}
|
|
98
98
|
|
|
99
|
-
public async createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<Order> {
|
|
100
|
-
const url = '/api/users';
|
|
101
|
-
return this.post<Order>(url, user, headers);
|
|
102
|
-
}
|
|
103
|
-
|
|
104
99
|
public async updateOrder(updateRequest: UpdateOrderRequest, headers?: Record<string, string>): Promise<Order> {
|
|
105
100
|
const url = '/api/orders/update';
|
|
106
101
|
return this.post<Order>(url, updateRequest, headers);
|
|
107
102
|
}
|
|
108
103
|
|
|
104
|
+
public async createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<UsersResponse> {
|
|
105
|
+
const url = '/api/users';
|
|
106
|
+
return this.post<UsersResponse>(url, user, headers);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
public async getUser(userId: string, headers?: Record<string, string>): Promise<UsersResponse> {
|
|
110
|
+
const url = `/api/users/${userId}`;
|
|
111
|
+
return this.get<UsersResponse>(url, headers);
|
|
112
|
+
}
|
|
113
|
+
|
|
109
114
|
public async rateUser(rateUserRequest: RateUserRequest, headers?: Record<string, string>): Promise<any> {
|
|
110
115
|
const url = '/api/users/rate';
|
|
111
116
|
return this.post<any>(url, rateUserRequest, headers);
|
package/src/types.ts
CHANGED
|
@@ -58,12 +58,17 @@ export interface Order {
|
|
|
58
58
|
creatorRating: string;
|
|
59
59
|
transactionsCount: number;
|
|
60
60
|
chatId: string;
|
|
61
|
+
userMetrics?: UserMetrics[];
|
|
61
62
|
}
|
|
62
63
|
|
|
63
64
|
export interface OrderResponse {
|
|
64
65
|
orders: Order[]
|
|
65
66
|
}
|
|
66
67
|
|
|
68
|
+
export interface UsersResponse {
|
|
69
|
+
users: KioscoinUser[]
|
|
70
|
+
}
|
|
71
|
+
|
|
67
72
|
export interface PaymentMethod {
|
|
68
73
|
type: string;
|
|
69
74
|
alias?: string;
|
|
@@ -120,6 +125,7 @@ export interface TakeBuyOrderRequest {
|
|
|
120
125
|
}
|
|
121
126
|
|
|
122
127
|
export interface CreateUserRequest {
|
|
128
|
+
id: string;
|
|
123
129
|
username: string;
|
|
124
130
|
}
|
|
125
131
|
|
|
@@ -230,4 +236,39 @@ export interface ConfigResponse<T = any> {
|
|
|
230
236
|
|
|
231
237
|
export interface TestEventParams {
|
|
232
238
|
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
export interface UserMetrics {
|
|
242
|
+
userId: string;
|
|
243
|
+
avgTimeToLock: number;
|
|
244
|
+
avgTimeToRelease: number;
|
|
245
|
+
avgTimeToFiatSent: number;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
export interface UserReview {
|
|
249
|
+
reviewId?: string;
|
|
250
|
+
rating?: number;
|
|
251
|
+
reviewedAt?: string;
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
export interface KioscoinUser {
|
|
255
|
+
id?: string;
|
|
256
|
+
username?: string;
|
|
257
|
+
lang?: string;
|
|
258
|
+
tradesCompleted?: number;
|
|
259
|
+
totalReviews?: number;
|
|
260
|
+
lastRating: string;
|
|
261
|
+
totalRating: string;
|
|
262
|
+
volumeTraded?: number;
|
|
263
|
+
admin?: boolean;
|
|
264
|
+
banned?: boolean;
|
|
265
|
+
showUsername?: boolean;
|
|
266
|
+
showVolumeTraded?: boolean;
|
|
267
|
+
lightningAddress?: string;
|
|
268
|
+
disputes?: number;
|
|
269
|
+
defaultCommunityId?: string;
|
|
270
|
+
timeToLock?: number;
|
|
271
|
+
timeToRelease?: number;
|
|
272
|
+
timeToFiatSent?: number;
|
|
273
|
+
reviews?: UserReview[];
|
|
233
274
|
}
|