@genesislcap/foundation-comms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0

package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md

@@ -14,55 +14,10 @@ createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDe
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-sourceRef
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The unique source reference.
-
-
-</td></tr>
-<tr><td>
-
-viewNumber
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The desired view number. Default: the first view.
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sourceRef | string | The unique source reference. |
+|  viewNumber | number | _(Optional)_ The desired view number. Default: the first view. |
 
 **Returns:**
 

package/docs/api/foundation-comms.messagebuilder.createrequestmessage.md

@@ -14,55 +14,10 @@ createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Mes
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-resourceName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The resource name.
-
-
-</td></tr>
-<tr><td>
-
-params
-
-
-</td><td>
-
-[RequestParams](./foundation-comms.requestparams.md)
-
-
-</td><td>
-
-_(Optional)_ The additional parameters.
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The resource name. |
+|  params | [RequestParams](./foundation-comms.requestparams.md) | _(Optional)_ The additional parameters. |
 
 **Returns:**
 

package/docs/api/foundation-comms.messagebuilder.createresourcesmessage.md

@@ -14,39 +14,9 @@ createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-[RequestParams](./foundation-comms.requestparams.md)
-
-
-</td><td>
-
-_(Optional)_ The additional parameters.
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | [RequestParams](./foundation-comms.requestparams.md) | _(Optional)_ The additional parameters. |
 
 **Returns:**
 

package/docs/api/foundation-comms.messagebuilder.md

