@twin.org/identity-models 0.0.1-next.55 → 0.0.1-next.57

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export * from "./models/api/identity/IIdentityProofCreateRequest";
 export * from "./models/api/identity/IIdentityProofCreateResponse";
 export * from "./models/api/identity/IIdentityProofVerifyRequest";
 export * from "./models/api/identity/IIdentityProofVerifyResponse";
+export * from "./models/api/identity/IIdentityRemoveRequest";
 export * from "./models/api/identity/IIdentityServiceCreateRequest";
 export * from "./models/api/identity/IIdentityServiceCreateResponse";
 export * from "./models/api/identity/IIdentityServiceRemoveRequest";

package/dist/types/models/IIdentityComponent.d.ts

@@ -12,6 +12,13 @@ export interface IIdentityComponent extends IComponent {
      * @returns The created identity document.
      */
     identityCreate(namespace?: string, controller?: string): Promise<IDidDocument>;
+    /**
+     * Remove an identity.
+     * @param identity The id of the document to remove.
+     * @param controller The controller of the identity who can make changes.
+     * @returns Nothing.
+     */
+    identityRemove(identity: string, controller?: string): Promise<void>;
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param identity The id of the document to add the verification method to.

package/dist/types/models/IIdentityConnector.d.ts

@@ -11,6 +11,13 @@ export interface IIdentityConnector extends IComponent {
      * @returns The created document.
      */
     createDocument(controller: string): Promise<IDidDocument>;
+    /**
+     * Remove a document.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to remove.
+     * @returns Nothing.
+     */
+    removeDocument(controller: string, documentId: string): Promise<void>;
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param controller The controller of the identity who can make changes.

package/dist/types/models/api/identity/IIdentityRemoveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Request to remove an identity.
+ */
+export interface IIdentityRemoveRequest {
+    /**
+     * The data for the request.
+     */
+    pathParams: {
+        /**
+         * The identity to remove.
+         */
+        identity: string;
+    };
+}

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/identity-service-models - Changelog
 
+## [0.0.1-next.57](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.1-next.56...identity-models-v0.0.1-next.57) (2025-07-08)
+
+
+### Features
+
+* add identity remove ([eebc13f](https://github.com/twinfoundation/identity/commit/eebc13f4c2cd994d2d9cce4da2128fb346c80ba7))
+
+## [0.0.1-next.56](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.1-next.55...identity-models-v0.0.1-next.56) (2025-06-30)
+
+
+### Miscellaneous Chores
+
+* **identity-models:** Synchronize repo versions
+
 ## [0.0.1-next.55](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.1-next.54...identity-models-v0.0.1-next.55) (2025-06-26)
 
 

package/docs/reference/index.md

@@ -19,6 +19,7 @@
 - [IIdentityProofCreateResponse](interfaces/IIdentityProofCreateResponse.md)
 - [IIdentityProofVerifyRequest](interfaces/IIdentityProofVerifyRequest.md)
 - [IIdentityProofVerifyResponse](interfaces/IIdentityProofVerifyResponse.md)
+- [IIdentityRemoveRequest](interfaces/IIdentityRemoveRequest.md)
 - [IIdentityServiceCreateRequest](interfaces/IIdentityServiceCreateRequest.md)
 - [IIdentityServiceCreateResponse](interfaces/IIdentityServiceCreateResponse.md)
 - [IIdentityServiceRemoveRequest](interfaces/IIdentityServiceRemoveRequest.md)

package/docs/reference/interfaces/IIdentityComponent.md

@@ -36,6 +36,34 @@ The created identity document.
 
 ***
 
+### identityRemove()
+
+> **identityRemove**(`identity`, `controller?`): `Promise`\<`void`\>
+
+Remove an identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The id of the document to remove.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
 ### verificationMethodCreate()
 
 > **verificationMethodCreate**(`identity`, `verificationMethodType`, `verificationMethodId?`, `controller?`): `Promise`\<`IDidDocumentVerificationMethod`\>

package/docs/reference/interfaces/IIdentityConnector.md

@@ -30,6 +30,34 @@ The created document.
 
 ***
 
+### removeDocument()
+
+> **removeDocument**(`controller`, `documentId`): `Promise`\<`void`\>
+
+Remove a document.
+
+#### Parameters
+
+##### controller
+
+`string`
+
+The controller of the identity who can make changes.
+
+##### documentId
+
+`string`
+
+The id of the document to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
 ### addVerificationMethod()
 
 > **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId?`): `Promise`\<`IDidDocumentVerificationMethod`\>

package/docs/reference/interfaces/IIdentityRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityRemoveRequest
+
+Request to remove an identity.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The data for the request.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to remove.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.1-next.55",
+	"version": "0.0.1-next.57",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",