@marcohefti/request-network-api-client 0.5.0 → 0.5.5

package/dist/esm/index.d.mts

@@ -3627,10 +3627,61 @@ interface RequestClient {
     /** Legacy pay endpoints */
     pay: PayApi;
 }
+/**
+ * Creates a Request Network API client with typed domain facades.
+ *
+ * @param options - Client configuration options
+ * @param options.baseUrl - API base URL (defaults to production if not provided)
+ * @param options.apiKey - API key for server-side authentication
+ * @param options.clientId - Client ID for browser/frontend authentication
+ * @param options.runtimeValidation - Enable/disable runtime validation (default: true)
+ * @param options.logLevel - Logging level: 'silent' | 'error' | 'info' | 'debug' (default: 'error')
+ * @param options.logger - Custom logger function
+ * @param options.userAgent - Custom user agent string
+ * @param options.retry - Retry configuration
+ *
+ * @returns RequestClient instance with domain APIs
+ *
+ * @example
+ * ```ts
+ * import { createRequestClient, RequestEnvironment } from '@marcohefti/request-network-api-client';
+ *
+ * const client = createRequestClient({
+ *   baseUrl: RequestEnvironment.production,
+ *   apiKey: process.env.REQUEST_API_KEY,
+ *   logLevel: 'info',
+ * });
+ *
+ * const tokens = await client.currencies.list({ network: 'sepolia' });
+ * ```
+ */
 declare function createRequestClient(options?: CreateClientOptions): RequestClient;
 interface EnvOptions {
     env?: NodeJS.ProcessEnv;
 }
+/**
+ * Creates a Request Network API client from environment variables.
+ *
+ * Reads configuration from the following environment variables (in order of preference):
+ * - `REQUEST_API_URL` (or legacy `REQUEST_SDK_BASE_URL`)
+ * - `REQUEST_API_KEY` (or legacy `REQUEST_SDK_API_KEY`)
+ * - `REQUEST_CLIENT_ID` (or legacy `REQUEST_SDK_CLIENT_ID`)
+ *
+ * @param options - Optional environment override
+ * @param options.env - Custom environment object (defaults to process.env)
+ *
+ * @returns RequestClient instance configured from environment
+ *
+ * @example
+ * ```ts
+ * import { createRequestClientFromEnv } from '@marcohefti/request-network-api-client';
+ *
+ * const client = createRequestClientFromEnv();
+ * // Reads REQUEST_API_KEY, REQUEST_CLIENT_ID, REQUEST_API_URL from process.env
+ *
+ * const tokens = await client.currencies.list({ network: 'sepolia' });
+ * ```
+ */
 declare function createRequestClientFromEnv(options?: EnvOptions): RequestClient;
 
 declare const RequestEnvironment: {

package/dist/esm/index.js

@@ -3383,8 +3383,8 @@ function isAgreementRejected(payload) {
 }
 function complianceStatusSummary(payload) {
   const parts = [];
-  const kyc = payload.kycStatus ? String(payload.kycStatus).replace(/_/g, " ") : "unknown";
-  const agreement = payload.agreementStatus ? String(payload.agreementStatus).replace(/_/g, " ") : "unknown";
+  const kyc = payload.kycStatus ? payload.kycStatus.replace(/_/g, " ") : "unknown";
+  const agreement = payload.agreementStatus ? payload.agreementStatus.replace(/_/g, " ") : "unknown";
   parts.push(`KYC: ${kyc}`);
   parts.push(`Agreement: ${agreement}`);
   if (payload.clientUserId) {