-
Notifications
You must be signed in to change notification settings - Fork 51
Add support for retrieving Zoom Phone call queues #468
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
MacgyverH
wants to merge
8
commits into
Jericho:develop
Choose a base branch
from
MacgyverH:feature-CallQueues
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
223ac5d
Add support for retrieving Zoom Phone call queues
MacgyverH 97597f7
Refactor CallQueue models and added missing documentation
MacgyverH 4e41e74
Formatting Fixes for ICallQueues.cs
MacgyverH d085586
Use Site model and rename call queue params
MacgyverH 273a31a
Move call queues into Phone resource
MacgyverH d30f607
Add CallQueueStatus; remove CallQueues property
MacgyverH 041d561
Use CallQueueStatus enum for Status property
MacgyverH 6356ed3
Add CallQueueNumberSource enum and use in model
MacgyverH File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| using System.Collections.Generic; | ||
| using System.Text.Json.Serialization; | ||
|
|
||
| namespace ZoomNet.Models | ||
| { | ||
| /// <summary> | ||
| /// A Call Queue. | ||
| /// </summary> | ||
| public class CallQueue | ||
| { | ||
| /// <summary> | ||
| /// Gets or sets the extension id. | ||
| /// </summary> | ||
| [JsonPropertyName("extension_id")] | ||
| public string ExtensionId { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the extension number. | ||
| /// </summary> | ||
| [JsonPropertyName("extension_number")] | ||
| public long? ExtensionNumber { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the unique identifier of the call queue. | ||
| /// </summary> | ||
| [JsonPropertyName("id")] | ||
| public string Id { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the name of the call queue. | ||
| /// </summary> | ||
| [JsonPropertyName("name")] | ||
| public string Name { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the phone numbers assigned to the call queue. | ||
| /// </summary> | ||
| [JsonPropertyName("phone_numbers")] | ||
| public List<CallQueuePhoneNumber> PhoneNumbers { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the site information. | ||
| /// </summary> | ||
| [JsonPropertyName("site")] | ||
| public CallQueueSite Site { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the status of the call queue. | ||
| /// </summary> | ||
| [JsonPropertyName("status")] | ||
| public string Status { get; set; } | ||
|
MacgyverH marked this conversation as resolved.
Outdated
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| using System.Text.Json.Serialization; | ||
|
|
||
| namespace ZoomNet.Models | ||
| { | ||
| /// <summary> | ||
| /// Represents a member of a call queue, which can be a user or a common area. | ||
| /// </summary> | ||
| public class CallQueueMember | ||
| { | ||
| /// <summary> | ||
| /// Gets or sets the member id. | ||
| /// </summary> | ||
| [JsonPropertyName("id")] | ||
| public string Id { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the level of the member. | ||
| /// </summary> | ||
| [JsonPropertyName("level")] | ||
| public string Level { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the name of the user or common area. | ||
| /// </summary> | ||
| [JsonPropertyName("name")] | ||
| public string Name { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets a value indicating whether the user can receive calls. It displays if the level is user. | ||
| /// </summary> | ||
| [JsonPropertyName("receive_call")] | ||
| public bool ReceiveCall { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the extension ID of the user or common area. | ||
| /// </summary> | ||
| [JsonPropertyName("extension_id")] | ||
| public string ExtensionId { get; set; } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Text.Json.Serialization; | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace ZoomNet.Models | ||
| { | ||
| /// <summary> | ||
| /// Represents a phone number assigned to a call queue. | ||
| /// </summary> | ||
| public class CallQueuePhoneNumber | ||
| { | ||
| /// <summary> | ||
| /// Gets or sets the unique identifier of the phone number. | ||
| /// </summary> | ||
| [JsonPropertyName("id")] | ||
| public string Id { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the phone number. | ||
| /// </summary> | ||
| [JsonPropertyName("number")] | ||
| public string Number { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// gets or sets the source of the phone number. | ||
| /// </summary> | ||
| [JsonPropertyName("source")] | ||
| public string Source { get; set; } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Text.Json.Serialization; | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace ZoomNet.Models | ||
| { | ||
| /// <summary> | ||
| /// Represents a site where a Call Queue is assigned. | ||
| /// </summary> | ||
| public class CallQueueSite | ||
|
MacgyverH marked this conversation as resolved.
Outdated
|
||
| { | ||
| /// <summary> | ||
| /// Gets or sets the Unique identifier of the site where the Call Queue is assigned. | ||
| /// </summary> | ||
| [JsonPropertyName("id")] | ||
| public string Id { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the name of the site. | ||
| /// </summary> | ||
| [JsonPropertyName("name")] | ||
| public string Name { get; set; } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| using Pathoschild.Http.Client; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using ZoomNet.Models; | ||
| using ZoomNet.Utilities; | ||
|
|
||
| namespace ZoomNet.Resources | ||
| { | ||
| /// <inheritdoc/> | ||
| public class CallQueues : ICallQueues | ||
| { | ||
| private readonly IClient _client; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="CallQueues" /> class. | ||
| /// </summary> | ||
| /// <param name="client">The HTTP client.</param> | ||
| internal CallQueues(IClient client) | ||
| { | ||
| _client = client; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public Task<CallQueue> GetAsync(string callQueueId, CancellationToken cancellationToken = default) | ||
| { | ||
| return _client | ||
| .GetAsync($"phone/call_queues/{callQueueId}") | ||
| .WithCancellationToken(cancellationToken) | ||
| .AsObject<CallQueue>(); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public Task<PaginatedResponseWithToken<CallQueue>> GetAllAsync(string department = null, string cost_center = null, string site_id = null, int recordsPerPage = 30, string pagingToken = null, CancellationToken cancellationToken = default) | ||
|
MacgyverH marked this conversation as resolved.
Outdated
|
||
| { | ||
| Utils.ValidateRecordPerPage(recordsPerPage, max: 100); | ||
|
|
||
| return _client | ||
| .GetAsync($"phone/call_queues") | ||
| .WithArgument("department", department) | ||
| .WithArgument("cost_center", cost_center) | ||
| .WithArgument("site_id", site_id) | ||
| .WithArgument("page_size", recordsPerPage) | ||
| .WithArgument("next_page_token", pagingToken) | ||
| .WithCancellationToken(cancellationToken) | ||
| .AsPaginatedResponseWithToken<CallQueue>("call_queues"); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public Task<PaginatedResponseWithToken<CallQueueMember>> GetMembersAsync(string callQueueId, int recordsPerPage = 30, string pagingToken = null, CancellationToken cancellationToken = default) | ||
| { | ||
| Utils.ValidateRecordPerPage(recordsPerPage); | ||
| return _client | ||
| .GetAsync($"phone/call_queues/{callQueueId}/members") | ||
| .WithArgument("page_size", recordsPerPage) | ||
| .WithArgument("next_page_token", pagingToken) | ||
| .WithCancellationToken(cancellationToken) | ||
| .AsPaginatedResponseWithToken<CallQueueMember>("call_queue_members"); | ||
| } | ||
| } | ||
| } | ||
|
MacgyverH marked this conversation as resolved.
Outdated
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using ZoomNet.Models; | ||
|
|
||
| namespace ZoomNet.Resources | ||
| { | ||
| /// <summary> | ||
| /// Allows you to manage call queues. | ||
| /// </summary> | ||
| public interface ICallQueues | ||
| { | ||
| /// <summary> | ||
| /// Get call queue details. | ||
| /// </summary> | ||
| /// <param name="callQueueId">The ID of the call queue.</param> | ||
| /// <param name="cancellationToken">The cancellation token.</param> | ||
| /// <returns> | ||
| /// Details about a <see cref="CallQueue"/>. | ||
| /// </returns> | ||
| public Task<CallQueue> GetAsync(string callQueueId, CancellationToken cancellationToken = default); | ||
|
|
||
| /// <summary> | ||
| /// Get call queues. | ||
| /// </summary> | ||
| /// <param name="department">Filter by department.</param> | ||
| /// <param name="cost_center">Filter by cost center.</param> | ||
| /// <param name="site_id">Filter by site id.</param> | ||
| /// <param name="recordsPerPage">The number of records to return.</param> | ||
| /// <param name="pagingToken">The paging token.</param> | ||
| /// <param name="cancellationToken">The cancellation token.</param> | ||
| /// <returns> | ||
| /// A paginated response of <see cref="CallQueue"/>. | ||
| /// </returns> | ||
| public Task<PaginatedResponseWithToken<CallQueue>> GetAllAsync(string department = null, string cost_center = null, string site_id = null, int recordsPerPage = 30, string pagingToken = null, CancellationToken cancellationToken = default); | ||
|
MacgyverH marked this conversation as resolved.
Outdated
|
||
|
|
||
| /// <summary> | ||
| /// Get members currently in call queues. | ||
| /// </summary> | ||
| /// <param name="callQueueId">The ID of the call queue.</param> | ||
| /// <param name="recordsPerPage">The number of records to return.</param> | ||
| /// <param name="pagingToken">The paging token.</param> | ||
| /// <param name="cancellationToken">The cancellation token.</param> | ||
| /// <returns>An array of current call queue membership entries.</returns> | ||
| public Task<PaginatedResponseWithToken<CallQueueMember>> GetMembersAsync(string callQueueId, int recordsPerPage = 30, string pagingToken = null, CancellationToken cancellationToken = default); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.