users

package
v0.21.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 15, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package users contains methods related to Users

Package users contains methods related to Users

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type UsersV1 

type UsersV1 struct {
	// contains filtered or unexported fields
}

UsersV1 represents a custom type struct

func (*UsersV1) ChangePassword 

func (u *UsersV1) ChangePassword(
	userId int64,
	body *models.ChangePasswordV1Request) (
	*models.ChangePasswordResponse, *apiutils.APIError)

ChangePassword Change the password of the specified user. Users can change their own passwords.

func (*UsersV1) CreateUser 

func (u *UsersV1) CreateUser(
	body *models.CreateUserV1Request) (
	*models.CreateUserResponseV1, *apiutils.APIError)

CreateUser Creates a new user. Specify the user's full name and email address to generate an email message that is sent to the user with an invitation to activate their Clumio account.

func (*UsersV1) DeleteUser 

func (u *UsersV1) DeleteUser(
	userId int64) (
	*models.DeleteUserResponseV1, *apiutils.APIError)

DeleteUser Deletes an existing user from Clumio, revoking the user's access to Clumio. A deleted user cannot be recovered.

func (*UsersV1) ListUsers 

func (u *UsersV1) ListUsers(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListUsersResponseV1, *apiutils.APIError)

ListUsers Returns a list of Clumio users.

func (*UsersV1) ReadUser 

func (u *UsersV1) ReadUser(
	userId int64) (
	*models.ReadUserResponseV1, *apiutils.APIError)

ReadUser Returns a representation of the specified Clumio user.

func (*UsersV1) UpdateUser 

func (u *UsersV1) UpdateUser(
	userId int64,
	body *models.UpdateUserV1Request) (
	*models.UpdateUserResponseV1, *apiutils.APIError)

UpdateUser Manages an existing user. Managing a user includes enabling or disabling the user, 

changing the user's full name or updating the user's role.

func (*UsersV1) UpdateUserProfile 

func (u *UsersV1) UpdateUserProfile(
	body *models.UpdateUserProfileV1Request) (
	*models.EditProfileResponseV1, *apiutils.APIError)

UpdateUserProfile Manages the current user's profile, such as changing the user's full name.

type UsersV1Client 

type UsersV1Client interface {
	// ListUsers Returns a list of Clumio users.
	ListUsers(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListUsersResponseV1, *apiutils.APIError)

	// CreateUser Creates a new user. Specify the user's full name and email address to generate an email message that is sent to the user with an invitation to activate their Clumio account.
	CreateUser(
		body *models.CreateUserV1Request) (
		*models.CreateUserResponseV1, *apiutils.APIError)

	// UpdateUserProfile Manages the current user's profile, such as changing the user's full name.
	UpdateUserProfile(
		body *models.UpdateUserProfileV1Request) (
		*models.EditProfileResponseV1, *apiutils.APIError)

	// ReadUser Returns a representation of the specified Clumio user.
	ReadUser(
		userId int64) (
		*models.ReadUserResponseV1, *apiutils.APIError)

	// DeleteUser Deletes an existing user from Clumio, revoking the user's access to Clumio. A deleted user cannot be recovered.
	DeleteUser(
		userId int64) (
		*models.DeleteUserResponseV1, *apiutils.APIError)

	// UpdateUser Manages an existing user. Managing a user includes enabling or disabling the user,
	//  changing the user's full name or updating the user's role.
	UpdateUser(
		userId int64,
		body *models.UpdateUserV1Request) (
		*models.UpdateUserResponseV1, *apiutils.APIError)

	// ChangePassword Change the password of the specified user. Users can change their own passwords.
	ChangePassword(
		userId int64,
		body *models.ChangePasswordV1Request) (
		*models.ChangePasswordResponse, *apiutils.APIError)
}

UsersV1Client represents a custom type interface

func NewUsersV1 

func NewUsersV1(config config.Config) UsersV1Client

NewUsersV1 returns UsersV1Client

