新增签约接口;微信小程序获取 openid 方法

Author: chengliangzhang

CHANGELOG.md

@@ -1,4 +1,9 @@
 # ChangeLog
+### 1.4.5
+- 新增
+    - 新增签约接口
+    - 新增微信小程序获取openid方法
+
 ### 1.4.4
 - 修改
     - order创建示例参数新增 余额结算信息

Example/Entry.cs

@@ -46,6 +46,7 @@ private static void Main(string[] args)
         private static void Examples(string appId)
         {
             ChargeDemo.Example(appId);
+            AgreementDemo.Example(appId);
             RedEnvelopeDemo.Example(appId);
             TransferDemo.Example(appId);
             VerifyDemo.Example();

Example/Example.csproj

@@ -49,6 +49,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Entry.cs" />
+    <Compile Include="Example\AgreementDemo.cs" />
     <Compile Include="Example\BalanceBonusDemo.cs" />
     <Compile Include="Example\BalanceSettlementDemo.cs" />
     <Compile Include="Example\BalanceTransactionDemo.cs" />
@@ -59,7 +60,7 @@
     <Compile Include="Example\RoyaltyDemo.cs" />
     <Compile Include="Example\RoyaltySettlementDemo.cs" />
     <Compile Include="Example\RoyaltyTemplateDemo.cs" />
-    <Compile Include="Example\RoyaltyTransactionDemo.cs" /> 
+    <Compile Include="Example\RoyaltyTransactionDemo.cs" />
     <Compile Include="Example\SettleAccountDemo.cs" />
     <Compile Include="Example\SubAppDemo.cs" />
     <Compile Include="Example\BatchRefundDemo.cs" />

Example/Example/AgreementDemo.cs

@@ -0,0 +1,60 @@
+using System;
+using System.Collections.Generic;
+using Pingpp;
+using Pingpp.Models;
+
+namespace Example.Example
+{
+    internal class AgreementDemo
+    {
+        /// <summary>
+        /// 本示例只介绍如何请求支付凭据（charge 对象），以及如何查询指定 charge 对象和 charge 列表，
+        /// 至于如何将 charge 对象传递给客户端需要接入者自行处理
+        /// </summary>
+        public static void Example(string appId)
+        {
+
+            Console.WriteLine("**** 创建签约示例 ****");
+            var param = new Dictionary<string, object> {
+                {"app", appId},
+                {"contract_no", randomStr(10)},
+                {"channel", "qpay"},
+                {"extra", new Dictionary<string, object>{
+                    {"display_account", "签约测试"}
+                }},
+                {"metadata", new Dictionary<string, object>{}}
+            };
+
+            var agreement = Agreement.Create(param);
+            Console.WriteLine(agreement);
+            Console.WriteLine();
+
+            Console.WriteLine("****查询 agreement 对象****");
+            Console.WriteLine(Agreement.Retrieve(agreement.Id));
+            Console.WriteLine();
+
+            Console.WriteLine("****解除签约 agreement 对象****");
+            Console.WriteLine(Agreement.Cancel(agreement.Id));
+            Console.WriteLine();
+
+
+            Console.WriteLine("****查询 agreement 列表****");
+            Dictionary<string, object> listParams = new Dictionary<string, object>{
+                {"app", appId}, // 必填 签约使用的 app id
+                {"per_page", 10},  //限制有多少对象可以被返回，限制范围是从 1-100 项，默认是 10 项。
+            };
+            Console.WriteLine(Agreement.List(listParams));
+        }
+
+        public static String randomStr(int length)
+        {
+            string result = "";
+            System.Random random = new Random();
+            for (int i = 0; i < length; i++)
+            {
+                result += random.Next(10).ToString();
+            }
+            return result;
+        }
+    }
+}

README.md

@@ -657,3 +657,33 @@ CardInfo.Query(List<string> params)
 ```
 
 详细信息请参考 [API 文档](https://pingxx.com/document/api)
+
+### 创建签约
+```c#
+Agreement.Create( Dictionary<string, object> createParams)
+```
+
+### 查询签约状态
+```c#
+Agreement.Retrieve(string Id)
+```
+
+### 解除签约
+```c#
+Agreement.Cancel(string Id)
+```
+
+### 查询签约列表
+```c#
+Agreement.List( Dictionary<string, object> listParams)
+```
+
+### 微信公众号获取openid
+```c#
+WxPubUtils.GetOpenId(string appId, string appSecret, string code)
+```
+
+### 微信小程序获取openid
+```c#
+WxPubUtils.GetWxLiteOpenId(string appId, string appSecret, string code)
+```

VERSION

@@ -1 +1 @@
-1.4.4
+1.4.5

libs/pingpp.dll

@@ -0,0 +1,94 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Pingpp.Net;
+using Pingpp.Exception;
+
+namespace Pingpp.Models
+{
+    /// <summary>
+    /// 签约对象
+    /// </summary>
+    public class Agreement :Pingpp
+    {
+        [JsonProperty("id")]
+        public string Id { get; set; }
+        [JsonProperty("object")]
+        public string Object { get; set; }
+        [JsonProperty("livemode")]
+        public bool Livemode { get; set; }
+        [JsonProperty("app")]
+        public string App { get; set; }
+        [JsonProperty("created")]
+        public int? Created { get; set; }
+        [JsonProperty("channel")]
+        public string Channel { get; set; }
+        [JsonProperty("contract_no")]
+        public string ContractNo { get; set; }
+        [JsonProperty("contract_id")]
+        public string ContractId { get; set; }
+        [JsonProperty("credential")]
+        public Dictionary<string, object> Credential { get; set; }
+        [JsonProperty("status")]
+        public string Status { get; set; }
+        [JsonProperty("time_succeeded")]
+        public int? TimeSucceeded { get; set; }
+        [JsonProperty("time_canceled")]
+        public int? TImeCanceled { get; set; }
+        [JsonProperty("failure_code")]
+        public string FailureCode { get; set; }
+        [JsonProperty("failure_msg")]
+        public string FailureMsg { get; set; }
+        [JsonProperty("metadata")]
+        public Dictionary<string, object> Metadata { get; set; }
+        [JsonProperty("extra")]
+        public Dictionary<string, object> Extra { get; set; }
+
+        private const string BaseUrl = "/v1/agreements";
+
+        /// <summary>
+        /// 创建签约接口
+        /// </summary>
+        /// <param name="param"></param>
+        /// <returns></returns>
+        public static Agreement Create(Dictionary<string, object> param)
+        {
+            var agreement = Requestor.DoRequest(BaseUrl, "POST", param);
+            return Mapper<Agreement>.MapFromJson(agreement);
+        }
+
+        /// <summary>
+        /// 查询签约对象
+        /// </summary>
+        /// <param name="Id"></param>
+        /// <returns></returns>
+        public static Agreement Retrieve(string Id) 
+        {
+            var agreement = Requestor.DoRequest(string.Format("{0}/{1}", BaseUrl, Id), "GET");
+            return Mapper<Agreement>.MapFromJson(agreement);
+        }
+
+        /// <summary>
+        /// 解除签约
+        /// </summary>
+        /// <param name="Id"></param>
+        /// <returns></returns>
+        public static Agreement Cancel(string Id) 
+        {
+            Dictionary<string, object> param = new Dictionary<string, object> {{ "status", "canceled" }};
+            var agreement = Requestor.DoRequest(string.Format("{0}/{1}", BaseUrl, Id), "PUT", param);
+            return Mapper<Agreement>.MapFromJson(agreement);
+        }
+
+        /// <summary>
+        /// 查询签约对象列表
+        /// </summary>
+        /// <param name="listParams"></param>
+        /// <returns></returns>
+        public static AgreementList List(Dictionary<string, object> listParams) 
+        {
+            var agreementList = Requestor.DoRequest(Requestor.FormatUrl(BaseUrl, Requestor.CreateQuery(listParams)), "GET");
+            return Mapper<AgreementList>.MapFromJson(agreementList);
+        }
+    }
+}

pingpp/Models/Agreement.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace Pingpp.Models
+{
+    public class AgreementList : Pingpp
+    {
+        [JsonProperty("object")]
+        public string Object { get; set; }
+        [JsonProperty("url")]
+        public string Url { get; set; }
+        [JsonProperty("has_more")]
+        public bool HasMore { get; set; }
+        [JsonProperty("data")]
+        public IEnumerable<Agreement> Data { get; set; }
+    }
+}

pingpp/Models/AgreementList.cs

@@ -10,7 +10,7 @@ public abstract class Pingpp
         public static volatile string ApiVersion;
         public static volatile string AcceptLanguage = "zh-CN";
         public static volatile string ApiBase = "https://api.pingxx.com";
-        public static volatile string Version = "1.4.4";
+        public static volatile string Version = "1.4.5";
         public static volatile bool BadGateWayMatch = true;
         public static volatile int MaxNetworkRetries = 1;
         protected static volatile int MaxRetry = 0;