Struct ClientWrapper

pub struct ClientWrapper { /* private fields */ }

A wrapper around Client. Helps reduce external imports.

Methods from Deref<Target = Client<DynConnector, Identity>>

pub fn conf(&self) -> &Config

Returns the client’s configuration.

pub fn complete_group_avatar_upload(&self) -> CompleteGroupAvatarUpload<C, M, R>

Constructs a fluent builder for the CompleteGroupAvatarUpload operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
  • upload_id(impl Into<String>) / set_upload_id(Option<String>): A universally unique identifier.
• On success, responds with CompleteGroupAvatarUploadOutput
• On failure, responds with SdkError<CompleteGroupAvatarUploadError>

pub fn consume_group_invite(&self) -> ConsumeGroupInvite<C, M, R>

Constructs a fluent builder for the ConsumeGroupInvite operation.

• The fluent builder is configurable:
  • group_invite_code(impl Into<String>) / set_group_invite_code(Option<String>): Provided by rivet.api.group#CreateGroupInviteOutput$code.
• On success, responds with ConsumeGroupInviteOutput with field(s):
  • group_id(Option<String>): A universally unique identifier.
• On failure, responds with SdkError<ConsumeGroupInviteError>

pub fn create_group(&self) -> CreateGroup<C, M, R>

Constructs a fluent builder for the CreateGroup operation.

• The fluent builder is configurable:
  • display_name(impl Into<String>) / set_display_name(Option<String>): Represent a resource’s readable display name.
• On success, responds with CreateGroupOutput with field(s):
  • group_id(Option<String>): A universally unique identifier.
• On failure, responds with SdkError<CreateGroupError>

pub fn create_group_invite(&self) -> CreateGroupInvite<C, M, R>

Constructs a fluent builder for the CreateGroupInvite operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
  • ttl(i64) / set_ttl(Option<i64>): How long until the group invite expires (in milliseconds).
  • use_count(i64) / set_use_count(Option<i64>): How many times the group invite can be used.
• On success, responds with CreateGroupInviteOutput with field(s):
  • code(Option<String>): The code that will be passed to rivet.api.group#ConsumeGroupInvite to join a group.
• On failure, responds with SdkError<CreateGroupInviteError>

pub fn create_group_join_request(&self) -> CreateGroupJoinRequest<C, M, R>

Constructs a fluent builder for the CreateGroupJoinRequest operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
• On success, responds with CreateGroupJoinRequestOutput
• On failure, responds with SdkError<CreateGroupJoinRequestError>

pub fn get_group_invite(&self) -> GetGroupInvite<C, M, R>

Constructs a fluent builder for the GetGroupInvite operation.

• The fluent builder is configurable:
  • group_invite_code(impl Into<String>) / set_group_invite_code(Option<String>): Provided by rivet.api.group#CreateGroupInviteOutput$code.
• On success, responds with GetGroupInviteOutput with field(s):
  • group(Option<GroupHandle>): A group handle.
• On failure, responds with SdkError<GetGroupInviteError>

pub fn get_group_profile(&self) -> GetGroupProfile<C, M, R>

Constructs a fluent builder for the GetGroupProfile operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
  • watch_index(impl Into<String>) / set_watch_index(Option<String>): A query parameter denoting the requests watch index.
• On success, responds with GetGroupProfileOutput with field(s):
  • group(Option<GroupProfile>): A list of group profiles.
  • watch(Option<WatchResponse>): Provided by watchable endpoints used in blocking loops.
• On failure, responds with SdkError<GetGroupProfileError>

pub fn get_group_summary(&self) -> GetGroupSummary<C, M, R>

Constructs a fluent builder for the GetGroupSummary operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
• On success, responds with GetGroupSummaryOutput with field(s):
  • group(Option<GroupSummary>): A group summary.
• On failure, responds with SdkError<GetGroupSummaryError>

pub fn join_group(&self) -> JoinGroup<C, M, R>

Constructs a fluent builder for the JoinGroup operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
• On success, responds with JoinGroupOutput
• On failure, responds with SdkError<JoinGroupError>

pub fn leave_group(&self) -> LeaveGroup<C, M, R>

Constructs a fluent builder for the LeaveGroup operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
• On success, responds with LeaveGroupOutput
• On failure, responds with SdkError<LeaveGroupError>

