Skip to main content

Laravel Models

ClientXCMS uses Laravel models to manage client area data. These models are divided into several categories, each corresponding to a specific domain.

Customers

ModelNamespaceDescriptionExample
CustomerApp\Models\Account\CustomerRepresents a system customerApp\Models\Account\Customer::find($id)
EmailMessageApp\Models\Account\EmailMessageManages email messagesApp\Models\Account\EmailMessage::find($id)

Billing

ModelNamespaceDescriptionExample
CustomItemApp\Models\Billing\CustomItemHandles custom itemsApp\Models\Billing\CustomItem::find($id)
GatewayApp\Models\Billing\GatewayManages payment gatewaysApp\Models\Billing\Gateway::find($id)
InvoiceApp\Models\Billing\InvoiceRepresents an invoiceApp\Models\Billing\Invoice::find($id)
InvoiceItemApp\Models\Billing\InvoiceItemRepresents invoice itemsApp\Models\Billing\InvoiceItem::find($id)
InvoiceLogApp\Models\Billing\InvoiceLogLogs invoice-related actionsApp\Models\Billing\InvoiceLog::find($id)
SubscriptionApp\Models\Billing\SubscriptionManages subscriptionsApp\Models\Billing\Subscription::find($id)
SubscriptionLogApp\Models\Billing\SubscriptionLogLogs subscription-related actionsApp\Models\Billing\SubscriptionLog::find($id)
ConfigOptionApp\Models\Billing\ConfigOptionManages configuration optionsApp\Models\Billing\ConfigOption::find($id)
ConfigOptionOptionApp\Models\Billing\ConfigOptionOptionManages configuration option optionsApp\Models\Billing\ConfigOptionOption::find($id)
ConfigOptionProductApp\Models\Billing\ConfigOptionProductManages products associated with configuration optionsApp\Models\Billing\ConfigOptionProduct::find($id)
UpgradeApp\Models\Billing\UpgradeManages service upgradesApp\Models\Billing\Upgrade::find($id)

Help Center

ModelNamespaceDescriptionExample
SupportAttachmentApp\Models\Helpdesk\SupportAttachmentManages helpdesk attachmentsApp\Models\Helpdesk\SupportAttachment::find($id)
SupportDepartmentApp\Models\Helpdesk\SupportDepartmentRepresents a support departmentApp\Models\Helpdesk\SupportDepartment::find($id)
SupportMessageApp\Models\Helpdesk\SupportMessageManages helpdesk messagesApp\Models\Helpdesk\SupportMessage::find($id)
SupportTicketApp\Models\Helpdesk\SupportTicketManages helpdesk ticketsApp\Models\Helpdesk\SupportTicket::find($id)

Provisioning

ModelNamespaceDescriptionExample
CancellationReasonApp\Models\Provisioning\CancellationReasonRepresents a cancellation reasonApp\Models\Provisioning\CancellationReason::find($id)
ServerApp\Models\Provisioning\ServerManages a serverApp\Models\Provisioning\Server::find($id)
ServiceApp\Models\Provisioning\ServiceRepresents a serviceApp\Models\Provisioning\Service::find($id)
ServiceRenewalsApp\Models\Provisioning\ServiceRenewalsManages service renewalsApp\Models\Provisioning\ServiceRenewals::find($id)
SubdomainHostApp\Models\Provisioning\SubdomainHostManages hosting subdomainsApp\Models\Provisioning\SubdomainHost::find($id)
ConfigOptionServiceApp\Models\Provisioning\ConfigOptionServiceManages service configuration optionsApp\Models\Provisioning\ConfigOptionService::find($id)

Store

Cart

ModelNamespaceDescriptionExample
BasketApp\Models\Store\Basket\BasketManages the shopping cartApp\Models\Store\Basket\Basket::find($id)
BasketRowApp\Models\Store\Basket\BasketRowManages a cart item rowApp\Models\Store\Basket\BasketRow::find($id)
ModelNamespaceDescriptionExample
CouponApp\Models\Store\CouponRepresents a couponApp\Models\Store\Coupon::find($id)
CouponProductsApp\Models\Store\CouponProductsManages products associated with couponsApp\Models\Store\CouponProducts::find($id)
CouponUsageApp\Models\Store\CouponUsageLogs coupon usageApp\Models\Store\CouponUsage::find($id)
GroupApp\Models\Store\GroupRepresents a product groupApp\Models\Store\Group::find($id)
ProductApp\Models\Store\ProductRepresents a productApp\Models\Store\Product::find($id)
PricingApp\Models\Store\PricingRepresents a priceApp\Models\Store\Pricing::find($id)