@peeramid-labs/sdk 2.0.2 → 2.0.3

package/docs/docs/classes/MultipassBase.md

@@ -1,217 +0,0 @@
-# Class: MultipassBase
-
-Base class for Multipass functionality
-
-## Hierarchy
-
-- **`MultipassBase`**
-
-  ↳ [`Multipass`](Multipass.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](MultipassBase.md#constructor)
-
-### Properties
-
-- [chainId](MultipassBase.md#chainid)
-
-### Methods
-
-- [getDappURL](MultipassBase.md#getdappurl)
-- [getRegistrarMessage](MultipassBase.md#getregistrarmessage)
-- [formQueryByAddress](MultipassBase.md#formquerybyaddress)
-- [formQueryById](MultipassBase.md#formquerybyid)
-- [formQueryByUsername](MultipassBase.md#formquerybyusername)
-- [formQueryByUsernameAndId](MultipassBase.md#formquerybyusernameandid)
-- [formQueryByFullDetails](MultipassBase.md#formquerybyfulldetails)
-
-## Constructors
-
-### constructor
-
-• **new MultipassBase**(`params`): [`MultipassBase`](MultipassBase.md)
-
-Creates a new MultipassBase instance
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `params` | `Object` | Constructor parameters |
-| `params.chainId` | `number` | ID of the blockchain network |
-
-#### Returns
-
-[`MultipassBase`](MultipassBase.md)
-
-## Properties
-
-### chainId
-
-• **chainId**: `number`
-
-Chain ID for the network
-
-## Methods
-
-### getDappURL
-
-▸ **getDappURL**(`message`, `signature`, `basepath`, `contractAddress`): `string`
-
-Generates a URL for a dapp
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `message` | `object` | Message object to be encoded in the URL |
-| `signature` | `string` | Signature to be encoded in the URL |
-| `basepath` | `string` | Base path of the URL |
-| `contractAddress` | `string` | Address of the contract |
-
-#### Returns
-
-`string`
-
-The generated URL
-
-___
-
-### getRegistrarMessage
-
-▸ **getRegistrarMessage**(`«destructured»`): [`RegisterMessage`](../interfaces/RegisterMessage.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `«destructured»` | `Object` |
-| › `username` | `string` |
-| › `id` | `string` |
-| › `domainName` | `string` |
-| › `validUntil` | `number` |
-
-#### Returns
-
-[`RegisterMessage`](../interfaces/RegisterMessage.md)
-
-___
-
-### formQueryByAddress
-
-▸ **formQueryByAddress**(`params`): [`NameQuery`](../index.md#namequery)
-
-Creates a name query by address
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `params` | `Object` | Parameters for creating the query |
-| `params.address` | `string` | Address to be encoded in the query |
-| `params.domainName` | `string` | Domain name to be encoded in the query |
-| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
-
-#### Returns
-
-[`NameQuery`](../index.md#namequery)
-
-The generated name query
-
-___
-
-### formQueryById
-
-▸ **formQueryById**(`params`): [`NameQuery`](../index.md#namequery)
-
-Creates a name query by ID
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `params` | `Object` | Parameters for creating the query |
-| `params.id` | `string` | ID to be encoded in the query |
-| `params.domainName` | `string` | Domain name to be encoded in the query |
-| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
-
-#### Returns
-
-[`NameQuery`](../index.md#namequery)
-
-The generated name query
-
-___
-
-### formQueryByUsername
-
-▸ **formQueryByUsername**(`params`): [`NameQuery`](../index.md#namequery)
-
-Creates a name query by username
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `params` | `Object` | Parameters for creating the query |
-| `params.username` | `string` | Username to be encoded in the query |
-| `params.domainName` | `string` | Domain name to be encoded in the query |
-| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
-
-#### Returns
-
-[`NameQuery`](../index.md#namequery)
-
-The generated name query
-
-___
-
-### formQueryByUsernameAndId
-
-▸ **formQueryByUsernameAndId**(`params`): [`NameQuery`](../index.md#namequery)
-
-Creates a name query by username and ID
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `params` | `Object` | Parameters for creating the query |
-| `params.username` | `string` | Username to be encoded in the query |
-| `params.id` | `string` | ID to be encoded in the query |
-| `params.domainName` | `string` | Domain name to be encoded in the query |
-| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
-
-#### Returns
-
-[`NameQuery`](../index.md#namequery)
-
-The generated name query
-
-___
-
-### formQueryByFullDetails
-
-▸ **formQueryByFullDetails**(`params`): [`NameQuery`](../index.md#namequery)
-
-Creates a name query with full details
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `params` | `Object` | Parameters for creating the query |
-| `params.username` | `string` | Username to be encoded in the query |
-| `params.id` | `string` | ID to be encoded in the query |
-| `params.domainName` | `string` | Domain name to be encoded in the query |
-| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
-| `params.address` | `string` | Address to be encoded in the query |
-
-#### Returns
-
-[`NameQuery`](../index.md#namequery)
-
-The generated name query

package/docs/docs/enums/SearchCriteria.md

@@ -1,29 +0,0 @@
-# Enumeration: SearchCriteria
-
-Criteria used for searching entities in the system
-
-## Table of contents
-
-### Enumeration Members
-
-- [id](SearchCriteria.md#id)
-- [username](SearchCriteria.md#username)
-- [address](SearchCriteria.md#address)
-
-## Enumeration Members
-
-### id
-
-• **id** = ``0``
-
-___
-
-### username
-
-• **username** = ``1``
-
-___
-
-### address
-
-• **address** = ``2``

package/docs/docs/enums/gameStatusEnum.md

@@ -1,71 +0,0 @@
-# Enumeration: gameStatusEnum
-
-Enum representing different states of a game instance
-
-## Table of contents
-
-### Enumeration Members
-
-- [created](gameStatusEnum.md#created)
-- [open](gameStatusEnum.md#open)
-- [started](gameStatusEnum.md#started)
-- [lastTurn](gameStatusEnum.md#lastturn)
-- [overtime](gameStatusEnum.md#overtime)
-- [finished](gameStatusEnum.md#finished)
-- [notFound](gameStatusEnum.md#notfound)
-
-## Enumeration Members
-
-### created
-
-• **created** = ``"Game created"``
-
-Game has been created but not opened for registration
-
-___
-
-### open
-
-• **open** = ``"Registration open"``
-
-Game is open for player registration
-
-___
-
-### started
-
-• **started** = ``"In progress"``
-
-Game is in progress
-
-___
-
-### lastTurn
-
-• **lastTurn** = ``"Playing last turn"``
-
-Game is in its final turn
-
-___
-
-### overtime
-
-• **overtime** = ``"PLaying in overtime"``
-
-Game is in overtime
-
-___
-
-### finished
-
-• **finished** = ``"Finished"``
-
-Game has finished
-
-___
-
-### notFound
-
-• **notFound** = ``"not found"``
-
-Game was not found