b5-api-client 0.0.22 → 0.0.23

package/dist/P2PMarketplaceAPIClient.d.ts

@@ -1,4 +1,4 @@
-import { CreateOrderRequest, CreateUserRequest, Order, OrderResponse, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse, UsersResponse, GetOrdersParams, CreateDisputeRequest, DisputesResponse, OrderOffersResponse, TransactionRequest } from './types';
+import { CreateOrderRequest, CreateUserRequest, Order, OrderResponse, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse, UsersResponse, GetOrdersParams, CreateDisputeRequest, DisputesResponse, OrderOffersResponse, TransactionRequest, KioscoinOperationResponse, UpdateUserSettingsRequest } from './types';
 declare class P2PMarketplaceAPIClient {
     private readonly client;
     private readonly defaultHeaders;
@@ -15,12 +15,13 @@ declare class P2PMarketplaceAPIClient {
     createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<UsersResponse>;
     getUser(userId: string, headers?: Record<string, string>): Promise<UsersResponse>;
     rateUser(rateUserRequest: RateUserRequest, headers?: Record<string, string>): Promise<any>;
+    updateUserSettings(request: UpdateUserSettingsRequest, headers?: Record<string, string>): Promise<UsersResponse>;
     registerPushToken(registerRequest: PushNotificationsRegisterRequest, headers?: Record<string, string>): Promise<any>;
     getConfig<T>(): Promise<ConfigResponse<T>>;
     getOrderEvents(id: string, headers?: Record<string, string>): Promise<OrderEventsResponse>;
     getDashboardMetrics(headers?: Record<string, string>): Promise<DashboardMetricsResponse>;
     getOrderOffers(headers?: Record<string, string>): Promise<OrderOffersResponse>;
-    pointOfSaleTransact(request: TransactionRequest, headers?: Record<string, string>): Promise<any>;
+    pointOfSaleTransact(request: TransactionRequest, headers?: Record<string, string>): Promise<KioscoinOperationResponse>;
     testLockFunds(order: Order, testParams?: TestEventParams, headers?: Record<string, string>): Promise<void>;
     testReleaseFunds(order: Order, testParams?: TestEventParams, headers?: Record<string, string>): Promise<void>;
     releaseFunds(order: Order, testParams?: TestEventParams, headers?: Record<string, string>): Promise<string>;

package/dist/P2PMarketplaceAPIClient.js

@@ -151,6 +151,12 @@ class P2PMarketplaceAPIClient {
             return this.post(url, rateUserRequest, headers);
         });
     }
