Merge pull request #98 from gocardless/template-changes

Release v5.12.0

GoCardless/GoCardless.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageId>GoCardless</PackageId>
-    <PackageVersion>5.11.0</PackageVersion>
+    <PackageVersion>5.12.0</PackageVersion>
     <Authors>GoCardless Ltd</Authors>
     <Description>Client for the GoCardless API - a powerful, simple solution for the collection of recurring bank-to-bank payments</Description>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
@@ -11,7 +11,7 @@
     <Copyright>GoCardless Ltd</Copyright>
     <PackageTags>gocardless payments rest api direct debit</PackageTags>
     <PackageLicenseUrl>https://github.com/gocardless/gocardless-dotnet/blob/master/LICENSE.txt</PackageLicenseUrl>
-    <PackageReleaseNotes>https://github.com/gocardless/gocardless-dotnet/releases/tag/v5.11.0</PackageReleaseNotes>
+    <PackageReleaseNotes>https://github.com/gocardless/gocardless-dotnet/releases/tag/v5.12.0</PackageReleaseNotes>
     <TargetFrameworks>netstandard1.6;netstandard2.0;net46</TargetFrameworks>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>

GoCardless/GoCardlessClient.Generated.cs

@@ -138,6 +138,11 @@ public partial class GoCardlessClient
         /// </summary>
         public ScenarioSimulatorService ScenarioSimulators => new ScenarioSimulatorService(this);
 
+        /// <summary>
+        ///A service for working with schemeentifier resources.
+        /// </summary>
+        public SchemeIdentifierService SchemeIdentifiers => new SchemeIdentifierService(this);
+
         /// <summary>
         ///A service for working with subscription resources.
         /// </summary>
@@ -148,6 +153,11 @@ public partial class GoCardlessClient
         /// </summary>
         public TaxRateService TaxRates => new TaxRateService(this);
 
+        /// <summary>
+        ///A service for working with verification detail resources.
+        /// </summary>
+        public VerificationDetailService VerificationDetails => new VerificationDetailService(this);
+
         /// <summary>
         ///A service for working with webhook resources.
         /// </summary>

GoCardless/GoCardlessClient.cs

