/// <summary>
/// Updating a channel This method updates an existing channel from given attributes and renders it in case of success. Authorization: only users that are able to update channels.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="channelId"></param>
/// <param name="name">The name of the channel. (optional)</param>
/// <param name="sourceIds">An array containing id of each source assigned to a channel (multiple). (optional)</param>
/// <param name="softCapability">Number of tasks that can be assigned to agent by the routing before they are considered \"occupied\". (optional)</param>
/// <param name="hardCapability">Maximum number of tasks that can be assigned to agents. (optional)</param>
/// <param name="taskTimeoutSeconds">this field defines the time before a task expires (in seconds). (optional)</param>
/// <returns>Task of Channel</returns>
public async System.Threading.Tasks.Task <Channel> UpdateChannelAsync(string channelId, string name = default(string), Collection <string> sourceIds = default(Collection <string>), int?softCapability = default(int?), int?hardCapability = default(int?), int?taskTimeoutSeconds = default(int?))
{
RingCentral.EngageDigital.Client.ApiResponse <Channel> localVarResponse = await UpdateChannelAsyncWithHttpInfo(channelId, name, sourceIds, softCapability, hardCapability, taskTimeoutSeconds);
return(localVarResponse.Data);
}
/// <summary>
/// Getting all identities This method renders identities ordered by creation date (descending). Only identities in sources where token’s user has “read” permission are returned.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="communityId">To filter identities on given community id. (optional)</param>
/// <param name="identityGroupId">To filter on given group id. (optional)</param>
/// <param name="userId">To filter identities on given user id. (optional)</param>
/// <param name="sort">To change the criteria chosen to sort the identities. The value can be “created_at” or (optional)</param>
/// <param name="foreignId">To filter identities on given user id (optional)</param>
/// <param name="uuid">To filter identities on given uuid (optional)</param>
/// <param name="offset">The record index to start. Default value is 0. (optional)</param>
/// <param name="limit">The max number of records to return. Default value is 30, max value is 150. (optional)</param>
/// <returns>Task of GetAllIdentitiesResponse</returns>
public async System.Threading.Tasks.Task <GetAllIdentitiesResponse> GetAllIdentitiesAsync(string communityId = default(string), string identityGroupId = default(string), string userId = default(string), string sort = default(string), string foreignId = default(string), string uuid = default(string), int?offset = default(int?), int?limit = default(int?))
{
RingCentral.EngageDigital.Client.ApiResponse <GetAllIdentitiesResponse> localVarResponse = await GetAllIdentitiesAsyncWithHttpInfo(communityId, identityGroupId, userId, sort, foreignId, uuid, offset, limit);
return(localVarResponse.Data);
}
/// <summary>
/// Getting a channel from its id This method renders a channel from given id.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="channelId"></param>
/// <returns>Task of Channel</returns>
public async System.Threading.Tasks.Task <Channel> GetChannelAsync(string channelId)
{
RingCentral.EngageDigital.Client.ApiResponse <Channel> localVarResponse = await GetChannelAsyncWithHttpInfo(channelId);
return(localVarResponse.Data);
}
/// <summary>
/// Getting a community from its id This method renders a community from given id.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="communityId"></param>
/// <returns>Community</returns>
public Community GetCommunity(string communityId)
{
RingCentral.EngageDigital.Client.ApiResponse <Community> localVarResponse = GetCommunityWithHttpInfo(communityId);
return(localVarResponse.Data);
}
/// <summary>
/// Getting all timezones This method renders all available timezones.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Collection<Timezone></returns>
public Collection <Timezone> GetAllTimezones()
{
RingCentral.EngageDigital.Client.ApiResponse <Collection <Timezone> > localVarResponse = GetAllTimezonesWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="tagId"></param>
/// <param name="name">Tag’s label.</param>
/// <returns>Tag</returns>
public Tag UpdateTag (string tagId, string name)
{
RingCentral.EngageDigital.Client.ApiResponse<Tag> localVarResponse = UpdateTagWithHttpInfo(tagId, name);
return localVarResponse.Data;
}
/// <summary>
/// Getting all communities This method renders communities ordered by creation date (ascending).
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="offset">The record index to start. Default value is 0. (optional)</param>
/// <param name="limit">The max number of records to return. Default value is 30, max value is 150. (optional)</param>
/// <returns>GetAllCommunitiesResponse</returns>
public GetAllCommunitiesResponse GetAllCommunities(int?offset = default(int?), int?limit = default(int?))
{
RingCentral.EngageDigital.Client.ApiResponse <GetAllCommunitiesResponse> localVarResponse = GetAllCommunitiesWithHttpInfo(offset, limit);
return(localVarResponse.Data);
}
/// <summary>
/// Getting all events This method renders events ordered by creation date (descending). Authorization: Only users whose role can search event permission.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="q">To filter events on given query. Query works exactly like threads query but only have those keywords: content, content_thread, name_in, created_before, created_after, user. Order can be created_at.desc (default) or created_at.asc. e.g. q=name_in:\"content.replied\"%20content_thread:\"7f946431b6eebffafae642cc\"%20created_after:\"2014-03-20\"%20user:\"4ee91f197aa58d01b500000f\"%20order:\"created_at.asc\" * DateTime parameters should be ISO-8601 * you can specify multiple value for a given keyword: q=name_in:’content.replied’&name_in:’content.ignored’ Please refer to Search & filtering parameters for more details. (optional)</param>
/// <param name="offset">The record index to start. Default value is 0. (optional)</param>
/// <param name="limit">The max number of records to return. Default value is 30, max value is 150. (optional)</param>
/// <returns>GetAllEventsResponse</returns>
public GetAllEventsResponse GetAllEvents(string q = default(string), int?offset = default(int?), int?limit = default(int?))
{
RingCentral.EngageDigital.Client.ApiResponse <GetAllEventsResponse> localVarResponse = GetAllEventsWithHttpInfo(q, offset, limit);
return(localVarResponse.Data);
}
/// <summary>
/// Getting an event from its id This method renders an event from given id. If token’s user role does not have “search event” permission a 404 HTTP response will be returned. Authorization: Only users who’s role can search event permission.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="eventId"></param>
/// <returns>Event</returns>
public Event GetEvent(string eventId)
{
RingCentral.EngageDigital.Client.ApiResponse <Event> localVarResponse = GetEventWithHttpInfo(eventId);
return(localVarResponse.Data);
}
/// <summary>
/// Get a connected agent status This method get the status of a connected agent. Returns a 404 if the user does not exist (not_found) or if he’s not connected (disconnected). Authorization: only users that have the right to monitor the task view.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="agentId"></param>
/// <returns>AgentStatus</returns>
public AgentStatus GetAgentStatus(string agentId)
{
RingCentral.EngageDigital.Client.ApiResponse <AgentStatus> localVarResponse = GetAgentStatusWithHttpInfo(agentId);
return(localVarResponse.Data);
}
/// <summary>
/// Get all connected agents status This method get all currently connected agents & their status. Authorization: only users that have the right to monitor the task view.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Collection<AgentStatus></returns>
public Collection <AgentStatus> GetAllAgentStatus()
{
RingCentral.EngageDigital.Client.ApiResponse <Collection <AgentStatus> > localVarResponse = GetAllAgentStatusWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Changing an agent's status This method updates an agent's availability. Can be used to set either channels statuses OR custom status. If both parameters are provided, ignores custom status.The status parameter **MUST** be either “away” or “available”. Authorization: only users that have the right to monitor the task view.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="agentId"></param>
/// <param name="status">A hash of channel_id => availability (must contain all channels). (optional)</param>
/// <param name="customStatusId">id of presence status (optional) (optional)</param>
/// <returns>Task of AgentStatus</returns>
public async System.Threading.Tasks.Task <AgentStatus> ChangeAgentStatusAsync(string agentId, string status = default(string), string customStatusId = default(string))
{
RingCentral.EngageDigital.Client.ApiResponse <AgentStatus> localVarResponse = await ChangeAgentStatusAsyncWithHttpInfo(agentId, status, customStatusId);
return(localVarResponse.Data);
}
/// <summary>
/// Changing an agent's status This method updates an agent's availability. Can be used to set either channels statuses OR custom status. If both parameters are provided, ignores custom status.The status parameter **MUST** be either “away” or “available”. Authorization: only users that have the right to monitor the task view.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="agentId"></param>
/// <param name="status">A hash of channel_id => availability (must contain all channels). (optional)</param>
/// <param name="customStatusId">id of presence status (optional) (optional)</param>
/// <returns>AgentStatus</returns>
public AgentStatus ChangeAgentStatus(string agentId, string status = default(string), string customStatusId = default(string))
{
RingCentral.EngageDigital.Client.ApiResponse <AgentStatus> localVarResponse = ChangeAgentStatusWithHttpInfo(agentId, status, customStatusId);
return(localVarResponse.Data);
}
/// <summary>
/// Getting an identity from its id This method renders an identity from given id. If token’s user does not have “read” on identity’s source community a 404 HTTP response will be returned.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="identityId"></param>
/// <returns>Identity</returns>
public Identity GetIdentity(string identityId)
{
RingCentral.EngageDigital.Client.ApiResponse <Identity> localVarResponse = GetIdentityWithHttpInfo(identityId);
return(localVarResponse.Data);
}
/// <summary>
/// Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="name">Tag name (mandatory).</param>
/// <returns>Tag</returns>
public Tag CreateTag (string name)
{
RingCentral.EngageDigital.Client.ApiResponse<Tag> localVarResponse = CreateTagWithHttpInfo(name);
return localVarResponse.Data;
}
/// <summary>
/// Creating an attachment This method allows you to create an new attachment.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="file"> (optional)</param>
/// <param name="_private"> (optional)</param>
/// <returns>Attachment</returns>
public Attachment CreateAttachment(System.IO.Stream file = default(System.IO.Stream), string _private = default(string))
{
RingCentral.EngageDigital.Client.ApiResponse <Attachment> localVarResponse = CreateAttachmentWithHttpInfo(file, _private);
return(localVarResponse.Data);
}
/// <summary>
/// Getting a tag from its id This method renders a tag from given id.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="tagId"></param>
/// <returns>Tag</returns>
public Tag GetTag (string tagId)
{
RingCentral.EngageDigital.Client.ApiResponse<Tag> localVarResponse = GetTagWithHttpInfo(tagId);
return localVarResponse.Data;
}
/// <summary>
/// Creating an attachment This method allows you to create an new attachment.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="file"> (optional)</param>
/// <param name="_private"> (optional)</param>
/// <returns>Task of Attachment</returns>
public async System.Threading.Tasks.Task <Attachment> CreateAttachmentAsync(System.IO.Stream file = default(System.IO.Stream), string _private = default(string))
{
RingCentral.EngageDigital.Client.ApiResponse <Attachment> localVarResponse = await CreateAttachmentAsyncWithHttpInfo(file, _private);
return(localVarResponse.Data);
}
/// <summary>
/// Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="tagId"></param>
/// <param name="name">Tag’s label.</param>
/// <returns>Task of Tag</returns>
public async System.Threading.Tasks.Task<Tag> UpdateTagAsync (string tagId, string name)
{
RingCentral.EngageDigital.Client.ApiResponse<Tag> localVarResponse = await UpdateTagAsyncWithHttpInfo(tagId, name);
return localVarResponse.Data;
}
/// <summary>
/// Getting an attachment from its id This method renders an attachment from given id.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="attachmentId"></param>
/// <returns>Attachment</returns>
public Attachment GetAttachment(string attachmentId)
{
RingCentral.EngageDigital.Client.ApiResponse <Attachment> localVarResponse = GetAttachmentWithHttpInfo(attachmentId);
return(localVarResponse.Data);
}
/// <summary>
/// Getting all communities This method renders communities ordered by creation date (ascending).
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="offset">The record index to start. Default value is 0. (optional)</param>
/// <param name="limit">The max number of records to return. Default value is 30, max value is 150. (optional)</param>
/// <returns>Task of GetAllCommunitiesResponse</returns>
public async System.Threading.Tasks.Task <GetAllCommunitiesResponse> GetAllCommunitiesAsync(int?offset = default(int?), int?limit = default(int?))
{
RingCentral.EngageDigital.Client.ApiResponse <GetAllCommunitiesResponse> localVarResponse = await GetAllCommunitiesAsyncWithHttpInfo(offset, limit);
return(localVarResponse.Data);
}
/// <summary>
/// Getting an attachment from its id This method renders an attachment from given id.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="attachmentId"></param>
/// <returns>Task of Attachment</returns>
public async System.Threading.Tasks.Task <Attachment> GetAttachmentAsync(string attachmentId)
{
RingCentral.EngageDigital.Client.ApiResponse <Attachment> localVarResponse = await GetAttachmentAsyncWithHttpInfo(attachmentId);
return(localVarResponse.Data);
}
/// <summary>
/// Getting a community from its id This method renders a community from given id.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="communityId"></param>
/// <returns>Task of Community</returns>
public async System.Threading.Tasks.Task <Community> GetCommunityAsync(string communityId)
{
RingCentral.EngageDigital.Client.ApiResponse <Community> localVarResponse = await GetCommunityAsyncWithHttpInfo(communityId);
return(localVarResponse.Data);
}
/// <summary>
/// Getting a channel from its id This method renders a channel from given id.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="channelId"></param>
/// <returns>Channel</returns>
public Channel GetChannel(string channelId)
{
RingCentral.EngageDigital.Client.ApiResponse <Channel> localVarResponse = GetChannelWithHttpInfo(channelId);
return(localVarResponse.Data);
}
/// <summary>
/// Getting all timezones This method renders all available timezones.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Task of Collection<Timezone></returns>
public async System.Threading.Tasks.Task <Collection <Timezone> > GetAllTimezonesAsync()
{
RingCentral.EngageDigital.Client.ApiResponse <Collection <Timezone> > localVarResponse = await GetAllTimezonesAsyncWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Getting all identities This method renders identities ordered by creation date (descending). Only identities in sources where token’s user has “read” permission are returned.
/// </summary>
/// <exception cref="RingCentral.EngageDigital.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="communityId">To filter identities on given community id. (optional)</param>
/// <param name="identityGroupId">To filter on given group id. (optional)</param>
/// <param name="userId">To filter identities on given user id. (optional)</param>
/// <param name="sort">To change the criteria chosen to sort the identities. The value can be “created_at” or (optional)</param>
/// <param name="foreignId">To filter identities on given user id (optional)</param>
/// <param name="uuid">To filter identities on given uuid (optional)</param>
/// <param name="offset">The record index to start. Default value is 0. (optional)</param>
/// <param name="limit">The max number of records to return. Default value is 30, max value is 150. (optional)</param>
/// <returns>GetAllIdentitiesResponse</returns>
public GetAllIdentitiesResponse GetAllIdentities(string communityId = default(string), string identityGroupId = default(string), string userId = default(string), string sort = default(string), string foreignId = default(string), string uuid = default(string), int?offset = default(int?), int?limit = default(int?))
{
RingCentral.EngageDigital.Client.ApiResponse <GetAllIdentitiesResponse> localVarResponse = GetAllIdentitiesWithHttpInfo(communityId, identityGroupId, userId, sort, foreignId, uuid, offset, limit);
return(localVarResponse.Data);
}