antinvestor_api_profile library
Dart client library for Ant Investor Profile Service.
Provides Profile service functionality using Connect RPC protocol.
For other services in this package, import directly:
package:antinvestor_api_profile/device.dartfor Device servicepackage:antinvestor_api_profile/settings.dartfor Settings servicepackage:antinvestor_api_profile/ocr.dartfor OCR servicepackage:antinvestor_api_profile/geolocation.dartfor Geolocation service
Classes
- AddAddressRequest
- The request message containing the information necessary to create a profile
- AddAddressResponse
- AddContactRequest
- The request message containing the information necessary to create a profile
- AddContactResponse
- AddRelationshipRequest
- The request message containing the information necessary to create a profile
- AddRelationshipResponse
- AddressObject
- AddressObject represents a physical address with geocoding.
- AddRosterRequest
- AddRosterResponse
- CheckVerificationRequest
- CheckVerificationResponse
- CommunicationLevel
- CommunicationLevel defines user's communication preferences. buf:lint:ignore ENUM_VALUE_PREFIX
- ContactLink
- ContactLink represents a link between a contact and a profile in the system. Used for associating external contacts with internal profiles across services. This enables unified identity management and contact resolution.
- ContactObject
- ContactObject represents a contact method (email or phone).
- ContactType
- ContactType defines the type of contact information. buf:lint:ignore ENUM_VALUE_PREFIX
- CreateContactRequest
- The request message containing the information necessary to create a profile
- CreateContactResponse
- CreateContactVerificationRequest
- The request message containing the information necessary to verify a contact
- CreateContactVerificationResponse
- CreateRequest
- The request message containing the information necessary to create a profile
- CreateResponse
- DeleteRelationshipRequest
- The request message containing the information necessary to delete relationship to a profile
- DeleteRelationshipResponse
- EntryItem
- EntryItem identifies an object in a relationship.
- ErrorDetail
- Standard error codes used by API responses. Use gRPC status codes; the application-level ErrorDetail below may carry more.
- GetByContactRequest
- Request message containing a contact necessary to link to a profile
- GetByContactResponse
- GetByIdRequest
- The request message containing the profile's hash
- GetByIdResponse
- ListRelationshipRequest
- Request message to list all profiles related to the supplied profile id
- ListRelationshipResponse
- ListValue
-
ListValueis a wrapper around a repeated field of values. - MergeRequest
- The request message containing the profile's hash
- MergeResponse
- NullValue
-
NullValueis a singleton enumeration to represent the null value for theValuetype union. - PageCursor
- PageCursor provides standard offset-based pagination/cursor stream parameters. Used for list operations that return large result sets.
- ProfileObject
- ProfileObject represents a complete user or entity profile.
- ProfileService
- ProfileService manages user and entity profiles. All RPCs require authentication via Bearer token.
- ProfileServiceApi
- ProfileType
- ProfileType defines the type of profile entity. buf:lint:ignore ENUM_VALUE_PREFIX
- RawContact
- RelationshipObject
- RelationshipObject represents a relationship between two profiles.
- RelationshipType
- RelationshipType defines how two profiles are linked. buf:lint:ignore ENUM_VALUE_PREFIX
- RemoveContactRequest
- The request message containing the information necessary to remove a contact
- RemoveContactResponse
- RemoveRosterRequest
- RemoveRosterResponse
- RosterObject
- RosterObject represents a contact in a user's roster/contact list.
- SearchRequest
- SearchResponse
- SearchRosterRequest
- SearchRosterResponse
- STATE
- STATE represents the lifecycle state of an entity across all services. This enum provides a consistent way to track entity states from creation to deletion. buf:lint:ignore ENUM_VALUE_PREFIX
- STATUS
- STATUS represents the processing status of an operation or task. This enum is used for tracking asynchronous operations, jobs, and workflows. buf:lint:ignore ENUM_VALUE_PREFIX
- StatusRequest
- StatusRequest retrieves the current status of an entity or operation.
- StatusResponse
- StatusResponse returns the current state and status of an entity or operation.
- StatusUpdateRequest
- StatusUpdateRequest updates the state and/or status of an entity or operation. Used for state transitions and status updates by authorized services.
- StatusUpdateResponse
- StatusUpdateResponse returns the updated status after a status update operation.
- Struct
-
Structrepresents a structured data value, consisting of fields which map to dynamically typed values. In some languages,Structmight be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language. - Timestamp
- A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
- UpdateRequest
- The request message containing the information necessary to create a profile
- UpdateResponse
- Value
-
Valuerepresents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
Enums
Extension Types
- ProfileServiceClient
- ProfileService manages user and entity profiles. All RPCs require authentication via Bearer token.
Constants
-
AddAddressRequest$json
→ const Map<
String, Object> -
AddAddressResponse$json
→ const Map<
String, Object> -
AddContactRequest$json
→ const Map<
String, Object> -
AddContactResponse$json
→ const Map<
String, Object> -
AddRelationshipRequest$json
→ const Map<
String, Object> -
AddRelationshipResponse$json
→ const Map<
String, Object> -
AddressObject$json
→ const Map<
String, Object> -
AddRosterRequest$json
→ const Map<
String, Object> -
AddRosterResponse$json
→ const Map<
String, Object> -
CheckVerificationRequest$json
→ const Map<
String, Object> -
CheckVerificationResponse$json
→ const Map<
String, Object> -
CommunicationLevel$json
→ const Map<
String, Object> -
ContactObject$json
→ const Map<
String, Object> -
ContactType$json
→ const Map<
String, Object> -
CreateContactRequest$json
→ const Map<
String, Object> -
CreateContactResponse$json
→ const Map<
String, Object> -
CreateContactVerificationRequest$json
→ const Map<
String, Object> -
CreateContactVerificationResponse$json
→ const Map<
String, Object> -
CreateRequest$json
→ const Map<
String, Object> -
CreateResponse$json
→ const Map<
String, Object> - defaultDeviceEndpoint → const String
- Default endpoint for the Device service.
- defaultProfileEndpoint → const String
- Default endpoint for the Profile service.
-
DeleteRelationshipRequest$json
→ const Map<
String, Object> -
DeleteRelationshipResponse$json
→ const Map<
String, Object> -
EntryItem$json
→ const Map<
String, Object> -
GetByContactRequest$json
→ const Map<
String, Object> -
GetByContactResponse$json
→ const Map<
String, Object> -
GetByIdRequest$json
→ const Map<
String, Object> -
GetByIdResponse$json
→ const Map<
String, Object> -
ListRelationshipRequest$json
→ const Map<
String, Object> -
ListRelationshipResponse$json
→ const Map<
String, Object> -
MergeRequest$json
→ const Map<
String, Object> -
MergeResponse$json
→ const Map<
String, Object> -
ProfileObject$json
→ const Map<
String, Object> -
ProfileServiceBase$json
→ const Map<
String, dynamic> -
ProfileServiceBase$messageJson
→ const Map<
String, Map< String, dynamic> > -
ProfileType$json
→ const Map<
String, Object> -
RawContact$json
→ const Map<
String, Object> -
RelationshipObject$json
→ const Map<
String, Object> -
RelationshipType$json
→ const Map<
String, Object> -
RemoveContactRequest$json
→ const Map<
String, Object> -
RemoveContactResponse$json
→ const Map<
String, Object> -
RemoveRosterRequest$json
→ const Map<
String, Object> -
RemoveRosterResponse$json
→ const Map<
String, Object> -
RosterObject$json
→ const Map<
String, Object> -
SearchRequest$json
→ const Map<
String, Object> -
SearchResponse$json
→ const Map<
String, Object> -
SearchRosterRequest$json
→ const Map<
String, Object> -
SearchRosterResponse$json
→ const Map<
String, Object> -
UpdateRequest$json
→ const Map<
String, Object> -
UpdateResponse$json
→ const Map<
String, Object>
Properties
- addAddressRequestDescriptor → Uint8List
-
Descriptor for
AddAddressRequest. Decode as agoogle.protobuf.DescriptorProto.final - addAddressResponseDescriptor → Uint8List
-
Descriptor for
AddAddressResponse. Decode as agoogle.protobuf.DescriptorProto.final - addContactRequestDescriptor → Uint8List
-
Descriptor for
AddContactRequest. Decode as agoogle.protobuf.DescriptorProto.final - addContactResponseDescriptor → Uint8List
-
Descriptor for
AddContactResponse. Decode as agoogle.protobuf.DescriptorProto.final - addRelationshipRequestDescriptor → Uint8List
-
Descriptor for
AddRelationshipRequest. Decode as agoogle.protobuf.DescriptorProto.final - addRelationshipResponseDescriptor → Uint8List
-
Descriptor for
AddRelationshipResponse. Decode as agoogle.protobuf.DescriptorProto.final - addressObjectDescriptor → Uint8List
-
Descriptor for
AddressObject. Decode as agoogle.protobuf.DescriptorProto.final - addRosterRequestDescriptor → Uint8List
-
Descriptor for
AddRosterRequest. Decode as agoogle.protobuf.DescriptorProto.final - addRosterResponseDescriptor → Uint8List
-
Descriptor for
AddRosterResponse. Decode as agoogle.protobuf.DescriptorProto.final - checkVerificationRequestDescriptor → Uint8List
-
Descriptor for
CheckVerificationRequest. Decode as agoogle.protobuf.DescriptorProto.final - checkVerificationResponseDescriptor → Uint8List
-
Descriptor for
CheckVerificationResponse. Decode as agoogle.protobuf.DescriptorProto.final - communicationLevelDescriptor → Uint8List
-
Descriptor for
CommunicationLevel. Decode as agoogle.protobuf.EnumDescriptorProto.final - contactObjectDescriptor → Uint8List
-
Descriptor for
ContactObject. Decode as agoogle.protobuf.DescriptorProto.final - contactTypeDescriptor → Uint8List
-
Descriptor for
ContactType. Decode as agoogle.protobuf.EnumDescriptorProto.final - createContactRequestDescriptor → Uint8List
-
Descriptor for
CreateContactRequest. Decode as agoogle.protobuf.DescriptorProto.final - createContactResponseDescriptor → Uint8List
-
Descriptor for
CreateContactResponse. Decode as agoogle.protobuf.DescriptorProto.final - createContactVerificationRequestDescriptor → Uint8List
-
Descriptor for
CreateContactVerificationRequest. Decode as agoogle.protobuf.DescriptorProto.final - createContactVerificationResponseDescriptor → Uint8List
-
Descriptor for
CreateContactVerificationResponse. Decode as agoogle.protobuf.DescriptorProto.final - createRequestDescriptor → Uint8List
-
Descriptor for
CreateRequest. Decode as agoogle.protobuf.DescriptorProto.final - createResponseDescriptor → Uint8List
-
Descriptor for
CreateResponse. Decode as agoogle.protobuf.DescriptorProto.final - deleteRelationshipRequestDescriptor → Uint8List
-
Descriptor for
DeleteRelationshipRequest. Decode as agoogle.protobuf.DescriptorProto.final - deleteRelationshipResponseDescriptor → Uint8List
-
Descriptor for
DeleteRelationshipResponse. Decode as agoogle.protobuf.DescriptorProto.final - entryItemDescriptor → Uint8List
-
Descriptor for
EntryItem. Decode as agoogle.protobuf.DescriptorProto.final - getByContactRequestDescriptor → Uint8List
-
Descriptor for
GetByContactRequest. Decode as agoogle.protobuf.DescriptorProto.final - getByContactResponseDescriptor → Uint8List
-
Descriptor for
GetByContactResponse. Decode as agoogle.protobuf.DescriptorProto.final - getByIdRequestDescriptor → Uint8List
-
Descriptor for
GetByIdRequest. Decode as agoogle.protobuf.DescriptorProto.final - getByIdResponseDescriptor → Uint8List
-
Descriptor for
GetByIdResponse. Decode as agoogle.protobuf.DescriptorProto.final - listRelationshipRequestDescriptor → Uint8List
-
Descriptor for
ListRelationshipRequest. Decode as agoogle.protobuf.DescriptorProto.final - listRelationshipResponseDescriptor → Uint8List
-
Descriptor for
ListRelationshipResponse. Decode as agoogle.protobuf.DescriptorProto.final - mergeRequestDescriptor → Uint8List
-
Descriptor for
MergeRequest. Decode as agoogle.protobuf.DescriptorProto.final - mergeResponseDescriptor → Uint8List
-
Descriptor for
MergeResponse. Decode as agoogle.protobuf.DescriptorProto.final - profileObjectDescriptor → Uint8List
-
Descriptor for
ProfileObject. Decode as agoogle.protobuf.DescriptorProto.final - profileServiceDescriptor → Uint8List
-
Descriptor for
ProfileService. Decode as agoogle.protobuf.ServiceDescriptorProto.final - profileTypeDescriptor → Uint8List
-
Descriptor for
ProfileType. Decode as agoogle.protobuf.EnumDescriptorProto.final - rawContactDescriptor → Uint8List
-
Descriptor for
RawContact. Decode as agoogle.protobuf.DescriptorProto.final - relationshipObjectDescriptor → Uint8List
-
Descriptor for
RelationshipObject. Decode as agoogle.protobuf.DescriptorProto.final - relationshipTypeDescriptor → Uint8List
-
Descriptor for
RelationshipType. Decode as agoogle.protobuf.EnumDescriptorProto.final - removeContactRequestDescriptor → Uint8List
-
Descriptor for
RemoveContactRequest. Decode as agoogle.protobuf.DescriptorProto.final - removeContactResponseDescriptor → Uint8List
-
Descriptor for
RemoveContactResponse. Decode as agoogle.protobuf.DescriptorProto.final - removeRosterRequestDescriptor → Uint8List
-
Descriptor for
RemoveRosterRequest. Decode as agoogle.protobuf.DescriptorProto.final - removeRosterResponseDescriptor → Uint8List
-
Descriptor for
RemoveRosterResponse. Decode as agoogle.protobuf.DescriptorProto.final - rosterObjectDescriptor → Uint8List
-
Descriptor for
RosterObject. Decode as agoogle.protobuf.DescriptorProto.final - searchRequestDescriptor → Uint8List
-
Descriptor for
SearchRequest. Decode as agoogle.protobuf.DescriptorProto.final - searchResponseDescriptor → Uint8List
-
Descriptor for
SearchResponse. Decode as agoogle.protobuf.DescriptorProto.final - searchRosterRequestDescriptor → Uint8List
-
Descriptor for
SearchRosterRequest. Decode as agoogle.protobuf.DescriptorProto.final - searchRosterResponseDescriptor → Uint8List
-
Descriptor for
SearchRosterResponse. Decode as agoogle.protobuf.DescriptorProto.final - updateRequestDescriptor → Uint8List
-
Descriptor for
UpdateRequest. Decode as agoogle.protobuf.DescriptorProto.final - updateResponseDescriptor → Uint8List
-
Descriptor for
UpdateResponse. Decode as agoogle.protobuf.DescriptorProto.final
Functions
-
newDeviceClient(
{required TransportFactory createTransport, String? endpoint, TokenManager? tokenManager, TokenRefreshCallback? onTokenRefresh, List< Interceptor> ? additionalInterceptors, bool noAuth = false}) → Future<ConnectClientBase< DeviceServiceClient> > - Creates a new Device service client.
-
newProfileClient(
{required TransportFactory createTransport, String? endpoint, TokenManager? tokenManager, TokenRefreshCallback? onTokenRefresh, List< Interceptor> ? additionalInterceptors, bool noAuth = false}) → Future<ConnectClientBase< ProfileServiceClient> > - Creates a new Profile service client.
Typedefs
-
DeviceClient
= ConnectClientBase<
DeviceServiceClient> - Type alias for Device client for convenience.
-
ProfileClient
= ConnectClientBase<
ProfileServiceClient> - Type alias for Profile client for convenience.