### Get Products List with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

This example shows how to fetch a list of products using the Basalam SDK. It allows for pagination and sorting by providing query parameters such as page number, items per page, and sort order. This is useful for displaying product listings.

```php
<?php

use Basalam\SDK\Core\Models\GetProductsQuerySchema;

function getProductsExample(): object
{
    global $client;

    $products = $client->getProducts(
        queryParams: new GetProductsQuerySchema(
            page: 1,
            perPage: 20,
            sort: 'price:asc'
        )
    );

    return $products;
}

```

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

### PHP SDK Wallet Service: Get User Balance

Source: https://developers.basalam.com/docs/sdk/php/wallet

This example shows how to retrieve a user's wallet balance using the `getBalance` method. It accepts a user ID and optional filters to specify the type of balance to retrieve (e.g., cash, settleable).

```php
<?php

use Basalam\SDK\Wallet\Models\BalanceFilter;

function getBalanceExample(): object
{
    global $client;

    $balance = $client->getBalance(
        userId: 123,
        filters: [
            new BalanceFilter(
                cash: true,
                settleable: true,
                vendor: false,
                customer: true
            )
        ]
    );

    return $balance;
}

```

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

### Install Basalam PHP SDK using Composer

Source: https://developers.basalam.com/docs/sdk/php/intro

This snippet shows how to install the Basalam PHP SDK using Composer, a dependency manager for PHP. Ensure you have Composer installed on your system.

```bash
composer require basalam/php-sdk
```

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

### Get Vendor Products with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

Provides an example of retrieving a vendor's products using the Basalam SDK. Requires the vendor ID and allows filtering by status, page number, and items per page via query parameters. Returns the product list.

```php
<?php

use Basalam\SDK\Core\Models\GetVendorProductsSchema;
use Basalam\SDK\Core\Enums\ProductStatusInputEnum;

function getVendorProductsExample(): object
{
    global $client;

    $products = $client->getVendorProducts(
        vendorId: 456,
        queryParams: new GetVendorProductsSchema(
            statuses: [ProductStatusInputEnum::PUBLISHED],
            page: 1,
            perPage: 10
        )
    );

    return $products;
}

```

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

### Get Vendor with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

Provides an example of how to retrieve a specific vendor's details using the Basalam SDK. Requires the vendor ID and an optional 'prefer' parameter for customizing the return format. Returns the vendor object.

```php
<?php

function getVendorExample(): object
{
    global $client;

    $vendor = $client->getVendor(
        vendorId: 456,
        prefer: 'return=minimal'
    );

    return $vendor;
}

```

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

### Get Me API (GET)

Source: https://developers.basalam.com/docs/sdk/php/chat

Retrieves information about the bot using a GET request.

```APIDOC
## GET /getMe

### Description
Retrieves information about the bot.

### Method
GET

### Endpoint
/getMe

### Parameters
#### Query Parameters
- **token** (string) - Required - The token of the bot.

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **result** (object) - Contains bot information such as 'id', 'first_name', and 'username'.
```

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

### Configure Basalam SDK PHP Client

Source: https://developers.basalam.com/docs/sdk/php/order

Initializes the Basalam PHP SDK client using personal access tokens for authentication. This setup is required before making any service calls.

```php
<?php
 
use Basalam\SDK\BasalamClient;
use Basalam\SDK\Auth\PersonalToken;
 
$auth = new PersonalToken(
    token: 'your_access_token',
    refreshToken: 'your_refresh_token'
);
$client = new BasalamClient($auth);
```

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

### Get Working Shipping Methods with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

Shows how to get the shipping methods that are currently active for a specific vendor using the Basalam SDK. Requires the vendor ID and returns an array of active shipping methods.

```php
<?php

function getWorkingShippingMethodsExample(): array
{
    global $client;

    $workingMethods = $client->getWorkingShippingMethods(
        vendorId: 456
    );

    return $workingMethods;
}

```

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

### Get Webhook Info API (GET)

Source: https://developers.basalam.com/docs/sdk/php/chat

Retrieves the current webhook information for a bot using a GET request.

```APIDOC
## GET /getWebhookInfo

### Description
Retrieves the current webhook information for a bot.

### Method
GET

### Endpoint
/getWebhookInfo

### Parameters
#### Query Parameters
- **token** (string) - Required - The token of the bot.

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **result** (object) - Contains webhook details if successful (e.g., 'url').
```

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

