WellnessLiving SDK

https://github.com/wellnessliving/wl-sdk
Admin
WellnessLiving SDK is a PHP library that enables developers to integrate with the WellnessLiving...
Tokens:73,602
Snippets:515
Trust Score:6.5
Update:1 day ago
Show doc for...
Tokens:
Raw
### Quick Start: Sign-in and Report

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/README.md

Example demonstrating how to configure the SDK, sign in, and fetch a report.

```APIDOC
## Quick Start: Sign-in and Report

### Description
This example shows the basic usage of the WellnessLiving SDK: loading the autoloader, creating a configuration, signing in with credentials, and fetching a report.

### Prerequisites
- PHP >= 5.5
- Required extensions: bcmath, curl, json
- Autoloader: `WellnessLiving/wl-autoloader.php`
- Configuration class extending `WellnessLiving\Config\WlConfigDeveloper` or `WlConfigProduction`

### Code Example
```php
require_once __DIR__.'/WellnessLiving/wl-autoloader.php';
require_once __DIR__.'/example-config.php';

use WellnessLiving\Core\Passport\Login\Enter\EnterModel;
use WellnessLiving\Core\Passport\Login\Enter\NotepadModel;
use WellnessLiving\Wl\Report\DataModel;
use WellnessLiving\WlAssertException;
use WellnessLiving\WlUserException;

try {
  $o_config = ExampleConfig::create(WlRegionSid::US_EAST_1);

  $o_notepad = new NotepadModel($o_config);
  $o_notepad->get();

  $o_enter = new EnterModel($o_config);
  $o_enter->cookieSet($o_notepad->cookieGet());
  $o_enter->s_login = 'demo';
  $o_enter->s_notepad = $o_notepad->s_notepad;
  $o_enter->s_password = $o_notepad->hash('secret');
  $o_enter->post();

  $o_report = new DataModel($o_config);
  $o_report->cookieSet($o_notepad->cookieGet());
  $o_report->k_business = '123';
  $o_report->get();
} catch (WlAssertException $e) {
  echo $e;
} catch (WlUserException $e) {
  echo $e->getMessage();
  if ($e->request()) echo $e->request()->httpProtocol();
}
```

### Notes
- The `NotepadModel` is used to obtain a notepad and session cookie.
- The `EnterModel` performs the sign-in using the notepad and credentials.
- The `DataModel` fetches a report for a specific business.
- Exceptions `WlAssertException` and `WlUserException` are caught for error handling.
```

--------------------------------

### LoginModel usage example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-models.md

PHP example showing how to instantiate LoginModel, set the cookie, specify user ID and business key, perform a GET request, and output the user's first and last name. Requires a valid configuration and cookie.

```php
use WellnessLiving\Wl\Login\LoginModel;

$o_login = new LoginModel($o_config);
$o_login->cookieSet($o_cookie);
$o_login->uid = 'uid-42';
$o_login->k_business = '123';
$o_login->get();
echo $o_login->s_first_name . ' ' . $o_login->s_last_name;
```

--------------------------------

### Usage example for WlModelMultiModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-multi-model.md

Complete example showing how to create a multi-model, add two models, execute a GET request, and handle exceptions. Demonstrates setting model properties and using cookieSet.

```php
use WellnessLiving\Wl\Catalog\CatalogList\ElementModel;
use WellnessLiving\WlModelMultiModel;
use WellnessLiving\WlUserException;

$o_multi = new WlModelMultiModel($o_config);

$model_1 = new ElementModel($o_config);
$model_1->cookieSet($o_notepad->cookieGet());
$model_1->k_id = '100';
$model_1->k_location = 'loc-1';
$model_1->id_sale = 7;

$model_2 = new ElementModel($o_config);
$model_2->cookieSet($o_notepad->cookieGet());
$model_2->k_id = '200';
$model_2->k_location = 'loc-2';
$model_2->id_sale = 7;

$o_multi->add($model_1);
$o_multi->add($model_2);

try {
  $o_multi->getMulti();
  print_r($model_1->a_data);
  print_r($model_2->a_data);
} catch (WlUserException $e) {
  echo $e->getMessage();
  echo $e->request()->httpProtocol(); // identify which request failed
}
```

--------------------------------

### Usage of ExampleEdgeModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-edge-abstract.md

Instantiates the example model, sets k_id, calls get() to perform a GET request to the edge URL, and prints the HTTP protocol. The comment shows the resulting URL.

```php
$o_edge = new ExampleEdgeModel($o_config);
$o_edge->k_id = 'abc';
$o_request = $o_edge->get();           // GET https://edge.sandbox.wellnessliving.com/12345/abc.json
echo $o_request->httpProtocol();
```

--------------------------------

### create() usage example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/config.md

Example of creating a config instance for the US_EAST_1 region.

```php
$o_config = ExampleConfig::create(WlRegionSid::US_EAST_1);
```

--------------------------------

### Run Example Script

Source: https://github.com/wellnessliving/wl-sdk/blob/master/README.md

After configuring example-config.php and example-sdk.php, run this command to execute the example script.

```shell
php example-sdk.php
```

--------------------------------

