dealcloud v0.4.0

View Source Dealcloud.Management (dealcloud v0.4.0)

Management contains all of the apis needed to work with users

With these APIs you are able to:

  1. Get Users, ~> By email, By modified data, by Id
  2. Create Users
  3. Update users ~> change users names, active/inactive, change email addresses, change user permissions
  4. Delete users
  5. Get User groups
  6. Get user group details
  7. Get user activities
  8. Get proxy assignments
  9. Create proxy assignments

Link to this section Summary

Types

activityQuery()
license()
proxy()
proxyQuery()
query()
user()

Functions

create_user_proxy(body, config)

This creates new proxy assignments. There's no way to update an existing proxy assignments. Proxy assignments can be replaced

create_users(body, config)

Takes a list of Dealcloud.Management.user() and creates them as new

delete_user(userId, config)

Takes a user id and deletes the associated user

get_by_ids(param, config)

Takes a list of integers representing the user's Id and returns the users

get_user(param, config)

Takes a query containing either the user's email address or a dateTime, attempts to find the user or return all user modified since the dateTime provided

get_user_activity(body, config)

These are the user activity APIs ## Examples

get_user_activity(body, query, config)

These are the user activity APIs ## Examples

get_user_group(groupId, config)

These are the user group APIs

get_user_groups(config)

These are the user group APIs

get_user_license(userId, config)

These are the user license APIs

get_user_proxy(query, config)

These are the user proxy APIs

get_users_license(config)

Get all licenses

get_users_license(params, config)

Get licenses for multiple users

update_user(body, config)

Takes a list of Dealcloud.Management.user() and updates them

update_user_license(license, config)

Update licenses

user_get_by_id(param, config)

Takes a integer representing the user's Id and returns the user

Link to this section Types

Link to this type

activityQuery()

View Source

Specs

activityQuery() :: %Dealcloud.Management.ActivityQuery{
  activity: term(),
  dateFrom: term(),
  dateTo: term(),
  source: term(),
  userIds: term()
}
Link to this type

license()

View Source

Specs

license() :: %Dealcloud.Management.License{
  description: term(),
  licenseType: term(),
  userId: term()
}
Link to this type

proxy()

View Source

Specs

proxy() :: %Dealcloud.Management.Proxy{proxyUserId: term(), userIds: term()}
Link to this type

proxyQuery()

View Source

Specs

proxyQuery() :: %Dealcloud.Management.ProxyQuery{
  pageNumber: term(),
  pageSize: term(),
  proxyQuery: term(),
  searchByName: term(),
  userQuery: term()
}
Link to this type

query()

View Source

Specs

query() :: %Dealcloud.Management.Query{
  email: term(),
  isBillable: term(),
  modifiedSince: term(),
  pageNumber: term(),
  pageSize: term()
}
Link to this type

user()

View Source

Specs

user() :: %Dealcloud.Management.User{
  createdBy: term(),
  createdDate: term(),
  email: term(),
  federationId: term(),
  firstName: term(),
  group: term(),
  id: term(),
  isActive: term(),
  isLocked: term(),
  lastName: term(),
  modifiedBy: term(),
  modifiedDate: term()
}

Link to this section Functions

Link to this function

create_user_proxy(body, config)

View Source

Specs

create_user_proxy(Dealcloud.Management.Proxy, Dealcloud.Auth) :: any()

This creates new proxy assignments. There's no way to update an existing proxy assignments. Proxy assignments can be replaced

Examples 

Dealcloud.Management.get_user_proxy(%Dealcloud.Management.Proxy{proxyUserId: 1, userIds: [2,3,4]}, Dealcloud.Auth)
Link to this function

create_users(body, config)

View Source

Specs

create_users([User], Dealcloud.Auth) :: any()

Takes a list of Dealcloud.Management.user() and creates them as new

Examples 

Dealcloud.Management.create_users([%User{ firstName: "James", lastName: "King", email: "kingj@basketball.com"}], Dealcloud.Auth)
Link to this function

delete_user(userId, config)

View Source

Specs

delete_user(binary(), Dealcloud.Auth) :: any()

Takes a user id and deletes the associated user

Examples 

Dealcloud.Management.delete_users(1, Dealcloud.Auth)
Link to this function

get_by_ids(param, config)

View Source

Specs

get_by_ids([integer()], Dealcloud.Auth) :: any()

