tale-js-sdk 0.1.2 → 0.1.3

package/dist/auth/index.js

@@ -1,5 +1,5 @@
-import { getAppToken } from '../token.js';
-import { ApiError, ConfigurationError, NetworkError } from '../errors.js';
+import { getAppToken } from "../token.js";
+import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
 /**
  * Authenticates a user with username and password.
  *
@@ -32,24 +32,24 @@ import { ApiError, ConfigurationError, NetworkError } from '../errors.js';
  */
 export async function login(credentials, options) {
     // Validate required fields
-    if (!credentials.username || credentials.username.trim() === '') {
-        throw new ApiError('username is required', 400, '9400');
+    if (!credentials.username || credentials.username.trim() === "") {
+        throw new ApiError("username is required", 400, "9400");
     }
-    if (!credentials.password || credentials.password.trim() === '') {
-        throw new ApiError('password is required', 400, '9400');
+    if (!credentials.password || credentials.password.trim() === "") {
+        throw new ApiError("password is required", 400, "9400");
     }
     // Determine base URL
     const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
     const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
     if (!base) {
-        throw new ConfigurationError('Missing required environment variable: TALE_BASE_URL');
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     // Get app key from environment variable
     const appKey = env?.TALE_APP_KEY;
     if (!appKey) {
-        throw new ConfigurationError('Missing required environment variable: TALE_APP_KEY');
+        throw new ConfigurationError("Missing required environment variable: TALE_APP_KEY");
     }
-    const url = String(base).replace(/\/+$/, '') + '/auth/v1/login/username-password';
+    const url = String(base).replace(/\/+$/, "") + "/auth/v1/login/username-password";
     // Build request body
     const requestBody = {
         username: credentials.username.trim(),
@@ -57,20 +57,20 @@ export async function login(credentials, options) {
         app_key: appKey,
         device_name: options?.device_name,
         device_fingerprint: options?.device_fingerprint,
-        scope: options?.scope || ''
+        scope: options?.scope || "",
     };
     let response;
     try {
         response = await globalThis.fetch(url, {
-            method: 'POST',
+            method: "POST",
             headers: {
-                'Content-Type': 'application/json',
+                "Content-Type": "application/json",
             },
             body: JSON.stringify(requestBody),
         });
     }
     catch (error) {
-        throw new NetworkError(`Failed to authenticate user: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        throw new NetworkError(`Failed to authenticate user: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
     let json;
     try {
@@ -78,31 +78,37 @@ export async function login(credentials, options) {
         json = responseJson;
     }
     catch (error) {
-        throw new ApiError(`Failed to parse login response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
+        throw new ApiError(`Failed to parse login response: ${error instanceof Error ? error.message : "Invalid JSON"}`, response.status);
     }
     // Handle authentication errors based on response status
     if (response.status === 400) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'Authentication failed';
-        throw new ApiError(errorMsg, response.status, '9400');
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "Authentication failed";
+        throw new ApiError(errorMsg, response.status, "9400");
     }
     if (response.status === 403) {
-        throw new ApiError('Account is frozen or access forbidden', response.status, '9403');
+        throw new ApiError("Account is frozen or access forbidden", response.status, "9403");
     }
     if (response.status === 401) {
-        throw new ApiError('Invalid app_key or authentication failed', response.status, '9401');
+        throw new ApiError("Invalid app_key or authentication failed", response.status, "9401");
     }
     if (!response.ok) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'Authentication failed';
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "Authentication failed";
         throw new ApiError(errorMsg, response.status);
     }
     // Handle response data structure - check if data is wrapped in a 'data' field
     const responseData = json.data || json;
     // Validate response structure
     if (!responseData || !responseData.user || !responseData.token) {
-        console.error('Invalid response structure:', { json, responseData });
-        throw new ApiError('Invalid login response: missing required data', response.status);
+        console.error("Invalid response structure:", { json, responseData });
+        throw new ApiError("Invalid login response: missing required data", response.status);
     }
     // Build standard response structure
     const loginResponse = {
@@ -112,7 +118,7 @@ export async function login(credentials, options) {
         user_roles: responseData.user_roles || [],
         user_privileges: responseData.user_privileges || [],
         user_groups: responseData.user_groups || [],
-        user_login_methods: responseData.user_login_methods || []
+        user_login_methods: responseData.user_login_methods || [],
     };
     return loginResponse;
 }
@@ -140,31 +146,31 @@ export async function login(credentials, options) {
  */
 export async function validateToken(token, options) {
     // Validate required fields
-    if (!token || token.trim() === '') {
-        throw new ApiError('token is required', 400, '9400');
+    if (!token || token.trim() === "") {
+        throw new ApiError("token is required", 400, "9400");
     }
     // Determine base URL
     const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
     const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
     if (!base) {
-        throw new ConfigurationError('Missing required environment variable: TALE_BASE_URL');
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = new URL(String(base).replace(/\/+$/, '') + '/auth/v1/assert_token');
+    const url = new URL(String(base).replace(/\/+$/, "") + "/auth/v1/assert_token");
     if (options?.scope) {
-        url.searchParams.append('scope', options.scope);
+        url.searchParams.append("scope", options.scope);
     }
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
-            method: 'GET',
+            method: "GET",
             headers: {
-                'Content-Type': 'application/json',
-                'x-t-token': token.trim(),
+                "Content-Type": "application/json",
+                "x-t-token": token.trim(),
             },
         });
     }
     catch (error) {
-        throw new NetworkError(`Failed to validate token: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        throw new NetworkError(`Failed to validate token: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
     // Token is valid if we get a 200 response
     return response.ok;
@@ -194,31 +200,31 @@ export async function validateToken(token, options) {
  */
 export async function loginWithSms(phone, options) {
     // Validate required fields
-    if (!phone || phone.trim() === '') {
-        throw new ApiError('phone number is required', 400, '9400');
+    if (!phone || phone.trim() === "") {
+        throw new ApiError("phone number is required", 400, "9400");
     }
     // Determine base URL from environment variables
     const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
     const base = env?.TALE_BASE_URL;
     if (!base) {
-        throw new ConfigurationError('Missing required environment variable: TALE_BASE_URL');
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     // Use provided app token or get one from token service
-    const authToken = options?.appToken ?? await getAppToken();
-    const url = new URL(String(base).replace(/\/+$/, '') + '/auth/v1/sms/login_or_register');
-    url.searchParams.append('phone', phone.trim());
+    const authToken = options?.appToken ?? (await getAppToken());
+    const url = new URL(String(base).replace(/\/+$/, "") + "/auth/v1/sms/login_or_register");
+    url.searchParams.append("phone", phone.trim());
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
-            method: 'GET',
+            method: "GET",
             headers: {
-                'x-t-token': authToken,
-                'Content-Type': 'application/json',
+                "x-t-token": authToken,
+                "Content-Type": "application/json",
             },
         });
     }
     catch (error) {
-        throw new NetworkError(`Failed to send SMS verification: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        throw new NetworkError(`Failed to send SMS verification: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
     let json;
     try {
@@ -226,34 +232,40 @@ export async function loginWithSms(phone, options) {
         json = responseJson;
     }
     catch (error) {
-        throw new ApiError(`Failed to parse SMS response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
+        throw new ApiError(`Failed to parse SMS response: ${error instanceof Error ? error.message : "Invalid JSON"}`, response.status);
     }
     // Handle API errors
     if (response.status === 400) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'Invalid phone number format';
-        throw new ApiError(errorMsg, response.status, '9400');
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "Invalid phone number format";
+        throw new ApiError(errorMsg, response.status, "9400");
     }
     if (response.status === 429) {
-        throw new ApiError('SMS sending rate limit exceeded', response.status, '9705');
+        throw new ApiError("SMS sending rate limit exceeded", response.status, "9705");
     }
     if (!response.ok) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'SMS sending failed';
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "SMS sending failed";
         throw new ApiError(errorMsg, response.status);
     }
     // Handle response data structure - check if data is wrapped in a 'data' field
     const responseData = json.data || json;
     // Validate response structure
     if (!responseData || !responseData.sms_id || !responseData.type) {
-        throw new ApiError('Invalid SMS response: missing required data', response.status);
+        throw new ApiError("Invalid SMS response: missing required data", response.status);
     }
     return {
         app_key: responseData.app_key,
         phone: responseData.phone,
         type: responseData.type,
         sms_id: responseData.sms_id,
-        expired_at: responseData.expired_at
+        expired_at: responseData.expired_at,
     };
 }
 /**
@@ -285,39 +297,39 @@ export async function loginWithSms(phone, options) {
  */
 export async function verifySmsCode(request, options) {
     // Validate required fields
-    if (!request.sms_id || request.sms_id.trim() === '') {
-        throw new ApiError('sms_id is required', 400, '9400');
+    if (!request.sms_id || request.sms_id.trim() === "") {
+        throw new ApiError("sms_id is required", 400, "9400");
     }
-    if (!request.sms_type || !['login', 'register'].includes(request.sms_type)) {
-        throw new ApiError('sms_type must be "login" or "register"', 400, '9400');
+    if (!request.sms_type || !["login", "register"].includes(request.sms_type)) {
+        throw new ApiError('sms_type must be "login" or "register"', 400, "9400");
     }
-    if (!request.verification_code || request.verification_code.trim() === '') {
-        throw new ApiError('verification_code is required', 400, '9400');
+    if (!request.verification_code || request.verification_code.trim() === "") {
+        throw new ApiError("verification_code is required", 400, "9400");
     }
     // Determine base URL
     const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
     const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
     if (!base) {
-        throw new ConfigurationError('Missing required environment variable: TALE_BASE_URL');
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     // Use provided app token or get one from token service
-    const authToken = options?.appToken ?? await getAppToken(options);
-    const url = new URL(String(base).replace(/\/+$/, '') + '/auth/v1/sms/verify');
-    url.searchParams.append('sms_id', request.sms_id.trim());
-    url.searchParams.append('sms_type', request.sms_type);
-    url.searchParams.append('verification_code', request.verification_code.trim());
+    const authToken = options?.appToken ?? (await getAppToken(options));
+    const url = new URL(String(base).replace(/\/+$/, "") + "/auth/v1/sms/verify");
+    url.searchParams.append("sms_id", request.sms_id.trim());
+    url.searchParams.append("sms_type", request.sms_type);
+    url.searchParams.append("verification_code", request.verification_code.trim());
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
-            method: 'GET',
+            method: "GET",
             headers: {
-                'x-t-token': authToken,
-                'Content-Type': 'application/json',
+                "x-t-token": authToken,
+                "Content-Type": "application/json",
             },
         });
     }
     catch (error) {
-        throw new NetworkError(`Failed to verify SMS code: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        throw new NetworkError(`Failed to verify SMS code: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
     let json;
     try {
@@ -325,27 +337,33 @@ export async function verifySmsCode(request, options) {
         json = responseJson;
     }
     catch (error) {
-        throw new ApiError(`Failed to parse SMS verification response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
+        throw new ApiError(`Failed to parse SMS verification response: ${error instanceof Error ? error.message : "Invalid JSON"}`, response.status);
     }
     // Handle verification errors
     if (response.status === 400) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'SMS verification failed';
-        throw new ApiError(errorMsg, response.status, '9739');
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "SMS verification failed";
+        throw new ApiError(errorMsg, response.status, "9739");
     }
     if (response.status === 403) {
-        throw new ApiError('Account is frozen or access forbidden', response.status, '9403');
+        throw new ApiError("Account is frozen or access forbidden", response.status, "9403");
     }
     if (!response.ok) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'SMS verification failed';
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "SMS verification failed";
         throw new ApiError(errorMsg, response.status);
     }
     // Handle response data structure - check if data is wrapped in a 'data' field
     const responseData = json.data || json;
     // Validate response structure
     if (!responseData || !responseData.user || !responseData.token) {
-        throw new ApiError('Invalid SMS verification response: missing required data', response.status);
+        throw new ApiError("Invalid SMS verification response: missing required data", response.status);
     }
     // Build standard response structure
     const smsLoginResponse = {
@@ -355,7 +373,7 @@ export async function verifySmsCode(request, options) {
         user_roles: responseData.user_roles || [],
         user_privileges: responseData.user_privileges || [],
         user_groups: responseData.user_groups || [],
-        user_login_methods: responseData.user_login_methods || []
+        user_login_methods: responseData.user_login_methods || [],
     };
     return smsLoginResponse;
 }
@@ -390,39 +408,39 @@ export async function verifySmsCode(request, options) {
  */
 export async function registerWithSms(request, options) {
     // Validate required fields for registration
-    if (request.sms_type !== 'register') {
-        throw new ApiError('sms_type must be "register" for registration', 400, '9400');
+    if (request.sms_type !== "register") {
+        throw new ApiError('sms_type must be "register" for registration', 400, "9400");
     }
     // Determine base URL
     const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
     const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
     if (!base) {
-        throw new ConfigurationError('Missing required environment variable: TALE_BASE_URL');
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     // Use provided app token or get one from token service
-    const authToken = options?.appToken ?? await getAppToken(options);
-    const url = String(base).replace(/\/+$/, '') + '/auth/v1/sms/register/verify';
+    const authToken = options?.appToken ?? (await getAppToken(options));
+    const url = String(base).replace(/\/+$/, "") + "/auth/v1/sms/register/verify";
     // Build request body
     const requestBody = {
         sms_id: request.sms_id.trim(),
         sms_type: request.sms_type,
         verification_code: request.verification_code.trim(),
         username: request.username?.trim(),
-        password_encrypted: request.password_encrypted
+        password_encrypted: request.password_encrypted,
     };
     let response;
     try {
         response = await globalThis.fetch(url, {
-            method: 'POST',
+            method: "POST",
             headers: {
-                'x-t-token': authToken,
-                'Content-Type': 'application/json',
+                "x-t-token": authToken,
+                "Content-Type": "application/json",
             },
             body: JSON.stringify(requestBody),
         });
     }
     catch (error) {
-        throw new NetworkError(`Failed to register with SMS: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        throw new NetworkError(`Failed to register with SMS: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
     let json;
     try {
@@ -430,27 +448,33 @@ export async function registerWithSms(request, options) {
         json = responseJson;
     }
     catch (error) {
-        throw new ApiError(`Failed to parse registration response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
+        throw new ApiError(`Failed to parse registration response: ${error instanceof Error ? error.message : "Invalid JSON"}`, response.status);
     }
     // Handle registration errors
     if (response.status === 400) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'SMS registration failed';
-        throw new ApiError(errorMsg, response.status, '9739');
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "SMS registration failed";
+        throw new ApiError(errorMsg, response.status, "9739");
     }
     if (response.status === 403) {
-        throw new ApiError('Account is frozen or access forbidden', response.status, '9403');
+        throw new ApiError("Account is frozen or access forbidden", response.status, "9403");
     }
     if (!response.ok) {
-        const errorMsg = typeof json === 'object' && json !== null && ('message' in json || 'msg' in json) ?
-            String(json.message || json.msg) : 'SMS registration failed';
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "SMS registration failed";
         throw new ApiError(errorMsg, response.status);
     }
     // Handle response data structure - check if data is wrapped in a 'data' field
     const responseData = json.data || json;
     // Validate response structure
     if (!responseData || !responseData.user || !responseData.token) {
-        throw new ApiError('Invalid registration response: missing required data', response.status);
+        throw new ApiError("Invalid registration response: missing required data", response.status);
     }
     // Build standard response structure
     const registrationResponse = {
@@ -460,7 +484,7 @@ export async function registerWithSms(request, options) {
         user_roles: responseData.user_roles || [],
         user_privileges: responseData.user_privileges || [],
         user_groups: responseData.user_groups || [],
-        user_login_methods: responseData.user_login_methods || []
+        user_login_methods: responseData.user_login_methods || [],
     };
     return registrationResponse;
 }

package/dist/auth/types.d.ts

@@ -0,0 +1,122 @@
+import type { AppInfo, BaseUser, UserGroup, Role, Privilege, CommonOptions } from "../common/types.js";
+export type { AppInfo, UserGroup };
+/**
+ * Auth user information (extends BaseUser with non-null remark)
+ */
+export interface AuthUser extends Omit<BaseUser, "remark"> {
+    remark: string;
+}
+/**
+ * User token information
+ */
+export interface UserToken {
+    token: string;
+    scope: string;
+    device_name?: string;
+    device_fingerprint?: string;
+    granted_at: string;
+    expired_at: string;
+}
+/**
+ * Auth role (extends base Role with additional fields)
+ */
+export interface AuthRole extends Role {
+    assigned_at: string;
+    expires_at?: string;
+    is_active: boolean;
+}
+/**
+ * Auth privilege (extends base Privilege with additional fields)
+ */
+export interface AuthPrivilege extends Privilege {
+    granted_directly: boolean;
+    role_id?: string;
+    assigned_at: string;
+    expires_at?: string;
+    is_active: boolean;
+}
+/**
+ * Auth user login method
+ */
+export interface AuthUserLoginMethod {
+    method_type: string;
+    identifier: string;
+    is_active: boolean;
+    created_at: string;
+    last_used_at?: string;
+}
+export interface LoginRequest {
+    username: string;
+    password: string;
+}
+export interface LoginOptions {
+    baseUrl?: string;
+    device_name?: string;
+    device_fingerprint?: string;
+    scope?: string;
+}
+export interface LoginResponse {
+    app: AppInfo;
+    user: AuthUser;
+    token: UserToken;
+    user_roles: AuthRole[];
+    user_privileges: AuthPrivilege[];
+    user_groups: UserGroup[];
+    user_login_methods: AuthUserLoginMethod[];
+}
+export interface LoginJson {
+    app: AppInfo;
+    user: AuthUser;
+    token: UserToken;
+    user_roles: AuthRole[];
+    user_privileges: AuthPrivilege[];
+    user_groups: UserGroup[];
+    user_login_methods: AuthUserLoginMethod[];
+}
+export interface LoginWithSmsOptions {
+    appToken?: string;
+}
+export interface VerifySmsOptions extends CommonOptions {
+    device_name?: string;
+    device_fingerprint?: string;
+    scope?: string;
+}
+export interface SendSmsResponse {
+    app_key: string;
+    phone: string;
+    type: "login" | "register";
+    sms_id: string;
+    expired_at: string;
+}
+export interface SendSmsJson {
+    app_key: string;
+    phone: string;
+    type: "login" | "register";
+    sms_id: string;
+    expired_at: string;
+}
+export interface VerifySmsRequest {
+    sms_id: string;
+    sms_type: "login" | "register";
+    verification_code: string;
+    username?: string;
+    password_encrypted?: string;
+}
+export interface SmsLoginResponse {
+    app: AppInfo;
+    user: AuthUser;
+    token: UserToken;
+    user_roles: AuthRole[];
+    user_privileges: AuthPrivilege[];
+    user_groups: UserGroup[];
+    user_login_methods: AuthUserLoginMethod[];
+}
+export interface SmsLoginJson {
+    app: AppInfo;
+    user: AuthUser;
+    token: UserToken;
+    user_roles: AuthRole[];
+    user_privileges: AuthPrivilege[];
+    user_groups: UserGroup[];
+    user_login_methods: AuthUserLoginMethod[];
+}

package/dist/auth/types.js

@@ -0,0 +1 @@
+export {};

package/dist/common/types.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Application information
+ */
+export interface AppInfo {
+    app_id: string;
+    org_id: string;
+    app_key: string;
+    app_name: string;
+}
+/**
+ * Base user information with common fields
+ */
+export interface BaseUser {
+    user_id: string;
+    nick_name: string;
+    avatar_url: string;
+    username: string;
+    email: string;
+    phone: string;
+    registered_at: string;
+    remark: string | null;
+    is_frozen: boolean;
+    latest_login_time?: string;
+}
+/**
+ * User group information
+ */
+export interface UserGroup {
+    group_id: string;
+    group_name: string;
+    description?: string;
+}
+/**
+ * Role information
+ */
+export interface Role {
+    role_id: string;
+    role_name: string;
+    description?: string;
+}
+/**
+ * Privilege information
+ */
+export interface Privilege {
+    privilege_id: string;
+    privilege_name: string;
+    description?: string;
+}
+/**
+ * Sort information for pagination
+ */
+export interface Sort {
+    empty: boolean;
+    sorted: boolean;
+    unsorted: boolean;
+}
+/**
+ * Pageable information for pagination
+ */
+export interface Pageable {
+    sort: Sort;
+    offset: number;
+    pageNumber: number;
+    pageSize: number;
+    paged: boolean;
+    unpaged: boolean;
+}
+/**
+ * Common API request options
+ */
+export interface CommonOptions {
+    baseUrl?: string;
+    appKey?: string;
+    appSecret?: string;
+    appToken?: string;
+}