@twin.org/immutable-proof-rest-client 0.0.1-next.24 → 0.0.1-next.26

package/dist/cjs/index.cjs

@@ -22,21 +22,21 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
         super("ImmutableProofClient", config, "immutable-proof");
     }
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
-     * @returns The id of the new authentication proof.
+     * Create a new proof.
+     * @param document The document to create the proof for.
+     * @returns The id of the new proof.
      */
-    async create(proofObject) {
-        core.Guards.object(this.CLASS_NAME, "proofObject", proofObject);
+    async create(document) {
+        core.Guards.object(this.CLASS_NAME, "document", document);
         const response = await this.fetch("/", "POST", {
             body: {
-                proofObject
+                document
             }
         });
         return response.headers[web.HeaderTypes.Location];
     }
     /**
-     * Get an authentication proof.
+     * Get a proof.
      * @param id The id of the proof to get.
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
@@ -54,7 +54,7 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
         return response.body;
     }
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.

package/dist/esm/index.mjs

@@ -20,21 +20,21 @@ class ImmutableProofClient extends BaseRestClient {
         super("ImmutableProofClient", config, "immutable-proof");
     }
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
-     * @returns The id of the new authentication proof.
+     * Create a new proof.
+     * @param document The document to create the proof for.
+     * @returns The id of the new proof.
      */
-    async create(proofObject) {
-        Guards.object(this.CLASS_NAME, "proofObject", proofObject);
+    async create(document) {
+        Guards.object(this.CLASS_NAME, "document", document);
         const response = await this.fetch("/", "POST", {
             body: {
-                proofObject
+                document
             }
         });
         return response.headers[HeaderTypes.Location];
     }
     /**
-     * Get an authentication proof.
+     * Get a proof.
      * @param id The id of the proof to get.
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
@@ -52,7 +52,7 @@ class ImmutableProofClient extends BaseRestClient {
         return response.body;
     }
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.

package/dist/types/immutableProofClient.d.ts

@@ -16,20 +16,20 @@ export declare class ImmutableProofClient extends BaseRestClient implements IImm
      */
     constructor(config: IBaseRestClientConfig);
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
-     * @returns The id of the new authentication proof.
+     * Create a new proof.
+     * @param document The document to create the proof for.
+     * @returns The id of the new proof.
      */
-    create(proofObject: IJsonLdNodeObject): Promise<string>;
+    create(document: IJsonLdNodeObject): Promise<string>;
     /**
-     * Get an authentication proof.
+     * Get a proof.
      * @param id The id of the proof to get.
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
      */
     get(id: string): Promise<IImmutableProof>;
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/immutable-proof-rest-client - Changelog
 
-## v0.0.1-next.24
+## v0.0.1-next.26
 
 - Initial Release

package/docs/reference/classes/ImmutableProofClient.md

@@ -50,23 +50,23 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`proofObject`): `Promise`\<`string`\>
+> **create**(`document`): `Promise`\<`string`\>
 
-Create a new authentication proof.
+Create a new proof.
 
 #### Parameters
 
-##### proofObject
+##### document
 
 `IJsonLdNodeObject`
 
-The object for the proof as JSON-LD.
+The document to create the proof for.
 
 #### Returns
 
 `Promise`\<`string`\>
 
-The id of the new authentication proof.
+The id of the new proof.
 
 #### Implementation of
 
@@ -78,7 +78,7 @@ The id of the new authentication proof.
 
 > **get**(`id`): `Promise`\<`IImmutableProof`\>
 
-Get an authentication proof.
+Get a proof.
 
 #### Parameters
 
@@ -108,7 +108,7 @@ NotFoundError if the proof is not found.
 
 > **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
 
-Verify an authentication proof.
+Verify a proof.
 
 #### Parameters
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-rest-client",
-	"version": "0.0.1-next.24",
+	"version": "0.0.1-next.26",
 	"description": "Immutable Proof contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -19,7 +19,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/immutable-proof-models": "0.0.1-next.24",
+		"@twin.org/immutable-proof-models": "0.0.1-next.26",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},