chore: generate docs

JoinColony · Jun 20, 2024 · 8b11a2f · 8b11a2f
1 parent 587fb30
commit 8b11a2f
Show file tree

Hide file tree

Showing 21 changed files with 447 additions and 16,089 deletions.
diff --git a/packages/colony-js/docs/api/README.md b/packages/colony-js/docs/api/README.md
@@ -36,7 +36,6 @@
 
 ## Interfaces
 
-- [ColonyClientV10](interfaces/ColonyClientV10.md)
 - [ColonyClientV11](interfaces/ColonyClientV11.md)
 - [ColonyClientV12](interfaces/ColonyClientV12.md)
 - [ColonyClientV13](interfaces/ColonyClientV13.md)
@@ -66,10 +65,7 @@
 - [StakedExpenditureClientV3](interfaces/StakedExpenditureClientV3.md)
 - [StakedExpenditureClientV4](interfaces/StakedExpenditureClientV4.md)
 - [StakedExpenditureClientV5](interfaces/StakedExpenditureClientV5.md)
-- [StreamingPaymentsClientV1](interfaces/StreamingPaymentsClientV1.md)
-- [StreamingPaymentsClientV2](interfaces/StreamingPaymentsClientV2.md)
-- [StreamingPaymentsClientV3](interfaces/StreamingPaymentsClientV3.md)
-- [StreamingPaymentsClientV4](interfaces/StreamingPaymentsClientV4.md)
+- [StreamingPaymentsClientV5](interfaces/StreamingPaymentsClientV5.md)
 - [Token](interfaces/Token.md)
 - [TokenAuthority](interfaces/TokenAuthority.md)
 - [TokenLocking](interfaces/TokenLocking.md)
@@ -121,7 +117,7 @@ Re-exports [Token__factory](classes/factories.Token__factory.md)
 
 ### AnyColonyClient
 
-Ƭ **AnyColonyClient**: [`ColonyClientV10`](interfaces/ColonyClientV10.md) \| [`ColonyClientV11`](interfaces/ColonyClientV11.md) \| [`ColonyClientV12`](interfaces/ColonyClientV12.md) \| [`ColonyClientV13`](interfaces/ColonyClientV13.md) \| [`ColonyClientV14`](interfaces/ColonyClientV14.md) \| [`ColonyClientV15`](interfaces/ColonyClientV15.md)
+Ƭ **AnyColonyClient**: [`ColonyClientV11`](interfaces/ColonyClientV11.md) \| [`ColonyClientV12`](interfaces/ColonyClientV12.md) \| [`ColonyClientV13`](interfaces/ColonyClientV13.md) \| [`ColonyClientV14`](interfaces/ColonyClientV14.md) \| [`ColonyClientV15`](interfaces/ColonyClientV15.md)
 
 ___
 
@@ -145,7 +141,7 @@ ___
 
 ### AnyStreamingPaymentsClient
 
-Ƭ **AnyStreamingPaymentsClient**: [`StreamingPaymentsClientV1`](interfaces/StreamingPaymentsClientV1.md) \| [`StreamingPaymentsClientV2`](interfaces/StreamingPaymentsClientV2.md) \| [`StreamingPaymentsClientV3`](interfaces/StreamingPaymentsClientV3.md) \| [`StreamingPaymentsClientV4`](interfaces/StreamingPaymentsClientV4.md)
+Ƭ **AnyStreamingPaymentsClient**: [`StreamingPaymentsClientV5`](interfaces/StreamingPaymentsClientV5.md)
 
 ___
 
@@ -343,7 +339,7 @@ Latest versions of all extension contracts
 | `ReputationBootstrapper` | ``1`` \| ``2`` \| ``3`` \| ``4`` |
 | `StagedExpenditure` | ``1`` \| ``2`` |
 | `StakedExpenditure` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` |
-| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` |
+| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` |
 | `TokenSupplier` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` |
 | `VotingReputation` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
 

diff --git a/packages/colony-js/docs/api/classes/ColonyFactory.md b/packages/colony-js/docs/api/classes/ColonyFactory.md
diff --git a/packages/colony-js/docs/api/classes/ColonyTokenFactory.md b/packages/colony-js/docs/api/classes/ColonyTokenFactory.md
diff --git a/packages/colony-js/docs/api/interfaces/ColonyClientV10.md b/packages/colony-js/docs/api/interfaces/ColonyClientV10.md
diff --git a/packages/colony-js/docs/api/interfaces/ColonyClientV15.md b/packages/colony-js/docs/api/interfaces/ColonyClientV15.md
@@ -5650,70 +5650,6 @@ ColonyAugmentsV5.setExpenditureStateWithProofs
 
 ___
 
