From 1d15afd94e442a9595334ae08eaeed68cb0922c4 Mon Sep 17 00:00:00 2001 From: Fu Diwei Date: Mon, 15 Aug 2022 21:37:09 +0800 Subject: [PATCH] =?UTF-8?q?feat(work):=20=E9=9A=8F=E5=AE=98=E6=96=B9?= =?UTF-8?q?=E6=A0=87=E8=AE=B0=E9=80=9A=E8=AE=AF=E5=BD=95=E5=90=8C=E6=AD=A5?= =?UTF-8?q?=E7=9B=B8=E5=85=B3=E6=8E=A5=E5=8F=A3=E6=88=96=E5=AD=97=E6=AE=B5?= =?UTF-8?q?=E4=B8=BA=E5=BA=9F=E5=BC=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Events/Contact/ChangeContactEvent.cs | 18 +++++++- ...atWorkClientExecuteCgibinUserExtensions.cs | 19 +++++++++ .../CgibinUser/CgibinUserListIdRequest.cs | 22 ++++++++++ .../CgibinUser/CgibinUserListIdResponse.cs | 42 +++++++++++++++++++ .../CgibinUser/CgibinUserListIdRequest.json | 4 ++ .../CgibinUser/CgibinUserListIdResponse.json | 19 +++++++++ 6 files changed, 123 insertions(+), 1 deletion(-) create mode 100644 src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdRequest.cs create mode 100644 src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdResponse.cs create mode 100644 test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdRequest.json create mode 100644 test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdResponse.json diff --git a/src/SKIT.FlurlHttpClient.Wechat.Work/Events/Contact/ChangeContactEvent.cs b/src/SKIT.FlurlHttpClient.Wechat.Work/Events/Contact/ChangeContactEvent.cs index 7b71e5d0..535a4adc 100644 --- a/src/SKIT.FlurlHttpClient.Wechat.Work/Events/Contact/ChangeContactEvent.cs +++ b/src/SKIT.FlurlHttpClient.Wechat.Work/Events/Contact/ChangeContactEvent.cs @@ -1,4 +1,6 @@ -namespace SKIT.FlurlHttpClient.Wechat.Work.Events +using System; + +namespace SKIT.FlurlHttpClient.Wechat.Work.Events { /// /// 表示 EVENT.change_contact 或 INFO.change_contact 事件的数据。 @@ -125,6 +127,7 @@ /// /// 获取或设置用户成员别名。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Alias", IsNullable = true)] public string? UserAlias { get; set; } @@ -137,72 +140,84 @@ /// /// 获取或设置用户的部门领导状态（以逗号分割）。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("IsLeaderInDept", IsNullable = true)] public string? UserDepartmentLeaderStatus { get; set; } /// /// 获取或设置用户的主部门 ID。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("MainDepartment", IsNullable = true)] public int? UserMainDepartmentId { get; set; } /// /// 获取或设置用户邮箱。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Email", IsNullable = true)] public string? UserEmail { get; set; } /// /// 获取或设置用户企业邮箱。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("BizMail", IsNullable = true)] public string? UserBusinessEmail { get; set; } /// /// 获取或设置用户手机号码。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Mobile", IsNullable = true)] public string? UserMobileNumber { get; set; } /// /// 获取或设置用户座机号码。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Telephone", IsNullable = true)] public string? UserTeleNumber { get; set; } /// /// 获取或设置用户性别。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Gender", IsNullable = true)] public int? UserGender { get; set; } /// /// 获取或设置用户地址。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Address", IsNullable = true)] public string? UserAddress { get; set; } /// /// 获取或设置用户职务。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Position", IsNullable = true)] public string? UserPosition { get; set; } /// /// 获取或设置用户头像 URL。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Avatar", IsNullable = true)] public string? UserAvatarUrl { get; set; } /// /// 获取或设置用户激活状态。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Status", IsNullable = true)] public int? UserStatus { get; set; } /// /// 获取或设置用户自定义字段信息。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("ExtAttr", IsNullable = true)] public Types.ExtendedAttribute? UserExtendedAttribute { get; set; } @@ -221,6 +236,7 @@ /// /// 获取或设置部门次序值。 /// + [Obsolete("相关接口或字段于 2022-08-15 下线。")] [System.Xml.Serialization.XmlElement("Order", IsNullable = true)] public long? DepartmentOrder { get; set; } diff --git a/src/SKIT.FlurlHttpClient.Wechat.Work/Extensions/WechatWorkClientExecuteCgibinUserExtensions.cs b/src/SKIT.FlurlHttpClient.Wechat.Work/Extensions/WechatWorkClientExecuteCgibinUserExtensions.cs index b0c57b24..3fbc8770 100644 --- a/src/SKIT.FlurlHttpClient.Wechat.Work/Extensions/WechatWorkClientExecuteCgibinUserExtensions.cs +++ b/src/SKIT.FlurlHttpClient.Wechat.Work/Extensions/WechatWorkClientExecuteCgibinUserExtensions.cs @@ -374,5 +374,24 @@ namespace SKIT.FlurlHttpClient.Wechat.Work return await client.SendRequestWithJsonAsync(flurlReq, cancellationToken: cancellationToken); } + /// + /// 异步调用 [GET] /cgi-bin/user/list_id 接口。 + /// REF: https://developer.work.weixin.qq.com/document/40856 + /// + /// + /// + /// + /// + public static async Task ExecuteCgibinUserListIdAsync(this WechatWorkClient client, Models.CgibinUserListIdRequest request, CancellationToken cancellationToken = default) + { + if (client is null) throw new ArgumentNullException(nameof(client)); + if (request is null) throw new ArgumentNullException(nameof(request)); + + IFlurlRequest flurlReq = client + .CreateRequest(request, HttpMethod.Post, "cgi-bin", "user", "list_id") + .SetQueryParam("access_token", request.AccessToken); + + return await client.SendRequestWithJsonAsync(flurlReq, cancellationToken: cancellationToken); + } } } diff --git a/src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdRequest.cs b/src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdRequest.cs new file mode 100644 index 00000000..ce962bfb --- /dev/null +++ b/src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdRequest.cs @@ -0,0 +1,22 @@ +namespace SKIT.FlurlHttpClient.Wechat.Work.Models +{ + /// + /// 表示 [POST] /cgi-bin/user/list_id 接口的请求。 + /// + public class CgibinUserListIdRequest : WechatWorkRequest + { + /// + /// 获取或设置分页每页数量。 + /// + [Newtonsoft.Json.JsonProperty("limit")] + [System.Text.Json.Serialization.JsonPropertyName("limit")] + public int? Limit { get; set; } + + /// + /// 获取或设置翻页标记。 + /// + [Newtonsoft.Json.JsonProperty("cursor")] + [System.Text.Json.Serialization.JsonPropertyName("cursor")] + public string? Cursor { get; set; } + } +} diff --git a/src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdResponse.cs b/src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdResponse.cs new file mode 100644 index 00000000..c150e653 --- /dev/null +++ b/src/SKIT.FlurlHttpClient.Wechat.Work/Models/CgibinUser/CgibinUserListIdResponse.cs @@ -0,0 +1,42 @@ +namespace SKIT.FlurlHttpClient.Wechat.Work.Models +{ + /// + /// 表示 [POST] /cgi-bin/user/list_id 接口的响应。 + /// + public class CgibinUserListIdResponse : WechatWorkResponse + { + public static class Types + { + public class DepartmentUser + { + /// + /// 获取或设置成员账号。 + /// + [Newtonsoft.Json.JsonProperty("userid")] + [System.Text.Json.Serialization.JsonPropertyName("userid")] + public string UserId { get; set; } = default!; + + /// + /// 获取或设置部门 ID。 + /// + [Newtonsoft.Json.JsonProperty("department")] + [System.Text.Json.Serialization.JsonPropertyName("department")] + public long DepartmentId { get; set; } + } + } + + /// + /// 获取或设置成员与部门关系列表。 + /// + [Newtonsoft.Json.JsonProperty("dept_user")] + [System.Text.Json.Serialization.JsonPropertyName("dept_user")] + public Types.DepartmentUser[] DepartmentUser { get; set; } = default!; + + /// + /// 获取或设置翻页标记。 + /// + [Newtonsoft.Json.JsonProperty("next_cursor")] + [System.Text.Json.Serialization.JsonPropertyName("next_cursor")] + public string? NextCursor { get; set; } + } +} diff --git a/test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdRequest.json b/test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdRequest.json new file mode 100644 index 00000000..c08598b1 --- /dev/null +++ b/test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdRequest.json @@ -0,0 +1,4 @@ +{ + "cursor": "xxxxxxx", + "limit": 10000 +} diff --git a/test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdResponse.json b/test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdResponse.json new file mode 100644 index 00000000..fd4c0376 --- /dev/null +++ b/test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/ModelSamples/CgibinUser/CgibinUserListIdResponse.json @@ -0,0 +1,19 @@ +{ + "errcode": 0, + "errmsg": "ok", + "next_cursor": "aaaaaaaaa", + "dept_user": [ + { + "userid": "zhangsan", + "department": 1 + }, + { + "userid": "zhangsan", + "department": 2 + }, + { + "userid": "lisi", + "department": 2 + } + ] +}