Skip to content

Commit

Permalink
fix spaces
Browse files Browse the repository at this point in the history 
Signed-off-by: wambuipixel <kiokowambui015@gmail.com>
  • Loading branch information
@wambui-pixel
wambui-pixel committed Feb 10, 2025
1 parent 9fce36d commit ad2f6a6
Show file tree
Hide file tree
Showing 7 changed files with 57 additions and 57 deletions.
18 changes: 9 additions & 9 deletions src/bootstrap.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>} response - A promise that resolves when the bootstrap configuration is created.
* @throws {Error} - If the bootstrap configuration cannot be created.
Expand Down Expand Up @@ -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>} response - A promise that resolves when the bootstrap configuration is whitelisted.
* @throws {Error} - If the bootstrap configuration cannot be whitelisted.
Expand Down Expand Up @@ -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>} response - A promise that resolves when the bootstrap configuration is updated.
* @throws {Error} - If the bootstrap configuration cannot be updated.
Expand Down Expand Up @@ -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>} bootstrapConfig - The requested bootstrap configuration object.
* @throws {Error} - If the bootstrap configuration cannot be fetched.
Expand Down Expand Up @@ -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>} bootstrapConfig - The updated bootstrap configuration.
* @throws {Error} - If the certs cannot be updated.
Expand Down Expand Up @@ -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>} response - A promise that resolves when the bootstrap configuration is deleted.
* @throws {Error} - If the bootstrap configuration cannot be deleted.
Expand Down Expand Up @@ -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>} bootstrapPage - A page of bootstrap configurations.
* @throws {Error} - If the bootstrap configurations cannot be fetched.
Expand Down Expand Up @@ -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>} response - A promise that resolves when the bootstrap configuration connection are updated.
* @throws {Error} - If the bootstrap configuration cannot be updated.
Expand Down
10 changes: 5 additions & 5 deletions src/certs.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>} cert - A promise that resolves with the certificate issued.
* @throws {Error} - If the certificate cannot be issued.
Expand Down Expand Up @@ -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>} certsPage - A page of certs.
* @throws {Error} - If the certs cannot be fetched.
Expand Down Expand Up @@ -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>} cert - The requested cert object.
* @throws {Error} - If the cert cannot be fetched.
Expand Down Expand Up @@ -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>} response - A promise that resolves when the cert is revoked.
* @throws {Error} - If the cert cannot be revoked.
Expand Down
4 changes: 2 additions & 2 deletions src/channels.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Loading

0 comments on commit ad2f6a6

Please sign in to comment.