### Quick pattern: sign in and fetch report with WellnessLiving SDK

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/README.md

Shows the minimal setup to authenticate and retrieve a report. Requires the autoloader and example-config.php. Uses NotepadModel to get a notepad, EnterModel to sign in with a hashed password, and DataModel to fetch a report. Catches WlAssertException and WlUserException, printing the request protocol on user errors.

```php
require_once __DIR__.'/WellnessLiving/wl-autoloader.php';
require_once __DIR__.'/example-config.php';

use WellnessLiving\Core\Passport\Login\Enter\EnterModel;
use WellnessLiving\Core\Passport\Login\Enter\NotepadModel;
use WellnessLiving\Wl\Report\DataModel;
use WellnessLiving\WlAssertException;
use WellnessLiving\WlUserException;

try {
  $o_config = ExampleConfig::create(WlRegionSid::US_EAST_1);

  $o_notepad = new NotepadModel($o_config);
  $o_notepad->get();

  $o_enter = new EnterModel($o_config);
  $o_enter->cookieSet($o_notepad->cookieGet());
  $o_enter->s_login = 'demo';
  $o_enter->s_notepad = $o_notepad->s_notepad;
  $o_enter->s_password = $o_notepad->hash('secret');
  $o_enter->post();

  $o_report = new DataModel($o_config);
  $o_report->cookieSet($o_notepad->cookieGet());
  $o_report->k_business = '123';
  $o_report->get();
} catch (WlAssertException $e) {
  echo $e;
} catch (WlUserException $e) {
  echo $e->getMessage();
  if ($e->request()) echo $e->request()->httpProtocol();
}
```

--------------------------------

### Usage example for WlTool methods

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-tool.md

Shows how to use getAllHeaders(), dateNowMysql(), and dateMysqlHttp() together. Checks for a 'Date' header, gets the current MySQL datetime, and converts it to an HTTP date.

```php
use WellnessLiving\WlTool;

$a_header = WlTool::getAllHeaders();
if (isset($a_header['Date'])) {
  echo $a_header['Date'];
}

$dt_now = WlTool::dateNowMysql();   // '2025-01-27 08:00:00'
echo WlTool::dateMysqlHttp($dt_now);
```

--------------------------------

### GET Core/Request/Example.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/request-infrastructure.md

Example endpoint designed to debug API issues. It accepts an example argument and returns an example result along with a log record key.

```APIDOC
## GET Core/Request/Example.json

### Description
Example endpoint designed to debug API issues.

### Method
GET

### Endpoint
Core/Request/Example.json

### Parameters
#### Query Parameters
- **i_argument** (int) - Required - Example argument.

### Request Example
```php
$o_example = new ExampleModel($o_config);
$o_example->i_argument = 42;
$o_example->get();
echo $o_example->i_result . ' ' . $o_example->s_log;
```

### Response
#### Success Response (200)
- **i_result** (int) - Example result.
- **s_log** (string) - Key of the log record written by the API controller.

#### Response Example
```json
{
  "i_result": 0,
  "s_log": "string"
}
```
```

--------------------------------

### PHP usage example with error handling

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-abstract.md

PHP example showing how to create an EnterModel, set login credentials, call post(), and handle WlUserException and WlAssertException. Includes use of ExampleConfig and WlRegionSid::US_EAST_1.

```php
use WellnessLiving\Core\Passport\Login\Enter\EnterModel;
use WellnessLiving\WlAssertException;
use WellnessLiving\WlUserException;

$o_config = ExampleConfig::create(WlRegionSid::US_EAST_1);
$o_enter = new EnterModel($o_config);
$o_enter->s_login = 'demo';
$o_enter->s_password = $o_notepad->hash('secret');

try {
  $o_enter->post();
} catch (WlUserException $e) {
  echo $e->getMessage();
  echo $e->sid();          // server error code of the first error
  if ($e->request()) {
    echo $e->request()->httpProtocol(); // full HTTP exchange for debugging
  }
} catch (WlAssertException $e) {
  echo $e;                 // programmatic error — fix the client code
}
```

--------------------------------

### Install SDK with Composer

Source: https://github.com/wellnessliving/wl-sdk/blob/master/README.md

Use this bash one-liner to install the WellnessLiving SDK via Composer. It creates a composer.json if missing, adds the repository, requires the SDK version >=1.0.0, and runs composer install.

```shell
([ ! -f composer.json ] && echo '{"name":"sdk/project"}' > composer.json); composer config repositories.wellnessliving/wl-sdk git https://github.com/wellnessliving/wl-sdk && composer require 'wellnessliving/wl-sdk:>=1.0.0' && composer install
```

--------------------------------

### Usage example for Sha3::hash()

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/sha3.md

Shows how to use Sha3::hash() to get hex or binary digest. The first call returns lowercase hex, the second returns raw binary.

```php
use WellnessLiving\Sha3;

$s_hash = Sha3::hash('hello', 512, false); // hex digest
$s_raw  = Sha3::hash('hello', 512, true);  // binary digest
```

--------------------------------

### Usage example for WlWebhook

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-webhook.md

Example from example-webhook.php: creates WlWebhook, checks authorization, logs diagnostic on failure, and outputs variables.

