diff --git a/docs/docs/api-reference/sidebar.js b/docs/docs/api-reference/sidebar.js index 476e9aa6..46698fe1 100644 --- a/docs/docs/api-reference/sidebar.js +++ b/docs/docs/api-reference/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"category","label":"Siwe","link":{"type":"doc","id":"api-reference/siwe"},"items":[{"type":"doc","id":"api-reference/siwe-challenge-controller-request-challenge","label":"Request a challenge","className":"api-method post"},{"type":"doc","id":"api-reference/siwe-verify-controller-verify","label":"Verify a message","className":"api-method post"}]},{"type":"category","label":"Primary Name","link":{"type":"doc","id":"api-reference/primary-name"},"items":[{"type":"doc","id":"api-reference/primary-name-read-controller-get-primary-name-by-address","label":"Get by Address","className":"api-method get"},{"type":"doc","id":"api-reference/primary-name-write-controller-set-primary-name","label":"Set Primary Name","className":"api-method post"}]},{"type":"category","label":"Subname","items":[{"type":"doc","id":"api-reference/subdomain-write-controller-accept","label":"Claim Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-api-reserve","label":"Reserve Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-add","label":"Add Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-update","label":"Update Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-revoke","label":"Revoke Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-by-domain-name-and-name-and-chain-id","label":"Get by Username and ENS Domain","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-by-full-domain-and-chain-id","label":"Get by Subname","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-all-by-domain-name-and-chain-id","label":"Get all by ENS Domain","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-all-by-address","label":"Get all by Address","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-get-invitations","label":"Get Subnames Reserved to an Address","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-get-subdomain-records","label":"Get Subnames and ENS Records","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-is-username-available","label":"Available","className":"api-method get"}]}]; \ No newline at end of file +module.exports = [{"type":"category","label":"Siwe","link":{"type":"doc","id":"api-reference/siwe"},"items":[{"type":"doc","id":"api-reference/siwe-challenge-controller-request-challenge","label":"Request a challenge","className":"api-method post"},{"type":"doc","id":"api-reference/siwe-verify-controller-verify","label":"Verify a message","className":"api-method post"}]},{"type":"category","label":"Primary Name","link":{"type":"doc","id":"api-reference/primary-name"},"items":[{"type":"doc","id":"api-reference/primary-name-read-controller-get-primary-name-by-address","label":"Get by Address","className":"api-method get"},{"type":"doc","id":"api-reference/primary-name-write-controller-set-primary-name","label":"Set Primary Name","className":"api-method post"}]},{"type":"category","label":"Subname","items":[{"type":"doc","id":"api-reference/subdomain-write-controller-accept","label":"Accept Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-api-reserve","label":"Reserve Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-add","label":"Add Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-update","label":"Update Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-revoke","label":"Revoke Subname","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-write-controller-revoke-invitation","label":"Reject Subname Invitation","className":"api-method post"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-by-domain-name-and-name-and-chain-id","label":"Get by Username and ENS Domain","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-by-full-domain-and-chain-id","label":"Get by Subname","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-all-by-domain-name-and-chain-id","label":"Get all by ENS Domain","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-find-all-by-address","label":"Get all by Address","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-get-invitations","label":"Get Subnames Reserved to an Address","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-get-subdomain-records","label":"Get Subnames and ENS Records","className":"api-method get"},{"type":"doc","id":"api-reference/subdomain-read-controller-is-username-available","label":"Is Subname Available","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs/docs/api-reference/subdomain-read-controller-find-all-by-address.api.mdx b/docs/docs/api-reference/subdomain-read-controller-find-all-by-address.api.mdx index 382388fe..1e32d708 100644 --- a/docs/docs/api-reference/subdomain-read-controller-find-all-by-address.api.mdx +++ b/docs/docs/api-reference/subdomain-read-controller-find-all-by-address.api.mdx @@ -36,5 +36,5 @@ Retrieves all subnames associated with an address The Subname was fetched successfully. -
Schema
    result objectrequired
    data objectrequired
    data objectrequired
+
Schema
    result objectrequired
    data objectrequired
    data objectrequired
\ No newline at end of file diff --git a/docs/docs/api-reference/subdomain-read-controller-find-all-by-domain-name-and-chain-id.api.mdx b/docs/docs/api-reference/subdomain-read-controller-find-all-by-domain-name-and-chain-id.api.mdx index 2107984c..819fa839 100644 --- a/docs/docs/api-reference/subdomain-read-controller-find-all-by-domain-name-and-chain-id.api.mdx +++ b/docs/docs/api-reference/subdomain-read-controller-find-all-by-domain-name-and-chain-id.api.mdx @@ -36,5 +36,5 @@ Retrieves all subnames associated with the provided ens domain The Subnames were fetched successfully. -
Schema
    result objectrequired
    data objectrequired
    data objectrequired
+
Schema
    result objectrequired
    data objectrequired
    data objectrequired
\ No newline at end of file diff --git a/docs/docs/api-reference/subdomain-read-controller-find-by-domain-name-and-name-and-chain-id.api.mdx b/docs/docs/api-reference/subdomain-read-controller-find-by-domain-name-and-name-and-chain-id.api.mdx index 5422cecb..815c0343 100644 --- a/docs/docs/api-reference/subdomain-read-controller-find-by-domain-name-and-name-and-chain-id.api.mdx +++ b/docs/docs/api-reference/subdomain-read-controller-find-by-domain-name-and-name-and-chain-id.api.mdx @@ -36,5 +36,5 @@ Retrieves subname details based on the specified ENS domain, username, and chain The subname was fetched successfully. -
Schema
    result objectrequired
    data objectrequired
    data objectrequired
+
Schema
    result objectrequired
    data objectrequired
    data objectrequired
\ No newline at end of file diff --git a/docs/docs/api-reference/subdomain-read-controller-find-by-full-domain-and-chain-id.api.mdx b/docs/docs/api-reference/subdomain-read-controller-find-by-full-domain-and-chain-id.api.mdx index 58d568b4..7a8edc93 100644 --- a/docs/docs/api-reference/subdomain-read-controller-find-by-full-domain-and-chain-id.api.mdx +++ b/docs/docs/api-reference/subdomain-read-controller-find-by-full-domain-and-chain-id.api.mdx @@ -36,5 +36,5 @@ Retrieves subname details based on the specified subname and chainId The Subname was fetched successfully. -
Schema
    result objectrequired
    data objectrequired
    data objectrequired
+
Schema
    result objectrequired
    data objectrequired
    data objectrequired
\ No newline at end of file diff --git a/docs/docs/api-reference/subdomain-read-controller-get-invitations.api.mdx b/docs/docs/api-reference/subdomain-read-controller-get-invitations.api.mdx index 484fa70f..8a05290b 100644 --- a/docs/docs/api-reference/subdomain-read-controller-get-invitations.api.mdx +++ b/docs/docs/api-reference/subdomain-read-controller-get-invitations.api.mdx @@ -36,5 +36,5 @@ Retrieves all subnames reserved to an address The Subname was fetched successfully. -
Schema
    result objectrequired
    data objectrequired
    data objectrequired
+
Schema
    result objectrequired
    data objectrequired
    data objectrequired
\ No newline at end of file diff --git a/docs/docs/api-reference/subdomain-read-controller-is-username-available.api.mdx b/docs/docs/api-reference/subdomain-read-controller-is-username-available.api.mdx index 72ddb22a..4ef14a2b 100644 --- a/docs/docs/api-reference/subdomain-read-controller-is-username-available.api.mdx +++ b/docs/docs/api-reference/subdomain-read-controller-is-username-available.api.mdx @@ -1,11 +1,11 @@ --- id: subdomain-read-controller-is-username-available -title: "Available" +title: "Is Subname Available" description: "Checks if a username is available for a given ENS domain" sidebar_label: "Is Subname Available" hide_title: true hide_table_of_contents: true -api: eJy9VU1v4jAQ/SuWT62UJbBSpRW3ClWrHrYHoCdUrUwyJKaO7doOFEX8951xQkmhi7q70l4gsd/MvPl6abix4ESQRt/nfMxn9TI3lZB6CiKfGB2cUQrcT+kfPTgtKrjdCKnEUgFPeA4+c9KSNdpOSsiePZMrJljdoZn0TBws2Mo4vCvkBjS7e5ixNhQ6ssIhOIDzfLxoOFmiQ18v41PCHbzU0gEyDK6GhEuK91KD252xmJfAjobwKiqryBkxGqyFHkAo8cJnJVSCjxsedjYGC07qgu/3yVv8rER2WJY/ij8hIybzhG2BGa12yMZa4wK7CyU4qCv2AxEaAhM6ZzOwRknB5uADnV2NYpWqFpKw0Wh0c4M/8dS34Ot+YgfABynpulqCw5SeKANvjfbg6T6HlahVaB9Pi3dAsq3wbAUBveaYQ5aB96taqd0Aw2c4GqCjB2GtklkcoXTtyU1zTsUs15AF6rSjgQuyJeKDCLWfmBzOafdy/DocftjmaM0yNGdmxUKP/IDvY85dlpdZ5CJ8guvbGPegS2MUCE1T05uRRQ+LpQ8yxAm8P9+hWyunHWMiDM4Zdz6Tp7k/YBdozbRh0YKZLKsdhk6YoRnbSuweVaO9rbBxoqCSnLCMeR+ifproNFZ1thVFEYfrvc9eR98a8GnXs3bKjr735D6IgmSBtCkuJrpDrSgN6VUBsVECd3rMU9A+3YxSfxCxVPTECuNuDgJTO4X4MgTrx2kqrBysa2RO7gcy56QBZ5AvCCiwHZegiFQmE6o0Poy/DYdDTrsn9crErnZFmMf/06723xJOVNvz0WDYLZzIaJipJBb9VyKuWqdVv5Xl5rir/6LQ3UQGeA2pVXSGNGLiTVf+BcfyE/MRFfvQAnx+twxUGcI2zVJ4eHRqv6fjVkupNbn0hMXmroTycCGbq2k3d9fsveh/yPUZdu8+KRuhakLFDv5V0P+k9BeyOX6gjtk80YuTrVAtnhBb4qcct4mK25rd4pbZ0LM6k/B9f8e+381xFX8BC4TSOg== +api: eJy9VVFv2jAQ/iuWn1opIzCp0sRbhaqpD+sD0CdUTSY5ElPHdm0HiiL+++6cUFLoULdJe4HE/u7uu/vuLg03FpwI0uj7nI/5rF7mphJST0HkE6ODM0qB+yn9owenRQW3GyGVWCrgCc/BZ05askbbSQnZs2dyxQSrOzSTnomDBVsZh3eF3IBmdw8z1oZCR1Y4BAdwno8XDSdLdOjrZXxKuIOXWjpAhsHVkHBJ8V5qcLszFvMS2NEQXkVlFTkjRoO10AMIJV74rIRK8HHDw87GYMFJXfD9PnmLn5XIDsvyR/EnZMRknrAtMKPVDtlYa1xgd6EEB3XFfiBCQ2BC52wG1igp2Bx8oLOrUaxS1UISNhqNbm7wJ576FnzdT+wA+CAlXVdLcJjSE2XgrdEePN3nsBK1Cu3jafEOSLYVnq0goNccc8gy8H5VK7UbYPgMWwN09CCsVTKLLZSuPblpzqmY5RqyQEo7arggWyI+iFD7icnhnHYvx6/D4YcyR2uWoTkzKxZ65Ad8H3PusrzMIhfhE1zf2rgHXRqjQGjqml6PLHpYLH2QIXbg/fkM3Vo57RgTYXDOuPOePM39AVWgMdOGRQtmsqx2GDphhnpsK1E9qkZ7W6FwoqCSnLCMeR+ifproNFZ1thVFEZvrvc+eom8CfNr1rO2yo+89uQ+ioLVAuykOJrrDXVEa2lcFRKEEzvSYp6B9uhml/rDEUtFbVhh3c1gwtVOIL0OwfpymwsrBukbm5H4gc0474AzyBQEFynEJikhlMqFK48P423A45DR7Uq9MVLUrwjz+n6raf0s4UW3PR4NhN3Aio2amklj0X4k4at2uuvesqw/77YZujmP7L8u6a84AryG1is6QUaxB0ymx4KgEJTGiuh/UwOd3c0FFImzTLIWHR6f2ezpu1yqplEtPWNR5JZSHC9lcTbsWvGbv9/+HXJ9h9+7rshGqJlQU86+C/qelfyGb47fqmM0TvTjZ7qzFE2JL/KrjYFFxW7NbHDgbelZn23zfH7fvd3Ocyl9N8NYB sidebar_class_name: "get api-method" info_path: api-reference/title custom_edit_url: null diff --git a/docs/docs/api-reference/subdomain-write-controller-accept.api.mdx b/docs/docs/api-reference/subdomain-write-controller-accept.api.mdx index c887c0da..cfc455ba 100644 --- a/docs/docs/api-reference/subdomain-write-controller-accept.api.mdx +++ b/docs/docs/api-reference/subdomain-write-controller-accept.api.mdx @@ -1,11 +1,11 @@ --- id: subdomain-write-controller-accept -title: "Claim Subname" +title: "Accept Subname" description: "Accept a reserved Subname." sidebar_label: "Accept Subname" hide_title: true hide_table_of_contents: true -api: eJytVt9v2zYQ/lcEPq2AYyt7KvyWpQU6DN0GJ0UfvGA4S2ebmSRqJJUfEPy/946kJNpWHTdNAiQ2ebzvePfxu2uFqlGDlar6PRdzcdOsclWCrL5qafFaVVarokD9L2QZ1lZMRI4m07LmE2R/XYAsE0g0GtQPmCfkoIISp2RZg6ZPFrUR82UreJlOPF0YuanANhrJRrKTLUKO+sj37RaT3pYdavy/kRopTqsbnAiTbbEEMW+Ffa7Zt7FaVhux200iuBKNgc05YJ+95euhIM8pEeYMqCtv+RNQtbz4D5/Pgapl8gc+/xjUnTdGY39T+TNbHJ7NiBtYWd6Cui5k5kg0uzcM3B67Vqt7zJhAtWbKWYmGdxvijb/UURATgZX54Ng4upttaYdZ2+9VTbmiLNBeqITHCLugNbiEWSzNy5F1xRyFVrK6dYtH2Ls4zUsxUKI/Q7m10hZ8KNDgI93TKnfW4pN9fczMiLF4H6BoxlJ8EKwnlDeOorylmBaYKZ13UYbifwKzfdlrX+K4oEP54mKF++8DRJH08nTl5IiovfAsJVAPa2pVhbLnuIamsP7j4asIOpU8gkkyFjHSLtOQV2PWTVG45/JGFDeWFMxcq3yELpSSJyhrvtyvaTqqgO50ktHxRK0TS0vdLafCXzlc8nQUOdgzYpX5cT2jGEX6NJ062LPc7YbKfUYL7swhOyQzwO28UGd/ZycLWis9Fud+9v6kOiZynVQqcScSlWWNJthJoiiN+lEadPn0u2Wn/ocRuuA61LOCXLia3DzCZjMiCREf+vKd5fbG83Pw6zhvYcMNVgRGsyvqulvF7bxWxhUFLL1TMaPnN3u4nJkOYdZ3dde9Q6NudMEdxdrazGczajTT+4Zidm2dqsVt6Mjkggw2VIRTpmRZqAyKLQU1f5+mqeA2w69pMbSajx3V4tYQMXHoCMNi3wjSPeFfRhoeGffSnTK819tlkM7BLChmr2l3B6IXiaus1sqxsZNL9/+QjfE3ck/J9uuX0zRIDWT8jLmkXLYSnMiEBPg5qyvxge92UKqTA1l4LnzlWV1wEgnL1acNFFlygjm8S+ZERxOWaE8UygJXjw3bdgUGv+hit+NlKqCmBC7vOHVawopTsbwjgDCacI5zaXiDKrWGwuCJa/yyCA/mXXI0Bo5ew5dvf7jsauh4+GrsaCo8iTzMmW+DG42IJ3GHCeONcId58TRuP4Hu4frta+/9wr20weKojQ4nrjop+r5trGx//3VzS8arMJ2WrrsKDY+sqfR3Lv6hX/qi3I1dc3PrrSig2jRcqbnwfvnnG1cpejk= +api: eJytVlFv2zgM/iuGnjYgTdx7OuSt6w3YHnZ3SHu4h6w4MDaTqLMtnyS3DYz895GSbCuJl2bFWqBNJJIfxY/6qFaoGjVYqarPuZiLu2aVqxJk9a+WFm9VZbUqCtT/QZZhbcVE5GgyLWv2IPsbt5xAotGgfsI8oQgVlDgl0xo0fbKojZgvW8HL5PJyZeSmAttoJBvJUbYIOeqT4PdbTHpbDqjx/0ZqpEStbnAiTLbFEsS8FXZXc2xjtaw2Yr+fRHAlGgObS8C+eMu3Q0GeUyHMBVA33vLnoB68MRr7QeU7tjj2zYgxrCxvQV0XMnPUzh4NA7enodXqETOmtdbcCFai4d2GyPSHOkliIrAyf7geGd3NtrTDvdTvVU25oirQXiiPxwi7oDXsuGAWS/N6Zl2FR6GVrO7d4gn2Pi7zUgw89T5UWyttwU6Bm490Tqucr8UX+/acv+FuNN8nKJqxEh8ly+6dcZTlPeW0wEzpvMsykP8JzPb1qD3FMaEDfTFZ4fyHAFEmvWh4Nbip5cJ3KYF6WFOrKtCe4xqawvqPx7ciiEfyDCbJCpAlCYppKKox66YodlPxy1rcWJIVc6vykXahkrxAWfPhfkvTUVly3klG7olaJ5aWulNOhT9yOOT5LHKwF+Qq81M+oxxF+jKdOtiLwu0H5r6gBedz3B2SO8DtvMKzP7OTBa2VHsvzsHp/Eo+JXCeVSpxHorKs0QQ7SRSVUT9Lg66efrfsJPk4Q5dch3pRkgvHyd0zbDYjkhD1Q0/fRWHvfH8OcV3PW9jw1BOhozkUjcKt4iFbK+NIAUv3VMzo+s2ermemQ5j1s9aN1DA9G13wRLG2NvPZDGo5fWwoZzdriS0eQycmV2SwIRLOmZJloTIotpTU/Pc0TQWPGb5Ni2HUfOxaLR4NUScOE2FY7AdBeiD8y0jDI+NeulOG93q7DNI5mAXF7DXt4Uj0InGV1Vq5buzk0v0/7sb4G4WnYvv162kapAYyvsZMKdNWghOZUIDw+uk4PgreDlJ1/p0ULgwfelYXXEZCcwy1oUmWXGJO8Jq7omsUFmnfKlQH5o8N23YFBv/RxX7Py0ShphIuH7h4WsKKi7F8IIDwOOEq59LwBnG1hsLgmXO8W4Qr8z45eZ2NHsMTePjm61h0nfhm7OixdhZ5eP79Gtzo5XYWd3hjHOD67Vsf/cr1/GBxMtAGj5tOFH5sG2vM33/d3ZPxKrwTSzfnhIZnVjf6Oxdf6Ze+KHdiN2bceisKqDYNV2wufFz++Q4DlDBV sidebar_class_name: "post api-method" info_path: api-reference/title custom_edit_url: null @@ -28,11 +28,11 @@ import TabItem from "@theme/TabItem"; -Claim a reserved Subname. +Accept a reserved Subname. ## Request -

Header Parameters

Body

required
    addresses object[]required
  • Array [
  • ]
  • text object[]required
  • Array [
  • ]
+

Header Parameters

Body

required
    addresses object[]required
  • Array [
  • ]
  • text object[]required
  • Array [
  • ]
The Subname was claimed successfully. diff --git a/docs/docs/api-reference/subdomain-write-controller-add.api.mdx b/docs/docs/api-reference/subdomain-write-controller-add.api.mdx index 66ddfcc3..cfbf8431 100644 --- a/docs/docs/api-reference/subdomain-write-controller-add.api.mdx +++ b/docs/docs/api-reference/subdomain-write-controller-add.api.mdx @@ -5,7 +5,7 @@ description: "Add a new subname" sidebar_label: "Add Subname" hide_title: true hide_table_of_contents: true -api: eJzNV21vGjkQ/iuWP7USCWwbEsqnI5B70TVtAlRVlYtOZu0Fp7vrre2FcCj//WbsZVlgS16Uky6RErAfz4xnnnnxiqpMaGalSv/gtEtH+YSrhMn0q5ZW9FVqtYpjof9mnNMG5cKEWmYIB3CPc8JIKhbE5JOUJQIQGdPwwQptaPdmRd1ql94fsUwefRdLQEg8OhOMC70ncTwTpJdJ8qdYHsOmFj9yqQUYZnUuGtSEM5Ew2l1Ru8xQrrFaplP68NCoqDJymjKba/EEZSX25eoSYQybPkXZpUe+XBUEQYOMpzjRI5+n6taDhbHnii8RsXs2BEKI1OIWy7JYho45zTuDilf7otXkToQWaaGRZ1YKg7u5EdpfateIursgkqiIWIzXmp+AFPcsyWI8zMWcPsBCagZ+89ly4SipEXzHUhQczmAD86MUm+bJpMb1fQQSyRtkAaLTeAkGZ5nSllyAFi3yhFwCIhWWsJSTkchULBkZg8tx7U1AIqVJ4iENEgRBuw1/3Krx4LdVA9cAsLHghnfw/mXLbRIqDZ8ylXJwDLHq536F/F0zrktb95MPp23Wjt6zVtQPOoPOycVpp9N5H4Y93m51Tk7a7OxDcNbrUOSJTMfOU6ctZPBGTNAL/rkKxFX7+jcRyXeDy6txNP7YHn1M5mcDOY8+sa3jLSRl4XOmNXMFxIrEPE6yUuce0asKdiMKCVdh/Q3dpFx5Bi2S1vGjSLMLIJ5V7qwV97Y+ArjzTO9jwexSu5AWCupxqBLYn7M4R9W/3OXGMpdF6GEPXarc5hOxA60gX+xNJ7/Gk4WOmrq15UZf+j244r8x+GQowCd87b+iwvzOzOxpWVwcIDM4cbhKyCwy3WbzOhn2rs9Pv7H+UvKr92df+CC9+/Vbe36dy3Md/uBL9TXo54Pp4v774GTvJmXtqtabTYmoJmLBhu1LVW5fNlugEXS9oa+9oNHrRJaU+RyxPP4JsUa++ZIFM5jmgsP9wxBMiPI4dn30lco2sMjmpq94Td5UHP2u1aptte40xIuXVXd9x2PqL1xc8bAVnNkn2Cp5HX0qZOB7kYWlQ8Hxpro+o7XSj7PzE7ifyIikirgTRIVhDtkP3UFhN1hII3zzcbvJejrYtctdeK31cQuHzo+jBZtOa+pZJYalyx+XOfKE2gh1FLVsilMeLQiIcmD0mykcJDNlXFCYhTymTUiV5jxolonZ9PMk5NJ8PSrmOsaZxtoMsxTmxeOybh1jtBo1kCMATMH3h6CAjFXI4hlY1O20Wi1XBZH7w82wc7EmRnU4cXPF1ljhBoLKPLDuv1vt93/TNl0r+q/ayFahfmltxUE2Ui6V1h3B/d9Npeo3MAgo49eD41ZR3liIpQNZicxLmCtsRRjxnTIqXyhbkleb2lj7nCkyHF3ZzGLkAGhw3FoV3L5BfqBRAfK50niQ4eAnpB2iVqsJM+KLjh8ecBmYp8HVN7foXy3ZxLX8W5BeTPUYOC4NbgDRIhYbccD2N8Mix9+SnTdU7Q18mKuvsnWQHQterHfrOXVQc/WR9jq6K6+rg5o377XX0Vt5ah32dTlJbun1230v/cil7wax1603J3pQkTN7EFutx1efR2MAT4qHXeKaONVsgW0A/nbpX/ALX5S7seuhbn1FY5ZOc/RYl3q5+PMvpe6EXA== +api: eJzNV21vGjkQ/iuWP7USCWwbEsqnI5B70TVtAlRVlYtOZu0Fp7vrre2FcCj//WbsZVlgS16Uky6RErDHM+NnnnnxiqpMaGalSv/gtEtH+YSrhMn0q5ZW9FVqtYpjof9mnNMG5cKEWmYoDsI9zgkjqVgQk09SlgiQyJiGD1ZoQ7s3K+pWu/T+iGXy6LtYgoTEozPBuNB7GsczQXqZJH+K5TFsavEjl1qAY1bnokFNOBMJo90VtcsM9RqrZTqlDw+NiikjpymzuRZPMFbKvtxcIoxh06cYu/SSLzcFQdCg4ykgesnnmbr1wsLYc8WXKLF7NgRCiNTiFsuyWIaOOc07g4ZX+6rV5E6EFmmhkWdWCoO7uRHaX2rXibq7oCRREbEYrzU/QVLcsySL8TAXc/oAC6kZ+M1n64WjpEbxHUtRcTiDDcyPUm2aJ5Ma6PsoSCRvkAWoTuMlOJxlSltyAVa0yBNyCRKpsISlnIxEpmLJyBggx7U3AYmUJokXaZAgCNpt+ONWjRd+W3VwLQA+FtzwAO9fttwmodLwKVMpB2CIVT/HFfJ3zbgubd1PPpy2WTt6z1pRP+gMOicXp51O530Y9ni71Tk5abOzD8FZr0ORJzIdO6ROW8jgjZqgF/xzFYir9vVvIpLvBpdX42j8sT36mMzPBnIefWJbx1tIygJzpjVzBcSKxDxOstLmHtGrBnYjCglXYf0N3aRceQY9ktbxo0izCyCeVe6sFfe2PgK480z0sWB2qV1ICwX1OFQJ7M9ZnKPpX+5yY5nLIkTYiy5VbvOJ2BGtSL4YTae/BsnCRk3d2oLRl34vXMFvDJgMBWDC1/gVFeZ3ZmZ1Tu3DWhwgMzhxuErILDLdZvM6Gfauz0+/sf5S8qv3Z1/4IL379Vt7fp3Lcx3+4Ev1Nejng+ni/vvgZO8mZe2q1ptNiagmYsGG7UtVbl82W6ARdL2hr71g0dtElpT5HLE8/gmxRr75kgUzmOaCw/3DEFyI8jh2ffSVyjawyOamr3hN3lSAftdq1bZadxrixcuqu77jMfUXLq542AvO7BN8lbyuCVTIwPciC0uHguNddX1Ga6Uf7zGfAH4iI5Iq4k4QFYY5ZD90B4XdYCGN8M3H7Sbr6WDXL3fhtdXHPRw6HEcLNp3W1LNKDEvIH9c58oTaKHUUtWyKUx4tCIh6YPSbKRwkM2VcUJiFPKZNSJXmPGiWidn08yTk0nw9KuY6xpnG2gyzFObF47JuHWO0GjUiRyAwBewPiYJkrEIWz8CjbqfVarkqiNwfboadizUxqsOJmyu2xgo3EFTmgXX/3Wq//5u26VrRf9VGtgr1S2srDrKRcqm07gju/24qVb+BQ0AZvx4ct4ryxkIsHchKZF7CXGErwojvlFH5QtnSvNrUxtrnTJHhCGUzi5EDYMFxa1Vw+wb5gU4FyOdK40GGA05IO5RarSbMiC86fnjAZWCeBqhvbhFfLdnEtfxb0F5M9Rg4Lg1uANEiFhtxwPc3wyLH35KdN1TtDXyYq6+ydZAdC15sd+s5ddBy9ZH2OrYrr6uDljfvtdexW3lqHca6nCS37Prtvtd+5NJ3I7HXrTcnelCRM3tQtlqPrz6PxiA8KR52iWviVLMFtgH426V/wS98Ue7Groe69RWNWTrNEbEu9Xrx519zuIQ8 sidebar_class_name: "post api-method" info_path: api-reference/title custom_edit_url: null @@ -40,7 +40,7 @@ The addresses corresponding to the subdomain The texts corresponding to the subdomain -
  • Array [
  • ]
  • +
  • Array [
  • ]
  • The Subname was added successfully. diff --git a/docs/docs/api-reference/subdomain-write-controller-revoke-invitation.api.mdx b/docs/docs/api-reference/subdomain-write-controller-revoke-invitation.api.mdx new file mode 100644 index 00000000..5fe90ff1 --- /dev/null +++ b/docs/docs/api-reference/subdomain-write-controller-revoke-invitation.api.mdx @@ -0,0 +1,40 @@ +--- +id: subdomain-write-controller-revoke-invitation +title: "Reject Subname Invitation" +description: "Reject the specified subname invitation" +sidebar_label: "Reject Subname Invitation" +hide_title: true +hide_table_of_contents: true +api: eJytVkuPGjEM/itRTq3E8qhUqeK23fbQQx8Cqh62qyrMGMg2k6RJBhaN+O+1kxkYGErZqiDBTPLZju3PdipuLDgRpNEfcj7m03Kem0JI/c3JAHdGB2eUAvfDwdr8hA96LUNE8x7PwWdO2vg25hN4hCywsALmLWRyISFnvpxrUQCTbTkrHK4FcJ6P7ytOAJR/uvFyqUUoHSBGksoViBxcx9KMTDTYPm47+FVKB3j+4ErocZ+toBB8XPGwtaTbByf1ku92vZa5ArwXy2uMfUzIfzcl8tyhjitM3Sbk80w9JDD48NbkW0KcymaYSNCBtoS1SmYxF4NHT4arrmozp2RSrhzxI0jwtAvav4vs6J7inDMx9WYROYGiLDELofAkCqtI+lFovuvx0oNL0XquXt8Q9khtDmtSm61wg3i916rLYn4m9HcEZDLvsQ1q1mqLeq01LrD3aMRBWbCPiNAQmNA5m4I1Sgo2w5DT2osRWxjHigTpsdFo9Po1/sRVn8Av2wdsAEiTVq7uWwFuxeTgByY6yBA93BfqJBbmrZWTRAHkQ9LqrdE+5S2HhShVSI+n0Zx2apRthGcu1nOs4SxDSi5KpbbEy//EJY+2Sn9ncjiXnn2kXg2HZ+s/SrMMxRsmNB73eXK/dvjyKXIRrjhro/psnR8lcI/8S6pqFEqDc8b9nfefMPxMLpg2LEowk2WlQ6s9ZoiiG+khFVrcLZqWdXrA6HBj9apDTmIopxuxXGJqTvW10riP+lVqp4lWB72RtkEsaSrwmpSkCkfFytBsssbH1IiwwrcB1spgPRrsG8AgMfbmaNZgDa2bQVM6Rc03BOvHg4Gwsv9Y4vHJTl/mnDp2B3KDgCXm4xIUkcpkQq3wfOM3w+GQU0emepgcuvL7htBHXTT2v3b7i52r1bj2jYJGx8JEntShncX/U56033qcfE/ro/6wrl2RUV1QsCmghYhVW1uvh3jTEv487qtDG3jG5K8pHuApDKyiCFDvp0BWdVpjC6SDjyh5rd7eTS7GmCJOMlU1Fx6+OrXb0TIG3eEYvMfHtXBSzCle9w9oq568xIZcetrAGC+E8nDBvxeTmu8vWefqcdajn7DtXGjWQpWEjNz5Z9utm8hFy4e7zf+x27qWXLR7uOgc2U3bd0n7zYw0HBCdIXKQuMUWYcNFbLtBfPk8nSF4Xl+CijhbuBMb4g/+jvl3/OKLiR6n1k7rFVdCL0uK2JgnvfT5DWWh2Ug= +sidebar_class_name: "post api-method" +info_path: api-reference/title +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

    Reject Subname Invitation

    + + + + + +Reject the specified subname invitation + +## Request + +

    Header Parameters

    Body

    required
    + +The Subname invitation was rejected successfully. + +
    Schema
      result objectrequired
      data objectrequired
    + \ No newline at end of file diff --git a/docs/docs/api-reference/subdomain-write-controller-revoke.api.mdx b/docs/docs/api-reference/subdomain-write-controller-revoke.api.mdx index 740143db..e53b829d 100644 --- a/docs/docs/api-reference/subdomain-write-controller-revoke.api.mdx +++ b/docs/docs/api-reference/subdomain-write-controller-revoke.api.mdx @@ -5,7 +5,7 @@ description: "Revoke the specified subname" sidebar_label: "Revoke Subname" hide_title: true hide_table_of_contents: true -api: eJytVduO2jAQ/RXLT7sSEKi0UsXblu5DVfUioOrDdlWZZACzTuzaDiyK+PfO2CGEi9itVJAgscfHnjNnjiuuDVjhpS4+ZXzIJ+Us07mQxU8rPYx04a1WCuxvC2v9DLzDM3CplYZWYPw4DDO/BOYMpHIuIWOunBUip2AjLD54sI4PHyseRof8pSuM7D7DFiMkoSxBZGDPwKeIem8k+wzbHk5a+FNKC3hMb0vocJcuIRd8WHG/NYTrvJXFgu92TzEYnP+gsy1FnK5NMTMoPE0JY5RMAwXJytHG1Tm0nq0g9ZSRJcK8BEezULiPga7zU1xKhvJneh7owqUsUo2h8CJyo2j1ShR81+GlAxvZ+ldct6/gEWwGa4JNlzhBhW5QizKfXaB+RIFMZh22QeRCbRHXGG09e8BNLJQ5+4IRBXgmioxNwGglBZsi5TR2M2BzbVkeQzpsMBjc3eFPGHUx+LZ9wH3Abteu82OL4BYnhzyw0F76kGGj3ChJ1M04SgD1EFGd0YWLdctgLkrl4+Mpm5MoX7YRjkXZk6TTFJybl0oFLf4n/TgvfOlGOoNLJWnYedfvXyp7XM1SXL6v/j7LHo8p10leP0Um/BvOuoe+1HDHRWsiXylPHYWrwVptX9f6V6SfyTkrNAsrmE7T0uKuHaZJlhvpohfF2RwrJhbExckBQ8L7Xd90yHGgcrIRiwWW5hSvVcaG9TfBTqKsDrhBql4syC95LUSCQhNdajJoo10ojfBLfEuwP5L1IGmaPml8Gptlvffd0ipyWe+NGyYJmm9vVeKZCbwnMyzAhZAuBiywCNdCMVLpVKglHmr4vt/vc7JeaoLxwX4f9io+sstgdG2fCxbVcqjGEeiOmOsgjprPafg/FUf7rcMp9zg+6PXrhhUpNQMxTCzmIrRqvXt9kU2aq+sIvDo0/GtXXq1gDy8+MYpyJTsnyqq6asHV6IgDKlPLruvaIYVEKAVW1Uw4+GHVbkfDyKnF6+wRH9fCSjEjOh6fcIP6BqViZ9LRBFI4F8rBlUxuxrWGb9nJVXsxCbqwjy/vtVAlxQVZxOlRRO9OCeEQcWaShxX32ALGX41tN8D3b5MpBs/qiz0P3smt2BCB+Dvkv/CLLzpkHK2LxiuuRLEo0RBIfQGXPn8BimMc+g== +api: eJytVm1v2jAQ/iuWP60S5WVSpYlvXdcP09RtAqZ96KrJJAe4dWLPdqAo4r/vzk5CeBGlVUGCxH5857t77qXk2oAVXur8a8qHfFxMU50Jmf+20sONzr3VSoH9a2Gpn4B3eAousdLQCcSPwjLzC2DOQCJnElLmimkuMgIbYfHBg3V8eF/ysDrkz5fCyMsnWCNCkpQFiBTsgfAJSr02kn2DdRc3LfwrpAW8prcFdLhLFpAJPiy5XxuS67yV+ZxvNp2WKifnufCFhTOUNdi3q8vAOTE/R9ldRL5dlUhTizLOcWJEvk7VQwSD8591uibE/tkE6QG5py1hjJJJ4FHv0ZHi8lC0nj5C4okWlljnJTjahdx9CZw7vMUxY8h+pmeBc3iURb4iFJ5FZhSdfhQ533R44cBGb71WrqvTYEdsCksSmyxwg7KlkZoX2fSI628IyGTaYSuUnKs1yjVGW89uUYmFImN3iMjBM5GnbAxGKynYBF1Oax8GbKYtyyKkwwaDwdUV/oRVF8EX7QvWAKRJK1b3LQe3fLK1AwPtpQ8WNukf8xqTbxQpgHyIUp3RuYtxS2EmCuXj4743x7EGsJVwLNYOqgtJgjScFUqFhH4n/jiPOetudArHQtJ452O/fzTnw2mW4PE6+rWVXR5Nrow8fYtU+DPuWos+mts7QWuQL4SnQuFpsFbbl7n+Hd3P5IzlmoUTTCdJYVFrh2mi5Uq6WNDjblaXqf0LBoNrrWddchRcOV6J+RxDsy+vFcbG62eJHUdabeUGqnoxp6bDKyKSKOxEC01dzmgXQiP8At96mB+95aDXJH2vaXaYLMu6eRVWUZX13rhhr4cdrPtY4J1JeFemnErzAeQSAXMMwikoIpVOhFrgpYaf+v0+p9JLSTDalt/bmsU75TIUunadCyWqVaGaikA9YqYDOSp/TsL/Pjnabx1Otsf1QbdfJaxIKBnIw+TFTIRUrbRX08C46f87wsttwr80N1QM9vDse0aRrVTOyWVlFbVQ1eiKAwpTq1xXsUMXkkMJWJZT4eCXVZsNLaNPLbaze3xcCivFlNxx/4AKqg5KwU6low104UwoBycs+TCqOHzB9uaVo0bQ1LM7AS2FKggXaPFmvTujy0nN7YHofXS3JpmTmrez0fvobY01p33dDEo7euP2TZR+OSEJW8RBQ9qeuMZyY/xJbLvY/PwxniB4Wg1RWehT3IoVkRV/h/wPfvFFB4tjm6D1kiuRzwvy2JBHufT5DxiVBfE= sidebar_class_name: "post api-method" info_path: api-reference/title custom_edit_url: null @@ -32,7 +32,7 @@ Revoke the specified subname ## Request -

    Header Parameters

    Body

    required
    +

    Header Parameters

    Body

    required
    The Subname was revoked successfully. diff --git a/docs/docs/sdk/core/classes/JustaName.md b/docs/docs/sdk/core/classes/JustaName.md index ed7224dc..87ca2691 100644 --- a/docs/docs/sdk/core/classes/JustaName.md +++ b/docs/docs/sdk/core/classes/JustaName.md @@ -21,7 +21,7 @@ const configuration = { apiKey: 'your-api-key' }; - const justaName = await JustaName.init(configuration); + const justaName = JustaName.init(configuration); const requestChallengeResponse = await justaName.siwe.requestChallenge({ chainId: 1, @@ -52,7 +52,7 @@ const configuration = { #### Defined in -[lib/justaname/index.ts:41](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L41) +[lib/justaname/index.ts:41](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L41) ## Properties @@ -62,7 +62,7 @@ const configuration = { #### Defined in -[lib/justaname/index.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L31) +[lib/justaname/index.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L31) ___ @@ -78,7 +78,7 @@ JustaName #### Defined in -[lib/justaname/index.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L39) +[lib/justaname/index.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L39) ## Methods @@ -106,13 +106,13 @@ Checks if the API key is present. #### Defined in -[lib/justaname/index.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L74) +[lib/justaname/index.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L74) ___ ### init -▸ **init**(`configuration`): `Promise`<[`JustaName`](JustaName.md)\> +▸ **init**(`configuration`): [`JustaName`](JustaName.md) Initializes the JustaName SDK. @@ -124,7 +124,7 @@ Initializes the JustaName SDK. #### Returns -`Promise`<[`JustaName`](JustaName.md)\> +[`JustaName`](JustaName.md) - A promise that resolves with the JustaName SDK. @@ -136,4 +136,4 @@ Initializes the JustaName SDK. #### Defined in -[lib/justaname/index.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L57) +[lib/justaname/index.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L57) diff --git a/docs/docs/sdk/core/classes/Siwe.md b/docs/docs/sdk/core/classes/Siwe.md index 1fe43646..f3881559 100644 --- a/docs/docs/sdk/core/classes/Siwe.md +++ b/docs/docs/sdk/core/classes/Siwe.md @@ -58,7 +58,7 @@ Sends a request to initiate a challenge. #### Defined in -[lib/features/siwe/index.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/siwe/index.ts#L39) +[lib/features/siwe/index.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/siwe/index.ts#L39) ___ @@ -82,4 +82,4 @@ Sends a request to verify a specific address using SIWE. #### Defined in -[lib/features/siwe/index.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/siwe/index.ts#L52) +[lib/features/siwe/index.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/siwe/index.ts#L52) diff --git a/docs/docs/sdk/core/classes/Subnames.md b/docs/docs/sdk/core/classes/Subnames.md index de34339f..2ebf6441 100644 --- a/docs/docs/sdk/core/classes/Subnames.md +++ b/docs/docs/sdk/core/classes/Subnames.md @@ -51,7 +51,7 @@ Constructs a new instance of the Subnames class, optionally with an API key for #### Defined in -[lib/features/subnames/index.ts:60](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L60) +[lib/features/subnames/index.ts:62](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L62) ## Properties @@ -61,7 +61,7 @@ Constructs a new instance of the Subnames class, optionally with an API key for #### Defined in -[lib/features/subnames/index.ts:54](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L54) +[lib/features/subnames/index.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L56) ## Methods @@ -70,7 +70,6 @@ Constructs a new instance of the Subnames class, optionally with an API key for ▸ **acceptSubname**(`params`, `headers`): `Promise`<[`SubnameAcceptResponse`](../interfaces/SubnameAcceptResponse.md)\> Accept a subname invite under a specific domain, associating it with an Ethereum address. -This operation requires an API key. #### Parameters @@ -87,7 +86,7 @@ The result of the claim operation. #### Defined in -[lib/features/subnames/index.ts:71](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L71) +[lib/features/subnames/index.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L72) ___ @@ -113,7 +112,7 @@ The result of the add operation. #### Defined in -[lib/features/subnames/index.ts:106](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L106) +[lib/features/subnames/index.ts:105](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L105) ___ @@ -138,7 +137,7 @@ Information about the subname's availability. #### Defined in -[lib/features/subnames/index.ts:238](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L238) +[lib/features/subnames/index.ts:250](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L250) ___ @@ -164,7 +163,7 @@ A list of subnames associated with the address. #### Defined in -[lib/features/subnames/index.ts:202](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L202) +[lib/features/subnames/index.ts:214](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L214) ___ @@ -189,7 +188,7 @@ The details of the subname, if found. #### Defined in -[lib/features/subnames/index.ts:177](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L177) +[lib/features/subnames/index.ts:189](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L189) ___ @@ -214,7 +213,7 @@ The details of the subname, if found. #### Defined in -[lib/features/subnames/index.ts:189](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L189) +[lib/features/subnames/index.ts:201](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L201) ___ @@ -234,7 +233,7 @@ ___ #### Defined in -[lib/features/subnames/index.ts:208](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L208) +[lib/features/subnames/index.ts:220](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L220) ___ @@ -259,7 +258,7 @@ A list of subname invitations. #### Defined in -[lib/features/subnames/index.ts:226](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L226) +[lib/features/subnames/index.ts:238](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L238) ___ @@ -284,7 +283,7 @@ The records associated with the subname. #### Defined in -[lib/features/subnames/index.ts:251](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L251) +[lib/features/subnames/index.ts:262](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L262) ___ @@ -318,7 +317,32 @@ If called in read-only mode without an API key. #### Defined in -[lib/features/subnames/index.ts:264](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L264) +[lib/features/subnames/index.ts:275](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L275) + +___ + +### rejectSubname + +▸ **rejectSubname**(`params`, `headers`): `Promise`<[`SubnameRejectResponse`](../interfaces/SubnameRejectResponse.md)\> + +Rejects a subname, removing its association and optionally freeing it for re-registration. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`SubnameRejectRequest`](../interfaces/SubnameRejectRequest.md) | The parameters for rejecting the subname. | +| `headers` | [`SIWEHeaders`](../interfaces/SIWEHeaders.md) | Additional headers for signing and authentication. | + +#### Returns + +`Promise`<[`SubnameRejectResponse`](../interfaces/SubnameRejectResponse.md)\> + +The result of the revoke operation. + +#### Defined in + +[lib/features/subnames/index.ts:174](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L174) ___ @@ -343,7 +367,7 @@ The result of the reservation operation. #### Defined in -[lib/features/subnames/index.ts:89](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L89) +[lib/features/subnames/index.ts:88](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L88) ___ @@ -369,7 +393,7 @@ The result of the revoke operation. #### Defined in -[lib/features/subnames/index.ts:159](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L159) +[lib/features/subnames/index.ts:156](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L156) ___ @@ -389,7 +413,7 @@ ___ #### Defined in -[lib/features/subnames/index.ts:214](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L214) +[lib/features/subnames/index.ts:226](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L226) ___ @@ -415,4 +439,4 @@ The result of the update operation. #### Defined in -[lib/features/subnames/index.ts:140](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L140) +[lib/features/subnames/index.ts:139](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/features/subnames/index.ts#L139) diff --git a/docs/docs/sdk/core/interfaces/Address.md b/docs/docs/sdk/core/interfaces/Address.md index df957b54..9cce0be2 100644 --- a/docs/docs/sdk/core/interfaces/Address.md +++ b/docs/docs/sdk/core/interfaces/Address.md @@ -20,7 +20,7 @@ The cryptocurrency address. #### Defined in -[lib/types/subnames/accept.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L13) +[lib/types/subnames/accept.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L13) ___ @@ -32,4 +32,4 @@ The coin type number, typically following the BIP-0044 standard. #### Defined in -[lib/types/subnames/accept.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L15) +[lib/types/subnames/accept.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L15) diff --git a/docs/docs/sdk/core/interfaces/AddressResponse.md b/docs/docs/sdk/core/interfaces/AddressResponse.md index b830bc16..6614f78d 100644 --- a/docs/docs/sdk/core/interfaces/AddressResponse.md +++ b/docs/docs/sdk/core/interfaces/AddressResponse.md @@ -21,7 +21,7 @@ The actual cryptocurrency address. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L19) +[lib/types/subnames/get-by-domain-name-chainId.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L19) ___ @@ -33,7 +33,7 @@ The cryptocurrency coin type number, typically following a standard like BIP-44. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L17) +[lib/types/subnames/get-by-domain-name-chainId.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L17) ___ @@ -45,7 +45,7 @@ A reference to the metadata associated with this address. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L21) +[lib/types/subnames/get-by-domain-name-chainId.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L21) ___ @@ -57,4 +57,4 @@ The unique identifier of the address record. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L15) +[lib/types/subnames/get-by-domain-name-chainId.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L15) diff --git a/docs/docs/sdk/core/interfaces/ApiKeyHeaders.md b/docs/docs/sdk/core/interfaces/ApiKeyHeaders.md index cb02c999..cf716ce6 100644 --- a/docs/docs/sdk/core/interfaces/ApiKeyHeaders.md +++ b/docs/docs/sdk/core/interfaces/ApiKeyHeaders.md @@ -23,4 +23,4 @@ The API key provided to the client. This key should be included in API #### Defined in -[lib/types/headers/index.ts:30](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L30) +[lib/types/headers/index.ts:30](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L30) diff --git a/docs/docs/sdk/core/interfaces/ApiKeyResponse.md b/docs/docs/sdk/core/interfaces/ApiKeyResponse.md index 1c1f2879..46f7e566 100644 --- a/docs/docs/sdk/core/interfaces/ApiKeyResponse.md +++ b/docs/docs/sdk/core/interfaces/ApiKeyResponse.md @@ -27,7 +27,7 @@ The identifier of the user who created this API key. #### Defined in -[lib/types/api-key/health-check.ts:25](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L25) +[lib/types/api-key/health-check.ts:25](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L25) ___ @@ -39,7 +39,7 @@ The unique identifier of the API key. #### Defined in -[lib/types/api-key/health-check.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L17) +[lib/types/api-key/health-check.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L17) ___ @@ -51,7 +51,7 @@ The actual API key string used for authentication and authorization. #### Defined in -[lib/types/api-key/health-check.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L21) +[lib/types/api-key/health-check.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L21) ___ @@ -63,7 +63,7 @@ The name given to the API key, typically used for easy identification. #### Defined in -[lib/types/api-key/health-check.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L19) +[lib/types/api-key/health-check.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L19) ___ @@ -75,4 +75,4 @@ The identifier of the workspace to which this API key belongs. #### Defined in -[lib/types/api-key/health-check.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L23) +[lib/types/api-key/health-check.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L23) diff --git a/docs/docs/sdk/core/interfaces/ApiKeyRoute.md b/docs/docs/sdk/core/interfaces/ApiKeyRoute.md index de2cef7b..2e6c046b 100644 --- a/docs/docs/sdk/core/interfaces/ApiKeyRoute.md +++ b/docs/docs/sdk/core/interfaces/ApiKeyRoute.md @@ -33,7 +33,7 @@ The required headers for API key operations, specified by the #### Defined in -[lib/types/api-key/health-check.ts:45](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L45) +[lib/types/api-key/health-check.ts:45](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L45) ___ @@ -50,7 +50,7 @@ The type of the request data. It is intentionally broad #### Defined in -[lib/types/api-key/health-check.ts:43](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L43) +[lib/types/api-key/health-check.ts:43](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L43) ___ @@ -67,4 +67,4 @@ The expected response structure for the API key operations, #### Defined in -[lib/types/api-key/health-check.ts:44](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L44) +[lib/types/api-key/health-check.ts:44](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L44) diff --git a/docs/docs/sdk/core/interfaces/BaseResponse.md b/docs/docs/sdk/core/interfaces/BaseResponse.md index a5f13f59..7e5b47a1 100644 --- a/docs/docs/sdk/core/interfaces/BaseResponse.md +++ b/docs/docs/sdk/core/interfaces/BaseResponse.md @@ -33,7 +33,7 @@ T - The type of the data to be returned. #### Defined in -[lib/types/base-response/index.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/base-response/index.ts#L14) +[lib/types/base-response/index.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/base-response/index.ts#L14) ___ @@ -43,4 +43,4 @@ ___ #### Defined in -[lib/types/base-response/index.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/base-response/index.ts#L13) +[lib/types/base-response/index.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/base-response/index.ts#L13) diff --git a/docs/docs/sdk/core/interfaces/Coin.md b/docs/docs/sdk/core/interfaces/Coin.md index 2731ffb3..08df01ff 100644 --- a/docs/docs/sdk/core/interfaces/Coin.md +++ b/docs/docs/sdk/core/interfaces/Coin.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -lib/types/subnames/records.ts:10 +[lib/types/subnames/records.ts:10](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L10) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -lib/types/subnames/records.ts:11 +[lib/types/subnames/records.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L11) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -lib/types/subnames/records.ts:12 +[lib/types/subnames/records.ts:12](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L12) diff --git a/docs/docs/sdk/core/interfaces/CoinType.md b/docs/docs/sdk/core/interfaces/CoinType.md new file mode 100644 index 00000000..9b1f041c --- /dev/null +++ b/docs/docs/sdk/core/interfaces/CoinType.md @@ -0,0 +1,47 @@ +--- +id: "CoinType" +title: "Interface: CoinType" +sidebar_label: "CoinType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### coin + +• **coin**: `string` + +#### Defined in + +[lib/utils/cointypes/index.ts:2](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L2) + +___ + +### coinType + +• **coinType**: `string` + +#### Defined in + +[lib/utils/cointypes/index.ts:4](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L4) + +___ + +### color + +• **color**: `string` + +#### Defined in + +[lib/utils/cointypes/index.ts:5](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L5) + +___ + +### symbol + +• **symbol**: `string` + +#### Defined in + +[lib/utils/cointypes/index.ts:3](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L3) diff --git a/docs/docs/sdk/core/interfaces/CoinTypeMap.md b/docs/docs/sdk/core/interfaces/CoinTypeMap.md new file mode 100644 index 00000000..5f235151 --- /dev/null +++ b/docs/docs/sdk/core/interfaces/CoinTypeMap.md @@ -0,0 +1,11 @@ +--- +id: "CoinTypeMap" +title: "Interface: CoinTypeMap" +sidebar_label: "CoinTypeMap" +sidebar_position: 0 +custom_edit_url: null +--- + +## Indexable + +▪ [key: `string`]: [`CoinType`](CoinType.md) diff --git a/docs/docs/sdk/core/interfaces/Configuration.md b/docs/docs/sdk/core/interfaces/Configuration.md index 1651e7b2..2fcd315a 100644 --- a/docs/docs/sdk/core/interfaces/Configuration.md +++ b/docs/docs/sdk/core/interfaces/Configuration.md @@ -25,4 +25,4 @@ An optional API key used for authenticating requests #### Defined in -[lib/types/justaname/configuration.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/justaname/configuration.ts#L13) +[lib/types/justaname/configuration.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/justaname/configuration.ts#L13) diff --git a/docs/docs/sdk/core/interfaces/ContentHash.md b/docs/docs/sdk/core/interfaces/ContentHash.md index b33eb9bd..b20a5269 100644 --- a/docs/docs/sdk/core/interfaces/ContentHash.md +++ b/docs/docs/sdk/core/interfaces/ContentHash.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -lib/types/subnames/records.ts:17 +[lib/types/subnames/records.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L17) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -lib/types/subnames/records.ts:16 +[lib/types/subnames/records.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L16) diff --git a/docs/docs/sdk/core/interfaces/Generals.md b/docs/docs/sdk/core/interfaces/Generals.md new file mode 100644 index 00000000..896eb3c9 --- /dev/null +++ b/docs/docs/sdk/core/interfaces/Generals.md @@ -0,0 +1,27 @@ +--- +id: "Generals" +title: "Interface: Generals" +sidebar_label: "Generals" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### identifier + +• **identifier**: [`GeneralsIdentifier`](../modules.md#generalsidentifier) + +#### Defined in + +[lib/constants/general-fields/index.ts:8](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/general-fields/index.ts#L8) + +___ + +### name + +• **name**: [`GeneralsName`](../modules.md#generalsname) + +#### Defined in + +[lib/constants/general-fields/index.ts:7](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/general-fields/index.ts#L7) diff --git a/docs/docs/sdk/core/interfaces/IRequest.md b/docs/docs/sdk/core/interfaces/IRequest.md index b5c8b5aa..80a9b252 100644 --- a/docs/docs/sdk/core/interfaces/IRequest.md +++ b/docs/docs/sdk/core/interfaces/IRequest.md @@ -37,6 +37,8 @@ This interface can be extended to include common request properties shared acros ↳ [`SubnameRevokeRequest`](SubnameRevokeRequest.md) + ↳ [`SubnameRejectRequest`](SubnameRejectRequest.md) + ↳ [`SubnameSearchRequest`](SubnameSearchRequest.md) ↳ [`SubnameUpdateRequest`](SubnameUpdateRequest.md) diff --git a/docs/docs/sdk/core/interfaces/IResponse.md b/docs/docs/sdk/core/interfaces/IResponse.md index 82621902..0d8cd965 100644 --- a/docs/docs/sdk/core/interfaces/IResponse.md +++ b/docs/docs/sdk/core/interfaces/IResponse.md @@ -39,6 +39,8 @@ Extend this interface to define specific properties for different responses. ↳ [`SubnameRevokeResponse`](SubnameRevokeResponse.md) + ↳ [`SubnameRejectResponse`](SubnameRejectResponse.md) + ↳ [`SubnameSearchResponse`](SubnameSearchResponse.md) ↳ [`SubnameUpdateResponse`](SubnameUpdateResponse.md) diff --git a/docs/docs/sdk/core/interfaces/IRoute.md b/docs/docs/sdk/core/interfaces/IRoute.md index 721044a6..b4321f48 100644 --- a/docs/docs/sdk/core/interfaces/IRoute.md +++ b/docs/docs/sdk/core/interfaces/IRoute.md @@ -42,6 +42,8 @@ a specific API endpoint, ensuring type safety and consistency in request/respons ↳ [`SubnameRevokeRoute`](SubnameRevokeRoute.md) + ↳ [`SubnameRejectRoute`](SubnameRejectRoute.md) + ↳ [`SubnameSearchRoute`](SubnameSearchRoute.md) ↳ [`SubnameUpdateRoute`](SubnameUpdateRoute.md) @@ -60,7 +62,7 @@ The type of the headers for the request/response. #### Defined in -[lib/types/common/index.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L57) +[lib/types/common/index.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L57) ___ @@ -72,7 +74,7 @@ The type of the request data. #### Defined in -[lib/types/common/index.ts:55](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L55) +[lib/types/common/index.ts:55](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L55) ___ @@ -84,4 +86,4 @@ The type of the response data. #### Defined in -[lib/types/common/index.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L56) +[lib/types/common/index.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L56) diff --git a/docs/docs/sdk/core/interfaces/IsSubnameAvailableRequest.md b/docs/docs/sdk/core/interfaces/IsSubnameAvailableRequest.md index 9ea134e9..4bf5121b 100644 --- a/docs/docs/sdk/core/interfaces/IsSubnameAvailableRequest.md +++ b/docs/docs/sdk/core/interfaces/IsSubnameAvailableRequest.md @@ -28,7 +28,7 @@ The blockchain network identifier where the subname exists. #### Defined in -[lib/types/subnames/available.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L16) +[lib/types/subnames/available.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L16) ___ @@ -40,4 +40,4 @@ The subname to check for availability. #### Defined in -[lib/types/subnames/available.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L15) +[lib/types/subnames/available.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L15) diff --git a/docs/docs/sdk/core/interfaces/IsSubnameAvailableResponse.md b/docs/docs/sdk/core/interfaces/IsSubnameAvailableResponse.md index 5c6ed6a4..e5d8e35f 100644 --- a/docs/docs/sdk/core/interfaces/IsSubnameAvailableResponse.md +++ b/docs/docs/sdk/core/interfaces/IsSubnameAvailableResponse.md @@ -28,4 +28,4 @@ Indicates the availability of the subname. #### Defined in -[lib/types/subnames/available.ts:30](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L30) +[lib/types/subnames/available.ts:30](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L30) diff --git a/docs/docs/sdk/core/interfaces/IsSubnameAvailableRoute.md b/docs/docs/sdk/core/interfaces/IsSubnameAvailableRoute.md index a78fbeac..2c20dcfd 100644 --- a/docs/docs/sdk/core/interfaces/IsSubnameAvailableRoute.md +++ b/docs/docs/sdk/core/interfaces/IsSubnameAvailableRoute.md @@ -33,7 +33,7 @@ The headers required for the request, deliberately unspecified #### Defined in -[lib/types/subnames/available.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L50) +[lib/types/subnames/available.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L50) ___ @@ -49,7 +49,7 @@ The request structure for the subname availability check. #### Defined in -[lib/types/subnames/available.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L48) +[lib/types/subnames/available.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L48) ___ @@ -65,4 +65,4 @@ The response indicating the availability of the subname. #### Defined in -[lib/types/subnames/available.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L49) +[lib/types/subnames/available.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/available.ts#L49) diff --git a/docs/docs/sdk/core/interfaces/Metadata.md b/docs/docs/sdk/core/interfaces/Metadata.md index b789949c..a12d4eb4 100644 --- a/docs/docs/sdk/core/interfaces/Metadata.md +++ b/docs/docs/sdk/core/interfaces/Metadata.md @@ -21,7 +21,7 @@ An array of addresses associated with the subname. #### Defined in -[lib/types/subnames/accept.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L49) +[lib/types/subnames/accept.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L49) ___ @@ -33,7 +33,7 @@ A hash of the content associated with the subname. #### Defined in -[lib/types/subnames/accept.ts:47](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L47) +[lib/types/subnames/accept.ts:47](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L47) ___ @@ -45,7 +45,7 @@ The unique identifier of the subname metadata. #### Defined in -[lib/types/subnames/accept.ts:45](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L45) +[lib/types/subnames/accept.ts:45](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L45) ___ @@ -57,7 +57,7 @@ The identifier of the parent domain. #### Defined in -[lib/types/subnames/accept.ts:53](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L53) +[lib/types/subnames/accept.ts:53](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L53) ___ @@ -69,4 +69,4 @@ An array of text records associated with the subname. #### Defined in -[lib/types/subnames/accept.ts:51](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L51) +[lib/types/subnames/accept.ts:51](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L51) diff --git a/docs/docs/sdk/core/interfaces/MetadataResponse.md b/docs/docs/sdk/core/interfaces/MetadataResponse.md index 7ec469ac..9814311e 100644 --- a/docs/docs/sdk/core/interfaces/MetadataResponse.md +++ b/docs/docs/sdk/core/interfaces/MetadataResponse.md @@ -21,7 +21,7 @@ A list of cryptocurrency addresses associated with the subname. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:64](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L64) +[lib/types/subnames/get-by-domain-name-chainId.ts:64](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L64) ___ @@ -33,7 +33,7 @@ A content hash associated with the subname, representing stored or linked conten #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:60](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L60) +[lib/types/subnames/get-by-domain-name-chainId.ts:60](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L60) ___ @@ -45,7 +45,7 @@ The unique identifier of the subname's metadata. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:58](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L58) +[lib/types/subnames/get-by-domain-name-chainId.ts:58](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L58) ___ @@ -57,7 +57,7 @@ The identifier of the subdomain to which this metadata belongs. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:62](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L62) +[lib/types/subnames/get-by-domain-name-chainId.ts:62](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L62) ___ @@ -69,4 +69,4 @@ A list of text records providing additional information about the subname. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:66](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L66) +[lib/types/subnames/get-by-domain-name-chainId.ts:66](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L66) diff --git a/docs/docs/sdk/core/interfaces/ROUTES.md b/docs/docs/sdk/core/interfaces/ROUTES.md index 78b40635..86f7e88d 100644 --- a/docs/docs/sdk/core/interfaces/ROUTES.md +++ b/docs/docs/sdk/core/interfaces/ROUTES.md @@ -24,7 +24,7 @@ IROUTES.ACCEPT\_SUBNAME\_ROUTE #### Defined in -[lib/api/routes/index.ts:68](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L68) +[lib/api/routes/index.ts:71](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L71) ___ @@ -38,7 +38,7 @@ IROUTES.ADD\_SUBNAME\_ROUTE #### Defined in -[lib/api/routes/index.ts:70](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L70) +[lib/api/routes/index.ts:73](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L73) ___ @@ -52,7 +52,7 @@ IROUTES.CHECK\_SUBNAME\_AVAILABILITY\_ROUTE #### Defined in -[lib/api/routes/index.ts:78](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L78) +[lib/api/routes/index.ts:82](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L82) ___ @@ -66,7 +66,7 @@ IROUTES.GET\_ALL\_SUBNAMES\_BY\_ADDRESS\_ROUTE #### Defined in -[lib/api/routes/index.ts:76](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L76) +[lib/api/routes/index.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L80) ___ @@ -80,7 +80,7 @@ IROUTES.GET\_ALL\_SUBNAMES\_BY\_DOMAIN\_ROUTE #### Defined in -[lib/api/routes/index.ts:75](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L75) +[lib/api/routes/index.ts:79](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L79) ___ @@ -94,7 +94,7 @@ IROUTES.GET\_ALL\_SUBNAMES\_BY\_INVITATION\_ROUTE #### Defined in -[lib/api/routes/index.ts:77](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L77) +[lib/api/routes/index.ts:81](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L81) ___ @@ -108,7 +108,7 @@ IROUTES.GET\_SUBNAME\_BY\_DOMAIN\_NAME\_CHAIN\_ID\_ROUTE #### Defined in -[lib/api/routes/index.ts:73](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L73) +[lib/api/routes/index.ts:77](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L77) ___ @@ -122,7 +122,7 @@ IROUTES.GET\_SUBNAME\_BY\_SUBNAME\_ROUTE #### Defined in -[lib/api/routes/index.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L74) +[lib/api/routes/index.ts:78](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L78) ___ @@ -136,7 +136,7 @@ IROUTES.HEALTH\_CHECK\_ROUTE #### Defined in -[lib/api/routes/index.ts:65](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L65) +[lib/api/routes/index.ts:68](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L68) ___ @@ -150,7 +150,21 @@ IROUTES.RECORDS\_BY\_FULLNAME\_ROUTE #### Defined in -[lib/api/routes/index.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L80) +[lib/api/routes/index.ts:84](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L84) + +___ + +### REJECT\_SUBNAME\_ROUTE + +• **REJECT\_SUBNAME\_ROUTE**: [`SubnameRejectRoute`](SubnameRejectRoute.md) + +#### Overrides + +IROUTES.REJECT\_SUBNAME\_ROUTE + +#### Defined in + +[lib/api/routes/index.ts:75](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L75) ___ @@ -164,7 +178,7 @@ IROUTES.RESERVE\_SUBNAME\_ROUTE #### Defined in -[lib/api/routes/index.ts:69](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L69) +[lib/api/routes/index.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L72) ___ @@ -178,7 +192,7 @@ IROUTES.REVOKE\_SUBNAME\_ROUTE #### Defined in -[lib/api/routes/index.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L72) +[lib/api/routes/index.ts:76](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L76) ___ @@ -192,7 +206,7 @@ IROUTES.SEARCH\_SUBNAMES\_ROUTE #### Defined in -[lib/api/routes/index.ts:79](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L79) +[lib/api/routes/index.ts:83](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L83) ___ @@ -206,7 +220,7 @@ IROUTES.SIWE\_REQUEST\_CHALLENGE\_ROUTE #### Defined in -[lib/api/routes/index.ts:67](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L67) +[lib/api/routes/index.ts:70](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L70) ___ @@ -220,7 +234,7 @@ IROUTES.SIWE\_VERIFY\_MESSAGE\_ROUTE #### Defined in -[lib/api/routes/index.ts:66](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L66) +[lib/api/routes/index.ts:69](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L69) ___ @@ -234,4 +248,4 @@ IROUTES.UPDATE\_SUBNAME\_ROUTE #### Defined in -[lib/api/routes/index.ts:71](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L71) +[lib/api/routes/index.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L74) diff --git a/docs/docs/sdk/core/interfaces/RequestChallengeRequest.md b/docs/docs/sdk/core/interfaces/RequestChallengeRequest.md index 29ec9b77..d3625917 100644 --- a/docs/docs/sdk/core/interfaces/RequestChallengeRequest.md +++ b/docs/docs/sdk/core/interfaces/RequestChallengeRequest.md @@ -25,7 +25,7 @@ Represents the ethereum address to be challenged. #### Defined in -[lib/types/siwe/request-challenge.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L21) +[lib/types/siwe/request-challenge.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L21) ___ @@ -37,7 +37,7 @@ Represents the chainId of the blockchain to be used. #### Defined in -[lib/types/siwe/request-challenge.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L31) +[lib/types/siwe/request-challenge.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L31) ___ @@ -49,7 +49,7 @@ Represents the ENS domain #### Defined in -[lib/types/siwe/request-challenge.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L14) +[lib/types/siwe/request-challenge.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L14) ___ @@ -61,7 +61,7 @@ Represents the origin of the request (e.g. the domain of the website). #### Defined in -[lib/types/siwe/request-challenge.ts:26](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L26) +[lib/types/siwe/request-challenge.ts:26](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L26) ___ @@ -82,4 +82,4 @@ default: 120000 ms, 2 minutes ( 2 * 60 * 1000 ) #### Defined in -[lib/types/siwe/request-challenge.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L39) +[lib/types/siwe/request-challenge.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L39) diff --git a/docs/docs/sdk/core/interfaces/RequestChallengeResponse.md b/docs/docs/sdk/core/interfaces/RequestChallengeResponse.md index db012e1f..3899c9ee 100644 --- a/docs/docs/sdk/core/interfaces/RequestChallengeResponse.md +++ b/docs/docs/sdk/core/interfaces/RequestChallengeResponse.md @@ -25,4 +25,4 @@ Represents the challenge to be signed by the user. #### Defined in -[lib/types/siwe/request-challenge.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L52) +[lib/types/siwe/request-challenge.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L52) diff --git a/docs/docs/sdk/core/interfaces/SIWEHeaders.md b/docs/docs/sdk/core/interfaces/SIWEHeaders.md index df40726d..69c5a6b8 100644 --- a/docs/docs/sdk/core/interfaces/SIWEHeaders.md +++ b/docs/docs/sdk/core/interfaces/SIWEHeaders.md @@ -23,7 +23,7 @@ The Ethereum address of the user. This address is expected to match the #### Defined in -[lib/types/headers/index.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L17) +[lib/types/headers/index.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L17) ___ @@ -36,7 +36,7 @@ The original message that was signed by the user. This message typically #### Defined in -[lib/types/headers/index.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L15) +[lib/types/headers/index.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L15) ___ @@ -49,4 +49,4 @@ The digital signature produced by signing `xMessage` with the user's #### Defined in -[lib/types/headers/index.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L16) +[lib/types/headers/index.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L16) diff --git a/docs/docs/sdk/core/interfaces/SIWERequestChallengeRoute.md b/docs/docs/sdk/core/interfaces/SIWERequestChallengeRoute.md index 8931e735..31f70058 100644 --- a/docs/docs/sdk/core/interfaces/SIWERequestChallengeRoute.md +++ b/docs/docs/sdk/core/interfaces/SIWERequestChallengeRoute.md @@ -34,7 +34,7 @@ The headers required for the request, left intentionally #### Defined in -[lib/types/siwe/request-challenge.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L72) +[lib/types/siwe/request-challenge.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L72) ___ @@ -50,7 +50,7 @@ The request structure for the SIWE challenge. #### Defined in -[lib/types/siwe/request-challenge.ts:70](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L70) +[lib/types/siwe/request-challenge.ts:70](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L70) ___ @@ -66,4 +66,4 @@ The expected response structure. #### Defined in -[lib/types/siwe/request-challenge.ts:71](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L71) +[lib/types/siwe/request-challenge.ts:71](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/request-challenge.ts#L71) diff --git a/docs/docs/sdk/core/interfaces/SIWEVerifyMessageRoute.md b/docs/docs/sdk/core/interfaces/SIWEVerifyMessageRoute.md index c018123e..a5143387 100644 --- a/docs/docs/sdk/core/interfaces/SIWEVerifyMessageRoute.md +++ b/docs/docs/sdk/core/interfaces/SIWEVerifyMessageRoute.md @@ -31,7 +31,7 @@ The headers required for the request, left flexible for specific needs. #### Defined in -[lib/types/siwe/verify-challenge.ts:58](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L58) +[lib/types/siwe/verify-challenge.ts:58](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L58) ___ @@ -47,7 +47,7 @@ The structure required for the verification request. #### Defined in -[lib/types/siwe/verify-challenge.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L56) +[lib/types/siwe/verify-challenge.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L56) ___ @@ -63,4 +63,4 @@ The expected response indicating verification result. #### Defined in -[lib/types/siwe/verify-challenge.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L57) +[lib/types/siwe/verify-challenge.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L57) diff --git a/docs/docs/sdk/core/interfaces/SanitizedRecords.md b/docs/docs/sdk/core/interfaces/SanitizedRecords.md new file mode 100644 index 00000000..6a556a9a --- /dev/null +++ b/docs/docs/sdk/core/interfaces/SanitizedRecords.md @@ -0,0 +1,157 @@ +--- +id: "SanitizedRecords" +title: "Interface: SanitizedRecords" +sidebar_label: "SanitizedRecords" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### allAddresses + +• **allAddresses**: [`CoinAndDetails`](../modules.md#coinanddetails)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L15) + +___ + +### allOtherTexts + +• **allOtherTexts**: [`Text`](Text.md)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:24](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L24) + +___ + +### avatar + +• `Optional` **avatar**: `string` + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L17) + +___ + +### banner + +• `Optional` **banner**: `string` + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:18](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L18) + +___ + +### contentHash + +• **contentHash**: ``null`` \| [`ContentHash`](ContentHash.md) + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:26](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L26) + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L21) + +___ + +### display + +• `Optional` **display**: `string` + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L19) + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:20](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L20) + +___ + +### ethAddress + +• **ethAddress**: [`CoinAndDetails`](../modules.md#coinanddetails) + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L13) + +___ + +### generals + +• **generals**: [`Text`](Text.md)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:12](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L12) + +___ + +### location + +• `Optional` **location**: `string` + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L23) + +___ + +### otherAddresses + +• **otherAddresses**: [`CoinAndDetails`](../modules.md#coinanddetails)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L14) + +___ + +### otherTextsWithoutStandard + +• **otherTextsWithoutStandard**: [`Text`](Text.md)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:25](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L25) + +___ + +### socials + +• **socials**: [`SocialDetails`](../modules.md#socialdetails)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L16) + +___ + +### url + +• `Optional` **url**: `string` + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:22](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L22) diff --git a/docs/docs/sdk/core/interfaces/Socials.md b/docs/docs/sdk/core/interfaces/Socials.md new file mode 100644 index 00000000..0d0e88da --- /dev/null +++ b/docs/docs/sdk/core/interfaces/Socials.md @@ -0,0 +1,51 @@ +--- +id: "Socials" +title: "Interface: Socials" +sidebar_label: "Socials" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### identifier + +• **identifier**: [`SocialsIdentifier`](../modules.md#socialsidentifier) + +#### Defined in + +[lib/constants/supported-socials/index.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/supported-socials/index.ts#L16) + +___ + +### link + +• **link**: (`handle`: `string`) => `string` + +#### Type declaration + +▸ (`handle`): `string` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `handle` | `string` | + +##### Returns + +`string` + +#### Defined in + +[lib/constants/supported-socials/index.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/supported-socials/index.ts#L17) + +___ + +### name + +• **name**: [`SocialsName`](../modules.md#socialsname) + +#### Defined in + +[lib/constants/supported-socials/index.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/supported-socials/index.ts#L15) diff --git a/docs/docs/sdk/core/interfaces/SubnameAcceptRequest.md b/docs/docs/sdk/core/interfaces/SubnameAcceptRequest.md index f0224fc4..ccaada3f 100644 --- a/docs/docs/sdk/core/interfaces/SubnameAcceptRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameAcceptRequest.md @@ -26,7 +26,7 @@ Optional. Addresses to associate with the subname. #### Defined in -[lib/types/subnames/accept.ts:76](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L76) +[lib/types/subnames/accept.ts:76](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L76) ___ @@ -38,7 +38,7 @@ The blockchain network identifier for the claim. #### Defined in -[lib/types/subnames/accept.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L74) +[lib/types/subnames/accept.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L74) ___ @@ -50,7 +50,7 @@ Optional. A content hash to associate with the subname. #### Defined in -[lib/types/subnames/accept.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L80) +[lib/types/subnames/accept.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L80) ___ @@ -62,7 +62,7 @@ The parent ENS domain under which the subname is claimed. #### Defined in -[lib/types/subnames/accept.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L72) +[lib/types/subnames/accept.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L72) ___ @@ -74,7 +74,7 @@ Optional. Text records to associate with the subname. #### Defined in -[lib/types/subnames/accept.ts:78](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L78) +[lib/types/subnames/accept.ts:78](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L78) ___ @@ -86,4 +86,4 @@ The desired subname to claim. #### Defined in -[lib/types/subnames/accept.ts:70](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L70) +[lib/types/subnames/accept.ts:70](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L70) diff --git a/docs/docs/sdk/core/interfaces/SubnameAcceptResponse.md b/docs/docs/sdk/core/interfaces/SubnameAcceptResponse.md index 42d2597c..3d3ca8d0 100644 --- a/docs/docs/sdk/core/interfaces/SubnameAcceptResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameAcceptResponse.md @@ -26,7 +26,7 @@ The metadata associated with the claimed subname. #### Defined in -[lib/types/subnames/accept.ts:95](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L95) +[lib/types/subnames/accept.ts:95](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L95) ___ @@ -38,4 +38,4 @@ The unique identifier of the claimed subname. #### Defined in -[lib/types/subnames/accept.ts:93](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L93) +[lib/types/subnames/accept.ts:93](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L93) diff --git a/docs/docs/sdk/core/interfaces/SubnameAcceptRoute.md b/docs/docs/sdk/core/interfaces/SubnameAcceptRoute.md index 0f02d109..f1b58852 100644 --- a/docs/docs/sdk/core/interfaces/SubnameAcceptRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameAcceptRoute.md @@ -20,9 +20,9 @@ Configures the route for accepting a subname invitation. ### headers -• **headers**: [`ApiKeyHeaders`](ApiKeyHeaders.md) & [`SIWEHeaders`](SIWEHeaders.md) +• **headers**: [`SIWEHeaders`](SIWEHeaders.md) -Combined API key and SIWE authentication headers required for the request. +SIWE authentication headers required for the request. #### Overrides @@ -30,7 +30,7 @@ Combined API key and SIWE authentication headers required for the request. #### Defined in -[lib/types/subnames/accept.ts:112](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L112) +[lib/types/subnames/accept.ts:111](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L111) ___ @@ -46,7 +46,7 @@ The data structure for the claim request. #### Defined in -[lib/types/subnames/accept.ts:110](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L110) +[lib/types/subnames/accept.ts:109](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L109) ___ @@ -62,4 +62,4 @@ The expected structure for the claim response. #### Defined in -[lib/types/subnames/accept.ts:111](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L111) +[lib/types/subnames/accept.ts:110](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L110) diff --git a/docs/docs/sdk/core/interfaces/SubnameAddRequest.md b/docs/docs/sdk/core/interfaces/SubnameAddRequest.md index dddf8f86..cc6a21f3 100644 --- a/docs/docs/sdk/core/interfaces/SubnameAddRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameAddRequest.md @@ -27,7 +27,7 @@ Optional. Ethereum addresses associated with the subname. #### Defined in -[lib/types/subnames/add.ts:54](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L54) +[lib/types/subnames/add.ts:54](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L54) ___ @@ -39,7 +39,7 @@ The chain ID of the Ethereum blockchain where the operation takes place. #### Defined in -[lib/types/subnames/add.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L52) +[lib/types/subnames/add.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L52) ___ @@ -51,7 +51,7 @@ Optional. A content hash representing associated data. #### Defined in -[lib/types/subnames/add.ts:58](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L58) +[lib/types/subnames/add.ts:58](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L58) ___ @@ -63,7 +63,7 @@ The ENS domain under which the subname is added. #### Defined in -[lib/types/subnames/add.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L50) +[lib/types/subnames/add.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L50) ___ @@ -75,7 +75,7 @@ Optional. Text records for additional data associated with the subname. #### Defined in -[lib/types/subnames/add.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L56) +[lib/types/subnames/add.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L56) ___ @@ -87,4 +87,4 @@ The subname to be added. #### Defined in -[lib/types/subnames/add.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L48) +[lib/types/subnames/add.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L48) diff --git a/docs/docs/sdk/core/interfaces/SubnameAddResponse.md b/docs/docs/sdk/core/interfaces/SubnameAddResponse.md index 63d818e5..474bd184 100644 --- a/docs/docs/sdk/core/interfaces/SubnameAddResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameAddResponse.md @@ -26,4 +26,4 @@ The unique identifier of the added subname. #### Defined in -[lib/types/subnames/add.ts:69](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L69) +[lib/types/subnames/add.ts:69](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L69) diff --git a/docs/docs/sdk/core/interfaces/SubnameAddRoute.md b/docs/docs/sdk/core/interfaces/SubnameAddRoute.md index 8d83de04..ba5faffd 100644 --- a/docs/docs/sdk/core/interfaces/SubnameAddRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameAddRoute.md @@ -33,7 +33,7 @@ The combined set of headers required for authentication and verification. #### Defined in -[lib/types/subnames/add.ts:87](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L87) +[lib/types/subnames/add.ts:87](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L87) ___ @@ -49,7 +49,7 @@ The required structure for the subname addition request. #### Defined in -[lib/types/subnames/add.ts:85](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L85) +[lib/types/subnames/add.ts:85](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L85) ___ @@ -65,4 +65,4 @@ The expected response upon successful operation. #### Defined in -[lib/types/subnames/add.ts:86](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L86) +[lib/types/subnames/add.ts:86](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/add.ts#L86) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRequest.md b/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRequest.md index 11560928..1e699c22 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRequest.md @@ -26,7 +26,7 @@ The cryptocurrency address to search for associated subnames. #### Defined in -[lib/types/subnames/get-all-by-address.ts:78](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L78) +[lib/types/subnames/get-all-by-address.ts:78](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L78) ___ @@ -38,7 +38,7 @@ The blockchain network identifier. #### Defined in -[lib/types/subnames/get-all-by-address.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L80) +[lib/types/subnames/get-all-by-address.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L80) ___ @@ -50,7 +50,7 @@ Coin type number for the cryptocurrency of the address. #### Defined in -[lib/types/subnames/get-all-by-address.ts:82](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L82) +[lib/types/subnames/get-all-by-address.ts:82](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L82) ___ @@ -62,4 +62,4 @@ Flag indicating whether to retrieve only claimed subnames. #### Defined in -[lib/types/subnames/get-all-by-address.ts:84](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L84) +[lib/types/subnames/get-all-by-address.ts:84](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L84) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressResponse.md b/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressResponse.md index df6842b6..473acb38 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressResponse.md @@ -26,7 +26,7 @@ The timestamp when the subname was claimed, if applicable. #### Defined in -[lib/types/subnames/get-all-by-address.ts:112](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L112) +[lib/types/subnames/get-all-by-address.ts:112](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L112) ___ @@ -38,7 +38,7 @@ Metadata associated with the subname. #### Defined in -[lib/types/subnames/get-all-by-address.ts:114](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L114) +[lib/types/subnames/get-all-by-address.ts:114](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L114) ___ @@ -50,7 +50,7 @@ Identifier of the parent ENS domain. #### Defined in -[lib/types/subnames/get-all-by-address.ts:106](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L106) +[lib/types/subnames/get-all-by-address.ts:106](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L106) ___ @@ -62,7 +62,7 @@ Unique identifier of the subname. #### Defined in -[lib/types/subnames/get-all-by-address.ts:102](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L102) +[lib/types/subnames/get-all-by-address.ts:102](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L102) ___ @@ -74,7 +74,7 @@ Indicates if the subname has been claimed. #### Defined in -[lib/types/subnames/get-all-by-address.ts:110](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L110) +[lib/types/subnames/get-all-by-address.ts:110](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L110) ___ @@ -86,7 +86,7 @@ The full subname. #### Defined in -[lib/types/subnames/get-all-by-address.ts:108](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L108) +[lib/types/subnames/get-all-by-address.ts:108](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L108) ___ @@ -98,4 +98,4 @@ The username part of the subname. #### Defined in -[lib/types/subnames/get-all-by-address.ts:104](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L104) +[lib/types/subnames/get-all-by-address.ts:104](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L104) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRoute.md b/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRoute.md index 6ba91765..e03855d6 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetAllByAddressRoute.md @@ -30,7 +30,7 @@ The headers required for the request. The type is intentionally kept generic to #### Defined in -[lib/types/subnames/get-all-by-address.ts:130](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L130) +[lib/types/subnames/get-all-by-address.ts:130](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L130) ___ @@ -46,7 +46,7 @@ The request data structure. #### Defined in -[lib/types/subnames/get-all-by-address.ts:128](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L128) +[lib/types/subnames/get-all-by-address.ts:128](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L128) ___ @@ -62,4 +62,4 @@ An array of responses, each containing details of a subname associated with the #### Defined in -[lib/types/subnames/get-all-by-address.ts:129](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L129) +[lib/types/subnames/get-all-by-address.ts:129](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-address.ts#L129) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRequest.md b/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRequest.md index 09a00a01..dd1fb16a 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRequest.md @@ -27,7 +27,7 @@ The blockchain network identifier. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:150](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L150) +[lib/types/subnames/get-all-by-ens-domain.ts:150](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L150) ___ @@ -39,7 +39,7 @@ Optional coin type to filter the subnames by. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:152](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L152) +[lib/types/subnames/get-all-by-ens-domain.ts:152](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L152) ___ @@ -51,7 +51,7 @@ The ENS domain to search under. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:148](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L148) +[lib/types/subnames/get-all-by-ens-domain.ts:148](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L148) ___ @@ -63,7 +63,7 @@ Optional flag to filter by claimed status. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:158](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L158) +[lib/types/subnames/get-all-by-ens-domain.ts:158](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L158) ___ @@ -75,7 +75,7 @@ Optional limit on the number of items per page. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:156](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L156) +[lib/types/subnames/get-all-by-ens-domain.ts:156](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L156) ___ @@ -87,4 +87,4 @@ Optional page number for pagination. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:154](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L154) +[lib/types/subnames/get-all-by-ens-domain.ts:154](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L154) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdResponse.md b/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdResponse.md index d2f07272..f3a8c435 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdResponse.md @@ -27,7 +27,7 @@ Pagination information for navigating through the subnames. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:175](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L175) +[lib/types/subnames/get-all-by-ens-domain.ts:175](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L175) ___ @@ -39,4 +39,4 @@ An array of subname details. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:173](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L173) +[lib/types/subnames/get-all-by-ens-domain.ts:173](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L173) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRoute.md b/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRoute.md index 37e2e9fd..38aacc0c 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetAllByDomainChainIdRoute.md @@ -31,7 +31,7 @@ The headers required for the request, left intentionally unspecified to accommod #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:192](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L192) +[lib/types/subnames/get-all-by-ens-domain.ts:192](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L192) ___ @@ -47,7 +47,7 @@ The request data structure. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:190](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L190) +[lib/types/subnames/get-all-by-ens-domain.ts:190](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L190) ___ @@ -63,4 +63,4 @@ The expected response structure. #### Defined in -[lib/types/subnames/get-all-by-ens-domain.ts:191](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L191) +[lib/types/subnames/get-all-by-ens-domain.ts:191](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-all-by-ens-domain.ts#L191) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRequest.md b/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRequest.md index 37f95340..4285ff3f 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRequest.md @@ -26,7 +26,7 @@ The blockchain network identifier where the domain and subname exist. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:84](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L84) +[lib/types/subnames/get-by-domain-name-chainId.ts:84](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L84) ___ @@ -38,7 +38,7 @@ The ENS domain within which the subname is registered. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L80) +[lib/types/subnames/get-by-domain-name-chainId.ts:80](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L80) ___ @@ -50,4 +50,4 @@ The specific username associated with the subname. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:82](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L82) +[lib/types/subnames/get-by-domain-name-chainId.ts:82](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L82) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdResponse.md b/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdResponse.md index d5f499ec..ab4ab107 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdResponse.md @@ -27,7 +27,7 @@ The timestamp when the subname was claimed, if applicable. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:113](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L113) +[lib/types/subnames/get-by-domain-name-chainId.ts:113](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L113) ___ @@ -39,7 +39,7 @@ Detailed metadata associated with the subname. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:115](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L115) +[lib/types/subnames/get-by-domain-name-chainId.ts:115](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L115) ___ @@ -51,7 +51,7 @@ The identifier of the ENS domain. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:107](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L107) +[lib/types/subnames/get-by-domain-name-chainId.ts:107](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L107) ___ @@ -63,7 +63,7 @@ The unique identifier of the subname. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:103](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L103) +[lib/types/subnames/get-by-domain-name-chainId.ts:103](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L103) ___ @@ -75,7 +75,7 @@ Indicates whether the subname has been claimed. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:111](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L111) +[lib/types/subnames/get-by-domain-name-chainId.ts:111](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L111) ___ @@ -87,7 +87,7 @@ The full subname, including the username and domain. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:109](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L109) +[lib/types/subnames/get-by-domain-name-chainId.ts:109](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L109) ___ @@ -99,4 +99,4 @@ The username associated with the subname. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:105](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L105) +[lib/types/subnames/get-by-domain-name-chainId.ts:105](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L105) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRoute.md b/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRoute.md index b40c4b99..945c1167 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetByDomainNameChainIdRoute.md @@ -30,7 +30,7 @@ Specifies any headers required for the request, left unspecified to accommodate #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:131](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L131) +[lib/types/subnames/get-by-domain-name-chainId.ts:131](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L131) ___ @@ -46,7 +46,7 @@ The expected format of the request data. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:129](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L129) +[lib/types/subnames/get-by-domain-name-chainId.ts:129](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L129) ___ @@ -62,4 +62,4 @@ The structure of the response data. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:130](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L130) +[lib/types/subnames/get-by-domain-name-chainId.ts:130](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L130) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRequest.md b/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRequest.md index 96788f36..3da9ca69 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRequest.md @@ -26,7 +26,7 @@ The blockchain network identifier. #### Defined in -[lib/types/subnames/get-by-subname.ts:79](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L79) +[lib/types/subnames/get-by-subname.ts:79](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L79) ___ @@ -38,4 +38,4 @@ The full subname to lookup. #### Defined in -[lib/types/subnames/get-by-subname.ts:77](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L77) +[lib/types/subnames/get-by-subname.ts:77](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L77) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetBySubnameResponse.md b/docs/docs/sdk/core/interfaces/SubnameGetBySubnameResponse.md index 38e4b673..8566ad09 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetBySubnameResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetBySubnameResponse.md @@ -26,7 +26,7 @@ The date and time when the subname was claimed, if applicable. #### Defined in -[lib/types/subnames/get-by-subname.ts:107](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L107) +[lib/types/subnames/get-by-subname.ts:107](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L107) ___ @@ -38,7 +38,7 @@ Detailed metadata about the subname. #### Defined in -[lib/types/subnames/get-by-subname.ts:109](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L109) +[lib/types/subnames/get-by-subname.ts:109](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L109) ___ @@ -50,7 +50,7 @@ The identifier of the ENS domain to which the subname belongs. #### Defined in -[lib/types/subnames/get-by-subname.ts:101](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L101) +[lib/types/subnames/get-by-subname.ts:101](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L101) ___ @@ -62,7 +62,7 @@ The unique identifier of the subname. #### Defined in -[lib/types/subnames/get-by-subname.ts:97](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L97) +[lib/types/subnames/get-by-subname.ts:97](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L97) ___ @@ -74,7 +74,7 @@ Indicates whether the subname has been claimed. #### Defined in -[lib/types/subnames/get-by-subname.ts:105](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L105) +[lib/types/subnames/get-by-subname.ts:105](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L105) ___ @@ -86,7 +86,7 @@ The full subname, including both the username and domain parts. #### Defined in -[lib/types/subnames/get-by-subname.ts:103](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L103) +[lib/types/subnames/get-by-subname.ts:103](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L103) ___ @@ -98,4 +98,4 @@ The username portion of the subname. #### Defined in -[lib/types/subnames/get-by-subname.ts:99](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L99) +[lib/types/subnames/get-by-subname.ts:99](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L99) diff --git a/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRoute.md b/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRoute.md index c8f08585..00211007 100644 --- a/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameGetBySubnameRoute.md @@ -31,7 +31,7 @@ Specifies any headers required for the request. The type is intentionally kept g #### Defined in -[lib/types/subnames/get-by-subname.ts:126](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L126) +[lib/types/subnames/get-by-subname.ts:126](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L126) ___ @@ -47,7 +47,7 @@ The structure of the request for retrieving a subname. #### Defined in -[lib/types/subnames/get-by-subname.ts:124](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L124) +[lib/types/subnames/get-by-subname.ts:124](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L124) ___ @@ -63,4 +63,4 @@ The format of the response containing the subname details. #### Defined in -[lib/types/subnames/get-by-subname.ts:125](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L125) +[lib/types/subnames/get-by-subname.ts:125](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-subname.ts#L125) diff --git a/docs/docs/sdk/core/interfaces/SubnameRecordsRequest.md b/docs/docs/sdk/core/interfaces/SubnameRecordsRequest.md index 3cf157ed..6d810c84 100644 --- a/docs/docs/sdk/core/interfaces/SubnameRecordsRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameRecordsRequest.md @@ -26,7 +26,7 @@ The chain identifier. #### Defined in -lib/types/subnames/records.ts:56 +[lib/types/subnames/records.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L56) ___ @@ -38,7 +38,7 @@ The full name of the subname. #### Defined in -lib/types/subnames/records.ts:55 +[lib/types/subnames/records.ts:55](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L55) ___ @@ -50,4 +50,4 @@ The URL of the provider. #### Defined in -lib/types/subnames/records.ts:57 +[lib/types/subnames/records.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L57) diff --git a/docs/docs/sdk/core/interfaces/SubnameRecordsResponse.md b/docs/docs/sdk/core/interfaces/SubnameRecordsResponse.md index 5bd2b12a..c6d1d932 100644 --- a/docs/docs/sdk/core/interfaces/SubnameRecordsResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameRecordsResponse.md @@ -26,7 +26,7 @@ The coin records associated with the subname. #### Defined in -lib/types/subnames/records.ts:37 +[lib/types/subnames/records.ts:37](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L37) ___ @@ -38,7 +38,7 @@ The content hash associated with the subname. #### Defined in -lib/types/subnames/records.ts:39 +[lib/types/subnames/records.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L39) ___ @@ -50,7 +50,7 @@ A boolean indicating whether the subname is a Japanese name. #### Defined in -lib/types/subnames/records.ts:41 +[lib/types/subnames/records.ts:41](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L41) ___ @@ -62,7 +62,7 @@ The address of the resolver. #### Defined in -lib/types/subnames/records.ts:33 +[lib/types/subnames/records.ts:33](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L33) ___ @@ -74,4 +74,4 @@ The text records associated with the subname. #### Defined in -lib/types/subnames/records.ts:35 +[lib/types/subnames/records.ts:35](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L35) diff --git a/docs/docs/sdk/core/interfaces/SubnameRecordsRoute.md b/docs/docs/sdk/core/interfaces/SubnameRecordsRoute.md index cbca97b2..52c4c628 100644 --- a/docs/docs/sdk/core/interfaces/SubnameRecordsRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameRecordsRoute.md @@ -30,7 +30,7 @@ The headers required for the request. The type is intentionally kept generic to #### Defined in -lib/types/subnames/records.ts:73 +[lib/types/subnames/records.ts:73](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L73) ___ @@ -46,7 +46,7 @@ The request data structure. #### Defined in -lib/types/subnames/records.ts:71 +[lib/types/subnames/records.ts:71](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L71) ___ @@ -62,4 +62,4 @@ The response data structure. #### Defined in -lib/types/subnames/records.ts:72 +[lib/types/subnames/records.ts:72](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L72) diff --git a/docs/docs/sdk/core/interfaces/SubnameRejectRequest.md b/docs/docs/sdk/core/interfaces/SubnameRejectRequest.md new file mode 100644 index 00000000..63a3f862 --- /dev/null +++ b/docs/docs/sdk/core/interfaces/SubnameRejectRequest.md @@ -0,0 +1,53 @@ +--- +id: "SubnameRejectRequest" +title: "Interface: SubnameRejectRequest" +sidebar_label: "SubnameRejectRequest" +sidebar_position: 0 +custom_edit_url: null +--- + +Defines the request structure for rejecting a subname under a specific ENS domain. + + SubnameRejectRequest + +## Hierarchy + +- [`IRequest`](IRequest.md) + + ↳ **`SubnameRejectRequest`** + +## Properties + +### chainId + +• **chainId**: `number` + +The blockchain network identifier, specifying the network of the ENS domain. + +#### Defined in + +[lib/types/subnames/reject.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reject.ts#L19) + +___ + +### ensDomain + +• **ensDomain**: `string` + +The parent ENS domain under which the subname is registered. + +#### Defined in + +[lib/types/subnames/reject.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reject.ts#L15) + +___ + +### username + +• **username**: `string` + +The subname to be rejected. + +#### Defined in + +[lib/types/subnames/reject.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reject.ts#L17) diff --git a/docs/docs/sdk/core/interfaces/SubnameRejectResponse.md b/docs/docs/sdk/core/interfaces/SubnameRejectResponse.md new file mode 100644 index 00000000..95e417b0 --- /dev/null +++ b/docs/docs/sdk/core/interfaces/SubnameRejectResponse.md @@ -0,0 +1,29 @@ +--- +id: "SubnameRejectResponse" +title: "Interface: SubnameRejectResponse" +sidebar_label: "SubnameRejectResponse" +sidebar_position: 0 +custom_edit_url: null +--- + +Represents the response received after successfully rejecting a subname. + + SubnameRejectResponse + +## Hierarchy + +- [`IResponse`](IResponse.md) + + ↳ **`SubnameRejectResponse`** + +## Properties + +### response + +• **response**: `string` + +A message or status indicating the outcome of the subname revocation. + +#### Defined in + +[lib/types/subnames/reject.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reject.ts#L31) diff --git a/docs/docs/sdk/core/interfaces/SubnameRejectRoute.md b/docs/docs/sdk/core/interfaces/SubnameRejectRoute.md new file mode 100644 index 00000000..e11b7568 --- /dev/null +++ b/docs/docs/sdk/core/interfaces/SubnameRejectRoute.md @@ -0,0 +1,66 @@ +--- +id: "SubnameRejectRoute" +title: "Interface: SubnameRejectRoute" +sidebar_label: "SubnameRejectRoute" +sidebar_position: 0 +custom_edit_url: null +--- + +Configures the route for rejecting a subname, detailing the required request format, the expected response, +and any necessary headers for authentication and authorization. + + SubnameRejectRoute + +## Hierarchy + +- [`IRoute`](IRoute.md) + + ↳ **`SubnameRejectRoute`** + +## Properties + +### headers + +• **headers**: [`SIWEHeaders`](SIWEHeaders.md) + +SIWE authentication headers required for the operation. + +#### Overrides + +[IRoute](IRoute.md).[headers](IRoute.md#headers) + +#### Defined in + +[lib/types/subnames/reject.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reject.ts#L48) + +___ + +### request + +• **request**: [`SubnameRejectRequest`](SubnameRejectRequest.md) + +The structure required for a subname revocation request. + +#### Overrides + +[IRoute](IRoute.md).[request](IRoute.md#request) + +#### Defined in + +[lib/types/subnames/reject.ts:46](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reject.ts#L46) + +___ + +### response + +• **response**: [`SubnameRejectResponse`](SubnameRejectResponse.md) + +The expected format of the response upon successful revocation. + +#### Overrides + +[IRoute](IRoute.md).[response](IRoute.md#response) + +#### Defined in + +[lib/types/subnames/reject.ts:47](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reject.ts#L47) diff --git a/docs/docs/sdk/core/interfaces/SubnameReserveRequest.md b/docs/docs/sdk/core/interfaces/SubnameReserveRequest.md index 91ba3401..a5f00a42 100644 --- a/docs/docs/sdk/core/interfaces/SubnameReserveRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameReserveRequest.md @@ -26,7 +26,7 @@ The blockchain network identifier, indicating which network the ENS domain resid #### Defined in -[lib/types/subnames/reserve.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L21) +[lib/types/subnames/reserve.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L21) ___ @@ -38,7 +38,7 @@ The parent ENS domain under which the subname will be reserved. #### Defined in -[lib/types/subnames/reserve.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L19) +[lib/types/subnames/reserve.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L19) ___ @@ -50,7 +50,7 @@ The Ethereum address associated with the reservation. This is usually the addres #### Defined in -[lib/types/subnames/reserve.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L23) +[lib/types/subnames/reserve.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L23) ___ @@ -62,4 +62,4 @@ The desired subname to reserve. #### Defined in -[lib/types/subnames/reserve.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L17) +[lib/types/subnames/reserve.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L17) diff --git a/docs/docs/sdk/core/interfaces/SubnameReserveResponse.md b/docs/docs/sdk/core/interfaces/SubnameReserveResponse.md index 953a523e..5e5c60d2 100644 --- a/docs/docs/sdk/core/interfaces/SubnameReserveResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameReserveResponse.md @@ -26,4 +26,4 @@ The unique identifier of the reserved subname. This ID can be used to claim the #### Defined in -[lib/types/subnames/reserve.ts:35](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L35) +[lib/types/subnames/reserve.ts:35](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L35) diff --git a/docs/docs/sdk/core/interfaces/SubnameReserveRoute.md b/docs/docs/sdk/core/interfaces/SubnameReserveRoute.md index c9c52edf..b3420eb3 100644 --- a/docs/docs/sdk/core/interfaces/SubnameReserveRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameReserveRoute.md @@ -30,7 +30,7 @@ Specifies the API key headers required for authentication to perform the reserva #### Defined in -[lib/types/subnames/reserve.ts:51](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L51) +[lib/types/subnames/reserve.ts:51](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L51) ___ @@ -46,7 +46,7 @@ The data structure required for a subname reservation request. #### Defined in -[lib/types/subnames/reserve.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L49) +[lib/types/subnames/reserve.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L49) ___ @@ -62,4 +62,4 @@ The expected format of the response upon a successful reservation. #### Defined in -[lib/types/subnames/reserve.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L50) +[lib/types/subnames/reserve.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/reserve.ts#L50) diff --git a/docs/docs/sdk/core/interfaces/SubnameRevokeRequest.md b/docs/docs/sdk/core/interfaces/SubnameRevokeRequest.md index d2cf7c76..d83c5a4f 100644 --- a/docs/docs/sdk/core/interfaces/SubnameRevokeRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameRevokeRequest.md @@ -26,7 +26,7 @@ The blockchain network identifier, specifying the network of the ENS domain. #### Defined in -[lib/types/subnames/revoke.ts:20](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L20) +[lib/types/subnames/revoke.ts:20](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L20) ___ @@ -38,7 +38,7 @@ The parent ENS domain under which the subname is registered. #### Defined in -[lib/types/subnames/revoke.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L16) +[lib/types/subnames/revoke.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L16) ___ @@ -50,4 +50,4 @@ The subname to be revoked. #### Defined in -[lib/types/subnames/revoke.ts:18](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L18) +[lib/types/subnames/revoke.ts:18](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L18) diff --git a/docs/docs/sdk/core/interfaces/SubnameRevokeResponse.md b/docs/docs/sdk/core/interfaces/SubnameRevokeResponse.md index caa19c57..c60ca29f 100644 --- a/docs/docs/sdk/core/interfaces/SubnameRevokeResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameRevokeResponse.md @@ -26,4 +26,4 @@ A message or status indicating the outcome of the subname revocation. #### Defined in -[lib/types/subnames/revoke.ts:32](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L32) +[lib/types/subnames/revoke.ts:32](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L32) diff --git a/docs/docs/sdk/core/interfaces/SubnameRevokeRoute.md b/docs/docs/sdk/core/interfaces/SubnameRevokeRoute.md index e2a2e2ca..2331eefe 100644 --- a/docs/docs/sdk/core/interfaces/SubnameRevokeRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameRevokeRoute.md @@ -32,7 +32,7 @@ Combined API key and SIWE authentication headers required for the operation. #### Defined in -[lib/types/subnames/revoke.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L50) +[lib/types/subnames/revoke.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L50) ___ @@ -48,7 +48,7 @@ The structure required for a subname revocation request. #### Defined in -[lib/types/subnames/revoke.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L48) +[lib/types/subnames/revoke.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L48) ___ @@ -64,4 +64,4 @@ The expected format of the response upon successful revocation. #### Defined in -[lib/types/subnames/revoke.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L49) +[lib/types/subnames/revoke.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/revoke.ts#L49) diff --git a/docs/docs/sdk/core/interfaces/SubnameSearchDomainResponse.md b/docs/docs/sdk/core/interfaces/SubnameSearchDomainResponse.md index 92acd263..da7e8d04 100644 --- a/docs/docs/sdk/core/interfaces/SubnameSearchDomainResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameSearchDomainResponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[lib/types/subnames/search-subnames.ts:67](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L67) +[lib/types/subnames/search-subnames.ts:67](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L67) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:69](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L69) +[lib/types/subnames/search-subnames.ts:69](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L69) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:61](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L61) +[lib/types/subnames/search-subnames.ts:61](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L61) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L57) +[lib/types/subnames/search-subnames.ts:57](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L57) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:65](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L65) +[lib/types/subnames/search-subnames.ts:65](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L65) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:63](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L63) +[lib/types/subnames/search-subnames.ts:63](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L63) ___ @@ -74,4 +74,4 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:59](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L59) +[lib/types/subnames/search-subnames.ts:59](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L59) diff --git a/docs/docs/sdk/core/interfaces/SubnameSearchRequest.md b/docs/docs/sdk/core/interfaces/SubnameSearchRequest.md index 5c419a28..9236ffd9 100644 --- a/docs/docs/sdk/core/interfaces/SubnameSearchRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameSearchRequest.md @@ -27,7 +27,7 @@ This interface can be extended to include common request properties shared acros #### Defined in -[lib/types/subnames/search-subnames.ts:42](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L42) +[lib/types/subnames/search-subnames.ts:42](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L42) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:44](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L44) +[lib/types/subnames/search-subnames.ts:44](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L44) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:46](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L46) +[lib/types/subnames/search-subnames.ts:46](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L46) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L48) +[lib/types/subnames/search-subnames.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L48) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L38) +[lib/types/subnames/search-subnames.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L38) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:36](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L36) +[lib/types/subnames/search-subnames.ts:36](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L36) ___ @@ -87,4 +87,4 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L40) +[lib/types/subnames/search-subnames.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L40) diff --git a/docs/docs/sdk/core/interfaces/SubnameSearchResponse.md b/docs/docs/sdk/core/interfaces/SubnameSearchResponse.md index 3c8f4885..eaf67a0d 100644 --- a/docs/docs/sdk/core/interfaces/SubnameSearchResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameSearchResponse.md @@ -27,7 +27,7 @@ Extend this interface to define specific properties for different responses. #### Defined in -[lib/types/subnames/search-subnames.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L52) +[lib/types/subnames/search-subnames.ts:52](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L52) ___ @@ -37,4 +37,4 @@ ___ #### Defined in -[lib/types/subnames/search-subnames.ts:53](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L53) +[lib/types/subnames/search-subnames.ts:53](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L53) diff --git a/docs/docs/sdk/core/interfaces/SubnameSearchRoute.md b/docs/docs/sdk/core/interfaces/SubnameSearchRoute.md index 3dd8143f..adf625e9 100644 --- a/docs/docs/sdk/core/interfaces/SubnameSearchRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameSearchRoute.md @@ -36,7 +36,7 @@ The type of the headers for the request/response. #### Defined in -[lib/types/subnames/search-subnames.ts:75](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L75) +[lib/types/subnames/search-subnames.ts:75](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L75) ___ @@ -52,7 +52,7 @@ The type of the request data. #### Defined in -[lib/types/subnames/search-subnames.ts:73](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L73) +[lib/types/subnames/search-subnames.ts:73](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L73) ___ @@ -68,4 +68,4 @@ The type of the response data. #### Defined in -[lib/types/subnames/search-subnames.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L74) +[lib/types/subnames/search-subnames.ts:74](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/search-subnames.ts#L74) diff --git a/docs/docs/sdk/core/interfaces/SubnameUpdateRequest.md b/docs/docs/sdk/core/interfaces/SubnameUpdateRequest.md index 1bdd0955..8e4577da 100644 --- a/docs/docs/sdk/core/interfaces/SubnameUpdateRequest.md +++ b/docs/docs/sdk/core/interfaces/SubnameUpdateRequest.md @@ -27,7 +27,7 @@ The cryptocurrency addresses to associate with the subname. #### Defined in -[lib/types/subnames/update.ts:81](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L81) +[lib/types/subnames/update.ts:81](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L81) ___ @@ -39,7 +39,7 @@ The blockchain network identifier. #### Defined in -[lib/types/subnames/update.ts:79](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L79) +[lib/types/subnames/update.ts:79](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L79) ___ @@ -51,7 +51,7 @@ A hash of the content to be associated with the subname. #### Defined in -[lib/types/subnames/update.ts:85](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L85) +[lib/types/subnames/update.ts:85](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L85) ___ @@ -63,7 +63,7 @@ The parent ENS domain under which the subname is registered. #### Defined in -[lib/types/subnames/update.ts:77](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L77) +[lib/types/subnames/update.ts:77](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L77) ___ @@ -75,7 +75,7 @@ The text records to associate with the subname. #### Defined in -[lib/types/subnames/update.ts:83](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L83) +[lib/types/subnames/update.ts:83](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L83) ___ @@ -87,4 +87,4 @@ The subname to be updated. #### Defined in -[lib/types/subnames/update.ts:75](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L75) +[lib/types/subnames/update.ts:75](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L75) diff --git a/docs/docs/sdk/core/interfaces/SubnameUpdateResponse.md b/docs/docs/sdk/core/interfaces/SubnameUpdateResponse.md index 50af1e89..9b139c83 100644 --- a/docs/docs/sdk/core/interfaces/SubnameUpdateResponse.md +++ b/docs/docs/sdk/core/interfaces/SubnameUpdateResponse.md @@ -26,7 +26,7 @@ The updated metadata associated with the subname. #### Defined in -[lib/types/subnames/update.ts:101](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L101) +[lib/types/subnames/update.ts:101](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L101) ___ @@ -38,4 +38,4 @@ The unique identifier of the update operation. #### Defined in -[lib/types/subnames/update.ts:99](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L99) +[lib/types/subnames/update.ts:99](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L99) diff --git a/docs/docs/sdk/core/interfaces/SubnameUpdateRoute.md b/docs/docs/sdk/core/interfaces/SubnameUpdateRoute.md index 7508f99b..be0e3e46 100644 --- a/docs/docs/sdk/core/interfaces/SubnameUpdateRoute.md +++ b/docs/docs/sdk/core/interfaces/SubnameUpdateRoute.md @@ -20,7 +20,7 @@ Configures the route for updating subname details. ### headers -• **headers**: [`ApiKeyHeaders`](ApiKeyHeaders.md) & [`SIWEHeaders`](SIWEHeaders.md) +• **headers**: [`SIWEHeaders`](SIWEHeaders.md) Combined API key and SIWE authentication headers required for the operation. @@ -30,7 +30,7 @@ Combined API key and SIWE authentication headers required for the operation. #### Defined in -[lib/types/subnames/update.ts:117](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L117) +[lib/types/subnames/update.ts:117](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L117) ___ @@ -46,7 +46,7 @@ The structure required for a subname update request. #### Defined in -[lib/types/subnames/update.ts:115](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L115) +[lib/types/subnames/update.ts:115](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L115) ___ @@ -62,4 +62,4 @@ The expected format of the response after successful update. #### Defined in -[lib/types/subnames/update.ts:116](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L116) +[lib/types/subnames/update.ts:116](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/update.ts#L116) diff --git a/docs/docs/sdk/core/interfaces/Text.md b/docs/docs/sdk/core/interfaces/Text.md index a8f1746c..a1267b8f 100644 --- a/docs/docs/sdk/core/interfaces/Text.md +++ b/docs/docs/sdk/core/interfaces/Text.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -lib/types/subnames/records.ts:5 +[lib/types/subnames/records.ts:5](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L5) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -lib/types/subnames/records.ts:6 +[lib/types/subnames/records.ts:6](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/records.ts#L6) diff --git a/docs/docs/sdk/core/interfaces/TextRecord.md b/docs/docs/sdk/core/interfaces/TextRecord.md index 786fdccb..a79442ef 100644 --- a/docs/docs/sdk/core/interfaces/TextRecord.md +++ b/docs/docs/sdk/core/interfaces/TextRecord.md @@ -20,7 +20,7 @@ The key of the text record. #### Defined in -[lib/types/subnames/accept.ts:27](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L27) +[lib/types/subnames/accept.ts:27](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L27) ___ @@ -32,4 +32,4 @@ The value of the text record. #### Defined in -[lib/types/subnames/accept.ts:29](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L29) +[lib/types/subnames/accept.ts:29](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/accept.ts#L29) diff --git a/docs/docs/sdk/core/interfaces/TextRecordResponse.md b/docs/docs/sdk/core/interfaces/TextRecordResponse.md index ace61e5e..0bdca34e 100644 --- a/docs/docs/sdk/core/interfaces/TextRecordResponse.md +++ b/docs/docs/sdk/core/interfaces/TextRecordResponse.md @@ -21,7 +21,7 @@ A reference to the metadata this text record is associated with. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:42](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L42) +[lib/types/subnames/get-by-domain-name-chainId.ts:42](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L42) ___ @@ -33,7 +33,7 @@ Unique identifier for the text record. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:36](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L36) +[lib/types/subnames/get-by-domain-name-chainId.ts:36](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L36) ___ @@ -45,7 +45,7 @@ The key or label of the text record. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L38) +[lib/types/subnames/get-by-domain-name-chainId.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L38) ___ @@ -57,4 +57,4 @@ The text content or value of the record. #### Defined in -[lib/types/subnames/get-by-domain-name-chainId.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L40) +[lib/types/subnames/get-by-domain-name-chainId.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/subnames/get-by-domain-name-chainId.ts#L40) diff --git a/docs/docs/sdk/core/interfaces/VerifyChallengeRequest.md b/docs/docs/sdk/core/interfaces/VerifyChallengeRequest.md index 66e24810..912e43ec 100644 --- a/docs/docs/sdk/core/interfaces/VerifyChallengeRequest.md +++ b/docs/docs/sdk/core/interfaces/VerifyChallengeRequest.md @@ -25,7 +25,7 @@ Represents the ethereum address to be verified. #### Defined in -[lib/types/siwe/verify-challenge.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L13) +[lib/types/siwe/verify-challenge.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L13) ___ @@ -37,7 +37,7 @@ Represents the challenge signed by the address. #### Defined in -[lib/types/siwe/verify-challenge.ts:26](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L26) +[lib/types/siwe/verify-challenge.ts:26](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L26) ___ @@ -49,4 +49,4 @@ Represents the signature of the challenge. #### Defined in -[lib/types/siwe/verify-challenge.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L19) +[lib/types/siwe/verify-challenge.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L19) diff --git a/docs/docs/sdk/core/interfaces/VerifyChallengeResponse.md b/docs/docs/sdk/core/interfaces/VerifyChallengeResponse.md index 0398b8df..956f9849 100644 --- a/docs/docs/sdk/core/interfaces/VerifyChallengeResponse.md +++ b/docs/docs/sdk/core/interfaces/VerifyChallengeResponse.md @@ -25,4 +25,4 @@ Represents the result of the verification. #### Defined in -[lib/types/siwe/verify-challenge.ts:41](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L41) +[lib/types/siwe/verify-challenge.ts:41](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/siwe/verify-challenge.ts#L41) diff --git a/docs/docs/sdk/core/modules.md b/docs/docs/sdk/core/modules.md index 83cf19e4..034886ac 100644 --- a/docs/docs/sdk/core/modules.md +++ b/docs/docs/sdk/core/modules.md @@ -21,8 +21,11 @@ custom_edit_url: null - [ApiKeyRoute](interfaces/ApiKeyRoute.md) - [BaseResponse](interfaces/BaseResponse.md) - [Coin](interfaces/Coin.md) +- [CoinType](interfaces/CoinType.md) +- [CoinTypeMap](interfaces/CoinTypeMap.md) - [Configuration](interfaces/Configuration.md) - [ContentHash](interfaces/ContentHash.md) +- [Generals](interfaces/Generals.md) - [IHeaders](interfaces/IHeaders.md) - [IRequest](interfaces/IRequest.md) - [IResponse](interfaces/IResponse.md) @@ -38,6 +41,8 @@ custom_edit_url: null - [SIWEHeaders](interfaces/SIWEHeaders.md) - [SIWERequestChallengeRoute](interfaces/SIWERequestChallengeRoute.md) - [SIWEVerifyMessageRoute](interfaces/SIWEVerifyMessageRoute.md) +- [SanitizedRecords](interfaces/SanitizedRecords.md) +- [Socials](interfaces/Socials.md) - [SubnameAcceptRequest](interfaces/SubnameAcceptRequest.md) - [SubnameAcceptResponse](interfaces/SubnameAcceptResponse.md) - [SubnameAcceptRoute](interfaces/SubnameAcceptRoute.md) @@ -59,6 +64,9 @@ custom_edit_url: null - [SubnameRecordsRequest](interfaces/SubnameRecordsRequest.md) - [SubnameRecordsResponse](interfaces/SubnameRecordsResponse.md) - [SubnameRecordsRoute](interfaces/SubnameRecordsRoute.md) +- [SubnameRejectRequest](interfaces/SubnameRejectRequest.md) +- [SubnameRejectResponse](interfaces/SubnameRejectResponse.md) +- [SubnameRejectRoute](interfaces/SubnameRejectRoute.md) - [SubnameReserveRequest](interfaces/SubnameReserveRequest.md) - [SubnameReserveResponse](interfaces/SubnameReserveResponse.md) - [SubnameReserveRoute](interfaces/SubnameReserveRoute.md) @@ -91,7 +99,47 @@ This type is used to specify and restrict operations to the following chain IDs: #### Defined in -[lib/types/common/index.ts:9](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L9) +[lib/types/common/index.ts:9](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/types/common/index.ts#L9) + +___ + +### CoinAndDetails + +Ƭ **CoinAndDetails**: [`Coin`](interfaces/Coin.md) & [`CoinType`](interfaces/CoinType.md) + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:5](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L5) + +___ + +### CoinTypeKeys + +Ƭ **CoinTypeKeys**: keyof typeof [`coinTypeMap`](modules.md#cointypemap) + +#### Defined in + +[lib/utils/cointypes/index.ts:1262](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L1262) + +___ + +### GeneralsIdentifier + +Ƭ **GeneralsIdentifier**: ``"display"`` \| ``"description"`` \| ``"url"`` \| ``"location"`` \| ``"avatar"`` \| ``"banner"`` + +#### Defined in + +[lib/constants/general-fields/index.ts:3](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/general-fields/index.ts#L3) + +___ + +### GeneralsName + +Ƭ **GeneralsName**: ``"Nickname"`` \| ``"Description"`` \| ``"Website"`` \| ``"Location"`` \| ``"Avatar"`` \| ``"Banner"`` + +#### Defined in + +[lib/constants/general-fields/index.ts:1](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/general-fields/index.ts#L1) ___ @@ -101,7 +149,7 @@ ___ #### Defined in -[lib/api/routes/index.ts:61](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L61) +[lib/api/routes/index.ts:64](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L64) ___ @@ -111,10 +159,70 @@ ___ #### Defined in -[lib/api/routes/index.ts:59](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L59) +[lib/api/routes/index.ts:62](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L62) + +___ + +### SocialDetails + +Ƭ **SocialDetails**: [`Text`](interfaces/Text.md) & \{ `name`: [`SupportedSocialsNames`](modules.md#supportedsocialsnames) } + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:7](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L7) + +___ + +### SocialsIdentifier + +Ƭ **SocialsIdentifier**: ``"com.twitter"`` \| ``"com.facebook"`` \| ``"com.instagram"`` \| ``"com.reddit"`` \| ``"com.x"`` \| ``"com.github"`` \| ``"email"`` \| ``"org.telegram"`` + +#### Defined in + +[lib/constants/supported-socials/index.ts:4](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/supported-socials/index.ts#L4) + +___ + +### SocialsName + +Ƭ **SocialsName**: ``"Twitter"`` \| ``"Facebook"`` \| ``"Instagram"`` \| ``"Reddit"`` \| ``"X"`` \| ``"Github"`` \| ``"Email"`` \| ``"Telegram"`` + +#### Defined in + +[lib/constants/supported-socials/index.ts:2](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/supported-socials/index.ts#L2) + +___ + +### SupportedGeneralsNames + +Ƭ **SupportedGeneralsNames**: typeof [`GENERAL_FIELDS`](modules.md#general_fields)[`number`][``"name"``] + +#### Defined in + +[lib/constants/general-fields/index.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/general-fields/index.ts#L39) + +___ + +### SupportedSocialsNames + +Ƭ **SupportedSocialsNames**: typeof [`SUPPORTED_SOCIALS`](modules.md#supported_socials)[`number`][``"name"``] + +#### Defined in + +[lib/constants/supported-socials/index.ts:77](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/supported-socials/index.ts#L77) ## Variables +### GENERAL\_FIELDS + +• `Const` **GENERAL\_FIELDS**: readonly [`Generals`](interfaces/Generals.md)[] + +#### Defined in + +[lib/constants/general-fields/index.ts:12](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/general-fields/index.ts#L12) + +___ + ### Routes • `Const` **Routes**: `Object` @@ -133,6 +241,7 @@ ___ | `GET_SUBNAME_BY_SUBNAME_ROUTE` | `string` | | `HEALTH_CHECK_ROUTE` | `string` | | `RECORDS_BY_FULLNAME_ROUTE` | `string` | +| `REJECT_SUBNAME_ROUTE` | `string` | | `RESERVE_SUBNAME_ROUTE` | `string` | | `REVOKE_SUBNAME_ROUTE` | `string` | | `SEARCH_SUBNAMES_ROUTE` | `string` | @@ -142,4 +251,145 @@ ___ #### Defined in -[lib/api/routes/index.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L40) +[lib/api/routes/index.ts:42](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/api/routes/index.ts#L42) + +___ + +### SUPPORTED\_SOCIALS + +• `Const` **SUPPORTED\_SOCIALS**: readonly [`Socials`](interfaces/Socials.md)[] + +#### Defined in + +[lib/constants/supported-socials/index.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/constants/supported-socials/index.ts#L21) + +___ + +### coinTypeMap + +• `Const` **coinTypeMap**: [`CoinTypeMap`](interfaces/CoinTypeMap.md) + +#### Defined in + +[lib/utils/cointypes/index.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L11) + +## Functions + +### LightenDarkenColor + +▸ **LightenDarkenColor**(`color`, `percent`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `color` | `string` | +| `percent` | `number` | + +#### Returns + +`string` + +#### Defined in + +[lib/utils/cointypes/index.ts:1264](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L1264) + +___ + +### createAddresses + +▸ **createAddresses**(`coins`): [`CoinAndDetails`](modules.md#coinanddetails)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coins` | [`Coin`](interfaces/Coin.md)[] | + +#### Returns + +[`CoinAndDetails`](modules.md#coinanddetails)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:41](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L41) + +___ + +### createGenerals + +▸ **createGenerals**(`texts`): [`Text`](interfaces/Text.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `texts` | [`Text`](interfaces/Text.md)[] | + +#### Returns + +[`Text`](interfaces/Text.md)[] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:68](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L68) + +___ + +### createSocialsAndOthers + +▸ **createSocialsAndOthers**(`texts`): [[`SocialDetails`](modules.md#socialdetails)[], [`Text`](interfaces/Text.md)[]] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `texts` | [`Text`](interfaces/Text.md)[] | + +#### Returns + +[[`SocialDetails`](modules.md#socialdetails)[], [`Text`](interfaces/Text.md)[]] + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:50](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L50) + +___ + +### getCoinTypeDetails + +▸ **getCoinTypeDetails**(`cointype`): [`CoinType`](interfaces/CoinType.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cointype` | `string` \| `number` | + +#### Returns + +[`CoinType`](interfaces/CoinType.md) + +#### Defined in + +[lib/utils/cointypes/index.ts:1292](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/cointypes/index.ts#L1292) + +___ + +### sanitizeRecords + +▸ **sanitizeRecords**(`records`): [`SanitizedRecords`](interfaces/SanitizedRecords.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `records` | `undefined` \| [`SubnameRecordsResponse`](interfaces/SubnameRecordsResponse.md) | + +#### Returns + +[`SanitizedRecords`](interfaces/SanitizedRecords.md) + +#### Defined in + +[lib/utils/sanitizeRecords/index.ts:78](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/sdk/src/lib/utils/sanitizeRecords/index.ts#L78) diff --git a/docs/docs/sdk/react/interfaces/BaseAcceptSubnameRequest.md b/docs/docs/sdk/react/interfaces/BaseAcceptSubnameRequest.md index 44bd40a6..3cdc2c07 100644 --- a/docs/docs/sdk/react/interfaces/BaseAcceptSubnameRequest.md +++ b/docs/docs/sdk/react/interfaces/BaseAcceptSubnameRequest.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L17) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:18](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L18) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L15) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L16) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L21) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:22](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L22) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L13) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L14) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L19) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:20](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L20) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L11) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:12](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L12) diff --git a/docs/docs/sdk/react/interfaces/BaseAddSubnameRequest.md b/docs/docs/sdk/react/interfaces/BaseAddSubnameRequest.md index c01be74e..d3f66ede 100644 --- a/docs/docs/sdk/react/interfaces/BaseAddSubnameRequest.md +++ b/docs/docs/sdk/react/interfaces/BaseAddSubnameRequest.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L11) +[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L11) diff --git a/docs/docs/sdk/react/interfaces/BaseRejectSubnameRequest.md b/docs/docs/sdk/react/interfaces/BaseRejectSubnameRequest.md new file mode 100644 index 00000000..4c2258e5 --- /dev/null +++ b/docs/docs/sdk/react/interfaces/BaseRejectSubnameRequest.md @@ -0,0 +1,37 @@ +--- +id: "BaseRejectSubnameRequest" +title: "Interface: BaseRejectSubnameRequest" +sidebar_label: "BaseRejectSubnameRequest" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### chainId + +• **chainId**: `number` + +#### Defined in + +[packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts#L16) + +___ + +### ensDomain + +• **ensDomain**: `string` + +#### Defined in + +[packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts#L14) + +___ + +### username + +• **username**: `string` + +#### Defined in + +[packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts:12](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts#L12) diff --git a/docs/docs/sdk/react/interfaces/BaseRevokeSubnameRequest.md b/docs/docs/sdk/react/interfaces/BaseRevokeSubnameRequest.md index d220f8d5..bf53c179 100644 --- a/docs/docs/sdk/react/interfaces/BaseRevokeSubnameRequest.md +++ b/docs/docs/sdk/react/interfaces/BaseRevokeSubnameRequest.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L15) +[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L11) +[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L11) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L13) +[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L13) diff --git a/docs/docs/sdk/react/interfaces/JustaNameContextProps.md b/docs/docs/sdk/react/interfaces/JustaNameContextProps.md index 0c30fc76..37aca614 100644 --- a/docs/docs/sdk/react/interfaces/JustaNameContextProps.md +++ b/docs/docs/sdk/react/interfaces/JustaNameContextProps.md @@ -12,13 +12,13 @@ Type definition for the properties available in the JustaNameContext. ### backendUrl -• **backendUrl**: `string` +• `Optional` **backendUrl**: `string` The backend URL for JustaName API requests. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:37](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L37) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:36](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L36) ___ @@ -30,19 +30,19 @@ The blockchain network identifier. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:38](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L38) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:37](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L37) ___ ### justaname -• **justaname**: ``null`` \| `JustaName` +• **justaname**: `JustaName` The JustaName SDK instance. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:35](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L35) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:34](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L34) ___ @@ -56,13 +56,10 @@ An object containing route definitions. | Name | Type | | :------ | :------ | -| `acceptSubnameRoute` | `string` | | `addSubnameRoute` | `string` | -| `checkSubnameAvailabilityRoute` | `string` | | `requestChallengeRoute` | `string` | | `revokeSubnameRoute` | `string` | -| `updateSubnameRoute` | `string` | #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:36](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L36) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:35](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L35) diff --git a/docs/docs/sdk/react/interfaces/JustaNameProvider.md b/docs/docs/sdk/react/interfaces/JustaNameProvider.md index 01e26f0e..5b083ef8 100644 --- a/docs/docs/sdk/react/interfaces/JustaNameProvider.md +++ b/docs/docs/sdk/react/interfaces/JustaNameProvider.md @@ -18,7 +18,7 @@ Optional backend URL for API requests. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:63](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L63) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:62](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L62) ___ @@ -30,7 +30,7 @@ Optional blockchain network identifier. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:62](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L62) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:61](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L61) ___ @@ -42,7 +42,7 @@ The child components. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:60](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L60) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:59](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L59) ___ @@ -56,13 +56,10 @@ Optional custom API routes. | Name | Type | | :------ | :------ | -| `acceptSubnameRoute` | `string` | | `addSubnameRoute` | `string` | -| `checkSubnameAvailabilityRoute` | `string` | | `requestChallengeRoute` | `string` | | `revokeSubnameRoute` | `string` | -| `updateSubnameRoute` | `string` | #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:61](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L61) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:60](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L60) diff --git a/docs/docs/sdk/react/interfaces/SubnameUpdate.md b/docs/docs/sdk/react/interfaces/SubnameUpdate.md index 8b014c1f..4b52b736 100644 --- a/docs/docs/sdk/react/interfaces/SubnameUpdate.md +++ b/docs/docs/sdk/react/interfaces/SubnameUpdate.md @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L19) +[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:18](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L18) ___ diff --git a/docs/docs/sdk/react/interfaces/UseAcceptSubname.md b/docs/docs/sdk/react/interfaces/UseAcceptSubname.md index 546622db..24785fb4 100644 --- a/docs/docs/sdk/react/interfaces/UseAcceptSubname.md +++ b/docs/docs/sdk/react/interfaces/UseAcceptSubname.md @@ -1,6 +1,6 @@ --- id: "UseAcceptSubname" -title: "Interface: UseAcceptSubname" +title: "Interface: UseAcceptSubname" sidebar_label: "UseAcceptSubname" sidebar_position: 0 custom_edit_url: null @@ -8,17 +8,11 @@ custom_edit_url: null Interface defining the parameters needed to accept a subname. -## Type parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `T` | `any` | The type of additional parameters that can be passed to the accept subname mutation, extending the base request. | - ## Properties ### acceptSubname -• **acceptSubname**: (`params`: `T` & [`BaseAcceptSubnameRequest`](BaseAcceptSubnameRequest.md)) => `Promise`<`SubnameAcceptResponse`\> +• **acceptSubname**: (`params`: [`BaseAcceptSubnameRequest`](BaseAcceptSubnameRequest.md)) => `Promise`<`SubnameAcceptResponse`\> The function to accept a subname. @@ -30,7 +24,7 @@ The function to accept a subname. | Name | Type | | :------ | :------ | -| `params` | `T` & [`BaseAcceptSubnameRequest`](BaseAcceptSubnameRequest.md) | +| `params` | [`BaseAcceptSubnameRequest`](BaseAcceptSubnameRequest.md) | ##### Returns @@ -38,7 +32,7 @@ The function to accept a subname. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:34](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L34) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:34](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L34) ___ @@ -50,4 +44,4 @@ Indicates if the mutation is currently pending. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:37](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L37) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:37](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L37) diff --git a/docs/docs/sdk/react/interfaces/UseAddSubname.md b/docs/docs/sdk/react/interfaces/UseAddSubname.md index f7773c45..70dfef63 100644 --- a/docs/docs/sdk/react/interfaces/UseAddSubname.md +++ b/docs/docs/sdk/react/interfaces/UseAddSubname.md @@ -38,7 +38,7 @@ The function to add a subname. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:24](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L24) +[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:24](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L24) ___ @@ -50,4 +50,4 @@ Indicates if the mutation is currently pending. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:27](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L27) +[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:27](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L27) diff --git a/docs/docs/sdk/react/interfaces/UseCommunitySubnamesOptions.md b/docs/docs/sdk/react/interfaces/UseCommunitySubnamesOptions.md index 22e12b67..db1b52b9 100644 --- a/docs/docs/sdk/react/interfaces/UseCommunitySubnamesOptions.md +++ b/docs/docs/sdk/react/interfaces/UseCommunitySubnamesOptions.md @@ -14,34 +14,14 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L14) +[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:10](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L10) ___ ### isClaimed -• `Optional` **isClaimed**: `boolean` +• **isClaimed**: `boolean` #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L17) - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L16) - -___ - -### page - -• `Optional` **page**: `number` - -#### Defined in - -[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L15) +[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L11) diff --git a/docs/docs/sdk/react/interfaces/UseConnectedWalletSubnamesOptions.md b/docs/docs/sdk/react/interfaces/UseConnectedWalletSubnamesOptions.md index 365fb43f..5415f6af 100644 --- a/docs/docs/sdk/react/interfaces/UseConnectedWalletSubnamesOptions.md +++ b/docs/docs/sdk/react/interfaces/UseConnectedWalletSubnamesOptions.md @@ -18,4 +18,4 @@ An optional ENS domain to filter the subnames by. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts#L31) +[packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts:32](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts#L32) diff --git a/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableOptions.md b/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableOptions.md index a92cf734..b2c8f608 100644 --- a/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableOptions.md +++ b/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableOptions.md @@ -18,7 +18,7 @@ The ENS domain under which the subname will be checked. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L17) +[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L17) ___ @@ -30,4 +30,4 @@ The desired username to check within the ENS domain. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L16) +[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L16) diff --git a/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableResult.md b/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableResult.md index 62fdb50a..23b209d7 100644 --- a/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableResult.md +++ b/docs/docs/sdk/react/interfaces/UseIsSubnameAvailableResult.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L21) +[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L21) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:22](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L22) +[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:22](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L22) diff --git a/docs/docs/sdk/react/interfaces/UseRejectSubname.md b/docs/docs/sdk/react/interfaces/UseRejectSubname.md new file mode 100644 index 00000000..298656a0 --- /dev/null +++ b/docs/docs/sdk/react/interfaces/UseRejectSubname.md @@ -0,0 +1,47 @@ +--- +id: "UseRejectSubname" +title: "Interface: UseRejectSubname" +sidebar_label: "UseRejectSubname" +sidebar_position: 0 +custom_edit_url: null +--- + +Interface defining the parameters needed to reject a subname. + +## Properties + +### rejectSubname + +• **rejectSubname**: (`params`: [`BaseRejectSubnameRequest`](BaseRejectSubnameRequest.md)) => `Promise`<`SubnameRejectResponse`\> + +The function to reject a subname. + +#### Type declaration + +▸ (`params`): `Promise`<`SubnameRejectResponse`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | [`BaseRejectSubnameRequest`](BaseRejectSubnameRequest.md) | + +##### Returns + +`Promise`<`SubnameRejectResponse`\> + +#### Defined in + +[packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts:28](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts#L28) + +___ + +### rejectSubnamePending + +• **rejectSubnamePending**: `boolean` + +Indicates if the mutation is currently pending. + +#### Defined in + +[packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts#L31) diff --git a/docs/docs/sdk/react/interfaces/UseRevokeSubname.md b/docs/docs/sdk/react/interfaces/UseRevokeSubname.md index 3282c3c9..fda5e6f7 100644 --- a/docs/docs/sdk/react/interfaces/UseRevokeSubname.md +++ b/docs/docs/sdk/react/interfaces/UseRevokeSubname.md @@ -38,7 +38,7 @@ The function to revoke a subname. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:28](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L28) +[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:28](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L28) ___ @@ -50,4 +50,4 @@ Indicates if the mutation is currently pending. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L31) +[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:31](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L31) diff --git a/docs/docs/sdk/react/interfaces/UseSearchSubnamesOptions.md b/docs/docs/sdk/react/interfaces/UseSearchSubnamesOptions.md index f344e5fa..c3f95281 100644 --- a/docs/docs/sdk/react/interfaces/UseSearchSubnamesOptions.md +++ b/docs/docs/sdk/react/interfaces/UseSearchSubnamesOptions.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L17) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L17) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:18](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L18) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:18](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L18) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L19) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:19](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L19) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L15) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L15) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L14) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L14) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L16) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L16) diff --git a/docs/docs/sdk/react/interfaces/UseSubnameOptions.md b/docs/docs/sdk/react/interfaces/UseSubnameOptions.md index 545158cc..ec8b58e5 100644 --- a/docs/docs/sdk/react/interfaces/UseSubnameOptions.md +++ b/docs/docs/sdk/react/interfaces/UseSubnameOptions.md @@ -18,4 +18,4 @@ The subname to query. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSubname.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSubname.ts#L23) +[packages/@justaname.id/react/src/lib/hooks/useSubname.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSubname.ts#L23) diff --git a/docs/docs/sdk/react/interfaces/UseSubnameSignatureResult.md b/docs/docs/sdk/react/interfaces/UseSubnameSignatureResult.md index b104aace..a23abb20 100644 --- a/docs/docs/sdk/react/interfaces/UseSubnameSignatureResult.md +++ b/docs/docs/sdk/react/interfaces/UseSubnameSignatureResult.md @@ -22,7 +22,7 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:16](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L16) +[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L13) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:17](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L17) +[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L14) diff --git a/docs/docs/sdk/react/interfaces/UseUpdateSubnameResult.md b/docs/docs/sdk/react/interfaces/UseUpdateSubnameResult.md index fef1dd55..c3200c79 100644 --- a/docs/docs/sdk/react/interfaces/UseUpdateSubnameResult.md +++ b/docs/docs/sdk/react/interfaces/UseUpdateSubnameResult.md @@ -28,7 +28,7 @@ custom_edit_url: null #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L23) +[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:22](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L22) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:24](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L24) +[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L23) diff --git a/docs/docs/sdk/react/modules.md b/docs/docs/sdk/react/modules.md index 91fba6b1..e8749dfd 100644 --- a/docs/docs/sdk/react/modules.md +++ b/docs/docs/sdk/react/modules.md @@ -10,6 +10,7 @@ custom_edit_url: null - [BaseAcceptSubnameRequest](interfaces/BaseAcceptSubnameRequest.md) - [BaseAddSubnameRequest](interfaces/BaseAddSubnameRequest.md) +- [BaseRejectSubnameRequest](interfaces/BaseRejectSubnameRequest.md) - [BaseRevokeSubnameRequest](interfaces/BaseRevokeSubnameRequest.md) - [JustaNameContextProps](interfaces/JustaNameContextProps.md) - [JustaNameProvider](interfaces/JustaNameProvider.md) @@ -20,10 +21,10 @@ custom_edit_url: null - [UseConnectedWalletSubnamesOptions](interfaces/UseConnectedWalletSubnamesOptions.md) - [UseIsSubnameAvailableOptions](interfaces/UseIsSubnameAvailableOptions.md) - [UseIsSubnameAvailableResult](interfaces/UseIsSubnameAvailableResult.md) +- [UseRejectSubname](interfaces/UseRejectSubname.md) - [UseRevokeSubname](interfaces/UseRevokeSubname.md) - [UseSearchSubnamesOptions](interfaces/UseSearchSubnamesOptions.md) - [UseSubnameOptions](interfaces/UseSubnameOptions.md) -- [UseSubnameSignatureOptions](interfaces/UseSubnameSignatureOptions.md) - [UseSubnameSignatureResult](interfaces/UseSubnameSignatureResult.md) - [UseUpdateSubnameResult](interfaces/UseUpdateSubnameResult.md) @@ -53,9 +54,30 @@ The provider component wrapping children. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:59](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L59) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:58](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L58) -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:74](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L74) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:73](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L73) + +___ + +### SignatureOnMounted + +▸ **SignatureOnMounted**(`props`, `context?`): `ReactNode` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Object` | +| `context?` | `any` | + +#### Returns + +`ReactNode` + +#### Defined in + +[packages/@justaname.id/react/src/lib/components/SignatureOnMounted.tsx:5](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/components/SignatureOnMounted.tsx#L5) ___ @@ -75,7 +97,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts#L11) +[packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts:11](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts#L11) ___ @@ -99,7 +121,7 @@ A unique cache key array for react-query. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts:20](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts#L20) +[packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts#L21) ___ @@ -119,7 +141,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:9](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L9) +[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:5](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L5) ___ @@ -140,7 +162,7 @@ ___ #### Defined in -packages/@justaname.id/react/src/lib/hooks/useRecords.ts:7 +[packages/@justaname.id/react/src/lib/hooks/useRecords.ts:5](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRecords.ts#L5) ___ @@ -160,7 +182,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:9](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L9) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:9](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L9) ___ @@ -180,7 +202,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:8](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L8) +[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:9](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L9) ___ @@ -204,7 +226,7 @@ A unique cache key array for react-query. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSubname.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSubname.ts#L13) +[packages/@justaname.id/react/src/lib/hooks/useSubname.ts:13](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSubname.ts#L13) ___ @@ -227,31 +249,25 @@ ___ #### Defined in -packages/@justaname.id/react/src/lib/hooks/useRecords.ts:10 +[packages/@justaname.id/react/src/lib/hooks/useRecords.ts:15](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRecords.ts#L15) ___ ### useAcceptSubname -▸ **useAcceptSubname**<`T`\>(): [`UseAcceptSubname`](interfaces/UseAcceptSubname.md)<`T`\> +▸ **useAcceptSubname**(): [`UseAcceptSubname`](interfaces/UseAcceptSubname.md) Custom hook for performing a mutation to accept a subname. -#### Type parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `T` | `any` | The type of additional parameters that can be passed to the accept subname mutation, extending the base request. | - #### Returns -[`UseAcceptSubname`](interfaces/UseAcceptSubname.md)<`T`\> +[`UseAcceptSubname`](interfaces/UseAcceptSubname.md) An object containing the `acceptSubname` async function to initiate the subname accept, and a boolean `acceptSubnamePending` indicating the mutation's pending state. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:45](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L45) +[packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts:44](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAcceptSubname.ts#L44) ___ @@ -265,7 +281,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts:25](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts#L25) +[packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts:25](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAccountInvitations.ts#L25) ___ @@ -289,7 +305,7 @@ The result object containing subnames data, loading state, and a refetch functio #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts:65](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts#L65) +[packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts:66](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAccountSubnames.ts#L66) ___ @@ -313,13 +329,13 @@ An object containing the `addSubname` async function to initiate the subname cla #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:35](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L35) +[packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts:35](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useAddSubname.ts#L35) ___ ### useCommunitySubnames -▸ **useCommunitySubnames**(`props`): `UseCommunitySubnamesResult` +▸ **useCommunitySubnames**(`props`): `UseInfiniteQueryResult`<`InfiniteData`<`SubnameGetAllByDomainChainIdResponse`, `unknown`\>, `Error`\> #### Parameters @@ -329,11 +345,11 @@ ___ #### Returns -`UseCommunitySubnamesResult` +`UseInfiniteQueryResult`<`InfiniteData`<`SubnameGetAllByDomainChainIdResponse`, `unknown`\>, `Error`\> #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:32](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L32) +[packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts:14](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useCommunitySubnames.ts#L14) ___ @@ -358,7 +374,7 @@ and the loading state of the query (`isLoading`). #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:32](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L32) +[packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts:32](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useIsSubnameAvailable.ts#L32) ___ @@ -382,7 +398,7 @@ If the hook is used outside a JustaNameProvider. #### Defined in -[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:121](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L121) +[packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx:107](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/providers/JustaNameProvider.tsx#L107) ___ @@ -400,7 +416,26 @@ A boolean flag indicating whether the component is currently mounted. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useMounted.ts:10](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useMounted.ts#L10) +[packages/@justaname.id/react/src/lib/hooks/useMounted.ts:10](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useMounted.ts#L10) + +___ + +### useMountedAccount + +▸ **useMountedAccount**(): \{ `address`: `undefined` ; `addresses`: `undefined` ; `chain`: `undefined` ; `chainId`: `undefined` ; `connector`: `undefined` ; `isConnected`: `boolean` ; `isConnecting`: ``false`` ; `isDisconnected`: ``true`` ; `isReconnecting`: ``false`` ; `status`: ``"disconnected"`` } \| \{ `address`: \`0x$\{string}\` ; `addresses`: readonly [\`0x$\{string}\`, \`0x$\{string}\`] ; `chain`: `undefined` \| `Chain` ; `chainId`: `number` ; `connector`: `Connector` ; `isConnected`: `boolean` ; `isConnecting`: ``false`` ; `isDisconnected`: ``false`` ; `isReconnecting`: ``false`` ; `status`: ``"connected"`` } \| \{ `address`: `undefined` \| \`0x$\{string}\` ; `addresses`: `undefined` \| readonly \`0x$\{string}\`[] ; `chain`: `undefined` \| `Chain` ; `chainId`: `undefined` \| `number` ; `connector`: `undefined` \| `Connector` ; `isConnected`: `boolean` ; `isConnecting`: ``false`` ; `isDisconnected`: ``false`` ; `isReconnecting`: ``true`` ; `status`: ``"reconnecting"`` } \| \{ `address`: `undefined` \| \`0x$\{string}\` ; `addresses`: `undefined` \| readonly \`0x$\{string}\`[] ; `chain`: `undefined` \| `Chain` ; `chainId`: `undefined` \| `number` ; `connector`: `undefined` \| `Connector` ; `isConnected`: `boolean` ; `isConnecting`: ``true`` ; `isDisconnected`: ``false`` ; `isReconnecting`: ``false`` ; `status`: ``"connecting"`` } + +A custom hook that wraps the `useAccount` hook from wagmi, incorporating a component mount check. + +#### Returns + +\{ `address`: `undefined` ; `addresses`: `undefined` ; `chain`: `undefined` ; `chainId`: `undefined` ; `connector`: `undefined` ; `isConnected`: `boolean` ; `isConnecting`: ``false`` ; `isDisconnected`: ``true`` ; `isReconnecting`: ``false`` ; `status`: ``"disconnected"`` } \| \{ `address`: \`0x$\{string}\` ; `addresses`: readonly [\`0x$\{string}\`, \`0x$\{string}\`] ; `chain`: `undefined` \| `Chain` ; `chainId`: `number` ; `connector`: `Connector` ; `isConnected`: `boolean` ; `isConnecting`: ``false`` ; `isDisconnected`: ``false`` ; `isReconnecting`: ``false`` ; `status`: ``"connected"`` } \| \{ `address`: `undefined` \| \`0x$\{string}\` ; `addresses`: `undefined` \| readonly \`0x$\{string}\`[] ; `chain`: `undefined` \| `Chain` ; `chainId`: `undefined` \| `number` ; `connector`: `undefined` \| `Connector` ; `isConnected`: `boolean` ; `isConnecting`: ``false`` ; `isDisconnected`: ``false`` ; `isReconnecting`: ``true`` ; `status`: ``"reconnecting"`` } \| \{ `address`: `undefined` \| \`0x$\{string}\` ; `addresses`: `undefined` \| readonly \`0x$\{string}\`[] ; `chain`: `undefined` \| `Chain` ; `chainId`: `undefined` \| `number` ; `connector`: `undefined` \| `Connector` ; `isConnected`: `boolean` ; `isConnecting`: ``true`` ; `isDisconnected`: ``false`` ; `isReconnecting`: ``false`` ; `status`: ``"connecting"`` } + +An enhanced account object that includes all properties and methods from `useAccount`, +along with an improved `isConnected` boolean that also takes the component's mount state into consideration. + +#### Defined in + +[packages/@justaname.id/react/src/lib/hooks/useMountedAccount.ts:12](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useMountedAccount.ts#L12) ___ @@ -420,7 +455,25 @@ ___ #### Defined in -packages/@justaname.id/react/src/lib/hooks/useRecords.ts:63 +[packages/@justaname.id/react/src/lib/hooks/useRecords.ts:68](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRecords.ts#L68) + +___ + +### useRejectSubname + +▸ **useRejectSubname**(): [`UseRejectSubname`](interfaces/UseRejectSubname.md) + +Custom hook for performing a mutation to reject a subname. + +#### Returns + +[`UseRejectSubname`](interfaces/UseRejectSubname.md) + +An object containing the `rejectSubname` async function to initiate the subname reject, and a boolean `rejectSubnamePending` indicating the mutation's pending state. + +#### Defined in + +[packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRejectSubname.ts#L38) ___ @@ -444,7 +497,7 @@ An object containing the `revokeSubname` async function to initiate the subname #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L39) +[packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useRevokeSubname.ts#L39) ___ @@ -464,7 +517,7 @@ ___ #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:29](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L29) +[packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts:29](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSearchSubnames.ts#L29) ___ @@ -488,22 +541,16 @@ An object containing the subname data, loading state, and a refetch function. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSubname.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSubname.ts#L48) +[packages/@justaname.id/react/src/lib/hooks/useSubname.ts:48](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSubname.ts#L48) ___ ### useSubnameSignature -▸ **useSubnameSignature**(`props`): [`UseSubnameSignatureResult`](interfaces/UseSubnameSignatureResult.md) +▸ **useSubnameSignature**(): [`UseSubnameSignatureResult`](interfaces/UseSubnameSignatureResult.md) Custom hook to request a challenge for a subname and obtain a signature proving ownership of an address. -#### Parameters - -| Name | Type | -| :------ | :------ | -| `props` | [`UseSubnameSignatureOptions`](interfaces/UseSubnameSignatureOptions.md) | - #### Returns [`UseSubnameSignatureResult`](interfaces/UseSubnameSignatureResult.md) @@ -513,7 +560,7 @@ and a boolean indicating if the signature operation is pending (`subnameSignatur #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:25](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L25) +[packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts:22](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useSubnameSignature.ts#L22) ___ @@ -531,4 +578,4 @@ An object containing methods and properties to handle the mutation state. #### Defined in -[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:33](https://github.com/JustaName-id/JustaName-sdk/blob/4ff9084/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L33) +[packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts:32](https://github.com/JustaName-id/JustaName-sdk/blob/610ce53/packages/@justaname.id/react/src/lib/hooks/useUpdateSubname.ts#L32) diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json index 476bc748..6f280cbc 100644 --- a/docs/swagger/swagger.json +++ b/docs/swagger/swagger.json @@ -99,15 +99,6 @@ "schema": { "type": "string" } - }, - { - "name": "x-api-key", - "in": "header", - "description": "The Api Key.", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -325,6 +316,33 @@ "schema": { "type": "string" } + }, + { + "name": "x-signature", + "in": "header", + "description": "The signature.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-message", + "in": "header", + "description": "The Message.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-address", + "in": "header", + "description": "The Address.", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -354,6 +372,67 @@ ] } }, + "/ens/v1/subdomain/reject-invitation": { + "post": { + "operationId": "SubdomainWriteController_revokeInvitation", + "summary": "Reject Subname Invitation", + "description": "Reject the specified subname invitation", + "parameters": [ + { + "name": "x-signature", + "in": "header", + "description": "The signature.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-message", + "in": "header", + "description": "The Message.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-address", + "in": "header", + "description": "The Address.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubdomainRevokeApiRequest" + } + } + } + }, + "responses": { + "default": { + "description": "The Subname invitation was rejected successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubdomainRevokeApiResponseSuccessSwagger" + } + } + } + } + }, + "tags": [ + "Subname" + ] + } + }, "/ens/v1/subdomain/username": { "get": { "operationId": "SubdomainReadController_findByDomainNameAndNameAndChainId", @@ -1166,6 +1245,17 @@ "isBlocked" ] }, + "EnsUnlockDomainApiRequest": { + "type": "object", + "properties": { + "ensId": { + "type": "string" + } + }, + "required": [ + "ensId" + ] + }, "EnsApiResponse": { "type": "object", "properties": { @@ -1232,6 +1322,50 @@ "names" ] }, + "EnsGetSubscriptionApiResponse": { + "type": "object", + "properties": { + "isSubscribed": { + "type": "boolean" + } + }, + "required": [ + "isSubscribed" + ] + }, + "EnsGetSubscriptionApiResponseResultSwagger": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/EnsGetSubscriptionApiResponse" + }, + "error": { + "type": "string", + "description": "Null if no error occurred, otherwise the error message." + } + }, + "required": [ + "data", + "error" + ] + }, + "EnsGetSubscriptionApiResponseSuccessSwagger": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "example": 200, + "description": "The status code of the response." + }, + "result": { + "$ref": "#/components/schemas/EnsGetSubscriptionApiResponseResultSwagger" + } + }, + "required": [ + "statusCode", + "result" + ] + }, "OffchainResolverApiResponse": { "type": "object", "properties": { @@ -1627,7 +1761,7 @@ } }, "contentHash": { - "type": "string", + "type": "object", "description": "The content hash of the subdomain", "example": "ipfs://QmRAQB6YaCyidP37UdDnjFY5vQuiBrcqdyoW1CuDgwxkD4" }