### Get Me API (POST)

Source: https://developers.basalam.com/docs/sdk/php/chat

Retrieves information about the bot using a POST request.

```APIDOC
## POST /getMePost

### Description
Retrieves information about the bot using a POST request.

### Method
POST

### Endpoint
/getMePost

### Parameters
#### Request Body
- **token** (string) - Required - The token of the bot.

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **result** (object) - Contains bot information.
```

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

### Get Bot Info (GET/POST) using Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/chat

Retrieves information about the bot, including its ID, first name, and username. This can be done via GET (`getMe`) or POST (`getMePost`) requests, both requiring the bot's token. The GET method also demonstrates how to access and display bot details.

```php
<?php

function getMeExample(): object
{
    global $client;

    $botToken = '123456789:ABCdefGHIjklMNOpqrsTUVwxyz';
    $botInfo = $client->getMe(token: $botToken);

    if ($botInfo->getOk()) {
        $bot = $botInfo->getResult();
        echo 'شناسه بات: ' . $bot['id'];
        echo 'نام بات: ' . $bot['first_name'];
        echo 'نام کاربری بات: @' . $bot['username'];
    }

    return $botInfo;
}

```

```php
<?php

function getMePostExample(): object
{
    global $client;

    $botToken = '123456789:ABCdefGHIjklMNOpqrsTUVwxyz';
    $botInfo = $client->getMePost(token: $botToken);

    return $botInfo;
}

```

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

### Get Webhook Info (GET/POST) using Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/chat

Fetches the current webhook information for a bot. This can be done using either a GET request (`getWebhookInfo`) or a POST request (`getWebhookInfoPost`). Both methods require the bot's token and return webhook details.

```php
<?php

function getWebhookInfoExample(): object
{
    global $client;

    $botToken = '123456789:ABCdefGHIjklMNOpqrsTUVwxyz';
    $webhookInfo = $client->getWebhookInfo(token: $botToken);

    if ($webhookInfo->getOk()) {
        echo 'Webhook URL: ' . $webhookInfo->getResult()['url'] ?? 'تنظیم نشده';
    }

    return $webhookInfo;
}

```

```php
<?php

function getWebhookInfoPostExample(): object
{
    global $client;

    $botToken = '123456789:ABCdefGHIjklMNOpqrsTUVwxyz';
    $webhookInfo = $client->getWebhookInfoPost(token: $botToken);

    return $webhookInfo;
}

```

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

### GET /items

Source: https://developers.basalam.com/docs/sdk/php/order-processing

Retrieves a list of order items based on specified filters.

```APIDOC
## GET /items

### Description
Retrieves order items based on provided filters.

### Method
GET

### Endpoint
`/items`

### Parameters
#### Query Parameters
- **`filters`** (ItemFilter) - Optional - An object containing various filters to narrow down the item search. See `ItemFilter` documentation for available properties.

### Request Example
```php
<?php

use Basalam\SDK\OrderProcessing\Models\ItemFilter;

// Assuming $client is an initialized BasalamClient instance
$items = $client->getOrderItems(
    filters: new ItemFilter(
        createdAt: '2024-01-01',
        cursor: 'next_cursor_123',
        customerIds: '123,456,789',
        ids: '1,2,3',
        orderIds: '1,2,3',
        perPage: 20,
        productIds: '1,2,3',
        sort: 'created_at:desc',
        vendorIds: '456,789'
    )
);