@@ -277,11 +277,11 @@ private HttpRequestMessage BuildHttpRequestMessage<T>(string method, string path
             runtimeFrameworkInformation = System.Runtime.InteropServices.RuntimeEnvironment.GetSystemVersion();
 #endif
 
-            var userAgentInformation = $" gocardless-dotnet/5.11.0 {runtimeFrameworkInformation} {Helpers.CleanupOSDescriptionString(OSRunningOn)}";
+            var userAgentInformation = $" gocardless-dotnet/5.12.0 {runtimeFrameworkInformation} {Helpers.CleanupOSDescriptionString(OSRunningOn)}";
 
             requestMessage.Headers.Add("User-Agent", userAgentInformation);
             requestMessage.Headers.Add("GoCardless-Version", "2015-07-06");
-            requestMessage.Headers.Add("GoCardless-Client-Version", "5.11.0");
+            requestMessage.Headers.Add("GoCardless-Client-Version", "5.12.0");
             requestMessage.Headers.Add("GoCardless-Client-Library", "gocardless-dotnet");
             requestMessage.Headers.Authorization =
                 new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", _accessToken);

GoCardless/Resources/BankAuthorisation.cs

@@ -73,6 +73,20 @@ public class BankAuthorisation
         /// <summary>
         /// URL that the payer can be redirected to after authorising the
         /// payment.
+        /// 
+        /// On completion of bank authorisation, the query parameter of either
+        /// `outcome=success` or `outcome=failure` will be
+        /// appended to the `redirect_uri` to indicate the result of the bank
+        /// authorisation. If the bank authorisation is
+        /// expired, the query parameter `outcome=timeout` will be appended to
+        /// the `redirect_uri`, in which case you should
+        /// prompt the user to try the bank authorisation step again.
+        /// 
+        /// The `redirect_uri` you provide should handle the `outcome` query
+        /// parameter for displaying the result of the
+        /// bank authorisation as outlined above.
+        /// 
+        /// Defaults to `https://pay.gocardless.com/billing/static/thankyou`.
         /// </summary>
         [JsonProperty("redirect_uri")]
         public string RedirectUri { get; set; }

GoCardless/Resources/BillingRequest.cs

@@ -1077,6 +1077,10 @@ public class BillingRequestResourcesCustomerBillingDetail
         /// containing the IP address of the payer to whom the mandate belongs
         /// (i.e. as a result of their completion of a mandate setup flow in
         /// their browser).
+        /// 
+        /// Not required for creating offline mandates where
+        /// `authorisation_source` is set to telephone or paper.
+        /// 
         /// </summary>
         [JsonProperty("ip_address")]
         public string IpAddress { get; set; }

GoCardless/Resources/Creditor.cs

@@ -136,7 +136,7 @@ public class Creditor
         public bool? MerchantResponsibleForNotifications { get; set; }
 
         /// <summary>
-        /// The creditor's name.
+        /// The creditor's trading name.
         /// </summary>
         [JsonProperty("name")]
         public string Name { get; set; }
@@ -329,19 +329,19 @@ public class CreditorLinks
     public class CreditorSchemeIdentifier
     {
         /// <summary>
-        /// The first line of the support address.
+        /// The first line of the scheme identifier's support address.
         /// </summary>
         [JsonProperty("address_line1")]
         public string AddressLine1 { get; set; }
 
         /// <summary>
-        /// The second line of the support address.
+        /// The second line of the scheme identifier's support address.
         /// </summary>
         [JsonProperty("address_line2")]
         public string AddressLine2 { get; set; }
 
         /// <summary>
-        /// The third line of the support address.
+        /// The third line of the scheme identifier's support address.
         /// </summary>
         [JsonProperty("address_line3")]
         public string AddressLine3 { get; set; }
@@ -354,7 +354,7 @@ public class CreditorSchemeIdentifier
         public bool? CanSpecifyMandateReference { get; set; }
 
         /// <summary>
-        /// The city of the support address.
+        /// The city of the scheme identifier's support address.
         /// </summary>
         [JsonProperty("city")]
         public string City { get; set; }
@@ -366,18 +366,31 @@ public class CreditorSchemeIdentifier
         [JsonProperty("country_code")]
         public string CountryCode { get; set; }
 
+        /// <summary>
+        /// Fixed [timestamp](#api-usage-time-zones--dates), recording when this
+        /// resource was created.
+        /// </summary>
+        [JsonProperty("created_at")]
+        public DateTimeOffset? CreatedAt { get; set; }
+
         /// <summary>
         /// The currency of the scheme identifier.
         /// </summary>
         [JsonProperty("currency")]
         public CreditorSchemeIdentifierCurrency? Currency { get; set; }
 
         /// <summary>
-        /// The support email address.
+        /// Scheme identifier's support email address.
         /// </summary>
         [JsonProperty("email")]
         public string Email { get; set; }
 
+        /// <summary>
+        /// Unique identifier, usually beginning with "SU".
+        /// </summary>
+        [JsonProperty("id")]
+        public string Id { get; set; }
+
         /// <summary>
         /// The minimum interval, in working days, between the sending of a
         /// pre-notification to the customer, and the charge date of a payment
@@ -391,19 +404,20 @@ public class CreditorSchemeIdentifier
         public int? MinimumAdvanceNotice { get; set; }
 
         /// <summary>
-        /// The name which appears on customers' bank statements.
+        /// The name which appears on customers' bank statements. This should
+        /// usually be the merchant's trading name.
         /// </summary>
         [JsonProperty("name")]
         public string Name { get; set; }
 
         /// <summary>
-        /// The support phone number.
+        /// Scheme identifier's support phone number.
         /// </summary>
         [JsonProperty("phone_number")]
         public string PhoneNumber { get; set; }
 
         /// <summary>
-        /// The support postal code.
+        /// The scheme identifier's support postal code.
         /// </summary>
         [JsonProperty("postal_code")]
         public string PostalCode { get; set; }
@@ -415,7 +429,8 @@ public class CreditorSchemeIdentifier
         public string Reference { get; set; }
 
         /// <summary>
-        /// The support address region, county or department.
+        /// The scheme identifier's support address region, county or
+        /// department.
         /// </summary>
         [JsonProperty("region")]
         public string Region { get; set; }
@@ -425,6 +440,13 @@ public class CreditorSchemeIdentifier
         /// </summary>
         [JsonProperty("scheme")]
         public CreditorSchemeIdentifierScheme? Scheme { get; set; }
+
+        /// <summary>
+        /// The status of the scheme identifier. Only `active` scheme
+        /// identifiers will be applied to a creditor and used against payments.
+        /// </summary>
+        [JsonProperty("status")]
+        public CreditorSchemeIdentifierStatus? Status { get; set; }
     }
 
     /// <summary>
@@ -509,6 +531,24 @@ public enum CreditorSchemeIdentifierScheme {
         SepaInstantCreditTransfer,
     }
 
+    /// <summary>
+    /// The status of the scheme identifier. Only `active` scheme identifiers will be applied to a
+    /// creditor and used against payments.
+    /// </summary>
+    [JsonConverter(typeof(GcStringEnumConverter), (int)Unknown)]
+    public enum CreditorSchemeIdentifierStatus {
+        /// <summary>Unknown status</summary>
+        [EnumMember(Value = "unknown")]
+        Unknown = 0,
+
+        /// <summary>`status` with a value of "pending"</summary>
+        [EnumMember(Value = "pending")]
+        Pending,
+        /// <summary>`status` with a value of "active"</summary>
+        [EnumMember(Value = "active")]
+        Active,
+    }
+
     /// <summary>
     /// The creditor's verification status, indicating whether they can yet receive payouts. For
     /// more details on handling verification as a partner, see our ["Helping your users get

GoCardless/Resources/Mandate.cs

@@ -125,6 +125,13 @@ public class Mandate
         /// </summary>
         [JsonProperty("status")]
         public MandateStatus? Status { get; set; }
+
+        /// <summary>
+        /// [Timestamp](#api-usage-time-zones--dates) recording when this
+        /// mandate was verified.
+        /// </summary>
+        [JsonProperty("verified_at")]
+        public string VerifiedAt { get; set; }
     }
 
     /// <summary>

GoCardless/Resources/PayerAuthorisation.cs

@@ -444,6 +444,10 @@ public class PayerAuthorisationMandate
         /// containing the IP address of the payer to whom the mandate belongs
         /// (i.e. as a result of their completion of a mandate setup flow in
         /// their browser).
+        /// 
+        /// Not required for creating offline mandates where
+        /// `authorisation_source` is set to telephone or paper.
+        /// 
         /// </summary>
         [JsonProperty("payer_ip_address")]
         public string PayerIpAddress { get; set; }