Skip to content

UsersApi.md

Latest commit

 

History

History
380 lines (262 loc) · 12.3 KB

UsersApi.md

File metadata and controls

380 lines (262 loc) · 12.3 KB

SunshineConversationsClient::UsersApi

All URIs are relative to https://api.smooch.io

Method HTTP request Description
create_user POST /v2/apps/{appId}/users Create User
delete_user DELETE /v2/apps/{appId}/users/{userIdOrExternalId} Delete User
delete_user_personal_information DELETE /v2/apps/{appId}/users/{userIdOrExternalId}/personalinformation Delete User Personal Information
get_user GET /v2/apps/{appId}/users/{userIdOrExternalId} Get User
sync_user POST /v2/apps/{appId}/users/{zendeskId}/sync Synchronize User
update_user PATCH /v2/apps/{appId}/users/{userIdOrExternalId} Update User

create_user

UserResponse create_user(app_id, user_create_body)

Create User

Creates a new user.

Example

# load the gem
require 'sunshine-conversations-client'
# setup authorization
SunshineConversationsClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Configure Bearer authorization (JWT): bearerAuth
  # Uncomment this line to use JWTs
  # config.access_token = 'YOUR_JWT'
end

api_instance = SunshineConversationsClient::UsersApi.new
app_id = 5d8cff3cd55b040010928b5b # String | Identifies the app.
user_create_body =  # UserCreateBody | 
# Be sure to add the required body parameters

begin
  #Create User
  result = api_instance.create_user(app_id, user_create_body)
  p result
rescue SunshineConversationsClient::ApiError => e
  puts "Exception when calling UsersApi->create_user: #{e}"
end

Parameters

Name Type Description Notes
app_id String Identifies the app.
user_create_body UserCreateBody

Return type

UserResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_user

Object delete_user(app_id, user_id_or_external_id)

Delete User

Delete a user, its clients and its conversation history. The user is considered completely deleted once the user:delete webhook is fired. To only delete a user’s personal information, see Delete User Personal Information.

Example

# load the gem
require 'sunshine-conversations-client'
# setup authorization
SunshineConversationsClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Configure Bearer authorization (JWT): bearerAuth
  # Uncomment this line to use JWTs
  # config.access_token = 'YOUR_JWT'
end

api_instance = SunshineConversationsClient::UsersApi.new
app_id = 5d8cff3cd55b040010928b5b # String | Identifies the app.
user_id_or_external_id = 42589ad070d43be9b00ff7e5 # String | The user's id or externalId.
# Be sure to add the required body parameters

begin
  #Delete User
  result = api_instance.delete_user(app_id, user_id_or_external_id)
  p result
rescue SunshineConversationsClient::ApiError => e
  puts "Exception when calling UsersApi->delete_user: #{e}"
end

Parameters

Name Type Description Notes
app_id String Identifies the app.
user_id_or_external_id String The user's id or externalId.

Return type

Object

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

delete_user_personal_information

UserResponse delete_user_personal_information(app_id, user_id_or_external_id)

Delete User Personal Information

Delete a user’s personal information. Calling this API will clear givenName, surname, email and avatarUrl and every custom property for the specified user. For every client owned by the user, it will also clear displayName, avatarUrl and any channel specific information stored in the info and raw fields. Calling this API doesn’t delete the user’s conversation history. To fully delete the user, see Delete User.

Example

# load the gem
require 'sunshine-conversations-client'
# setup authorization
SunshineConversationsClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Configure Bearer authorization (JWT): bearerAuth
  # Uncomment this line to use JWTs
  # config.access_token = 'YOUR_JWT'
end

api_instance = SunshineConversationsClient::UsersApi.new
app_id = 5d8cff3cd55b040010928b5b # String | Identifies the app.
user_id_or_external_id = 42589ad070d43be9b00ff7e5 # String | The user's id or externalId.
# Be sure to add the required body parameters

begin
  #Delete User Personal Information
  result = api_instance.delete_user_personal_information(app_id, user_id_or_external_id)
  p result
rescue SunshineConversationsClient::ApiError => e
  puts "Exception when calling UsersApi->delete_user_personal_information: #{e}"
end

Parameters

Name Type Description Notes
app_id String Identifies the app.
user_id_or_external_id String The user's id or externalId.

Return type

UserResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_user