```php
use WellnessLiving\WlWebhook;

$o_webhook = new WlWebhook($o_config);

if (!$o_webhook->isAuthorize()) {
  error_log(var_export($o_webhook->a_diagnostic, true)); // log only, never display
  http_response_code(403);
  exit;
}

$a_variable = $o_webhook->variable();
echo var_export($a_variable, true);
```

--------------------------------

### WlWebhook Error-Handling Example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-webhook.md

Example showing how to handle authorization failure and log diagnostic information.

```APIDOC
## WlWebhook Error-Handling Example

### Description
Demonstrates error handling when the webhook is not authorized, including logging diagnostic information.

### Code
```php
$o_webhook = new WlWebhook($o_config);
if ($o_webhook->isAuthorize()) {
  echo "Webhook is authorized." . PHP_EOL;
} else {
  echo "ERROR: Webhook is not authorized." . PHP_EOL;
  echo var_export($o_webhook->a_diagnostic, true) . PHP_EOL; // diagnostic info for logging
  return;
}

$a_variable = $o_webhook->variable();
echo "The request variables: " . PHP_EOL;
echo var_export($a_variable, true);
```
```

--------------------------------

### dateMysqlHttp() usage example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-tool.md

Example call to dateMysqlHttp() with a sample date and the expected output format.

```php
WlTool::dateMysqlHttp('2025-01-27 11:23:28');
// e.g. 'Mon, 27 Jan 2025 11:23:28 GMT'
```

--------------------------------

### NotepadModel Usage Example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/authentication.md

Example of retrieving a notepad and hashing a password. The hash result should be assigned to EnterModel::s_password.

```php
$o_notepad = new NotepadModel($o_config);
$o_notepad->s_login = 'demo';
$o_notepad->get();
$s_hash = $o_notepad->hash('user-password'); // assign to EnterModel::s_password
```

--------------------------------

### Error-handling example for WlWebhook

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-webhook.md

Mirrors example-webhook.php: prints authorization status, logs diagnostic on failure, and outputs variables.

```php
$o_webhook = new WlWebhook($o_config);
if ($o_webhook->isAuthorize()) {
  echo "Webhook is authorized." . PHP_EOL;
} else {
  echo "ERROR: Webhook is not authorized." . PHP_EOL;
  echo var_export($o_webhook->a_diagnostic, true) . PHP_EOL; // diagnostic info for logging
  return;
}

$a_variable = $o_webhook->variable();
echo "The request variables: " . PHP_EOL;
echo var_export($a_variable, true);
```

--------------------------------

### httpProtocol() usage example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-request.md

Example call to httpProtocol() on the last request, used for debugging output.

```php
echo $o_enter->lastRequest()->httpProtocol();
```

--------------------------------

### Instantiate a model with configuration

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-abstract.md

Creates a new EnterModel instance using a configuration object. This is a basic usage example for constructing any model.

```php
$o_model = new EnterModel($o_config);
```

--------------------------------

### WlWebhook Usage Example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-webhook.md

Example usage of the WlWebhook class to authorize an incoming webhook and retrieve request variables.

```APIDOC
## WlWebhook Usage Example

### Description
Demonstrates how to use WlWebhook to authorize an incoming webhook and access its variables.

### Code
```php
use WellnessLiving\WlWebhook;

$o_webhook = new WlWebhook($o_config);

if (!$o_webhook->isAuthorize()) {
  error_log(var_export($o_webhook->a_diagnostic, true)); // log only, never display
  http_response_code(403);
  exit;
}

$a_variable = $o_webhook->variable();
echo var_export($a_variable, true);
```
```

--------------------------------

### WlFile Usage Example

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-file.md

Shows how to use WlFile with a model that supports file uploads, including error handling.

```APIDOC
## WlFile Usage Example

### Description
Demonstrates how to assign a WlFile instance to a model field and perform an upload.

### Usage Example
```php
use WellnessLiving\Core\Drive\ImageUpload\ImageUploadTemporaryModel;
use WellnessLiving\WlFile;

$o_upload = new ImageUploadTemporaryModel($o_config);
$o_upload->cookieSet($o_cookie);
$o_upload->s_class = 'PassportLoginImage';
$o_upload->k_id = 'uid-123';
$o_upload->f_image = new WlFile('/tmp/photo.jpg', 'image/jpeg', 'photo.jpg');

try {
  $o_upload->post();
  echo $o_upload->url_view;        // URL of the uploaded original
  echo $o_upload->url_thumbnail;   // URL of the resized thumbnail
} catch (\WellnessLiving\WlUserException $e) {
  echo $e->getMessage();
}
```

### Error Handling
WlFile itself never throws. Errors surface during the request — typically `WlUserException` from `requestResult()` (e.g. `request-connect`, `request-error`) or a server-side error whose `a_error[0].sid` is exposed via `$e->sid()`.
```

--------------------------------

### DataModel usage example with filterSet()

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/report-models.md

Example of using DataModel to fetch a report. Sets report group, report ID, business key, and filters, then retrieves data and iterates over rows. Catches WlUserException and prints the error message and HTTP protocol.

