- Lock DocFX to last-known working version (#407)

- Fix inconsistencies, bad failures in Makefile steps

.github/workflows/ci.yml

@@ -111,10 +111,10 @@ jobs:
           dotnet-version: 7.x.x
 
       - name: Install docfx
-        run: dotnet tool update -g docfx
+        run: make install-tools
 
       - name: Generate docs
-        run: docfx docs/docfx.json
+        run: make docs
 
       - name: Deploy docs
         uses: peaceiris/actions-gh-pages@v3

EasyPost.Tests/packages.lock.json

@@ -1283,4 +1283,4 @@
       }
     }
   }
-}
+}

EasyPost/Services/Beta/ReferralService.cs

@@ -1,7 +1,7 @@
-using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using EasyPost._base;
+using EasyPost.Exceptions.API;
 using EasyPost.Models.API;
 using EasyPost.Models.API.Beta;
 using RestSharp;
@@ -26,7 +26,7 @@ public ReferralService(EasyPostClient client)
         /// <param name="paymentMethodReference">ID of the card or bank account provided by Stripe.</param>
         /// <param name="priority">Which priority to save this payment method as on EasyPost.</param>
         /// <returns>A <see cref="PaymentMethod"/> object.</returns>
-        /// <exception cref="Exception">When the request fails.</exception>
+        /// <exception cref="ApiError">When the request fails.</exception>
         public async Task<PaymentMethod> AddPaymentMethod(string stripeCustomerId, string paymentMethodReference, PaymentMethod.Priority? priority = null)
         {
             priority ??= PaymentMethod.Priority.Primary;

EasyPost/Services/PartnerService.cs

@@ -61,7 +61,7 @@ public async Task<ReferralCustomer> CreateReferral(Dictionary<string, object> pa
         /// <param name="cvc">CVC of the credit card.</param>
         /// <param name="priority">Priority of the credit card.</param>
         /// <returns>An EasyPost.PaymentMethodObject instance.</returns>
-        /// <exception cref="Exception">When the request fails.</exception>
+        /// <exception cref="ApiError">When the request fails.</exception>
         [CrudOperations.Update]
         public async Task<PaymentMethod> AddCreditCardToUser(string referralApiKey, string number, int expirationMonth, int expirationYear, string cvc, PaymentMethod.Priority? priority = null)
         {

EasyPost/_base/EasyPostObject.cs

@@ -62,7 +62,7 @@ public abstract class EasyPostObject : EphemeralEasyPostObject
         /// <param name="rootElement">Root element of JSON returned by update call.</param>
         /// <param name="overrideApiVersion">Override the API version used for update call.</param>
         /// <typeparam name="T">Type of object to update.</typeparam>
-        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        /// <returns>A task representing the asynchronous operation.</returns>
         protected async Task Update<T>(Method method, string url, Dictionary<string, object>? parameters = null, string? rootElement = null, ApiVersion? overrideApiVersion = null)
             where T : class
         {

EasyPost/packages.lock.json

@@ -238,4 +238,4 @@
       }
     }
   }
-}
+}

Makefile

@@ -31,8 +31,8 @@ coverage-check:
 
 ## docs - Generates library documentation
 docs:
-	docfx docs/docfx.json
-	git add docs/*
+	dotnet tool run docfx docs/docfx.json
+	git add docs/* || exit 0
 
 ## format - Formats the project
 format:
@@ -43,7 +43,7 @@ install-tools:
 	dotnet new tool-manifest || exit 0
 	dotnet tool install --local security-scan --version 5.6.3 || exit 0
 	dotnet tool install --local dotnet-format || exit 0
-	dotnet tool install --local docfx || exit 0
+	dotnet tool install --local docfx --version 2.60.2 || exit 0
 
 ## install - Install requirements
 install: | install-tools