Merge pull request #615 from EasyPost/amazon_account

feat: route Amazon account to correct endpoint

Author: Justintime50

CHANGELOG.md

@@ -10,6 +10,7 @@
   - `ReferralCustomer.AddCreditCardFromStripe`
   - `ReferralCustomer.AddBankAccountFromStripe`
 - Adds `MerchantId` as Shipment option (closes #592)
+- Routes `AmazonShippingAccount` to the correct endpoint on create
 - Fixes error parsing
   - Allows for alternative format of `errors` field (previously we deserialized the `errors` field into a list of `Error` objects; however, sometimes the errors are simply a list of strings. This change make the `errors` field a list of `objects` allowing for either the new `FieldError` object or a list of strings. Users will need to check for the type of error returned and handle appropriately)
   - Removed the unused `Error` model

EasyPost.Integration/Basics.cs

@@ -108,6 +108,7 @@ public void UserCanConstructParameterSets()
         var carrierAccountCreateFedExParameters = new EasyPost.Parameters.CarrierAccount.CreateFedEx();
         var carrierAccountCreateFedExSmartPostParameters = new EasyPost.Parameters.CarrierAccount.CreateFedExSmartPost();
         var carrierAccountCreateUpsParameters = new EasyPost.Parameters.CarrierAccount.CreateUps();
+        var carrierAccountCreateOauthParameters = new EasyPost.Parameters.CarrierAccount.CreateOauth();
         var carrierAccountUpdateParameters = new EasyPost.Parameters.CarrierAccount.Update();
         var carrierMetadataRetrieveParameters = new EasyPost.Parameters.CarrierMetadata.Retrieve();
         var claimCreateParameters = new EasyPost.Parameters.Claim.Create();

EasyPost.Tests/ServicesTests/CarrierAccountServiceTest.cs

@@ -47,6 +47,7 @@ public async Task TestCreate()
 
             Assert.IsType<CarrierAccount>(carrierAccount);
             Assert.StartsWith("ca_", carrierAccount.Id);
+            Assert.Equal("DhlEcsAccount", carrierAccount.Type);
         }
 
         [Fact]
@@ -73,6 +74,26 @@ public async Task TestCreateWithCustomWorkflow()
             }
         }
 
+        [Fact]
+        [CrudOperations.Create]
+        [Testing.Parameters]
+        public async Task TestCreateOauth()
+        {
+            UseVCR("create_with_oauth");
+
+            EasyPost.Parameters.CarrierAccount.CreateOauth parameters = new()
+            {
+                Type = CarrierAccountType.AmazonShippingAccount.Name,
+            };
+
+            CarrierAccount carrierAccount = await Client.CarrierAccount.Create(parameters);
+            CleanUpAfterTest(carrierAccount.Id);
+
+            Assert.IsType<CarrierAccount>(carrierAccount);
+            Assert.StartsWith("ca_", carrierAccount.Id);
+            Assert.Equal("AmazonShippingAccount", carrierAccount.Type);
+        }
+
         [Fact]
         [CrudOperations.Read]
         [Testing.Function]

EasyPost.Tests/cassettes/net/carrier_account_service/create_with_oauth.json

@@ -134,6 +134,7 @@ public static class CarrierAccounts
                 CarrierAccountType.Ups.Name,
                 CarrierAccountType.UpsMailInnovations.Name,
                 CarrierAccountType.UpsSurePost.Name,
+                CarrierAccountType.AmazonShippingAccount.Name,
             };
 
             /// <summary>
@@ -154,6 +155,7 @@ internal static string DeriveCreateEndpoint(string carrierType)
                 {
                     { new List<string> { CarrierAccountType.FedEx.Name, CarrierAccountType.FedExSmartPost.Name }.Contains(carrierType), () => endpoint = CustomCreateEndpoint },
                     { new List<string> { CarrierAccountType.Ups.Name, CarrierAccountType.UpsMailInnovations.Name, CarrierAccountType.UpsSurePost.Name }.Contains(carrierType), () => endpoint = UpsOAuthCreateEndpoint },
+                    { new List<string> { CarrierAccountType.AmazonShippingAccount.Name, }.Contains(carrierType), () => endpoint = OauthCreateEndpoint },
                     { SwitchCaseScenario.Default, () => endpoint = StandardCreateEndpoint },
                 };
 
