The ApsoClient provides an entity() method to interact with specific resources in the API. It allows you to chain different methods to build queries and perform CRUD operations.
Creates an instance of EntityClient for the specified entity.
entityName'users').
const usersClient = apsoClient. entity ( 'users' ); Adds a filter to the query.
filter{ status: 'active' }).
const activeUsers = await apsoClient. entity ( 'users' ). where ({ status: 'active' }). get (); Adds joins to include related entities in the query response. This allows you to fetch associated data in a single request.
joinTables['profile', 'orders']).
// Fetch users with their profile information const usersWithProfiles = await apsoClient. entity ( 'users' ) . join ([ 'profile' ]) . get (); // Fetch users with profiles, orders, and addresses const usersWithRelatedData = await apsoClient. entity ( 'users' ) . join ([ 'profile' , 'orders' , 'addresses' ]) . where ({ status: 'active' }) . get (); // Fetch orders with customer and product information, filtering by date const recentOrdersWithDetails = await apsoClient. entity ( 'orders' ) . join ([ 'customer' , 'products' , 'shipping_address' ]) . where ({ created_at: { gte: '2024-01-01' } }) . orderBy ({ created_at: 'DESC' }) . limit ( 50 ) . get (); // Fetch companies with their departments and employees const companiesWithStructure = await apsoClient. entity ( 'companies' ) . join ([ 'departments' , 'departments.employees' ]) . where ({ active: true }) . get (); Specifies which fields to return in the response. This is especially useful with joins to control the amount of data returned.
fields
// Fetch users with specific fields from joined entities const selectedUserData = await apsoClient. entity ( 'users' ) . select ([ 'id' , 'name' , 'email' , 'profile.avatar' , 'profile.bio' , 'orders.id' , 'orders.total' ]) . join ([ 'profile' , 'orders' ]) . where ({ status: 'active' }) . get (); Limits the number of returned records.
limit
const limitedUsers = await apsoClient. entity ( 'users' ). where ({ status: 'active' }). limit ( 10 ). get (); Performs a GET request to retrieve the records.
const users = await apsoClient. entity ( 'users' ). where ({ status: 'active' }). limit ( 10 ). get (); Performs a POST request to create a new resource.
data
const newUser = await apsoClient. entity ( 'users' ). post ({ name: 'John Doe' , email: 'john@example.com' }); Performs a PUT request to update an existing resource.
data
const updatedUser = await apsoClient. entity ( 'users' ). where ({ id: 1 }). put ({ email: 'john.doe@example.com' }); Performs a DELETE request to remove a resource.
await apsoClient. entity ( 'users' ). where ({ id: 1 }). delete (); // Fetch products with their categories, reviews, and inventory data const productCatalog = await apsoClient. entity ( 'products' ) . join ([ 'category' , 'reviews' , 'inventory' ]) . select ([ 'id' , 'name' , 'price' , 'description' , 'category.name' , 'category.slug' , 'reviews.rating' , 'reviews.comment' , 'reviews.user_name' , 'inventory.quantity' , 'inventory.warehouse_location' ]) . where ({ status: 'active' , 'inventory.quantity' : { gt: 0 } }) . orderBy ({ created_at: 'DESC' }) . limit ( 20 ) . get (); // Fetch orders with customer, items, and shipping information const orderDetails = await apsoClient. entity ( 'orders' ) . join ([ 'customer' , 'order_items' , 'order_items.product' , 'shipping_address' , 'payment_method' ]) . select ([ 'id' , 'order_number' , 'status' , 'total' , 'created_at' , 'customer.name' , 'customer.email' , 'customer.phone' , 'order_items.quantity' , 'order_items.price' , 'order_items.product.name' , 'order_items.product.sku' , 'shipping_address.street' , 'shipping_address.city' , 'shipping_address.postal_code' , 'payment_method.type' , 'payment_method.last_four' ]) . where ({ status: { in: [ 'pending' , 'processing' ] } }) . orderBy ({ created_at: 'DESC' }) . get (); // Fetch blog posts with author details and recent comments const blogPostsWithDetails = await apsoClient. entity ( 'posts' ) . join ([ 'author' , 'comments' , 'comments.user' , 'tags' ]) . select ([ 'id' , 'title' , 'slug' , 'content' , 'published_at' , 'author.name' , 'author.bio' , 'author.avatar' , 'comments.content' , 'comments.created_at' , 'comments.user.name' , 'comments.user.avatar' , 'tags.name' , 'tags.slug' ]) . where ({ published: true }) . orderBy ({ published_at: 'DESC' }) . limit ( 10 ) . get (); // Fetch users with their roles, permissions, and recent activity const userManagement = await apsoClient. entity ( 'users' ) . join ([ 'profile' , 'roles' , 'roles.permissions' , 'activity_logs' ]) . select ([ 'id' , 'username' , 'email' , 'status' , 'last_login' , 'profile.first_name' , 'profile.last_name' , 'profile.department' , 'roles.name' , 'roles.description' , 'roles.permissions.resource' , 'roles.permissions.action' , 'activity_logs.action' , 'activity_logs.timestamp' ]) . where ({ status: 'active' }) . orderBy ({ last_login: 'DESC' }) . get (); The SDK supports several query parameters for GET requests to filter, sort, or paginate data.
where(filter: Record<string, any>){ active: true }).join(joinTables: string[])select(fields: string[])limit(limit: number)offset(offset: number)page(page: number)orderBy(sort: Record<string, 'ASC' | 'DESC'>)or(orCondition: Record<string, any>)cache(useCache?: boolean, duration?: number)
const result = await apsoClient. entity ( 'users' ) . select ([ 'id' , 'name' , 'email' , 'profile.avatar' , 'orders.total' ]) . join ([ 'profile' , 'orders' ]) . where ({ active: true , 'profile.verified' : true }) . or ({ role: 'admin' }) . orderBy ({ created_at: 'DESC' }) . limit ( 25 ) . offset ( 50 ) . cache ( true , 300 ) // Cache for 5 minutes . get (); The ApsoClient will throw an error if the request fails. Make sure to wrap your requests in try-catch blocks to handle errors appropriately.
try { const userWithOrders = await apsoClient. entity ( 'users' ) . join ([ 'orders' , 'profile' ]) . where ({ id: 1 }) . get (); console. log (userWithOrders); } catch (error) { console. error ( 'Error fetching user with related data:' , error); }