From c3884b0d309b7350185e4f7b76e24e7c0ca8e6c3 Mon Sep 17 00:00:00 2001 From: eruizgar91 Date: Tue, 29 Oct 2024 09:06:22 +0000 Subject: [PATCH] Automated docs update Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/AIQueryApi.html | 38 ++++++---- docs/classes/AIQueryOptions.html | 8 +- docs/classes/Payments.html | 75 +++++++++++-------- docs/classes/PaymentsError.html | 4 +- docs/enums/AgentExecutionStatus.html | 12 +-- docs/functions/generateStepId.html | 3 + docs/functions/getAIHubOpenApiUrl.html | 3 + docs/functions/getQueryProtocolEndpoints.html | 4 + .../getServiceHostFromEndpoints.html | 1 + docs/functions/isEthereumAddress.html | 5 +- docs/functions/isStepIdValid.html | 4 + docs/functions/jsonReplacer.html | 2 +- docs/functions/sleep.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 2 +- docs/interfaces/Artifact.html | 6 +- docs/interfaces/BackendApiOptions.html | 14 ++-- docs/interfaces/BackendWebSocketOptions.html | 10 +-- docs/interfaces/Endpoint.html | 2 +- docs/interfaces/EnvironmentInfo.html | 4 +- docs/interfaces/ExecutionInput.html | 14 ++-- docs/interfaces/ExecutionOptions.html | 31 +++++--- docs/interfaces/ExecutionOutput.html | 14 ++-- docs/interfaces/PaymentOptions.html | 12 +-- docs/interfaces/SearchSteps.html | 4 +- docs/interfaces/SearchTasks.html | 4 +- docs/interfaces/Step.html | 43 +++++++---- docs/interfaces/Task.html | 38 ++++++---- docs/modules.html | 8 +- docs/types/EnvironmentName.html | 2 +- docs/variables/CREATE_STEPS_ENDPOINT.html | 2 +- docs/variables/Environments.html | 2 +- docs/variables/FIRST_STEP_NAME.html | 2 +- docs/variables/GET_AGENTS_ENDPOINT.html | 2 +- .../variables/GET_BUILDER_STEPS_ENDPOINT.html | 2 +- docs/variables/GET_TASK_ENDPOINT.html | 2 +- docs/variables/GET_TASK_STEPS_ENDPOINT.html | 2 +- docs/variables/LAST_STEP_NAME.html | 1 - docs/variables/SEARCH_STEPS_ENDPOINT.html | 2 +- docs/variables/SEARCH_TASKS_ENDPOINT.html | 2 +- docs/variables/TASK_ENDPOINT.html | 2 +- docs/variables/UPDATE_STEP_ENDPOINT.html | 2 +- docs/variables/ZeroAddress.html | 2 +- 45 files changed, 237 insertions(+), 163 deletions(-) create mode 100644 docs/functions/generateStepId.html create mode 100644 docs/functions/getAIHubOpenApiUrl.html create mode 100644 docs/functions/getQueryProtocolEndpoints.html create mode 100644 docs/functions/getServiceHostFromEndpoints.html create mode 100644 docs/functions/isStepIdValid.html delete mode 100644 docs/variables/LAST_STEP_NAME.html diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 05b71e6..d9588d1 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43U0W6bMBQG4HfxdbSs2dptuXMbr0PraAZUk1pNkQsnCwsYyzZVo2nvPsESgYM5+Pr/z4dtDE9/iIFXQ5aE/gJh2CuktckrERtuak1mRHKzI0sCoi713NV5szNlQWZkn4uMLD/+nXVi8L0GdaAy75y04FqDnneZPX+xcAj3snmcHlWOOSat+aEEYRzGKfGZZkpVapxoY3Q/yuRbnpqOyIUBteVps5ljaAOLy6secM3TPYiMynxwJj1p0PIgf8BzXKV7MB7weRfjmchklQv3lk8hDrzkqhLNAQdiW404VgflTrc3ELIeWZVV8cKwQzsv+YG1mVze/w7GHS8mtjq7gmExcJXuYgPSLfXyaSbheo8xbY4yBqR73oDEBhvZOdgEnhcx5CV0hjlI+w428Zn09tOHi8tFT7uJGE3YJk7YOt6wcLW+D8KkM1+4yvlzAXruLNr6u4V7mdrl9XOE+RxEcdI+dRPSb8wlnVUQ7JYlG3rLwgTfqqM2gV4/BHcrFnkc43h74hEJjb9OylbJB/RbsKOK4Hd06o3ZDYSKGY1uvnis0lmchpuNecF2EYEnX5PvK3pYr07fG+q5egj7CKqiWaZAO7/KXowguWZmBwrqckBta5G2v/D5oGSDV+974G9diQhkwVNQLqufI4wuoP837ubbYDD48x8s2eradgoAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43WXW/aMBQG4P+SazRWtnYbd2lxS7QNGAmbtGlCJjkUj8S2bAcVTfvvU1JQYnBOfP2+fvwRJ/Drb2DgxQTjIHwGbsgLpKVhgseGmlIHg0BSswvGAfCy0ENX583OFHkwCPaMZ8H4479BI0bfSlDHULLGSXOqNehhk9njb0YOYS6r6XSncsoxaUGPBXDjMM6Jz2iilFDdRB2j+1GGbWlqGoJxA2pL02ozp9AGRrd3LeCepnvgWSjZ1Zm0pKuWB/kDNrFI92A84MsuxhOeScG4e8vnEAcOTAleHXDEt6LDsTood769EZdlx6qsiheGHdplyQ8sTe/yXjsYd7qY2OrsCobFQFW6iw1It9TK+5mE6j3G1DnKGJDu8QYkNrCSnQOrwPMizmgBjWGO0r6DVXwhvf304eZ21NIeliRMyDpOyCJek9lkMY9mSWMeqGJ0k4MeOou2/m7kXqZ2ee0cYR6jZZzUs65n4Vfiki4qCPZEknX4RGYJvlVHrQe9X0VfJmTpcYzd7Z4pkjD+3CtbJR/Qb8GOKoLHJFw+TD1oZ7EfrlbjBdtFBO49W99zXS0m55cE9Vw9hP0JSoRZpkA7X6VWjCDPwEFRA9WHKcoaZ1vytP7oDu2GTd29tygTRtNyM5fAQ8lWKndzly2crP9DLZQwIhX5+SdZd8juMj5BDOrAUpgKbR6VKPqm6KojkzBNzA4UlMXV42roqxIKvj6M7zRnzmdmFRDojxZ8CTKnKSiX084RRufQ/r1rxtfB1cDf/wHGCZAd2AsAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index b2ee5b5..3775445 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VdbXPbOJL+K1f0V41D8J355iSeHdfOZbKx57ZqXSkVLcEOLzKpI6lksqn89yuAb91QNwlK3k+Tsbr7aeBBN4AmCP5wqvJb7by+/+F8yYut89oLo5VTZM/See28yTZfZLG92ud/7Ju8LGpn5RyqnfPayYtGVo/ZRtavjoQuPzfPO2flbHZZXcvaee04P1e9eeF6wWD/oVX9rawbe8sXWAugrJx9VsmiIT1nXMj2+d/l9wXog8KZwN/kw225+SKbha039c50Y1+Vf31f6ALUORP+s8y2slowri5GjeXQURj64+her5vve7kc+nJQtPTgsvd5bigsjrILQnV5txAh/097l0xR+/DfZ83npYYvOqXJVh55zzjQVFlR78uqWdy+C6T6Is48yKyS1V35RRaLvcG6L9s3J46AC8LAqY4tjFs7fyzD+MjYUbvoQLouvuZVWTzLorkpHkvKXUPEPnAeq7JoZLG1NXoBFOjGmt5OT9jWuKP8WbDf5EOtOXizEJ9QPMsRPfNZo/fSSyF9bwD8l6zKq+22kvUYgF+zKs8edrJ+BX6dHDyem8Yi9Kix+V79pbes4gG1Rf06adknjVK+wp+nnQVB9CH7rhQmUhCWsA8hObpjafYCq9CkGg4z4MXX5yt23UlBQ4VzgCvZHKriz2pnCwwVzgHO9vsbMmwp0F74HMCvsqrzkpxJKchRfCEoTvnbfZnTA6r/bXqEeok59MdB32n07s9FfDCaepLNTVE3WbGR09YusORkV9QTaG/UnlJW9qDHCtbYoRhT0KYs6qY6bJqymsHEkiNYU29/yetf9lX+NWvkDDQacP93kNX3GdRexrpxM8FLo1jHLItEJUcaa0FOtMwNNI5VSrBOBjSGZQ7g27HZlIeiMadrpkGm8GmYxzMJDUdPIKeP9rxeFuOU/GnpZZ9VtXxv2ewj4RPbjjzIi7zJs13+b3m1z+fabci+BP6mLAq5mYvMUeq0flaeWzTuZPu78qk8zCEMQvYYkScCOE5/L5+e5PZmLviR4Gkt2lQya+TbSm7zpv6wy+YgKflzkO/yZ2kNC4TPwbyV1dd8NvpN2XMQf813dnCd4MmLmKu6ls27d3/Mr16A5Mloiourui43edbIbddVc5PIlN4LeaJ6cbEbvdJZPrzJdnaLRyx8MmbXd1ebjazrt2XxmD/NY9NKp/lQVltZWQQwlDsNaVt+K3ZlZkWuKXsWp+9kk+U7y/E0Cp/LqTXskfzJyKq7rGGx8InZ8bPcfCkPze3hod5Uud6ozuVJWuU0/Oe8aLq5bAYWS56G9nCoCjs0LGmPBvb1d1n9hdrTq7/bV5yarP6yzskiyGDoYhSiPdWuMAB1I/dkjWw034ssN17AOiFpu5NYbjov9geyZjLa7kWOls958VlWeSO39p2UNYfZXupkzocrD81s4waZ8+Halc92nc1AIrnzYQ/7rRUskjsftpJNlcsZMkehkwBhHrht5J4CU3+3zwMqBpk8MBi6GIXoeNKuLE80I8BcopkCyOv1LqNPDIwAo9ByAC7ZjNYnk82k71yyAZ4vSjZTYHyygUwvSjZTcHyyGeEWJpspuOlkM0KekGymYKeTzQh7QrKZgp1INiPm0mRjAIKnab/efLy9W9/eXX9Yv7/672vigZohYfuY7verGbtYwPpR3fVfcnNQK8iJh3WmjH3SZMOWNEmEMHryarq6OHxpVCKUT4Hlw5iGJUL6FNjpcKahmdA+BX46rGl4JsRPgZ8IbxqbCnVLYDJsbmZHuJawDxn8QGra4MyTKcNJ7vnHdpsroWy33mdV9jzdmQCcUjzLkarJH7MNfaqLdAAoLASmU6BFBGsRezZtksJo0j4ntHLzjC7EpzTPc8WKU+SCPalH0GOh4epJFs0geItnBFkcnutXlMg0seCAiyy2efFka/FilKebRLpLIt8U6w9V+YQeVc6hY51zPXhfNuuPMtt+t8aHGueivy2f9zvZrsfs0KHGuei/ZvluAfQgfhIuzFFXXVRQYdT/Zp+V+hhjtpvI4AUWZlrSu8etEuijSxjoMHH0gQIgTt1cV9XEGRL962QvLT2VMlpkj6ZQBcvWTXBQFixedxJUKx4PxUYvQ17pv0/6HsGd/nXzWVby8GyeahgNHsnYGv/fuiw+yv0u28iKsAt/tt3c3F5ffXz72/ru6vbvt+vr9+8+/HHz/o7Y45ByC0HUFskGBMvZgrz9eH11dz0PQsrZgvz54V2vPIVBidlC/O36bn31t+v3d5OtIKSWALz58+b3d9cf53uLF14Cp4aNHRYhaQukVSfMo98Xe2/jt5VxVB+VWbX5rAqodJlk/Nl+htkyhUzD1sV2qpYJ/DqhZmpCzZZO5+HYAqeJNV3ntGzXRBmSbNtMHcMCdp892bWvEzwZqHx8rCVdCDShBtElYMfD+5Z7ygZ+fpmHAYa9+WcCwL9ThzmAsxvmk3CTwQug5oN3EmY6mgCORTRNAmkG5qLJZMwqmiZhp6MJ4FlE0yTQXDQBKKtoOgIDK+2rm3+ompNZLe4XxvjnF1lrEyatFtuGp/zpX1nX+PW9KWQsfw7y8Su8U7jzL+/yqMf0USdgx59ekrbe3BLKlHfMAZK6PfPycHy+zMSDkqeidWcu4TkStnlQ9FS8J9koC//MG2O+4lAJhfPaageLZU9FbB8DoKfzHCASPXnsEOtcdvQg2fMQ7foUy54xgrSJX6vy2WrcEgrnYltjnh8p2m1dRrOOFaxyKn5eDy8Yv21P7IOyIOcBo2T3zHnep7V9clzT2XF4uaFstHP/daZD8jnXTF9/tWLoWP4/5to2r7n3MUyvkOhLcaXfcKHeCTPRgeCLYv9m3OAxif8bcXnHYh8mbwOwgb+E//OLmLsIAJhirfCJu3lD3OvA525D/KWoepLz4/NJvujAnFiQjqyY69AzMYkXio4gF5x+sgh/qZ4IzYd+L7Yc99PKyYut/Mt5/WN4j/G14136l6mzch5zuduq65v6TfCmfNYvY37qfvsfqRbKSqIVeeU6q3t3FcSXXhB8+rS67zX0D/oPWkw4q3tBiQkk5jmre48S85CY76zufUrMR2KBs7oPVoF3KfwIiQVILHRW9yFlLURikbO6j1Z+chnHAolFSCx2VvcxZS1GYomzuk8osQSJpc7qPqXEUty9qrcFyYMwiNBM0FRgLoTqc0GyITAdwue6RmBChOp4QTInMCdC9b0ISElMi1DdL0j+BGZGKAZEREpicoQiQZAsCsyPUDwIkkiBKfI0RSSXHqbIUzx4JJmeES46XkgyPUyRp4jwPCoYPMyRp4jwfFISc+QpIjwywDzMkaeI8EJSEnPkKSK8iJTEHHmKCI/kyMMceYoIj+TIwxz5igiP5MjHHPmKCJ/kyMcc+YoIX6z86NILEyxpZDWd1kiOfMyRH7A972OO/JDl3ccc+TxHPubI5znyMUe+IsKnMzXmyE/ZUedjjgJFhE9mhgBzFGiOyMwQYI4CzRGZGQLMUaA5IkddYEw+igifHHUB5ihQRPjkqAswR4EiIiBHXYA5ChQRAZkZAsxRoIgIyDQfYI4CRURAshlgjkJFREByFGKOQkVEQM++mKNQERGQHIWYo1AREZAchZijUK8QSI5CY42giAhIjkLMUaiICEmOQsxRqIgISY5CzFGoiAhJjkLMUaiICEmOQsxRpIgISY4izFGkiAhJjiLMUaSICEmOIsxRpIgISY4izFGkiAhJjiLMUaQXcimVaSNjKafXciRHEeYoUkREZPaOMEeRIiLyyAUi5ihSREQ+KYk5ihURUUChx5ijWBERhZTNGHMUKyIicrUWY45ivayLSUnMUayIiEiOYsxRrIiIUirPx5ijOGLZjI0Vt15yk2zGmKM4YdmMMUdxyrIZY44Sl2UzwRwlgmUzwRwlHstmgjlKfJbNBHOUBCybCeYoUUTEZF5KMEeJIiIm81KCOUo0R2ReSoyNER9HCeYo4eMowRylfBylmKOUj6MUc5TycZRijlI+jlLMUaqIiMmcnGKO0pBdK6aYo1RzRGbvFHOUao7IdV2KOUoVETGZvVNj/5ryPW9uYRUTMb2Vco1NrCtYV9vfoKxiIyan7vY3KKv4SJh9tLGXdRUjCb2Tdo3drKs4Sei9tGvsZ13FSkJvkl1jR+sqXhJ6m+wae1pXlxzojbJr7GpdxU1Cb5VdgzddYEjozfJR8UFxk9Acm+UHwW+chFmA0HWGhObYrEHoSkNKc2xWIXStIWWqJQZvutqQ0hyblQhdb0hpjs1ahK44pDTHZjVC1xxSmmOjHiF01SGlOTYqEkLXHVKaY88sGyluUppjoyohdO0hpXkz6hJCVx+ESxNnlCaELkAIV5AZwqhOCF2DEC6ZTYVRoBC6DEGvS4RRohAev94QRpFC6FKEcOkxYdQphN/W+8gKgDBKFUIXJIRLbu2FUa0QuiYhXDq1+mbdz2dXc8IoWQhdmGD6zShaCD+cIMSoWwhdnWA62ahcCF2fEC49kI3ihdAlCraTDfr8dKqTDfqClj46RowqhmjLGHT7jDqGCFr26IAyShlCFyzo1gVm3VbHHlNgNsoZoq1nMA4b5OmyhWDq0UZNQ+jKhWBK0kZZQ+jiheCKzQZ7un4hmHqzUdwQuoQhmJKzUd8QoZhIREaJQ4RTwWdUOYSuZQimnm0UOkTYEkgP/NCsvevwY6raRrlDhC2D9JAzKh5C1zUEXdsWRtFD6NKGoMvbwqh7CF3dEB49NozSh9AFDuHRY8Oofghd4xAePTaMAojQZQ76UYhRARG6ziE85smFwZ8udQiPJtuogwhd7RB0bVxE5uMTzR9dHhdGNURELX802V1BRD9h/CqrRt1+qJ803t8Pj9V/OOvu8ePwyP2HEzmvf/xcOcLv/ht56h8/x6eP6v8UlD6IoU7Byu4gxmhOjZPBoBodjAVwwAQqu1A5ZpTbM5ZN+ywdaLsp0A4457srWrP+zafRgO+P+j7nOfEK7GghToAHrjtvon8xGpgIRxNpxFlQ55Nk/2ZgfxQZGIE94bI9kev3wzN12BN0o4AkBMG0ctkf9IU8wF4I2F7Y51/U5a2jojeqsS7v9+pQOdAB3eV1A9hnu214S3I0kISwq1jW4UuOQDmCyumMMqYIqKZxF3GuYEwMX1wA3Qwd51rc6WX7nCAK8MyR1Ol/1gc6ADaAntYcPtVA4INhwvV7+wWU41CHDrAeHKpi018RN+qGMch4PqPb36FXozv0gBHQ+RHnwGZ8sxg02odDhuNtOFEGshPwO2D9hqeogS7oL9/rBpvo/xGI/h8hZ1Yf6F3re+bWcrgPfwRIA0gIx2ZrpuNkr6+6HE0EwMeAS/3wZhIwhwE24q4xSde6lGVHm3rU18kCL0BDQi4qWtW6v/gWaANyAy4ddNrtCVc4pmEfzmg3+iguVPag8nT3NfmzPOp9oB9w/PXnneCMDWeaiMPd4rSptpSjljesO7jhB49YQmxoJeQ6rL/p9LG96RTEMBhw7FqDGuweiESP6yt0hT7QhZNct9Bi2w1s5PpjQ6DxMI1wczTQ17JQH/DmceNcom+/gEaAmcPj4mtYnnS3NoGpDwz0lPW9Vycmjhg0PmGZGwwcL9MAgSlH4GN3OQNI3TBAXQ73Ma/qRqfKtdnpMRhxCUf6+FEnwBZE5hT1QU8YHnBxEnH9/CSbtV5OMokdGmEHijLycMh3W1lNTRIxtMWNG2VLv6RImVB1R2BjqlHdO6+sM3CR6nHrzSeVaWvZbLco+gIw4YQTDXlov46QD19HAFMyaIg/YUKlrW1/iTBIXmBERBO0UNAwZ/sTumqOyIbbv4/yZwDoDLkFyZGZerjLHFgCgyycoEJZeuivBAfqgMpwYkgodaorQUpmN6xPsuk8b3efm+5ScOAF6NVwIkY7M5QjIK2x05mycLx0gJE11QVa9bEqn48XEDDQp+hUmtpE9nS0+RcwqKY6QRn5ljefiaagiY2jY/hcKOg90HmMVl6s98NFRyCvw92Ey/Ve+1kMEMCgrewuefxQiLHL9kF3s6WKo5kzAkM1StrVQ5x2C16ur4YrW8FEBJJPzE1keT2VvkD+Ybf4eS27O2SIaksKMzm7hMnrnf6AR45Xq0A34PZQeT1sPjfj61RwqMG1a8iZURfWVMN9NsB/tAflhpzqeWYxALhMOPD+Symg44HT7H5N3cVObX1hsY8bdKafEWhn1BUq4m7sCa//B1tzKcpmXbWXe4GIgyt3l2tF8fWZKBKB/NDO/yvH55Jl/zo7XEDAsonf73x5C+qrDOZmKQTDjx03x8vOCMRM7HZR23mQdv+fco60lwDAhsA1oe/2DeGygH6tiUibwoN22FqGVicJ8UGHBpPq+gIviAxTPbuIab8MDOIOrN1ZFX2PFrFzgNVpdtG3H77RBxRBtvdmcGvZXjMGxjucF9mC1b6/BRAowiTpcrPy3izPwR2qetLAqLUfMgV6UI0dSErLLAjC2aAbiWyNyogKAbtWPemgtbqrTMG4AznE73bSKdfU4VpXEI2gsXGnn3TOp5zv7Uf4jIEMI8gLu5TETWjte9xTGxMYFYKbnDszejFGm4Eplq0Pt2aOV2EuXA0OFUN2bd6aadrX4aEZOEf2XSPYHVMtG67g66FqN0dPdzseiB84xQtW7egBSgRIiPoFVp+yufCvGwwegYEds+Ohv/4H6AGn477TfN55cBsN7HsYzD47jkzqI5Bx2GCkn96hqjy7LDN3HiHoJbZKwRYEUkiwx/XRcOkRgAWKUdfJcV+J9PoHMmwYoxu1YK/D6GUniuFj49TjM1QbnTNgoMPZglFt78po16Rkj8JIE1wL4B3dYPCAtBF3WSPpczPXltaUGTwCPd9iS/FGKk7goGe7YPgkKMjhwPOefTZohn0F9VgOZs5ZA+Y8Cp9Az+lShVHQ/Yz6v2VVErsxtHMnSf+0cvb5Xu7yQjqv7z/9/Pn/CVJITGSGAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VdW3PbuJL+K1vyqyaj5p15cxLPmdQ5m8kmmXOq1pVS0RJscyOTXJLyTE5q/vsWwFsD6gZByfs0GatvxNdoAB9A8MeqLv9oVq9vf6y+5cV+9doLo/WqyJ7E6vXqTbb7Jor9dZX/VrV5WTSr9epYH1avV3nRivo+24nm5xOhV4/t02G1Xu0OWdOIZvV6tfprPZiHjReM9u861V/LpnW3fKVrIS/rVZXVomjJyJkQsir/u/i+wPuocKHjP8Td53L3TbQLn97UuzCMqi7//L4wBKxzoftHke1FvSCvriaN5a6jMPSn7N5u2++VWO761ajoGMGrIea5VFjcy64I1eXNQnT5f7mHZIq6d/8qax+XGr7qlaxPeRI9E0BbZ0VTlXW7+PmuNNUXCeZOZLWov5TfRLE4Gl33ZdvmzAy4IgycG9jCfusWj2M3PjF28lx0R7opnvO6LJ5E0b4v7ksqXEPEvePc12XRimLvavQKKdAPa0ZrH7Cd/U7yF7n9Q9w1CoM3C/0TihcFokY+Z++D9FKXvjc6/G9Rl9f7fS2aqQM+Z3We3R1E8zP61Zo83iaNIfSo3Pwg/zJYlv1Bexb5q9WyTxqlYsU/24NFnehj9l0qWEqQLuHehcQUjqPZK12FBtUImHFePD9ds/NOyjVWuMRxLdpjXfxeH1wdY4VLHGdV9Z7stpTTQfgSh8+ibvKSHEkpl5P4Qqd6yd9XZU4n1PCbPUO9xEz9Kel7jSH8uR4fTKYeRPu+aNqs2Am7tStd0toUjcXbG7mmFLW701MFZ98hTCVoVxZNWx93bVnP+NQlJ2dts/8pb36q6vw5a8WMay3h/vco6u8zXgcZ54eb6by0F+c+y3qiiiPta0FNdKwNtB+nkuBcDGgfjjWAf47drjwWrTlcMw9kCp/n83Qkod3RA8j52Z43y/o4JX9eeamyuhEfHB/7RPjMZ9ciyIu8zbND/m9xXeVzz23IvoT/XVkUYjfXMyep89pZRu7wcGfbP5QP5XHOwyjk7iPyIMB5+o/y4UHs3891fk3wvCfa1SJrxdta7PO2+XjI5lxS8pd4/pI/CWe3SPgSn9cP82OELnmJt8+ifs5na40pe4nHX/KDm7te8Owp03XTiPbdu9/m50pI8mxvEvnrpil3edaKfd9Uc0OWTe+FIpGtuDiMQemiGN5kB7epqi58ts++7a53O9E0b8viPn+Y900rnRdDWe9F7VAusNx5nvblH8WhzJzANWUvwvSdaLP84JhPk/ClmDq7PZE/27NsLme3uvCZ1fFR7L6Vx/bz8a7Z1blaFs/VSVrlPP9PedH2I+eMW13yPG93x7pw86ZLOnuL8Izlpn0UtTg+mQuJ+2OxU/TDzycyVi4AGX8Qhajl4NgKvOaaLOsCrmbzppP/Z3bIKava7+6xtv8l18sf67Itd+VhYFCoBmFlFzi7fv/r8e63ShTXVY4X2ZoXQ8iVG/3l/afPX7afv9x83H64/s8bgh41JJwZ0i9Z843im+Tf3dnQNmu+bXOSoBsNXU1CdF6rUGwOmjZrjySLazgZBZc7alpRzbgYRJYbLzBZTtruJZab7maR+21GsoeTA03uZDWZF4+izluxd3V7rPZObjW5y93Woq1zMYPTJHS5wx1zwgE1rHme4VxXeVEd261OB5IedcGXclxldfY007KG5Eu5zuo2v8929G666R0LXx5AeWyr4wzCo8xLudtm+30uh4aM3E8xPeviLxeEW6sT0meFgAcfOapTXuXf3QcfWY+ZwWc0dDUJ0bVVhbJ8dJsczI1uNgfcuDBZt44LNtPqufmB02igmYHT5qiqxV7IdSXaOyEd6YLLHeXN9pDR1XhyMgktd2AfSicfZwylNrf2oXRye8ZQanNrGUonn0uHUmvzMkMpatglQ6k1VexDKUqXM4bSecf8UGp6XjiUzru2FnXT+/KabguAH0onvwuH0nl3M0Op6fmcodQlCLdWP3soNULQzg78KXZH+USWsy6mjPsQay+JpF2uPGpHmMygzyqNtHumTJ7j3lIiad9UuTzHMVcqmQa3nah2dTlTMmnP55TPZQHxpdQW0cKyuiwka2e3RbW837sGxpdeOp6FZXhZGDMl2RbROeV5aXDL0Tu7bFtCI0v4+2IORSXhXr5dO/Vklu3S5HN1AV/agU+8E933XPducJ9EQGPtFAQ9ODt0UCXijq1Ln59MUl2eTtVO7mV6+Il/roNfEIpbfyYicYf4JJBph0edThgFP+vrbVEcn5qfKRE7zOgcsyj2efHgavFqkqcfiQyX9Py+2H6sywdtI2nOu65zaQQfynb7SWT7787+scal3t+WT9VBdAXdzTvWuNT7L1l+WOB6FD/LL65Y132voHrT8Jt7jRr6GEOiaQavdGHmSYbwuAUDfUJdd3S0nHClHBCHq2/q2nJUWP1qbaWlh48ni+wJZGqnuAuT3LhsDgJxsNNepfq76+7n/zRl8UlUh2wnasIW/nnBhmp/vEG+KPpLXT7N7N9y0q5brJ9vrj+9/XX75frz3z9vbz68+/jb+w9fiI1WUm6hE7lN6+JEl3N18vbTzfWXm3knpJyrk98/vhuUbT4oMVcXf7v5sr3+282HL9anIKSWOHjz+/t/vLv5NN9avPASdzJt3HwRkq6OlKrFvPb74uhd4nYyru0EiazePcqtIpo7m352H3X2zJaNYetqb9u1QXGdsTtkuprdJJp3x+4Vmb7sW0aOz2XZOSKfbW4Dad5tlT24PV8veLaj8v6+ETRPbboaRZc4O03vz9zZEvTzy2x7Gvbmdz9RfOemOXLnluZWd9bOi1zNd16rG3tvQn4cepPV0dw+LImYU2+yurX3JuTPoTdZHc31JuTKqTedOEOz7+v36rCeudMxTJb1n19k/k2YdJqAG5HyL36JptFvbrB51uUv8VyIZ1E/5YXYf5Tvmv9en76PRAVAqi2N4xRQ6nWo6aeXBHIwtwREGR1zvrfpjiTfnR7/N/1hyXO99S/g4IOb7ONh0XP9PYhWWvhX3hojGOeVULjsWd3c6rLneuz2DbWTSZxDTfTs3CFmvmz2aLKXeXRrU132ggxyatBJ7kJPjaQAnHoIoXCpb2efl/dJFbai9Zx7pa5ydr/s3g7tbrZxqbKatNu22XwUeTPervO2c4HIUi4YRumlYtq6DwZbejQY3+wtWxXcf1wYkHjKVb7dPDvlyan8/1to+7zhXkY2o9JEXwor9Xo3dSGC6R0JvqjvX43r66z+fyVurlscg/UqLBf3r/D//ARzt2AhU6wVfqBq3xCXmvFjlSH+UlA9OJS4hxctbBU++MOisuSYpINP4m36E5cLTos4dH8h98nmu/4gttzv1/UqL/biz9XrH+MlHq9X3iv/Vbpar+5zcdjLu0sHGmBXPqmbSL72v/1TyIWBlOhEft6s1rebdZC8CqLk69f17aChflB/UGKwWt8CJQaamLda33qUmKeJ+av1rU+J+ZpYsFrfBpRYoImFq/VtSImFmli0Wt9Gaz99laahJhZpYvFqfRtT1mJNLFmtbxNKLNHE0tX6NqXEUr15ZWsDiQMYQCgkaCh0LEC2OZBogA4H+FzTgA4IyIYHEjnQMQHZ9kCCBzosIJsfSPxARwYkAhCRkjo4IEEAEkXQ8QGJA5BAgg6RpyAisfR0iDyJg0eC6RndRfUXEkxPh8iTQHjeOvBf+ZEuqEPkSRw8nxLUEfIkDF5ACeoAeRIFL6QEdXw8CYIXUYI6PJ7EwCPh8XR4PImBR8Lj6fD4EgOPhMfX4fElBj4Jj6/D40sMfFj78asg8XRJo6Cpikb2NV/Hxw+4Zvd1fPyQQ9zX8fFZfHwdH5/Fx9fx8SUIPl2gdXz8lMs2X4cnkBj4dDHX4QkUPGQ9CHR4AgUPWQ8CHZ5AwUMmXGAMORIEn0y4QMcnkCj4ZMIFOkCBhCEgEy7QEQokDgFZDwIdokDiEJAJF+gQBRKIgAQz0DEKJRABiVGoYxRKIAJ6zNUxCiUQAYlRqGMUSiACEqNQxyhU8wISo9CYGUggAhKjUMcolECEJEahjlEogQhJjEIdo1ACEZIYhTpGoQQiJDEKdYwiCURIYhTpGEUSiJDEKNIxiiQQIYlRpGMUSSBCEqNIxyiSQIQkRpGOUaSmbyRGkTGBUzM4EqNIxyiSQEQkRpGOUSSBiEiMIh2jSAIRkRhFOkaxBCIiMYp1jGIJRERiFOsYxRKIKKKGoljHKFaTuZgoybEOUSxxiEiIYh2iWOIQpaRzHaJY4hBvqKlkbEyz1TwbSEkdoljiEHukpA5RLHGIfVJShyiROMQB9USJDlEicYhDUlKHKJE4xCREiQ5RIoGIY1JSxyiRQMQJKaljlEggYhKjRMcokUAkZDdKdIwSCUQCRColxmIoYbMz0SFKUjaVEh2iVOKQUPOfVEcolTAkZMdMdYRSCUNCdsxURyj12TxOdYTSgM3jVEcoDdk8TnWE0ojN41RHKI3ZPE51iNKEzePUWLKmbB6n5qp1wyZy9xuWBTaVu9+wrMcmc/cblpV4JPT6cWMsXzcBC2v3G5YNWWC737BsxELb/YZlYxbc7jcsm7Dwdr9h2ZQFuPsNySpOgYYYTvgG4DE2GQfFKzAYm5yDohYYjE3aQZELCb3yN4kHRS8wbWZSD4pgYNrMJB8UxcC1mYGbIhkSmn8wCQhFM3Dta+CmiAamfQ0SAhTVwLSvZzJFqjDSLIhBRIDiGxJyvgYGFwGKckhpWsugI0CxDilNbBmMBCjiIWWoLQM3xT2kNGdl8BKg2IeUZq0MZgIU/5DSdcfgJkAxECmdvwY7AYqDSOncMfgJsBAU4Jscn8QmpTE2OApQVERKY2zQFKDYCNjQIBtUBShGAjY0ygZdAYqVgA0Ns0FZgCImYEPjbLAWoMgJ2NBAG8wFBB03SyNtkBegKArY0FAb/AUolgI2NNYGhQGKqIANDWBg8rSKqN3QCBpEBii6AiT7fDLVAoPKAEVYAFBzQjDIDFCUBT0rBIPOAEVa0PNCMAgNULQFucIBg9EAxVsAULNIMDgNCDtmnSKzwGA1QHEXABSNBwavAYq9IGfRYBAboOgLpsVCk2APeSQMcgMUhcG0rkFvgCIxyHk3GPwGKBaDa10DNMVjcK1roBZ1qDF7AgZsisxgaqBBdEDUwUb3ToPrAMVoALOLYNAdoEgNYDYSDMYDFK/BhWzujnQdju7JBu0BitwAeusBDOYDFL8B9O4DGOQHKIoDPLoWG/wHKJYDPLoWGxQIxMBXH4MEgdjS7QwaBBTbAR5d4w0qBBThAR6dcQYbAorzAI/ZiDLwU7QH0JsdEJsbXB1+dBYZtAjEHX50ZhjMCCj+A+hdDzDIEVAUCPh0Zhj8CCgWBOi9DzAoElBECNBbC2CwJKC4EKA3DcAgSkDRIfQepsGUgOJDgN5iAIMsAUWJAL3LAAZfAooWAXqjAQzOBBQzAvReAxi0CSQdfjTYPXOijgY8i7qVd/arIwK3t+N5mB+rbX9uYDwr82MVrV7/+Gu9Ar//bxLIf/w1HRuQ/yddqRNU8gC/6E9QTeZknowGZXYwFtDJMKy8Qcpxyih3x8Pb7hAM0gb0LLJ+s9rywyLZcHnwZMD3J30/4dTlyUIxvGM8vMAwGUkSFITHBpGrmycyeSAcPwFWjrjm75XL4fUAbCDEBrjWz6r8m/zax6ToTWpsyFUlX0VBOsiX1+eOH3Ha4/vWk4E0wE3FNjh+XRop4yf1uFQZv6+H2khrIrteVuVEK6Mk5Vq4139UJ5iQb+Tarjl+mI/wj5KEa7Tue5dEF0EBsBEc62I3XNE96YbILZuawx3mjXaHOTKCyw2XabvpggGEt4fx5nAbj1CiXh1PioFv12v6A7yoxTzcJeOY159es0C+UXv73lBeh39EMPwjZM3q+ROjCtWVx/UqHcr2hg1OvTewVdc6b8X4DTb0kBtkF9jS19nJuu+UTNoBUg64jtjp9mlVqa8lIAuomQL7U3T3naEWQZ0x7lsiHQawDZumyta9+iQJCgNVhpDrHZ1qM3w8BWmjahZydaHX7g7H4yzD2R3ZG7FVp/ixMh41I3v7tfmTOGl+5DzgwB8OKeLROsVDPRf0Xq/boNWgYEjekOsC+Fw09o0bLOHAGr6Wcd99LQPVIaQeco9MdRUPVRN2yNI++oZ08Sjb56jPPTeykavP4+KHxy04r69ksT7CzeMyVWhfK0UPgZLN49p9nB/l3U1faOzCczQ++EGfGv3w+L3hCvpkob8PChmIcQgchvf9VTNoBMLN7nHd7D6vm1bV2q3Z7hGqEDHX7tOXiBFgeKLEJczwZQrpWu9yEYIs4kbOB2Pc8zFQiUVrqwYEbmDBYAXcM0srd8f8sBe1dZTCIQVc7klj6v1s2gauWQGXf6MNWzQ4jQJuLvMgvyPzeLwrK1FkVa6u5EHIoJRiq740IT9ptd9rVSBArRFa3N913xXMx+8KoukJSgzf0p6yfO6HD+KgIorAjSzqlGsP4eBb8kKOVdn4JauTOh6g2VloQVM304zf5UKWEJwhV1V6S3fD562QOnoedizr1ammRIkQWhJBLfyq/iMuYrowCKUUGmQirrg9iLZvg24tves/lYUCQqkRWnp/b4Z6JFS02JXoZEEule7r8ol8KLmhhCaolvZt1OuVeHKEa2dsAZaYlOF6E884bWTwp1MzXP9iS4JKTWUiezihVPCcA2ILGNLIH3n7SDwKnnSxafE4vICFUERpwGjlxbYab8NDwyWGzOMevftEJipJqEOz5Xn6aKhBoOBBiy3JJzdfotUE0k/6ZVrar7PkUYj+H9zYr9/qicyiVkz6RV+aDIuU0T6HrHZVKbKKMjvpY0vjwepgnp0vjF8QQDMjZDFlm6+xjSjIAjvc543ov85FkHAhKqTsujhvDupjpLm+jkEZF7CN2XQTpOfuU1yocKIuwi6i8mYkZnbTu7W4o+H5Rcx1NHlhXD3eJ4f6DNb2ufQfPvqKmh3pBVyjyQ+9UbwOqi4RVx9PprLIYVcZ16tkSORgyD124Jju16jk/RrH2qBBccHjYyrbbd3dgolaEBc6j2uK4vmJ4EDRGNzVq/XK58bi4Y4XHDVeH4QDt8OO5uq7keZSPEThh1wSni5pYtRgych+jPVqiAXYWE4vrUXGMd8YDMZHmwObxa4kT++hRbZRHiXhYHswOe5EsAvN7lYfDALmBcKhBdglvnpLlxj2ABcySLgUVOpkMvmo5LNLFaVuLAkA70JAwlXhKmsftbxHlZtVUZdlEktqPDtgtyyq4auMWBGlBsvBD4qiu0sUxYy7Obv+qIarftE4hcukx4Jjku+YCZb7b4wa/nwP8olgSdlYZTXTfGoubVrmVgEeSDm9o/F8mKpOOG8n8whMpflcY45ffEB9F+nFfclPxz7Mlf5atMe6MJIeT9K93gQ7/HVXtliX5rgI+BzQvR0182bs4MGE3drq7JzOuXXWZqhpMde/OjNtd/cNNoPn0cHQvjGXgo1ouc0fXJMg4cbG/sJc1E1xWrEJYi68EhQ2Sx+N1/YhPdTmyTCbZRfk2i1yyAhKgHQcBNhEMKGL0BOzizZ6Bxtzq8CSbeY6MULIsMhaSC2MELvHNV5aiPyi9U7cZ2gyzN6CsfW5JtBuxERWUdGLhyGc3Rlq66xoqrKmBiZtNOc6zmjAoAwwTcyodhdcdWwt3bK4D7OTQfwpHlQfUSbHfVum4/yJ636drVMaA88KWPLYKKspJjBYlm24NwLXY6To9aGzdXRcEVGb7RqFMmfAHAPxeYw5XSJ7cBoy6v8WdUksQrVzGCTqX9erKq/EIS/E6vXt17/++j+gFmArKJgAAA=="; \ No newline at end of file diff --git a/docs/classes/AIQueryApi.html b/docs/classes/AIQueryApi.html index 1b504b0..f6750b6 100644 --- a/docs/classes/AIQueryApi.html +++ b/docs/classes/AIQueryApi.html @@ -2,14 +2,16 @@ This API implements the Nevermined AI Query Protocol

