lsm/DotNetCore.SKIT.FlurlHttpClient.Wechat
1
0
Fork 0
mirror of https://gitee.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat.git synced 2025-04-04 05:47:23 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(work): 移除旧版数据分析专区相关接口

Browse Source
This commit is contained in:
Fu Diwei 2025-03-14 17:08:12 +08:00
parent 1875098aea
commit 1a4911c29d
20 changed files with 0 additions and 870 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Extensions/WechatWorkSpecialApiClientExecuteSpecialExtensions.cs
View File

@ -1,133 +0,0 @@
using System;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Flurl.Http;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi
{
public static class WechatWorkSpecialApiClientExecuteSpecialExtensions
{
/// <summary>
/// <para>异步调用 [POST] /spec/gettoken 接口。</para>
/// <para>
/// REF: <br/>
/// <![CDATA[ https://developer.work.weixin.qq.com/document/path/99473 ]]>
/// </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public static async Task<Models.SpecialGetTokenResponse> ExecuteSpecialGetTokenAsync(this WechatWorkSpecialApiClient client, Models.SpecialGetTokenRequest 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
.CreateFlurlRequest(request, HttpMethod.Post, "spec", "gettoken")
.WithHeader("auth-corpid", null);
return await client.SendFlurlRequestAsJsonAsync<Models.SpecialGetTokenResponse>(flurlReq, data: request, cancellationToken: cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// <para>异步调用 [POST] /spec/list_job 接口。</para>
/// <para>
/// REF: <br/>
/// <![CDATA[ https://developer.work.weixin.qq.com/document/path/99467 ]]>
/// </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public static async Task<Models.SpecialListJobResponse> ExecuteSpecialListJobAsync(this WechatWorkSpecialApiClient client, Models.SpecialListJobRequest 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
.CreateFlurlRequest(request, HttpMethod.Post, "spec", "list_job")
.WithHeader("auth-corpid", null)
.SetQueryParam("access_token", request.AccessToken);
return await client.SendFlurlRequestAsJsonAsync<Models.SpecialListJobResponse>(flurlReq, data: request, cancellationToken: cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// <para>异步调用 [POST] /spec/exec_and_report_job 接口。</para>
/// <para>
/// REF: <br/>
/// <![CDATA[ https://developer.work.weixin.qq.com/document/path/99469 ]]>
/// </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public static async Task<Models.SpecialExecuteAndReportJobResponse> ExecuteSpecialExecuteAndReportJobAsync(this WechatWorkSpecialApiClient client, Models.SpecialExecuteAndReportJobRequest 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
.CreateFlurlRequest(request, HttpMethod.Post, "spec", "exec_and_report_job")
.SetQueryParam("access_token", request.AccessToken);
return await client.SendFlurlRequestAsJsonAsync<Models.SpecialExecuteAndReportJobResponse>(flurlReq, data: request, cancellationToken: cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// <para>异步调用 [POST] /spec/fetch_msg 接口。</para>
/// <para>
/// REF: <br/>
/// <![CDATA[ https://developer.work.weixin.qq.com/document/path/99468 ]]>
/// </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public static async Task<Models.SpecialFetchMessageResponse> ExecuteSpecialFetchMessageAsync(this WechatWorkSpecialApiClient client, Models.SpecialFetchMessageRequest 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
.CreateFlurlRequest(request, HttpMethod.Post, "spec", "fetch_msg")
.SetQueryParam("access_token", request.AccessToken);
return await client.SendFlurlRequestAsJsonAsync<Models.SpecialFetchMessageResponse>(flurlReq, data: request, cancellationToken: cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// <para>异步调用 [GET] /spec/download_media 接口。</para>
/// <para>
/// REF: <br/>
/// <![CDATA[ https://developer.work.weixin.qq.com/document/path/99470 ]]>
/// </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public static async Task<Models.SpecialDownloadMediaResponse> ExecuteSpecialDownloadMediaAsync(this WechatWorkSpecialApiClient client, Models.SpecialDownloadMediaRequest 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
.CreateFlurlRequest(request, HttpMethod.Get, "spec", "download_media")
.SetQueryParam("access_token", request.AccessToken)
.SetQueryParam("media_id", request.MediaId);
return await client.SendFlurlRequestAsJsonAsync<Models.SpecialDownloadMediaResponse>(flurlReq, data: request, cancellationToken: cancellationToken).ConfigureAwait(false);
}
}
}

71
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Interceptors/WechatWorkSpecialApiRequestSigningInterceptor.cs
View File

@ -1,71 +0,0 @@
using System;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Flurl.Http;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Interceptors
{
using SKIT.FlurlHttpClient;
using SKIT.FlurlHttpClient.Internal;
using SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi;
internal class WechatWorkSpecialApiRequestSigningInterceptor : HttpInterceptor
{
private readonly string _secret;
public WechatWorkSpecialApiRequestSigningInterceptor(string secret)
{
_secret = secret;
}
public override async Task BeforeCallAsync(HttpInterceptorContext context, CancellationToken cancellationToken = default)
{
if (context is null) throw new ArgumentNullException(nameof(context));
if (context.FlurlCall.Completed) throw new WechatWorkSpecialApiException("Failed to sign request. This interceptor must be called before request completed.");
string method = context.FlurlCall.HttpRequestMessage.Method.ToString().ToUpper();
string path = context.FlurlCall.HttpRequestMessage.RequestUri?.AbsolutePath ?? string.Empty;
string query = context.FlurlCall.HttpRequestMessage.RequestUri?.Query?.TrimStart('?') ?? string.Empty;
string timestamp = DateTimeOffset.Now.ToLocalTime().ToUnixTimeSeconds().ToString();
string nonce = Guid.NewGuid().ToString("N");
string authCorpId = context.FlurlCall.Request.Headers.GetAll("auth-corpid").FirstOrDefault() ?? string.Empty;
string body = string.Empty;
if (context.FlurlCall.HttpRequestMessage?.Content is not null)
{
if (method != "GET")
{
HttpContent httpContent = context.FlurlCall.HttpRequestMessage.Content;
body = await _AsyncEx.RunTaskWithCancellationTokenAsync(httpContent.ReadAsStringAsync(), cancellationToken).ConfigureAwait(false);
}
}
StringBuilder signData = new StringBuilder();
signData.Append(!string.IsNullOrEmpty(authCorpId) ? $"auth-corpid={authCorpId}\n" : string.Empty);
signData.Append($"body-md5={Utilities.MD5Utility.Hash(body).Value!.ToLower()}\n");
signData.Append($"timestamp={timestamp}\n");
signData.Append($"method={method}\n");
signData.Append($"nonce={nonce}\n");
signData.Append($"url={path}\n");
signData.Append(!string.IsNullOrEmpty(query) ? $"query={query}\n" : string.Empty);
signData.Append("\n");
string sign;
try
{
sign = Utilities.HMACUtility.HashWithSHA256(_secret, signData.ToString()).Value!.ToLower();
}
catch (Exception ex)
{
throw new WechatWorkSpecialApiException("Failed to sign request. Please see the inner exception for more details.", ex);
}
context.FlurlCall.Request.WithHeader("nonce", nonce);
context.FlurlCall.Request.WithHeader("timestamp", timestamp);
context.FlurlCall.Request.WithHeader("signature", sign);
}
}
}

18
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialDownloadMediaRequest.cs
View File

@ -1,18 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [GET] /spec/download_media 接口的请求。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialDownloadMediaRequest : WechatWorkSpecialApiRequest
{
/// <summary>
/// 获取或设置素材 ID。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public string MediaId { get; set; } = string.Empty;
}
}

16
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialDownloadMediaResponse.cs
View File

@ -1,16 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [GET] /spec/download_media 接口的响应。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialDownloadMediaResponse : WechatWorkSpecialApiResponse
{
public override bool IsSuccessful()
{
return base.IsSuccessful() && GetRawHeaders().ContainsKey("Content-Disposition");
}
}
}

59
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialExecuteAndReportJobRequest.cs
View File

@ -1,59 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/exec_and_report_job 接口的请求。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialExecuteAndReportJobRequest : WechatWorkSpecialApiRequest
{
public static class Types
{
public class Result
{
/// <summary>
/// 获取或设置任务类型。
/// </summary>
[Newtonsoft.Json.JsonProperty("job_type")]
[System.Text.Json.Serialization.JsonPropertyName("job_type")]
public string JobType { get; set; } = string.Empty;
/// <summary>
/// 获取或设置任务结果数据。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public string? DataString { get; set; }
}
}
/// <summary>
/// 获取或设置任务 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("jobid")]
[System.Text.Json.Serialization.JsonPropertyName("jobid")]
public string JobId { get; set; } = string.Empty;
/// <summary>
/// 获取或设置任务状态。
/// </summary>
[Newtonsoft.Json.JsonProperty("status")]
[System.Text.Json.Serialization.JsonPropertyName("status")]
public int Status { get; set; }
/// <summary>
/// 获取或设置任务进度（单位：百分数）。
/// </summary>
[Newtonsoft.Json.JsonProperty("progress")]
[System.Text.Json.Serialization.JsonPropertyName("progress")]
public int? Progress { get; set; }
/// <summary>
/// 获取或设置结果信息。
/// </summary>
[Newtonsoft.Json.JsonProperty("result")]
[System.Text.Json.Serialization.JsonPropertyName("result")]
public Types.Result? Result { get; set; }
}
}

