UsersResource class

Project membership users (create, list, block, invite, register variants).

Inheritance

• Object
• Resource
• UsersResource

Constructors

UsersResource(Transport transport)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transport → Transport

final, inherited

Methods

assignRolePermissions({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/membership/auth/assign-roles

blockUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PATCH /{version}/membership/auth/block

deleteUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/membership/auth

getUser({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/membership/auth/{id}

getUserPreferences({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/membership/auth/{id}/preferences

getUsers({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/membership/auth

grantContactConsent({required Object contactId, required Object channel, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/users/{contactId}/marketing-state/{channel}/consent

inviteUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/invite

linkIdentity({required Object userId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/{userId}/link-identity

mapAuthToUser({required Object userId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/users/{userId}/map-auth

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

saveEmailUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/email

saveEmailUserNameWithPermissions({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/email-with-permissions

saveGuestUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/guest

savePhoneUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/phone

savePhoneUserNameWithPermissions({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/phone-with-permissions

saveSystemUserWithPermissions({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/service

saveUserNameUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/user-name

saveUserNameWithPermissions({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/auth/register/user-name-with-permissions

setContactRoles({required Object userId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/membership/users/{userId}/roles

setContactTagSubscription({required Object contactId, required Object commChannel, required Object channel, required Object tag, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/membership/users/{contactId}/marketing-state/{commChannel}/{channel}/tags/{tag}

toString() → String

A string representation of this object.

inherited

unblockUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PATCH /{version}/membership/auth/unblock

unsubscribeContact({required Object contactId, required Object channel, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/membership/users/{contactId}/marketing-state/{channel}/unsubscribe

updateUser({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/membership/auth

updateUserPreferences({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/membership/auth/{id}/preferences

Operators

operator ==(Object other) → bool

The equality operator.

inherited