@@ -186,6 +188,7 @@ internal static string DeriveUpdateEndpoint(string carrierType, string id)
             internal const string UpsOAuthCreateEndpoint = "ups_oauth_registrations";
             internal const string StandardUpdateEndpoint = "carrier_accounts/{0}";
             internal const string UpsOAuthUpdateEndpoint = "ups_oauth_registrations/{0}";
+            internal const string OauthCreateEndpoint = "carrier_accounts/register_oauth";
         }
     }
 }

EasyPost/Constants.cs

@@ -33,6 +33,11 @@ public class CarrierAccountType : ValueEnum
     /// </summary>
     public static readonly CarrierAccountType UpsSurePost = new CarrierAccountType(61, "UpsSurepostAccount");
 
+    /// <summary>
+    ///     Represents an Amazon carrier account.
+    /// </summary>
+    public static readonly CarrierAccountType AmazonShippingAccount = new CarrierAccountType(62, "AmazonShippingAccount");
+
     /// <summary>
     ///     Initializes a new instance of the <see cref="CarrierAccountType"/> class.
     /// </summary>

EasyPost/Models/API/CarrierAccountType.cs

@@ -0,0 +1,47 @@
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using EasyPost.Utilities.Internal.Attributes;
+using EasyPost.Utilities.Internal.Extensions;
+
+namespace EasyPost.Parameters.CarrierAccount
+{
+    /// <summary>
+    ///     <a href="https://docs.easypost.com/docs/carrier-accounts#create-a-carrieraccount">Parameters</a> for <see cref="EasyPost.Services.CarrierAccountService.Create(ACreate, System.Threading.CancellationToken)"/> API calls.
+    /// </summary>
+    [ExcludeFromCodeCoverage]
+    public class CreateOauth : ACreate
+    {
+        #region Request Parameters
+
+        /// <summary>
+        ///     Description for the new <see cref="Models.API.CarrierAccount"/>.
+        /// </summary>
+        [TopLevelRequestParameter(Necessity.Optional, "carrier_account_oauth_registrations", "description")]
+        public string? Description { get; set; }
+
+        /// <summary>
+        ///     Reference name for the new <see cref="Models.API.CarrierAccount"/>.
+        /// </summary>
+        [TopLevelRequestParameter(Necessity.Optional, "carrier_account_oauth_registrations", "reference")]
+        public string? Reference { get; set; }
+
+        /// <inheritdoc/>
+        [TopLevelRequestParameter(Necessity.Required, "carrier_account_oauth_registrations", "type")]
+        public override string? Type { get; set; }
+
+        #endregion
+
+        /// <inheritdoc cref="EasyPost.Parameters.CarrierAccount.ACreate.Endpoint"/>
+        internal override string Endpoint => Constants.CarrierAccounts.OauthCreateEndpoint;
+
+        /// <inheritdoc />
+        public override Dictionary<string, object> ToDictionary()
+        {
+            Dictionary<string, object> dictionary = base.ToDictionary();
+
+            dictionary!.AddOrUpdate(Type, "type"); // Need to add "type" top-level (added sub-level by serialization)
+
+            return dictionary;
+        }
+    }
+}

EasyPost/Parameters/CarrierAccount/CreateOauth.cs

@@ -28,8 +28,6 @@ internal CarrierAccountService(EasyPostClient client)
 
         #region CRUD Operations
 
-        // TODO: Use ID or whole object as parameter?
-
         /// <summary>
         ///     Create a <see cref="CarrierAccount"/>.
         ///     <a href="https://docs.easypost.com/docs/carrier-accounts#create-a-carrieraccount">Related API documentation</a>.