12
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialExecuteAndReportJobResponse.cs
View File

@ -1,12 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/exec_and_report_job 接口的响应。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialExecuteAndReportJobResponse : WechatWorkSpecialApiResponse
{
}
}

32
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialFetchMessageRequest.cs
View File

@ -1,32 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/fetch_msg 接口的请求。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialFetchMessageRequest : WechatWorkSpecialApiRequest
{
/// <summary>
/// 获取或设置任务 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("jobid")]
[System.Text.Json.Serialization.JsonPropertyName("jobid")]
public string JobId { get; set; } = string.Empty;
/// <summary>
/// 获取或设置分页游标。
/// </summary>
[Newtonsoft.Json.JsonProperty("cursor")]
[System.Text.Json.Serialization.JsonPropertyName("cursor")]
public string? Cursor { get; set; }
/// <summary>
/// 获取或设置分页每页数量。
/// </summary>
[Newtonsoft.Json.JsonProperty("limit")]
[System.Text.Json.Serialization.JsonPropertyName("limit")]
public int? Limit { get; set; }
}
}

119
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialFetchMessageResponse.cs
View File

@ -1,119 +0,0 @@
using System;
using System.Collections.Generic;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/fetch_msg 接口的响应。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialFetchMessageResponse : WechatWorkSpecialApiResponse
{
public static class Types
{
public class Message
{
public static class Types
{
public class Sender
{
/// <summary>
/// 获取或设置身份类型。
/// </summary>
[Newtonsoft.Json.JsonProperty("type")]
[System.Text.Json.Serialization.JsonPropertyName("type")]
public int Type { get; set; }
/// <summary>
/// 获取或设置 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("id")]
[System.Text.Json.Serialization.JsonPropertyName("id")]
public string Id { get; set; } = default!;
}
public class Receiver : Sender
{
}
}
/// <summary>
/// 获取或设置消息 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("msgid")]
[System.Text.Json.Serialization.JsonPropertyName("msgid")]
public string MessageId { get; set; } = default!;
/// <summary>
/// 获取或设置消息类型。
/// </summary>
[Newtonsoft.Json.JsonProperty("msgtype")]
[System.Text.Json.Serialization.JsonPropertyName("msgtype")]
public int MessageType { get; set; }
/// <summary>
/// 获取或设置发送者信息。
/// </summary>
[Newtonsoft.Json.JsonProperty("sender")]
[System.Text.Json.Serialization.JsonPropertyName("sender")]
public Types.Sender Sender { get; set; } = default!;
/// <summary>
/// 获取或设置接收者列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("receiver_list")]
[System.Text.Json.Serialization.JsonPropertyName("receiver_list")]
public Types.Receiver[]? ReceiverList { get; set; }
/// <summary>
/// 获取或设置群 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("chatid")]
[System.Text.Json.Serialization.JsonPropertyName("chatid")]
public string? GroupChatId { get; set; }
/// <summary>
/// 获取或设置发送时间戳。
/// </summary>
[Newtonsoft.Json.JsonProperty("send_time")]
[System.Text.Json.Serialization.JsonPropertyName("send_time")]
public long SendTimestamp { get; set; }
/// <summary>
/// 获取或设置是否被撤回。
/// </summary>
[Newtonsoft.Json.JsonProperty("is_recalled")]
[System.Text.Json.Serialization.JsonPropertyName("is_recalled")]
public bool IsRecalled { get; set; }
/// <summary>
/// 获取或设置扩展字段。
/// </summary>
[Newtonsoft.Json.JsonExtensionData]
[System.Text.Json.Serialization.JsonExtensionData]
public IDictionary<string, object>? ExtendedData { get; set; }
}
}
/// <summary>
/// 获取或设置消息列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("msg_list")]
[System.Text.Json.Serialization.JsonPropertyName("msg_list")]
public Types.Message[] MessageList { get; set; } = default!;
/// <summary>
/// 获取或设置分页游标。
/// </summary>
[Newtonsoft.Json.JsonProperty("next_cursor")]
[System.Text.Json.Serialization.JsonPropertyName("next_cursor")]
public string? NextCursor { get; set; }
/// <summary>
/// 获取或设置是否还有更多数据。
/// </summary>
[Newtonsoft.Json.JsonProperty("has_more")]
[System.Text.Json.Serialization.JsonPropertyName("has_more")]
public bool HasMore { get; set; }
}
}

