From eb1aaeaa8cc7871dbbc7ca51c5ccdc4302023c8e Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 13 Aug 2024 16:13:37 -0400 Subject: [PATCH] docs: update js-sdk based on platform pr --- docs/sdk-js/platform/names/register.md | 5 ++--- docs/sdk-js/platform/names/resolvebyrecord.md | 6 +++--- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/sdk-js/platform/names/register.md b/docs/sdk-js/platform/names/register.md index d51b8688c..7795c4711 100644 --- a/docs/sdk-js/platform/names/register.md +++ b/docs/sdk-js/platform/names/register.md @@ -9,10 +9,9 @@ Parameters: | -------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **name** | String | yes | An alphanumeric (1-63 character) value used for human-identification (can contain `-` but not as the first or last character). If a name with no parent domain is entered, '.dash' is used. | | **records** | Object | yes | records object having only one of the following items | -| **records.dashUniqueIdentityId** | String | no | Unique Identity ID for this name record | -| **records.dashAliasIdentityId** | String | no | Used to signify that this name is the alias for another id | +| **records.identity** | String | yes | Identity ID for this name record | | **identity** | Identity | yes | A valid [registered identity](../identities/register.md) | -**Example**: `await client.platform.names.register('alice', { dashUniqueIdentityId: identity.getId() }, identity)` +**Example**: `await client.platform.names.register('alice', { identity: identity.getId() }, identity)` Returns: the created domain document diff --git a/docs/sdk-js/platform/names/resolvebyrecord.md b/docs/sdk-js/platform/names/resolvebyrecord.md index 5ad72d1e1..645bc40d1 100644 --- a/docs/sdk-js/platform/names/resolvebyrecord.md +++ b/docs/sdk-js/platform/names/resolvebyrecord.md @@ -7,16 +7,16 @@ Parameters: | Parameters | Type | Required | Description | | ---------- | ------ | -------- | -------------------------------------------------------------------- | -| **record** | String | yes | Type of the record (`dashUniqueIdentityId` or `dashAliasIdentityId`) | +| **record** | String | yes | Type of the record (`identity`) | | **value** | String | yes | Identifier value for the record | **Example**: -This example will describe how to resolve names by the dash unique identity id. +This example will describe how to resolve names by the dash unique identity id. ```js const identityId = '3ge4yjGinQDhxh2aVpyLTQaoka45BkijkoybfAkDepoN'; -const document = await client.platform.names.resolveByRecord('dashUniqueIdentityId', identityId); +const document = await client.platform.names.resolveByRecord('identity', identityId); ``` Returns: array of ExtendedDocument.