-### setExpenditureValues
-
-▸ **setExpenditureValues**(`_id`, `_recipientSlots`, `_recipients`, `_skillIdSlots`, `_skillIds`, `_claimDelaySlots`, `_claimDelays`, `_payoutModifierSlots`, `_payoutModifiers`, `_payoutTokens`, `_payoutSlots`, `_payoutValues`, `overrides?`): `Promise`<`ContractTransaction`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `_id` | `BigNumberish` |
-| `_recipientSlots` | `BigNumberish`[] |
-| `_recipients` | `string`[] |
-| `_skillIdSlots` | `BigNumberish`[] |
-| `_skillIds` | `BigNumberish`[] |
-| `_claimDelaySlots` | `BigNumberish`[] |
-| `_claimDelays` | `BigNumberish`[] |
-| `_payoutModifierSlots` | `BigNumberish`[] |
-| `_payoutModifiers` | `BigNumberish`[] |
-| `_payoutTokens` | `string`[] |
-| `_payoutSlots` | `BigNumberish`[][] |
-| `_payoutValues` | `BigNumberish`[][] |
-| `overrides?` | `Overrides` & { `from?`: `string`  } |
-
-#### Returns
-
-`Promise`<`ContractTransaction`\>
-
-#### Inherited from
-
-AugmentedIColony.setExpenditureValues
-
-___
-
-### setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][])
-
-▸ **setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][])**(`_id`, `_recipientSlots`, `_recipients`, `_skillIdSlots`, `_skillIds`, `_claimDelaySlots`, `_claimDelays`, `_payoutModifierSlots`, `_payoutModifiers`, `_payoutTokens`, `_payoutSlots`, `_payoutValues`, `overrides?`): `Promise`<`ContractTransaction`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `_id` | `BigNumberish` |
-| `_recipientSlots` | `BigNumberish`[] |
-| `_recipients` | `string`[] |
-| `_skillIdSlots` | `BigNumberish`[] |
-| `_skillIds` | `BigNumberish`[] |
-| `_claimDelaySlots` | `BigNumberish`[] |
-| `_claimDelays` | `BigNumberish`[] |
-| `_payoutModifierSlots` | `BigNumberish`[] |
-| `_payoutModifiers` | `BigNumberish`[] |
-| `_payoutTokens` | `string`[] |
-| `_payoutSlots` | `BigNumberish`[][] |
-| `_payoutValues` | `BigNumberish`[][] |
-| `overrides?` | `Overrides` & { `from?`: `string`  } |
-
-#### Returns
-
-`Promise`<`ContractTransaction`\>
-
-#### Inherited from
-
-AugmentedIColony.setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][])
-
-___
-
 ### setFundingRole
 
 ▸ **setFundingRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\>
@@ -6736,6 +6672,52 @@ AugmentedIColony.userCanSetRoles(address,uint256,uint256,uint256)
 
 ___
 
+### validateDomainInheritance
+
+▸ **validateDomainInheritance**(`_permissionDomainId`, `_childSkillIndex`, `_childDomainId`, `overrides?`): `Promise`<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `_permissionDomainId` | `BigNumberish` |
+| `_childSkillIndex` | `BigNumberish` |
+| `_childDomainId` | `BigNumberish` |
+| `overrides?` | `CallOverrides` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Inherited from
+
+AugmentedIColony.validateDomainInheritance
+
+___
+
+### validateDomainInheritance(uint256,uint256,uint256)
+
+▸ **validateDomainInheritance(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_childDomainId`, `overrides?`): `Promise`<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `_permissionDomainId` | `BigNumberish` |
+| `_childSkillIndex` | `BigNumberish` |
+| `_childDomainId` | `BigNumberish` |
+| `overrides?` | `CallOverrides` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Inherited from
+
+AugmentedIColony.validateDomainInheritance(uint256,uint256,uint256)
+
+___
+
 ### verifyReputationProof
 
 ▸ **verifyReputationProof**(`key`, `value`, `branchMask`, `siblings`, `overrides?`): `Promise`<`boolean`\>