pub fn list_suggested_groups(&self) -> ListSuggestedGroups<C, M, R>

Constructs a fluent builder for the ListSuggestedGroups operation.

• The fluent builder is configurable:
  • watch_index(impl Into<String>) / set_watch_index(Option<String>): A query parameter denoting the requests watch index.
• On success, responds with ListSuggestedGroupsOutput with field(s):
  • groups(Option<Vec<GroupSummary>>): A list of group summaries.
  • watch(Option<WatchResponse>): Provided by watchable endpoints used in blocking loops.
• On failure, responds with SdkError<ListSuggestedGroupsError>

pub fn prepare_group_avatar_upload(&self) -> PrepareGroupAvatarUpload<C, M, R>

Constructs a fluent builder for the PrepareGroupAvatarUpload operation.

• The fluent builder is configurable:
  • path(impl Into<String>) / set_path(Option<String>): The path/filename of the group avatar.
  • mime(impl Into<String>) / set_mime(Option<String>): The MIME type of the group avatar.
  • content_length(i64) / set_content_length(Option<i64>): Unsigned 64 bit integer.
• On success, responds with PrepareGroupAvatarUploadOutput with field(s):
  • upload_id(Option<String>): A universally unique identifier.
  • presigned_request(Option<UploadPresignedRequest>): A presigned request used to upload files. Upload your file to the given URL via a PUT request.
• On failure, responds with SdkError<PrepareGroupAvatarUploadError>

pub fn resolve_group_join_request(&self) -> ResolveGroupJoinRequest<C, M, R>

Constructs a fluent builder for the ResolveGroupJoinRequest operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
  • identity_id(impl Into<String>) / set_identity_id(Option<String>): A universally unique identifier.
  • resolution(bool) / set_resolution(Option<bool>): (undocumented)
• On success, responds with ResolveGroupJoinRequestOutput
• On failure, responds with SdkError<ResolveGroupJoinRequestError>

pub fn search_groups(&self) -> SearchGroups<C, M, R>

Constructs a fluent builder for the SearchGroups operation.

• The fluent builder is configurable:
  • query(impl Into<String>) / set_query(Option<String>): The query to match group display names against.
  • anchor(impl Into<String>) / set_anchor(Option<String>): How many groups to offset the search by.
  • limit(i32) / set_limit(Option<i32>): Amount of groups to return.
• On success, responds with SearchGroupsOutput with field(s):
  • groups(Option<Vec<GroupHandle>>): A list of group handles.
• On failure, responds with SdkError<SearchGroupsError>

pub fn transfer_group_ownership(&self) -> TransferGroupOwnership<C, M, R>

Constructs a fluent builder for the TransferGroupOwnership operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
  • new_owner_identity_id(impl Into<String>) / set_new_owner_identity_id(Option<String>): Idnetity to transfer the group to. Must be a member of the group.
• On success, responds with TransferGroupOwnershipOutput
• On failure, responds with SdkError<TransferGroupOwnershipError>

pub fn update_group_profile(&self) -> UpdateGroupProfile<C, M, R>

Constructs a fluent builder for the UpdateGroupProfile operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>): A universally unique identifier.
  • display_name(impl Into<String>) / set_display_name(Option<String>): Represent a resource’s readable display name.
  • bio(impl Into<String>) / set_bio(Option<String>): Detailed information about a profile.
  • publicity(GroupPublicity) / set_publicity(Option<GroupPublicity>): The current publicity value for the given group.
• On success, responds with UpdateGroupProfileOutput
• On failure, responds with SdkError<UpdateGroupProfileError>

pub fn validate_group_profile(&self) -> ValidateGroupProfile<C, M, R>

Constructs a fluent builder for the ValidateGroupProfile operation.

• The fluent builder is configurable:
  • display_name(impl Into<String>) / set_display_name(Option<String>): Represent a resource’s readable display name.
  • bio(impl Into<String>) / set_bio(Option<String>): Detailed information about a profile.
  • publicity(GroupPublicity) / set_publicity(Option<GroupPublicity>): The current publicity value for the given group.
• On success, responds with ValidateGroupProfileOutput with field(s):
  • errors(Option<Vec<ValidationError>>): A list of validation errors.
• On failure, responds with SdkError<ValidateGroupProfileError>

Trait Implementations

impl Deref for ClientWrapper

type Target = Client<DynConnector, Identity>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.