```php
use WellnessLiving\Wl\Report\DataModel;
use WellnessLiving\Wl\Report\WlReportGroupSid;
use WellnessLiving\Wl\Report\WlReportSid;

$o_report = new DataModel($o_config);
$o_report->cookieSet($o_cookie);
$o_report->id_report_group = WlReportGroupSid::DAY;
$o_report->id_report = WlReportSid::PURCHASE_ITEM_ACCRUAL_CASH;
$o_report->k_business = '123';
$o_report->filterSet(['dt_date' => '2018-08-21']);

try {
  $o_report->get();
  foreach ($o_report->a_data['a_row'] as $a_row) {
    echo $a_row['dt_date'] . ' ' . $a_row['m_paid']['m_amount'] . PHP_EOL;
  }
} catch (\WellnessLiving\WlUserException $e) {
  echo $e->getMessage();
  echo $e->request()->httpProtocol();
}
```

--------------------------------

### Create configuration object with region

Source: https://github.com/wellnessliving/wl-sdk/blob/master/WellnessLiving/doc/upgrade-20211109.md

Example of creating a configuration object using the `create()` method with the `US_EAST_1` region constant. This replaces manual creation with `new`.

```php
<?php
...
$o_config = \WlSdkExample\ExampleConfig::create(\WellnessLiving\WlRegionSid::US_EAST_1);
```

--------------------------------

### delete(), get(), post(), put() method signatures

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-abstract.md

Each method performs a request with the corresponding HTTP method and returns WlModelRequest. Throws WlAssertException and WlUserException.

```php
public function delete()
public function get()
public function post()
public function put()
```

--------------------------------

### GET Wl/Business/Select/BusinessSelect.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-models.md

Returns business selection configuration for a user. The request includes business and user keys, and the response contains the selection configuration and result.

```APIDOC
## GET Wl/Business/Select/BusinessSelect.json

### Description
Returns business selection config for a user.

### Method
GET

### Endpoint
Wl/Business/Select/BusinessSelect.json

### Parameters
#### Query Parameters
- **k_business** (string) - Required - Business key.
- **uid** (string) - Required - User key.

### Response
#### Success Response (200)
- **a_config** (array) - Selection configuration.
- **a_select** (array) - Result of the selection.

#### Response Example
{
  "a_config": [],
  "a_select": []
}
```

--------------------------------

### Fetch catalog element with ElementModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-models.md

Creates an ElementModel, sets required fields (id_sale, k_id, k_location), calls get(), and prints the title and price. Requires a config and cookie.

```php
use WellnessLiving\Wl\Catalog\CatalogList\ElementModel;
use WellnessLiving\Wl\WlSaleSid;

$o_element = new ElementModel($o_config);
$o_element->cookieSet($o_cookie);
$o_element->id_sale = WlSaleSid::COUPON;
$o_element->k_id = '100';
$o_element->k_location = 'loc-1';
$o_element->get();
echo $o_element->text_title . ': ' . $o_element->text_price;
```

--------------------------------

### delete(), get(), post(), put()

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-abstract.md

Performs an HTTP request with the corresponding method and returns a WlModelRequest object. Throws WlAssertException and WlUserException.

```APIDOC
## delete(), get(), post(), put()

### Description
Performs an HTTP request with the corresponding HTTP method and returns a `WlModelRequest` object containing the complete request data. The HTTP method must be supported by the model's field annotations.

### Methods
- `delete()`
- `get()`
- `post()`
- `put()`

### Signatures
```php
public function delete()
public function get()
public function post()
public function put()
```

### Returns
- `WlModelRequest` - The request object with complete request data.

### Throws
- `WlAssertException` - Client-side assertion.
- `WlUserException` - Server-reported or transport error.

### Example
```php
$o_enter = new EnterModel($o_config);
$o_enter->s_login = 'login';
$o_enter->s_notepad = $o_notepad->s_notepad;
$o_enter->s_password = $o_notepad->hash('password');
$o_request = $o_enter->post();
echo $o_request->httpProtocol();
```
```

--------------------------------

### Example Edge model subclass

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-edge-abstract.md

Shows a subclass of WlEdgeAbstract with a CID of 12345 and a @get get field k_id. This model reads a public catalog entry cached at the edge.

```php
class ExampleEdgeModel extends WlEdgeAbstract
{
  const CID = 12345;

  /**
   * @get get
   * @var string
   */
  public $k_id = '';
}
```

--------------------------------

### Use ExampleConfig with a model and handle exceptions

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/config.md

Creates a config for the US East 1 region, instantiates a model with it, and calls get(). Catches WlAssertException for configuration or usage errors and WlUserException for user errors, printing the message in each case.

```php
use WlSdkExample\ExampleConfig;
use WellnessLiving\Wl\WlRegionSid;

try {
  $o_config = ExampleConfig::create(WlRegionSid::US_EAST_1);
  $o_model = new SomeModel($o_config);
  $o_model->get();
} catch (\WellnessLiving\WlAssertException $e) {
  echo $e->getMessage(); // configuration or usage error
} catch (\WellnessLiving\WlUserException $e) {
  echo $e->getMessage();
}
```