See

https://docs.nevermined.io/docs/protocol/query-protocol.

Remarks

This API is oriented for AI Builders providing AI Agents and AI Subscribers interacting with them.

-

Hierarchy

Constructors

constructor +

Hierarchy

  • NVMBackendApi
    • AIQueryApi

Constructors

constructor

Methods

_emitStepEvents _subscribe +connectSocket createSteps createTask delete disconnect get +getStep getSteps getStepsFromTask getTaskWithSteps @@ -24,13 +26,13 @@

Remarks

This API is oriented for AI Builders providing AI Agents and setBearerToken subscribe updateStep -

Constructors

constructor

Methods

Protected _emitStepEvents

  • _emitStepEvents(status?, dids?): Promise<void>

  • Parameters

    Returns Promise<void>

Protected _subscribe

  • _subscribe(_callback, opts): Promise<void>

  • Parameters

    • _callback: ((err?) => any)
        • (err?): any

        • Parameters

          • Optional err: any

          Returns any

    • opts: SubscriptionOptions

    Returns Promise<void>

createSteps

  • createSteps(did, taskId, steps): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It creates the step/s required to complete an AI Task

    +

Constructors

constructor

Methods

Protected _emitStepEvents

  • _emitStepEvents(status?, dids?): Promise<void>

  • Parameters

    Returns Promise<void>

