fluentcart-developer 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +26 -26
- package/README.md +59 -59
- package/dist/cards/fluentcart/templates-native.js +1087 -1087
- package/dist/cards/fluentcart/tools.js +2309 -2309
- package/dist/skills/fluentcart-developer/SKILL.md +108 -108
- package/dist/skills/fluentcart-developer/examples/README.md +30 -30
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
- package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
- package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
- package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
- package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
- package/dist/skills/fluentcart-developer/references/index.md +625 -625
- package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
- package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
- package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
- package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
- package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +66 -65
|
@@ -1,584 +1,584 @@
|
|
|
1
|
-
# Customer Model
|
|
2
|
-
|
|
3
|
-
| DB Table Name | {wp_db_prefix}_fct_customers |
|
|
4
|
-
| --- | --- |
|
|
5
|
-
| Schema | [Check Schema](/database/schema.md#fct-customers-table) |
|
|
6
|
-
| Source File | fluent-cart/app/Models/Customer.php |
|
|
7
|
-
| Name Space | FluentCart\App\Models |
|
|
8
|
-
| Class | FluentCart\App\Models\Customer |
|
|
9
|
-
|
|
10
|
-
## Traits
|
|
11
|
-
|
|
12
|
-
| Trait | Description |
|
|
13
|
-
| --- | --- |
|
|
14
|
-
| CanSearch | Provides `search()`, `whereLike()`, `whereBeginsWith()`, `whereEndsWith()`, `groupSearch()` scopes for flexible query filtering |
|
|
15
|
-
| CanUpdateBatch | Provides `batchUpdate()` scope for batch updating multiple records |
|
|
16
|
-
|
|
17
|
-
## Attributes
|
|
18
|
-
|
|
19
|
-
| Attribute | Data Type | Comment |
|
|
20
|
-
| --- | --- | --- |
|
|
21
|
-
| id | Integer (BIGINT UNSIGNED) | Primary Key, Auto Increment |
|
|
22
|
-
| user_id | Integer (BIGINT UNSIGNED) | WordPress user ID (nullable) |
|
|
23
|
-
| contact_id | Integer (BIGINT UNSIGNED) | Contact ID (default 0) |
|
|
24
|
-
| email | String (VARCHAR 192) | Customer email address |
|
|
25
|
-
| first_name | String (VARCHAR 192) | Customer first name |
|
|
26
|
-
| last_name | String (VARCHAR 192) | Customer last name |
|
|
27
|
-
| status | String (VARCHAR 45) | Customer status (default: 'active') |
|
|
28
|
-
| purchase_value | JSON | Purchase value data (stored/retrieved as JSON) |
|
|
29
|
-
| purchase_count | Integer (BIGINT UNSIGNED) | Number of purchases (default 0) |
|
|
30
|
-
| ltv | Integer (BIGINT) | Lifetime value in cents (default 0) |
|
|
31
|
-
| first_purchase_date | Date Time | First purchase date (nullable) |
|
|
32
|
-
| last_purchase_date | Date Time | Last purchase date (nullable) |
|
|
33
|
-
| aov | Decimal (18,2) | Average order value (nullable) |
|
|
34
|
-
| notes | Text (LONGTEXT) | Customer notes |
|
|
35
|
-
| uuid | String (VARCHAR 100) | Unique identifier (auto-generated on creation) |
|
|
36
|
-
| country | String (VARCHAR 45) | Customer country code (nullable) |
|
|
37
|
-
| city | String (VARCHAR 45) | Customer city (nullable) |
|
|
38
|
-
| state | String (VARCHAR 45) | Customer state (nullable) |
|
|
39
|
-
| postcode | String (VARCHAR 45) | Customer postcode (nullable) |
|
|
40
|
-
| created_at | Date Time | Creation timestamp |
|
|
41
|
-
| updated_at | Date Time | Last update timestamp |
|
|
42
|
-
|
|
43
|
-
### Appended Attributes
|
|
44
|
-
|
|
45
|
-
These virtual attributes are appended to every serialized Customer instance via the `$appends` property:
|
|
46
|
-
|
|
47
|
-
| Attribute | Accessor Method | Return Type | Description |
|
|
48
|
-
| --- | --- | --- | --- |
|
|
49
|
-
| full_name | `getFullNameAttribute()` | String | Concatenation of first_name and last_name |
|
|
50
|
-
| photo | `getPhotoAttribute()` | String | Avatar URL from `Helper::getUserAvatarUrl($user_id, $email)`; an empty string when there is no avatar |
|
|
51
|
-
| country_name | `getCountryNameAttribute()` | String | Human-readable country name from country code |
|
|
52
|
-
| formatted_address | `getFormattedAddressAttribute()` | Array | Formatted address data array |
|
|
53
|
-
| user_link | `getUserLinkAttribute()` | String | WordPress admin user-edit URL (empty if no user_id) |
|
|
54
|
-
|
|
55
|
-
### Searchable Fields
|
|
56
|
-
|
|
57
|
-
The `$searchable` property defines which fields are used by the `searchBy` scope:
|
|
58
|
-
|
|
59
|
-
- `first_name`
|
|
60
|
-
- `last_name`
|
|
61
|
-
- `email`
|
|
62
|
-
|
|
63
|
-
### Mutators
|
|
64
|
-
|
|
65
|
-
| Mutator | Direction | Description |
|
|
66
|
-
| --- | --- | --- |
|
|
67
|
-
| `setPurchaseValueAttribute` | Set | Accepts array/object (JSON-encodes) or scalar value |
|
|
68
|
-
| `getPurchaseValueAttribute` | Get | Returns decoded JSON as array, or null if empty |
|
|
69
|
-
|
|
70
|
-
### Boot Behavior
|
|
71
|
-
|
|
72
|
-
On `creating`, the model auto-generates the `uuid` attribute using `md5($model->email . '_' . wp_generate_uuid4())`.
|
|
73
|
-
|
|
74
|
-
## Usage
|
|
75
|
-
|
|
76
|
-
Please check [Model Basic](/database/models.md) for Common methods.
|
|
77
|
-
|
|
78
|
-
### Accessing Attributes
|
|
79
|
-
|
|
80
|
-
```
|
|
81
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
82
|
-
|
|
83
|
-
$customer->id; // returns customer ID
|
|
84
|
-
$customer->email; // returns email address
|
|
85
|
-
$customer->first_name; // returns first name
|
|
86
|
-
$customer->last_name; // returns last name
|
|
87
|
-
$customer->status; // returns customer status
|
|
88
|
-
$customer->full_name; // returns "John Doe" (appended)
|
|
89
|
-
$customer->photo; // returns photo URL (appended)
|
|
90
|
-
$customer->country_name; // returns country name (appended)
|
|
91
|
-
$customer->formatted_address; // returns address array (appended)
|
|
92
|
-
$customer->user_link; // returns WP user edit URL (appended)
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
## Methods
|
|
96
|
-
|
|
97
|
-
Along with Global Model methods, this model has few helper methods.
|
|
98
|
-
|
|
99
|
-
### getFullNameAttribute()
|
|
100
|
-
|
|
101
|
-
Get customer full name by concatenating first_name and last_name.
|
|
102
|
-
|
|
103
|
-
- Returns `String` - Full name (first_name + last_name), trimmed
|
|
104
|
-
|
|
105
|
-
```
|
|
106
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
107
|
-
$fullName = $customer->full_name; // returns "John Doe"
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
### getPhotoAttribute()
|
|
111
|
-
|
|
112
|
-
Get customer photo URL. First checks for a custom photo URL stored in user meta (`fc_customer_photo_url`). Falls back to Gravatar (100x100) if no custom photo is set.
|
|
113
|
-
|
|
114
|
-
- Returns `String` - Photo URL (custom or Gravatar)
|
|
115
|
-
|
|
116
|
-
```
|
|
117
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
118
|
-
$photo = $customer->photo; // returns photo URL
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
### getCountryNameAttribute()
|
|
122
|
-
|
|
123
|
-
Get country name from country code using `Helper::getCountryName()`.
|
|
124
|
-
|
|
125
|
-
- Returns `String` - Country name
|
|
126
|
-
|
|
127
|
-
```
|
|
128
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
129
|
-
$countryName = $customer->country_name; // returns country name
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
### getFormattedAddressAttribute()
|
|
133
|
-
|
|
134
|
-
Get formatted address as an associative array with resolved country and state names.
|
|
135
|
-
|
|
136
|
-
- Returns `Array` - Formatted address data with keys: `country`, `state`, `city`, `postcode`, `first_name`, `last_name`, `full_name`
|
|
137
|
-
|
|
138
|
-
```
|
|
139
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
140
|
-
$address = $customer->formatted_address;
|
|
141
|
-
// [
|
|
142
|
-
// 'country' => 'United States',
|
|
143
|
-
// 'state' => 'California',
|
|
144
|
-
// 'city' => 'San Francisco',
|
|
145
|
-
// 'postcode' => '94102',
|
|
146
|
-
// 'first_name' => 'John',
|
|
147
|
-
// 'last_name' => 'Doe',
|
|
148
|
-
// 'full_name' => 'John Doe'
|
|
149
|
-
// ]
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
### getUserLinkAttribute()
|
|
153
|
-
|
|
154
|
-
Get WordPress user edit link. Returns empty string if the customer has no associated `user_id`.
|
|
155
|
-
|
|
156
|
-
- Returns `String` - User edit URL (e.g., `/wp-admin/user-edit.php?user_id=5`) or empty string
|
|
157
|
-
|
|
158
|
-
```
|
|
159
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
160
|
-
$userLink = $customer->user_link; // returns user edit URL
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
### recountStats()
|
|
164
|
-
|
|
165
|
-
Recount customer order statistics. Sets `total_order_count` (count of all orders) and `total_order_value` (sum of `total_amount` across all orders) and saves the model.
|
|
166
|
-
|
|
167
|
-
- Returns `FluentCart\App\Models\Customer` - Updated customer instance
|
|
168
|
-
|
|
169
|
-
```
|
|
170
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
171
|
-
$customer->recountStats();
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
### recountStat()
|
|
175
|
-
|
|
176
|
-
Recount detailed customer purchase statistics from successful payment orders only.
|
|
177
|
-
|
|
178
|
-
Totals are grouped **per currency** and only added together after each order's amount is converted at the rate frozen on that order, so a multi-currency customer's lifetime value is not a sum of mixed units:
|
|
179
|
-
|
|
180
|
-
- `purchase_value` — net paid minus refunds, kept per currency
|
|
181
|
-
- `ltv` — the same figure converted to the store's base currency
|
|
182
|
-
- `aov` — `ltv` divided by the count of orders with a trusted exchange rate, not by all orders
|
|
183
|
-
- `purchase_count`, `first_purchase_date`, `last_purchase_date`
|
|
184
|
-
|
|
185
|
-
Saves the model.
|
|
186
|
-
|
|
187
|
-
- Returns `FluentCart\App\Models\Customer` - Updated customer instance
|
|
188
|
-
|
|
189
|
-
```
|
|
190
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
191
|
-
$customer->recountStat();
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### updateCustomerStatus($newStatus)
|
|
195
|
-
|
|
196
|
-
Update customer status and fire action hooks. If the new status is the same as the current status, returns early without saving or firing hooks.
|
|
197
|
-
|
|
198
|
-
Fires the following WordPress action hooks:
|
|
199
|
-
|
|
200
|
-
- `fluent_cart/customer_status_to_{$newStatus}` - Status-specific hook
|
|
201
|
-
- `fluent_cart/customer_status_updated` - General status change hook
|
|
202
|
-
|
|
203
|
-
Both hooks receive an array with keys: `customer`, `old_status`, `new_status`.
|
|
204
|
-
|
|
205
|
-
- Parameters: `$newStatus` (String) - New status value
|
|
206
|
-
- Returns `FluentCart\App\Models\Customer` - Updated customer instance
|
|
207
|
-
|
|
208
|
-
```
|
|
209
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
210
|
-
$customer->updateCustomerStatus('active');
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
### getWpUserId($recheck = false)
|
|
214
|
-
|
|
215
|
-
Returns the stored `user_id`. The `$recheck` parameter is accepted for backward compatibility and has no effect — the method performs no email lookup and never rewrites `user_id`.
|
|
216
|
-
|
|
217
|
-
- Parameters: `$recheck` (Boolean) - accepted and ignored
|
|
218
|
-
- Returns `Integer|null` - the stored WordPress user ID
|
|
219
|
-
|
|
220
|
-
```
|
|
221
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
222
|
-
$wpUserId = $customer->getWpUserId();
|
|
223
|
-
```
|
|
224
|
-
|
|
225
|
-
### getWpUser()
|
|
226
|
-
|
|
227
|
-
Get the WordPress user by the stored `user_id`. Returns `false` when the customer has no `user_id`, i.e. when the account is unclaimed.
|
|
228
|
-
|
|
229
|
-
- Returns `WP_User|false` - WordPress user object, or `false` when unlinked
|
|
230
|
-
|
|
231
|
-
```
|
|
232
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
233
|
-
$wpUser = $customer->getWpUser();
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
### getMeta($metaKey, $default = null)
|
|
237
|
-
|
|
238
|
-
Get customer meta value from the `fct_customer_meta` table.
|
|
239
|
-
|
|
240
|
-
- Parameters: `$metaKey` (String) - Meta key, `$default` (Mixed) - Default value if not found (default: null)
|
|
241
|
-
- Returns `Mixed` - Meta value or default
|
|
242
|
-
|
|
243
|
-
```
|
|
244
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
245
|
-
$metaValue = $customer->getMeta('custom_field', 'default');
|
|
246
|
-
```
|
|
247
|
-
|
|
248
|
-
### updateMeta($metaKey, $metaValue)
|
|
249
|
-
|
|
250
|
-
Create or update customer meta value in the `fct_customer_meta` table.
|
|
251
|
-
|
|
252
|
-
- Parameters: `$metaKey` (String) - Meta key, `$metaValue` (Mixed) - Meta value
|
|
253
|
-
- Returns `FluentCart\App\Models\CustomerMeta` - Meta instance (created or updated)
|
|
254
|
-
|
|
255
|
-
```
|
|
256
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
257
|
-
$meta = $customer->updateMeta('custom_field', 'new_value');
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
## Relations
|
|
261
|
-
|
|
262
|
-
This model has the following relationships that you can use
|
|
263
|
-
|
|
264
|
-
### orders
|
|
265
|
-
|
|
266
|
-
Access the customer orders.
|
|
267
|
-
|
|
268
|
-
- Relation type: `HasMany`
|
|
269
|
-
- Returns collection of `FluentCart\App\Models\Order`
|
|
270
|
-
- Foreign key: `customer_id`
|
|
271
|
-
|
|
272
|
-
```
|
|
273
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
274
|
-
$orders = $customer->orders;
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
### success_order_items
|
|
278
|
-
|
|
279
|
-
Access the successful order items (items from orders with successful payment statuses).
|
|
280
|
-
|
|
281
|
-
- Relation type: `HasManyThrough` (through `FluentCart\App\Models\Order`)
|
|
282
|
-
- Returns collection of `FluentCart\App\Models\OrderItem`
|
|
283
|
-
- Filters orders by successful payment statuses via `Status::getOrderPaymentSuccessStatuses()`
|
|
284
|
-
|
|
285
|
-
```
|
|
286
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
287
|
-
$orderItems = $customer->success_order_items;
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
### subscriptions
|
|
291
|
-
|
|
292
|
-
Access the customer subscriptions.
|
|
293
|
-
|
|
294
|
-
- Relation type: `HasMany`
|
|
295
|
-
- Returns collection of `FluentCart\App\Models\Subscription`
|
|
296
|
-
- Foreign key: `customer_id`
|
|
297
|
-
|
|
298
|
-
```
|
|
299
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
300
|
-
$subscriptions = $customer->subscriptions;
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
### shipping_address
|
|
304
|
-
|
|
305
|
-
Access the shipping addresses (filtered by type = 'shipping').
|
|
306
|
-
|
|
307
|
-
- Relation type: `HasMany`
|
|
308
|
-
- Returns collection of `FluentCart\App\Models\CustomerAddresses`
|
|
309
|
-
- Foreign key: `customer_id`
|
|
310
|
-
|
|
311
|
-
```
|
|
312
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
313
|
-
$addresses = $customer->shipping_address;
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
### billing_address
|
|
317
|
-
|
|
318
|
-
Access the billing addresses (filtered by type = 'billing').
|
|
319
|
-
|
|
320
|
-
- Relation type: `HasMany`
|
|
321
|
-
- Returns collection of `FluentCart\App\Models\CustomerAddresses`
|
|
322
|
-
- Foreign key: `customer_id`
|
|
323
|
-
|
|
324
|
-
```
|
|
325
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
326
|
-
$addresses = $customer->billing_address;
|
|
327
|
-
```
|
|
328
|
-
|
|
329
|
-
### primary_shipping_address
|
|
330
|
-
|
|
331
|
-
Access the primary shipping address (filtered by type = 'shipping' and is_primary = 1).
|
|
332
|
-
|
|
333
|
-
- Relation type: `HasOne`
|
|
334
|
-
- Returns `FluentCart\App\Models\CustomerAddresses|null`
|
|
335
|
-
|
|
336
|
-
```
|
|
337
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
338
|
-
$address = $customer->primary_shipping_address;
|
|
339
|
-
```
|
|
340
|
-
|
|
341
|
-
### primary_billing_address
|
|
342
|
-
|
|
343
|
-
Access the primary billing address (filtered by type = 'billing' and is_primary = 1).
|
|
344
|
-
|
|
345
|
-
- Relation type: `HasOne`
|
|
346
|
-
- Returns `FluentCart\App\Models\CustomerAddresses|null`
|
|
347
|
-
|
|
348
|
-
```
|
|
349
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
350
|
-
$address = $customer->primary_billing_address;
|
|
351
|
-
```
|
|
352
|
-
|
|
353
|
-
### labels
|
|
354
|
-
|
|
355
|
-
Access the customer labels (polymorphic relationship).
|
|
356
|
-
|
|
357
|
-
- Relation type: `MorphMany`
|
|
358
|
-
- Returns collection of `FluentCart\App\Models\LabelRelationship`
|
|
359
|
-
|
|
360
|
-
```
|
|
361
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
362
|
-
$labels = $customer->labels;
|
|
363
|
-
```
|
|
364
|
-
|
|
365
|
-
### wpUser
|
|
366
|
-
|
|
367
|
-
Access the associated WordPress user.
|
|
368
|
-
|
|
369
|
-
- Relation type: `BelongsTo`
|
|
370
|
-
- Returns `FluentCart\App\Models\User|null`
|
|
371
|
-
- Foreign key: `user_id`
|
|
372
|
-
|
|
373
|
-
```
|
|
374
|
-
$customer = FluentCart\App\Models\Customer::find(1);
|
|
375
|
-
$user = $customer->wpUser;
|
|
376
|
-
```
|
|
377
|
-
|
|
378
|
-
## Scopes
|
|
379
|
-
|
|
380
|
-
### unclaimed()
|
|
381
|
-
|
|
382
|
-
Customers with no linked WordPress user — `user_id` is `NULL` or `0`. These are guest purchases that nobody has claimed by registering with the same email.
|
|
383
|
-
|
|
384
|
-
```
|
|
385
|
-
$guests = FluentCart\App\Models\Customer::unclaimed()->get();
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
This model has the following scopes that you can use
|
|
389
|
-
|
|
390
|
-
### ofActive()
|
|
391
|
-
|
|
392
|
-
Get only active customers (where status = 'active').
|
|
393
|
-
|
|
394
|
-
```
|
|
395
|
-
$customers = FluentCart\App\Models\Customer::ofActive()->get();
|
|
396
|
-
```
|
|
397
|
-
|
|
398
|
-
### ofArchived()
|
|
399
|
-
|
|
400
|
-
Get only archived customers (where status = 'archived').
|
|
401
|
-
|
|
402
|
-
```
|
|
403
|
-
$customers = FluentCart\App\Models\Customer::ofArchived()->get();
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
### searchBy($search)
|
|
407
|
-
|
|
408
|
-
Search customers by query string. Supports multiple search modes:
|
|
409
|
-
|
|
410
|
-
- **Operator-based search**: `column_name > value`, `column_name = value`, etc. (supports `=`, `!=`, `>`, `<`)
|
|
411
|
-
- **Column-specific LIKE search**: `column_name:value` (searches with LIKE %value%)
|
|
412
|
-
- **Column-specific exact search**: `column_name=value`
|
|
413
|
-
- **General search**: Searches across `$searchable` fields (`first_name`, `last_name`, `email`) with LIKE matching. Also handles multi-word queries by splitting into first_name/last_name search.
|
|
414
|
-
|
|
415
|
-
- Parameters: `$search` (String) - Search query
|
|
416
|
-
|
|
417
|
-
```
|
|
418
|
-
// General search across searchable fields
|
|
419
|
-
$customers = FluentCart\App\Models\Customer::searchBy('john')->get();
|
|
420
|
-
|
|
421
|
-
// Operator-based search
|
|
422
|
-
$customers = FluentCart\App\Models\Customer::searchBy('purchase_count > 5')->get();
|
|
423
|
-
|
|
424
|
-
// Column-specific LIKE search
|
|
425
|
-
$customers = FluentCart\App\Models\Customer::searchBy('email:example.com')->get();
|
|
426
|
-
|
|
427
|
-
// Full name search (splits "John Doe" into first_name + last_name)
|
|
428
|
-
$customers = FluentCart\App\Models\Customer::searchBy('John Doe')->get();
|
|
429
|
-
```
|
|
430
|
-
|
|
431
|
-
### applyCustomFilters($filters)
|
|
432
|
-
|
|
433
|
-
Apply custom filters using an associative array. Each filter key must be a fillable attribute. Supports operators: `includes` (LIKE), `not_includes` (NOT LIKE), `gt` (>), `lt` (
|
|
434
|
-
|
|
435
|
-
```
|
|
436
|
-
$customers = FluentCart\App\Models\Customer::searchByFullName([
|
|
437
|
-
'value' => 'John',
|
|
438
|
-
'operator' => 'starts_with'
|
|
439
|
-
])->get();
|
|
440
|
-
|
|
441
|
-
$customers = FluentCart\App\Models\Customer::searchByFullName([
|
|
442
|
-
'value' => 'Doe',
|
|
443
|
-
'operator' => 'ends_with'
|
|
444
|
-
])->get();
|
|
445
|
-
|
|
446
|
-
$customers = FluentCart\App\Models\Customer::searchByFullName([
|
|
447
|
-
'value' => 'Test User',
|
|
448
|
-
'operator' => 'not_like'
|
|
449
|
-
])->get();
|
|
450
|
-
```
|
|
451
|
-
|
|
452
|
-
### Inherited Scopes from CanSearch Trait
|
|
453
|
-
|
|
454
|
-
These scopes are available via the `CanSearch` trait:
|
|
455
|
-
|
|
456
|
-
#### search($params)
|
|
457
|
-
|
|
458
|
-
Flexible search with multiple operators per column.
|
|
459
|
-
|
|
460
|
-
```
|
|
461
|
-
$customers = FluentCart\App\Models\Customer::search([
|
|
462
|
-
'email' => ['column' => 'email', 'operator' => 'like_all', 'value' => 'example.com'],
|
|
463
|
-
'status' => ['column' => 'status', 'operator' => '=', 'value' => 'active']
|
|
464
|
-
])->get();
|
|
465
|
-
```
|
|
466
|
-
|
|
467
|
-
#### whereLike($column, $value)
|
|
468
|
-
|
|
469
|
-
WHERE column LIKE %value% query.
|
|
470
|
-
|
|
471
|
-
```
|
|
472
|
-
$customers = FluentCart\App\Models\Customer::whereLike('email', 'example.com')->get();
|
|
473
|
-
```
|
|
474
|
-
|
|
475
|
-
#### whereBeginsWith($column, $value)
|
|
476
|
-
|
|
477
|
-
WHERE column LIKE value% query.
|
|
478
|
-
|
|
479
|
-
```
|
|
480
|
-
$customers = FluentCart\App\Models\Customer::whereBeginsWith('first_name', 'Jo')->get();
|
|
481
|
-
```
|
|
482
|
-
|
|
483
|
-
#### whereEndsWith($column, $value)
|
|
484
|
-
|
|
485
|
-
WHERE column LIKE %value query.
|
|
486
|
-
|
|
487
|
-
```
|
|
488
|
-
$customers = FluentCart\App\Models\Customer::whereEndsWith('email', '.com')->get();
|
|
489
|
-
```
|
|
490
|
-
|
|
491
|
-
#### groupSearch($groups)
|
|
492
|
-
|
|
493
|
-
Search across related models using dot notation.
|
|
494
|
-
|
|
495
|
-
```
|
|
496
|
-
$customers = FluentCart\App\Models\Customer::groupSearch([
|
|
497
|
-
'fct_customers.email' => ['column' => 'email', 'operator' => 'like_all', 'value' => 'test'],
|
|
498
|
-
])->get();
|
|
499
|
-
```
|
|
500
|
-
|
|
501
|
-
### Inherited Scope from CanUpdateBatch Trait
|
|
502
|
-
|
|
503
|
-
#### batchUpdate($values, $index = null)
|
|
504
|
-
|
|
505
|
-
Batch update multiple records at once.
|
|
506
|
-
|
|
507
|
-
```
|
|
508
|
-
FluentCart\App\Models\Customer::batchUpdate([
|
|
509
|
-
['id' => 1, 'status' => 'active'],
|
|
510
|
-
['id' => 2, 'status' => 'archived'],
|
|
511
|
-
]);
|
|
512
|
-
```
|
|
513
|
-
|
|
514
|
-
## Usage Examples
|
|
515
|
-
|
|
516
|
-
### Creating a Customer
|
|
517
|
-
|
|
518
|
-
```
|
|
519
|
-
use FluentCart\App\Models\Customer;
|
|
520
|
-
|
|
521
|
-
// uuid is auto-generated on creation
|
|
522
|
-
$customer = Customer::create([
|
|
523
|
-
'email' => '[email protected]',
|
|
524
|
-
'first_name' => 'John',
|
|
525
|
-
'last_name' => 'Doe',
|
|
526
|
-
'status' => 'active'
|
|
527
|
-
]);
|
|
528
|
-
```
|
|
529
|
-
|
|
530
|
-
### Retrieving Customers
|
|
531
|
-
|
|
532
|
-
```
|
|
533
|
-
// Get all active customers
|
|
534
|
-
$customers = Customer::ofActive()->get();
|
|
535
|
-
|
|
536
|
-
// Get customer by email
|
|
537
|
-
$customer = Customer::where('email', '[email protected]')->first();
|
|
538
|
-
|
|
539
|
-
// Get customer with orders
|
|
540
|
-
$customer = Customer::with('orders')->find(1);
|
|
541
|
-
|
|
542
|
-
// Search customers
|
|
543
|
-
$customers = Customer::searchBy('john doe')->get();
|
|
544
|
-
|
|
545
|
-
// Get customers with custom filters
|
|
546
|
-
$customers = Customer::applyCustomFilters([
|
|
547
|
-
'country' => ['value' => 'US', 'operator' => '=']
|
|
548
|
-
])->get();
|
|
549
|
-
```
|
|
550
|
-
|
|
551
|
-
### Updating a Customer
|
|
552
|
-
|
|
553
|
-
```
|
|
554
|
-
$customer = Customer::find(1);
|
|
555
|
-
$customer->first_name = 'Jane';
|
|
556
|
-
$customer->save();
|
|
557
|
-
|
|
558
|
-
// Update status with hooks
|
|
559
|
-
$customer->updateCustomerStatus('archived');
|
|
560
|
-
|
|
561
|
-
// Recount purchase statistics
|
|
562
|
-
$customer->recountStat();
|
|
563
|
-
```
|
|
564
|
-
|
|
565
|
-
### Working with Meta
|
|
566
|
-
|
|
567
|
-
```
|
|
568
|
-
$customer = Customer::find(1);
|
|
569
|
-
|
|
570
|
-
// Get meta
|
|
571
|
-
$value = $customer->getMeta('preferred_language', 'en');
|
|
572
|
-
|
|
573
|
-
// Set/update meta
|
|
574
|
-
$customer->updateMeta('preferred_language', 'fr');
|
|
575
|
-
```
|
|
576
|
-
|
|
577
|
-
### Deleting a Customer
|
|
578
|
-
|
|
579
|
-
```
|
|
580
|
-
$customer = Customer::find(1);
|
|
581
|
-
$customer->delete();
|
|
582
|
-
```
|
|
583
|
-
|
|
584
|
-
---
|
|
1
|
+
# Customer Model
|
|
2
|
+
|
|
3
|
+
| DB Table Name | {wp_db_prefix}_fct_customers |
|
|
4
|
+
| --- | --- |
|
|
5
|
+
| Schema | [Check Schema](/database/schema.md#fct-customers-table) |
|
|
6
|
+
| Source File | fluent-cart/app/Models/Customer.php |
|
|
7
|
+
| Name Space | FluentCart\App\Models |
|
|
8
|
+
| Class | FluentCart\App\Models\Customer |
|
|
9
|
+
|
|
10
|
+
## Traits
|
|
11
|
+
|
|
12
|
+
| Trait | Description |
|
|
13
|
+
| --- | --- |
|
|
14
|
+
| CanSearch | Provides `search()`, `whereLike()`, `whereBeginsWith()`, `whereEndsWith()`, `groupSearch()` scopes for flexible query filtering |
|
|
15
|
+
| CanUpdateBatch | Provides `batchUpdate()` scope for batch updating multiple records |
|
|
16
|
+
|
|
17
|
+
## Attributes
|
|
18
|
+
|
|
19
|
+
| Attribute | Data Type | Comment |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| id | Integer (BIGINT UNSIGNED) | Primary Key, Auto Increment |
|
|
22
|
+
| user_id | Integer (BIGINT UNSIGNED) | WordPress user ID (nullable) |
|
|
23
|
+
| contact_id | Integer (BIGINT UNSIGNED) | Contact ID (default 0) |
|
|
24
|
+
| email | String (VARCHAR 192) | Customer email address |
|
|
25
|
+
| first_name | String (VARCHAR 192) | Customer first name |
|
|
26
|
+
| last_name | String (VARCHAR 192) | Customer last name |
|
|
27
|
+
| status | String (VARCHAR 45) | Customer status (default: 'active') |
|
|
28
|
+
| purchase_value | JSON | Purchase value data (stored/retrieved as JSON) |
|
|
29
|
+
| purchase_count | Integer (BIGINT UNSIGNED) | Number of purchases (default 0) |
|
|
30
|
+
| ltv | Integer (BIGINT) | Lifetime value in cents (default 0) |
|
|
31
|
+
| first_purchase_date | Date Time | First purchase date (nullable) |
|
|
32
|
+
| last_purchase_date | Date Time | Last purchase date (nullable) |
|
|
33
|
+
| aov | Decimal (18,2) | Average order value (nullable) |
|
|
34
|
+
| notes | Text (LONGTEXT) | Customer notes |
|
|
35
|
+
| uuid | String (VARCHAR 100) | Unique identifier (auto-generated on creation) |
|
|
36
|
+
| country | String (VARCHAR 45) | Customer country code (nullable) |
|
|
37
|
+
| city | String (VARCHAR 45) | Customer city (nullable) |
|
|
38
|
+
| state | String (VARCHAR 45) | Customer state (nullable) |
|
|
39
|
+
| postcode | String (VARCHAR 45) | Customer postcode (nullable) |
|
|
40
|
+
| created_at | Date Time | Creation timestamp |
|
|
41
|
+
| updated_at | Date Time | Last update timestamp |
|
|
42
|
+
|
|
43
|
+
### Appended Attributes
|
|
44
|
+
|
|
45
|
+
These virtual attributes are appended to every serialized Customer instance via the `$appends` property:
|
|
46
|
+
|
|
47
|
+
| Attribute | Accessor Method | Return Type | Description |
|
|
48
|
+
| --- | --- | --- | --- |
|
|
49
|
+
| full_name | `getFullNameAttribute()` | String | Concatenation of first_name and last_name |
|
|
50
|
+
| photo | `getPhotoAttribute()` | String | Avatar URL from `Helper::getUserAvatarUrl($user_id, $email)`; an empty string when there is no avatar |
|
|
51
|
+
| country_name | `getCountryNameAttribute()` | String | Human-readable country name from country code |
|
|
52
|
+
| formatted_address | `getFormattedAddressAttribute()` | Array | Formatted address data array |
|
|
53
|
+
| user_link | `getUserLinkAttribute()` | String | WordPress admin user-edit URL (empty if no user_id) |
|
|
54
|
+
|
|
55
|
+
### Searchable Fields
|
|
56
|
+
|
|
57
|
+
The `$searchable` property defines which fields are used by the `searchBy` scope:
|
|
58
|
+
|
|
59
|
+
- `first_name`
|
|
60
|
+
- `last_name`
|
|
61
|
+
- `email`
|
|
62
|
+
|
|
63
|
+
### Mutators
|
|
64
|
+
|
|
65
|
+
| Mutator | Direction | Description |
|
|
66
|
+
| --- | --- | --- |
|
|
67
|
+
| `setPurchaseValueAttribute` | Set | Accepts array/object (JSON-encodes) or scalar value |
|
|
68
|
+
| `getPurchaseValueAttribute` | Get | Returns decoded JSON as array, or null if empty |
|
|
69
|
+
|
|
70
|
+
### Boot Behavior
|
|
71
|
+
|
|
72
|
+
On `creating`, the model auto-generates the `uuid` attribute using `md5($model->email . '_' . wp_generate_uuid4())`.
|
|
73
|
+
|
|
74
|
+
## Usage
|
|
75
|
+
|
|
76
|
+
Please check [Model Basic](/database/models.md) for Common methods.
|
|
77
|
+
|
|
78
|
+
### Accessing Attributes
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
82
|
+
|
|
83
|
+
$customer->id; // returns customer ID
|
|
84
|
+
$customer->email; // returns email address
|
|
85
|
+
$customer->first_name; // returns first name
|
|
86
|
+
$customer->last_name; // returns last name
|
|
87
|
+
$customer->status; // returns customer status
|
|
88
|
+
$customer->full_name; // returns "John Doe" (appended)
|
|
89
|
+
$customer->photo; // returns photo URL (appended)
|
|
90
|
+
$customer->country_name; // returns country name (appended)
|
|
91
|
+
$customer->formatted_address; // returns address array (appended)
|
|
92
|
+
$customer->user_link; // returns WP user edit URL (appended)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Methods
|
|
96
|
+
|
|
97
|
+
Along with Global Model methods, this model has few helper methods.
|
|
98
|
+
|
|
99
|
+
### getFullNameAttribute()
|
|
100
|
+
|
|
101
|
+
Get customer full name by concatenating first_name and last_name.
|
|
102
|
+
|
|
103
|
+
- Returns `String` - Full name (first_name + last_name), trimmed
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
107
|
+
$fullName = $customer->full_name; // returns "John Doe"
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### getPhotoAttribute()
|
|
111
|
+
|
|
112
|
+
Get customer photo URL. First checks for a custom photo URL stored in user meta (`fc_customer_photo_url`). Falls back to Gravatar (100x100) if no custom photo is set.
|
|
113
|
+
|
|
114
|
+
- Returns `String` - Photo URL (custom or Gravatar)
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
118
|
+
$photo = $customer->photo; // returns photo URL
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### getCountryNameAttribute()
|
|
122
|
+
|
|
123
|
+
Get country name from country code using `Helper::getCountryName()`.
|
|
124
|
+
|
|
125
|
+
- Returns `String` - Country name
|
|
126
|
+
|
|
127
|
+
```
|
|
128
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
129
|
+
$countryName = $customer->country_name; // returns country name
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### getFormattedAddressAttribute()
|
|
133
|
+
|
|
134
|
+
Get formatted address as an associative array with resolved country and state names.
|
|
135
|
+
|
|
136
|
+
- Returns `Array` - Formatted address data with keys: `country`, `state`, `city`, `postcode`, `first_name`, `last_name`, `full_name`
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
140
|
+
$address = $customer->formatted_address;
|
|
141
|
+
// [
|
|
142
|
+
// 'country' => 'United States',
|
|
143
|
+
// 'state' => 'California',
|
|
144
|
+
// 'city' => 'San Francisco',
|
|
145
|
+
// 'postcode' => '94102',
|
|
146
|
+
// 'first_name' => 'John',
|
|
147
|
+
// 'last_name' => 'Doe',
|
|
148
|
+
// 'full_name' => 'John Doe'
|
|
149
|
+
// ]
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### getUserLinkAttribute()
|
|
153
|
+
|
|
154
|
+
Get WordPress user edit link. Returns empty string if the customer has no associated `user_id`.
|
|
155
|
+
|
|
156
|
+
- Returns `String` - User edit URL (e.g., `/wp-admin/user-edit.php?user_id=5`) or empty string
|
|
157
|
+
|
|
158
|
+
```
|
|
159
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
160
|
+
$userLink = $customer->user_link; // returns user edit URL
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### recountStats()
|
|
164
|
+
|
|
165
|
+
Recount customer order statistics. Sets `total_order_count` (count of all orders) and `total_order_value` (sum of `total_amount` across all orders) and saves the model.
|
|
166
|
+
|
|
167
|
+
- Returns `FluentCart\App\Models\Customer` - Updated customer instance
|
|
168
|
+
|
|
169
|
+
```
|
|
170
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
171
|
+
$customer->recountStats();
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### recountStat()
|
|
175
|
+
|
|
176
|
+
Recount detailed customer purchase statistics from successful payment orders only.
|
|
177
|
+
|
|
178
|
+
Totals are grouped **per currency** and only added together after each order's amount is converted at the rate frozen on that order, so a multi-currency customer's lifetime value is not a sum of mixed units:
|
|
179
|
+
|
|
180
|
+
- `purchase_value` — net paid minus refunds, kept per currency
|
|
181
|
+
- `ltv` — the same figure converted to the store's base currency
|
|
182
|
+
- `aov` — `ltv` divided by the count of orders with a trusted exchange rate, not by all orders
|
|
183
|
+
- `purchase_count`, `first_purchase_date`, `last_purchase_date`
|
|
184
|
+
|
|
185
|
+
Saves the model.
|
|
186
|
+
|
|
187
|
+
- Returns `FluentCart\App\Models\Customer` - Updated customer instance
|
|
188
|
+
|
|
189
|
+
```
|
|
190
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
191
|
+
$customer->recountStat();
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### updateCustomerStatus($newStatus)
|
|
195
|
+
|
|
196
|
+
Update customer status and fire action hooks. If the new status is the same as the current status, returns early without saving or firing hooks.
|
|
197
|
+
|
|
198
|
+
Fires the following WordPress action hooks:
|
|
199
|
+
|
|
200
|
+
- `fluent_cart/customer_status_to_{$newStatus}` - Status-specific hook
|
|
201
|
+
- `fluent_cart/customer_status_updated` - General status change hook
|
|
202
|
+
|
|
203
|
+
Both hooks receive an array with keys: `customer`, `old_status`, `new_status`.
|
|
204
|
+
|
|
205
|
+
- Parameters: `$newStatus` (String) - New status value
|
|
206
|
+
- Returns `FluentCart\App\Models\Customer` - Updated customer instance
|
|
207
|
+
|
|
208
|
+
```
|
|
209
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
210
|
+
$customer->updateCustomerStatus('active');
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### getWpUserId($recheck = false)
|
|
214
|
+
|
|
215
|
+
Returns the stored `user_id`. The `$recheck` parameter is accepted for backward compatibility and has no effect — the method performs no email lookup and never rewrites `user_id`.
|
|
216
|
+
|
|
217
|
+
- Parameters: `$recheck` (Boolean) - accepted and ignored
|
|
218
|
+
- Returns `Integer|null` - the stored WordPress user ID
|
|
219
|
+
|
|
220
|
+
```
|
|
221
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
222
|
+
$wpUserId = $customer->getWpUserId();
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### getWpUser()
|
|
226
|
+
|
|
227
|
+
Get the WordPress user by the stored `user_id`. Returns `false` when the customer has no `user_id`, i.e. when the account is unclaimed.
|
|
228
|
+
|
|
229
|
+
- Returns `WP_User|false` - WordPress user object, or `false` when unlinked
|
|
230
|
+
|
|
231
|
+
```
|
|
232
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
233
|
+
$wpUser = $customer->getWpUser();
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### getMeta($metaKey, $default = null)
|
|
237
|
+
|
|
238
|
+
Get customer meta value from the `fct_customer_meta` table.
|
|
239
|
+
|
|
240
|
+
- Parameters: `$metaKey` (String) - Meta key, `$default` (Mixed) - Default value if not found (default: null)
|
|
241
|
+
- Returns `Mixed` - Meta value or default
|
|
242
|
+
|
|
243
|
+
```
|
|
244
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
245
|
+
$metaValue = $customer->getMeta('custom_field', 'default');
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### updateMeta($metaKey, $metaValue)
|
|
249
|
+
|
|
250
|
+
Create or update customer meta value in the `fct_customer_meta` table.
|
|
251
|
+
|
|
252
|
+
- Parameters: `$metaKey` (String) - Meta key, `$metaValue` (Mixed) - Meta value
|
|
253
|
+
- Returns `FluentCart\App\Models\CustomerMeta` - Meta instance (created or updated)
|
|
254
|
+
|
|
255
|
+
```
|
|
256
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
257
|
+
$meta = $customer->updateMeta('custom_field', 'new_value');
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
## Relations
|
|
261
|
+
|
|
262
|
+
This model has the following relationships that you can use
|
|
263
|
+
|
|
264
|
+
### orders
|
|
265
|
+
|
|
266
|
+
Access the customer orders.
|
|
267
|
+
|
|
268
|
+
- Relation type: `HasMany`
|
|
269
|
+
- Returns collection of `FluentCart\App\Models\Order`
|
|
270
|
+
- Foreign key: `customer_id`
|
|
271
|
+
|
|
272
|
+
```
|
|
273
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
274
|
+
$orders = $customer->orders;
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### success_order_items
|
|
278
|
+
|
|
279
|
+
Access the successful order items (items from orders with successful payment statuses).
|
|
280
|
+
|
|
281
|
+
- Relation type: `HasManyThrough` (through `FluentCart\App\Models\Order`)
|
|
282
|
+
- Returns collection of `FluentCart\App\Models\OrderItem`
|
|
283
|
+
- Filters orders by successful payment statuses via `Status::getOrderPaymentSuccessStatuses()`
|
|
284
|
+
|
|
285
|
+
```
|
|
286
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
287
|
+
$orderItems = $customer->success_order_items;
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### subscriptions
|
|
291
|
+
|
|
292
|
+
Access the customer subscriptions.
|
|
293
|
+
|
|
294
|
+
- Relation type: `HasMany`
|
|
295
|
+
- Returns collection of `FluentCart\App\Models\Subscription`
|
|
296
|
+
- Foreign key: `customer_id`
|
|
297
|
+
|
|
298
|
+
```
|
|
299
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
300
|
+
$subscriptions = $customer->subscriptions;
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### shipping_address
|
|
304
|
+
|
|
305
|
+
Access the shipping addresses (filtered by type = 'shipping').
|
|
306
|
+
|
|
307
|
+
- Relation type: `HasMany`
|
|
308
|
+
- Returns collection of `FluentCart\App\Models\CustomerAddresses`
|
|
309
|
+
- Foreign key: `customer_id`
|
|
310
|
+
|
|
311
|
+
```
|
|
312
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
313
|
+
$addresses = $customer->shipping_address;
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### billing_address
|
|
317
|
+
|
|
318
|
+
Access the billing addresses (filtered by type = 'billing').
|
|
319
|
+
|
|
320
|
+
- Relation type: `HasMany`
|
|
321
|
+
- Returns collection of `FluentCart\App\Models\CustomerAddresses`
|
|
322
|
+
- Foreign key: `customer_id`
|
|
323
|
+
|
|
324
|
+
```
|
|
325
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
326
|
+
$addresses = $customer->billing_address;
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
### primary_shipping_address
|
|
330
|
+
|
|
331
|
+
Access the primary shipping address (filtered by type = 'shipping' and is_primary = 1).
|
|
332
|
+
|
|
333
|
+
- Relation type: `HasOne`
|
|
334
|
+
- Returns `FluentCart\App\Models\CustomerAddresses|null`
|
|
335
|
+
|
|
336
|
+
```
|
|
337
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
338
|
+
$address = $customer->primary_shipping_address;
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### primary_billing_address
|
|
342
|
+
|
|
343
|
+
Access the primary billing address (filtered by type = 'billing' and is_primary = 1).
|
|
344
|
+
|
|
345
|
+
- Relation type: `HasOne`
|
|
346
|
+
- Returns `FluentCart\App\Models\CustomerAddresses|null`
|
|
347
|
+
|
|
348
|
+
```
|
|
349
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
350
|
+
$address = $customer->primary_billing_address;
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### labels
|
|
354
|
+
|
|
355
|
+
Access the customer labels (polymorphic relationship).
|
|
356
|
+
|
|
357
|
+
- Relation type: `MorphMany`
|
|
358
|
+
- Returns collection of `FluentCart\App\Models\LabelRelationship`
|
|
359
|
+
|
|
360
|
+
```
|
|
361
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
362
|
+
$labels = $customer->labels;
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
### wpUser
|
|
366
|
+
|
|
367
|
+
Access the associated WordPress user.
|
|
368
|
+
|
|
369
|
+
- Relation type: `BelongsTo`
|
|
370
|
+
- Returns `FluentCart\App\Models\User|null`
|
|
371
|
+
- Foreign key: `user_id`
|
|
372
|
+
|
|
373
|
+
```
|
|
374
|
+
$customer = FluentCart\App\Models\Customer::find(1);
|
|
375
|
+
$user = $customer->wpUser;
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
## Scopes
|
|
379
|
+
|
|
380
|
+
### unclaimed()
|
|
381
|
+
|
|
382
|
+
Customers with no linked WordPress user — `user_id` is `NULL` or `0`. These are guest purchases that nobody has claimed by registering with the same email.
|
|
383
|
+
|
|
384
|
+
```
|
|
385
|
+
$guests = FluentCart\App\Models\Customer::unclaimed()->get();
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
This model has the following scopes that you can use
|
|
389
|
+
|
|
390
|
+
### ofActive()
|
|
391
|
+
|
|
392
|
+
Get only active customers (where status = 'active').
|
|
393
|
+
|
|
394
|
+
```
|
|
395
|
+
$customers = FluentCart\App\Models\Customer::ofActive()->get();
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
### ofArchived()
|
|
399
|
+
|
|
400
|
+
Get only archived customers (where status = 'archived').
|
|
401
|
+
|
|
402
|
+
```
|
|
403
|
+
$customers = FluentCart\App\Models\Customer::ofArchived()->get();
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
### searchBy($search)
|
|
407
|
+
|
|
408
|
+
Search customers by query string. Supports multiple search modes:
|
|
409
|
+
|
|
410
|
+
- **Operator-based search**: `column_name > value`, `column_name = value`, etc. (supports `=`, `!=`, `>`, `<`)
|
|
411
|
+
- **Column-specific LIKE search**: `column_name:value` (searches with LIKE %value%)
|
|
412
|
+
- **Column-specific exact search**: `column_name=value`
|
|
413
|
+
- **General search**: Searches across `$searchable` fields (`first_name`, `last_name`, `email`) with LIKE matching. Also handles multi-word queries by splitting into first_name/last_name search.
|
|
414
|
+
|
|
415
|
+
- Parameters: `$search` (String) - Search query
|
|
416
|
+
|
|
417
|
+
```
|
|
418
|
+
// General search across searchable fields
|
|
419
|
+
$customers = FluentCart\App\Models\Customer::searchBy('john')->get();
|
|
420
|
+
|
|
421
|
+
// Operator-based search
|
|
422
|
+
$customers = FluentCart\App\Models\Customer::searchBy('purchase_count > 5')->get();
|
|
423
|
+
|
|
424
|
+
// Column-specific LIKE search
|
|
425
|
+
$customers = FluentCart\App\Models\Customer::searchBy('email:example.com')->get();
|
|
426
|
+
|
|
427
|
+
// Full name search (splits "John Doe" into first_name + last_name)
|
|
428
|
+
$customers = FluentCart\App\Models\Customer::searchBy('John Doe')->get();
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
### applyCustomFilters($filters)
|
|
432
|
+
|
|
433
|
+
Apply custom filters using an associative array. Each filter key must be a fillable attribute. Supports operators: `includes` (LIKE), `not_includes` (NOT LIKE), `gt` (>), `lt` (
|
|
434
|
+
|
|
435
|
+
```
|
|
436
|
+
$customers = FluentCart\App\Models\Customer::searchByFullName([
|
|
437
|
+
'value' => 'John',
|
|
438
|
+
'operator' => 'starts_with'
|
|
439
|
+
])->get();
|
|
440
|
+
|
|
441
|
+
$customers = FluentCart\App\Models\Customer::searchByFullName([
|
|
442
|
+
'value' => 'Doe',
|
|
443
|
+
'operator' => 'ends_with'
|
|
444
|
+
])->get();
|
|
445
|
+
|
|
446
|
+
$customers = FluentCart\App\Models\Customer::searchByFullName([
|
|
447
|
+
'value' => 'Test User',
|
|
448
|
+
'operator' => 'not_like'
|
|
449
|
+
])->get();
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Inherited Scopes from CanSearch Trait
|
|
453
|
+
|
|
454
|
+
These scopes are available via the `CanSearch` trait:
|
|
455
|
+
|
|
456
|
+
#### search($params)
|
|
457
|
+
|
|
458
|
+
Flexible search with multiple operators per column.
|
|
459
|
+
|
|
460
|
+
```
|
|
461
|
+
$customers = FluentCart\App\Models\Customer::search([
|
|
462
|
+
'email' => ['column' => 'email', 'operator' => 'like_all', 'value' => 'example.com'],
|
|
463
|
+
'status' => ['column' => 'status', 'operator' => '=', 'value' => 'active']
|
|
464
|
+
])->get();
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
#### whereLike($column, $value)
|
|
468
|
+
|
|
469
|
+
WHERE column LIKE %value% query.
|
|
470
|
+
|
|
471
|
+
```
|
|
472
|
+
$customers = FluentCart\App\Models\Customer::whereLike('email', 'example.com')->get();
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
#### whereBeginsWith($column, $value)
|
|
476
|
+
|
|
477
|
+
WHERE column LIKE value% query.
|
|
478
|
+
|
|
479
|
+
```
|
|
480
|
+
$customers = FluentCart\App\Models\Customer::whereBeginsWith('first_name', 'Jo')->get();
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
#### whereEndsWith($column, $value)
|
|
484
|
+
|
|
485
|
+
WHERE column LIKE %value query.
|
|
486
|
+
|
|
487
|
+
```
|
|
488
|
+
$customers = FluentCart\App\Models\Customer::whereEndsWith('email', '.com')->get();
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
#### groupSearch($groups)
|
|
492
|
+
|
|
493
|
+
Search across related models using dot notation.
|
|
494
|
+
|
|
495
|
+
```
|
|
496
|
+
$customers = FluentCart\App\Models\Customer::groupSearch([
|
|
497
|
+
'fct_customers.email' => ['column' => 'email', 'operator' => 'like_all', 'value' => 'test'],
|
|
498
|
+
])->get();
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Inherited Scope from CanUpdateBatch Trait
|
|
502
|
+
|
|
503
|
+
#### batchUpdate($values, $index = null)
|
|
504
|
+
|
|
505
|
+
Batch update multiple records at once.
|
|
506
|
+
|
|
507
|
+
```
|
|
508
|
+
FluentCart\App\Models\Customer::batchUpdate([
|
|
509
|
+
['id' => 1, 'status' => 'active'],
|
|
510
|
+
['id' => 2, 'status' => 'archived'],
|
|
511
|
+
]);
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
## Usage Examples
|
|
515
|
+
|
|
516
|
+
### Creating a Customer
|
|
517
|
+
|
|
518
|
+
```
|
|
519
|
+
use FluentCart\App\Models\Customer;
|
|
520
|
+
|
|
521
|
+
// uuid is auto-generated on creation
|
|
522
|
+
$customer = Customer::create([
|
|
523
|
+
'email' => '[email protected]',
|
|
524
|
+
'first_name' => 'John',
|
|
525
|
+
'last_name' => 'Doe',
|
|
526
|
+
'status' => 'active'
|
|
527
|
+
]);
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
### Retrieving Customers
|
|
531
|
+
|
|
532
|
+
```
|
|
533
|
+
// Get all active customers
|
|
534
|
+
$customers = Customer::ofActive()->get();
|
|
535
|
+
|
|
536
|
+
// Get customer by email
|
|
537
|
+
$customer = Customer::where('email', '[email protected]')->first();
|
|
538
|
+
|
|
539
|
+
// Get customer with orders
|
|
540
|
+
$customer = Customer::with('orders')->find(1);
|
|
541
|
+
|
|
542
|
+
// Search customers
|
|
543
|
+
$customers = Customer::searchBy('john doe')->get();
|
|
544
|
+
|
|
545
|
+
// Get customers with custom filters
|
|
546
|
+
$customers = Customer::applyCustomFilters([
|
|
547
|
+
'country' => ['value' => 'US', 'operator' => '=']
|
|
548
|
+
])->get();
|
|
549
|
+
```
|
|
550
|
+
|
|
551
|
+
### Updating a Customer
|
|
552
|
+
|
|
553
|
+
```
|
|
554
|
+
$customer = Customer::find(1);
|
|
555
|
+
$customer->first_name = 'Jane';
|
|
556
|
+
$customer->save();
|
|
557
|
+
|
|
558
|
+
// Update status with hooks
|
|
559
|
+
$customer->updateCustomerStatus('archived');
|
|
560
|
+
|
|
561
|
+
// Recount purchase statistics
|
|
562
|
+
$customer->recountStat();
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
### Working with Meta
|
|
566
|
+
|
|
567
|
+
```
|
|
568
|
+
$customer = Customer::find(1);
|
|
569
|
+
|
|
570
|
+
// Get meta
|
|
571
|
+
$value = $customer->getMeta('preferred_language', 'en');
|
|
572
|
+
|
|
573
|
+
// Set/update meta
|
|
574
|
+
$customer->updateMeta('preferred_language', 'fr');
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
### Deleting a Customer
|
|
578
|
+
|
|
579
|
+
```
|
|
580
|
+
$customer = Customer::find(1);
|
|
581
|
+
$customer->delete();
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
---
|