UserResponse get_user(app_id, user_id_or_external_id)

Get User

Fetches an individual user.

Example

# load the gem
require 'sunshine-conversations-client'
# setup authorization
SunshineConversationsClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Configure Bearer authorization (JWT): bearerAuth
  # Uncomment this line to use JWTs
  # config.access_token = 'YOUR_JWT'
end

api_instance = SunshineConversationsClient::UsersApi.new
app_id = 5d8cff3cd55b040010928b5b # String | Identifies the app.
user_id_or_external_id = 42589ad070d43be9b00ff7e5 # String | The user's id or externalId.
# Be sure to add the required body parameters

begin
  #Get User
  result = api_instance.get_user(app_id, user_id_or_external_id)
  p result
rescue SunshineConversationsClient::ApiError => e
  puts "Exception when calling UsersApi->get_user: #{e}"
end

Parameters

Name Type Description Notes
app_id String Identifies the app.
user_id_or_external_id String The user's id or externalId.

Return type

UserResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

sync_user

UserResponse sync_user(app_id, zendesk_id, opts)

Synchronize User

Synchronize a messaging user with its core Zendesk user counterpart. Messaging users are separate objects linked to a core Zendesk user record by zendeskId. It is possible for changes to be made to the core Zendesk user record in a way that causes the messaging user to fall out of sync. The core Zendesk user might have their primary email changed, for example. This endpoint can be used to update the messaging user with the profile.givenName, profile.surname, externalId, and primary email identity of its core Zendesk user counterpart.

It is also possible for two Zendesk users to be merged. In such a case, this API can be used to apply that merger on the messaging side. The surviving Zendesk user id can be specified via the survivingZendeskId parameter of the request body, and the outgoing zendeskId is specified in the request path. <aside class="notice">Note: Only the primary email identity of the core Zendesk user will be synchronized, and it will be set on the identities array, not in the profile.
<aside class="notice">Note: In some circumstances, a single call to this API might produce changes on more than one messaging user. If the externalId or email being synchronized already exists on a different messaging user within the account, the conflict will be resolved by merging those messaging users together, if possible. If a conflicting messaging user is already linked to a core Zendesk user by zendeskId it cannot be merged. In this case, the conflicting externalId or email will instead be removed and reassigned to the messaging user that is being synchronized.

Example

# load the gem
require 'sunshine-conversations-client'
# setup authorization
SunshineConversationsClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Configure Bearer authorization (JWT): bearerAuth
  # Uncomment this line to use JWTs
  # config.access_token = 'YOUR_JWT'
end

api_instance = SunshineConversationsClient::UsersApi.new
app_id = 5d8cff3cd55b040010928b5b # String | Identifies the app.
zendesk_id = 35436 # String | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API. 
# Be sure to add the required body parameters
opts = {
  sync_user_body:  # SyncUserBody | 
}

begin
  #Synchronize User
  result = api_instance.sync_user(app_id, zendesk_id, opts)
  p result
rescue SunshineConversationsClient::ApiError => e
  puts "Exception when calling UsersApi->sync_user: #{e}"
end

Parameters

Name Type Description Notes
app_id String Identifies the app.
zendesk_id String The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API.
sync_user_body SyncUserBody [optional]

Return type

UserResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_user

UserResponse update_user(app_id, user_id_or_external_id, user_update_body)

Update User

Updates a user.

Example

# load the gem
require 'sunshine-conversations-client'
# setup authorization
SunshineConversationsClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Configure Bearer authorization (JWT): bearerAuth
  # Uncomment this line to use JWTs
  # config.access_token = 'YOUR_JWT'
end

api_instance = SunshineConversationsClient::UsersApi.new
app_id = 5d8cff3cd55b040010928b5b # String | Identifies the app.
user_id_or_external_id = 42589ad070d43be9b00ff7e5 # String | The user's id or externalId.
user_update_body =  # UserUpdateBody | 
# Be sure to add the required body parameters

begin
  #Update User
  result = api_instance.update_user(app_id, user_id_or_external_id, user_update_body)
  p result
rescue SunshineConversationsClient::ApiError => e
  puts "Exception when calling UsersApi->update_user: #{e}"
end

Parameters

Name Type Description Notes
app_id String Identifies the app.
user_id_or_external_id String The user's id or externalId.
user_update_body UserUpdateBody

Return type

UserResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json