+    updateUserSettings(request, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = '/api/users/settings';
+            return this.post(url, request, headers);
+        });
+    }
     registerPushToken(registerRequest, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             const url = `/api/notifications/register-push`;

package/dist/types.d.ts

@@ -43,6 +43,8 @@ export interface Order {
     sellerCanDispute?: boolean;
     buyerDisputed?: boolean;
     sellerDisputed?: boolean;
+    escrowOrder?: EscrowOrderModel;
+    dispute?: Dispute[];
 }
 export interface OrderResponse {
     orders: Order[];
@@ -50,6 +52,14 @@ export interface OrderResponse {
 export interface UsersResponse {
     users: KioscoinUser[];
 }
+export interface UserSettings {
+    preferredTokenCode?: string;
+    paymentMethods: PaymentMethod[];
+}
+export interface UpdateUserSettingsRequest {
+    userId: string;
+    settings: UserSettings;
+}
 export interface PaymentMethod {
     type: string;
     alias?: string;
@@ -239,6 +249,7 @@ export interface KioscoinUser {
     timeToRelease?: number;
     timeToFiatSent?: number;
     reviews?: UserReview[];
+    settings?: UserSettings;
 }
 export type DisputeReason = 'SELLER_NOT_LOCKING' | 'BUYER_FIAT_NOT_SENT' | 'SELLER_NOT_RELEASING';
 export interface CreateDisputeRequest {
@@ -280,3 +291,51 @@ export interface TransactionRequest {
     offer: OrderOffer;
     buyerAddress?: string;
 }
+export type EscrowOrderStatus = 'NON_EXISTING' | 'LOCKED' | 'RELEASED' | 'REFUNDED';
+export interface EscrowOrderModel {
+    id: string;
+    timestamp?: string;
+    tokenContractAddress?: string;
+    buyerAddress?: string;
+    sellerAddress?: string;
+    amount?: string;
+    fee?: string;
+    status?: EscrowOrderStatus;
+    adminAction?: boolean;
+    token?: string;
+}
+export interface ExchangeRateOffer {
+    id: string;
+    tokenCode: string;
+    blockchainEnvironment: string;
+    fiatCode: string;
+    baseFiatRate: string;
+    offeredFiatRate: string;
+    margin: string;
+    validUntil: string;
+    isActive: boolean;
+    createdAt: string;
+}
+export interface KioscoinOperation {
+    orderType: OrderType;
+    tokenAmount: string;
+    fiatAmount: string;
+    tokenCode: string;
+    fiatCode: string;
+    blockchain: string;
+    userId: string;
+    username?: string;
+    buyerAddress?: string;
+    paymentMethods?: PaymentMethod[];
+    orderOffer?: OrderOffer;
+    exchangeRateOffer?: ExchangeRateOffer;
+}
+export type OperationErrorType = 'INVALID_TRANSACTION' | 'HAS_ACTIVE_ORDERS' | 'INSUFFICIENT_FUNDS' | 'UNKNOWN_ERROR';
+export interface OperationError {
+    type: OperationErrorType;
+    message: string;
+}
+export interface KioscoinOperationResponse {
+    error?: OperationError;
+    order?: Order;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "b5-api-client",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "Escrow Backend API client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/P2PMarketplaceAPIClient.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { CreateOrderRequest, CreateUserRequest, Order, OrderLockedEvent, OrderResponse, ReleaseOrderEvent as OrderReleasedEvent, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse, KioscoinUser, UsersResponse, PaymentMethod, GetOrdersParams, CreateDisputeRequest, DisputesResponse, OrderOffersResponse, TransactionRequest } from './types';
+import { CreateOrderRequest, CreateUserRequest, Order, OrderLockedEvent, OrderResponse, ReleaseOrderEvent as OrderReleasedEvent, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse, KioscoinUser, UsersResponse, PaymentMethod, GetOrdersParams, CreateDisputeRequest, DisputesResponse, OrderOffersResponse, TransactionRequest, KioscoinOperationResponse, UpdateUserSettingsRequest } from './types';
 import { isPlainObject, camelCase, snakeCase, transform } from 'lodash';
 
 class P2PMarketplaceAPIClient {
@@ -137,6 +137,11 @@ class P2PMarketplaceAPIClient {
         return this.post<any>(url, rateUserRequest, headers);
     }
 
+    public async updateUserSettings(request: UpdateUserSettingsRequest, headers?: Record<string, string>): Promise<UsersResponse> {
+        const url = '/api/users/settings';
+        return this.post<UsersResponse>(url, request, headers);
+    }
+
     public async registerPushToken(registerRequest: PushNotificationsRegisterRequest, headers?: Record<string, string>): Promise<any> {
         const url = `/api/notifications/register-push`;
         return this.post<PushNotificationsRegisterRequest>(url, registerRequest, headers);
@@ -162,9 +167,9 @@ class P2PMarketplaceAPIClient {
         return this.get<OrderOffersResponse>(url, headers);
     }
 
-    public async pointOfSaleTransact(request: TransactionRequest, headers?: Record<string, string>): Promise<any> {
+    public async pointOfSaleTransact(request: TransactionRequest, headers?: Record<string, string>): Promise<KioscoinOperationResponse> {
         const url = '/api/point_of_sale/transact';
-        return this.post<TransactionRequest>(url, request, headers);
+        return this.post<KioscoinOperationResponse>(url, request, headers);
     }
 
 

package/src/types.ts

@@ -63,6 +63,8 @@ export interface Order {
     sellerCanDispute?: boolean;
     buyerDisputed?: boolean;
     sellerDisputed?: boolean;
+    escrowOrder?: EscrowOrderModel;
+    dispute?: Dispute[];
 }
 
 export interface OrderResponse {
@@ -73,6 +75,16 @@ export interface UsersResponse {
     users: KioscoinUser[]
 }
 
+export interface UserSettings {
+    preferredTokenCode?: string;
+    paymentMethods: PaymentMethod[];
+}
+
+export interface UpdateUserSettingsRequest {
+    userId: string;
+    settings: UserSettings;
+}
+
 export interface PaymentMethod {
     type: string;
     alias?: string;
@@ -289,6 +301,7 @@ export interface KioscoinUser {
     timeToRelease?: number;
     timeToFiatSent?: number;
     reviews?: UserReview[];
+    settings?: UserSettings;
 }
 
 export type DisputeReason = 'SELLER_NOT_LOCKING' | 'BUYER_FIAT_NOT_SENT' | 'SELLER_NOT_RELEASING';
@@ -338,3 +351,58 @@ export interface TransactionRequest {
     offer: OrderOffer;
     buyerAddress?: string;
 }
+
+export type EscrowOrderStatus = 'NON_EXISTING' | 'LOCKED' | 'RELEASED' | 'REFUNDED';
+
+export interface EscrowOrderModel {
+    id: string;
+    timestamp?: string;
+    tokenContractAddress?: string;
+    buyerAddress?: string;
+    sellerAddress?: string;
+    amount?: string;
+    fee?: string;
+    status?: EscrowOrderStatus;
+    adminAction?: boolean;
+    token?: string;
+}
+
+export interface ExchangeRateOffer {
+    id: string;
+    tokenCode: string;
+    blockchainEnvironment: string;
+    fiatCode: string;
+    baseFiatRate: string;
+    offeredFiatRate: string;
+    margin: string;
+    validUntil: string;
+    isActive: boolean;
+    createdAt: string;
+}
+
+export interface KioscoinOperation {
+    orderType: OrderType;
+    tokenAmount: string;
+    fiatAmount: string;
+    tokenCode: string;
+    fiatCode: string;
+    blockchain: string;
+    userId: string;
+    username?: string;
+    buyerAddress?: string;
+    paymentMethods?: PaymentMethod[];
+    orderOffer?: OrderOffer;
+    exchangeRateOffer?: ExchangeRateOffer;
+}
+
+export type OperationErrorType = 'INVALID_TRANSACTION' | 'HAS_ACTIVE_ORDERS' | 'INSUFFICIENT_FUNDS' | 'UNKNOWN_ERROR';
+
+export interface OperationError {
+    type: OperationErrorType;
+    message: string;
+}
+
+export interface KioscoinOperationResponse {
+    error?: OperationError;
+    order?: Order;
+}