@aceplus/smartace-api 2.12.0 → 2.13.0-alpha.10

package/README.md

@@ -19,12 +19,16 @@ To use the SmartAce Api in node you will need the following dependencies
 
 ```
 
+Frontend: [https://saas.tkf-aceplus.com/](https://saas.tkf-aceplus.com/)
+Auth: auth.tkf-aceplus.com
+Asset Platform: saas.tkf-aceplus.com
+
 ## Auth
 
 Authentication happens on the auth cluster which is located on the following URL
 
 ```typescript
-var AuthAddress = "https://backend-auth.smart-ace.com";
+var AuthAddress = "https://auth.tkf-aceplus.com";
 ```
 
 ### Login
@@ -38,29 +42,29 @@ import { AuthnProto } from "@aceplus/smartace-api/auth.authn_pb";
 import { AuthnGRPC } from "@aceplus/smartace-api/auth.authn_pb_service";
 
 function login(username: string, password: string): Promise<AuthnProto.AsObject> {
-  return new Promise(async (resolve, reject) => {
-    let request = new AuthnProto.LoginRequest();
-
-    request.setUsername(username);
-    request.setPassword(password);
-
-    grpc.invoke(AuthnGRPC.Login, {
-      request,
-      transport: NodeHttpTransport(),
-      host: AuthAddress,
-      onMessage: (res) => {
-        resolve(res.toObject() as AuthnProto.AsObject);
-      },
-      onEnd: (code, message) => {
-        if (code === 0) {
-          console.log("Ok");
-        } else {
-          console.log({ code, message });
-          reject({ code, message });
-        }
-      },
-    });
-  });
+	return new Promise(async (resolve, reject) => {
+		let request = new AuthnProto.LoginRequest();
+
+		request.setUsername(username);
+		request.setPassword(password);
+
+		grpc.invoke(AuthnGRPC.Login, {
+			request,
+			transport: NodeHttpTransport(),
+			host: AuthAddress,
+			onMessage: (res) => {
+				resolve(res.toObject() as AuthnProto.AsObject);
+			},
+			onEnd: (code, message) => {
+				if (code === 0) {
+					console.log("Ok");
+				} else {
+					console.log({ code, message });
+					reject({ code, message });
+				}
+			},
+		});
+	});
 }
 
 var auth = await login("test@email.com", "password"); // fill in your credentials here
@@ -81,29 +85,29 @@ import { AuthnProto } from "@aceplus/smartace-api/auth.authn_pb";
 import { AuthnGRPC } from "@aceplus/smartace-api/auth.authn_pb_service";
 
 function refresh(accessToken: string, refreshToken: string): Promise<AuthnProto.AsObject> {
-  return new Promise(async (resolve, reject) => {
-    let request = new AuthnProto.RefreshRequest();
-
-    request.setAccessToken(accessToken);
-    request.setRefreshToken(refreshToken);
-
-    grpc.invoke(AuthnGRPC.Refresh, {
-      request,
-      transport: NodeHttpTransport(),
-      host: AuthAddress,
-      onMessage: (res) => {
-        resolve(res.toObject() as AuthnProto.AsObject);
-      },
-      onEnd: (code, message) => {
-        if (code === 0) {
-          console.log("Ok");
-        } else {
-          console.log({ code, message });
-          reject({ code, message });
-        }
-      },
-    });
-  });
+	return new Promise(async (resolve, reject) => {
+		let request = new AuthnProto.RefreshRequest();
+
+		request.setAccessToken(accessToken);
+		request.setRefreshToken(refreshToken);
+
+		grpc.invoke(AuthnGRPC.Refresh, {
+			request,
+			transport: NodeHttpTransport(),
+			host: AuthAddress,
+			onMessage: (res) => {
+				resolve(res.toObject() as AuthnProto.AsObject);
+			},
+			onEnd: (code, message) => {
+				if (code === 0) {
+					console.log("Ok");
+				} else {
+					console.log({ code, message });
+					reject({ code, message });
+				}
+			},
+		});
+	});
 }
 
 var auth = await login("test@email.com", "password");
@@ -116,36 +120,36 @@ auth = await refresh(auth.accessToken, auth.refreshToken);
 To access the spic data, we need to access the operator cluster on the following URL
 
 ```typescript
