@peeramid-labs/sdk 3.5.0 → 3.6.0

package/docs/docs/interfaces/GameMetadata.md

@@ -0,0 +1,91 @@
+# Interface: GameMetadata\<T\>
+
+Metadata for a game
+
+**`Param`**
+
+Name of the game
+
+**`Param`**
+
+Description of the game
+
+**`Param`**
+
+Image of the game
+
+**`Param`**
+
+Banner image of the game
+
+**`Param`**
+
+Featured image of the game
+
+**`Param`**
+
+Tags of the game
+
+**`Param`**
+
+Submissions allowed for the game
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`FellowshipMetadata`](../index.md#fellowshipmetadata) |
+
+## Table of contents
+
+### Properties
+
+- [name](GameMetadata.md#name)
+- [description](GameMetadata.md#description)
+- [image](GameMetadata.md#image)
+- [banner\_image](GameMetadata.md#banner_image)
+- [featured\_image](GameMetadata.md#featured_image)
+- [tags](GameMetadata.md#tags)
+- [submissions](GameMetadata.md#submissions)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+___
+
+### description
+
+• **description**: `string`
+
+___
+
+### image
+
+• `Optional` **image**: `string`
+
+___
+
+### banner\_image
+
+• `Optional` **banner\_image**: `string`
+
+___
+
+### featured\_image
+
+• `Optional` **featured\_image**: `string`
+
+___
+
+### tags
+
+• `Optional` **tags**: `string`[]
+
+___
+
+### submissions
+
+• **submissions**: `Partial`\<`T`\>[``"submissions"``]

package/docs/docs/interfaces/GmProposalParams.md

@@ -0,0 +1,41 @@
+# Interface: GmProposalParams
+
+## Table of contents
+
+### Properties
+
+- [gameId](GmProposalParams.md#gameid)
+- [encryptedProposal](GmProposalParams.md#encryptedproposal)
+- [commitment](GmProposalParams.md#commitment)
+- [proposer](GmProposalParams.md#proposer)
+- [gmSignature](GmProposalParams.md#gmsignature)
+
+## Properties
+
+### gameId
+
+• **gameId**: `bigint`
+
+___
+
+### encryptedProposal
+
+• **encryptedProposal**: `string`
+
+___
+
+### commitment
+
+• **commitment**: `bigint`
+
+___
+
+### proposer
+
+• **proposer**: \`0x$\{string}\`
+
+___
+
+### gmSignature
+
+• **gmSignature**: \`0x$\{string}\`

package/docs/docs/interfaces/Submission.md

@@ -0,0 +1,52 @@
+# Interface: Submission
+
+Represents a submission allowed for a fellowship thread
+
+**`Param`**
+
+Type of the submission
+
+**`Param`**
+
+Rules for the submission
+
+**`Param`**
+
+Custom validation rules for the submission
+
+**`Param`**
+
+Where the submission will be stored
+
+## Table of contents
+
+### Properties
+
+- [type](Submission.md#type)
+- [rules](Submission.md#rules)
+- [customValidation](Submission.md#customvalidation)
+- [store\_at](Submission.md#store_at)
+
+## Properties
+
+### type
+
+• **type**: [`SUBMISSION_TYPES`](../enums/SUBMISSION_TYPES.md)
+
+___
+
+### rules
+
+• **rules**: [`AudioRules`](../index.md#audiorules) \| [`VideoRules`](../index.md#videorules) \| [`ImageRules`](../index.md#imagerules) \| [`TextRules`](../index.md#textrules) \| [`BytesRules`](../index.md#bytesrules)
+
+___
+
+### customValidation
+
+• `Optional` **customValidation**: [`ValidationRule`](../index.md#validationrule)[]
+
+___
+
+### store\_at
+
+• **store\_at**: [`CONTENT_STORAGE`](../enums/CONTENT_STORAGE.md)