print_r($items);
?>
```

### Response
#### Success Response (200)
- **items** (array) - A list of order item objects.
- **meta** (object) - Pagination and meta information.

#### Response Example
```json
{
  "items": [
    {
      "id": 789,
      "order_id": 123,
      "product_id": 101,
      "quantity": 1,
      "price": 75.50,
      "created_at": "2024-01-10T10:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "next_page_url": "/items?page=2",
    "prev_page_url": null,
    "per_page": 20,
    "total": 100
  }
}
```
```

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

### Get All Shipping Methods with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

Illustrates how to retrieve all available shipping methods using the Basalam SDK. This function does not require any parameters and returns an array containing all shipping methods.

```php
<?php

function getShippingMethodsExample(): array
{
    global $client;

    $shippingMethods = $client->getShippingMethods();

    return $shippingMethods;
}

```

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

### PHP SDK Chat: Retrieve Messages

Source: https://developers.basalam.com/docs/sdk/php/chat

This example illustrates how to fetch messages from a chat using the `getMessages` method. It takes a `GetMessagesRequest` object, allowing filtering by `chatId`, `messageId`, `limit`, and `order`.

```php
<?php

use Basalam\SDK\Chat\Models\GetMessagesRequest;

function getMessagesExample(): array
{
    global $client;

    $request = new GetMessagesRequest(
        chatId: 123,
        messageId: 456,
        limit: 20,
        order: 'desc'
    );

    $messages = $client->getMessages(request: $request);

    return $messages;
}
```

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

### PHP SDK Wallet Service: Get Expense Details

Source: https://developers.basalam.com/docs/sdk/php/wallet

This snippet shows how to retrieve detailed information about a specific expense using the `getExpense` method. It requires both the user ID and the expense ID as parameters.

```php
<?php

function getExpenseExample(): object
{
    global $client;

    $expense = $client->getExpense(
        userId: 123,
        expenseId: 456
    );

    return $expense;
}

```

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

### Create Product with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

This example shows how to create a new product using the Basalam SDK. It involves providing product details such as name, description, price, stock, and category ID. The function also handles uploading product images by accepting file handles.

```php
<?php

use Basalam\SDK\Core\Models\ProductRequestSchema;
use Basalam\SDK\Core\Enums\ProductStatusInputEnum;
use Basalam\SDK\Core\Enums\UnitTypeInputEnum;

function createProductExample(): object
{
    global $client;

    $photoFiles = [
        fopen('test1.png', 'r'),
        fopen('test2.png', 'r')
    ];

    $request = new ProductRequestSchema(
        name: 'Product 01',
        description: 'The material of this product is very high quality and made of silk.',
        categoryId: 238,
        primaryPrice: 100000,
        weight: 300,
        packageWeight: 500,
        stock: 10,
        status: ProductStatusInputEnum::PUBLISHED,
        unitQuantity: 10,
        unitType: UnitTypeInputEnum::NUMERIC
    );

    $product = $client->createProduct(456, $request, photoFiles: $photoFiles);

    // Close file handles
    foreach ($photoFiles as $file) {
        fclose($file);
    }

    return $product;
}

```

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

### Fetch Products using Basalam PHP SDK

Source: https://developers.basalam.com/docs/sdk/php/intro

This PHP snippet illustrates how to make your first API call to fetch products using the Basalam PHP SDK. It assumes the BasalamClient has been successfully initialized.

```php
// دریافت محصولات
$products = $client->getProducts();
echo "Found " . count($products) . " products\n";
```

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

### Search Products using Basalam PHP SDK

Source: https://developers.basalam.com/docs/sdk/php/search

This example showcases how to search for products using the `searchProducts` method of the Basalam PHP SDK. It utilizes the `ProductSearchModel` and `FiltersModel` to define search criteria, including free shipping, price range, minimum rating, and vendor score. The function returns an array of search results.

```php
<?php

use Basalam\SDK\Search\Models\ProductSearchModel;
use Basalam\SDK\Search\Models\FiltersModel;

function searchProductsExample(): array
{
    global $client;

    $results = $client->searchProducts(
        request: new ProductSearchModel(
            filters: new FiltersModel(
                freeShipping: 1,
                maxPrice: 10000000,
                minPrice: 1000000,
                minRating: 4,
                vendorScore: 1
            ),
            q: 'عسل'
        )
    );

    return $results;
}

```

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

### Initialize BasalamClient with Personal Token

Source: https://developers.basalam.com/docs/sdk/php/webhook

Demonstrates how to set up the BasalamClient using a personal access token and refresh token for authentication. This is the initial step before making any API calls.

```php
<?php

use Basalam\SDK\BasalamClient;
use Basalam\SDK\Auth\PersonalToken;

$auth = new PersonalToken(
    token: 'your_access_token',
    refreshToken: 'your_refresh_token'
);
$client = new BasalamClient($auth);
```

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

### Log Out API (GET)

Source: https://developers.basalam.com/docs/sdk/php/chat

Logs out the bot and invalidates its token using a GET request.

```APIDOC
## GET /logOut

### Description
Logs out the bot and invalidates its token.

### Method
GET

### Endpoint
/logOut

### Parameters
#### Query Parameters
- **token** (string) - Required - The token of the bot.

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the operation was successful.
- **description** (string) - Provides a description of the result or error.
```

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

### PHP SDK Wallet Service: Initial Configuration

Source: https://developers.basalam.com/docs/sdk/php/wallet

This snippet demonstrates the initial setup and configuration of the Basalam PHP SDK's ClientCredentials authentication for accessing the Wallet Service. It requires client ID and secret to establish a connection.

```php
<?php

use Basalam\SDK\BasalamClient;
use Basalam\SDK\Auth\ClientCredentials;

$auth = new ClientCredentials(
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret'
);

$client = new BasalamClient($auth);

```

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

### Delete Webhook API (GET)

Source: https://developers.basalam.com/docs/sdk/php/chat

Deletes the webhook URL for a bot using a GET request.

```APIDOC
## GET /deleteWebhookGet

### Description
Deletes the webhook URL for a bot.

### Method
GET

### Endpoint
/deleteWebhookGet

### Parameters
#### Query Parameters
- **token** (string) - Required - The token of the bot.

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the operation was successful.
```

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

### مثال استفاده از جریان کد مجوز در Laravel (PHP)

Source: https://developers.basalam.com/docs/sdk/php/auth

این مثال نحوه ادغام جریان کد مجوز با فریمورک Laravel را نشان می‌دهد. این کد شامل متدهایی برای هدایت کاربر به صفحه مجوز باسلام و پردازش callback پس از احراز هویت است. کد امن توکن‌ها پس از تبادل، باید ذخیره شود.

```php
<?php

// مثال با استفاده از Laravel
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;
use Basalam\SDK\Auth\AuthorizationCode;

class AuthController extends Controller
{
    public function login()
    {
        $auth = new AuthorizationCode(
            clientId: 'your-client-id',
            clientSecret: 'your-client-secret',
            redirectUri: 'https://your-app.com/callback'
        );

        $authUrl = $auth->getAuthorizationUrl(state: 'user_session_id');
        return Redirect::to($authUrl);
    }

    public function callback(Request $request)
    {
        $code = $request->get('code');
        $state = $request->get('state');

        $auth = new AuthorizationCode(
            clientId: 'your-client-id',
            clientSecret: 'your-client-secret',
            redirectUri: 'https://your-app.com/callback'
        );

        // تبادل کد با توکن‌ها
        $tokenInfo = $auth->getToken(code: $code);

        // ذخیره امن توکن‌ها
        // ... ذخیره $tokenInfo->accessToken, $tokenInfo->refreshToken

        return 'Authentication successful!';
    }
}

```

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

### Create Vendor with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

Demonstrates how to create a new vendor using the Basalam SDK. Requires vendor details like title, identifier, category, city, and summary. Returns the created vendor object.

```php
<?php

use Basalam\SDK\Core\Models\CreateVendorSchema;

function createVendorExample(): object
{
    global $client;

    $vendor = $client->createVendor(
        userId: 123,
        request: new CreateVendorSchema(
            title: 'My Store',
            identifier: 'store123',
            categoryType: 1,
            city: 1,
            summary: 'A great store for all your needs'
        )
    );

    return $vendor;
}

```

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

### Get Unseen Chat Count using Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/chat

Retrieves the total number of unread chats for the authenticated bot. This is a simple GET request to the SDK client that returns an integer representing the count.

```php
<?php

function getUnseenChatCountExample(): int
{
    global $client;

    $unseenCount = $client->getUnseenChatCount();

    return $unseenCount;
}

```

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

### Create Bulk Products Action Request with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

This function demonstrates how to create a bulk action request for products using the Basalam SDK. It allows specifying a filter for products (e.g., by stock range) and defining actions to be performed on them, such as setting a new stock value.

```php
<?php

use Basalam\SDK\Core\Models\BulkProductsUpdateRequestSchema;
use Basalam\SDK\Core\Models\ProductFilterSchema;
use Basalam\SDK\Core\Models\BulkActionItem;
use Basalam\SDK\Core\Models\RangeFilterItem;
use Basalam\SDK\Core\Enums\ProductBulkActionTypeEnum;
use Basalam\SDK\Core\Enums\ProductBulkFieldInputEnum;

function createProductsBulkActionRequestExample(): object
{
    global $client;

    $bulkRequest = $client->createProductsBulkActionRequest(
        vendorId: 456,
        request: new BulkProductsUpdateRequestSchema(
            productFilter: new ProductFilterSchema(
                stock: new RangeFilterItem(
                    start: 1,
                    end: 5
                )
            ),
            action: [
                new BulkActionItem(
                    field: ProductBulkFieldInputEnum::STOCK,
                    action: ProductBulkActionTypeEnum::SET,
                    value: 50
                )
            ]
        )
    );

    return $bulkRequest;
}

```

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

### PHP SDK Wallet Service: Create Expense

Source: https://developers.basalam.com/docs/sdk/php/wallet

This example illustrates how to create a new expense record using the `createExpense` method. It takes a user ID and a `SpendCreditRequest` object containing details like reason, reference, amount, and types.

```php
<?php

use Basalam\SDK\Wallet\Models\SpendCreditRequest;

function createExpenseExample(): object
{
    global $client;

    $expense = $client->createExpense(
        userId: 123,
        request: new SpendCreditRequest(
            reasonId: 1,
            referenceId: 456,
            amount: 10000,
            description: 'Payment for order #456',
            types: [1, 2],
            settleable: true,
            references: [
                'order_id' => 456,
                'payment_method' => 1
            ]
        )
    );

    return $expense;
}

```

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

### Get Product Details with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

This function demonstrates how to retrieve detailed information about a specific product using its ID via the Basalam SDK. It includes an option to specify the 'prefer' parameter for controlling the return data format, such as 'return=minimal'.

```php
<?php

function getProductExample(): object
{
    global $client;

    $product = $client->getProduct(
        productId: 24835037,
        prefer: 'return=minimal'
    );

    return $product;
}

```

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

### GET /parcels/{parcelId}

Source: https://developers.basalam.com/docs/sdk/php/order-processing

Retrieves the details of a specific parcel using its ID.

```APIDOC
## GET /parcels/{parcelId}

### Description
Retrieves the detailed information for a specific parcel.

### Method
GET

### Endpoint
`/parcels/{parcelId}`

### Parameters
#### Path Parameters
- **`parcelId`** (integer) - Required - The unique identifier of the parcel.

### Request Example
```php
<?php

// Assuming $client is an initialized BasalamClient instance
$parcel = $client->getOrderParcel(
    parcelId: 789
);

print_r($parcel);
?>
```

### Response
#### Success Response (200)
- **parcel** (object) - An object containing the full details of the parcel.

#### Response Example
```json
{
  "parcel": {
    "id": 789,
    "order_id": 123,
    "vendor_id": 456,
    "status": "delivered",
    "tracking_code": "ABC123XYZ",
    "estimated_delivery_date": "2024-01-20",
    "created_at": "2024-01-12T12:00:00Z",
    "updated_at": "2024-01-19T15:00:00Z"
  }
}
```
```

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

### Authenticate with Basalam API using Personal Access Token

Source: https://developers.basalam.com/docs/sdk/php/intro

This PHP code demonstrates how to set up authentication with the Basalam API using a Personal Access Token (PAT). It initializes the BasalamClient with the provided token and refresh token.

```php
<?php

require_once 'vendor/autoload.php';

use Basalam\SDK\BasalamClient;
use Basalam\SDK\Auth\PersonalToken;

// توکن دسترسی شخصی (PAT)
$auth = new PersonalToken(
    token: 'your-access-token',
    refreshToken: 'your-refresh-token'
);

// ایجاد کلاینت
$client = new BasalamClient($auth);
```

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

### Use Scopes with ClientCredentials in Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/auth

This example shows how to instantiate the `ClientCredentials` class using specific scopes from the `Scope` class in the Basalam SDK for PHP. It requires a client ID, client secret, and an array of desired scopes for authentication.

```php
<?php

use Basalam\SDK\Auth\ClientCredentials;
use Basalam\SDK\Auth\Scope;

$auth = new ClientCredentials(
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret',
    scopes: [
        Scope::CUSTOMER_WALLET_READ,
        Scope::VENDOR_PRODUCT_WRITE,
        Scope::CUSTOMER_ORDER_READ
    ]
);
```

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

### GET /orders/{orderId}

Source: https://developers.basalam.com/docs/sdk/php/order-processing

Retrieves the details of a specific order using its ID.

```APIDOC
## GET /orders/{orderId}

### Description
Retrieves the detailed information for a specific order.

### Method
GET

### Endpoint
`/orders/{orderId}`

### Parameters
#### Path Parameters
- **`orderId`** (integer) - Required - The unique identifier of the order.

### Request Example
```php
<?php

// Assuming $client is an initialized BasalamClient instance
$order = $client->getOrder(
    orderId: 123
);

print_r($order);
?>
```

### Response
#### Success Response (200)
- **order** (object) - An object containing the full details of the order.

#### Response Example
```json
{
  "order": {
    "id": 123,
    "customer_id": 456,
    "created_at": "2024-01-10T10:00:00Z",
    "status": "processing",
    "total_amount": 75.50,
    "items": [
      {
        "id": 789,
        "product_id": 101,
        "quantity": 1,
        "price": 75.50
      }
    ]
  }
}
```
```

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

### Create Shelve - PHP

Source: https://developers.basalam.com/docs/sdk/php/core

This function creates a new product shelf. It requires a schema object containing the shelf's title, description, and the vendor ID. The function returns an object representing the newly created shelf.

```php
<?php

use Basalam\SDK\Core\Models\ShelveSchema;

function createShelveExample(): object
{
    global $client;

    $shelve = $client->createShelve(
        request: new ShelveSchema(
            title: 'مجموعه تابستانه',
            description: 'بهترین محصولات برای فصل تابستان',
            vendorId: 456
        )
    );

    return $shelve;
}

```

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

### GET /orders

Source: https://developers.basalam.com/docs/sdk/php/order-processing

Retrieves a list of customer orders based on specified filters.

```APIDOC
## GET /orders

### Description
Retrieves customer orders based on provided filters.

### Method
GET

### Endpoint
`/orders`

### Parameters
#### Query Parameters
- **`filters`** (OrderFilter) - Optional - An object containing various filters to narrow down the order search. See `OrderFilter` documentation for available properties.

### Request Example
```php
<?php

use Basalam\SDK\OrderProcessing\Models\OrderFilter;

// Assuming $client is an initialized BasalamClient instance
$orders = $client->getOrders(
    filters: new OrderFilter(
        couponCode: 'SAVE10',
        cursor: 'next_cursor_123',
        customerIds: '123,456,789',
        customerName: 'John Doe',
        ids: '1,2,3',
        itemsTitle: 'laptop',
        paidAt: '2024-01-01',
        parcelEstimateSendAt: '2024-01-15',
        parcelStatuses: ['posted', 'delivered'],
        perPage: 20,
        sort: 'paid_at:desc',
        vendorIds: '456,789'
    )
);

print_r($orders);
?>
```

### Response
#### Success Response (200)
- **orders** (array) - A list of order objects.
- **meta** (object) - Pagination and meta information.

#### Response Example
```json
{
  "orders": [
    {
      "id": 1,
      "customer_id": 123,
      "created_at": "2024-01-10T10:00:00Z",
      "status": "pending",
      "total_amount": 50.00
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 10,
    "next_page_url": "/orders?page=2",
    "prev_page_url": null,
    "per_page": 20,
    "total": 200
  }
}
```
```

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

### Update Single Product with Basalam SDK PHP

Source: https://developers.basalam.com/docs/sdk/php/core

This example illustrates how to update a single product's details using the Basalam SDK. It allows modifying various product attributes, including status and specific custom attributes, by providing the product ID and a schema with the desired changes.

```php
<?php

use Basalam\SDK\Core\Models\ProductRequestSchema;

function updateProductExample(): object
{
    global $client;

    $updatedProduct = $client->updateProduct(
        productId: 789,
        request: new ProductRequestSchema(
            status: 3790,
            productAttribute: [
                [
                    'attribute_id' => 219,
                    'value' => 'Suitable for formal ceremonies'
                ],
                [
                    'attribute_id' => 221,
                    'value' => 'Silk'
                ],
                [
                    'attribute_id' => 222,
                    'value' => 'Burgundy, Black, Turquoise'
                ],
                [
                    'attribute_id' => 1319,
                    'value' => 'Due to its sensitivity, this fabric should be hand washed gently with cold water.'
                ]
            ]
        )
    );

    return $updatedProduct;
}

```

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

### GET /webhooks/logs

Source: https://developers.basalam.com/docs/sdk/php/webhook

Retrieves logs for a specific webhook. This is useful for debugging and monitoring webhook activity.

```APIDOC
## GET /webhooks/logs

### Description
Retrieves logs for a specific webhook. This is useful for debugging and monitoring webhook activity.

### Method
GET

### Endpoint
/webhooks/logs

### Parameters
#### Query Parameters
- **webhookId** (int) - Required - The ID of the webhook to retrieve logs for.

### Request Example
```php
<?php

function getWebhookLogsExample(): object
{
    global $client;

    $logs = $client->getWebhookLogs(webhookId: 123);

    return $logs;
}
```

### Response
#### Success Response (200)
- **logs** (array) - A list of webhook log entries.
```

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

### GET /items/{itemId}

Source: https://developers.basalam.com/docs/sdk/php/order-processing

Retrieves the details of a specific order item using its ID.

```APIDOC
## GET /items/{itemId}

### Description
Retrieves the detailed information for a specific order item.

### Method
GET

### Endpoint
`/items/{itemId}`

### Parameters
#### Path Parameters
- **`itemId`** (integer) - Required - The unique identifier of the order item.

### Request Example
```php
<?php

// Assuming $client is an initialized BasalamClient instance
$item = $client->getOrderItem(
    itemId: 456
);

print_r($item);
?>
```

### Response
#### Success Response (200)
- **item** (object) - An object containing the full details of the order item.

#### Response Example
```json
{
  "item": {
    "id": 456,
    "order_id": 789,
    "product_id": 101,
    "quantity": 2,
    "price": 151.00,
    "created_at": "2024-01-11T11:00:00Z"
  }
}
```
```

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

### GET /webhooks/registered

Source: https://developers.basalam.com/docs/sdk/php/webhook

Retrieves a list of webhooks that the client is registered for. Supports pagination and filtering by service ID.

```APIDOC
## GET /webhooks/registered

### Description
Retrieves a list of webhooks that the client is registered for. Supports pagination and filtering by service ID.

### Method
GET

### Endpoint
/webhooks/registered

### Parameters
#### Query Parameters
- **page** (int) - Optional - The page number for pagination.
- **perPage** (int) - Optional - The number of results per page.
- **serviceId** (int) - Optional - The ID of the service to filter registered webhooks by.

### Request Example
```php
<?php

function getRegisteredWebhooksExample(): object
{
    global $client;

    $webhooks = $client->getRegisteredWebhooks(
        page: 1,
        perPage: 10,
        serviceId: 1
    );

    return $webhooks;
}
```

### Response
#### Success Response (200)
- **webhooks** (array) - A list of registered webhook objects.
- **pagination** (object) - Pagination details.
```

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

### احراز هویت با اعتبارنامه‌های کلاینت در PHP

Source: https://developers.basalam.com/docs/sdk/php/auth

این کد نحوه احراز هویت با استفاده از اعتبارنامه‌های کلاینت را نشان می‌دهد. این روش برای برنامه‌های با ماهیت حقوقی و دسترسی‌های خاص مانند کیف پول مناسب است. کلاس `ClientCredentials` برای مدیریت این نوع احراز هویت استفاده می‌شود.

```php
<?php

use Basalam\SDK\BasalamClient;
use Basalam\SDK\Auth\ClientCredentials;
use Basalam\SDK\Auth\Scope;

// احراز هویت پایه
$auth = new ClientCredentials(
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret',
    scopes: [
        Scope::CUSTOMER_WALLET_READ,
        Scope::VENDOR_PRODUCT_WRITE
    ]
);

// ایجاد کلاینت
$client = new BasalamClient($auth);

```

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

### GET /webhooks/customers

Source: https://developers.basalam.com/docs/sdk/php/webhook

Retrieves a list of customers associated with webhooks. Supports pagination and filtering by webhook ID.

```APIDOC
## GET /webhooks/customers

### Description
Retrieves a list of customers associated with webhooks. Supports pagination and filtering by webhook ID.

### Method
GET

### Endpoint
/webhooks/customers

### Parameters
#### Query Parameters
- **page** (int) - Optional - The page number for pagination.
- **perPage** (int) - Optional - The number of results per page.
- **webhookId** (int) - Required - The ID of the webhook to filter customers by.

### Request Example
```php
<?php

function getWebhookCustomersExample(): object
{
    global $client;

    $customers = $client->getWebhookCustomers(
        page: 1,
        perPage: 10,
        webhookId: 123
    );

    return $customers;
}
```

### Response
#### Success Response (200)
- **customers** (array) - A list of customer objects.
- **pagination** (object) - Pagination details.
```

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

### دریافت اطلاعات توکن با اعتبارنامه‌های کلاینت در PHP

Source: https://developers.basalam.com/docs/sdk/php/auth

این کد نحوه دریافت اطلاعات توکن با استفاده از اعتبارنامه‌های کلاینت را نشان می‌دهد. متد `getToken()` از کلاس `ClientCredentials` توکن موجود را در صورت عدم انقضا بازمی‌گرداند یا توکن جدیدی دریافت می‌کند.

```php
<?php

function tokenManagementExample(): object
{
    $auth = new ClientCredentials(
        clientId: 'your-client-id',
        clientSecret: 'your-client-secret'
    );

    // دریافت توکن - اگر منقضی نشده باشد از توکن موجود استفاده می‌کند
    $tokenInfo = $auth->getToken();

    return $tokenInfo;
}

```

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

### GET /stats

Source: https://developers.basalam.com/docs/sdk/php/order-processing

Retrieves statistics related to orders, potentially filtered by vendor, product, or customer.

```APIDOC
## GET /stats

### Description
Retrieves statistics about orders. The type of statistics returned depends on the `resourceCount` parameter.

### Method
GET

### Endpoint
`/stats`

### Parameters
#### Query Parameters
- **`resourceCount`** (string) - Required - Specifies the type of statistics to retrieve. Use constants from `Basalam\SDK\OrderProcessing\Models\ResourceStats` class (e.g., `ResourceStats::NUMBER_OF_ORDERS_PER_VENDOR`).
- **`vendorId`** (integer) - Optional - Filters statistics for a specific vendor.
- **`productId`** (integer) - Optional - Filters statistics for a specific product.
- **`customerId`** (integer) - Optional - Filters statistics for a specific customer.
- **`couponCode`** (string) - Optional - Filters statistics for orders with a specific coupon code.
- **`cacheControl`** (string) - Optional - Controls caching behavior for the request.

### Request Example
```php
<?php

use Basalam\SDK\OrderProcessing\Models\ResourceStats;

// Assuming $client is an initialized BasalamClient instance
$stats = $client->getOrderStats(
    resourceCount: ResourceStats::NUMBER_OF_ORDERS_PER_VENDOR,
    vendorId: 456
);

print_r($stats);
?>
```

### Response
#### Success Response (200)
- **stats** (object or array) - An object or array containing the requested order statistics. The structure depends on the `resourceCount` parameter.

#### Response Example (Example for `NUMBER_OF_ORDERS_PER_VENDOR`)
```json
{
  "stats": [
    {
      "vendor_id": 456,
      "order_count": 50
    },
    {
      "vendor_id": 789,
      "order_count": 30
    }
  ]
}
```
```

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

### Create a New Webhook

Source: https://developers.basalam.com/docs/sdk/php/webhook

Creates a new webhook subscription for a given service and event IDs. It allows configuration of request method, headers, URL, and activation status.

```php
<?php

use Basalam\SDK\Webhook\Models\CreateWebhookRequest;
use Basalam\SDK\Webhook\Enums\RequestMethodType;

function createWebhookExample(): object
{
    global $client;

    $webhook = $client->createWebhook(
        request: new CreateWebhookRequest(
            serviceId: 1,
            eventIds: [1, 2],
            requestHeaders: 'Content-Type: application/json',
            requestMethod: RequestMethodType::POST,  // Enum: POST, PUT, PATCH
            url: 'https://your-app.com/webhook',
            isActive: true
        )
    );

    return $webhook;
}
```