-var OperatorAddress = "https://backend-dev.smart-ace.com";
+var OperatorAddress = "https://saas.tkf-aceplus.com";
 
 // grpc call helper function
 function BaseOperatorRequest<TRequest extends grpc.ProtobufMessage, TResponse extends grpc.ProtobufMessage, TMethod extends grpc.MethodDefinition<TRequest, TResponse>>(
-  accessToken: string,
-  method: TMethod,
-  request: TRequest
+	accessToken: string,
+	method: TMethod,
+	request: TRequest
 ): Promise<TResponse> {
-  return new Promise(async (resolve, reject) => {
-    // set accesssToken in header for authorization
-    const metadata = new grpc.Metadata();
-    metadata.set("authorization", "Bearer " + accessToken);
-
-    grpc.invoke(method, {
-      metadata,
-      request,
-      host: OperatorAddress,
-      transport: NodeHttpTransport(), // required for Node
-      onMessage: (res) => {
-        resolve(res as TResponse);
-      },
-      onEnd: (code, message) => {
-        if (code === 0) {
-          console.log("Ok");
-        } else {
-          reject({ code, message });
-        }
-      },
-    });
-  });
+	return new Promise(async (resolve, reject) => {
+		// set accesssToken in header for authorization
+		const metadata = new grpc.Metadata();
+		metadata.set("authorization", "Bearer " + accessToken);
+
+		grpc.invoke(method, {
+			metadata,
+			request,
+			host: OperatorAddress,
+			transport: NodeHttpTransport(), // required for Node
+			onMessage: (res) => {
+				resolve(res as TResponse);
+			},
+			onEnd: (code, message) => {
+				if (code === 0) {
+					console.log("Ok");
+				} else {
+					reject({ code, message });
+				}
+			},
+		});
+	});
 }
 ```
 
@@ -155,18 +159,18 @@ Searching cabinets with pagination
 
 ```typescript
 function searchCabinets(accessToken: string, name: string, count: number, page: number): Promise<CabinetProto.SearchReply> {
-  return new Promise(async (resolve, reject) => {
-    const request = new CabinetProto.SearchRequest();
-    name && name.length >= 3 && request.setName(name);
-    request.setCount(count);
-    request.setPage(page);
-
-    BaseOperatorRequest(accessToken, CabinetGRPC.Search, request)
-      .then((res) => {
-        resolve(res as CabinetProto.SearchReply);
-      })
-      .catch((err) => reject(err));
-  });
+	return new Promise(async (resolve, reject) => {
+		const request = new CabinetProto.SearchRequest();
+		name && name.length >= 3 && request.setName(name);
+		request.setCount(count);
+		request.setPage(page);
+
+		BaseOperatorRequest(accessToken, CabinetGRPC.Search, request)
+			.then((res) => {
+				resolve(res as CabinetProto.SearchReply);
+			})
+			.catch((err) => reject(err));
+	});
 }
 
 var cabinets = await searchCabinets(auth.accessToken, "", 10, 0);