--------------------------------

### Check report access with AccessModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/report-models.md

PHP example using AccessModel to check if the current user has access to a report. Sets the report ID to WlReportSid::LOGIN_LIST and business key to '123', then calls get() and checks the has_access property.

```php
$o_access = new AccessModel($o_config);
$o_access->cookieSet($o_cookie);
$o_access->id_report = WlReportSid::LOGIN_LIST;
$o_access->k_business = '123';
$o_access->get();
if ($o_access->has_access) { /* ... */ }
```

--------------------------------

### Complete Sign-in Flow with Notepad and Enter Models

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/authentication.md

Performs a full sign-in: retrieves a notepad, creates an enter model, sets the login, notepad, and hashed password, then posts. Catches WlAssertException and WlUserException, printing error details.

```php
use WellnessLiving\Core\Passport\Login\Enter\EnterModel;
use WellnessLiving\Core\Passport\Login\Enter\NotepadModel;
use WellnessLiving\WlAssertException;
use WellnessLiving\WlUserException;

try {
  $o_notepad = new NotepadModel($o_config);
  $o_notepad->get();

  $o_enter = new EnterModel($o_config);
  $o_enter->cookieSet($o_notepad->cookieGet());
  $o_enter->s_login = 'login';
  $o_enter->s_notepad = $o_notepad->s_notepad;
  $o_enter->s_password = $o_notepad->hash('password');
  $o_enter->post();
} catch (WlAssertException $e) {
  echo $e;
} catch (WlUserException $e) {
  echo $e->getMessage();
  if ($e->request()) {
    echo $e->request()->httpProtocol();
  }
}
```

--------------------------------

### How to catch API errors with WlUserException

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/exceptions.md

Example of catching WlUserException when calling a model's get() method. Shows how to access the user-friendly message, the string error code (e.g., 'login-incorrect'), and the full HTTP exchange via the request object.

```php
use WellnessLiving\WlUserException;

try {
  $o_model->get();
} catch (WlUserException $e) {
  echo $e->getMessage();      // user-friendly message from the server
  echo $e->sid();             // string error code, e.g. 'login-incorrect'
  if ($e->request()) {
    echo $e->request()->httpProtocol(); // full HTTP exchange
  }
}
```

--------------------------------

### Usage example: uploading an image with WlFile

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-file.md

Shows how to create an ImageUploadTemporaryModel, set required fields, assign a WlFile to the f_image field, and call post(). On success, prints the original and thumbnail URLs. On failure, catches WlUserException and prints the error message.

```php
use WellnessLiving\Core\Drive\ImageUpload\ImageUploadTemporaryModel;
use WellnessLiving\WlFile;

$o_upload = new ImageUploadTemporaryModel($o_config);
$o_upload->cookieSet($o_cookie);
$o_upload->s_class = 'PassportLoginImage';
$o_upload->k_id = 'uid-123';
$o_upload->f_image = new WlFile('/tmp/photo.jpg', 'image/jpeg', 'photo.jpg');

try {
  $o_upload->post();
  echo $o_upload->url_view;        // URL of the uploaded original
  echo $o_upload->url_thumbnail;   // URL of the resized thumbnail
} catch (\WellnessLiving\WlUserException $e) {
  echo $e->getMessage();
}
```

--------------------------------

### GET Core/Geo/Region/Region.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/request-infrastructure.md

Gets regions (state/province/territory) for a country or all countries. Returns regions grouped by country.

```APIDOC
## GET Core/Geo/Region/Region.json

### Description
Gets regions (state/province/territory) for a country or all countries. Returns regions grouped by country.

### Method
GET

### Endpoint
Core/Geo/Region/Region.json

### Parameters
#### Query Parameters
- **id_locale** (int) - Required - Locale ID (`LocaleSid`) to find regions for.
- **is_locale_all** (bool) - Required - `true` to get regions for all locales.

### Response
#### Success Response (200)
- **a_region** (array[]) - Regions grouped by country; each country has `k_geo_country`, `s_title` and `a_region` (list of `{k_geo, s_title}`).

#### Response Example
{
  "a_region": [
    {
      "k_geo_country": 1,
      "s_title": "Country",
      "a_region": [
        {
          "k_geo": 1,
          "s_title": "Region"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET Core/Passport/Login/Info.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/authentication.md

Gets the current user's key and password-reset/registration URLs. Returns null for uid if not signed in.

```APIDOC
## GET Core/Passport/Login/Info.json

### Description
Gets the current user's key and password-reset/registration URLs. Returns null for uid if not signed in.

### Method
GET

### Endpoint
Core/Passport/Login/Info.json

### Response
#### Success Response (200)
- **uid** (string|null) - Current user key; `null` if not signed in.
- **url_password_change** (string) - Password reset URL.
- **url_register** (string) - Registration page URL.