25
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialGetTokenRequest.cs
View File

@ -1,25 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/gettoken 接口的请求。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialGetTokenRequest : WechatWorkSpecialApiRequest
{
/// <summary>
/// 获取或设置服务商 CorpId。如果不指定将使用构造 <see cref="WechatWorkSpecialApiClient"/> 时的 <see cref="WechatWorkSpecialApiClientOptions.ProviderCorpId"/> 参数。
/// </summary>
[Newtonsoft.Json.JsonProperty("model_id")]
[System.Text.Json.Serialization.JsonPropertyName("model_id")]
public string? CorpId { get; set; }
/// <summary>
/// 获取或设置数据分析专区 Secret。如果不指定将使用构造 <see cref="WechatWorkSpecialApiClient"/> 时的 <see cref="WechatWorkSpecialApiClientOptions.SpecialSecret"/> 参数。
/// </summary>
[Newtonsoft.Json.JsonProperty("secret")]
[System.Text.Json.Serialization.JsonPropertyName("secret")]
public string? Secret { get; set; }
}
}

25
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialGetTokenResponse.cs
View File

@ -1,25 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/gettoken 接口的响应。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialGetTokenResponse : WechatWorkSpecialApiResponse
{
/// <summary>
/// 获取或设置数据分析专区接口凭证。
/// </summary>
[Newtonsoft.Json.JsonProperty("access_token")]
[System.Text.Json.Serialization.JsonPropertyName("access_token")]
public string AccessToken { get; set; } = default!;
/// <summary>
/// 获取或设置接口凭证有效期（单位：秒）。
/// </summary>
[Newtonsoft.Json.JsonProperty("expires_in")]
[System.Text.Json.Serialization.JsonPropertyName("expires_in")]
public int ExpiresIn { get; set; }
}
}