Protected _subscribe

  • _subscribe(_callback, opts): Promise<void>

  • Parameters

    • _callback: ((err?) => any)
        • (err?): any

        • Parameters

          • Optional err: any

          Returns any

    • opts: SubscriptionOptions

    Returns Promise<void>

connectSocket

  • connectSocket(_callback, opts): Promise<void>

  • Parameters

    • _callback: ((err?) => any)
        • (err?): any

        • Parameters

          • Optional err: any

          Returns any

    • opts: SubscriptionOptions

    Returns Promise<void>

createSteps

  • createSteps(did, taskId, steps): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It creates the step/s required to complete an AI Task

    Parameters

    • did: string

      Agent DID

    • taskId: string

      Task ID

    • steps: any

      The list of Steps to create

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

    The result of the operation

    Remarks

    This method is used by the AI Agent to create the steps required to complete the AI Task.

    -

createTask

  • createTask(did, task, queryOpts): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • Subscribers can create an AI Task for an Agent. The task must contain the input query that will be used by the AI Agent.

    +

createTask

  • createTask(did, task, queryOpts): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • Subscribers can create an AI Task for an Agent. The task must contain the input query that will be used by the AI Agent.

    Parameters

    • did: string

      Agent DID

    • task: any

      Task object. The task object should contain the query to execute and the name of the task. All the attributes here:

    • queryOpts: AIQueryOptions

      The query options

      @@ -45,18 +47,24 @@

      Remarks

      This method is used by subscribers of a Payment Plan required This is given using the queryOpts object (accessToken attribute).

      Example

      const accessConfig = await payments.getServiceAccessConfig(agentDID)
      const queryOpts = {
         accessToken: accessConfig.accessToken,
         proxyHost: accessConfig.neverminedProxyUri
      }

      const aiTask = {
          query: "https://www.youtube.com/watch?v=0tZFQs7qBfQ",
          name: "transcribe",
          "additional_params": [],
          "artifacts": []
      }

      await payments.query.createTask(
        agentDID,
        aiTask,
        queryOpts
      )
      -

delete

  • delete(url, data, reqOptions): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • Parameters

    • url: string
    • data: any
    • reqOptions: HTTPRequestOptions

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

disconnect

get

  • get(url, reqOptions?): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • Parameters

    • url: string
    • reqOptions: HTTPRequestOptions = ...

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

getSteps

  • getSteps(status?, dids?): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It retrieves all the steps that the agent needs to execute to complete the different tasks assigned.

    +

delete

  • delete(url, data, reqOptions): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • Parameters

    • url: string
    • data: any
    • reqOptions: HTTPRequestOptions

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

disconnect

get

  • get(url, reqOptions?): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • Parameters

    • url: string
    • reqOptions: HTTPRequestOptions = ...

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

getStep

  • getStep(stepId): Promise<any>

  • It retrieves the complete information of a specific step given a stepId

    +

    Parameters

    • stepId: string

      the id of the step to retrieve

      +

    Returns Promise<any>

    The complete step information

    +

    Remarks

    This method is used by the AI Agent to retrieve information about the steps part of tasks created by users to the agents owned by the user

    +

    Example

    await paymentsBuilder.query.getStep('step-1234')
+
    +

getSteps

  • getSteps(status?, dids?): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It retrieves all the steps that the agent needs to execute to complete the different tasks assigned.

    Parameters

    • status: undefined | AgentExecutionStatus = AgentExecutionStatus.Pending

      The status of the steps to retrieve

    • dids: string[] = []

      The list of DIDs to filter the steps

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

    The steps of the task

    Remarks

    This method is used by the AI Agent to retrieve information about the steps part of tasks created by users to the agents owned by the user

    -

getStepsFromTask

  • getStepsFromTask(did, taskId, status?): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It retrieves all the steps that the agent needs to execute to complete a specific task associated to the user.

    +

getStepsFromTask

  • getStepsFromTask(did, taskId, status?): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It retrieves all the steps that the agent needs to execute to complete a specific task associated to the user.

    Parameters

    • did: string

      Agent DID

    • taskId: string

      Task ID

    • Optional status: string

      The status of the steps to retrieve

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

    The steps of the task

    Remarks

    This method is used by the AI Agent to retrieve information about the tasks created by users to the agents owned by the user

    -

getTaskWithSteps

  • getTaskWithSteps(did, taskId, queryOpts): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It returns the full task and the steps resulted of the execution of the task.

    +

getTaskWithSteps

  • getTaskWithSteps(did, taskId, queryOpts): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It returns the full task and the steps resulted of the execution of the task.

    Parameters

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

    The task with the steps

    @@ -65,35 +73,33 @@

    Example

    const queryOpts object (accessToken attribute).
    
 
    Example
    const accessConfig = await payments.getServiceAccessConfig(agentDID)
    const queryOpts = {
       accessToken: accessConfig.accessToken,
       proxyHost: accessConfig.neverminedProxyUri
    }

    await payments.query.createTask(
      agentDID, 
      taskId, 
      queryOpts
    )
 
    
-

