@twin.org/hierarchies-models 0.9.0-next.1

package/docs/reference/interfaces/IHierarchiesAccreditationAddRequest.md

@@ -0,0 +1,25 @@
+# Interface: IHierarchiesAccreditationAddRequest
+
+Request to add an accreditation to a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+***
+
+### body {#body}
+
+> **body**: `Omit`\<[`IAccreditation`](IAccreditation.md), `"permissionId"`\>
+
+The request data.

package/docs/reference/interfaces/IHierarchiesAccreditationGetRequest.md

@@ -0,0 +1,29 @@
+# Interface: IHierarchiesAccreditationGetRequest
+
+Request to get federation accreditation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation to get.
+
+#### accreditedById
+
+> **accreditedById**: `string`
+
+The id of the authority for which to get the accreditation.
+
+#### permissionId
+
+> **permissionId**: `string`
+
+The id of the permission for which to get the accreditation.

package/docs/reference/interfaces/IHierarchiesAccreditationGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IHierarchiesAccreditationGetResponse
+
+Response for getting an accreditation.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IAccreditation`](IAccreditation.md)
+
+The response body.

package/docs/reference/interfaces/IHierarchiesAccreditationRemoveRequest.md

@@ -0,0 +1,29 @@
+# Interface: IHierarchiesAccreditationRemoveRequest
+
+Request to remove an accreditation from a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+#### accreditedById
+
+> **accreditedById**: `string`
+
+The accredited by id.
+
+#### permissionId
+
+> **permissionId**: `string`
+
+The permission id of the accreditation to remove.

package/docs/reference/interfaces/IHierarchiesAccreditationsGetRequest.md

@@ -0,0 +1,23 @@
+# Interface: IHierarchiesAccreditationsGetRequest
+
+Request to get federation accreditations.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation to get.
+
+#### accreditedById
+
+> **accreditedById**: `string`
+
+The id of the authority for which to get the accreditations.

package/docs/reference/interfaces/IHierarchiesAccreditationsGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IHierarchiesAccreditationsGetResponse
+
+Response for getting accreditations.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IAccreditation`](IAccreditation.md)[]
+
+The response body.

package/docs/reference/interfaces/IHierarchiesAuthorityAddRequest.md

@@ -0,0 +1,31 @@
+# Interface: IHierarchiesAuthorityAddRequest
+
+Request to add an authority to a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The request data.
+
+#### accountId
+
+> **accountId**: `string`
+
+The account id of the authority to add.

package/docs/reference/interfaces/IHierarchiesAuthorityRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IHierarchiesAuthorityRemoveRequest
+
+Request to remove an authority from a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+#### accountId
+
+> **accountId**: `string`
+
+The account id of the authority to remove.