From ad2f6a673f201f733f613c202685918cb7e7ce2b Mon Sep 17 00:00:00 2001 From: wambuipixel Date: Tue, 11 Feb 2025 00:25:27 +0300 Subject: [PATCH] fix spaces Signed-off-by: wambuipixel --- src/bootstrap.ts | 18 ++++++++-------- src/certs.ts | 10 ++++----- src/channels.ts | 4 ++-- src/clients.ts | 54 ++++++++++++++++++++++++------------------------ src/journal.ts | 12 +++++------ src/messages.ts | 2 +- src/re.ts | 14 ++++++------- 7 files changed, 57 insertions(+), 57 deletions(-) diff --git a/src/bootstrap.ts b/src/bootstrap.ts index d2e27ff..8e51f2d 100644 --- a/src/bootstrap.ts +++ b/src/bootstrap.ts @@ -52,7 +52,7 @@ export default class Bootstrap { /** * @method AddBootstrap - Creates a new bootstrap configuration. * @param {BootstrapConfig} bootstrapConfig - The bootstrap configuration object containing details like external key, channels, externalId, clientId, etc. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the bootstrap configuration is created. * @throws {Error} - If the bootstrap configuration cannot be created. @@ -95,7 +95,7 @@ export default class Bootstrap { /** * @method Whitelist - Updates a bootstrap configuration and changes the status of the config to whitelisted. * @param {BootstrapConfig} bootstrapConfig - The bootstrap configuration object containing details like external key, channels, externalId, clientId, etc. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the bootstrap configuration is whitelisted. * @throws {Error} - If the bootstrap configuration cannot be whitelisted. @@ -138,7 +138,7 @@ export default class Bootstrap { /** * @method UpdateBootstrap - Updates an existing bootstrap configuration's details. * @param {BootstrapConfig} bootstrapConfig - The bootstrap configuration object containing details like external key, channels, externalId, clientId, etc. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the bootstrap configuration is updated. * @throws {Error} - If the bootstrap configuration cannot be updated. @@ -181,7 +181,7 @@ export default class Bootstrap { /** * @method ViewBootstrap - Retrieves a bootstrap config by its ID. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} bootstrapConfig - The requested bootstrap configuration object. * @throws {Error} - If the bootstrap configuration cannot be fetched. @@ -221,7 +221,7 @@ export default class Bootstrap { /** * @method UpdateBootstrapCerts - Updates the details of a specific role in a domain. * @param {BootstrapConfig} bootstrapConfig - The bootstrap configuration object containing details like external key, channels, externalId, clientId, etc. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} bootstrapConfig - The updated bootstrap configuration. * @throws {Error} - If the certs cannot be updated. @@ -260,8 +260,8 @@ export default class Bootstrap { /** * @method DeleteBootstrap - Deletes bootstrap configuration with specified id. - * @param {string} clientId - The unique ID of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} clientId - The unique ID of the client. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the bootstrap configuration is deleted. * @throws {Error} - If the bootstrap configuration cannot be deleted. @@ -340,7 +340,7 @@ export default class Bootstrap { /** * @method Bootstraps -Retrieves all bootstrap configuration matching the provided query parameters. * @param {PageMetadata} queryParams - Query parameters for the request. - * @param {string} domainId -The unique ID of the domain. + * @param {string} domainId -The unique ID of the domain. * @param {String} token - Authorization token. * @returns {Promise} bootstrapPage - A page of bootstrap configurations. * @throws {Error} - If the bootstrap configurations cannot be fetched. @@ -386,7 +386,7 @@ export default class Bootstrap { * @method UpdateBootstrapConnection - Updates the connection of a bootstrap configuration. * @param {string} clientId - The unique identifier of the client. * @param {string[]} channels - An array of unique channels ids to be updated. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the bootstrap configuration connection are updated. * @throws {Error} - If the bootstrap configuration cannot be updated. diff --git a/src/certs.ts b/src/certs.ts index f6bcfbf..1e7c064 100644 --- a/src/certs.ts +++ b/src/certs.ts @@ -25,7 +25,7 @@ export default class Certs { * @method IssueCert - Issues a certificate to a client. * @param {string} clientId - The unique ID of the client to be issued a certificate. * @param {string} valid - The time in hours for which the certificate is valid such as '10h' - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} cert - A promise that resolves with the certificate issued. * @throws {Error} - If the certificate cannot be issued. @@ -63,8 +63,8 @@ export default class Certs { /** * @method ViewCertByClient - Retrieves all certs matching the provided client Id. - * @param {string} clientId - The unique ID of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} clientId - The unique ID of the client. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} certsPage - A page of certs. * @throws {Error} - If the certs cannot be fetched. @@ -100,7 +100,7 @@ export default class Certs { /** * @method ViewCert - Retrieves a certificate by its id. * @param {string} certId - The unique ID of the certificate. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} cert - The requested cert object. * @throws {Error} - If the cert cannot be fetched. @@ -140,7 +140,7 @@ export default class Certs { /** * @method RevokeCert - Revokes and deletes a certificate with specified id. * @param {string} certId - The unique ID of the certificate to be revoked. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the cert is revoked. * @throws {Error} - If the cert cannot be revoked. diff --git a/src/channels.ts b/src/channels.ts index b74d13a..b4a14e6 100644 --- a/src/channels.ts +++ b/src/channels.ts @@ -409,7 +409,7 @@ export default class Channels { /** * @method ConnectClient - Connects multiple clients to a channel. * @param {string[]} clientIds - An array of unique clients IDs to be connected. - * @param {string} channelId - The unique ID of the channel to which the clients will connect. + * @param {string} channelId - The unique ID of the channel. to which the clients will connect. * @param {string[]}connectionTypes - Connection types can be 'publish', 'subscribe' or both. * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. @@ -562,7 +562,7 @@ export default class Channels { /** * @method DisconnectClient - Disconnects clients from channel. * @param {string[]} clientIds - An array of unique clients IDs to be disconnected. - * @param {string} channelId - The unique ID of the channel from which the clients will be disconnected. + * @param {string} channelId - The unique ID of the channel. from which the clients will be disconnected. * @param {string[]} connectionTypes - connection types can be publish, subscribe or both publish and subscribe. * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. diff --git a/src/clients.ts b/src/clients.ts index 9bba851..20b63de 100644 --- a/src/clients.ts +++ b/src/clients.ts @@ -87,7 +87,7 @@ export default class Clients { /** * @method CreateClients - Creates multiple new clients. * @param {Client[]} clients - An array of client objects, each containing details like name, metadata, and tags. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} clientsPage - A page of clients. * @throws {Error} - If the clients cannot be created. @@ -126,8 +126,8 @@ export default class Clients { /** * @method Enable - Enables a previously disabled client by its ID. - * @param {string} clientId - The unique ID of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} clientId - The unique ID of the client. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} client - The updated client object with enabled status. * @throws {Error} - If the client cannot be enabled. @@ -166,8 +166,8 @@ export default class Clients { /** * @method Disable - Disables an enabled client by its ID. - * @param {string} clientId - The unique ID of the client. - * @param {string} domainId -The unique ID of the domain. + * @param {string} clientId - The unique ID of the client. + * @param {string} domainId -The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} client - The updated client object with disabled status. * @throws {Error} - If the group cannot be disabled. @@ -245,7 +245,7 @@ export default class Clients { /** * @method UpdateClientSecret - Updates an existing client's secret. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {Client} client - Client object with updated secret. * @param {string} token - Authorization token. * @returns {Promise } client - The updated client object. @@ -286,7 +286,7 @@ export default class Clients { /** * @method UpdateClientTags - Updates an existing client's tags. * @param {Client} client - Client object with updated tags. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} client - The updated client object. * @throws {Error} - If the client tags cannot be updated. @@ -327,7 +327,7 @@ export default class Clients { /** * @method Client - Retrieves a client by its id. * @param {string} clientId - The unique ID of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} client - The requested client object. * @throws {Error} - If the client cannot be fetched. @@ -367,7 +367,7 @@ export default class Clients { /** * @method Clients - Retrieves all clients matching the provided query parameters. * @param {PageMetadata} queryParams - Query parameters for the request. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} clientsPage - A page of clients. * @throws {Error} - If the clients cannot be fetched. @@ -412,7 +412,7 @@ export default class Clients { /** * @method setClientParentGroup - Sets parent to a client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} clientId - The unique ID of the client to be updated. * @param {string} parentGroupId - The unique ID of the group to be set as the parent. * @param {string} token - Authorization token. @@ -457,8 +457,8 @@ export default class Clients { /** * @method DeleteClientParentGroup - Removes the parent group from a specified client. - * @param {string} domainId - The unique ID of the domain. - * @param {string} clientId - The unique ID of the client. + * @param {string} domainId - The unique ID of the domain. + * @param {string} clientId - The unique ID of the client. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the parent group is successfully removed from the specified client. * @throws {Error} - If the parent group cannot removed from the client. @@ -499,8 +499,8 @@ export default class Clients { /** * @method DeleteClient - Deletes a client with specified id. - * @param {string} clientId - The unique ID of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} clientId - The unique ID of the client. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the client is deleted. * @throws {Error} - If the client cannot be deleted. @@ -566,7 +566,7 @@ export default class Clients { /** * @method CreateClientRole - Creates a new role within a specific client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleName - The name of the role to create. * @param {string} token - Authorization token. * @param {string[]} optionalActions - Optional actions assigned to the role. @@ -601,7 +601,7 @@ export default class Clients { /** * @method ListClientRoles - Lists all roles within a specific client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {PageMetadata} queryParams - Metadata for pagination or filters. * @param {string} token - Authorization token. * @returns {Promise} rolePage - A promise that resolves with a page of roles in the domain. @@ -630,7 +630,7 @@ export default class Clients { /** * @method ViewClientRole - Retrieves details about a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string} token - Authorization token. * @returns {Promise} role - A promise that resolves with the role details. @@ -659,7 +659,7 @@ export default class Clients { /** * @method UpdateClientRole - Updates the details of a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {Role} role - The role to be updated. * @param {string} token - Authorization token. @@ -691,7 +691,7 @@ export default class Clients { /** * @method DeleteClientRole - Deletes a specific role from a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the role is deleted. @@ -720,7 +720,7 @@ export default class Clients { /** * @method AddClientRoleActions - Adds actions to a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string} token - Authorization token. * @param {string[]} actions - The actions to add to the role. @@ -752,7 +752,7 @@ export default class Clients { /** * @method ListClientRoleActions - Lists all actions associated with a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string} token - Authorization token. * @returns {Promise} role actions - A promise that resolves with an array of actions. @@ -781,7 +781,7 @@ export default class Clients { /** * @method DeleteClientRoleActions - Deletes specific actions from a role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string[]} actions - The actions to delete from the role. * @param {string} token - Authorization token. @@ -813,7 +813,7 @@ export default class Clients { /** * @method DeleteAllClientRoleActions - Deletes all actions associated with a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when all actions are deleted. @@ -842,7 +842,7 @@ export default class Clients { /** * @method AddClientRoleMembers - Adds members to a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string[]} members - The IDs of the members to add. * @param {string} token - Authorization token. @@ -874,7 +874,7 @@ export default class Clients { /** * @method ListClientRoleMembers - Lists all members associated with a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string} token - Authorization token. * @returns {Promise} members - A promise that resolves with an array of member ids. @@ -905,7 +905,7 @@ export default class Clients { /** * @method DeleteClientRoleMembers - Deletes specific members from a role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string[]} members - The IDs of the members to delete. * @param {string} token - Authorization token. @@ -937,7 +937,7 @@ export default class Clients { /** * @method DeleteAllClientRoleMembers - Deletes all members associated with a specific role in a client. * @param {string} clientId - The unique identifier of the client. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} roleId - The unique identifier of the role. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when all members are deleted. diff --git a/src/journal.ts b/src/journal.ts index c81eb9b..cce8fdc 100644 --- a/src/journal.ts +++ b/src/journal.ts @@ -30,8 +30,8 @@ export default class Journal { /** * @method EntityJournals - Retrieve entity journals by entity id matching the provided query parameters. * @param {string} entityType - Entity type i.e client, channel or group. - * @param {string} entityId - The unique ID of the entity. - * @param {string} domainId - The unique ID of the domain. + * @param {string} entityId - The unique ID of the entity. + * @param {string} domainId - The unique ID of the domain. * @param {JournalsPageMetadata} queryParams - Query parameters for the request. * @param {string} token - Authorization token. * @returns {Promise} journalsPage - A page of journals. @@ -80,7 +80,7 @@ export default class Journal { /** * @method UserJournals - Retrieve user journals by user id matching the provided query parameters. - * @param {string} userId - The unique ID of the user. + * @param {string} userId - The unique ID of the user. * @param {JournalsPageMetadata} queryParams - Query parameters for the request. * @param {string} token - Authorization token. * @returns {Promise} journalsPage - A page of journals. @@ -127,10 +127,10 @@ export default class Journal { /** * @method ClientTelemetry - Retrieves client telemetry. - * @param {string} clientId - The unique ID of the client. + * @param {string} clientId - The unique ID of the client. * @param {string} token - Authorization token. - * @param {string} domainId - The unique ID of the domain. - * @returns {Promise} clientTelemetry - A client telemetry interface. + * @param {string} domainId - The unique ID of the domain. + * @returns {Promise} clientTelemetry - A client telemetry interface. * @throws {Error} - If client telemetry cannot be fetched. */ public async ClientTelemetry( diff --git a/src/messages.ts b/src/messages.ts index 2a8ebb5..74492c1 100644 --- a/src/messages.ts +++ b/src/messages.ts @@ -97,7 +97,7 @@ export default class Messages { * @param {MessagesPageMetadata} queryParams - Query parameters for the request. * @param {string} channelId - The ID of the channel to read the message from. * @param {string} token - Authorization token. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @returns {Promise} messagesPage - A page of messages. * @throws {Error} - If the messages cannot be fetched. */ diff --git a/src/re.ts b/src/re.ts index 13299ab..b9f3923 100644 --- a/src/re.ts +++ b/src/re.ts @@ -30,7 +30,7 @@ export default class Rules { /** * @method CreateRule - Creates a new rule * @param {Rule} rule - Rule object with a containing details like name, input_channel, input_topic and logic. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} rule - The created rule object. * @throws {Error} - If the rule cannot be created. @@ -67,7 +67,7 @@ export default class Rules { /** * @method ViewRule - Retrieves a rule by its id. * @param {string} ruleId - The unique ID of the rule. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} rule - The requested rule object. * @throws {Error} - If the rule cannot be fetched. @@ -106,7 +106,7 @@ export default class Rules { /** * @method ListRules - Retrieves all rules matching the provided query parameters. * @param {RulesPageMetadata} queryParams - Query parameters for the request. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} rulesPage - A page of rules. * @throws {Error} - If the rules cannot be fetched. @@ -150,7 +150,7 @@ export default class Rules { /** * @method UpdateRule - Updates an existing rule. * @param {Rule} rule - rule object with updated properties. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} rule - The updated rule object. * @throws {Error} - If the rule cannot be updated. @@ -190,7 +190,7 @@ export default class Rules { /** * @method DeleteRule - Deletes a rule. * @param {string} ruleId - The unique ID of the rule. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} response - A promise that resolves when the rule is successfully deleted. * @throws {Error} - If the rule cannot be deleted. @@ -232,7 +232,7 @@ export default class Rules { /** * @method EnableRule - Enables a previously disabled rule. * @param {string} ruleId - The unique ID of the rule. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} rule - The enabled rule object. * @throws {Error} - If the rule cannot be enabled. @@ -271,7 +271,7 @@ export default class Rules { /** * @method DisableRule - Disables a spcific rule. * @param {string} ruleId - The unique ID of the rule. - * @param {string} domainId - The unique ID of the domain. + * @param {string} domainId - The unique ID of the domain. * @param {string} token - Authorization token. * @returns {Promise} rule - The disabled rule object. * @throws {Error} - If the rule cannot be disabled.