getTasksFromAgents

  • getTasksFromAgents(): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It retrieves all the tasks that the agent needs to execute to complete the different tasks assigned.

    +

getTasksFromAgents

  • getTasksFromAgents(): Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

  • It retrieves all the tasks that the agent needs to execute to complete the different tasks assigned.

    Returns Promise<AxiosResponse<any, any> | {
        data: any;
        headers: any;
        status: any;
    }>

    The tasks of the agents

    Remarks

    This method is used by the AI Agent to retrieve information about the tasks created by users to the agents owned by the user

    -

isWebSocketConnected

parseHeaders

  • parseHeaders(additionalHeaders): {}

  • Parameters

    • additionalHeaders: {
          [key: string]: string;
      }
      • [key: string]: string

    Returns {}

    parseUrl

    • parseUrl(uri, reqOptions): string

    • Parameters

      • uri: string
      • reqOptions: HTTPRequestOptions

      Returns string

    post

    • post(url, data, reqOptions): Promise<AxiosResponse<any, any> | {
          data: any;
          headers: any;
          status: any;
      }>

    • Parameters

      • url: string
      • data: any
      • reqOptions: HTTPRequestOptions

      Returns Promise<AxiosResponse<any, any> | {
          data: any;
          headers: any;
          status: any;
      }>

    put

    • put(url, data, reqOptions): Promise<AxiosResponse<any, any> | {
          data: any;
          headers: any;
          status: any;
      }>

    • Parameters

      • url: string
      • data: any
      • reqOptions: HTTPRequestOptions

      Returns Promise<AxiosResponse<any, any> | {
          data: any;
          headers: any;
          status: any;
      }>

    searchSteps

    • searchSteps(searchParams): Promise<AxiosResponse<any, any> | {
          data: any;
          headers: any;
          status: any;
      }>

    • It search steps based on the search parameters. The steps belongs to the tasks part of the AI Agents owned by the user.

      +

    isWebSocketConnected

    parseHeaders

    • parseHeaders(additionalHeaders): {}

    • Parameters

      • additionalHeaders: {
            [key: string]: string;
        }
        • [key: string]: string

      Returns {}

      parseUrl

      • parseUrl(uri, reqOptions): string

      • Parameters

        • uri: string
        • reqOptions: HTTPRequestOptions

        Returns string

      post

      • post(url, data, reqOptions): Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      • Parameters

        • url: string
        • data: any
        • reqOptions: HTTPRequestOptions

        Returns Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      put

      • put(url, data, reqOptions): Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      • Parameters

        • url: string
        • data: any
        • reqOptions: HTTPRequestOptions

        Returns Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      searchSteps

      • searchSteps(searchParams): Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      • It search steps based on the search parameters. The steps belongs to the tasks part of the AI Agents owned by the user.

        Parameters

        Returns Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

        The result of the search query

        Remarks

        This method is used by the AI Agent to retrieve information about the steps part of tasks created by users to the agents owned by the user

        Example

        await paymentsBuilder.query.searchSteps({ step_id: "my-step-id" })

        See

        SearchSteps

        -

      searchTasks

      • searchTasks(searchParams): Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      • It searches tasks based on the search parameters associated to the user

        +

      searchTasks

      • searchTasks(searchParams): Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      • It searches tasks based on the search parameters associated to the user

        Parameters

        Returns Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

        The result of the search query

        Remarks

        This method is used by the AI Agent to retrieve information about the tasks created by users to the agents owned by the user

        Example

        await paymentsBuilder.query.searchTasks({ did: "did:nv:1234" })

        See

        SearchTasks

        -

      setBearerToken

      • setBearerToken(token): void

      • Parameters

        • token: string

        Returns void

      subscribe

      • subscribe(_callback, opts?): Promise<void>

      • It subscribes to the Nevermined network to retrieve new AI Tasks requested by other users.

        +

      setBearerToken

      • setBearerToken(token): void

      • Parameters

        • token: string

        Returns void

      subscribe

      • subscribe(_callback, opts?): Promise<void>

      • It subscribes to the Nevermined network to retrieve new AI Tasks requested by other users.

        Parameters

        • _callback: ((err?) => any)

          The callback to execute when a new event is received

            • (err?): any

            • Parameters

              • Optional err: any

              Returns any

        • opts: SubscriptionOptions = DefaultSubscriptionOptions

          The subscription options

        Returns Promise<void>

        Remarks

        This method is used by AI agents to subscribe and receive new AI Tasks sent by other subscribers

        -

      updateStep

      • updateStep(did, taskId, stepId, step): Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      • It updates the step with the new information

        +

      updateStep

      • updateStep(did, step): Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

      • It updates the step with the new information

        Parameters

        • did: string

          Agent DID

          -
        • taskId: string

          Task ID

          -
        • stepId: string

          Step ID

          -
        • step: any

          The Step object to update.

          +
        • step: Step

          The Step object to update.

        Returns Promise<AxiosResponse<any, any> | {
            data: any;
            headers: any;
            status: any;
        }>

        The result of the operation

        Remarks

        This method is used by the AI Agent to update the status and output of an step. This method can not be called by a subscriber.

        -

        Example

        const result = await payments.query.updateStep(step.did, step.task_id, step.step_id, {
                step_id: step.step_id,
                task_id: step.task_id,
                step_status: AgentExecutionStatus.Completed,
                is_last: true,
                output: 'LFG!',
                cost: 1
              })
+
        Example
        const result = await payments.query.updateStep(step.did, step.task_id, step.step_id, {
                step_id: step.step_id,
                task_id: step.task_id,
                did: step.did,
                step_status: AgentExecutionStatus.Completed,
                is_last: true,
                output: 'LFG!',
                cost: 1
              })
 
        
 
        See
        https://docs.nevermined.io/docs/protocol/query-protocol#steps-attributes
        
-

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_emitStepEvents_subscribecreateStepscreateTaskdeletedisconnectgetgetStepsgetStepsFromTaskgetTaskWithStepsgetTasksFromAgentsisWebSocketConnectedparseHeadersparseUrlpostputsearchStepssearchTaskssetBearerTokensubscribeupdateStep
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_emitStepEvents_subscribeconnectSocketcreateStepscreateTaskdeletedisconnectgetgetStepgetStepsgetStepsFromTaskgetTaskWithStepsgetTasksFromAgentsisWebSocketConnectedparseHeadersparseUrlpostputsearchStepssearchTaskssetBearerTokensubscribeupdateStep
      \ No newline at end of file diff --git a/docs/classes/AIQueryOptions.html b/docs/classes/AIQueryOptions.html index 3a19953..bd23384 100644 --- a/docs/classes/AIQueryOptions.html +++ b/docs/classes/AIQueryOptions.html @@ -1,8 +1,8 @@ AIQueryOptions | @nevermined-io/payments

      Class AIQueryOptions

      Options required for interacting with an external AI Agent/Service.

      -

      Constructors

      constructor +

      Constructors

      constructor

      Properties

      accessToken? -proxyHost? +neverminedProxyUri?

      Constructors

      constructor

      Properties

      Optional accessToken

      accessToken?: string

      The access token to interact with the AI Agent/Service. Only subscribers of the Payment Plan associated with the AI Agent/Service can obtain the access toke.

      -

      Optional proxyHost

      proxyHost?: string

      The Nevermined Proxy that needs to be used to interact with the AI Agent/Service.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      constructoraccessTokenproxyHost
      \ No newline at end of file +

      Optional neverminedProxyUri

      neverminedProxyUri?: string

      The Nevermined Proxy that needs to be used to interact with the AI Agent/Service.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      constructoraccessTokenneverminedProxyUri
      \ No newline at end of file diff --git a/docs/classes/Payments.html b/docs/classes/Payments.html index 5645821..c7f2257 100644 --- a/docs/classes/Payments.html +++ b/docs/classes/Payments.html @@ -1,6 +1,6 @@ Payments | @nevermined-io/payments

      Class Payments

      Main class that interacts with the Nevermined payments API. To get an instance of this class use the getInstance method.

      -

      Constructors

      constructor +

      Constructors

      constructor

      Properties

      accountAddress? appId? environment @@ -13,6 +13,7 @@

      Methods

      burnCredits checkoutSubscription connect +createAgent createCreditsPlan createFile createService @@ -37,25 +38,38 @@

      Constructors

      Private constructor

      Properties

      Optional accountAddress

      accountAddress?: string

      Optional appId

      appId?: string

      environment

      environment: EnvironmentInfo

      isBrowserInstance

      isBrowserInstance: boolean = true

      Private Optional nvmApiKey

      nvmApiKey?: string

      query

      query: AIQueryApi

      returnUrl

      returnUrl: string

      Optional version

      version?: string

      Accessors

      isLoggedIn

      • get isLoggedIn(): boolean

      • Property to check if a user logged in.

        +

      Properties

      Optional accountAddress

      accountAddress?: string

      Optional appId

      appId?: string

      environment

      environment: EnvironmentInfo

      isBrowserInstance

      isBrowserInstance: boolean = true

      Private Optional nvmApiKey

      nvmApiKey?: string

      query

      query: AIQueryApi

      returnUrl

      returnUrl: string

      Optional version

      version?: string

      Accessors

      isLoggedIn

      • get isLoggedIn(): boolean

      • Property to check if a user logged in.

        Returns boolean

        True if the user is logged in.

        Example

        payments.isLoggedIn
        -

      Methods

      burnCredits

      • burnCredits(planDID, creditsAmount): Promise<any>

      • Burn credits for a given Payment Plan DID.

        +

      Methods

      burnCredits

      • burnCredits(planDID, creditsAmount): Promise<any>

      • Burn credits for a given Payment Plan DID.

        Parameters

        • planDID: string

          The DID (Decentralized Identifier) of the asset.

        • creditsAmount: string

          The amount of NFT (Non-Fungible Token) credits to burn.

        Returns Promise<any>

        A Promise that resolves to the JSON response from the server.

        Remarks

        This method is only can be called by the owner of the Payment Plan.

        Throws

        Error if the server response is not successful.

        -

      checkoutSubscription

      • checkoutSubscription(did): void

      • Redirects the user to the subscription checkout page for the specified DID.

        +

      checkoutSubscription

      • checkoutSubscription(did): void

      • Redirects the user to the subscription checkout page for the specified DID.

        Parameters

        • did: string

          The DID (Decentralized Identifier) of the item to be subscribed to.

        Returns void

        Remarks

        This method is only for browser instances.

        -

      connect

      • connect(): void

      • Initiate the connect flow. The user's browser will be redirected to +

      connect

      • connect(): void

      • Initiate the connect flow. The user's browser will be redirected to the Nevermined App login page.

        Returns void

        Remarks

        This is a browser only function.

        Example

        payments.connect()
        -

      createCreditsPlan

      • createCreditsPlan(__namedParameters): Promise<{
            did: string;
        }>

      • It allows to an AI Builder to create a Payment Plan on Nevermined based on Credits. +

      createAgent

      • createAgent(__namedParameters): Promise<{
            did: string;
        }>

      • It creates a new AI Agent on Nevermined. +The agent must be associated to a Payment Plan. Users that are subscribers of a payment plan can access the agent. +Depending on the Payment Plan and the configuration of the agent, the usage of the agent/service will consume credits. +When the plan expires (because the time is over or the credits are consumed), the user needs to renew the plan to continue using the agent.

        +

        Parameters

        • __namedParameters: {
              amountOfCredits?: number;
              apiDescription?: string;
              authType?: "basic" | "none" | "oauth" | "bearer";
              curation?: object;
              description: string;
              endpoints?: Endpoint[];
              implementsQueryProtocol?: boolean;
              integration?: string;
              maxCreditsToCharge?: number;
              minCreditsToCharge?: number;
              name: string;
              openApiUrl?: string;
              openEndpoints?: string[];
              password?: string;
              planDID: string;
              sampleLink?: string;
              serviceChargeType: "fixed" | "dynamic";
              tags?: string[];
              token?: string;
              username?: string;
              usesAIHub?: boolean;
          }
          • Optional amountOfCredits?: number
          • Optional apiDescription?: string
          • Optional authType?: "basic" | "none" | "oauth" | "bearer"
          • Optional curation?: object
          • description: string
          • Optional endpoints?: Endpoint[]
          • Optional implementsQueryProtocol?: boolean
          • Optional integration?: string
          • Optional maxCreditsToCharge?: number
          • Optional minCreditsToCharge?: number
          • name: string
          • Optional openApiUrl?: string
          • Optional openEndpoints?: string[]
          • Optional password?: string
          • planDID: string
          • Optional sampleLink?: string
          • serviceChargeType: "fixed" | "dynamic"
          • Optional tags?: string[]
          • Optional token?: string
          • Optional username?: string
          • Optional usesAIHub?: boolean

        Returns Promise<{
            did: string;
        }>

        A promise that resolves to the created agent DID.

        +

        Remarks

        This method is oriented to AI Builders

        +

        See

        +

        Example

        const agentDID = await paymentsBuilder.createService({
            planDID,
            name: 'E2E Payments Agent',
            description: 'description',
            serviceType: 'agent',
            serviceChargeType: 'fixed',
            authType: 'bearer',
            token: 'changeme',
            amountOfCredits: 1,
            endpoints: agentEndpoints,
            openEndpoints: ['https://example.com/api/v1/rest/docs-json']
          })
+
        +

      createCreditsPlan

      • createCreditsPlan(__namedParameters): Promise<{
            did: string;
        }>

      • It allows to an AI Builder to create a Payment Plan on Nevermined based on Credits. A Nevermined Credits Plan limits the access by the access/usage of the Plan. With them, AI Builders control the number of requests that can be made to an agent or service. Every time a user accesses any resouce associated to the Payment Plan, the usage consumes from a capped amount of credits. @@ -65,7 +79,7 @@

        Example

        payments
 
        See
        https://docs.nevermined.app/docs/tutorials/builders/create-plan
        
 
        Example
         const { did } = await payments.createCreditsPlan({
           name: "My AI Payments Plan",
           description: "AI stuff",
           price: 10000000n,
           tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
           amountOfCredits: 30,
           tags: ["test"]
          })
 
        