25
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialListJobRequest.cs
View File

@ -1,25 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/list_job 接口的请求。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialListJobRequest : WechatWorkSpecialApiRequest
{
/// <summary>
/// 获取或设置分页游标。
/// </summary>
[Newtonsoft.Json.JsonProperty("cursor")]
[System.Text.Json.Serialization.JsonPropertyName("cursor")]
public string? Cursor { get; set; }
/// <summary>
/// 获取或设置分页每页数量。
/// </summary>
[Newtonsoft.Json.JsonProperty("limit")]
[System.Text.Json.Serialization.JsonPropertyName("limit")]
public int? Limit { get; set; }
}
}

66
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Models/SpecialListJobResponse.cs
View File

@ -1,66 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models
{
/// <summary>
/// <para>表示 [POST] /spec/list_job 接口的响应。</para>
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public class SpecialListJobResponse : WechatWorkSpecialApiResponse
{
public static class Types
{
public class Job
{
/// <summary>
/// 获取或设置任务 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("jobid")]
[System.Text.Json.Serialization.JsonPropertyName("jobid")]
public string JobId { get; set; } = default!;
/// <summary>
/// 获取或设置授权方 CorpId。
/// </summary>
[Newtonsoft.Json.JsonProperty("auth_corpid")]
[System.Text.Json.Serialization.JsonPropertyName("auth_corpid")]
public string AuthorizerCorpId { get; set; } = default!;
/// <summary>
/// 获取或设置自定义数据。
/// </summary>
[Newtonsoft.Json.JsonProperty("custom_data")]
[System.Text.Json.Serialization.JsonPropertyName("custom_data")]
public string? CustomData { get; set; }
/// <summary>
/// 获取或设置创建时间戳。
/// </summary>
[Newtonsoft.Json.JsonProperty("create_time")]
[System.Text.Json.Serialization.JsonPropertyName("create_time")]
public long CreateTimestamp { get; set; }
}
}
/// <summary>
/// 获取或设置任务列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("job_list")]
[System.Text.Json.Serialization.JsonPropertyName("job_list")]
public Types.Job[] JobList { get; set; } = default!;
/// <summary>
/// 获取或设置分页游标。
/// </summary>
[Newtonsoft.Json.JsonProperty("next_cursor")]
[System.Text.Json.Serialization.JsonPropertyName("next_cursor")]
public string? NextCursor { get; set; }
/// <summary>
/// 获取或设置是否还有更多数据。
/// </summary>
[Newtonsoft.Json.JsonProperty("has_more")]
[System.Text.Json.Serialization.JsonPropertyName("has_more")]
public bool HasMore { get; set; }
}
}

