Merge pull request #634 from EasyPost/SHPE-594_sessions

feat: add portal and embeddable sessions

Author: Justintime50

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## Next Release
+
+- Adds the following functions:
+  - `CustomerPortal.CreateAccountLink`
+  - `Embeddable.CreateSession`
+
 ## v7.3.0 (2025-11-10)
 
 - Adds support for `UspsShipAccount`

EasyPost.Integration/TestUtils.cs

@@ -12,13 +12,11 @@ public class Utils
 
         private static readonly List<string> BodyCensors =
         [
-            "api_keys",
-            "children",
             "client_ip",
             "credentials",
             "email",
+            "fields",
             "key",
-            "keys",
             "phone_number",
             "phone",
             "test_credentials"

EasyPost.Tests/ServicesTests/WithParameters/CustomerPortalServiceTest.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using EasyPost.Models.API;
+using EasyPost.Parameters.CustomerPortal;
+using EasyPost.Parameters.User;
+using EasyPost.Tests._Utilities;
+using EasyPost.Tests._Utilities.Attributes;
+using EasyPost.Utilities.Internal.Attributes;
+using Xunit;
+
+namespace EasyPost.Tests.ServicesTests.WithParameters
+{
+    public class CustomerPortalServiceTests : UnitTest
+    {
+        public CustomerPortalServiceTests() : base("customer_portal_service_with_parameters", TestUtils.ApiKey.Production)
+        {
+        }
+
+        #region Tests
+
+        #region Test CRUD Operations
+
+        [Fact]
+        [CrudOperations.Read]
+        [Testing.Function]
+        public async Task TestCreateAccountLink()
+        {
+            UseVCR("create_account_link");
+
+            Dictionary<string, object> fixture = new Dictionary<string, object> { { "page_size", Fixtures.PageSize } };
+            AllChildren childrenParameters = Fixtures.Parameters.Users.AllChildren(fixture);
+            ChildUserCollection childUserCollection = await Client.User.AllChildren(childrenParameters);
+
+            Parameters.CustomerPortal.CreateAccountLink parameters = new()
+            {
+                SessionType = "account_onboarding",
+                UserId = childUserCollection.Children[0].Id,
+                RefreshUrl = "https://example.com/refresh",
+                ReturnUrl = "https://example.com/return",
+            };
+            CustomerPortalAccountLink accountLink = await Client.CustomerPortal.CreateAccountLink(parameters);
+
+            Assert.IsType<CustomerPortalAccountLink>(accountLink);
+        }
+
+        #endregion
+
+        #endregion
+    }
+}

EasyPost.Tests/ServicesTests/WithParameters/EmbeddableServiceTest.cs

@@ -0,0 +1,49 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using EasyPost.Models.API;
+using EasyPost.Parameters.Embeddable;
+using EasyPost.Parameters.User;
+using EasyPost.Tests._Utilities;
+using EasyPost.Tests._Utilities.Attributes;
+using EasyPost.Utilities.Internal.Attributes;
+using Xunit;
+
+namespace EasyPost.Tests.ServicesTests.WithParameters
+{
+    public class EmbeddableServiceTests : UnitTest
+    {
+        public EmbeddableServiceTests() : base("embeddable_service_with_parameters", TestUtils.ApiKey.Production)
+        {
+        }
+
+        #region Tests
+
+        #region Test CRUD Operations
+
+        [Fact]
+        [CrudOperations.Read]
+        [Testing.Function]
+        public async Task TestCreateSession()
+        {
+            UseVCR("create_session");
+
+            Dictionary<string, object> fixture = new Dictionary<string, object> { { "page_size", Fixtures.PageSize } };
+            AllChildren childrenParameters = Fixtures.Parameters.Users.AllChildren(fixture);
+            ChildUserCollection childUserCollection = await Client.User.AllChildren(childrenParameters);
+
+            Parameters.Embeddable.CreateSession parameters = new()
+            {
+                OriginHost = "https://example.com",
+                UserId = childUserCollection.Children[0].Id,
+            };
+            EmbeddablesSession session = await Client.Embeddable.CreateSession(parameters);
+
+            Assert.IsType<EmbeddablesSession>(session);
+        }
+
+        #endregion
+
+        #endregion
+    }
+}

EasyPost.Tests/TestUtils.cs

@@ -23,13 +23,11 @@ public class TestUtils
 
         private static readonly List<string> BodyCensors =
         [
-            "api_keys",
-            "children",
             "client_ip",
             "credentials",
             "email",
+            "fields",
             "key",
-            "keys",
             "phone_number",
             "phone",
             "test_credentials"

EasyPost.Tests/cassettes/net/customer_portal_service_with_parameters/create_account_link.json

@@ -53,6 +53,11 @@ public class Client : EasyPostClient
         /// </summary>
         public ClaimService Claim => new ClaimService(this);
 
+        /// <summary>
+        ///     Access CustomerPortal-related functionality.
+        /// </summary>
+        public CustomerPortalService CustomerPortal => new CustomerPortalService(this);
+
         /// <summary>
         ///     Access Customs Info-related functionality.
         /// </summary>
@@ -63,6 +68,11 @@ public class Client : EasyPostClient
         /// </summary>
         public CustomsItemService CustomsItem => new CustomsItemService(this);
 
+        /// <summary>
+        ///     Access Embeddable-related functionality.
+        /// </summary>
+        public EmbeddableService Embeddable => new EmbeddableService(this);
+
         /// <summary>
         ///     Access EndShipper-related functionality.
         /// </summary>

EasyPost.Tests/cassettes/net/embeddable_service_with_parameters/create_session.json

@@ -0,0 +1,33 @@
+using EasyPost._base;
+using Newtonsoft.Json;
+
+namespace EasyPost.Models.API
+{
+    /// <summary>
+    ///     Class representing a CustomerPortalAccountLink.
+    /// </summary>
+    public class CustomerPortalAccountLink : EphemeralEasyPostObject
+    {
+        #region JSON Properties
+
+        /// <summary>
+        ///     One-time-use session URL for initiating the Customer Portal.
+        /// </summary>
+        [JsonProperty("link")]
+        public string? Link { get; set; }
+
+        /// <summary>
+        ///     One-time-use session URL for initiating the Customer Portal.
+        /// </summary>
+        [JsonProperty("created_at")]
+        public string? CreatedAt { get; set; }
+
+        /// <summary>
+        ///     ISO 8601 timestamp when the link will expire (5 minutes from creation).
+        /// </summary>
+        [JsonProperty("expires_at")]
+        public string? ExpiresAt { get; set; }
+
+        #endregion
+    }
+}