-

      createFile

      • createFile(__namedParameters): Promise<{
            did: string;
        }>

      • It creates a new asset with file associated to it. +

      createFile

      • createFile(__namedParameters): Promise<{
            did: string;
        }>

      • It creates a new asset with file associated to it. The file asset must be associated to a Payment Plan. Users that are subscribers of a payment plan can download the files attached to it. Depending on the Payment Plan and the configuration of the file asset, the download will consume credits. When the plan expires (because the time is over or the credits are consumed), the user needs to renew the plan to continue downloading the files.

        @@ -75,53 +89,54 @@

        See

        -

      createService

      • createService(__namedParameters): Promise<{
            did: string;
        }>

      • It creates a new AI Agent or Service on Nevermined. +

      createService

      • createService(__namedParameters): Promise<{
            did: string;
        }>

      • It creates a new AI Agent or Service on Nevermined. The agent/service must be associated to a Payment Plan. Users that are subscribers of a payment plan can access the agent/service. Depending on the Payment Plan and the configuration of the agent/service, the usage of the agent/service will consume credits. When the plan expires (because the time is over or the credits are consumed), the user needs to renew the plan to continue using the agent/service.

        -

        Parameters

        • __namedParameters: {
              amountOfCredits?: number;
              apiDescription?: string;
              authType: "basic" | "none" | "oauth" | "bearer";
              curation?: object;
              description: string;
              endpoints?: Endpoint[];
              integration?: string;
              maxCreditsToCharge?: number;
              minCreditsToCharge?: number;
              name: string;
              openApiUrl?: string;
              openEndpoints?: string[];
              password?: string;
              planDID: string;
              sampleLink?: string;
              serviceChargeType: "fixed" | "dynamic";
              serviceType: "agent" | "service" | "assistant";
              tags?: string[];
              token?: string;
              username?: string;
          }
          • Optional amountOfCredits?: number
          • Optional apiDescription?: string
          • authType: "basic" | "none" | "oauth" | "bearer"
          • Optional curation?: object
          • description: string
          • Optional endpoints?: Endpoint[]
          • Optional integration?: string
          • Optional maxCreditsToCharge?: number
          • Optional minCreditsToCharge?: number
          • name: string
          • Optional openApiUrl?: string
          • Optional openEndpoints?: string[]
          • Optional password?: string
          • planDID: string
          • Optional sampleLink?: string
          • serviceChargeType: "fixed" | "dynamic"
          • serviceType: "agent" | "service" | "assistant"
          • Optional tags?: string[]
          • Optional token?: string
          • Optional username?: string

        Returns Promise<{
            did: string;
        }>

        A promise that resolves to the created agent DID.

        +

      Parameters

      • __namedParameters: {
            amountOfCredits?: number;
            apiDescription?: string;
            authType?: "basic" | "none" | "oauth" | "bearer";
            curation?: object;
            description: string;
            endpoints?: Endpoint[];
            implementsQueryProtocol?: boolean;
            integration?: string;
            maxCreditsToCharge?: number;
            minCreditsToCharge?: number;
            name: string;
            openApiUrl?: string;
            openEndpoints?: string[];
            password?: string;
            planDID: string;
            sampleLink?: string;
            serviceChargeType: "fixed" | "dynamic";
            serviceType: "agent" | "service" | "assistant";
            tags?: string[];
            token?: string;
            username?: string;
            usesAIHub?: boolean;
        }
        • Optional amountOfCredits?: number
        • Optional apiDescription?: string
        • Optional authType?: "basic" | "none" | "oauth" | "bearer"
        • Optional curation?: object
        • description: string
        • Optional endpoints?: Endpoint[]
        • Optional implementsQueryProtocol?: boolean
        • Optional integration?: string
        • Optional maxCreditsToCharge?: number
        • Optional minCreditsToCharge?: number
        • name: string
        • Optional openApiUrl?: string
        • Optional openEndpoints?: string[]
        • Optional password?: string
        • planDID: string
        • Optional sampleLink?: string
        • serviceChargeType: "fixed" | "dynamic"
        • serviceType: "agent" | "service" | "assistant"
        • Optional tags?: string[]
        • Optional token?: string
        • Optional username?: string
        • Optional usesAIHub?: boolean

      Returns Promise<{
          did: string;
      }>

      A promise that resolves to the created agent DID.

      Remarks

      This method is oriented to AI Builders

      See

      -

      Example

      const agentEndpoints: Endpoint[] = [
        { 'POST': `https://example.com/api/v1/agents/(.*)/tasks` },
        { 'GET': `https://example.com/api/v1/agents/(.*)/tasks/(.*)` }
      ]
      const agentDID = await paymentsBuilder.createService({
          planDID,
          name: 'E2E Payments Agent',
          description: 'description', 
          serviceType: 'agent',
          serviceChargeType: 'fixed',
          authType: 'bearer',
          token: 'changeme',
          amountOfCredits: 1,
          endpoints: agentEndpoints,
          openEndpoints: ['https://example.com/api/v1/rest/docs-json']
        })
+
      Example
      const agentEndpoints: Endpoint[] = [
        { 'POST': `https://example.com/api/v1/agents/(.*)/tasks` },
        { 'GET': `https://example.com/api/v1/agents/(.*)/tasks/(.*)` }
      ]
      const agentDID = await paymentsBuilder.createService({
          planDID,
          name: 'E2E Payments Agent',
          description: 'description',
          serviceType: 'agent',
          serviceChargeType: 'fixed',
          authType: 'bearer',
          token: 'changeme',
          amountOfCredits: 1,
          endpoints: agentEndpoints,
          openEndpoints: ['https://example.com/api/v1/rest/docs-json']
        })
 
      
-

      createTimePlan

      • createTimePlan(__namedParameters): Promise<{
            did: string;
        }>

      • It allows to an AI Builder to create a Payment Plan on Nevermined based on Time. +

      createTimePlan

      • createTimePlan(__namedParameters): Promise<{
            did: string;
        }>

      • It allows to an AI Builder to create a Payment Plan on Nevermined based on Time. A Nevermined Time Plan limits the access by the a specific amount of time. With them, AI Builders can specify the duration of the Payment Plan (1 month, 1 year, etc.). When the time period is over, the plan automatically expires and the user needs to renew it.

        Parameters

        • __namedParameters: {
              description: string;
              duration?: number;
              name: string;
              price: bigint;
              tags?: string[];
              tokenAddress: string;
          }
          • description: string
          • Optional duration?: number
          • name: string
          • price: bigint
          • Optional tags?: string[]
          • tokenAddress: string

        Returns Promise<{
            did: string;
        }>

        The unique identifier of the plan (Plan DID) of the newly created plan.

        Remarks

        This method is oriented to AI Builders

        See

        https://docs.nevermined.app/docs/tutorials/builders/create-plan

        -

        Example

         const { did } = await payments.createTimePlan({
           name: "My 1 year Plan",
           description: "test",
           price: 10000000n,
           tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
           duration: 30,
           tags: ["test"]
          })
+
        Example
         const { did } = await payments.createTimePlan({
           name: "My 1 Month Plan",
           description: "test",
           price: 10000000n,
           tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
           duration: 30,
           tags: ["test"]
          })
 
        
-

      downloadFiles

      • downloadFiles(fileDid): Promise<string>

      • Downloads files for a given DID asset.

        +

      downloadFiles

      • downloadFiles(fileDid): Promise<string>

      • Downloads files for a given DID asset.

        Parameters

        • fileDid: string

        Returns Promise<string>

        A promise that resolves to the JSON response from the server.

        -

      getAssetDDO

      • getAssetDDO(did): Promise<any>

      • Get the Metadata (aka Decentralized Document or DDO) for a given asset identifier (DID).

        +

      getAssetDDO

      getFileDetails

      • getFileDetails(did): void

      • Redirects the user to the file details for the specified DID (Decentralized Identifier).

        +

      getFileDetails

      • getFileDetails(did): void

      • Redirects the user to the file details for the specified DID (Decentralized Identifier).

        Parameters

        • did: string

          The DID of the file.

        Returns void

        Remarks

        This method is only for browser instances.

        -

      getPlanAssociatedFiles

      • getPlanAssociatedFiles(planDID): Promise<any>

      • Get array of files DIDs associated with a payment plan.

        +

      getPlanAssociatedFiles

      • getPlanAssociatedFiles(planDID): Promise<any>

      • Get array of files DIDs associated with a payment plan.

        Parameters

        • planDID: string

          The DID of the Payment Plan.

        Returns Promise<any>

        A promise that resolves to array of files DIDs.

        -

      getPlanAssociatedServices

      • getPlanAssociatedServices(planDID): Promise<any>

      • Get array of services/agent DIDs associated with a payment plan.

        +

      getPlanAssociatedServices

      • getPlanAssociatedServices(planDID): Promise<any>

      • Get array of services/agent DIDs associated with a payment plan.

        Parameters

        • planDID: string

          The DID of the Payment Plan.

        Returns Promise<any>

        A promise that resolves to the array of services/agents DIDs.

        -

      getPlanBalance

      • getPlanBalance(planDID, accountAddress?): Promise<{
            balance: bigint;
            isOwner: boolean;
            isSubscriptor: boolean;
            subscriptionType: string;
        }>

      • Get the balance of an account for a Payment Plan.

        +

      getPlanBalance

      • getPlanBalance(planDID, accountAddress?): Promise<{
            balance: bigint;
            isOwner: boolean;
            isSubscriptor: boolean;
            subscriptionType: string;
        }>

      • Get the balance of an account for a Payment Plan.

        Parameters

        • planDID: string

          The Payment Plan DID of the service to be published.

        • Optional accountAddress: string

          The address of the account to get the balance.

        Returns Promise<{
            balance: bigint;
            isOwner: boolean;
            isSubscriptor: boolean;
            subscriptionType: string;
        }>

        A promise that resolves to the balance result.

        -

      getPlanDetails

      • getPlanDetails(planDID): void

      • Redirects the user to the subscription details for a given DID.

        +

      getPlanDetails

      • getPlanDetails(planDID): void

      • Redirects the user to the subscription details for a given DID.

        Parameters

        • planDID: string

          The DID (Decentralized Identifier) of the plan.

        Returns void

        Remarks

        This method is only for browser instances.

        -

      getServiceAccessConfig

      • getServiceAccessConfig(did): Promise<{
            accessToken: string;
            neverminedProxyUri: string;
        }>

      • Get the required configuration for accessing a remote service agent. +

      getServiceAccessConfig

      • getServiceAccessConfig(did): Promise<{
            accessToken: string;
            neverminedProxyUri: string;
        }>

      • Get the required configuration for accessing a remote service agent. This configuration includes:

        • The JWT access token
          • @@ -131,10 +146,10 @@

          Example

           const

        Returns Promise<{
            accessToken: string;
            neverminedProxyUri: string;
        }>

        A promise that resolves to the service token.

        Example

        const accessConfig = await payments.getServiceAccessConfig(agentDID)
        console.log(`Agent JWT Token: ${accessConfig.accessToken}`)
        console.log(`Agent Proxy URL: ${accessConfig.neverminedProxyUri}`)
        -

      getServiceDetails

      • getServiceDetails(did): void

      • Redirects the user to the service details for a given DID.

        +

      getServiceDetails

      • getServiceDetails(did): void

      • Redirects the user to the service details for a given DID.

        Parameters

        • did: string

          The DID (Decentralized Identifier) of the service.

        Returns void

        Remarks

        This method is only for browser instances.

        -

      init

      • init(): void

      • Method to initialize the class once the user has been logged in. +

      init

      • init(): void

      • Method to initialize the class once the user has been logged in. This method should be called has soon as the user has been redirected back to the app (returnUrl).

        Returns void

        Remarks

        This is a browser only function.

        @@ -144,33 +159,33 @@

        Example: Using react

        You may want to use useEffect on th returnUrl

        useEffect(() => {
          payments.init()
        })
        -

      Private initializeApi

      • initializeApi(): void

      • Initializes the AI Query Protocol API.

        -

        Returns void

      logout

      Private initializeApi

      • initializeApi(): void

      • Initializes the AI Query Protocol API.

        +

        Returns void

      logout

      • logout(): void

      • Logout the user by removing the nvm api key.

        Returns void

        Remarks

        This is a browser only function.

        Example

        payments.logout()
        -

      mintCredits

      • mintCredits(planDID, creditsAmount, receiver): Promise<any>

      • Mint credits for a given Payment Plan DID and transfer them to a receiver.

        +

      mintCredits

      • mintCredits(planDID, creditsAmount, receiver): Promise<any>

      • Mint credits for a given Payment Plan DID and transfer them to a receiver.

        Parameters

        • planDID: string

          The DID (Decentralized Identifier) of the asset.

        • creditsAmount: string

          The amount of NFT (Non-Fungible Token) credits to mint.

        • receiver: string

          The address of the receiver where the credits will be transferred.

        Returns Promise<any>

        A Promise that resolves to the JSON response from the server.

        Remarks

        This method is only can be called by the owner of the Payment Plan.

        Throws

        Error if the server response is not successful.

        -

      orderPlan

      • orderPlan(planDID, agreementId?): Promise<{
            agreementId: string;
            success: boolean;
        }>

      • Orders a Payment Plan. The user needs to have enough balance in the token selected by the owner of the Payment Plan.

        +

      orderPlan

      • orderPlan(planDID, agreementId?): Promise<{
            agreementId: string;
            success: boolean;
        }>

      • Orders a Payment Plan. The user needs to have enough balance in the token selected by the owner of the Payment Plan.

        Parameters

        • planDID: string

          The Payment Plan DID of the service to be published.

        • Optional agreementId: string

          The unique identifier of the purchase transaction (aka agreement ID). When this parameter is given, it assumes there is a previous payment step and will request the payment plan.

        Returns Promise<{
            agreementId: string;
            success: boolean;
        }>

        A promise that resolves to the agreement ID and a boolean indicating if the operation was successful.

        Remarks

        The payment is done using Crypto. Payments using Fiat can be done via the Nevermined App.

        -

      Private parseNvmApiKey

      • parseNvmApiKey(): void

      • It parses the NVM API Key to get the account address.

        -

        Returns void

      Static getBrowserInstance

      • getBrowserInstance(options): Payments

      • The options get's an instance of the payments class to be used in the browser.

        +

      Private parseNvmApiKey

      • parseNvmApiKey(): void

      • It parses the NVM API Key to get the account address.

        +

        Returns void

      Static getBrowserInstance

      • getBrowserInstance(options): Payments

      • The options get's an instance of the payments class to be used in the browser.

        Parameters

        Returns Payments

        An instance of Payments

        Remarks

        This is a browser only function.

        Example

        const payments = Payments.getBrowserInstance({
          returnUrl: 'https://mysite.example',
          environment: 'testing',
          appId: 'my-app-id',
          version: '1.0.0'
        })
        -

      Static getInstance

      Static getInstance

      • getInstance(options): Payments

      • The options get's an instance of the payments class.

        Parameters

        Returns Payments

        An instance of Payments

        Example

        const payments = Payments.getInstance({
          nvmApiKey: 'kjdfaofakdoasdkoas',
          environment: 'testing'
        })
        -

      Settings

      Member Visibility

      Theme

      On This Page

      constructoraccountAddressappIdenvironmentisBrowserInstancenvmApiKeyqueryreturnUrlversionisLoggedInburnCreditscheckoutSubscriptionconnectcreateCreditsPlancreateFilecreateServicecreateTimePlandownloadFilesgetAssetDDOgetFileDetailsgetPlanAssociatedFilesgetPlanAssociatedServicesgetPlanBalancegetPlanDetailsgetServiceAccessConfiggetServiceDetailsinitinitializeApilogoutmintCreditsorderPlanparseNvmApiKeygetBrowserInstancegetInstance
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      constructoraccountAddressappIdenvironmentisBrowserInstancenvmApiKeyqueryreturnUrlversionisLoggedInburnCreditscheckoutSubscriptionconnectcreateAgentcreateCreditsPlancreateFilecreateServicecreateTimePlandownloadFilesgetAssetDDOgetFileDetailsgetPlanAssociatedFilesgetPlanAssociatedServicesgetPlanBalancegetPlanDetailsgetServiceAccessConfiggetServiceDetailsinitinitializeApilogoutmintCreditsorderPlanparseNvmApiKeygetBrowserInstancegetInstance
      \ No newline at end of file diff --git a/docs/classes/PaymentsError.html b/docs/classes/PaymentsError.html index d6f3e02..36968f8 100644 --- a/docs/classes/PaymentsError.html +++ b/docs/classes/PaymentsError.html @@ -1,11 +1,11 @@ -PaymentsError | @nevermined-io/payments

      Class PaymentsError

      Hierarchy

      • Error
        • PaymentsError

      Constructors

      constructor +PaymentsError | @nevermined-io/payments

      Class PaymentsError

      Hierarchy

      • Error
        • PaymentsError

      Constructors

      constructor

      Properties

      message name stack? prepareStackTrace? stackTraceLimit

      Methods

      captureStackTrace -

      Constructors

      constructor

      Properties

      message

      message: string

      name

      name: string

      Optional stack

      stack?: string

      Static Optional prepareStackTrace

      prepareStackTrace?: ((err, stackTraces) => any)

      Optional override for formatting stack traces

      +

      Constructors

      constructor

      Properties

      message

      message: string

      name

      name: string

      Optional stack

      stack?: string

      Static Optional prepareStackTrace

      prepareStackTrace?: ((err, stackTraces) => any)

      Optional override for formatting stack traces

      Type declaration

        • (err, stackTraces): any

        • Parameters

          • err: Error
          • stackTraces: CallSite[]

          Returns any

      See

      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

      Static stackTraceLimit

      stackTraceLimit: number

      Methods

      Static captureStackTrace

      • captureStackTrace(targetObject, constructorOpt?): void

      • Create .stack property on a target object

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      constructormessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
      \ No newline at end of file diff --git a/docs/enums/AgentExecutionStatus.html b/docs/enums/AgentExecutionStatus.html index 6e2386a..7f8b34d 100644 --- a/docs/enums/AgentExecutionStatus.html +++ b/docs/enums/AgentExecutionStatus.html @@ -1,12 +1,12 @@ AgentExecutionStatus | @nevermined-io/payments

      Enumeration AgentExecutionStatus

      The execution status of a task or a step

      -

      Enumeration Members

      Completed +

      Enumeration Members

      Completed Failed In_Progress Not_Ready Pending

      Enumeration Members

      Completed

      Completed: "Completed"

      The execution is completed

      -

      Failed

      Failed: "Failed"

      The execution is failed

      -

      In_Progress

      In_Progress: "In_Progress"

      The execution is in progress

      -

      Not_Ready

      Not_Ready: "Not_Ready"

      The step or task is not ready to be executed

      -

      Pending

      Pending: "Pending"

      The execution is pending

      -

      Settings

      Member Visibility

      Theme

      On This Page

      CompletedFailedIn_ProgressNot_ReadyPending
      \ No newline at end of file +

      Failed

      Failed: "Failed"

      The execution is failed

      +

      In_Progress

      In_Progress: "In_Progress"

      The execution is in progress

      +

      Not_Ready

      Not_Ready: "Not_Ready"

      The step or task is not ready to be executed

      +

      Pending

      Pending: "Pending"

      The execution is pending

      +

      Settings

      Member Visibility

      Theme

      On This Page

      CompletedFailedIn_ProgressNot_ReadyPending
      \ No newline at end of file diff --git a/docs/functions/generateStepId.html b/docs/functions/generateStepId.html new file mode 100644 index 0000000..e2150d9 --- /dev/null +++ b/docs/functions/generateStepId.html @@ -0,0 +1,3 @@ +generateStepId | @nevermined-io/payments

      Function generateStepId

      • generateStepId(): string

      • It generates a random step id

        +

        Returns string

        the step id

        +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/getAIHubOpenApiUrl.html b/docs/functions/getAIHubOpenApiUrl.html new file mode 100644 index 0000000..ea60bf6 --- /dev/null +++ b/docs/functions/getAIHubOpenApiUrl.html @@ -0,0 +1,3 @@ +getAIHubOpenApiUrl | @nevermined-io/payments

      Function getAIHubOpenApiUrl

      • getAIHubOpenApiUrl(serverHost): string

      • Giving a server host it returns the URL to the OpenAPI documentation of the AI Hub

        +

        Parameters

        Returns string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/getQueryProtocolEndpoints.html b/docs/functions/getQueryProtocolEndpoints.html new file mode 100644 index 0000000..b5e5925 --- /dev/null +++ b/docs/functions/getQueryProtocolEndpoints.html @@ -0,0 +1,4 @@ +getQueryProtocolEndpoints | @nevermined-io/payments

      Function getQueryProtocolEndpoints

      • getQueryProtocolEndpoints(serverHost): Endpoint[]

      • It returns the list of endpoints that are used by agents/services implementing the Nevermined Query Protocol

        +

        Parameters

        • serverHost: string

          The host of the server where the agents/services are running

          +

        Returns Endpoint[]

        the list of endpoints

        +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/getServiceHostFromEndpoints.html b/docs/functions/getServiceHostFromEndpoints.html new file mode 100644 index 0000000..99dd6d9 --- /dev/null +++ b/docs/functions/getServiceHostFromEndpoints.html @@ -0,0 +1 @@ +getServiceHostFromEndpoints | @nevermined-io/payments

      Function getServiceHostFromEndpoints

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/isEthereumAddress.html b/docs/functions/isEthereumAddress.html index a7865b0..8777018 100644 --- a/docs/functions/isEthereumAddress.html +++ b/docs/functions/isEthereumAddress.html @@ -1 +1,4 @@ -isEthereumAddress | @nevermined-io/payments

      Function isEthereumAddress

      • isEthereumAddress(address): boolean

      • Parameters

        • address: undefined | string

        Returns boolean

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +isEthereumAddress | @nevermined-io/payments

      Function isEthereumAddress

      • isEthereumAddress(address): boolean

      • Validates if a string is a valid Ethereum address

        +

        Parameters

        • address: undefined | string

          the address to check

          +

        Returns boolean

        true if it's a valid Ethereum address

        +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/isStepIdValid.html b/docs/functions/isStepIdValid.html new file mode 100644 index 0000000..69d96ae --- /dev/null +++ b/docs/functions/isStepIdValid.html @@ -0,0 +1,4 @@ +isStepIdValid | @nevermined-io/payments

      Function isStepIdValid

      • isStepIdValid(stepId): boolean

      • It checks the step id has the right format

        +

        Parameters

        • stepId: string

          the step id to validate

          +

        Returns boolean

        true if it's a valid step id

        +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/jsonReplacer.html b/docs/functions/jsonReplacer.html index 24c5005..e93178d 100644 --- a/docs/functions/jsonReplacer.html +++ b/docs/functions/jsonReplacer.html @@ -1 +1 @@ -jsonReplacer | @nevermined-io/payments

      Function jsonReplacer

      • jsonReplacer(_key, value): string | {
            toString: (() => any);
        }

      • Parameters

        • _key: any
        • value: {
              toString: (() => any);
          }
          • toString: (() => any)
              • (): any

              • Returns any

        Returns string | {
            toString: (() => any);
        }

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +jsonReplacer | @nevermined-io/payments

      Function jsonReplacer

      • jsonReplacer(_key, value): string | {
            toString: (() => any);
        }

      • Parameters

        • _key: any
        • value: {
              toString: (() => any);
          }
          • toString: (() => any)
              • (): any

              • Returns any

        Returns string | {
            toString: (() => any);
        }

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/sleep.html b/docs/functions/sleep.html index 93aa3ac..fda5dcc 100644 --- a/docs/functions/sleep.html +++ b/docs/functions/sleep.html @@ -1 +1 @@ -sleep | @nevermined-io/payments

      Function sleep

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +sleep | @nevermined-io/payments

      Function sleep

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 4e00345..01081f6 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@nevermined-io/payments

      @nevermined-io/payments

      Class Hierarchy

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +@nevermined-io/payments

      @nevermined-io/payments

      Class Hierarchy

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 9b960fd..af24bd1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,7 +10,7 @@ 
      import { useEffect } from "react";
      import { Payments } from "@nevermined-io/payments";

      export default function Home() {
        const payments = new Payments({
          returnUrl: "http://localhost:8080",
          environment: "staging",
        });

        const onLogin = () => {
          payments.connect();
        };

        useEffect(() => {
          payments.init();
        }, []);

        return (
          <main>
            <div>
              <button onClick={onLogin}>Login</button>
            </div>
          </main>
        );
      }

      The init() method should be called immediately after the app returns the user to returnUrl.

      -

      Create a Payments Plan

      Once the app is initialized we can create a subscription:

      +

      Create a Payments Plan

      Once the app is initialized we can create a payment plan:

      const planDID = await payments.createCreditsPlan({
          name: "My AI Payments Plan",
          description: "AI stuff",
          price: 10000000n,
          tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
          amountOfCredits: 30,
          tags: ["test"]
        })

      Create an AI Agent/Service

      const agentEndpoints: Endpoint[] = [
        { 'POST': `https://example.com/api/v1/agents/(.*)/tasks` },
        { 'GET': `https://example.com/api/v1/agents/(.*)/tasks/(.*)` }
      ]
         
      const agentDID = await paymentsBuilder.createService({
        planDID,
        name: 'E2E Payments Agent',
        description: 'description', 
        serviceType: 'agent',
        serviceChargeType: 'fixed',
        authType: 'bearer',
        token: 'changeme',
        amountOfCredits: 1,
        endpoints: agentEndpoints,
        openEndpoints: ['https://example.com/api/v1/rest/docs-json']
      })