31
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/Settings/Credentials.cs
View File

@ -1,31 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Settings
{
public sealed class Credentials
{
/// <summary>
/// 初始化客户端时 <see cref="WechatWorkSpecialApiClientOptions.ProviderCorpId"/> 的副本。
/// </summary>
public string ProviderCorpId { get; }
/// <summary>
/// 初始化客户端时 <see cref="WechatWorkSpecialApiClientOptions.SpecialSecret"/> 的副本。
/// </summary>
public string SpecialSecret { get; }
/// <summary>
/// 初始化客户端时 <see cref="WechatWorkSpecialApiClientOptions.SignSecret"/> 的副本。
/// </summary>
public string SignSecret { get; }
internal Credentials(WechatWorkSpecialApiClientOptions options)
{
if (options is null) throw new ArgumentNullException(nameof(options));
ProviderCorpId = options.ProviderCorpId;
SpecialSecret = options.SpecialSecret;
SignSecret = options.SignSecret;
}
}
}

90
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/WechatWorkSpecialApiClient.cs
View File

@ -1,90 +0,0 @@
using System;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Flurl.Http;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi
{
/// <summary>
/// 一个企业微信数据分析专区 API HTTP 客户端。
/// </summary>
[Obsolete("相关接口或字段于 2024-06-06 下线。")]
public sealed class WechatWorkSpecialApiClient : CommonClientBase, ICommonClient
{
/// <summary>
/// 获取当前客户端使用的企业微信数据分析专区凭证。
/// </summary>
public Settings.Credentials Credentials { get; }
/// <summary>
/// 用指定的配置项初始化 <see cref="WechatWorkClient"/> 类的新实例。
/// </summary>
/// <param name="options">配置项。</param>
public WechatWorkSpecialApiClient(WechatWorkSpecialApiClientOptions options)
: this(options, null)
{
}
/// <summary>
///
/// </summary>
/// <param name="options"></param>
/// <param name="httpClient"></param>
/// <param name="disposeClient"></param>
internal WechatWorkSpecialApiClient(WechatWorkSpecialApiClientOptions options, HttpClient? httpClient, bool disposeClient = true)
: base(httpClient, disposeClient)
{
if (options is null) throw new ArgumentNullException(nameof(options));
Credentials = new Settings.Credentials(options);
FlurlClient.BaseUrl = options.Endpoint ?? WechatWorkSpecialApiEndpoints.DEFAULT;
FlurlClient.WithTimeout(options.Timeout <= 0 ? Timeout.InfiniteTimeSpan : TimeSpan.FromMilliseconds(options.Timeout));
Interceptors.Add(new Interceptors.WechatWorkSpecialApiRequestSigningInterceptor(options.SignSecret));
}
/// <summary>
/// 使用当前客户端生成一个新的 <see cref="IFlurlRequest"/> 对象。
/// </summary>
/// <param name="request"></param>
/// <param name="httpMethod"></param>
/// <param name="urlSegments"></param>
/// <returns></returns>
public IFlurlRequest CreateFlurlRequest(WechatWorkSpecialApiRequest request, HttpMethod httpMethod, params object[] urlSegments)
{
IFlurlRequest flurlRequest = base.CreateFlurlRequest(request, httpMethod, urlSegments);
if (request.AuthorizerCorpId is not null)
{
flurlRequest.WithHeader("auth-corpid", request.AuthorizerCorpId);
}
return flurlRequest;
}
/// <summary>
/// 异步发起请求。
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="flurlRequest"></param>
/// <param name="data"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public async Task<T> SendFlurlRequestAsJsonAsync<T>(IFlurlRequest flurlRequest, object? data = null, CancellationToken cancellationToken = default)
where T : WechatWorkSpecialApiResponse, new()
{
if (flurlRequest is null) throw new ArgumentNullException(nameof(flurlRequest));
bool isSimpleRequest = data is null ||
flurlRequest.Verb == HttpMethod.Get ||
flurlRequest.Verb == HttpMethod.Head ||
flurlRequest.Verb == HttpMethod.Options;
using IFlurlResponse flurlResponse = isSimpleRequest ?
await base.SendFlurlRequestAsync(flurlRequest, null, cancellationToken).ConfigureAwait(false) :
await base.SendFlurlRequestAsJsonAsync(flurlRequest, data, cancellationToken).ConfigureAwait(false);
return await WrapFlurlResponseAsJsonAsync<T>(flurlResponse, cancellationToken).ConfigureAwait(false);
}
}
}