@@ -183,29 +187,29 @@ Or retrieve cabinet by id or Uid
 
 ```typescript
 function retrieveCabinetById(accessToken: string, id: number): Promise<CabinetWithLocation> {
-  return new Promise(async (resolve, reject) => {
-    const request = new CabinetProto.RetrieveRequest();
-    request.setId(id);
-
-    BaseOperatorRequest(accessToken, CabinetGRPC.Retrieve, request)
-      .then((res) => {
-        resolve(res as CabinetWithLocation);
-      })
-      .catch((err) => reject(err));
-  });
+	return new Promise(async (resolve, reject) => {
+		const request = new CabinetProto.RetrieveRequest();
+		request.setId(id);
+
+		BaseOperatorRequest(accessToken, CabinetGRPC.Retrieve, request)
+			.then((res) => {
+				resolve(res as CabinetWithLocation);
+			})
+			.catch((err) => reject(err));
+	});
 }
 
 function retrieveCabinetByUid(accessToken: string, uid: string): Promise<CabinetWithLocation> {
-  return new Promise(async (resolve, reject) => {
-    const request = new CabinetProto.RetrieveRequest();
-    request.setUid(uid);
-
-    BaseOperatorRequest(accessToken, CabinetGRPC.Retrieve, request)
-      .then((res) => {
-        resolve(res as CabinetWithLocation);
-      })
-      .catch((err) => reject(err));
-  });
+	return new Promise(async (resolve, reject) => {
+		const request = new CabinetProto.RetrieveRequest();
+		request.setUid(uid);
+
+		BaseOperatorRequest(accessToken, CabinetGRPC.Retrieve, request)
+			.then((res) => {
+				resolve(res as CabinetWithLocation);
+			})
+			.catch((err) => reject(err));
+	});
 }
 
 let cabinet1 = await retrieveCabinetById(auth.accessToken, 1);
@@ -218,20 +222,20 @@ console.log(cabinet2.toObject());
 
 ```typescript
 function retrieveEvents(accessToken: string, cabinetId: number, count: number, page: number, descendingOrder: boolean): Promise<CabinetProto.Event.SearchReply> {
-  return new Promise(async (resolve, reject) => {
-    const request = new CabinetProto.Event.SearchRequest();
-
-    request.setCabinetId(cabinetId);
-    request.setCount(count);
-    request.setPage(page);
-    request.setDescorder(descendingOrder);
-
-    BaseOperatorRequest(accessToken, CabinetGRPC.SearchEvents, request)
-      .then((res) => {
-        resolve(res as CabinetProto.Event.SearchReply);
-      })
-      .catch((err) => reject(err));
-  });
+	return new Promise(async (resolve, reject) => {
+		const request = new CabinetProto.Event.SearchRequest();
+
+		request.setCabinetId(cabinetId);
+		request.setCount(count);
+		request.setPage(page);
+		request.setDescorder(descendingOrder);
+
+		BaseOperatorRequest(accessToken, CabinetGRPC.SearchEvents, request)
+			.then((res) => {
+				resolve(res as CabinetProto.Event.SearchReply);
+			})
+			.catch((err) => reject(err));
+	});
 }
 let events = await retrieveEvents(auth.accessToken, cabinet2.getCabinet()!.getId(), 10, 0, false);
 