@@ -14,190 +14,22 @@ export interface MessageBuilder
 
 ## Methods
 
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[createChangePasswordMessage(username, oldPassword, newPassword)](./foundation-comms.messagebuilder.createchangepasswordmessage.md)
-
-
-</td><td>
-
-Creates a change password message.
-
-
-</td></tr>
-<tr><td>
-
-[createCommitMessage(eventName, params)](./foundation-comms.messagebuilder.createcommitmessage.md)
-
-
-</td><td>
-
-Creates an event commit message.
-
-
-</td></tr>
-<tr><td>
-
-[createDataLogoffMessage(sourceRef)](./foundation-comms.messagebuilder.createdatalogoffmessage.md)
-
-
-</td><td>
-
-Creates a message to logoff from a DATASERVER.
-
-
-</td></tr>
-<tr><td>
-
-[createDataLogonMessage(resourceName, params)](./foundation-comms.messagebuilder.createdatalogonmessage.md)
-
-
-</td><td>
-
-Creates a message to logon to a DATASERVER. Used for data fetching.
-
-
-</td></tr>
-<tr><td>
-
-[createForgotPasswordMessage(username, returnUrl, requester)](./foundation-comms.messagebuilder.createforgotpasswordmessage.md)
-
-
-</td><td>
-
-Creates a forgot password message.
-
-
-</td></tr>
-<tr><td>
-
-[createForgotPasswordTokenMessage(username, resetToken, newPassword, requester)](./foundation-comms.messagebuilder.createforgotpasswordtokenmessage.md)
-
-
-</td><td>
-
-Creates a forgot password token message.
-
-
-</td></tr>
-<tr><td>
-
-[createHeartbeatPingMessage(verbose)](./foundation-comms.messagebuilder.createheartbeatpingmessage.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[createHTTPHeadersFromMessage(message, contentType)](./foundation-comms.messagebuilder.createhttpheadersfrommessage.md)
-
-
-</td><td>
-
-Create HTTP Headers from a message.
-
-
-</td></tr>
-<tr><td>
-
-[createLoginMessage(credentials)](./foundation-comms.messagebuilder.createloginmessage.md)
-
-
-</td><td>
-
-Creates a login message.
-
-
-</td></tr>
-<tr><td>
-
-[createLogoutMessage(loginResult)](./foundation-comms.messagebuilder.createlogoutmessage.md)
-
-
-</td><td>
-
-Creates a logout message.
-
-
-</td></tr>
-<tr><td>
-
-[createMetaRequestMessage(resourceName, messageType)](./foundation-comms.messagebuilder.createmetarequestmessage.md)
-
-
-</td><td>
-
-Creates a metadata fetch message.
-
-
-</td></tr>
-<tr><td>
-
-[createMoreColumnsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorecolumnsmessage.md)
-
-
-</td><td>
-
-Creates a message to request more columns.
-
-
-</td></tr>
-<tr><td>
-
-[createMoreRowsMessage(sourceRef, viewNumber)](./foundation-comms.messagebuilder.createmorerowsmessage.md)
-
-
-</td><td>
-
-Creates a message to request more rows. This is only relevant when you are connected to a real-time (Data Server) datasource.
-
-
-</td></tr>
-<tr><td>
-
-[createRefreshTokenMessage()](./foundation-comms.messagebuilder.createrefreshtokenmessage.md)
-
-
-</td><td>
-
-Creates an auth message specific for token refresh.
-
-
-</td></tr>
-<tr><td>
-
-[createRequestMessage(resourceName, params)](./foundation-comms.messagebuilder.createrequestmessage.md)
-
-
-</td><td>
-
-Creates a request message.
-
-
-</td></tr>
-<tr><td>
-
-[createResourcesMessage(params)](./foundation-comms.messagebuilder.createresourcesmessage.md)
-
-
-</td><td>
-
-Creates a message for getting list of resources.
-
-
-</td></tr>
-</tbody></table>
+|  Method | Description |
+|  --- | --- |
+|  [createChangePasswordMessage(username, oldPassword, newPassword)](./foundation-comms.messagebuilder.createchangepasswordmessage.md) | Creates a change password message. |
+|  [createCommitMessage(eventName, params)](./foundation-comms.messagebuilder.createcommitmessage.md) | Creates an event commit message. |
+|  [createDataLogoffMessage(sourceRef)](./foundation-comms.messagebuilder.createdatalogoffmessage.md) | Creates a message to logoff from a DATASERVER. |
+|  [createDataLogonMessage(resourceName, params)](./foundation-comms.messagebuilder.createdatalogonmessage.md) | Creates a message to logon to a DATASERVER. Used for data fetching. |
+|  [createForgotPasswordMessage(username, returnUrl, requester)](./foundation-comms.messagebuilder.createforgotpasswordmessage.md) | Creates a forgot password message. |
+|  [createForgotPasswordTokenMessage(username, resetToken, newPassword, requester)](./foundation-comms.messagebuilder.createforgotpasswordtokenmessage.md) | Creates a forgot password token message. |
+|  [createHeartbeatPingMessage(verbose)](./foundation-comms.messagebuilder.createheartbeatpingmessage.md) |  |
+|  [createHTTPHeadersFromMessage(message, contentType)](./foundation-comms.messagebuilder.createhttpheadersfrommessage.md) | Create HTTP Headers from a message. |
+|  [createLoginMessage(credentials)](./foundation-comms.messagebuilder.createloginmessage.md) | Creates a login message. |
+|  [createLogoutMessage(loginResult)](./foundation-comms.messagebuilder.createlogoutmessage.md) | Creates a logout message. |
+|  [createMetaRequestMessage(resourceName, messageType)](./foundation-comms.messagebuilder.createmetarequestmessage.md) | Creates a metadata fetch message. |
+|  [createMoreColumnsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorecolumnsmessage.md) | Creates a message to request more columns. |
+|  [createMoreRowsMessage(sourceRef, viewNumber)](./foundation-comms.messagebuilder.createmorerowsmessage.md) | Creates a message to request more rows. This is only relevant when you are connected to a real-time (Data Server) datasource. |
+|  [createRefreshTokenMessage()](./foundation-comms.messagebuilder.createrefreshtokenmessage.md) | Creates an auth message specific for token refresh. |
+|  [createRequestMessage(resourceName, params)](./foundation-comms.messagebuilder.createrequestmessage.md) | Creates a request message. |
+|  [createResourcesMessage(params)](./foundation-comms.messagebuilder.createresourcesmessage.md) | Creates a message for getting list of resources. |
 

package/docs/api/foundation-comms.messagecode.md

@@ -14,49 +14,8 @@ export declare enum MessageCode
 
 ## Enumeration Members
 
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-SESSION\_NOT\_FOUND
-
-
-</td><td>
-
-`"SESSION_NOT_FOUND"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-UNKNOWN\_MESSAGE\_TYPE
-
-
-</td><td>
-
-`"UNKNOWN_MESSAGE_TYPE"`
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  SESSION\_NOT\_FOUND | <code>&quot;SESSION_NOT_FOUND&quot;</code> |  |
+|  UNKNOWN\_MESSAGE\_TYPE | <code>&quot;UNKNOWN_MESSAGE_TYPE&quot;</code> |  |
 

package/docs/api/foundation-comms.messagedetails.md

@@ -14,192 +14,22 @@ export declare namespace MessageDetails
 
 ## Type Aliases
 
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ChangePassword](./foundation-comms.messagedetails.changepassword.md)
-
-
-</td><td>
-
-Details type for a password-change message
-
-
-</td></tr>
-<tr><td>
-
-[DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)
-
-
-</td><td>
-
-Details type to request DATASERVER metadata
-
-
-</td></tr>
-<tr><td>
-
-[Error](./foundation-comms.messagedetails.error.md)
-
-
-</td><td>
-
-Details type for ERROR results
-
-
-</td></tr>
-<tr><td>
-
-[ExpirePassword](./foundation-comms.messagedetails.expirepassword.md)
-
-
-</td><td>
-
-Details type for a password-expiry message
-
-
-</td></tr>
-<tr><td>
-
-[ForgotPassword](./foundation-comms.messagedetails.forgotpassword.md)
-
-
-</td><td>
-
-Details type for a forgot-password message
-
-
-</td></tr>
-<tr><td>
-
-[ForgotPasswordToken](./foundation-comms.messagedetails.forgotpasswordtoken.md)
-
-
-</td><td>
-
-Details type for a forgot-password token-based message
-
-
-</td></tr>
-<tr><td>
-
-[LoggedInSystemInfo](./foundation-comms.messagedetails.loggedinsysteminfo.md)
-
-
-</td><td>
-
-System-level information when a user is logged in.
-
-
-</td></tr>
-<tr><td>
-
-[Login](./foundation-comms.messagedetails.login.md)
-
-
-</td><td>
-
-Union type for different types of login information
-
-
-</td></tr>
-<tr><td>
-
-[LoginBasic](./foundation-comms.messagedetails.loginbasic.md)
-
-
-</td><td>
-
-Details type for a basic auth message
-
-
-</td></tr>
-<tr><td>
-
-[LoginJWT](./foundation-comms.messagedetails.loginjwt.md)
-
-
-</td><td>
-
-Details type for a JWT-based auth message
-
-
-</td></tr>
-<tr><td>
-
-[LoginSSO](./foundation-comms.messagedetails.loginsso.md)
-
-
-</td><td>
-
-Details type for a SSO-based auth message
-
-
-</td></tr>
-<tr><td>
-
-[MetaRequest](./foundation-comms.messagedetails.metarequest.md)
-
-
-</td><td>
-
-Details type to request FEATURE metadata
-
-
-</td></tr>
-<tr><td>
-
-[MoreRows](./foundation-comms.messagedetails.morerows.md)
-
-
-</td><td>
-
-Details type to request more rows
-
-
-</td></tr>
-<tr><td>
-
-[RefreshToken](./foundation-comms.messagedetails.refreshtoken.md)
-
-
-</td><td>
-
-Details type for a refresh-token message
-
-
-</td></tr>
-<tr><td>
-
-[ResetPassword](./foundation-comms.messagedetails.resetpassword.md)
-
-
-</td><td>
-
-Details type for a password-reset message
-
-
-</td></tr>
-<tr><td>
-
-[UpdateColumns](./foundation-comms.messagedetails.updatecolumns.md)
-
-
-</td><td>
-
-Details type to update columns
-
-
-</td></tr>
-</tbody></table>
+|  Type Alias | Description |
+|  --- | --- |
+|  [ChangePassword](./foundation-comms.messagedetails.changepassword.md) | Details type for a password-change message |
+|  [DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md) | Details type to request DATASERVER metadata |
+|  [Error](./foundation-comms.messagedetails.error.md) | Details type for ERROR results |
+|  [ExpirePassword](./foundation-comms.messagedetails.expirepassword.md) | Details type for a password-expiry message |
+|  [ForgotPassword](./foundation-comms.messagedetails.forgotpassword.md) | Details type for a forgot-password message |
+|  [ForgotPasswordToken](./foundation-comms.messagedetails.forgotpasswordtoken.md) | Details type for a forgot-password token-based message |
+|  [LoggedInSystemInfo](./foundation-comms.messagedetails.loggedinsysteminfo.md) | System-level information when a user is logged in. |
+|  [Login](./foundation-comms.messagedetails.login.md) | Union type for different types of login information |
+|  [LoginBasic](./foundation-comms.messagedetails.loginbasic.md) | Details type for a basic auth message |
+|  [LoginJWT](./foundation-comms.messagedetails.loginjwt.md) | Details type for a JWT-based auth message |
+|  [LoginSSO](./foundation-comms.messagedetails.loginsso.md) | Details type for a SSO-based auth message |
+|  [MetaRequest](./foundation-comms.messagedetails.metarequest.md) | Details type to request FEATURE metadata |
+|  [MoreRows](./foundation-comms.messagedetails.morerows.md) | Details type to request more rows |
+|  [RefreshToken](./foundation-comms.messagedetails.refreshtoken.md) | Details type for a refresh-token message |
+|  [ResetPassword](./foundation-comms.messagedetails.resetpassword.md) | Details type for a password-reset message |
+|  [UpdateColumns](./foundation-comms.messagedetails.updatecolumns.md) | Details type to update columns |
 

package/docs/api/foundation-comms.messagehaserrorcode.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md)
 
-## messageHasErrorCode() function
+## messageHasErrorCode variable
 
 Check if the message contains an error code.
 
@@ -11,60 +11,3 @@ Check if the message contains an error code.
 ```typescript
 messageHasErrorCode: (message: Message, code: string | number) => boolean
 ```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-[Message](./foundation-comms.message.md)
-
-
-</td><td>
-
-The message object.
-
-
-</td></tr>
-<tr><td>
-
-code
-
-
-</td><td>
-
-string \| number
-
-
-</td><td>
-
-The error code. Either a  number or an entire status code string.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-