@nevermined-io/payments 1.0.0-rc0 → 1.0.0-rc2

package/dist/api/query-api.js

@@ -1,56 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AIQueryApi = exports.AIQueryOptions = void 0;
+exports.AIQueryApi = void 0;
 const nvm_api_1 = require("./nvm-api");
 /**
- * Options required for interacting with an external AI Agent/Service.
- */
-class AIQueryOptions {
-}
-exports.AIQueryOptions = AIQueryOptions;
-/**
- * The AI Query API class provides the methods to interact with the AI Query API.
- * This API implements the Nevermined AI Query Protocol @see https://docs.nevermined.io/docs/protocol/query-protocol.
- *
+ * The AIQueryApi class provides methods to query AI Agents on Nevermined.
+
  * @remarks
- * This API is oriented for AI Builders providing AI Agents and AI Subscribers interacting with them.
+ * This API is oriented for AI users who already purchased access to an AI Agent and want to start querying them.
  */
-class AIQueryApi extends nvm_api_1.NVMBackendApi {
-    constructor(opts) {
-        super(opts);
-        this.queryOptionsCache = new Map();
-    }
+class AIQueryApi extends nvm_api_1.AbstractHTTPClient {
     /**
-     * Get the required configuration for accessing a remote service agent.
-     * This configuration includes:
-     * - The JWT access token
-     * - The Proxy url that can be used to query the agent/service.
-     *
-     * @example
-     * ```
-     * const accessConfig = await payments.query.getServiceAccessConfig(agentId)
-     * console.log(`Agent JWT Token: ${accessConfig.accessToken}`)
-     * console.log(`Agent Proxy URL: ${accessConfig.neverminedProxyUri}`)
-     * ```
+     * This method is used to create a singleton instance of the AIQueryApi class.
      *
-     * @param agentId - The unique identifier of the agent
-     * @returns A promise that resolves to the service token.
+     * @param options - The options to initialize the payments class.
+     * @returns The instance of the AIQueryApi class.
      */
-    async getServiceAccessConfig(agentId) {
-        const options = {
-            method: 'GET',
-            headers: {
-                Accept: 'application/json',
-                'Content-Type': 'application/json',
-                Authorization: `Bearer ${this.opts.apiKey}`,
-            },
-        };
-        const url = new URL(`/api/v1/payments/service/token/${agentId}`, this.opts.backendHost);
-        const response = await fetch(url, options);
-        if (!response.ok) {
-            throw Error(`${response.statusText} - ${await response.text()}`);
-        }
-        return (await response.json()).token;
+    static getInstance() {
+        return new AIQueryApi();
     }
     /**
      * It sends a request to the AI Agent/Service.
@@ -62,7 +28,7 @@ class AIQueryApi extends nvm_api_1.NVMBackendApi {
      * To send this request through a Nevermined proxy, it's necessary to specify the "sendThroughProxy" in the reqOptions parameter
      * @example
      * ```
-     * await payments.query.send('POST', 'http://example.com/agent/prompt', {'input': 'Hello'})
+     * await payments.query.send(accessCredentials, 'POST', 'http://example.com/agent/prompt', {'input': 'Hello'})
      * ```
      *
      * @param method - The HTTP method to use when querying the Agent @see {@link AxiosRequestConfig.method}
@@ -71,9 +37,14 @@ class AIQueryApi extends nvm_api_1.NVMBackendApi {
      * @param reqOptions - The request options to use when querying the Agent/Service.
      * @returns The result of query
      */
-    async send(method, url, data, reqOptions = {
+    async send(accessCredentials, method, url, data, reqOptions = {
         sendThroughProxy: false,
     }) {
+        reqOptions.accessToken = accessCredentials.accessToken;
+        if (accessCredentials.proxies && accessCredentials.proxies.length > 0) {
+            reqOptions.proxyHost = accessCredentials.proxies[0];
+            reqOptions.sendThroughProxy = true;
+        }
         return this.request(method, url, data, reqOptions);
     }
 }

package/dist/api/query-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-api.js","sourceRoot":"","sources":["../../src/api/query-api.ts"],"names":[],"mappings":";;;AAAA,uCAAgF;AAEhF;;GAEG;AACH,MAAa,cAAc;CAW1B;AAXD,wCAWC;AAED;;;;;;GAMG;AACH,MAAa,UAAW,SAAQ,uBAAa;IAG3C,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,CAAA;QAHb,sBAAiB,GAAG,IAAI,GAAG,EAA0B,CAAA;IAIrD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,sBAAsB,CAAC,OAAe;QAIjD,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;aAC5C;SACF,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,kCAAkC,OAAO,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,GAAG,QAAQ,CAAC,UAAU,MAAM,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAClE,CAAC;QAED,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAA;IACtC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,IAAI,CACR,MAAmD,EACnD,GAAW,EACX,IAAU,EACV,aAAiC;QAC/B,gBAAgB,EAAE,KAAK;KACxB;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,CAAA;IACpD,CAAC;CACF;AAzED,gCAyEC"}
+{"version":3,"file":"query-api.js","sourceRoot":"","sources":["../../src/api/query-api.ts"],"names":[],"mappings":";;;AAAA,uCAAkE;AAGlE;;;;;GAKG;AACH,MAAa,UAAW,SAAQ,4BAAkB;IAChD;;;;;OAKG;IACH,MAAM,CAAC,WAAW;QAChB,OAAO,IAAI,UAAU,EAAE,CAAA;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,IAAI,CACR,iBAAyC,EACzC,MAAmD,EACnD,GAAW,EACX,IAAU,EACV,aAAiC;QAC/B,gBAAgB,EAAE,KAAK;KACxB;QAED,UAAU,CAAC,WAAW,GAAG,iBAAiB,CAAC,WAAW,CAAA;QACtD,IAAI,iBAAiB,CAAC,OAAO,IAAI,iBAAiB,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtE,UAAU,CAAC,SAAS,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;YACnD,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAA;QACpC,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,CAAA;IACpD,CAAC;CACF;AA9CD,gCA8CC","sourcesContent":["import { AbstractHTTPClient, HTTPRequestOptions } from './nvm-api'\nimport { AgentAccessCredentials } from '../common/types'\n\n/**\n * The AIQueryApi class provides methods to query AI Agents on Nevermined.\n\n * @remarks\n * This API is oriented for AI users who already purchased access to an AI Agent and want to start querying them.\n */\nexport class AIQueryApi extends AbstractHTTPClient {\n  /**\n   * This method is used to create a singleton instance of the AIQueryApi class.\n   *\n   * @param options - The options to initialize the payments class.\n   * @returns The instance of the AIQueryApi class.\n   */\n  static getInstance(): AIQueryApi {\n    return new AIQueryApi()\n  }\n\n  /**\n   * It sends a request to the AI Agent/Service.\n   *\n   * @remarks\n   * This method is used to query an existing AI Agent. It requires the user controlling the NVM API Key to have access to the agent.\n   *\n   * @remarks\n   * To send this request through a Nevermined proxy, it's necessary to specify the \"sendThroughProxy\" in the reqOptions parameter\n   * @example\n   * ```\n   * await payments.query.send(accessCredentials, 'POST', 'http://example.com/agent/prompt', {'input': 'Hello'})\n   * ```\n   *\n   * @param method - The HTTP method to use when querying the Agent @see {@link AxiosRequestConfig.method}\n   * @param url - The URL of the endpoint to query the Agent/Service.\n   * @param data - The data to send to the Agent/Service.\n   * @param reqOptions - The request options to use when querying the Agent/Service.\n   * @returns The result of query\n   */\n  async send(\n    accessCredentials: AgentAccessCredentials,\n    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH',\n    url: string,\n    data?: any,\n    reqOptions: HTTPRequestOptions = {\n      sendThroughProxy: false,\n    },\n  ) {\n    reqOptions.accessToken = accessCredentials.accessToken\n    if (accessCredentials.proxies && accessCredentials.proxies.length > 0) {\n      reqOptions.proxyHost = accessCredentials.proxies[0]\n      reqOptions.sendThroughProxy = true\n    }\n    return this.request(method, url, data, reqOptions)\n  }\n}\n"]}

package/dist/api/requests-api.d.ts

@@ -0,0 +1,108 @@
+import { BasePaymentsAPI } from './base-payments';
+import { PaymentOptions, TrackAgentSubTaskDto, StartAgentRequest, NvmAPIResult } from '../common/types';
+/**
+ * The AgentRequestsAPI class provides methods to manage the requests received by AI Agents integrated with Nevermined.
+ *
+ */
+export declare class AgentRequestsAPI extends BasePaymentsAPI {
+    /**
+     * This method is used to create a singleton instance of the AgentRequestsAPI class.
+     *
+     * @param options - The options to initialize the payments class.
+     * @returns The instance of the AgentRequestsAPI class.
+     */
+    static getInstance(options: PaymentOptions): AgentRequestsAPI;
+    /**
+     * This method initializes an agent request.
+     *
+     * @remarks
+     * This method is used to initialize an agent request.
+     *
+     * @param agentId - The unique identifier of the AI Agent.
+     * @param accessToken - The access token provided by the subscriber to validate
+     * @param urlRequested - The URL requested by the subscriber to access the agent's API.
+     * @param httpMethodRequested - The HTTP method requested by the subscriber to access the agent's API.
+     * @returns @see {@link StartAgentRequest} The information about the initialization of the request.
+     * @throws PaymentsError if unable to initialize the agent request.
+     *
+     * @example
+     * ```
+     * onst authHeader = req.headers['authorization']
+     *
+     * const result = await payments.requests.startProcessingRequest(
+     *  agentId,
+     *  authHeader,
+     *  'https://api.example.com/agent-endpoint/1234',
+     *  'POST'
+     * )
+     *
+     * // {
+     * //   agentRequestId: '3921032910321',
+     * //   urlMatching: 'https://api.example.com/agent-endpoint/1234',
+     * //   verbMatching: 'POST',
+     * //   balance: {
+     * //     planId: '105906633592154016712415751065660953070604027297000423385655551747721326921578',
+     * //     planType: 'credits',
+     * //     holderAddress: '0x505384192Ba6a4D4b50EAB846ee67db3b9A93359',
+     * //     creditsContract: '0xdd0240858fE744C3BF245DD377abBC04d1FDA443',
+     * //     balance: '100',
+     * //     isSubscriber: true
+     * //   }
+     * // }
+     * ```
+     */
+    startProcessingRequest(agentId: string, accessToken: string, urlRequested: string, httpMethodRequested: string): Promise<StartAgentRequest>;
+    /**
+     * Allows the agent to redeem credits from a request.
+     *
+     * @param agentRequestId - The unique identifier of the agent request.
+     * @param requestAccessToken - The access token of the request.
+     * @param creditsToBurn - The number of credits to burn.
+     * @returns @see {@link NvmAPIResult} A promise that resolves to the result of the operation.
+     * @throws PaymentsError if unable to redeem credits from the request.
+     *
+     * @example
+     * ```
+     * const result = await payments.requests.redeemCreditsFromRequest(
+     *   'request-id-12345', // The request ID to track the operation
+     *    accessToken, // The access token of the request
+     *    5n // The number of credits to burn
+     * )
+     *
+     * // {
+     * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',
+     * //   success: true
+     * // }
+     * ```
+     */
+    redeemCreditsFromRequest(agentRequestId: string, requestAccessToken: string, creditsToBurn: bigint): Promise<NvmAPIResult>;
+    /**
+     * Tracks an agent sub task.
+     *
+     * @remarks
+     * This method is used by agent owners to track agent sub tasks for agent tasks.
+     * It records information about credit redemption, categorization tags, and processing descriptions.
+     *
+     * @param trackAgentSubTask - @see {@link TrackAgentSubTaskDto} The agent sub task data to track
+     * @returns @see {@link NvmAPIResult} A promise that resolves to the result of the operation.
+     * @throws PaymentsError if unable to track the agent sub task
+     *
+     * @example
+     * ```
+     * const result = await payments.requests.trackAgentSubTask({
+     *   agentRequestId: 'atx-12345',
+     *   creditsToRedeem: 5,
+     *   tag: 'high-priority',
+     *   description: 'Processing high-priority data request',
+     *   status: AgentTaskStatus.SUCCESS
+     * })
+     *
+     * // {
+     * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',
+     * //   success: true
+     * // }
+     * ```
+     */
+    trackAgentSubTask(trackAgentSubTask: TrackAgentSubTaskDto): Promise<NvmAPIResult>;
+}
+//# sourceMappingURL=requests-api.d.ts.map

package/dist/api/requests-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests-api.d.ts","sourceRoot":"","sources":["../../src/api/requests-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EACb,MAAM,iBAAiB,CAAA;AASxB;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACnD;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB;IAI7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACU,sBAAsB,CACjC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAoB7B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,wBAAwB,CACnC,cAAc,EAAE,MAAM,EACtB,kBAAkB,EAAE,MAAM,EAC1B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,YAAY,CAAC;IAmCxB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,iBAAiB,CAAC,iBAAiB,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;CAqB/F"}

package/dist/api/requests-api.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentRequestsAPI = void 0;
+const base_payments_1 = require("./base-payments");
+const nvm_api_1 = require("./nvm-api");
+const payments_error_1 = require("../common/payments.error");
+const utils_1 = require("../utils");
+/**
+ * The AgentRequestsAPI class provides methods to manage the requests received by AI Agents integrated with Nevermined.
+ *
+ */
+class AgentRequestsAPI extends base_payments_1.BasePaymentsAPI {
+    /**
+     * This method is used to create a singleton instance of the AgentRequestsAPI class.
+     *
+     * @param options - The options to initialize the payments class.
+     * @returns The instance of the AgentRequestsAPI class.
+     */
+    static getInstance(options) {
+        return new AgentRequestsAPI(options);
+    }
+    /**
+     * This method initializes an agent request.
+     *
+     * @remarks
+     * This method is used to initialize an agent request.
+     *
+     * @param agentId - The unique identifier of the AI Agent.
+     * @param accessToken - The access token provided by the subscriber to validate
+     * @param urlRequested - The URL requested by the subscriber to access the agent's API.
+     * @param httpMethodRequested - The HTTP method requested by the subscriber to access the agent's API.
+     * @returns @see {@link StartAgentRequest} The information about the initialization of the request.
+     * @throws PaymentsError if unable to initialize the agent request.
+     *
+     * @example
+     * ```
+     * onst authHeader = req.headers['authorization']
+     *
+     * const result = await payments.requests.startProcessingRequest(
+     *  agentId,
+     *  authHeader,
+     *  'https://api.example.com/agent-endpoint/1234',
+     *  'POST'
+     * )
+     *
+     * // {
+     * //   agentRequestId: '3921032910321',
+     * //   urlMatching: 'https://api.example.com/agent-endpoint/1234',
+     * //   verbMatching: 'POST',
+     * //   balance: {
+     * //     planId: '105906633592154016712415751065660953070604027297000423385655551747721326921578',
+     * //     planType: 'credits',
+     * //     holderAddress: '0x505384192Ba6a4D4b50EAB846ee67db3b9A93359',
+     * //     creditsContract: '0xdd0240858fE744C3BF245DD377abBC04d1FDA443',
+     * //     balance: '100',
+     * //     isSubscriber: true
+     * //   }
+     * // }
+     * ```
+     */
+    async startProcessingRequest(agentId, accessToken, urlRequested, httpMethodRequested) {
+        const initializeAgentUrl = nvm_api_1.API_URL_INITIALIZE_AGENT.replace(':agentId', agentId);
+        const body = {
+            accessToken,
+            endpoint: urlRequested,
+            httpVerb: httpMethodRequested,
+        };
+        const options = this.getBackendHTTPOptions('POST', body);
+        const url = new URL(initializeAgentUrl, this.environment.backend);
+        const response = await fetch(url, options);
+        if (!response.ok) {
+            throw new payments_error_1.PaymentsError(`Unable to validate access token. ${response.statusText} - ${await response.text()}`);
+        }
+        return response.json();
+    }
+    /**
+     * Allows the agent to redeem credits from a request.
+     *
+     * @param agentRequestId - The unique identifier of the agent request.
+     * @param requestAccessToken - The access token of the request.
+     * @param creditsToBurn - The number of credits to burn.
+     * @returns @see {@link NvmAPIResult} A promise that resolves to the result of the operation.
+     * @throws PaymentsError if unable to redeem credits from the request.
+     *
+     * @example
+     * ```
+     * const result = await payments.requests.redeemCreditsFromRequest(
+     *   'request-id-12345', // The request ID to track the operation
+     *    accessToken, // The access token of the request
+     *    5n // The number of credits to burn
+     * )
+     *
+     * // {
+     * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',
+     * //   success: true
+     * // }
+     * ```
+     */
+    async redeemCreditsFromRequest(agentRequestId, requestAccessToken, creditsToBurn) {
+        // Decode the access token to get the wallet address and plan ID
+        const decodedToken = (0, utils_1.decodeAccessToken)(requestAccessToken);
+        if (!decodedToken) {
+            throw new payments_error_1.PaymentsError('Invalid access token provided');
+        }
+        // Extract wallet address and plan ID from the token
+        const walletAddress = decodedToken.authToken?.sub || decodedToken.sub;
+        const planId = decodedToken.authToken?.planId || decodedToken.planId;
+        if (!walletAddress || !planId) {
+            throw new payments_error_1.PaymentsError('Missing wallet address or plan ID in access token');
+        }
+        const body = {
+            agentRequestId,
+            planId: BigInt(planId),
+            redeemFrom: walletAddress,
+            amount: creditsToBurn,
+        };
+        const options = this.getBackendHTTPOptions('POST', body);
+        const url = new URL(nvm_api_1.API_URL_REDEEM_PLAN, this.environment.backend);
+        const response = await fetch(url, options);
+        if (!response.ok) {
+            const responseText = await response.text();
+            throw new payments_error_1.PaymentsError(`Unable to redeem credits from request. ${response.status} ${response.statusText} - ${responseText}`);
+        }
+        return response.json();
+    }
+    /**
+     * Tracks an agent sub task.
+     *
+     * @remarks
+     * This method is used by agent owners to track agent sub tasks for agent tasks.
+     * It records information about credit redemption, categorization tags, and processing descriptions.
+     *
+     * @param trackAgentSubTask - @see {@link TrackAgentSubTaskDto} The agent sub task data to track
+     * @returns @see {@link NvmAPIResult} A promise that resolves to the result of the operation.
+     * @throws PaymentsError if unable to track the agent sub task
+     *
+     * @example
+     * ```
+     * const result = await payments.requests.trackAgentSubTask({
+     *   agentRequestId: 'atx-12345',
+     *   creditsToRedeem: 5,
+     *   tag: 'high-priority',
+     *   description: 'Processing high-priority data request',
+     *   status: AgentTaskStatus.SUCCESS
+     * })
+     *
+     * // {
+     * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',
+     * //   success: true
+     * // }
+     * ```
+     */
+    async trackAgentSubTask(trackAgentSubTask) {
+        const body = {
+            agentRequestId: trackAgentSubTask.agentRequestId,
+            creditsToRedeem: trackAgentSubTask.creditsToRedeem || 0,
+            tag: trackAgentSubTask.tag,
+            description: trackAgentSubTask.description,
+            status: trackAgentSubTask.status,
+        };
+        const options = this.getBackendHTTPOptions('POST', body);
+        const url = new URL(nvm_api_1.API_URL_TRACK_AGENT_SUB_TASK, this.environment.backend);
+        const response = await fetch(url, options);
+        if (!response.ok) {
+            throw new payments_error_1.PaymentsError(`Unable to track agent sub task. ${response.statusText} - ${await response.text()}`);
+        }
+        return response.json();
+    }
+}
+exports.AgentRequestsAPI = AgentRequestsAPI;
+//# sourceMappingURL=requests-api.js.map

package/dist/api/requests-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests-api.js","sourceRoot":"","sources":["../../src/api/requests-api.ts"],"names":[],"mappings":";;;AAAA,mDAAiD;AAOjD,uCAIkB;AAClB,6DAAwD;AACxD,oCAA4C;AAE5C;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,+BAAe;IACnD;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,OAAuB;QACxC,OAAO,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACtC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,KAAK,CAAC,sBAAsB,CACjC,OAAe,EACf,WAAmB,EACnB,YAAoB,EACpB,mBAA2B;QAE3B,MAAM,kBAAkB,GAAG,kCAAwB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAQ,CAAC,CAAA;QACjF,MAAM,IAAI,GAAG;YACX,WAAW;YACX,QAAQ,EAAE,YAAY;YACtB,QAAQ,EAAE,mBAAmB;SAC9B,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAExD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACjE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,8BAAa,CACrB,oCAAoC,QAAQ,CAAC,UAAU,MAAM,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,CACrF,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,wBAAwB,CACnC,cAAsB,EACtB,kBAA0B,EAC1B,aAAqB;QAErB,gEAAgE;QAChE,MAAM,YAAY,GAAG,IAAA,yBAAiB,EAAC,kBAAkB,CAAC,CAAA;QAC1D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,8BAAa,CAAC,+BAA+B,CAAC,CAAA;QAC1D,CAAC;QAED,oDAAoD;QACpD,MAAM,aAAa,GAAG,YAAY,CAAC,SAAS,EAAE,GAAG,IAAI,YAAY,CAAC,GAAG,CAAA;QACrE,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,EAAE,MAAM,IAAI,YAAY,CAAC,MAAM,CAAA;QAEpE,IAAI,CAAC,aAAa,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,IAAI,8BAAa,CAAC,mDAAmD,CAAC,CAAA;QAC9E,CAAC;QAED,MAAM,IAAI,GAAG;YACX,cAAc;YACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,UAAU,EAAE,aAAa;YACzB,MAAM,EAAE,aAAa;SACtB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,6BAAmB,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YAC1C,MAAM,IAAI,8BAAa,CACrB,0CAA0C,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,MAAM,YAAY,EAAE,CACrG,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,iBAAiB,CAAC,iBAAuC;QACpE,MAAM,IAAI,GAAG;YACX,cAAc,EAAE,iBAAiB,CAAC,cAAc;YAChD,eAAe,EAAE,iBAAiB,CAAC,eAAe,IAAI,CAAC;YACvD,GAAG,EAAE,iBAAiB,CAAC,GAAG;YAC1B,WAAW,EAAE,iBAAiB,CAAC,WAAW;YAC1C,MAAM,EAAE,iBAAiB,CAAC,MAAM;SACjC,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,sCAA4B,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC3E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,8BAAa,CACrB,mCAAmC,QAAQ,CAAC,UAAU,MAAM,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,CACpF,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;CACF;AAzLD,4CAyLC","sourcesContent":["import { BasePaymentsAPI } from './base-payments'\nimport {\n  PaymentOptions,\n  TrackAgentSubTaskDto,\n  StartAgentRequest,\n  NvmAPIResult,\n} from '../common/types'\nimport {\n  API_URL_REDEEM_PLAN,\n  API_URL_INITIALIZE_AGENT,\n  API_URL_TRACK_AGENT_SUB_TASK,\n} from './nvm-api'\nimport { PaymentsError } from '../common/payments.error'\nimport { decodeAccessToken } from '../utils'\n\n/**\n * The AgentRequestsAPI class provides methods to manage the requests received by AI Agents integrated with Nevermined.\n *\n */\nexport class AgentRequestsAPI extends BasePaymentsAPI {\n  /**\n   * This method is used to create a singleton instance of the AgentRequestsAPI class.\n   *\n   * @param options - The options to initialize the payments class.\n   * @returns The instance of the AgentRequestsAPI class.\n   */\n  static getInstance(options: PaymentOptions): AgentRequestsAPI {\n    return new AgentRequestsAPI(options)\n  }\n\n  /**\n   * This method initializes an agent request.\n   *\n   * @remarks\n   * This method is used to initialize an agent request.\n   *\n   * @param agentId - The unique identifier of the AI Agent.\n   * @param accessToken - The access token provided by the subscriber to validate\n   * @param urlRequested - The URL requested by the subscriber to access the agent's API.\n   * @param httpMethodRequested - The HTTP method requested by the subscriber to access the agent's API.\n   * @returns @see {@link StartAgentRequest} The information about the initialization of the request.\n   * @throws PaymentsError if unable to initialize the agent request.\n   *\n   * @example\n   * ```\n   * onst authHeader = req.headers['authorization']\n   *\n   * const result = await payments.requests.startProcessingRequest(\n   *  agentId,\n   *  authHeader,\n   *  'https://api.example.com/agent-endpoint/1234',\n   *  'POST'\n   * )\n   *\n   * // {\n   * //   agentRequestId: '3921032910321',\n   * //   urlMatching: 'https://api.example.com/agent-endpoint/1234',\n   * //   verbMatching: 'POST',\n   * //   balance: {\n   * //     planId: '105906633592154016712415751065660953070604027297000423385655551747721326921578',\n   * //     planType: 'credits',\n   * //     holderAddress: '0x505384192Ba6a4D4b50EAB846ee67db3b9A93359',\n   * //     creditsContract: '0xdd0240858fE744C3BF245DD377abBC04d1FDA443',\n   * //     balance: '100',\n   * //     isSubscriber: true\n   * //   }\n   * // }\n   * ```\n   */\n  public async startProcessingRequest(\n    agentId: string,\n    accessToken: string,\n    urlRequested: string,\n    httpMethodRequested: string,\n  ): Promise<StartAgentRequest> {\n    const initializeAgentUrl = API_URL_INITIALIZE_AGENT.replace(':agentId', agentId!)\n    const body = {\n      accessToken,\n      endpoint: urlRequested,\n      httpVerb: httpMethodRequested,\n    }\n    const options = this.getBackendHTTPOptions('POST', body)\n\n    const url = new URL(initializeAgentUrl, this.environment.backend)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw new PaymentsError(\n        `Unable to validate access token. ${response.statusText} - ${await response.text()}`,\n      )\n    }\n\n    return response.json()\n  }\n\n  /**\n   * Allows the agent to redeem credits from a request.\n   *\n   * @param agentRequestId - The unique identifier of the agent request.\n   * @param requestAccessToken - The access token of the request.\n   * @param creditsToBurn - The number of credits to burn.\n   * @returns @see {@link NvmAPIResult} A promise that resolves to the result of the operation.\n   * @throws PaymentsError if unable to redeem credits from the request.\n   *\n   * @example\n   * ```\n   * const result = await payments.requests.redeemCreditsFromRequest(\n   *   'request-id-12345', // The request ID to track the operation\n   *    accessToken, // The access token of the request\n   *    5n // The number of credits to burn\n   * )\n   *\n   * // {\n   * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',\n   * //   success: true\n   * // }\n   * ```\n   */\n  public async redeemCreditsFromRequest(\n    agentRequestId: string,\n    requestAccessToken: string,\n    creditsToBurn: bigint,\n  ): Promise<NvmAPIResult> {\n    // Decode the access token to get the wallet address and plan ID\n    const decodedToken = decodeAccessToken(requestAccessToken)\n    if (!decodedToken) {\n      throw new PaymentsError('Invalid access token provided')\n    }\n\n    // Extract wallet address and plan ID from the token\n    const walletAddress = decodedToken.authToken?.sub || decodedToken.sub\n    const planId = decodedToken.authToken?.planId || decodedToken.planId\n\n    if (!walletAddress || !planId) {\n      throw new PaymentsError('Missing wallet address or plan ID in access token')\n    }\n\n    const body = {\n      agentRequestId,\n      planId: BigInt(planId),\n      redeemFrom: walletAddress,\n      amount: creditsToBurn,\n    }\n\n    const options = this.getBackendHTTPOptions('POST', body)\n    const url = new URL(API_URL_REDEEM_PLAN, this.environment.backend)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      const responseText = await response.text()\n      throw new PaymentsError(\n        `Unable to redeem credits from request. ${response.status} ${response.statusText} - ${responseText}`,\n      )\n    }\n\n    return response.json()\n  }\n\n  /**\n   * Tracks an agent sub task.\n   *\n   * @remarks\n   * This method is used by agent owners to track agent sub tasks for agent tasks.\n   * It records information about credit redemption, categorization tags, and processing descriptions.\n   *\n   * @param trackAgentSubTask - @see {@link TrackAgentSubTaskDto} The agent sub task data to track\n   * @returns @see {@link NvmAPIResult} A promise that resolves to the result of the operation.\n   * @throws PaymentsError if unable to track the agent sub task\n   *\n   * @example\n   * ```\n   * const result = await payments.requests.trackAgentSubTask({\n   *   agentRequestId: 'atx-12345',\n   *   creditsToRedeem: 5,\n   *   tag: 'high-priority',\n   *   description: 'Processing high-priority data request',\n   *   status: AgentTaskStatus.SUCCESS\n   * })\n   *\n   * // {\n   * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',\n   * //   success: true\n   * // }\n   * ```\n   */\n  public async trackAgentSubTask(trackAgentSubTask: TrackAgentSubTaskDto): Promise<NvmAPIResult> {\n    const body = {\n      agentRequestId: trackAgentSubTask.agentRequestId,\n      creditsToRedeem: trackAgentSubTask.creditsToRedeem || 0,\n      tag: trackAgentSubTask.tag,\n      description: trackAgentSubTask.description,\n      status: trackAgentSubTask.status,\n    }\n\n    const options = this.getBackendHTTPOptions('POST', body)\n    const url = new URL(API_URL_TRACK_AGENT_SUB_TASK, this.environment.backend)\n    const response = await fetch(url, options)\n\n    if (!response.ok) {\n      throw new PaymentsError(\n        `Unable to track agent sub task. ${response.statusText} - ${await response.text()}`,\n      )\n    }\n\n    return response.json()\n  }\n}\n"]}

package/dist/common/helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"helper.js","sourceRoot":"","sources":["../../src/common/helper.ts"],"names":[],"mappings":";;;AAEO,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AAAzE,QAAA,KAAK,SAAoE;AAE/E,MAAM,YAAY,GAAG,CAAC,IAAS,EAAE,KAA8B,EAAE,EAAE;IACxE,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;AAC7D,CAAC,CAAA;AAFY,QAAA,YAAY,gBAExB;AAEM,MAAM,2BAA2B,GAAG,CAAC,SAAqB,EAAU,EAAE;IAC3E,IAAI,WAAW,GAAG,EAAE,CAAA;IACpB,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5C,WAAW,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAA;IACzC,CAAC,CAAC,CAAA;IACF,OAAO,WAAW,CAAA;AACpB,CAAC,CAAA;AAPY,QAAA,2BAA2B,+BAOvC"}
+{"version":3,"file":"helper.js","sourceRoot":"","sources":["../../src/common/helper.ts"],"names":[],"mappings":";;;AAEO,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AAAzE,QAAA,KAAK,SAAoE;AAE/E,MAAM,YAAY,GAAG,CAAC,IAAS,EAAE,KAA8B,EAAE,EAAE;IACxE,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;AAC7D,CAAC,CAAA;AAFY,QAAA,YAAY,gBAExB;AAEM,MAAM,2BAA2B,GAAG,CAAC,SAAqB,EAAU,EAAE;IAC3E,IAAI,WAAW,GAAG,EAAE,CAAA;IACpB,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5C,WAAW,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAA;IACzC,CAAC,CAAC,CAAA;IACF,OAAO,WAAW,CAAA;AACpB,CAAC,CAAA;AAPY,QAAA,2BAA2B,+BAOvC","sourcesContent":["import { Endpoint } from './types'\n\nexport const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))\n\nexport const jsonReplacer = (_key: any, value: { toString: () => any }) => {\n  return typeof value === 'bigint' ? value.toString() : value\n}\n\nexport const getServiceHostFromEndpoints = (endpoints: Endpoint[]): string => {\n  let serviceHost = ''\n  endpoints.some((endpoint) => {\n    const _endpoint = Object.values(endpoint)[0]\n    serviceHost = new URL(_endpoint).origin\n  })\n  return serviceHost\n}\n"]}

package/dist/common/payments.error.d.ts

@@ -1,4 +1,34 @@
+/**
+ * PaymentsError extends Error to provide detailed error information for payments and authentication.
+ * Supports error codes for unauthorized, payment required, and other payment-related errors.
+ */
 export declare class PaymentsError extends Error {
-    constructor(message: string);
+    code: string;
+    /**
+     * Creates a new PaymentsError instance.
+     * @param message - The error message
+     * @param code - The error code (e.g., 'unauthorized', 'payment_required')
+     */
+    constructor(message: string, code?: string);
+    /**
+     * Creates an unauthorized error (missing or invalid credentials).
+     * @param message - Optional custom message
+     */
+    static unauthorized(message?: string): PaymentsError;
+    /**
+     * Creates a payment required error (insufficient credits, etc.).
+     * @param message - Optional custom message
+     */
+    static paymentRequired(message?: string): PaymentsError;
+    /**
+     * Creates a generic validation error.
+     * @param message - Optional custom message
+     */
+    static validation(message?: string): PaymentsError;
+    /**
+     * Creates an internal error.
+     * @param message - Optional custom message
+     */
+    static internal(message?: string): PaymentsError;
 }
 //# sourceMappingURL=payments.error.d.ts.map

package/dist/common/payments.error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payments.error.d.ts","sourceRoot":"","sources":["../../src/common/payments.error.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAI5B"}
+{"version":3,"file":"payments.error.d.ts","sourceRoot":"","sources":["../../src/common/payments.error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;OAIG;gBACS,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAyB;IAM5D;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,GAAE,MAAuB;IAIpD;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,OAAO,GAAE,MAA2B;IAI3D;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,GAAE,MAA2B;IAItD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAE,MAAyB;CAGnD"}

package/dist/common/payments.error.js

@@ -1,10 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentsError = void 0;
+/**
+ * PaymentsError extends Error to provide detailed error information for payments and authentication.
+ * Supports error codes for unauthorized, payment required, and other payment-related errors.
+ */
 class PaymentsError extends Error {
-    constructor(message) {
+    /**
+     * Creates a new PaymentsError instance.
+     * @param message - The error message
+     * @param code - The error code (e.g., 'unauthorized', 'payment_required')
+     */
+    constructor(message, code = 'payments_error') {
         super(message);
         this.name = 'PaymentsError';
+        this.code = code;
+    }
+    /**
+     * Creates an unauthorized error (missing or invalid credentials).
+     * @param message - Optional custom message
+     */
+    static unauthorized(message = 'Unauthorized') {
+        return new PaymentsError(message, 'unauthorized');
+    }
+    /**
+     * Creates a payment required error (insufficient credits, etc.).
+     * @param message - Optional custom message
+     */
+    static paymentRequired(message = 'Payment required') {
+        return new PaymentsError(message, 'payment_required');
+    }
+    /**
+     * Creates a generic validation error.
+     * @param message - Optional custom message
+     */
+    static validation(message = 'Validation error') {
+        return new PaymentsError(message, 'validation');
+    }
+    /**
+     * Creates an internal error.
+     * @param message - Optional custom message
+     */
+    static internal(message = 'Internal error') {
+        return new PaymentsError(message, 'internal');
     }
 }
 exports.PaymentsError = PaymentsError;

package/dist/common/payments.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"payments.error.js","sourceRoot":"","sources":["../../src/common/payments.error.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAc,SAAQ,KAAK;IACtC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;IAC7B,CAAC;CACF;AALD,sCAKC"}
+{"version":3,"file":"payments.error.js","sourceRoot":"","sources":["../../src/common/payments.error.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAa,aAAc,SAAQ,KAAK;IAGtC;;;;OAIG;IACH,YAAY,OAAe,EAAE,OAAe,gBAAgB;QAC1D,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,UAAkB,cAAc;QAClD,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;IACnD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,UAAkB,kBAAkB;QACzD,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IACvD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,UAAkB,kBAAkB;QACpD,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;IACjD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAkB,gBAAgB;QAChD,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IAC/C,CAAC;CACF;AA7CD,sCA6CC","sourcesContent":["/**\n * PaymentsError extends Error to provide detailed error information for payments and authentication.\n * Supports error codes for unauthorized, payment required, and other payment-related errors.\n */\nexport class PaymentsError extends Error {\n  code: string\n\n  /**\n   * Creates a new PaymentsError instance.\n   * @param message - The error message\n   * @param code - The error code (e.g., 'unauthorized', 'payment_required')\n   */\n  constructor(message: string, code: string = 'payments_error') {\n    super(message)\n    this.name = 'PaymentsError'\n    this.code = code\n  }\n\n  /**\n   * Creates an unauthorized error (missing or invalid credentials).\n   * @param message - Optional custom message\n   */\n  static unauthorized(message: string = 'Unauthorized') {\n    return new PaymentsError(message, 'unauthorized')\n  }\n\n  /**\n   * Creates a payment required error (insufficient credits, etc.).\n   * @param message - Optional custom message\n   */\n  static paymentRequired(message: string = 'Payment required') {\n    return new PaymentsError(message, 'payment_required')\n  }\n\n  /**\n   * Creates a generic validation error.\n   * @param message - Optional custom message\n   */\n  static validation(message: string = 'Validation error') {\n    return new PaymentsError(message, 'validation')\n  }\n\n  /**\n   * Creates an internal error.\n   * @param message - Optional custom message\n   */\n  static internal(message: string = 'Internal error') {\n    return new PaymentsError(message, 'internal')\n  }\n}\n"]}

package/dist/common/types.d.ts

@@ -14,7 +14,7 @@ export interface PaymentOptions {
      * You can get your API key by logging in to the Nevermined App.
      * @see https://docs.nevermined.app/docs/tutorials/integration/nvm-api-keys
      */
-    nvmApiKey?: string;
+    nvmApiKey: string;
     /**
      * The URL to return to the app after a successful login.
      */
@@ -155,12 +155,13 @@ export interface PlanBalance {
     creditsContract: Address;
     isSubscriber: boolean;
 }
-export interface ValidationAgentRequest {
+export interface StartAgentRequest {
+    agentRequestId: string;
     balance: PlanBalance;
     urlMatching: string;
     verbMatching: string;
 }
-export interface AgentAccessParams {
+export interface AgentAccessCredentials {
     accessToken: string;
     proxies?: string[];
 }
@@ -171,6 +172,25 @@ export interface SubscriberRequestStatus {
     code: number;
     message?: string;
 }
+export interface NvmAPIResult {
+    success: boolean;
+    message?: string;
+    txHash?: string;
+    httpStatus?: number;
+    data?: APIOutputData;
+    when?: Date;
+}
+export interface APIOutputData {
+    [key: string]: any;
+}
+export interface StripeCheckoutResult {
+    stripeCheckoutSessionId: string;
+    checkoutLink: string;
+    clientReferenceId: string;
+    paymentStatus?: string;
+    linkCreatedAt: number;
+    linkExpiresAt: number;
+}
 /**
  * Metadata attributes describing the AI Agent.
  */
@@ -293,4 +313,38 @@ export declare class PaginationOptions {
      */
     asQueryParams(): string;
 }
+/**
+ * Status of an agent task
+ */
+export declare enum AgentTaskStatus {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED",
+    PENDING = "PENDING"
+}
+/**
+ * Data transfer object for tracking agent sub tasks
+ */
+export interface TrackAgentSubTaskDto {
+    /**
+     * The unique identifier of the agent task
+     */
+    agentRequestId: string;
+    /**
+     * The number of credits burned in this agent sub task (optional)
+     * @defaultValue 0
+     */
+    creditsToRedeem?: number;
+    /**
+     * A tag to categorize this agent sub task (optional)
+     */
+    tag?: string;
+    /**
+     * A description of this agent sub task (optional)
+     */
+    description?: string;
+    /**
+     * The status of the agent sub task (optional)
+     */
+    status?: AgentTaskStatus;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/common/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,WAAW,EAAE,eAAe,CAAA;IAE5B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA;AAEnC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAA;IACxB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB;;;OAGG;IACH,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,eAAe,CAAA;IAC5B;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAA;IAClC;;OAEG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB,WAAW,IAAA;IACX,gBAAgB,IAAA;IAChB,oBAAoB,IAAA;CACrB;AAED;;;;;;GAMG;AACH,oBAAY,eAAe;IACzB,SAAS,IAAA;IACT,KAAK,IAAA;IACL,OAAO,IAAA;CACR;AAED;;;;;;GAMG;AACH,oBAAY,kBAAkB;IAC5B,gBAAgB,IAAA,CAAE,qBAAqB;IACvC,UAAU,IAAA,CAAE,iBAAiB;IAC7B,cAAc,IAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,OAAO,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,YAAY,EAAE,OAAO,CAAA;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,WAAW,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAA;CAGnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAInB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,SAAS,EAAE,KAAK,GAAG,MAAM,CAAS;IAClC;;;OAGG;IACH,IAAI,SAAI;IACR;;;OAGG;IACH,MAAM,SAAK;IAEX;;;OAGG;gBACS,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAShD;;;;OAIG;IACH,aAAa,IAAI,MAAM;CAWxB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,WAAW,EAAE,eAAe,CAAA;IAE5B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA;AAEnC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAA;IACxB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB;;;OAGG;IACH,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,eAAe,CAAA;IAC5B;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAA;IAClC;;OAEG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB,WAAW,IAAA;IACX,gBAAgB,IAAA;IAChB,oBAAoB,IAAA;CACrB;AAED;;;;;;GAMG;AACH,oBAAY,eAAe;IACzB,SAAS,IAAA;IACT,KAAK,IAAA;IACL,OAAO,IAAA;CACR;AAED;;;;;;GAMG;AACH,oBAAY,kBAAkB;IAC5B,gBAAgB,IAAA,CAAE,qBAAqB;IACvC,UAAU,IAAA,CAAE,iBAAiB;IAC7B,cAAc,IAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,OAAO,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,YAAY,EAAE,OAAO,CAAA;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,WAAW,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,IAAI,CAAC,EAAE,IAAI,CAAA;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,uBAAuB,EAAE,MAAM,CAAA;IAC/B,YAAY,EAAE,MAAM,CAAA;IACpB,iBAAiB,EAAE,MAAM,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAA;CAGnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAInB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,SAAS,EAAE,KAAK,GAAG,MAAM,CAAS;IAClC;;;OAGG;IACH,IAAI,SAAI;IACR;;;OAGG;IACH,MAAM,SAAK;IAEX;;;OAGG;gBACS,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAShD;;;;OAIG;IACH,aAAa,IAAI,MAAM;CAWxB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB"}

package/dist/common/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaginationOptions = exports.PlanRedemptionType = exports.PlanCreditsType = exports.PlanPriceType = void 0;
+exports.AgentTaskStatus = exports.PaginationOptions = exports.PlanRedemptionType = exports.PlanCreditsType = exports.PlanPriceType = void 0;
 /**
  * Different types of prices that can be configured for a plan
  * @remarks 0 - FIXED_PRICE, 1 - FIXED_FIAT_PRICE, 2 - SMART_CONTRACT_PRICE
@@ -88,4 +88,13 @@ class PaginationOptions {
     }
 }
 exports.PaginationOptions = PaginationOptions;
+/**
+ * Status of an agent task
+ */
+var AgentTaskStatus;
+(function (AgentTaskStatus) {
+    AgentTaskStatus["SUCCESS"] = "SUCCESS";
+    AgentTaskStatus["FAILED"] = "FAILED";
+    AgentTaskStatus["PENDING"] = "PENDING";
+})(AgentTaskStatus || (exports.AgentTaskStatus = AgentTaskStatus = {}));
 //# sourceMappingURL=types.js.map