@@ -242,23 +246,23 @@ console.log(events.toObject());
 
 ```typescript
 function retrieveStates(accessToken: string, uid: string, count: number, page: number, descendingOrder: boolean): Promise<CabinetProto.State.SearchReply> {
-  return new Promise(async (resolve, reject) => {
-    const request = new CabinetProto.State.SearchRequest();
-
-    request.setUid(uid);
-    request.setCount(count);
-    request.setPage(page);
-    request.setDescorder(descendingOrder);
-
-    request.setBatteryTo(4000);
-    request.setTemperatureTo(100);
-
-    BaseOperatorRequest(accessToken, CabinetGRPC.SearchStates, request)
-      .then((res) => {
-        resolve(res as CabinetProto.State.SearchReply);
-      })
-      .catch((err) => reject(err));
-  });
+	return new Promise(async (resolve, reject) => {
+		const request = new CabinetProto.State.SearchRequest();
+
+		request.setUid(uid);
+		request.setCount(count);
+		request.setPage(page);
+		request.setDescorder(descendingOrder);
+
+		request.setBatteryTo(4000);
+		request.setTemperatureTo(100);
+
+		BaseOperatorRequest(accessToken, CabinetGRPC.SearchStates, request)
+			.then((res) => {
+				resolve(res as CabinetProto.State.SearchReply);
+			})
+			.catch((err) => reject(err));
+	});
 }
 let states = await retrieveStates(auth.accessToken, cabinet2.getCabinet()!.getUid(), 10, 0, false);
 
@@ -273,36 +277,36 @@ Here you have option for how long the opening is valid and if it is a single use
 
 ```typescript
 function Open(accessToken: string, cabinetId: number): Promise<CabinetProto.OpenRequest> {
-  return new Promise(async (resolve, reject) => {
-    const request = new CabinetProto.OpenRequest.CreateRequest();
+	return new Promise(async (resolve, reject) => {
+		const request = new CabinetProto.OpenRequest.CreateRequest();
 
-    request.setCabinetId(cabinetId);
+		request.setCabinetId(cabinetId);
 
-    function DateToTimestamp(date: Date): Timestamp {
-      let ts = new Timestamp();
-      let seconds = Math.round(date.getTime() / 1000);
-      ts.setSeconds(seconds);
-      return ts;
-    }
+		function DateToTimestamp(date: Date): Timestamp {
+			let ts = new Timestamp();
+			let seconds = Math.round(date.getTime() / 1000);
+			ts.setSeconds(seconds);
+			return ts;
+		}
 
-    var now = new Date(Date.now());
-    request.setRequestTime(DateToTimestamp(now));
+		var now = new Date(Date.now());
+		request.setRequestTime(DateToTimestamp(now));
 
-    var expirationDate = new Date(Date.now());
-    expirationDate.setTime(expirationDate.getTime() + 60 * 60 * 1000);
+		var expirationDate = new Date(Date.now());
+		expirationDate.setTime(expirationDate.getTime() + 60 * 60 * 1000);
 
-    request.setValidUntil(DateToTimestamp(expirationDate));
+		request.setValidUntil(DateToTimestamp(expirationDate));
 
-    request.setType(CabinetProto.OpenRequest.OpenRequestType.ADMIN_OPENING);
+		request.setType(CabinetProto.OpenRequest.OpenRequestType.ADMIN_OPENING);
 
-    request.setDeactivateafteropening(true);
+		request.setDeactivateafteropening(true);
 
-    BaseOperatorRequest(accessToken, CabinetGRPC.CreateOpenRequest, request)
-      .then((res) => {
-        resolve(res as CabinetProto.OpenRequest);
-      })
-      .catch((err) => reject(err));
-  });
+		BaseOperatorRequest(accessToken, CabinetGRPC.CreateOpenRequest, request)
+			.then((res) => {
+				resolve(res as CabinetProto.OpenRequest);
+			})
+			.catch((err) => reject(err));
+	});
 }
 
 let openRequest = await Open(auth.accessToken, cabinet2.getCabinet()!.getId()).catch((err) => console.log(err));

package/auth.account_pb.d.ts

@@ -188,11 +188,6 @@ export namespace AccountProto {
     getCount(): number;
     setCount(value: number): void;
 
-    clearScopeFiltersList(): void;
-    getScopeFiltersList(): Array<AccountProto.Scope>;
-    setScopeFiltersList(value: Array<AccountProto.Scope>): void;
-    addScopeFilters(value?: AccountProto.Scope, index?: number): AccountProto.Scope;
-
     serializeBinary(): Uint8Array;
     toObject(includeInstance?: boolean): SearchRequest.AsObject;
     static toObject(includeInstance: boolean, msg: SearchRequest): SearchRequest.AsObject;
@@ -208,7 +203,6 @@ export namespace AccountProto {
       search: string,
       page: number,
       count: number,
-      scopeFiltersList: Array<AccountProto.Scope.AsObject>,
     }
   }
 
@@ -420,106 +414,6 @@ export namespace AccountProto {
     }
   }
 