diff --git a/docs/interfaces/Artifact.html b/docs/interfaces/Artifact.html
index f25cb46..dd22eff 100644
--- a/docs/interfaces/Artifact.html
+++ b/docs/interfaces/Artifact.html
@@ -1,11 +1,11 @@
-Artifact | @nevermined-io/payments
      Interface Artifact
      interface Artifact { 
          artifact_id: string; 
          url: string; 
      }
      Properties
      artifact_id
+Artifact | @nevermined-io/payments
      Interface Artifact
      interface Artifact { 
          artifact_id: string; 
          url: string; 
      }
      Properties
      artifact_id
 url
 
      Properties
      artifact_id
      artifact_id: string
      The unique identifier of the artifact
      
-
      url
      url: string
      Reference to the artifact in a local or remote storage.
+
      url
      url: string
      Reference to the artifact in a local or remote storage.
 If it's in the local storage, the URL should be a relative path to the agent workspace.
 Examples:
      
 
        
 
      • file://path/to/file
        • 
 
      • http://example.com/path/to/file
        • 
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      artifact_idurl
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      artifact_idurl
      
\ No newline at end of file
diff --git a/docs/interfaces/BackendApiOptions.html b/docs/interfaces/BackendApiOptions.html
index 7ef28ba..497ef76 100644
--- a/docs/interfaces/BackendApiOptions.html
+++ b/docs/interfaces/BackendApiOptions.html
@@ -1,4 +1,4 @@
-BackendApiOptions | @nevermined-io/payments
      Interface BackendApiOptions
      interface BackendApiOptions { 
          apiKey?: string; 
          backendHost: string; 
          headers?: { 
              [key: string]: string; 
          }; 
          proxyHost?: string; 
          webSocketHost?: string; 
          webSocketOptions?: BackendWebSocketOptions; 
      }
      Properties
      apiKey?
+BackendApiOptions | @nevermined-io/payments
      Interface BackendApiOptions
      interface BackendApiOptions { 
          apiKey?: string; 
          backendHost: string; 
          headers?: { 
              [key: string]: string; 
          }; 
          proxyHost?: string; 
          webSocketHost?: string; 
          webSocketOptions?: BackendWebSocketOptions; 
      }
      Properties
      apiKey?
 backendHost
 headers?
 proxyHost?
@@ -7,9 +7,9 @@
 
      Properties
      Optional apiKey
      apiKey?: string
      The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API.
 You can get your API key by logging in to the Nevermined App.
      
 
      See
      https://docs.nevermined.app/docs/tutorials/integration/nvm-api-keys
      
-
      backendHost
      backendHost: string
      The host of the backend server
      
-
      Optional headers
      headers?: { 
          [key: string]: string; 
      }
      Additional headers to send with the requests
      
-
      Type declaration
      • [key: string]: string
      Optional proxyHost
      proxyHost?: string
      The host of the Nevermined Proxy
      
-
      Optional webSocketHost
      webSocketHost?: string
      The host of the websocket server
      
-
      Optional webSocketOptions
      webSocketOptions?: BackendWebSocketOptions
      Configuration of the websocket connection
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      apiKeybackendHostheadersproxyHostwebSocketHostwebSocketOptions
      
\ No newline at end of file
+
      backendHost
      backendHost: string
      The host of the backend server
      
+
      Optional headers
      headers?: { 
          [key: string]: string; 
      }
      Additional headers to send with the requests
      
+
      Type declaration
      • [key: string]: string
      Optional proxyHost
      proxyHost?: string
      The host of the Nevermined Proxy
      
+
      Optional webSocketHost
      webSocketHost?: string
      The host of the websocket server
      
+
      Optional webSocketOptions
      webSocketOptions?: BackendWebSocketOptions
      Configuration of the websocket connection
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      apiKeybackendHostheadersproxyHostwebSocketHostwebSocketOptions
      
\ No newline at end of file
diff --git a/docs/interfaces/BackendWebSocketOptions.html b/docs/interfaces/BackendWebSocketOptions.html
index 5073030..ddc6318 100644
--- a/docs/interfaces/BackendWebSocketOptions.html
+++ b/docs/interfaces/BackendWebSocketOptions.html
@@ -1,9 +1,9 @@
-BackendWebSocketOptions | @nevermined-io/payments
      Interface BackendWebSocketOptions
      interface BackendWebSocketOptions { 
          bearerToken?: string; 
          path?: string; 
          transportOptions?: { 
              [key: string]: any; 
          }; 
          transports?: string[]; 
      }
      Properties
      bearerToken?
+BackendWebSocketOptions | @nevermined-io/payments
      Interface BackendWebSocketOptions
      interface BackendWebSocketOptions { 
          bearerToken?: string; 
          path?: string; 
          transportOptions?: { 
              [key: string]: any; 
          }; 
          transports?: string[]; 
      }
      Properties
      bearerToken?
 path?
 transportOptions?
 transports?
 
      Properties
      Optional bearerToken
      bearerToken?: string
      The bearer token to use in the websocket connection
      
-
      Optional path
      path?: string
      The path to connect to the websocket server
      
-
      Optional transportOptions
      transportOptions?: { 
          [key: string]: any; 
      }
      Additional options to pass to the websocket transport
      
-
      Type declaration
      • [key: string]: any
      Optional transports
      transports?: string[]
      The websocket transports to use
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      bearerTokenpathtransportOptionstransports
      
\ No newline at end of file
+
      Optional path
      path?: string
      The path to connect to the websocket server
      
+
      Optional transportOptions
      transportOptions?: { 
          [key: string]: any; 
      }
      Additional options to pass to the websocket transport
      
+
      Type declaration
      • [key: string]: any
      Optional transports
      transports?: string[]
      The websocket transports to use
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      bearerTokenpathtransportOptionstransports
      
\ No newline at end of file
diff --git a/docs/interfaces/Endpoint.html b/docs/interfaces/Endpoint.html
index 7d02d08..350d379 100644
--- a/docs/interfaces/Endpoint.html
+++ b/docs/interfaces/Endpoint.html
@@ -1 +1 @@
-Endpoint | @nevermined-io/payments
      Interface Endpoint
      interface Endpoint { 
          [verb: string]: string; 
      }
      Indexable
      [verb: string]: string
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+Endpoint | @nevermined-io/payments
      Interface Endpoint
      interface Endpoint { 
          [verb: string]: string; 
      }
      Indexable
      [verb: string]: string
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/interfaces/EnvironmentInfo.html b/docs/interfaces/EnvironmentInfo.html
index 2c63a38..c88e27c 100644
--- a/docs/interfaces/EnvironmentInfo.html
+++ b/docs/interfaces/EnvironmentInfo.html
@@ -1,5 +1,5 @@
-EnvironmentInfo | @nevermined-io/payments
      Interface EnvironmentInfo
      interface EnvironmentInfo { 
          backend: string; 
          frontend: string; 
          proxy: string; 
          websocketBackend: string; 
      }
      Properties
      backend
+EnvironmentInfo | @nevermined-io/payments
      Interface EnvironmentInfo
      interface EnvironmentInfo { 
          backend: string; 
          frontend: string; 
          proxy: string; 
          websocketBackend: string; 
      }
      Properties
      backend
 frontend
 proxy
 websocketBackend
-
      Properties
      backend
      backend: string
      frontend
      frontend: string
      proxy
      proxy: string
      websocketBackend
      websocketBackend: string
      Settings
      Member Visibility
      Theme
      On This Page
      backendfrontendproxywebsocketBackend
      
