FenceServiceClient class

/ boutiques & users

Inheritance
Annotations
  • @GrpcServiceName.new('weebi.fence.service.FenceService')

Constructors

FenceServiceClient(ClientChannel channel, {CallOptions? options, Iterable<ClientInterceptor>? interceptors})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

$createCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ClientCall<Q, R>
inherited
$createStreamingCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ResponseStream<R>
inherited
$createUnaryCall<Q, R>(ClientMethod<Q, R> method, Q request, {CallOptions? options}) → ResponseFuture<R>
inherited
authenticateWithCredentials(Credentials request, {CallOptions? options}) → ResponseFuture<Tokens>
authenticateWithRefreshToken(RefreshToken request, {CallOptions? options}) → ResponseFuture<Tokens>
confirmPasswordReset(PasswordResetConfirmRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
createDevice(PendingDeviceRequest request, {CallOptions? options}) → ResponseFuture<CreateDeviceResponse>
/ createDevice is called by mobile/desktop app / await lasts for 2 minutes (to be tested) / remove pending
createFirm(CreateFirmRequest request, {CallOptions? options}) → ResponseFuture<CreateFirmResponse>
/ only one firm per 'company' / 1. user signup and get a userId & create firm permission / 2. A. user create a firm / Chain and Boutique will be created by default and will use the same firmId / Since createFirm also updates user permission, clientApp needs to reauthent using refresh right after / 2. B. user joins a firm is a different use case detailed in createPendingUser rpc
createOneBoutique(BoutiqueRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
createOneChain(Chain request, {CallOptions? options}) → ResponseFuture<StatusResponse>
createPendingUser(PendingUserRequest request, {CallOptions? options}) → ResponseFuture<PendingUserResponse>
/ App -> Web magic link: authenticated mobile client mints a short-lived one-time URL. / Supported product_id values: "premium", "syscohada" (fiscal_year required for syscohada).
deleteOneBoutique(BoutiqueRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
/ soft delete - marks boutique as deleted
deleteOneChain(DeleteChainRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
/ hard/complete delete (chainId only; see DeleteChainRequest)
deleteOneDevice(DeleteDeviceRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
/ hard/forever delete
deleteOneUser(UserId request, {CallOptions? options}) → ResponseFuture<StatusResponse>
exchangeWebBridgeToken(ExchangeWebBridgeTokenRequest request, {CallOptions? options}) → ResponseFuture<Tokens>
/ Public: browser exchanges the one-time token for a web BFF session (Tokens.sessionId only).
generateCodeForPairingDevice(ChainIdAndboutiqueId request, {CallOptions? options}) → ResponseFuture<CodeForPairingDevice>
/ device enrolment follows a different process than user enrolment / generateCodeForPairingDevice is called by web app, it includes chainId and boutiqueId / A device belongs to a boutique TODO rename this create
getSessionInternal(SessionRequest request, {CallOptions? options}) → ResponseFuture<Tokens>
/ Internal RPC used by Envoy to retrieve session data / Called when browser presents a session cookie / Path: /weebi.fence.service.FenceService/getSessionInternal
healthCheck(Empty request, {CallOptions? options}) → ResponseFuture<HealthCheckWeebiResponse>
/ Health check with version information
isADeviceInChain(ReadDevicesRequest request, {CallOptions? options}) → ResponseFuture<IsADeviceInChainResponse>
/ scans all firm's devices, disregarding user rights / used both in : / weebi_app signups to REQUIRE that user pushes device data / weebi_app device linking to PREVENT user from pushing data, pulling only will be false by default, which is safer since it avoids corrupting data when linking new device that potentially weebi_app with different data == isOneDevice at least
logout(Empty request, {CallOptions? options}) → ResponseFuture<Empty>
/ Web session logout - invalidates session server-side. Envoy clears the cookie on success.
markEmailVerified(MarkEmailVerifiedRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
Email verification - marks a user's email as verified
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readAllBoutiques(Empty request, {CallOptions? options}) → ResponseFuture<ReadAllBoutiquesResponse>
/ returns all active boutiques across all chains (filters out deleted ones)
readAllChains(Empty request, {CallOptions? options}) → ResponseFuture<ReadAllChainsResponse>
readAllUsers(Empty request, {CallOptions? options}) → ResponseFuture<UsersPublic>
/ Presumably, until 2030 firms will have max 9 users, why bother filter ?
readDevices(ReadDevicesRequest request, {CallOptions? options}) → ResponseFuture<Devices>
/ return only device visible according to user rights
readOneBoutique(BoutiqueRequest request, {CallOptions? options}) → ResponseFuture<BoutiqueResponse>
readOneFirm(Empty request, {CallOptions? options}) → ResponseFuture<Firm>
readOnePendingDevice(ReadDeviceBtqRequest request, {CallOptions? options}) → ResponseFuture<Device>
/ webapp listens to deviceStream awaiting PoS app to createDevice by typing the code
readOneUser(UserId request, {CallOptions? options}) → ResponseFuture<ReadOneUserResponse>
requestPasswordReset(PasswordResetRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
Password reset functionality
restoreOneBoutique(BoutiqueRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
/ restore a soft-deleted boutique
signUp(SignUpRequest request, {CallOptions? options}) → ResponseFuture<SignUpResponse>
toString() → String
A string representation of this object.
inherited
updateDevicePassword(UpdateDevicePasswordRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
/ removed as it brings a security risk / rpc authenticateWithDevice (DeviceCredentials) returns (Tokens);
updateOneBoutique(BoutiqueRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
/ real update, not upsert, do nothing if unfound
updateOneChain(ChainRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
only update fiels not boutiques, not upsert, do nothing if unfound
updateOneUser(UserPublic request, {CallOptions? options}) → ResponseFuture<StatusResponse>
real update, not an upsert, does nothing if user not found
updateSubscriberId(UpdateSubscriberIdRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>
Update subscriber ID - links a user to a newsletter subscriber
updateUserPassword(PasswordUpdateRequest request, {CallOptions? options}) → ResponseFuture<StatusResponse>

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

defaultHost → const String
The hostname for this service.
oauthScopes → const List<String>
OAuth scopes needed for the client.