-  export class Scope extends jspb.Message {
-    getScopeName(): string;
-    setScopeName(value: string): void;
-
-    getScopeValue(): string;
-    setScopeValue(value: string): void;
-
-    serializeBinary(): Uint8Array;
-    toObject(includeInstance?: boolean): Scope.AsObject;
-    static toObject(includeInstance: boolean, msg: Scope): Scope.AsObject;
-    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
-    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
-    static serializeBinaryToWriter(message: Scope, writer: jspb.BinaryWriter): void;
-    static deserializeBinary(bytes: Uint8Array): Scope;
-    static deserializeBinaryFromReader(message: Scope, reader: jspb.BinaryReader): Scope;
-  }
-
-  export namespace Scope {
-    export type AsObject = {
-      scopeName: string,
-      scopeValue: string,
-    }
-  }
-
-  export class SetSuperAccountScopeRequest extends jspb.Message {
-    getId(): number;
-    setId(value: number): void;
-
-    hasScope(): boolean;
-    clearScope(): void;
-    getScope(): AccountProto.Scope | undefined;
-    setScope(value?: AccountProto.Scope): void;
-
-    getClusterName(): string;
-    setClusterName(value: string): void;
-
-    serializeBinary(): Uint8Array;
-    toObject(includeInstance?: boolean): SetSuperAccountScopeRequest.AsObject;
-    static toObject(includeInstance: boolean, msg: SetSuperAccountScopeRequest): SetSuperAccountScopeRequest.AsObject;
-    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
-    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
-    static serializeBinaryToWriter(message: SetSuperAccountScopeRequest, writer: jspb.BinaryWriter): void;
-    static deserializeBinary(bytes: Uint8Array): SetSuperAccountScopeRequest;
-    static deserializeBinaryFromReader(message: SetSuperAccountScopeRequest, reader: jspb.BinaryReader): SetSuperAccountScopeRequest;
-  }
-
-  export namespace SetSuperAccountScopeRequest {
-    export type AsObject = {
-      id: number,
-      scope?: AccountProto.Scope.AsObject,
-      clusterName: string,
-    }
-  }
-
-  export class SetAccountScopeRequest extends jspb.Message {
-    getId(): number;
-    setId(value: number): void;
-
-    hasScope(): boolean;
-    clearScope(): void;
-    getScope(): AccountProto.Scope | undefined;
-    setScope(value?: AccountProto.Scope): void;
-
-    serializeBinary(): Uint8Array;
-    toObject(includeInstance?: boolean): SetAccountScopeRequest.AsObject;
-    static toObject(includeInstance: boolean, msg: SetAccountScopeRequest): SetAccountScopeRequest.AsObject;
-    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
-    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
-    static serializeBinaryToWriter(message: SetAccountScopeRequest, writer: jspb.BinaryWriter): void;
-    static deserializeBinary(bytes: Uint8Array): SetAccountScopeRequest;
-    static deserializeBinaryFromReader(message: SetAccountScopeRequest, reader: jspb.BinaryReader): SetAccountScopeRequest;
-  }
-
-  export namespace SetAccountScopeRequest {
-    export type AsObject = {
-      id: number,
-      scope?: AccountProto.Scope.AsObject,
-    }
-  }
-
-  export class SetAccountScopeReply extends jspb.Message {
-    getId(): number;
-    setId(value: number): void;
-
-    serializeBinary(): Uint8Array;
-    toObject(includeInstance?: boolean): SetAccountScopeReply.AsObject;
-    static toObject(includeInstance: boolean, msg: SetAccountScopeReply): SetAccountScopeReply.AsObject;
-    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
-    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
-    static serializeBinaryToWriter(message: SetAccountScopeReply, writer: jspb.BinaryWriter): void;
-    static deserializeBinary(bytes: Uint8Array): SetAccountScopeReply;
-    static deserializeBinaryFromReader(message: SetAccountScopeReply, reader: jspb.BinaryReader): SetAccountScopeReply;
-  }
-
-  export namespace SetAccountScopeReply {
-    export type AsObject = {
-      id: number,
-    }
-  }
-
   export class RetrievePushInfoRequest extends jspb.Message {
     getId(): number;
     setId(value: number): void;
@@ -592,6 +486,26 @@ export namespace AccountProto {
     }
   }
 
+  export class DeleteFromClusterRequest extends jspb.Message {
+    getId(): number;
+    setId(value: number): void;
+
+    serializeBinary(): Uint8Array;
+    toObject(includeInstance?: boolean): DeleteFromClusterRequest.AsObject;
+    static toObject(includeInstance: boolean, msg: DeleteFromClusterRequest): DeleteFromClusterRequest.AsObject;
+    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+    static serializeBinaryToWriter(message: DeleteFromClusterRequest, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): DeleteFromClusterRequest;
+    static deserializeBinaryFromReader(message: DeleteFromClusterRequest, reader: jspb.BinaryReader): DeleteFromClusterRequest;
+  }
+
+  export namespace DeleteFromClusterRequest {
+    export type AsObject = {
+      id: number,
+    }
+  }
+
   export class RetrieveAccountActivationStatusesRequest extends jspb.Message {
     clearIdsList(): void;
     getIdsList(): Array<number>;