35
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/WechatWorkSpecialApiClientOptions.cs
View File

@ -1,35 +0,0 @@
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi
{
/// <summary>
/// 一个用于构造 <see cref="WechatWorkSpecialApiClient"/> 时使用的配置项。
/// </summary>
public class WechatWorkSpecialApiClientOptions
{
/// <summary>
/// 获取或设置请求超时时间（单位：毫秒）。
/// <para>默认值：30000</para>
/// </summary>
public int Timeout { get; set; } = 30 * 1000;
/// <summary>
/// 获取或设置企业微信数据分析专区 API 入口点。
/// <para>默认值：<see cref="WechatWorkSpecialApiEndpoints.DEFAULT"/></para>
/// </summary>
public string Endpoint { get; set; } = WechatWorkSpecialApiEndpoints.DEFAULT;
/// <summary>
/// 获取或设置企业微信服务商 CorpId。
/// </summary>
public string ProviderCorpId { get; set; } = default!;
/// <summary>
/// 获取或设置企业微信数据分析专区 Secret 。
/// </summary>
public string SpecialSecret { get; set; } = default!;
/// <summary>
/// 获取或设置企业微信数据分析专区签名密钥。
/// </summary>
public string SignSecret { get; set; } = default!;
}
}

13
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/WechatWorkSpecialApiEndpoints.cs
View File

