Added user address and profile methods

Catzilla · Catzilla · commit 274074a8c7e0 · 2025-02-05T13:02:05.000+02:00
diff --git a/src/models/App.ts b/src/models/App.ts
@@ -29,6 +29,7 @@ export interface PublicApp {
      * App image
      *
      * @format URL
+     * @example 'https://example.com/image.webp'
      */
     image: string | null;
 
@@ -41,6 +42,7 @@ export interface PublicApp {
      * App URL
      *
      * @format URL
+     * @example 'https://example.com'
      */
     url: string;
 }
diff --git a/src/models/Product.ts b/src/models/Product.ts
@@ -40,6 +40,7 @@ export default interface Product {
      * Product image
      *
      * @format URL
+     * @example 'https://example.com/image.webp'
      */
     image: string | null;
 
diff --git a/src/models/UserAddress.ts b/src/models/UserAddress.ts
@@ -0,0 +1,65 @@
+export enum UserAddressType {
+    /**
+     * Bitcoin
+     */
+    BTC = 'BTC',
+
+    /**
+     * Ethereum-like (Ethereum, Binance Smart Chain, Polygon, etc.)
+     */
+    EVM = 'EVM',
+
+    /**
+     * Litecoin
+     */
+    LTC = 'LTC',
+
+    /**
+     * Tron
+     */
+    TRX = 'TRX'
+}
+
+export default interface UserAddress {
+    /**
+     * Address ID
+     *
+     * @example '0660bfde-e576-467a-af63-69edaf85f8c2'
+     */
+    id: string;
+
+    /**
+     * Address name
+     *
+     * @example 'Main Ethereum wallet'
+     */
+    name: string;
+
+    /**
+     * Address
+     *
+     * @example '0x41ce73496136A0072013B9187550e30841eDeD74'
+     */
+    address: string;
+
+    /**
+     * Network type
+     *
+     * @example 'EVM'
+     */
+    type: UserAddressType;
+
+    /**
+     * Address creation timestamp
+     *
+     * @example '2024-07-31T00:48:53Z'
+     */
+    createdAt: string;
+
+    /**
+     * Address update timestamp
+     *
+     * @example '2024-07-31T00:49:28Z'
+     */
+    updatedAt: string;
+}
diff --git a/src/models/UserProfile.ts b/src/models/UserProfile.ts
@@ -0,0 +1,52 @@
+export default interface UserProfile {
+    /**
+     * Profile name (title)
+     *
+     * @example 'Crypto trader, influencer'
+     */
+    name: string | null;
+
+    /**
+     * Profile description (bio)
+     *
+     * @example 'Experienced crypto trader specializing in market analysis, DeFi strategies, and risk management. Passionate about leveraging blockchain technology to capitalize on emerging trends and maximize returns.'
+     */
+    description: string | null;
+
+    /**
+     * Profile image URL
+     *
+     * @format URL
+     * @example 'https://example.com/image.webp'
+     */
+    image: string | null;
+
+    /**
+     * Username
+     *
+     * @example 'john_doe'
+     */
+    username: string | null;
+
+    /**
+     * Username in Telegram (without starting `@`)
+     *
+     * @example 'john_doe'
+     */
+    usernameTelegram: string | null;
+
+    /**
+     * Username in X (without starting `@`)
+     *
+     * @example 'john_doe'
+     */
+    usernameX: string | null;
+
+    /**
+     * URL of user's website
+     *
+     * @format URL
+     * @example 'https://example.com'
+     */
+    websiteUrl: string | null;
+}
diff --git a/src/models/index.ts b/src/models/index.ts
@@ -6,8 +6,11 @@ export { default as Network } from './Network';
 export { default as PAT } from './PAT';
 export { default as Product } from './Product';
 export { default as Transaction } from './Transaction';
+export { default as UserAddress } from './UserAddress';
+export { default as UserProfile } from './UserProfile';
 export * from './App';
 export * from './Invoice';
 export * from './PAT';
 export * from './Transaction';
+export * from './UserAddress';
 export * from './WebhookEvent';
diff --git a/src/requests/UserAddress.ts b/src/requests/UserAddress.ts
@@ -0,0 +1,40 @@
+import { UserAddressType } from '../models';
+
+export type UserAddressCreateRequest = {
+    /**
+     * Address ID
+     *
+     * @example '0660bfde-e576-467a-af63-69edaf85f8c2'
+     */
+    id: string;
+
+    /**
+     * Address name
+     *
+     * @example 'Main Ethereum wallet'
+     */
+    name: string;
+
+    /**
+     * Address
+     *
+     * @example '0x41ce73496136A0072013B9187550e30841eDeD74'
+     */
+    address: string;
+
+    /**
+     * Network type
+     *
+     * @example 'EVM'
+     */
+    type: UserAddressType;
+};
+
+export type UserAddressUpdateRequest = {
+    /**
+     * Address name
+     *
+     * @example 'Main Ethereum wallet'
+     */
+    name?: string;
+};
diff --git a/src/requests/UserProfile.ts b/src/requests/UserProfile.ts
@@ -0,0 +1,52 @@
+export type UserProfileUpdateRequest = {
+    /**
+     * Profile name (title)
+     *
+     * @example 'Crypto trader, influencer'
+     */
+    name?: string | null;
+
+    /**
+     * Profile description (bio)
+     *
+     * @example 'Experienced crypto trader specializing in market analysis, DeFi strategies, and risk management. Passionate about leveraging blockchain technology to capitalize on emerging trends and maximize returns.'
+     */
+    description?: string | null;
+
+    /**
+     * Profile image URL
+     *
+     * @format URL
+     * @example 'https://example.com/image.webp'
+     */
+    image?: string | null;
+
+    /**
+     * Username
+     *
+     * @example 'john_doe'
+     */
+    username?: string | null;
+
+    /**
+     * Username in Telegram (without starting `@`)
+     *
+     * @example 'john_doe'
+     */
+    usernameTelegram?: string | null;
+
+    /**
+     * Username in X (without starting `@`)
+     *
+     * @example 'john_doe'
+     */
+    usernameX?: string | null;
+
+    /**
+     * URL of user's website
+     *
+     * @format URL
+     * @example 'https://example.com'
+     */
+    websiteUrl?: string | null;
+};
diff --git a/src/requests/index.ts b/src/requests/index.ts
@@ -4,4 +4,6 @@ export * from './Cryptocurrency';
 export * from './Invoice';
 export * from './PAT';
 export * from './Transaction';
+export * from './UserAddress';
 export * from './UserInvoice';
+export * from './UserProfile';
diff --git a/src/responses/UserAddress.ts b/src/responses/UserAddress.ts
@@ -0,0 +1,9 @@
+export type UserAddressCreateErrors = {
+    name?: 'required' | 'ascii' | 'max';
+    address?: 'required' | 'alphanum' | 'invalid';
+    type?: 'required' | 'oneof';
+};
+
+export type UserAddressUpdateErrors = {
+    name?: 'ascii' | 'max';
+};
diff --git a/src/responses/UserProfile.ts b/src/responses/UserProfile.ts
@@ -0,0 +1,9 @@
+export type UserProfileUpdateErrors = {
+    name?: 'ascii' | 'max';
+    description?: 'ascii' | 'max';
+    image?: 'ascii' | 'max' | 'invalid';
+    username?: 'alphanum' | 'max' | 'taken';
+    usernameTelegram?: 'username_telegram';
+    usernameX?: 'username_x';
+    websiteUrl?: 'http_url' | 'max';
+};
diff --git a/src/responses/index.ts b/src/responses/index.ts
@@ -3,4 +3,6 @@ export * from './Cryptocurrency';
 export * from './Invoice';
 export * from './PAT';
 export * from './Transaction';
+export * from './UserAddress';
 export * from './UserInvoice';
+export * from './UserProfile';
diff --git a/src/services/UserAddressService.ts b/src/services/UserAddressService.ts
@@ -0,0 +1,74 @@
+import type { UserAddress } from '../models';
+import type { UserAddressCreateRequest, UserAddressUpdateRequest } from '../requests';
+import type { UserAddressCreateErrors, UserAddressUpdateErrors } from '../responses';
+import { StatusCodes } from 'http-status-codes';
+import BaseService from '../BaseService';
+import { HttpError, ValidationError } from '../errors';
+
+export default class UserAddressService extends BaseService {
+    public async list(): Promise<UserAddress[]> {
+        const response = await this.request('GET', '?v=1');
+
+        if (!response.ok) {
+            throw new HttpError(response.status);
+        }
+
+        const data = await response.json();
+
+        return this.toCamelCase(data) as UserAddress[];
+    }
+
+    public async create(request: UserAddressCreateRequest): Promise<UserAddress> {
+        const response = await this.request('POST', '?v=1', this.toSnakeCase(request));
+
+        if (!response.ok && response.status !== StatusCodes.BAD_REQUEST) {
+            throw new HttpError(response.status);
+        }
+
+        const data = this.toCamelCase(await response.json());
+
+        if (response.status === StatusCodes.BAD_REQUEST) {
+            throw new ValidationError<UserAddressCreateErrors>(data);
+        }
+
+        return data as UserAddress;
+    }
+
+    public async get(id: string): Promise<UserAddress> {
+        const response = await this.request('GET', `/${id}?v=1`);
+
+        if (!response.ok) {
+            throw new HttpError(response.status);
+        }
+
+        const data = await response.json();
+
+        return this.toCamelCase(data) as UserAddress;
+    }
+
+    public async update(id: string, request: UserAddressUpdateRequest): Promise<UserAddress> {
+        const response = await this.request('PUT', `/${id}?v=1`, this.toSnakeCase(request));
+
+        if (!response.ok && response.status !== StatusCodes.BAD_REQUEST) {
+            throw new HttpError(response.status);
+        }
+
+        const data = this.toCamelCase(await response.json());
+
+        if (response.status === StatusCodes.BAD_REQUEST) {
+            throw new ValidationError<UserAddressUpdateErrors>(data);
+        }
+
+        return data as UserAddress;
+    }
+
+    public async delete(id: string): Promise<true> {
+        const response = await this.request('DELETE', `/${id}?v=1`);
+
+        if (!response.ok) {
+            throw new HttpError(response.status);
+        }
+
+        return true;
+    }
+}
diff --git a/src/services/UserProfileService.ts b/src/services/UserProfileService.ts
@@ -0,0 +1,36 @@
+import type { UserProfile } from '../models';
+import type { UserProfileUpdateRequest } from '../requests';
+import type { UserProfileUpdateErrors } from '../responses';
+import { StatusCodes } from 'http-status-codes';
+import BaseService from '../BaseService';
+import { HttpError, ValidationError } from '../errors';
+
+export default class UserProfileService extends BaseService {
+    public async get(): Promise<UserProfile> {
+        const response = await this.request('GET', '?v=1');
+
+        if (!response.ok) {
+            throw new HttpError(response.status);
+        }
+
+        const data = await response.json();
+
+        return this.toCamelCase(data) as UserProfile;
+    }
+
+    public async update(request: UserProfileUpdateRequest): Promise<UserProfile> {
+        const response = await this.request('PUT', '?v=1', this.toSnakeCase(request));
+
+        if (!response.ok && response.status !== StatusCodes.BAD_REQUEST) {
+            throw new HttpError(response.status);
+        }
+
+        const data = this.toCamelCase(await response.json());
+
+        if (response.status === StatusCodes.BAD_REQUEST) {
+            throw new ValidationError<UserProfileUpdateErrors>(data);
+        }
+
+        return data as UserProfile;
+    }
+}
diff --git a/src/services/UserService.ts b/src/services/UserService.ts
diff --git a/src/services/index.ts b/src/services/index.ts

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ export interface PublicApp {`
`29`	`29`	`* App image`
`30`	`30`	`*`
`31`	`31`	`* @format URL`
	`32`	`+ * @example 'https://example.com/image.webp'`
`32`	`33`	`*/`
`33`	`34`	`image: string \| null;`
`34`	`35`
`@@ -41,6 +42,7 @@ export interface PublicApp {`
`41`	`42`	`* App URL`
`42`	`43`	`*`
`43`	`44`	`* @format URL`
	`45`	`+ * @example 'https://example.com'`
`44`	`46`	`*/`
`45`	`47`	`url: string;`
`46`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ export default interface Product {`
`40`	`40`	`* Product image`
`41`	`41`	`*`
`42`	`42`	`* @format URL`
	`43`	`+ * @example 'https://example.com/image.webp'`
`43`	`44`	`*/`
`44`	`45`	`image: string \| null;`
`45`	`46`