\ No newline at end of file
+
      Properties
      backend
      backend: string
      frontend
      frontend: string
      proxy
      proxy: string
      websocketBackend
      websocketBackend: string
      Settings
      Member Visibility
      Theme
      On This Page
      backendfrontendproxywebsocketBackend
      
\ No newline at end of file
diff --git a/docs/interfaces/ExecutionInput.html b/docs/interfaces/ExecutionInput.html
index 1067580..284eb72 100644
--- a/docs/interfaces/ExecutionInput.html
+++ b/docs/interfaces/ExecutionInput.html
@@ -1,8 +1,8 @@
 ExecutionInput | @nevermined-io/payments
      Interface ExecutionInput
      This task can be a question, a prompt, etc. It can include additional parameters and artifacts.
      
-
      interface ExecutionInput { 
          additional_params?: { 
              [name: string]: string; 
          }[]; 
          artifacts?: Artifact[]; 
          query: string; 
      }
      Properties
      additional_params?
-artifacts?
-query
-
      Properties
      Optional additional_params
      additional_params?: { 
          [name: string]: string; 
      }[]
      Additional parameters required for the task
      
-
      Type declaration
      • [name: string]: string
      Optional artifacts
      artifacts?: Artifact[]
      List of artifact ids that are associated with the task
      
-
      query
      query: string
      The input for the task. It can be a prompt, a question, etc
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      additional_paramsartifactsquery
      
\ No newline at end of file
+
      interface ExecutionInput { 
          input_artifacts?: Artifact[]; 
          input_params?: { 
              [name: string]: string; 
          }[]; 
          input_query: string; 
      }
      Hierarchy (view full)
      Properties
      input_artifacts?
+input_params?
+input_query
+
      Properties
      Optional input_artifacts
      input_artifacts?: Artifact[]
      List of artifact ids that are associated with the task
      
+
      Optional input_params
      input_params?: { 
          [name: string]: string; 
      }[]
      Additional parameters required for the task
      
+
      Type declaration
      • [name: string]: string
      input_query
      input_query: string
      The input for the task. It can be a prompt, a question, etc
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      input_artifactsinput_paramsinput_query
      
\ No newline at end of file
diff --git a/docs/interfaces/ExecutionOptions.html b/docs/interfaces/ExecutionOptions.html
index f7ddf0e..1bef750 100644
--- a/docs/interfaces/ExecutionOptions.html
+++ b/docs/interfaces/ExecutionOptions.html
@@ -1,13 +1,22 @@
-ExecutionOptions | @nevermined-io/payments
      Interface ExecutionOptions
      interface ExecutionOptions { 
          created_at?: Date; 
          input: ExecutionInput; 
          output?: ExecutionOutput; 
          retries?: number; 
          status: AgentExecutionStatus; 
          updated_at?: Date; 
      }
      Hierarchy (view full)
      Properties
      created_at?
-input
-output?
+ExecutionOptions | @nevermined-io/payments
      Interface ExecutionOptions
      This task can be a question, a prompt, etc. It can include additional parameters and artifacts.
      
+
      interface ExecutionOptions { 
          cost?: number; 
          created_at?: Date; 
          input_artifacts?: Artifact[]; 
          input_params?: { 
              [name: string]: string; 
          }[]; 
          input_query: string; 
          output: any; 
          output_additional?: { 
              [name: string]: any; 
          }[]; 
          output_artifacts?: any[]; 
          retries?: number; 
          updated_at?: Date; 
      }
      Hierarchy (view full)
      Properties
      cost?
+created_at?
+input_artifacts?
+input_params?
+input_query
+output
+output_additional?
+output_artifacts?
 retries?
-status
 updated_at?
-
      Properties
      Optional created_at
      created_at?: Date
      When the execution was created
      
-
      input
      input: ExecutionInput
      The input for the task. It can be a prompt, a question, etc
      
-
      Optional output
      output?: ExecutionOutput
      The output of the step
      
-
      Optional retries
      retries?: number
      The number of retries for the task or step
      
-
      status
      status: AgentExecutionStatus
      The status of the execution
      
-
      Optional updated_at
      updated_at?: Date
      When the execution was last updated
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      created_atinputoutputretriesstatusupdated_at
      
\ No newline at end of file
+
      Properties
      Optional cost
      cost?: number
      The cost in credits resulting from the execution of the task or the step
      
+
      Optional created_at
      created_at?: Date
      When the execution was created
      
+
      Optional input_artifacts
      input_artifacts?: Artifact[]
      List of artifact ids that are associated with the task
      
+
      Optional input_params
      input_params?: { 
          [name: string]: string; 
      }[]
      Additional parameters required for the task
      
+
      Type declaration
      • [name: string]: string
      input_query
      input_query: string
      The input for the task. It can be a prompt, a question, etc
      
+
      output
      output: any
      The main output generated by a task or step
      
+
      Optional output_additional
      output_additional?: { 
          [name: string]: any; 
      }[]
      Additional output generated
      
+
      Type declaration
      • [name: string]: any
      Optional output_artifacts
      output_artifacts?: any[]
      List of artifact generated by the task or step
      
+
      Optional retries
      retries?: number
      The number of retries for the task or step
      
+
      Optional updated_at
      updated_at?: Date
      When the execution was last updated
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      costcreated_atinput_artifactsinput_paramsinput_queryoutputoutput_additionaloutput_artifactsretriesupdated_at
      
\ No newline at end of file
diff --git a/docs/interfaces/ExecutionOutput.html b/docs/interfaces/ExecutionOutput.html
index f11dbad..fd749ee 100644
--- a/docs/interfaces/ExecutionOutput.html
+++ b/docs/interfaces/ExecutionOutput.html
@@ -1,8 +1,8 @@
 ExecutionOutput | @nevermined-io/payments
      Interface ExecutionOutput
      Output of the task or step execution
      
-
      interface ExecutionOutput { 
          additional_output?: { 
              [name: string]: any; 
          }[]; 
          artifacts?: string[]; 
          output: any; 
      }
      Properties
      additional_output?
-artifacts?
-output
-
      Properties
      Optional additional_output
      additional_output?: { 
          [name: string]: any; 
      }[]
      Additional output generated
      
-
      Type declaration
      • [name: string]: any
      Optional artifacts
      artifacts?: string[]
      List of artifact generated by the task or step
      
-
      output
      output: any
      The main output of the task
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      additional_outputartifactsoutput
      
\ No newline at end of file
+
      interface ExecutionOutput { 
          output: any; 
          output_additional?: { 
              [name: string]: any; 
          }[]; 
          output_artifacts?: any[]; 
      }
      Hierarchy (view full)
      Properties
      output
+output_additional?
+output_artifacts?
+
      Properties
      output
      output: any
      The main output generated by a task or step
      
+
      Optional output_additional
      output_additional?: { 
          [name: string]: any; 
      }[]
      Additional output generated
      
+
      Type declaration
      • [name: string]: any
      Optional output_artifacts
      output_artifacts?: any[]
      List of artifact generated by the task or step
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      outputoutput_additionaloutput_artifacts
      
\ No newline at end of file
diff --git a/docs/interfaces/PaymentOptions.html b/docs/interfaces/PaymentOptions.html
index 7c025ea..78f7689 100644
--- a/docs/interfaces/PaymentOptions.html
+++ b/docs/interfaces/PaymentOptions.html
@@ -1,16 +1,16 @@
 PaymentOptions | @nevermined-io/payments
      Interface PaymentOptions
      Options to initialize the Payments class.
      
-
      interface PaymentOptions { 
          appId?: string; 
          environment: EnvironmentName; 
          nvmApiKey?: string; 
          returnUrl?: string; 
          version?: string; 
      }
      Properties
      appId?
+
      interface PaymentOptions { 
          appId?: string; 
          environment: EnvironmentName; 
          nvmApiKey?: string; 
          returnUrl?: string; 
          version?: string; 
      }
      Properties
      appId?
 environment
 nvmApiKey?
 returnUrl?
 version?
 
      Properties
      Optional appId
      appId?: string
      The app id. This attribute is optional and helps to associate assets registered into Nevermined with a common identifier.
      
-
      environment
      environment: EnvironmentName
      The Nevermined environment to connect to.
+
      environment
      environment: EnvironmentName
      The Nevermined environment to connect to.
 If you are developing an agent it's recommended to use the "testing" environment.
 When deploying to production use the "arbitrum" environment.
      
-
      Optional nvmApiKey
      nvmApiKey?: string
      The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API.
+
      Optional nvmApiKey
      nvmApiKey?: string
      The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API.
 You can get your API key by logging in to the Nevermined App.
      
 
      See
      https://docs.nevermined.app/docs/tutorials/integration/nvm-api-keys
      
-
      Optional returnUrl
      returnUrl?: string
      The URL to return to the app after a successful login.
      
-
      Optional version
      version?: string
      The version of the API to use.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      appIdenvironmentnvmApiKeyreturnUrlversion
      
\ No newline at end of file
+
      Optional returnUrl
      returnUrl?: string
      The URL to return to the app after a successful login.
      
+
      Optional version
      version?: string
      The version of the API to use.
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      appIdenvironmentnvmApiKeyreturnUrlversion
      
\ No newline at end of file
diff --git a/docs/interfaces/SearchSteps.html b/docs/interfaces/SearchSteps.html
index 933aa5b..7758ab6 100644
--- a/docs/interfaces/SearchSteps.html
+++ b/docs/interfaces/SearchSteps.html
@@ -1,8 +1,8 @@
-SearchSteps | @nevermined-io/payments
      Interface SearchSteps
      interface SearchSteps { 
          did?: string; 
          name?: string; 
          offset?: number; 
          page?: number; 
          step_id?: string; 
          step_status?: AgentExecutionStatus; 
          task_id?: string; 
      }
      Properties
      did?
+SearchSteps | @nevermined-io/payments
      Interface SearchSteps
      interface SearchSteps { 
          did?: string; 
          name?: string; 
          offset?: number; 
          page?: number; 
          step_id?: string; 
          step_status?: AgentExecutionStatus; 
          task_id?: string; 
      }
      Properties
      did?
 name?
 offset?
 page?
 step_id?
 step_status?
 task_id?
-
      Properties
      Optional did
      did?: string
      Optional name
      name?: string
      Optional offset
      offset?: number
      Optional page
      page?: number
      Optional step_id
      step_id?: string
      Optional step_status
      step_status?: AgentExecutionStatus
      Optional task_id
      task_id?: string
      Settings
      Member Visibility
      Theme
      On This Page
      didnameoffsetpagestep_idstep_statustask_id
      
\ No newline at end of file
+
      Properties
      Optional did
      did?: string
      Optional name
      name?: string
      Optional offset
      offset?: number
      Optional page
      page?: number
      Optional step_id
      step_id?: string
      Optional step_status
      step_status?: AgentExecutionStatus
      Optional task_id
      task_id?: string
      Settings
      Member Visibility
      Theme
      On This Page
      didnameoffsetpagestep_idstep_statustask_id
      
\ No newline at end of file
diff --git a/docs/interfaces/SearchTasks.html b/docs/interfaces/SearchTasks.html
index f0cc5a9..d48a1ae 100644
--- a/docs/interfaces/SearchTasks.html
+++ b/docs/interfaces/SearchTasks.html
@@ -1,7 +1,7 @@
-SearchTasks | @nevermined-io/payments
      Interface SearchTasks
      interface SearchTasks { 
          did?: string; 
          name?: string; 
          offset?: number; 
          page?: number; 
          task_id?: string; 
          task_status?: AgentExecutionStatus; 
      }
      Properties
      did?
+SearchTasks | @nevermined-io/payments
      Interface SearchTasks
      interface SearchTasks { 
          did?: string; 
          name?: string; 
          offset?: number; 
          page?: number; 
          task_id?: string; 
          task_status?: AgentExecutionStatus; 
      }
      Properties
      did?
 name?
 offset?
 page?
 task_id?
 task_status?
-
      Properties
      Optional did
      did?: string
      Optional name
      name?: string
      Optional offset
      offset?: number
      Optional page
      page?: number
      Optional task_id
      task_id?: string
      Optional task_status
      task_status?: AgentExecutionStatus
      Settings
      Member Visibility
      Theme
      On This Page
      didnameoffsetpagetask_idtask_status
      
\ No newline at end of file
+
      Properties
      Optional did
      did?: string
      Optional name
      name?: string
      Optional offset
      offset?: number
      Optional page
      page?: number
      Optional task_id
      task_id?: string
      Optional task_status
      task_status?: AgentExecutionStatus
      Settings
      Member Visibility
      Theme
      On This Page
      didnameoffsetpagetask_idtask_status
      
\ No newline at end of file
diff --git a/docs/interfaces/Step.html b/docs/interfaces/Step.html
index f525547..f046cc1 100644
--- a/docs/interfaces/Step.html
+++ b/docs/interfaces/Step.html
@@ -1,21 +1,34 @@
-Step | @nevermined-io/payments
      Interface Step
      interface Step { 
          created_at?: Date; 
          input: ExecutionInput; 
          is_last?: boolean; 
          name?: string; 
          output?: ExecutionOutput; 
          retries?: number; 
          status: AgentExecutionStatus; 
          step_id: string; 
          task_id: string; 
          updated_at?: Date; 
      }
      Hierarchy (view full)
      Properties
      created_at?
-input
+Step | @nevermined-io/payments
      Interface Step
      This task can be a question, a prompt, etc. It can include additional parameters and artifacts.
      
+
      interface Step { 
          cost?: number; 
          created_at?: Date; 
          input_artifacts?: Artifact[]; 
          input_params?: { 
              [name: string]: string; 
          }[]; 
          input_query: string; 
          is_last?: boolean; 
          name?: string; 
          output: any; 
          output_additional?: { 
              [name: string]: any; 
          }[]; 
          output_artifacts?: any[]; 
          predecessor?: string; 
          retries?: number; 
          step_id: string; 
          step_status: AgentExecutionStatus; 
          task_id: string; 
          updated_at?: Date; 
      }
      Hierarchy (view full)
      Properties
      cost?
+created_at?
+input_artifacts?
+input_params?
+input_query
 is_last?
 name?
-output?
+output
+output_additional?
+output_artifacts?
+predecessor?
 retries?
-status
 step_id
+step_status
 task_id
 updated_at?
-
      Properties
      Optional created_at
      created_at?: Date
      When the execution was created
      
-
      input
      input: ExecutionInput
      The input for the task. It can be a prompt, a question, etc
      
-
      Optional is_last
      is_last?: boolean
      Whether this is the last step in the task.
      
-
      Optional name
      name?: string
      The name of the step
      
-
      Optional output
      output?: ExecutionOutput
      The output of the step
      
-
      Optional retries
      retries?: number
      The number of retries for the task or step
      
-
      status
      status: AgentExecutionStatus
      The status of the execution
      
-
      step_id
      step_id: string
      The unique identifier of the step
      
-
      task_id
      task_id: string
      The task that the step belongs to
      
-
      Optional updated_at
      updated_at?: Date
      When the execution was last updated
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      created_atinputis_lastnameoutputretriesstatusstep_idtask_idupdated_at
      
\ No newline at end of file
+
      Properties
      Optional cost
      cost?: number
      The cost in credits resulting from the execution of the task or the step
      
+
      Optional created_at
      created_at?: Date
      When the execution was created
      
+
      Optional input_artifacts
      input_artifacts?: Artifact[]
      List of artifact ids that are associated with the task
      
+
      Optional input_params
      input_params?: { 
          [name: string]: string; 
      }[]
      Additional parameters required for the task
      
+
      Type declaration
      • [name: string]: string
      input_query
      input_query: string
      The input for the task. It can be a prompt, a question, etc
      
+
      Optional is_last
      is_last?: boolean
      Whether this is the last step in the task.
      