@ -1,13 +0,0 @@
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi
{
/// <summary>
/// <para>企业微信数据分析专区 API 接口域名。</para>
/// </summary>
public static class WechatWorkSpecialApiEndpoints
{
/// <summary>
/// 默认域名。
/// </summary>
public const string DEFAULT = "https://specapi.weixin.qq.com";
}
}

27
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/WechatWorkSpecialApiException.cs
View File

@ -1,27 +0,0 @@
using System;
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi
{
/// <summary>
/// 当调用企业微信数据分析专区 API 出错时引发的异常。
/// </summary>
public class WechatWorkSpecialApiException : WechatWorkException
{
/// <inheritdoc/>
public WechatWorkSpecialApiException()
{
}
/// <inheritdoc/>
public WechatWorkSpecialApiException(string message)
: base(message)
{
}
/// <inheritdoc/>
public WechatWorkSpecialApiException(string message, Exception innerException)
: base(message, innerException)
{
}
}
}

22
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/WechatWorkSpecialApiRequest.cs
View File

@ -1,22 +0,0 @@
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi
{
/// <summary>
/// 表示企业微信数据分析专区 API 请求的基类。
/// </summary>
public abstract class WechatWorkSpecialApiRequest : CommonRequestBase, ICommonRequest
{
/// <summary>
/// 获取或设置企业微信数据分析专区的 AccessToken。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public virtual string? AccessToken { get; set; }
/// <summary>
/// 获取或设置授权方的 CorpId。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public virtual string? AuthorizerCorpId { get; set; }
}
}

34
src/SKIT.FlurlHttpClient.Wechat.Work/ExtendedSDK/SpecialApi/WechatWorkSpecialApiResponse.cs
View File

@ -1,34 +0,0 @@
namespace SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi
{
/// <summary>
/// 表示企业微信数据分析专区 API 响应的基类。
/// </summary>
public abstract class WechatWorkSpecialApiResponse : CommonResponseBase, ICommonResponse
{
/// <summary>
/// 获取企业微信数据分析专区 API 返回的错误码。
/// </summary>
[Newtonsoft.Json.JsonProperty("errcode")]
[System.Text.Json.Serialization.JsonPropertyName("errcode")]
public virtual int ErrorCode { get; set; }
/// <summary>
/// 获取企业微信数据分析专区 API 返回的错误描述。
/// </summary>
[Newtonsoft.Json.JsonProperty("errmsg")]
[System.Text.Json.Serialization.JsonPropertyName("errmsg")]
public virtual string? ErrorMessage { get; set; }
/// <summary>
/// 获取一个值，该值指示调用企业微信数据分析专区 API 是否成功。
/// <para>
///（即 HTTP 状态码为 200，且 <see cref="ErrorCode"/> 值为 0）
/// </para>
/// </summary>
/// <returns></returns>
public override bool IsSuccessful()
{
return GetRawStatus() == 200 && ErrorCode == 0;
}
}
}

17
test/SKIT.FlurlHttpClient.Wechat.Work.UnitTests/IMPORTANT_CodeAnalyzeTests.cs
View File

@ -6,8 +6,6 @@ using Xunit;
namespace SKIT.FlurlHttpClient.Wechat.Work.UnitTests
{
using SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi;
public class CodeAnalyzeTests
{
[Fact(DisplayName = "代码质量分析")]
@ -58,21 +56,6 @@ namespace SKIT.FlurlHttpClient.Wechat.Work.UnitTests
};
new SourceFileAnalyzer(options).AssertNoIssues();
}));
Assert.Null(Record.Exception(() =>
{
var options = new TypeDeclarationAnalyzerOptions()
{
SdkAssembly = Assembly.GetAssembly(typeof(WechatWorkSpecialApiClient))!,
SdkRequestModelDeclarationNamespace = "SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models",
SdkResponseModelDeclarationNamespace = "SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi.Models",
SdkExecutingExtensionDeclarationNamespace = "SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.SpecialApi",
ThrowOnNotFoundRequestModelTypes = true,
ThrowOnNotFoundResponseModelTypes = true,
ThrowOnNotFoundExecutingExtensionTypes = true
};
new TypeDeclarationAnalyzer(options).AssertNoIssues();
}));
}
}
}