[feat] Add function to retrieve paginated list of child users (#538)

- Add `AllChildren` and `GetNextPageOfChildren` functions to User service
- Add unit tests, cassettes
- Fix straggling back CRUD decorators
- Split BaseUser into explicit User and ReferralCustomer classes
- Add "verified" property to User class for child users

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Next Release
+
+- Add `AllChildren` and `GetNextPageOfChildren` functions to `User` service
+
 ## v6.0.0 (2023-12-06)
 
 - No changes since `v6.0.0-rc1`, see below.

EasyPost.Tests/Fixture.cs

@@ -717,6 +717,18 @@ internal static ParameterSets.User.CreateChild CreateChild(Dictionary<string, ob
                         Name = fixture.GetOrNull<string>("name"),
                     };
                 }
+
+                internal static ParameterSets.User.AllChildren AllChildren(Dictionary<string, object>? fixture)
+                {
+                    fixture ??= new Dictionary<string, object>();
+
+                    return new ParameterSets.User.AllChildren
+                    {
+                        PageSize = fixture.GetOrNullInt("page_size"),
+                        BeforeId = fixture.GetOrNull<string>("before_id"),
+                        AfterId = fixture.GetOrNull<string>("after_id"),
+                    };
+                }
             }
 
             internal static class Webhooks

EasyPost.Tests/ServicesTests/UserServiceTest.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using EasyPost.Exceptions.General;
 using EasyPost.Models.API;
 using EasyPost.Tests._Utilities;
 using EasyPost.Tests._Utilities.Attributes;
@@ -77,6 +78,49 @@ public async Task TestRetrieveMe()
             Assert.StartsWith("user_", user.Id);
         }
 
+        [Fact]
+        [CrudOperations.Read]
+        [Testing.Function]
+        public async Task TestAllChildren()
+        {
+            UseVCR("all_children");
+
+            ChildUserCollection childUserCollection = await Client.User.AllChildren(new Dictionary<string, object> { { "page_size", Fixtures.PageSize } });
+            List<User> children = childUserCollection.Children;
+
+            Assert.True(children.Count <= Fixtures.PageSize);
+            foreach (User item in children)
+            {
+                Assert.IsType<User>(item);
+            }
+        }
+
+        [Fact]
+        [CrudOperations.Read]
+        [Testing.Function]
+        public async Task TestGetNextPageOfChildren()
+        {
+            UseVCR("get_next_page_of_children");
+
+            ChildUserCollection collection = await Client.User.AllChildren(new Dictionary<string, object> { { "page_size", Fixtures.PageSize } });
+
+            try
+            {
+                ChildUserCollection nextPageCollection = await Client.User.GetNextPageOfChildren(collection);
+
+                // If the first ID in the next page is the same as the first ID in the current page, then we didn't get the next page
+                Assert.NotEqual(collection.Children[0].Id, nextPageCollection.Children[0].Id);
+            }
+            catch (EndOfPaginationError) // There's no second page, that's not a failure
+            {
+                Assert.True(true);
+            }
+            catch // Any other exception is a failure
+            {
+                Assert.True(false);
+            }
+        }
+
         [Fact]
         [CrudOperations.Create]
         [Testing.Function]

EasyPost.Tests/ServicesTests/WithParameters/UserServiceTest.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using EasyPost.Models.API;
+using EasyPost.Parameters.User;
 using EasyPost.Tests._Utilities;
 using EasyPost.Tests._Utilities.Attributes;
 using EasyPost.Utilities.Internal.Attributes;
@@ -50,7 +51,28 @@ public async Task TestCreateChild()
         }
 
         [Fact]
-        [CrudOperations.Create]
+        [CrudOperations.Read]
+        [Testing.Function]
+        public async Task TestAllChildren()
+        {
+            UseVCR("all_children");
+
+            Dictionary<string, object> fixture = new Dictionary<string, object> { { "page_size", Fixtures.PageSize } };
+
+            AllChildren parameters = Fixtures.Parameters.Users.AllChildren(fixture);
+
+            ChildUserCollection childUserCollection = await Client.User.AllChildren(parameters);
+            List<User> children = childUserCollection.Children;
+
+            Assert.True(children.Count <= Fixtures.PageSize);
+            foreach (User item in children)
+            {
+                Assert.IsType<User>(item);
+            }
+        }
+
+        [Fact]
+        [CrudOperations.Update]
         [Testing.Function]
         public async Task TestUpdateBrand()
         {