+
      Optional name
      name?: string
      The name of the step
      
+
      output
      output: any
      The main output generated by a task or step
      
+
      Optional output_additional
      output_additional?: { 
          [name: string]: any; 
      }[]
      Additional output generated
      
+
      Type declaration
      • [name: string]: any
      Optional output_artifacts
      output_artifacts?: any[]
      List of artifact generated by the task or step
      
+
      Optional predecessor
      predecessor?: string
      The step preceeding the current step if any
      
+
      Optional retries
      retries?: number
      The number of retries for the task or step
      
+
      step_id
      step_id: string
      The unique identifier of the step
      
+
      step_status
      step_status: AgentExecutionStatus
      The status of the execution
      
+
      task_id
      task_id: string
      The task that the step belongs to
      
+
      Optional updated_at
      updated_at?: Date
      When the execution was last updated
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      costcreated_atinput_artifactsinput_paramsinput_queryis_lastnameoutputoutput_additionaloutput_artifactspredecessorretriesstep_idstep_statustask_idupdated_at
      
\ No newline at end of file
diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html
index 9531a2d..95fd900 100644
--- a/docs/interfaces/Task.html
+++ b/docs/interfaces/Task.html
@@ -1,20 +1,30 @@
 Task | @nevermined-io/payments
      Interface Task
      A task defines something that the agent should execute.
      
-
      interface Task { 
          created_at?: Date; 
          input: ExecutionInput; 
          name?: string; 
          output?: ExecutionOutput; 
          retries?: number; 
          status: AgentExecutionStatus; 
          steps: Step[]; 
          task_id: string; 
          updated_at?: Date; 
      }
      Hierarchy (view full)
      Properties
      created_at?
-input
+
      interface Task { 
          cost?: number; 
          created_at?: Date; 
          input_artifacts?: Artifact[]; 
          input_params?: { 
              [name: string]: string; 
          }[]; 
          input_query: string; 
          name?: string; 
          output: any; 
          output_additional?: { 
              [name: string]: any; 
          }[]; 
          output_artifacts?: any[]; 
          retries?: number; 
          steps: Step[]; 
          task_id: string; 
          task_status: AgentExecutionStatus; 
          updated_at?: Date; 
      }
      Hierarchy (view full)
      Properties
      cost?
+created_at?
+input_artifacts?
+input_params?
+input_query
 name?
-output?
+output
+output_additional?
+output_artifacts?
 retries?
-status
 steps
 task_id
+task_status
 updated_at?
-
      Properties
      Optional created_at
      created_at?: Date
      When the execution was created
      
-
      input
      input: ExecutionInput
      The input for the task. It can be a prompt, a question, etc
      
-
      Optional name
      name?: string
      The name of the task
      
-
      Optional output
      output?: ExecutionOutput
      The output of the step
      
-
      Optional retries
      retries?: number
      The number of retries for the task or step
      
-
      status
      status: AgentExecutionStatus
      The status of the execution
      
-
      steps
      steps: Step[]
      The steps executed by the agent to complete the task
      
-
      task_id
      task_id: string
      The unique identifier of the task
      
-
      Optional updated_at
      updated_at?: Date
      When the execution was last updated
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      created_atinputnameoutputretriesstatusstepstask_idupdated_at
      
\ No newline at end of file
+
      Properties
      Optional cost
      cost?: number
      The cost in credits resulting from the execution of the task or the step
      
+
      Optional created_at
      created_at?: Date
      When the execution was created
      
+
      Optional input_artifacts
      input_artifacts?: Artifact[]
      List of artifact ids that are associated with the task
      
+
      Optional input_params
      input_params?: { 
          [name: string]: string; 
      }[]
      Additional parameters required for the task
      
+
      Type declaration
      • [name: string]: string
      input_query
      input_query: string
      The input for the task. It can be a prompt, a question, etc
      
+
      Optional name
      name?: string
      The name of the task
      
+
      output
      output: any
      The main output generated by a task or step
      
+
      Optional output_additional
      output_additional?: { 
          [name: string]: any; 
      }[]
      Additional output generated
      
+
      Type declaration
      • [name: string]: any
      Optional output_artifacts
      output_artifacts?: any[]
      List of artifact generated by the task or step
      
+
      Optional retries
      retries?: number
      The number of retries for the task or step
      
+
      steps
      steps: Step[]
      The steps executed by the agent to complete the task
      
+
      task_id
      task_id: string
      The unique identifier of the task
      
+
      task_status
      task_status: AgentExecutionStatus
      The status of the execution
      
+
      Optional updated_at
      updated_at?: Date
      When the execution was last updated
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      costcreated_atinput_artifactsinput_paramsinput_querynameoutputoutput_additionaloutput_artifactsretriesstepstask_idtask_statusupdated_at
      
\ No newline at end of file
diff --git a/docs/modules.html b/docs/modules.html
index b5501f4..118cd85 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -24,13 +24,17 @@
 GET_BUILDER_STEPS_ENDPOINT
 GET_TASK_ENDPOINT
 GET_TASK_STEPS_ENDPOINT
-LAST_STEP_NAME
 SEARCH_STEPS_ENDPOINT
 SEARCH_TASKS_ENDPOINT
 TASK_ENDPOINT
 UPDATE_STEP_ENDPOINT
 ZeroAddress
-
      Functions
      isEthereumAddress
+
      Functions
      generateStepId
+getAIHubOpenApiUrl
+getQueryProtocolEndpoints
+getServiceHostFromEndpoints
+isEthereumAddress
+isStepIdValid
 jsonReplacer
 sleep
 
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/types/EnvironmentName.html b/docs/types/EnvironmentName.html
index 53ba269..2c8f13e 100644
--- a/docs/types/EnvironmentName.html
+++ b/docs/types/EnvironmentName.html
@@ -1 +1 @@
-EnvironmentName | @nevermined-io/payments
      Type alias EnvironmentName
      EnvironmentName: "local" | "staging" | "testing" | "arbitrum" | "peaq" | "custom"
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+EnvironmentName | @nevermined-io/payments
      Type alias EnvironmentName
      EnvironmentName: "local" | "staging" | "testing" | "arbitrum" | "peaq" | "custom"
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/CREATE_STEPS_ENDPOINT.html b/docs/variables/CREATE_STEPS_ENDPOINT.html
index 99d4598..1377474 100644
--- a/docs/variables/CREATE_STEPS_ENDPOINT.html
+++ b/docs/variables/CREATE_STEPS_ENDPOINT.html
@@ -1 +1 @@
-CREATE_STEPS_ENDPOINT | @nevermined-io/payments
      Variable CREATE_STEPS_ENDPOINTConst 
      CREATE_STEPS_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}/steps" = '/api/v1/agents/{did}/tasks/{taskId}/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+CREATE_STEPS_ENDPOINT | @nevermined-io/payments
      Variable CREATE_STEPS_ENDPOINTConst 
      CREATE_STEPS_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}/steps" = '/api/v1/agents/{did}/tasks/{taskId}/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/Environments.html b/docs/variables/Environments.html
index 81c077b..e6e6537 100644
--- a/docs/variables/Environments.html
+++ b/docs/variables/Environments.html
@@ -1,2 +1,2 @@
 Environments | @nevermined-io/payments
      Variable EnvironmentsConst 
      Environments: Record<EnvironmentName, EnvironmentInfo> = ...
      Represents the different environments and their corresponding URLs.
      
-
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/FIRST_STEP_NAME.html b/docs/variables/FIRST_STEP_NAME.html
index 67f897f..29bbe76 100644
--- a/docs/variables/FIRST_STEP_NAME.html
+++ b/docs/variables/FIRST_STEP_NAME.html
@@ -1 +1 @@
-FIRST_STEP_NAME | @nevermined-io/payments
      Variable FIRST_STEP_NAMEConst 
      FIRST_STEP_NAME: "init" = 'init'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+FIRST_STEP_NAME | @nevermined-io/payments
      Variable FIRST_STEP_NAMEConst 
      FIRST_STEP_NAME: "init" = 'init'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/GET_AGENTS_ENDPOINT.html b/docs/variables/GET_AGENTS_ENDPOINT.html
index 698fa14..39a0451 100644
--- a/docs/variables/GET_AGENTS_ENDPOINT.html
+++ b/docs/variables/GET_AGENTS_ENDPOINT.html
@@ -1 +1 @@
-GET_AGENTS_ENDPOINT | @nevermined-io/payments
      Variable GET_AGENTS_ENDPOINTConst 
      GET_AGENTS_ENDPOINT: "/api/v1/agents" = '/api/v1/agents'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+GET_AGENTS_ENDPOINT | @nevermined-io/payments
      Variable GET_AGENTS_ENDPOINTConst 
      GET_AGENTS_ENDPOINT: "/api/v1/agents" = '/api/v1/agents'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/GET_BUILDER_STEPS_ENDPOINT.html b/docs/variables/GET_BUILDER_STEPS_ENDPOINT.html
index cc2b459..1500792 100644
--- a/docs/variables/GET_BUILDER_STEPS_ENDPOINT.html
+++ b/docs/variables/GET_BUILDER_STEPS_ENDPOINT.html
@@ -1 +1 @@
-GET_BUILDER_STEPS_ENDPOINT | @nevermined-io/payments
      Variable GET_BUILDER_STEPS_ENDPOINTConst 
      GET_BUILDER_STEPS_ENDPOINT: "/api/v1/agents/steps" = '/api/v1/agents/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+GET_BUILDER_STEPS_ENDPOINT | @nevermined-io/payments
      Variable GET_BUILDER_STEPS_ENDPOINTConst 
      GET_BUILDER_STEPS_ENDPOINT: "/api/v1/agents/steps" = '/api/v1/agents/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/GET_TASK_ENDPOINT.html b/docs/variables/GET_TASK_ENDPOINT.html
index 3c33307..baaca05 100644
--- a/docs/variables/GET_TASK_ENDPOINT.html
+++ b/docs/variables/GET_TASK_ENDPOINT.html
@@ -1 +1 @@
-GET_TASK_ENDPOINT | @nevermined-io/payments
      Variable GET_TASK_ENDPOINTConst 
      GET_TASK_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}" = '/api/v1/agents/{did}/tasks/{taskId}'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+GET_TASK_ENDPOINT | @nevermined-io/payments
      Variable GET_TASK_ENDPOINTConst 
      GET_TASK_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}" = '/api/v1/agents/{did}/tasks/{taskId}'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/GET_TASK_STEPS_ENDPOINT.html b/docs/variables/GET_TASK_STEPS_ENDPOINT.html
index 42fda1d..7a49f2d 100644
--- a/docs/variables/GET_TASK_STEPS_ENDPOINT.html
+++ b/docs/variables/GET_TASK_STEPS_ENDPOINT.html
@@ -1 +1 @@
-GET_TASK_STEPS_ENDPOINT | @nevermined-io/payments
      Variable GET_TASK_STEPS_ENDPOINTConst 
      GET_TASK_STEPS_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}/steps" = '/api/v1/agents/{did}/tasks/{taskId}/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+GET_TASK_STEPS_ENDPOINT | @nevermined-io/payments
      Variable GET_TASK_STEPS_ENDPOINTConst 
      GET_TASK_STEPS_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}/steps" = '/api/v1/agents/{did}/tasks/{taskId}/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/LAST_STEP_NAME.html b/docs/variables/LAST_STEP_NAME.html
deleted file mode 100644
index 063344a..0000000
--- a/docs/variables/LAST_STEP_NAME.html
+++ /dev/null
@@ -1 +0,0 @@
-LAST_STEP_NAME | @nevermined-io/payments
      Variable LAST_STEP_NAMEConst 
      LAST_STEP_NAME: "init" = 'init'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/SEARCH_STEPS_ENDPOINT.html b/docs/variables/SEARCH_STEPS_ENDPOINT.html
index 516225f..4db7a91 100644
--- a/docs/variables/SEARCH_STEPS_ENDPOINT.html
+++ b/docs/variables/SEARCH_STEPS_ENDPOINT.html
@@ -1 +1 @@
-SEARCH_STEPS_ENDPOINT | @nevermined-io/payments
      Variable SEARCH_STEPS_ENDPOINTConst 
      SEARCH_STEPS_ENDPOINT: "/api/v1/agents/search/steps" = '/api/v1/agents/search/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+SEARCH_STEPS_ENDPOINT | @nevermined-io/payments
      Variable SEARCH_STEPS_ENDPOINTConst 
      SEARCH_STEPS_ENDPOINT: "/api/v1/agents/search/steps" = '/api/v1/agents/search/steps'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/SEARCH_TASKS_ENDPOINT.html b/docs/variables/SEARCH_TASKS_ENDPOINT.html
index 1125701..342a9ff 100644
--- a/docs/variables/SEARCH_TASKS_ENDPOINT.html
+++ b/docs/variables/SEARCH_TASKS_ENDPOINT.html
@@ -1 +1 @@
-SEARCH_TASKS_ENDPOINT | @nevermined-io/payments
      Variable SEARCH_TASKS_ENDPOINTConst 
      SEARCH_TASKS_ENDPOINT: "/api/v1/agents/search/tasks" = '/api/v1/agents/search/tasks'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+SEARCH_TASKS_ENDPOINT | @nevermined-io/payments
      Variable SEARCH_TASKS_ENDPOINTConst 
      SEARCH_TASKS_ENDPOINT: "/api/v1/agents/search/tasks" = '/api/v1/agents/search/tasks'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/TASK_ENDPOINT.html b/docs/variables/TASK_ENDPOINT.html
index 658a36d..80321f8 100644
--- a/docs/variables/TASK_ENDPOINT.html
+++ b/docs/variables/TASK_ENDPOINT.html
@@ -1 +1 @@
-TASK_ENDPOINT | @nevermined-io/payments
      Variable TASK_ENDPOINTConst 
      TASK_ENDPOINT: "/api/v1/agents/{did}/tasks" = '/api/v1/agents/{did}/tasks'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+TASK_ENDPOINT | @nevermined-io/payments
      Variable TASK_ENDPOINTConst 
      TASK_ENDPOINT: "/api/v1/agents/{did}/tasks" = '/api/v1/agents/{did}/tasks'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/UPDATE_STEP_ENDPOINT.html b/docs/variables/UPDATE_STEP_ENDPOINT.html
index c54196d..eeccf99 100644
--- a/docs/variables/UPDATE_STEP_ENDPOINT.html
+++ b/docs/variables/UPDATE_STEP_ENDPOINT.html
@@ -1 +1 @@
-UPDATE_STEP_ENDPOINT | @nevermined-io/payments
      Variable UPDATE_STEP_ENDPOINTConst 
      UPDATE_STEP_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}/step/{stepId}" = '/api/v1/agents/{did}/tasks/{taskId}/step/{stepId}'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+UPDATE_STEP_ENDPOINT | @nevermined-io/payments
      Variable UPDATE_STEP_ENDPOINTConst 
      UPDATE_STEP_ENDPOINT: "/api/v1/agents/{did}/tasks/{taskId}/step/{stepId}" = '/api/v1/agents/{did}/tasks/{taskId}/step/{stepId}'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
diff --git a/docs/variables/ZeroAddress.html b/docs/variables/ZeroAddress.html
index dbd2e51..09a628a 100644
--- a/docs/variables/ZeroAddress.html
+++ b/docs/variables/ZeroAddress.html
@@ -1 +1 @@
-ZeroAddress | @nevermined-io/payments
      Variable ZeroAddressConst 
      ZeroAddress: "0x0000000000000000000000000000000000000000" = '0x0000000000000000000000000000000000000000'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+ZeroAddress | @nevermined-io/payments
      Variable ZeroAddressConst 
      ZeroAddress: "0x0000000000000000000000000000000000000000" = '0x0000000000000000000000000000000000000000'
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file