Download the PHP package chkltlabs/wix-client without Composer
On this page you can find all versions of the php package chkltlabs/wix-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download chkltlabs/wix-client
More information about chkltlabs/wix-client
Files in chkltlabs/wix-client
Package wix-client
Short Description A fluent interface for the Wix API
License MIT
Informations about the package wix-client
Chkltlabs Wix Client
PHP implementation of Wix API as an SDK.
Installation
Requires PHP 8.2+.
Upgrading to 1.0
Version 1.0 drops support for nimbly/shuttle 0.x, psr/http-message 1.x, and PHP versions below 8.2 to align with Laravel 13.
If you inject a custom HTTP client, no code changes are required. If you reference Shuttle or Capsule classes directly, update imports:
Shuttle\Shuttle→Nimbly\Shuttle\ShuttleShuttle\Handler\MockHandler→Nimbly\Shuttle\Handler\MockHandlerCapsule\Request→Nimbly\Capsule\RequestCapsule\Response→Nimbly\Capsule\Response
Shuttle 2.x no longer accepts a configuration array in its constructor; pass dependencies as named constructor arguments instead.
Continuous Integration
GitHub Actions runs the full PHPUnit suite on PHP 8.2, 8.3, and 8.4. PHP 8.2 also runs with --prefer-lowest to verify compatibility with minimum allowed dependency versions.
Local Testing with Docker
To run tests with pinned versions (without relying on host PHP/composer), use Docker:
To stop the container:
Usage
The use of this package is intentionally extremely basic, methods have no required inputs except where required by the underlying Wix API. Please see Wix API Docs for more information.
This package has only been tested using API Keys. Please see the Roadmap below for planned features.
To begin, instantiate the Wix class. Depending on the endpoints you plan to access, you may set one of account_id/site_id as a blank string (but not both).
Now you have a class-based accessor to various api resources. These resources are treated as properties on the Wix class, or as properties of those properties:
This structure aims to replicate the Wix API Docs as closely as possible.
For endpoints that do not yet have dedicated resource methods, use explicit domain resources:
Regenerate typed domain operation methods from Wix public docs:
Typed Resource Coverage Snapshot
Generated from public docs currently available in wix-incubator/wix-rest-docs:
Api: 0Apps: 5Automations: 1B2BSiteManagement: 0Bookings: 118Chat: 1CurrencyConverter: 2DomainConnect: 0DomainSearch: 1Ecom: 24EmailMarketing: 20Events: 63EventsGuests: 0EventsPolicies: 5Faq: 11Forum: 5LocalDelivery: 7Locations: 6LoyaltyAccounts: 8LoyaltyPrograms: 2LoyaltyRewards: 4Marketing: 2MarketingConsent: 8Members: 27Notifications: 0Oauth: 0OauthApp: 5Payments: 8Pricing: 0PricingPlans: 35Progallery: 9PromoteSeoTxtFileServer: 2RedirectSession: 1Resellers: 8Restaurants: 36SiteActions: 0SiteFolders: 6SiteList: 1SiteMedia: 24SiteProperties: 9SocialGroups: 24Stores: 82V1: 1WixData: 44
Explicit Resource Status
All top-level domain resources in src/Resources are now explicit custom classes extending AbstractResource (no remaining top-level Domain subclasses).
Roadmap
Implemented
- Blog
-
- Categories
- Drafts
- Posts
- Tags
- Business
-
- Location
- Properties
- Comments
- Contacts
-
- Bulk
- ExtendedFields
- Facets
- Labels
- Coupons
-
- Bulk
- Inbox
-
- Conversations
- Messages
Upcoming
- Marketing
- Media
- Members
- Site Content
- Automations
- Bookings
- Chat
- Data
- Events
- Forms
- Forum
- Groups
- Notifications
- Class method -> Route Documentation
Not Planned
- Cashier
- eCommerce
- Loyalty Program
- Payments
- Pricing Plans
- Restaurants
- Stores
- Payment Provider SPI
- Account Management
Contributing
The Package uses a unified request system built on AbstractResource, so contributing new endpoints is as simple as creating a new class in src/Resources, and creating further subclasses is as simple as creating a new directory that matches your class name, and adding the HasCachedResources trait to your parent class. Make sure each extends AbstractResource.
Example from Blog.php:
Credit && Thanks
This package is heavily inspired and influenced by the excellent (TomorrowIdeas/Plaid)[https://github.com/TomorrowIdeas/plaid-sdk-php] SDK implementation. Go show them some love!
All versions of wix-client with dependencies
nimbly/capsule Version ^3.0
nimbly/shuttle Version ^2.0
psr/http-client Version ^1.0
psr/http-message Version ^2.0