// config/database.php

'api_connection' => [
    'driver' => 'laravel_api_model',
    'database' => 'YOUR_ENDPOINT_URL', // https://example.com/api/model
    
    // If your API doesn't require any authentication you can remove 'auth' from your config
    'auth' => [
        'type' => 'oauth', // package supports 'oauth' and 'passport_client_credentials'
        'url' => 'YOUR_AUTH_URL',
        'client_id' => '',
        'client_secret' => '',
    ],
    
    // Headers you want to append to every request (except auth requests)
    'headers' => [
         // ...
    ],

    'array_value_separator' => ',',
    'max_url_length' => 2048,  // default: 2048
],

use FriendsOfCat\LaravelApiModel\Models\ApiModel

class User extends ApiModel
{
    protected $connection = 'api_connection';
    

}

User::isActive()
    ->where(function($q){
      $q->where('id', '>', 1)
      ->orWhere(function ($q) {
          $q->whereId(0)
          ->orWhereIn('created_at', [3,4,5]);
      })
      ->whereIn('updated_at', [1,2,3,4,5]);
})
->orWhere(function($q) {
    $q->where('id', 3)->where(function($q){
        $q->whereDeletedAt(2)
        ->orWhereNull('type');
    })
    ->where('updated_at', 'like', ' 12%');
})
->where('type', 1)
->get()

User::where('id', '=', 1)->first();
// OR
User::find(1);

User::count();
User::avg('age');
User::min('age');
User::max('age');
// you can use complex queries with any aggregate function
User::where('created_at', '>', now()->subDays(7))->sum('credit');

// Example:
$totalCredit = User::where('created_at', '>', now()->subDays(7))->sum('credit');

$totalCredit === 1000 // true

User::where('created_at', '>', now()->subDays(7))->exists();

// Example:
$totalCredit = User::where('created_at', '>', now()->subDays(7))->exists();

$totalCredit === true // true

User::externalScope('isActive')->first()

User::externalScope('isFrom', ['New York', 'Boston'])->first()

User::with([
  'details',        // relation defined in our local model
  'undefined',      // relation NOT defined in our local model
  'external',       // relation defined in our local model but related to model with same API connection 
])->get()

/*
Every relation passed down to with() is inspected prior to query execution.

a) If relation is not set on our model, we assume it is external and we pass it with the query to server
   and it is excluded from default eager loading.

b) If relation is defined AND has same database connection as our API model,
   we pass it with the query to server and it is excluded from default eager loading.

From our above example, 'undefined' and 'external' are passed down to new externalWith() method.
Original with() is modified to hold only 'details' to ensure correct default eager loading.
*/

User::insert([
    ['name' => 'Mark'],
    ['name' => 'Jason'],
])

// Example:
$users = User::insert([
    ['name' => 'Mark'],
    ['name' => 'Jason'],
]);

$users === true // true

$user = new User();
$user->name = 'Mark';
$user->save();

// OR

$user = User::create(['name' => 'Mark']);

// Example:
$user = new User();
$user->name = 'Mark';
$user->save();
// OR
$user = User::create(['name' => 'Mark']);

$user->id === 1 // true

User::where('created_at', '>', now()->subDays(7))->update(['name' => 'Mark']);

// Example:
$numberOfUpdatedUsers = User::where('created_at', '>', now()->subDays(7))->update(['name' => 'Mark']);

$numberOfUpdatedUsers === 42 // true

// Example:
$user = User::find(1);
$user->name = 'Mark';
$user->save();

$numberOfDeletedUsers = User::where('created_at', '>', now()->subDays(7))->delete();

// Example:
$numberOfDeletedUsers = User::where('created_at', '>', now()->subDays(7))->delete();

$numberOfDeletedUsers === 42 // true