#### Response Example
```json
{
  "uid": "user123",
  "url_password_change": "https://example.com/password-reset",
  "url_register": "https://example.com/register"
}
```
```

--------------------------------

### Sign in with EnterModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/authentication.md

Creates an EnterModel instance, preserves the session cookie, sets login credentials, hashes the password using NotepadModel::hash(), and posts the request to sign in.

```php
$o_enter = new EnterModel($o_config);
$o_enter->cookieSet($o_notepad->cookieGet()); // keep the session
$o_enter->s_login = 'demo';
$o_enter->s_notepad = $o_notepad->s_notepad;
$o_enter->s_password = $o_notepad->hash('secret');
$o_enter->post();
```

--------------------------------

### GET Wl/Report/Data.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/report-models.md

Returns the contents of a single report. Use the DataModel class to set parameters and call get().

```APIDOC
## GET Wl/Report/Data.json

### Description
Returns the contents of a single report. The report is identified by its ID and business key, with optional filters, sorting, and pagination.

### Method
GET

### Endpoint
Wl/Report/Data.json

### Parameters
#### Query Parameters
- **i_page** (int) - Required - Page of results, starting at 0. The API returns 256 results per page.
- **id_report** (int) - Required - Report ID, one of `WlReportSid` constants.
- **id_report_group** (int) - Required - Report group ID, one of `WlReportGroupSid` constants (day/week/month/year).
- **id_report_page** (int|null) - Optional - Report page ID, one of `WlReportPageSid`; if set, the page collection is used.
- **id_report_view** (int) - Required - Report view ID, one of `WlReportChartViewSid`.
- **k_business** (string) - Required - Key of the business for which the report is generated.
- **s_filter** (string) - Optional - Filter settings in `UrlEncode` encoded format (set via `filterSet()`).
- **s_sort** (string) - Optional - Field to sort report data by.

### Response
#### Success Response (200)
- **a_data** (array) - Report contents; structure varies by report (e.g. `a_data['a_row']` in the example).

#### Response Example
```json
{
  "a_data": {
    "a_row": [
      {
        "dt_date": "2018-08-21",
        "m_paid": {
          "m_amount": "100.00"
        }
      }
    ]
  }
}
```

### Usage Example (PHP)
```php
use WellnessLiving\Wl\Report\DataModel;
use WellnessLiving\Wl\Report\WlReportGroupSid;
use WellnessLiving\Wl\Report\WlReportSid;

$o_report = new DataModel($o_config);
$o_report->cookieSet($o_cookie);
$o_report->id_report_group = WlReportGroupSid::DAY;
$o_report->id_report = WlReportSid::PURCHASE_ITEM_ACCRUAL_CASH;
$o_report->k_business = '123';
$o_report->filterSet(['dt_date' => '2018-08-21']);

try {
  $o_report->get();
  foreach ($o_report->a_data['a_row'] as $a_row) {
    echo $a_row['dt_date'] . ' ' . $a_row['m_paid']['m_amount'] . PHP_EOL;
  }
} catch (\WellnessLiving\WlUserException $e) {
  echo $e->getMessage();
  echo $e->request()->httpProtocol();
}
```
```

--------------------------------

### WlFile Constructor

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-file.md

Creates a new WlFile instance with the local file path, optional MIME type, and optional post name.

```APIDOC
## WlFile Constructor

### Description
Creates a new WlFile instance that wraps a local file path for upload.

### Method
Constructor

### Signature
`public function __construct($s_name, $s_mime = null, $s_postname = null)`

### Parameters
- **$s_name** (string) - Required - Path to the file to upload.
- **$s_mime** (string|null) - Optional - MIME type of the file; null if not set.
- **$s_postname** (string|null) - Optional - Name of the file as it will appear in the upload; null if not set.

### Usage Example
```php
$o_file = new WlFile('/tmp/photo.jpg', 'image/jpeg', 'photo.jpg');
```
```

--------------------------------

### Constructor

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-abstract.md

Creates a new model instance with the given configuration object. Throws WlAssertException if resource() validation fails.

```APIDOC
## Constructor

### Description
Creates a new model instance with the given configuration object.

### Method
`__construct`

### Signature
```php
public function __construct(WlConfigAbstract $o_config)
```

### Parameters
- `$o_config` (WlConfigAbstract) - Required - WellnessLiving SDK configuration object.

### Throws
- `WlAssertException` if `resource()` validation fails for the concrete class (e.g. class name does not end with `Model`).

### Example
```php
$o_model = new EnterModel($o_config);
```
```

--------------------------------

### GET Core/Request/Api/KeySecret.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/request-infrastructure.md

Gets a secret key for request signing, required for CORS requests. Must be signed as an ordinary SDK request (transient + persistent cookies), never from a browser.

```APIDOC
## GET Core/Request/Api/KeySecret.json

### Description
Gets a secret key for request signing — required for CORS requests. Must be signed as an ordinary SDK request (transient + persistent cookies), never from a browser.

### Method
GET

### Endpoint
Core/Request/Api/KeySecret.json

### Parameters
#### Query Parameters
- **s_csrf** (string) - Required - CSRF code from the client side.
- **s_key_session** (string) - Required - Session key.
- **url_origin** (string) - Required - Origin for client requests.
- **url_domain** (string) - Optional - Deprecated alias of `url_origin`.

### Response
#### Success Response (200)
- **s_key_secret** (string) - Secret key for request signing.