type UsersV2 added in v0.8.0 

type UsersV2 struct {
	// contains filtered or unexported fields
}

UsersV2 represents a custom type struct

func (*UsersV2) ChangePassword added in v0.8.0 

func (u *UsersV2) ChangePassword(
	body *models.ChangePasswordV2Request) (
	*models.ChangePasswordResponse, *apiutils.APIError)

ChangePassword Change the password of the current user. Users can only change their own passwords.

func (*UsersV2) CreateUser added in v0.8.0 

func (u *UsersV2) CreateUser(
	body *models.CreateUserV2Request) (
	*models.CreateUserResponse, *apiutils.APIError)

CreateUser Creates a new user. Specify the user's full name and email address to generate an email message that is sent to the user with an invitation to activate their Clumio account.

func (*UsersV2) DeleteUser added in v0.8.0 

func (u *UsersV2) DeleteUser(
	userId int64) (
	interface{}, *apiutils.APIError)

DeleteUser Deletes an existing user from Clumio, revoking the user's access to Clumio. A deleted user cannot be recovered.

func (*UsersV2) ListUsers added in v0.8.0 

func (u *UsersV2) ListUsers(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListUsersResponse, *apiutils.APIError)

ListUsers Returns a list of Clumio users.

func (*UsersV2) ReadUser added in v0.8.0 

func (u *UsersV2) ReadUser(
	userId int64) (
	*models.ReadUserResponse, *apiutils.APIError)

ReadUser Returns a representation of the specified Clumio user.

func (*UsersV2) UpdateUser added in v0.8.0 

func (u *UsersV2) UpdateUser(
	userId int64,
	body *models.UpdateUserV2Request) (
	*models.UpdateUserResponse, *apiutils.APIError)

UpdateUser Manages an existing user. Managing a user includes enabling or disabling the user, 

changing the user's full name or updating the user's access control.

func (*UsersV2) UpdateUserProfile added in v0.8.0 

func (u *UsersV2) UpdateUserProfile(
	body *models.UpdateUserProfileV2Request) (
	*models.EditProfileResponse, *apiutils.APIError)

UpdateUserProfile Manages the current user's profile, such as changing the user's full name.

type UsersV2Client added in v0.8.0 

type UsersV2Client interface {
	// ListUsers Returns a list of Clumio users.
	ListUsers(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListUsersResponse, *apiutils.APIError)

	// CreateUser Creates a new user. Specify the user's full name and email address to generate an email message that is sent to the user with an invitation to activate their Clumio account.
	CreateUser(
		body *models.CreateUserV2Request) (
		*models.CreateUserResponse, *apiutils.APIError)

	// ChangePassword Change the password of the current user. Users can only change their own passwords.
	ChangePassword(
		body *models.ChangePasswordV2Request) (
		*models.ChangePasswordResponse, *apiutils.APIError)

	// UpdateUserProfile Manages the current user's profile, such as changing the user's full name.
	UpdateUserProfile(
		body *models.UpdateUserProfileV2Request) (
		*models.EditProfileResponse, *apiutils.APIError)

	// ReadUser Returns a representation of the specified Clumio user.
	ReadUser(
		userId int64) (
		*models.ReadUserResponse, *apiutils.APIError)

	// DeleteUser Deletes an existing user from Clumio, revoking the user's access to Clumio. A deleted user cannot be recovered.
	DeleteUser(
		userId int64) (
		interface{}, *apiutils.APIError)

	// UpdateUser Manages an existing user. Managing a user includes enabling or disabling the user,
	//  changing the user's full name or updating the user's access control.
	UpdateUser(
		userId int64,
		body *models.UpdateUserV2Request) (
		*models.UpdateUserResponse, *apiutils.APIError)
}

UsersV2Client represents a custom type interface

func NewUsersV2 added in v0.8.0 

func NewUsersV2(config config.Config) UsersV2Client

NewUsersV2 returns UsersV2Client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.