Takes a list of integers representing the user's Id and returns the users

Examples 

Dealcloud.Management.get_by_ids([1,2,3], Dealcloud.Auth)
Link to this function

get_user(param, config)

View Source

Specs

get_user(Dealcloud.Management.Query, Dealcloud.Auth) :: any()

Takes a query containing either the user's email address or a dateTime, attempts to find the user or return all user modified since the dateTime provided

Examples 

iex> Dealcloud.Management.get_user(%Dealcloud.Management.Query{email: "test@email.com"}, Dealcloud.Auth)

or

iex> Dealcloud.Management.get_user(%Dealcloud.Management.Query{ModifiedSince: "2019-07-15T15:53:00.050Z"}, Dealcloud.Auth)
Link to this function

get_user_activity(body, config)

View Source

Specs

get_user_activity(Dealcloud.Management.ActivityQuery, Dealcloud.Auth) :: any()

These are the user activity APIs ## Examples

Dealcloud.Management.get_user_activity(%Dealcloud.Management.ActivityQuery{},%Dealcloud.Auth{})
Link to this function

get_user_activity(body, query, config)

View Source

Specs

get_user_activity(
  Dealcloud.Management.ActivityQuery,
  Dealcloud.Management.UserQuery,
  Dealcloud.Auth
) :: any()

These are the user activity APIs ## Examples

Dealcloud.Management.get_user_activity(%Dealcloud.Management.ActivityQuery{},%Dealcloud.Management.UserQuery{}, %Dealcloud.Auth{})
Link to this function

get_user_group(groupId, config)

View Source

Specs

get_user_group(integer(), Dealcloud.Auth) :: any()

These are the user group APIs

Examples 

Dealcloud.Management.get_user_group(1, Dealcloud.Auth)
Link to this function

get_user_groups(config)

View Source

Specs

get_user_groups(Dealcloud.Auth) :: any()

These are the user group APIs

Examples 

Dealcloud.Management.get_user_groups(Dealcloud.Auth)
Link to this function

get_user_license(userId, config)

View Source

Specs

get_user_license(integer(), Dealcloud.Auth) :: any()

These are the user license APIs

Examples 

Dealcloud.Management.get_user_license(1, Dealcloud.Auth)
Link to this function

get_user_proxy(query, config)

View Source

Specs

get_user_proxy(Dealcloud.Management.ProxyQuery, Dealcloud.Auth) :: any()

These are the user proxy APIs

There are two ways to query for proxies, you can search by user or by the proxy

Examples 

Dealcloud.Management.get_user_proxy(%Dealcloud.Management.ProxyQuery{proxyQuery: "test@user.com"}, Dealcloud.Auth)
Dealcloud.Management.get_user_proxy(%Dealcloud.Management.ProxyQuery{userQuery: "test@user.com"}, Dealcloud.Auth)
Link to this function

get_users_license(config)

View Source

Specs

get_users_license(Dealcloud.Auth) :: any()

Get all licenses

Examples 

Dealcloud.Management.get_user_license(Dealcloud.Auth)
Link to this function

get_users_license(params, config)

View Source

Specs

get_users_license(Dealcloud.Management.Query, Dealcloud.Auth) :: any()

Get licenses for multiple users

Examples 

Dealcloud.Management.get_users_license(%Dealcloud.Management.Query{isBillable: true}, Dealcloud.Auth)
Link to this function

update_user(body, config)

View Source

Specs

update_user(integer(), Dealcloud.Auth) :: any()

Takes a list of Dealcloud.Management.user() and updates them

Examples 

Dealcloud.Management.update_users([%User{ id: 1, firstName: "James", lastName: "King", email: "kingj@basketball.com"}], Dealcloud.Auth)
Link to this function

update_user_license(license, config)

View Source

Specs

update_user_license(Dealcloud.Management.License, Dealcloud.Auth) :: :ok

Update licenses

Examples 

Dealcloud.Management.update_user_license(%Dealcloud.Management.License{userId: 1, licenseType: 1}, Dealcloud.Auth)
Link to this function

user_get_by_id(param, config)

View Source

Specs

user_get_by_id(integer(), Dealcloud.Auth) :: any()

Takes a integer representing the user's Id and returns the user

Examples 

iex> Dealcloud.Management.user_get_by_id(1, Dealcloud.Auth)