#### Response Example
```json
{
  "s_key_secret": "string"
}
```
```

--------------------------------

### Performing a POST request with EnterModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-abstract.md

Sets login, notepad, and password fields, then posts the model and prints the HTTP protocol from the returned request. The password is hashed using the notepad's hash method.

```php
$o_enter = new EnterModel($o_config);
$o_enter->s_login = 'login';
$o_enter->s_notepad = $o_notepad->s_notepad;
$o_enter->s_password = $o_notepad->hash('password');
$o_request = $o_enter->post();
echo $o_request->httpProtocol();
```

--------------------------------

### CredentialModel: Get Google Credential

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/request-infrastructure.md

Creates a CredentialModel instance, sets the credential CID to 972 (Google credential), calls get(), and prints the credential payload. Requires a config object ($o_config) for initialization.

```php
$o_credential = new CredentialModel($o_config);
$o_credential->cid_credential = 972;
$o_credential->get();
print_r($o_credential->json_credential);
```

--------------------------------

### GET Core/Passport/User/Email/EmailExist.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/authentication.md

Checks whether an email address exists in the system.

```APIDOC
## GET Core/Passport/User/Email/EmailExist.json

### Description
Checks whether an email exists.

### Method
GET

### Endpoint
Core/Passport/User/Email/EmailExist.json

### Parameters
#### Query Parameters
- **text_email** (string) - Required - Email address.

### Response
#### Success Response
- **is_exist** (bool) - `true` if the email exists.

```

--------------------------------

### microserviceSet()

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-abstract.md

Sets the microservice tag appended to the request URL as the -ms GET parameter.

```APIDOC
## microserviceSet()

### Description
Sets the microservice tag that is appended to the request URL as the `-ms` GET parameter (`MS_GET_PARAM`). Passing `null` detaches the model from any microservice.

### Method
`microserviceSet`

### Signature
```php
public function microserviceSet($s_microservice)
```

### Parameters
- `$s_microservice` (string|null) - Required - Microservice name, or `null` to detach.

### Notes
- The constant `MS_GET_PARAM` is `'-ms'`.
```

--------------------------------

### WlWebhook::__construct

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-webhook.md

Constructor for the WlWebhook class. Accepts an SDK configuration object that provides AUTHORIZE_ID, AUTHORIZE_CODE, and hostname().

```APIDOC
## WlWebhook::__construct

### Description
Initializes the webhook helper with the SDK configuration.

### Method
Constructor

### Signature
```php
public function __construct($o_config)
```

### Parameters
- **$o_config** (WlConfigAbstract) - Required - SDK configuration object (provides AUTHORIZE_ID, AUTHORIZE_CODE, hostname()).
```

--------------------------------

### OriginModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/request-infrastructure.md

Gets, deletes, and adds allowed CORS origins for the application via the Core/Request/Api/Application/Origin.json endpoint.

```APIDOC
## OriginModel

### Description
Gets, deletes, and adds allowed CORS origins for the application.

### Endpoint
`Core/Request/Api/Application/Origin.json`

### Methods
- GET (result)
- PUT (body)
- DELETE (body)

### Fields
| Field | Type | Transport | Description |
|-------|------|-----------|-------------|
| `a_list` | array\|null | result / PUT / DELETE | Key = site URL where API calls may be made; value = domain used for API requests (`null` when requests go directly to the WellnessLiving server). |

### Notes
An application can only manage its own origins. If a site is not in the list, browser-side (CORS) requests from it are restricted.
```

--------------------------------

### Catch WlAssertException and display message

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/errors.md

Use this snippet to catch a WlAssertException thrown during configuration creation. The example calls ExampleConfig::create() with a region ID and catches the exception, printing the message and the exception object (which includes debug data via __toString()).

```php
use WellnessLiving\WlAssertException;

try {
  $o_config = ExampleConfig::create(WlRegionSid::US_EAST_1);
} catch (WlAssertException $e) {
  echo $e->getMessage();     // configuration problem, fix client code
  echo $e;                  // __toString() includes debug data
}
```

--------------------------------

### POST Core/Passport/ChangePassword/ChangePasswordBegin.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/authentication.md

Starts the password change process by sending a reset password email to the user.

```APIDOC
## POST Core/Passport/ChangePassword/ChangePasswordBegin.json

### Description
Starts password change; sends the "reset password" email.

### Method
POST

### Endpoint
Core/Passport/ChangePassword/ChangePasswordBegin.json

### Parameters
#### Request Body
- **text_captcha** (string) - Optional - Captcha answer, only if the server requires it.
- **text_mail** (string) - Required - User email.
- **url_reset** (string) - Optional - Custom password-reset page URL used in the email.

### Response
#### Success Response
- **text_error** (string) - Error code; empty string when the email was sent successfully.

```

--------------------------------

### Catch Exception Categories

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/errors.md

Example of catching different exception types when posting a model in the WellnessLiving SDK.

```APIDOC
## Catch Exception Categories

### Description
Demonstrates how to catch different exception types when calling `$o_model->post()` in the WellnessLiving SDK.

### Method
POST

### Endpoint
`$o_model->post()`

### Parameters
None

### Request Example
```php
use WellnessLiving\WlAssertException;
use WellnessLiving\WlDebugException;
use WellnessLiving\WlUserException;

try {
  $o_model->post();
} catch (WlDebugException $e) {
  // client-validatable error, may be shown to the user
} catch (WlUserException $e) {
  // API/transport error; $e->sid() for the code, $e->request() for debugging
} catch (WlAssertException $e) {
  // programmatic misuse — fix the calling code
} catch (\Exception $e) {
  // e.g. Sha3 unsupported-size errors
}
```

### Response
#### Success Response (200)
No response body is documented.

#### Error Handling
- `WlDebugException`: client-validatable error, may be shown to the user
- `WlUserException`: API/transport error; use `$e->sid()` for the code, `$e->request()` for debugging
- `WlAssertException`: programmatic misuse — fix the calling code
- `\Exception`: e.g. Sha3 unsupported-size errors
```

--------------------------------

### WlModelMultiModel::getMulti

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-multi-model.md

Executes the multi-cURL request with GET for all added models. Throws WlAssertException and WlUserException on failure.

```APIDOC
## WlModelMultiModel::getMulti

### Description
Executes the multi-cURL request with GET for all added models. Throws `WlAssertException` and `WlUserException` (each model's `requestResult()` runs after the batch; a failure surfaces from the first failing model processed).

### Method
getMulti

### Signature
```php
public function getMulti()
```

### Exceptions
- `WlAssertException` - Thrown on assertion failure.
- `WlUserException` - Thrown when a model request fails.

```

--------------------------------

### WlModelMultiModel::__construct

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-multi-model.md

Constructor inherited from WlModelAbstract. Initializes the multi-model with the SDK configuration object.

```APIDOC
## WlModelMultiModel::__construct

### Description
Constructor inherited from `WlModelAbstract`. Initializes the multi-model with the SDK configuration object.

### Method
Constructor

### Signature
```php
public function __construct(WlConfigAbstract $o_config)
```

### Parameters
- `$o_config` (WlConfigAbstract) - Required - SDK configuration object.

```

--------------------------------

### POST Wl/Business/Business.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-models.md

Creates a new business. The request body includes business details and optional staff member information. The response returns the key of the created business.

```APIDOC
## POST Wl/Business/Business.json

### Description
Creates a new business.

### Method
POST

### Endpoint
Wl/Business/Business.json

### Parameters
#### Request Body
- **a_staff_member** (array) - Required - Staff member to create in the business; empty array creates none. Elements: `is_enter` (bool, auto sign-in), `text_mail`, `text_name_first`, `text_name_last`.
- **id_locale** (int) - Required - Business locale, one of `LocaleSid` constants.
- **is_location_create** (bool) - Required - `true` to also create a location.
- **k_business_type** (string) - Required - Business type key.
- **k_office_city** (string) - Required - City key.
- **text_office_address** (string) - Optional - Address.
- **text_office_postal** (string) - Optional - Postal code.
- **text_phone** (string) - Required - Phone number.
- **text_title** (string) - Required - Business title.

### Response
#### Success Response (200)
- **k_business** (string) - Key of the created business.

#### Response Example
{
  "k_business": "string"
}
```

--------------------------------

### getMulti() method signature

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/wl-model-multi-model.md

Executes the multi-cURL request with GET for all added models. Throws WlAssertException and WlUserException.

```php
public function getMulti()
```

--------------------------------

### GET Core/Captcha/CaptchaRequire.json

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/request-infrastructure.md

Checks whether a captcha is required. Returns a boolean flag indicating if a captcha is needed.

```APIDOC
## GET Core/Captcha/CaptchaRequire.json

### Description
Checks whether a captcha is required. Returns a boolean flag indicating if a captcha is needed.

### Method
GET

### Endpoint
Core/Captcha/CaptchaRequire.json

### Parameters
#### Query Parameters
- **cid_captcha** (int) - Required - Captcha CID.
- **a_arguments** (array) - Required - Arguments for creating the captcha object.

### Response
#### Success Response (200)
- **is_require** (bool) - `true` when a captcha is required.

#### Response Example
{
  "is_require": true
}
```

--------------------------------

### CredentialModel

Source: https://github.com/wellnessliving/wl-sdk/blob/master/_autodocs/api-reference/request-infrastructure.md

Manages application credentials via the Core/Request/Api/Application/Credential/Credential.json endpoint. Supports GET, PUT, and DELETE operations.

```APIDOC
## CredentialModel

### Description
Manages application credentials (GET/PUT/DELETE).

### Endpoint
`Core/Request/Api/Application/Credential/Credential.json`

### Methods
- GET
- PUT
- DELETE

### Fields
| Field | Type | Transport | Description |
|-------|------|-----------|-------------|
| `cid_credential` | int | GET (delete/get/put) | Credential CID. `972` = Google credential, `973` = Facebook credential. |
| `json_credential` | array | result / PUT body | The credential payload. |

### Example
```php
$o_credential = new CredentialModel($o_config);
$o_credential->cid_credential = 972;
$o_credential->get();
print_r($o_credential->json_credential);
```
```
Tokens:
Raw