### Install PHP SDK via Composer

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/README.md

Use this command to install the PHP SDK using Composer.

```bash
composer require centralnic-reseller/php-sdk
```

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

### Example Data for Constructor

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Record.html

An example of the data structure expected by the constructor, including domain and user information.

```php
$data = [ "DOMAIN" => "mydomain.com", "USER" => "test.user", // ... further column data ... ];
```

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

### useHighPerformanceConnectionSetup()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Client.html

Activates the High Performance Setup. Note: this functionality is not supported.

```APIDOC
## useHighPerformanceConnectionSetup()

### Description
Activates the High Performance Setup for the client. Please note that this functionality is not supported.

### Method
useHighPerformanceConnectionSetup

### Parameters
None

### Response
#### Success Response ($this)
- Returns the client instance for method chaining.
```

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

### useHighPerformanceConnectionSetup()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Client.html

Activates the High Performance Setup. Note: This functionality is not supported.

```APIDOC
## useHighPerformanceConnectionSetup()

### Description
Activate High Performance Setup. Note: not supported.

### Method
`public useHighPerformanceConnectionSetup() : $this`

### Tags
throws
Exception

### Return values
$this
```

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

### login()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-SessionClient.html

Initiates an API login to start session-based communication.

```APIDOC
## login()

### Description
Perform API login to start session-based communication.

### Method
`public login()`

### Return values
[Response](classes/CNIC-CNR-Response.html)
```

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

### useHighPerformanceConnectionSetup()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-SessionClient.html

Activates the High Performance connection setup for API communication.

```APIDOC
## useHighPerformanceConnectionSetup()

### Description
Activate High Performance Setup.

### Method
`public useHighPerformanceConnectionSetup() : $this`

### Return values
$this
```

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

### CNIC-CNR-Record Constructor Example

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Record.html

Demonstrates how to instantiate the CNIC-CNR-Record class with an array of data. The data array should map column names to their respective values.

```php
public __construct(array<string|int, string> $data) : mixed

$data = [
    "DOMAIN" => "mydomain.com",
    "USER" => "test.user",
    // ... further column data ...
];
```

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

### useHighPerformanceConnectionSetup()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Client.html

Enables a high-performance connection setup for the client. This method is part of the CNIC-IBS-Client class and is directly callable by users.

```APIDOC
## useHighPerformanceConnectionSetup()

### Description
Enables a high-performance connection setup for the client.

### Method
(Not specified in source, assumed to be a method call)

### Parameters
(No parameters explicitly documented)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

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

### Moniker Client - Sessionless REST-style requests

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Demonstrates how to instantiate the Moniker client using ClientFactory for sessionless REST-style requests. It shows setting credentials, enabling debug mode, making a request to get TLD information, and closing the client.

```APIDOC
## Moniker Client — Sessionless REST-style requests

The Moniker client reuses the IBS client architecture and also targets a REST-based API without session support. Instantiated via `ClientFactory` with `"registrar" => "MONIKER"`.

```php
<?php
require 'vendor/autoload.php';

$cl = \CNIC\ClientFactory::getClient(["registrar" => "MONIKER"]);
$cl->useOTESystem()
   ->setCredentials("moniker-user", "moniker-password")
   ->enableDebugMode();

$r = $cl->request(["tld" => "com"], "Domain/Tldinfo");
print_r($r->getHash());

$cl->close();
```
```

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

### Get Command

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the command used in the request as an associative array.

```APIDOC
## getCommand()

### Description
Get Command used in this request.

### Method
getCommand()

### Parameters
None

### Response Example
```json
{
  "example": "array<string|int, string>"
}
```
```

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

### Get Command Plain Text

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the command used in the request as a plain text string.

```APIDOC
## getCommandPlain()

### Description
Get Command used in this request in plain text format.

### Method
getCommandPlain()

### Parameters
None

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

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

### Get Number of Pages

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the total number of available pages for the current list query.

```APIDOC
## getNumberOfPages()

### Description
Get the number of pages available for this list query.

### Method
getNumberOfPages()

### Parameters
None

### Response Example
```json
{
  "example": "int"
}
```
```

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

### Switch Between OTE (Sandbox) and LIVE Environments

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Use useOTESystem() to switch to the sandbox environment and useLIVESystem() to switch back to the production environment. The LIVE system is the default. High-performance mode can be enabled with useHighPerformanceConnectionSetup().

```php
<?php
require 'vendor/autoload.php';

$cl = \CNIC\ClientFactory::getClient(["registrar" => "CNR"]);

$cl->useOTESystem();  // point to sandbox
echo $cl->isOTE;      // true

$cl->useLIVESystem(); // point back to production
echo $cl->isOTE;      // false

// High-performance mode: routes through local proxy (127.0.0.1 over HTTP)
$cl->useHighPerformanceConnectionSetup();

```

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

### getStatus()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Response.html

Gets the API response status code.

```APIDOC
## getStatus()

### Description
Gets the API response status code.

### Method
`public getStatus() : string`

### Return values
- **string** - The API response status code.
```

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

### Run Demo Application using npm Scripts

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/README.md

Execute the demo applications for different brands using npm scripts after setting up your credentials.

```bash
# CentralNic Reseller
npm run test-demo-cnr
# internet.bs
npm run test-demo-ibs
# Moniker
npm run test-demo-moniker
```

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

### Get Code

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the API response code.

```APIDOC
## getCode()

### Description
Get API response code.

### Return values
- int
```

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

### getRecordsCount()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Response.html

Gets the number of rows present in the current response.

```APIDOC
## getRecordsCount()

### Description
Gets the number of rows present in the current response.

### Method
`public getRecordsCount() : int`

### Return values
- **int** - The count of records in the response.
```

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

### Get Column

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves a specific column from the response by its key.

```APIDOC
## getColumn()

### Description
Get column by column name.

### Parameters
- **key** (string) - Required - column name

### Return values
- [Column](classes/CNIC-CNR-Column.html)|null
```

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

### Instantiate a Registrar Client with ClientFactory

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Use ClientFactory::getClient to create a configured client instance for a specific registrar. Specify credentials, sandbox mode, and logging preferences.

```php
<?php
require 'vendor/autoload.php';

// Create a CNR client pointed at the OTE (sandbox) system with debug logging
$cl = \CNIC\ClientFactory::getClient([
    "registrar"  => "CNR",          // "CNR", "IBS", or "MONIKER"
    "sandbox"    => true,           // use OTE (test) environment
    "username"   => "your-user",
    "password"   => "your-password",
    "logging"    => true,           // enable debug output
    "proxyserver"=> "http://proxy.example.com:8080", // optional
    "referer"    => "https://myapp.example.com",     // optional
    "ua"         => [
        "name"    => "MyApp",
        "version" => "1.0.0",
        "modules" => ["MyModule/2.0"]
    ]
]);

// $cl is a \CNIC\CNR\SessionClient instance
echo $cl->getVersion(); // "13.1.6"
echo $cl->getURL();     // OTE endpoint URL

```

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

### Get All Records

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves an array containing all record objects.

```APIDOC
## getRecords()

### Description
Get all Records.

### Method
getRecords()

### Parameters
None

### Response Example
```json
{
  "example": "array<string|int, Record>"
}
```
```

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

### Get Current Record

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the record at the current index.

```APIDOC
## getCurrentRecord()

### Description
Get Record of current record index.

### Method
getCurrentRecord()

### Parameters
None

### Response Example
```json
{
  "example": "Record|null"
}
```
```

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

### Get All Columns

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves an array containing all column objects.

```APIDOC
## getColumns()

### Description
Get List of Columns.

### Method
getColumns()

### Parameters
None

### Response Example
```json
{
  "example": "array<string|int, Column>"
}
```
```

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

### useLIVESystem

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Client.html

Switches the client to use the LIVE system. This is typically for production environments.

```APIDOC
## useLIVESystem

### Description
Switches the client to use the LIVE system.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(No parameters explicitly documented)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

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

### Set Environment Variables for Demo Application

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/README.md

Configure your credentials by setting environment variables. This is required to run the demo applications for CentralNic Reseller, internet.bs, and moniker.

```bash
# CentralNic Reseller
export RTLDEV_MW_CI_USER_CNR=<your-username>
export RTLDEV_MW_CI_USERPASSWORD_CNR=<your-password>
# internet.bs
export RTLDEV_MW_CI_USER_IBS=<your-username>
export RTLDEV_MW_CI_USERPASSWORD_IBS=<your-password>
# moniker
export RTLDEV_MW_CI_USER_MONIKER=<your-username>
export RTLDEV_MW_CI_USERPASSWORD_MONIKER=<your-password>
```

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

### Get Column Names

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves an array of all column names.

```APIDOC
## getColumnKeys()

### Description
Get Column Names.

### Method
getColumnKeys()

### Parameters
None

### Response Example
```json
{
  "example": "array<string|int, string>"
}
```
```

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

### getRecordsTotalCount()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Response.html

Gets the total count of records available for the list query.

```APIDOC
## getRecordsTotalCount()

### Description
Gets the total count of records available for the list query.

### Method
`public getRecordsTotalCount() : int`

### Return values
- **int** - The total count of available records.
```

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

### __construct()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Client.html

Initializes the CNIC-IBS-Client. It can optionally take a path to a configuration file.

```APIDOC
## __construct()

### Description
Constructor for the CNIC-IBS-Client.

### Parameters
- **path** (string) - Optional - Path to the configuration file.
```

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

### useLIVESystem()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-SessionClient.html

Configures the API client to use the LIVE system for communication. This is the default setting.

```APIDOC
## useLIVESystem()

### Description
Set LIVE System for API communication (this is the default setting).

### Method
`public useLIVESystem() : $this`

### Return values
$this
```

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

### Get Columns

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the list of all Column instances within the response.

```APIDOC
## getColumns()

### Description
Get List of Columns.

### Return values
- array<string|int, [Column](classes/CNIC-CNR-Column.html)>
```

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

### Constructor

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-SocketConfig.html

Initializes a new instance of the CNIC-CNR-SocketConfig class.

```APIDOC
## __construct()

### Description
Initializes a new instance of the CNIC-CNR-SocketConfig class.

### Method
__construct
```

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

### Get Record by Index

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves a specific record object by its index.

```APIDOC
## getRecord(int $index)

### Description
Get Record at given index.

### Method
getRecord()

### Parameters
#### Path Parameters
- **index** (int) - Required - The index of the record to retrieve.

### Response Example
```json
{
  "example": "Record|null"
}
```
```

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

### Get API Response Queuetime

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the queuetime of the API response.

```APIDOC
## getQueuetime()

### Description
Get Queuetime of API response.

### Method
getQueuetime()

### Parameters
None

### Response Example
```json
{
  "example": "float"
}
```
```

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

### Get Previous Record

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the previous record in the sequence of records.

```APIDOC
## getPreviousRecord()

### Description
Get previous record in record list.

### Method
getPreviousRecord()

### Parameters
None

### Response Example
```json
{
  "example": "Record|null"
}
```
```

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

### Get Pagination Data

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves an object containing all pagination-related data.

```APIDOC
## getPagination()

### Description
Get object containing all paging data.

### Method
getPagination()

### Parameters
None

### Response Example
```json
{
  "example": "array<string, int|null>"
}
```
```

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

### Instantiate RecordInterface with Data

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-RecordInterface.html

Use the constructor to create a RecordInterface object, passing an associative array of column data. Ensure the data array includes keys like 'DOMAIN' and 'USER'.

```php
public __construct(array<string|int, string> $data) : mixed
```

```php
$data = [ "DOMAIN" => "mydomain.com", "USER" => "test.user", // ... further column data ... ];
```

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

### Get Next Record

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the next record in the sequence of records.

```APIDOC
## getNextRecord()

### Description
Get next record in record list.

### Method
getNextRecord()

### Parameters
None

### Response Example
```json
{
  "example": "Record|null"
}
```
```

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

### __construct()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-SessionClient.html

Initializes a new instance of the SessionClient class. This is the constructor for the class.

```APIDOC
## __construct()

### Description
Constructor for the SessionClient class.

### Method
`public __construct() : mixed`

### Throws
Exception
```

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

### __construct()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-ResponseInterface.html

Constructor for the ResponseInterface. Initializes the response object with raw API response data, the command used, and an optional placeholder array.

```APIDOC
## __construct(string $raw, array<string|int, string> $cmd[, array<string|int, string> $ph = [] ])

### Description
Constructor for the ResponseInterface.

### Parameters
#### Parameters
- **$raw** (string) - Required - API plain response
- **$cmd** (array<string|int, string>) - Required - API command used within this request
- **$ph** (array<string|int, string>) - Optional - placeholder array to get vars in response description dynamically replaced
```

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

### Constructor

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Column.html

Initializes a new instance of the Column class.

```APIDOC
## __construct()

### Description
Constructor for the Column class.

### Method
__construct(string $key, array<string|int, string> $data)

### Parameters
- **key** (string) - Required - Column Name
- **data** (array<string|int, string>) - Required - Column Data
```

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

### Get Column by Name

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves a specific column object by its name.

```APIDOC
## getColumn(string $columnName)

### Description
Get column by column name.

### Method
getColumn()

### Parameters
#### Path Parameters
- **columnName** (string) - Required - The name of the column to retrieve.

### Response Example
```json
{
  "example": "Column|null"
}
```
```

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

### Constructor

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Initializes a new instance of the CNIC-CNR-Response class.

```APIDOC
## __construct()

### Description
Initializes a new instance of the CNIC-CNR-Response class.

### Method
__construct()

### Parameters
None

### Response Example
```json
{
  "example": "mixed"
}
```
```

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

### __construct

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-RecordInterface.html

Initializes a new instance of the RecordInterface with provided data.

```APIDOC
## __construct

### Description
Initializes a new instance of the RecordInterface with provided data.

### Method
`__construct(array<string|int, string> $data)`

### Parameters
#### Parameters
- **data** (array<string|int, string>) - Required - The data object for the record.

### Request Example
```php
$data = [
    "DOMAIN" => "mydomain.com",
    "USER" => "test.user",
    // ... further column data ...
];
$record = new RecordInterface($data);
```
```

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

### Initialize Panzoom - JavaScript

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/graphs/classes.html

Select an element and initialize panzoom with custom options. Ensure the target element exists in the DOM before initialization.

```javascript
var element = document.querySelector('#scene');
panzoom(element, {
  smoothScroll: false
})
```

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

### getClient()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-ClientFactory.html

Returns a client instance based on the provided configuration parameters. An optional logger instance can also be passed.

```APIDOC
## getClient()

### Description
Returns Client Instance by configuration.

### Method
`public static getClient(array<string|int, mixed> $params[, [Logger](classes/CNIC-CNR-Logger.html)|null $logger = null]) : [SessionClient](classes/CNIC-CNR-SessionClient.html)|[SessionClient](classes/CNIC-IBS-SessionClient.html)`

### Parameters
#### Path Parameters
- **params** (array<string|int, mixed>) - Required - Configuration settings
- **logger** ([Logger](classes/CNIC-CNR-Logger.html)|null) - Optional - Logger Instance

### Return values
[SessionClient](classes/CNIC-CNR-SessionClient.html)|[SessionClient](classes/CNIC-IBS-SessionClient.html)

### Throws
Exception
```

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

### Get Column Index

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves data for a specific column at a given index.

```APIDOC
## getColumnIndex()

### Description
Get Data by Column Name and Index.

### Parameters
- **colkey** (string) - Required - column name
- **index** (int) - Required - column data index

### Return values
- string|null
```

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

### Constructor

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Initializes a new instance of the CNIC CNR Response class.

```APIDOC
## __construct()

### Description
Constructor for the CNIC CNR Response class.

### Parameters
- **raw** (string) - Required - API plain response
- **cmd** (array<string|int, string>) - Optional - API command used within this request
- **ph** (array<string|int, string>) - Optional - placeholder array to get vars in response description dynamically replaced
- **context** (array<string, mixed>) - Optional - context data for the response (for use in custom loggers etc., optional, has no impact on SDK behaviour)
```

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

### Get API Response Runtime

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the runtime duration of the API response.

```APIDOC
## getRuntime()

### Description
Get Runtime of API response.

### Method
getRuntime()

### Parameters
None

### Response Example
```json
{
  "example": "float"
}
```
```

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

### Get Request URL

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the URL that was used to make the API request.

```APIDOC
## getRequestURL()

### Description
Get Request URL.

### Method
getRequestURL()

### Parameters
None

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

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

### useOTESystem()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-SessionClient.html

Configures the API client to use the OT&E (Open, Test, and Evaluation) system for communication.

```APIDOC
## useOTESystem()

### Description
Set OT&E System for API communication.

### Method
`public useOTESystem() : $this`

### Return values
$this
```

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

### Get API Response Description

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the description string of the API response.

```APIDOC
## getDescription()

### Description
Get API response description.

### Method
getDescription()

### Parameters
None

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

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

### ClientFactory::getClient

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Instantiates a registrar client. This is the recommended entry point for creating a fully configured client for CNR, IBS, or MONIKER registrars.

```APIDOC
## ClientFactory::getClient — Instantiate a registrar client

### Description
`ClientFactory::getClient()` is the recommended entry point for creating a fully configured client. It accepts a parameters array specifying the registrar identifier and optional credentials, sandbox flag, proxy, referer, user agent, and logging toggle, and returns the correct `SessionClient` instance for the chosen registrar.

### Method
`ClientFactory::getClient(array $params)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **registrar** (string) - Required - The identifier for the registrar: "CNR", "IBS", or "MONIKER".
- **sandbox** (bool) - Optional - Set to `true` to use the OTE (test) environment.
- **username** (string) - Optional - Your username for authentication.
- **password** (string) - Optional - Your password for authentication.
- **logging** (bool) - Optional - Set to `true` to enable debug output.
- **proxyserver** (string) - Optional - The URL of a proxy server to use.
- **referer** (string) - Optional - The referer URL.
- **ua** (array) - Optional - Custom user agent details.
  - **name** (string) - Optional - The name of the application.
  - **version** (string) - Optional - The version of the application.
  - **modules** (array) - Optional - An array of module names and versions.

### Request Example
```php
<?php
require 'vendor/autoload.php';

// Create a CNR client pointed at the OTE (sandbox) system with debug logging
$cl = \CNIC\ClientFactory::getClient([
    "registrar"  => "CNR",          // "CNR", "IBS", or "MONIKER"
    "sandbox"    => true,           // use OTE (test) environment
    "username"   => "your-user",
    "password"   => "your-password",
    "logging"    => true,           // enable debug output
    "proxyserver"=> "http://proxy.example.example.com:8080", // optional
    "referer"    => "https://myapp.example.com",     // optional
    "ua"         => [
        "name"    => "MyApp",
        "version" => "1.0.0",
        "modules" => ["MyModule/2.0"]
    ]
]);

// $cl is a \CNIC\CNR\SessionClient instance
echo $cl->getVersion(); // "13.1.6"
echo $cl->getURL();     // OTE endpoint URL
?>
```

### Response
#### Success Response (200)
Returns a `SessionClient` instance configured for the specified registrar.

#### Response Example
```php
// $cl is a \CNIC\CNR\SessionClient instance
echo $cl->getVersion(); // "13.1.6"
echo $cl->getURL();     // OTE endpoint URL
```
```

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

### Get Context Data

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves context data associated with the API response.

```APIDOC
## getContext()

### Description
Get context data for the response.

### Method
getContext()

### Parameters
None

### Response Example
```json
{
  "example": "array<string, mixed>"
}
```
```

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

### request()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Client.html

Perform an API request using the given command.

```APIDOC
## request()

### Description
Perform API request using the given command.

### Method
request

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response ([Response](classes/CNIC-CNR-Response.html))
API Response object.
```

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

### Get Column Index by Name

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the index of a column based on its name.

```APIDOC
## getColumnIndex(string $columnName)

### Description
Get Data by Column Name and Index.

### Method
getColumnIndex()

### Parameters
#### Path Parameters
- **columnName** (string) - Required - The name of the column.

### Response Example
```json
{
  "example": "string|null"
}
```
```

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

### getRecordsLimitation()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Response.html

Gets the limitation setting for the current list query, which is the count of requested rows.

```APIDOC
## getRecordsLimitation()

### Description
Gets the limitation setting for the current list query, which is the count of requested rows.

### Method
`public getRecordsLimitation() : int`

### Return values
- **int** - The limitation count for the query.
```

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

### Constructor

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Response.html

Initializes a new instance of the CNIC-IBS-Response class.

```APIDOC
## __construct()

### Description
Initializes a new instance of the CNIC-IBS-Response class.

### Method
__construct

### Parameters
None

### Response Example
```json
{
  "example": "mixed"
}
```
```

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

### __construct()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-RecordInterface.html

Initializes a new instance of the CNIC-RecordInterface class.

```APIDOC
## __construct()

### Description
Initializes a new instance of the CNIC-RecordInterface class.

### Method
__construct
```

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

### Get Records

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves all records from the API response. The records are returned as an associative array.

```APIDOC
## getRecords()

### Description
Get all Records from the API response.

### Method
`public getRecords() : array<string|int, [Record](classes/CNIC-CNR-Record.html)>`

### Return values
An associative array where keys are strings or integers and values are [Record](classes/CNIC-CNR-Record.html) objects.
```

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

### useOTESystem()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-SessionClient.html

Configures the client to use the OT&E (Operational Test and Evaluation) System for API communication.

```APIDOC
## useOTESystem()

### Description
Set OT&E System for API communication.

### Method
`public useOTESystem()`

### Return values
$this
```

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

### Get Records Count

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the count of rows present in the current API response.

```APIDOC
## getRecordsCount()

### Description
Get count of rows in this response.

### Method
getRecordsCount()

### Parameters
None

### Response Example
```json
{
  "example": "int"
}
```
```

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

### __construct

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Column.html

Initializes a new instance of the Column class.

```APIDOC
## __construct()

### Description
Constructor for the Column class.

### Method
`public __construct(string $key, array<string|int, string> $data)`

### Parameters
#### Path Parameters
- **key** (string) - Required - Column Name
- **data** (array<string|int, string>) - Required - Column Data
```

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

### Get Plain API Response

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the raw API response as a plain string.

```APIDOC
## getPlain()

### Description
Get Plain API response.

### Method
getPlain()

### Parameters
None

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

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

### Get Current Page Number

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the page number of the current list query.

```APIDOC
## getCurrentPageNumber()

### Description
Get Page Number of current List Query.

### Method
getCurrentPageNumber()

### Parameters
None

### Response Example
```json
{
  "example": "int|null"
}
```
```

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

### Client::useOTESystem / Client::useLIVESystem

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Toggles the API endpoint between the OTE (Operational Test Environment / sandbox) and the production LIVE system. The LIVE system is the default on instantiation.

```APIDOC
## Client::useOTESystem / Client::useLIVESystem — Switch environments

### Description
Toggles the API endpoint between the OTE (Operational Test Environment / sandbox) and the production LIVE system. The LIVE system is the default on instantiation.

### Method
`Client::useOTESystem()`
`Client::useLIVESystem()`
`Client::useHighPerformanceConnectionSetup()`

### Parameters
None

### Request Example
```php
<?php
require 'vendor/autoload.php';

$cl = \CNIC\ClientFactory::getClient(["registrar" => "CNR"]);

$cl->useOTESystem();  // point to sandbox
echo $cl->isOTE;      // true

$cl->useLIVESystem(); // point back to production
echo $cl->isOTE;      // false

// High-performance mode: routes through local proxy (127.0.0.1 over HTTP)
$cl->useHighPerformanceConnectionSetup();
?>
```

### Response
#### Success Response (200)
Returns the `Client` instance for method chaining.

#### Response Example
```php
echo $cl->isOTE;      // true (after useOTESystem())
echo $cl->isOTE;      // false (after useLIVESystem())
```
```

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

### Moniker Client Sessionless REST Request

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Demonstrates how to instantiate the Moniker client and make a sessionless REST-style request to retrieve TLD information. Ensure vendor/autoload.php is included and credentials are set.

```php
<?php
require 'vendor/autoload.php';

$cl = \CNIC\ClientFactory::getClient(["registrar" => "MONIKER"]);
$cl->useOTESystem()
   ->setCredentials("moniker-user", "moniker-password")
   ->enableDebugMode();

$r = $cl->request(["tld" => "com"], "Domain/Tldinfo");
print_r($r->getHash());

$cl->close();

```

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

### useOTESystem

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Client.html

Switches the client to use the OTE (On-The-Edge) system. This is often used for testing or staging environments.

```APIDOC
## useOTESystem

### Description
Switches the client to use the OTE system.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(No parameters explicitly documented)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

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

### Get Last Record Index

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the index of the last record in the current list query.

```APIDOC
## getLastRecordIndex()

### Description
Get last record index of the current list query.

### Method
getLastRecordIndex()

### Parameters
None

### Response Example
```json
{
  "example": "int|null"
}
```
```

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

### Client::request

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Executes a single API command against the configured backend. Accepts an associative array command and returns a `Response` object.

```APIDOC
## Client::request — Send a single API command

### Description
Executes a single API command against the configured backend. Accepts an associative array command and returns a `Response` object. Nested array parameters are automatically flattened, keys are uppercased, and IDN domain names are auto-converted to punycode for CNR.

### Method
`Client::request(array $command)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **command** (array) - Required - An associative array representing the API command and its parameters. Keys are typically uppercased.
  - **COMMAND** (string) - Required - The name of the API command.
  - **LIMIT** (int) - Optional - The maximum number of records to return.
  - **FIRST** (int) - Optional - The starting offset for records.
  - **ORDERBY** (string) - Optional - The field to order the results by.

### Request Example
```php
<?php
require 'vendor/autoload.php';

$cl = \CNIC\ClientFactory::getClient(["registrar" => "CNR"]);
$cl->useOTESystem()->setCredentials("test.user", "test-password");

// Simple command
$r = $cl->request(["COMMAND" => "StatusAccount"]);

if ($r->isSuccess()) {
    echo "Code: " . $r->getCode() . "\n";         // e.g. 200
    echo "Desc: " . $r->getDescription() . "\n";  // "Command completed successfully"
    print_r($r->getHash());                        // full response as associative array
} elseif ($r->isTmpError()) {
    echo "Temporary error: " . $r->getCode() . " " . $r->getDescription();
} elseif ($r->isError()) {
    echo "Error: " . $r->getCode() . " " . $r->getDescription();
}

// List command with parameters
$r = $cl->request([
    "COMMAND" => "QueryDomainList",
    "LIMIT"   => 10,
    "FIRST"   => 0,
    "ORDERBY" => "DOMAINNAME"
]);

$cl->close(); // release cURL handle
?>
```

### Response
#### Success Response (200)
A `Response` object containing the result of the API command.

#### Response Example
```php
// Example for StatusAccount command
// Code: 200
// Desc: Command completed successfully
// Array
// (
//     [balance] => 100.00
//     [currency] => EUR
//     [account_id] => 12345
// )

// Example for QueryDomainList command (partial)
// $r->getHash() might contain:
// Array
// (
//     [domains] => Array
//         (
//             [0] => Array
//                 (
//                     [domain] => example.com
//                     [created] => 2020-01-01
//                 )
//             [1] => Array
//                 (
//                     [domain] => another.com
//                     [created] => 2021-05-10
//                 )
//         )
//     [result] => Array
//         (
//             [count] => 2
//             [first] => 0
//             [limit] => 10
//         )
// )
```
```

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

### Get First Record Index

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the index of the first record in the current list query.

```APIDOC
## getFirstRecordIndex()

### Description
Get Index of first row in this response.

### Method
getFirstRecordIndex()

### Parameters
None

### Response Example
```json
{
  "example": "int|null"
}
```
```

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

### __construct()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Record.html

Initializes the IBS Record with provided data. The data object should contain key-value pairs representing column data.

```APIDOC
## __construct()

### Description
Initializes the IBS Record with provided data.

### Method
`__construct(array<string|int, string> $data)`

### Parameters
#### Parameters
- **data** (array<string|int, string>) - Required - data object

### Request Example
```php
$data = [
    "DOMAIN" => "mydomain.com",
    "USER" => "test.user",
    // ... further column data ...
];
$record = new CNIC_IBS_Record($data);
```
```

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

### Get API Response Code

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the integer code representing the API response status.

```APIDOC
## getCode()

### Description
Get API response code.

### Method
getCode()

### Parameters
None

### Response Example
```json
{
  "example": "int"
}
```
```

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

### __construct

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-SessionClient.html

Initializes the CNIC IBS SessionClient.

```APIDOC
## __construct()

### Description
Initializes the CNIC IBS SessionClient.

### Method
constructor

### Parameters
This method does not accept any parameters.
```

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

### Get Runtime

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the runtime of the API response, indicating how long the API took to process the request.

```APIDOC
## getRuntime()

### Description
Get Runtime of API response.

### Method
`public getRuntime() : float`

### Return values
A float representing the API response runtime in seconds.
```

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

### request()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Client.html

Performs an API request using the provided command and path. Returns a Response object.

```APIDOC
## request()

### Description
Perform API request using the given command.

### Parameters
- **cmd** (array<string|int, mixed>) - Optional - The API command to execute. Defaults to an empty array.
- **path** (string) - Optional - The specific API path for the request. Defaults to an empty string.

### Return values
- [Response](classes/CNIC-IBS-Response.html)
```

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

### Debugging and Configuration Methods

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-MONIKER-SessionClient.html

Methods for controlling debug output and configuring client settings like proxy, user agent, and URL.

```APIDOC
## disableDebugMode()

### Description
Disable Debug Output.

### Method
disableDebugMode

### Parameters
None explicitly documented.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## enableDebugMode()

### Description
Enable Debug Output to STDOUT.

### Method
enableDebugMode

### Parameters
None explicitly documented.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## getProxy()

### Description
Get proxy configuration for API communication.

### Method
getProxy

### Parameters
None explicitly documented.

### Response
#### Success Response
- string|null - The proxy configuration string or null if not set.

### Response Example
```json
{
  "example": "http://proxy.example.com:8080"
}
```

## getReferer()

### Description
Get Referer configuration for API communication.

### Method
getReferer

### Parameters
None explicitly documented.

### Response
#### Success Response
- string|null - The referer configuration string or null if not set.

### Response Example
```json
{
  "example": "http://referer.example.com"
}
```

## getURL()

### Description
Get the API connection url that is currently set.

### Method
getURL

### Parameters
None explicitly documented.

### Response
#### Success Response
- string - The API connection URL.

### Response Example
```json
{
  "example": "https://api.example.com/v1"
}
```

## getUserAgent()

### Description
Get the user agent string.

### Method
getUserAgent

### Parameters
None explicitly documented.

### Response
#### Success Response
- string - The user agent string.

### Response Example
```json
{
  "example": "MySDK/1.0"
}
```

## setProxy()

### Description
Set proxy to use for API communication.

### Method
setProxy

### Parameters
- **proxy** (string) - Required - The proxy URL to set.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## setReferer()

### Description
Set Referer to use for API communication.

### Method
setReferer

### Parameters
- **referer** (string) - Required - The referer URL to set.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## setRemoteIPAddress()

### Description
Set an Remote IP Address to be used for API communication. To be used in case you have an active ip filter setting.

### Method
setRemoteIPAddress

### Parameters
- **ipAddress** (string) - Required - The remote IP address to set.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## setURL()

### Description
Set another connection url to be used for API communication.

### Method
setURL

### Parameters
- **url** (string) - Required - The API connection URL to set.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## setUserAgent()

### Description
Set a custom user agent (for platforms that use this SDK).

### Method
setUserAgent

### Parameters
- **userAgent** (string) - Required - The user agent string to set.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## useLIVESystem()

### Description
Set LIVE System for API communication (this is the default setting).

### Method
useLIVESystem

### Parameters
None explicitly documented.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```

## useOTESystem()

### Description
Set OT&E System for API communication.

### Method
useOTESystem

### Parameters
None explicitly documented.

### Response
#### Success Response
- $this - The current instance for method chaining.

### Response Example
```json
{
  "example": "$this"
}
```
```

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

### Get Column Keys

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves a list of all available column keys, with an option to filter pagination-related keys.

```APIDOC
## getColumnKeys()

### Description
Get Column Names.

### Parameters
- **filterPaginationKeys** (bool) - Optional - strip pagination columns (defaults to false)

### Return values
- array<string|int, string>
```

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

### Configure cURL transport options (Proxy and Referer)

Source: https://context7.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/llms.txt

Set a proxy server for all API HTTP communication using `setProxy()`, or specify a `Referer` header with `setReferer()`. Pass an empty string to either method to remove the setting.

```php
<?php
require 'vendor/autoload.php';

$cl = \CNIC\ClientFactory::getClient(["registrar" => "CNR"]);

$cl->setProxy("http://proxy.corporate.net:3128");
echo $cl->getProxy(); // "http://proxy.corporate.net:3128"

$cl->setReferer("https://my-registrar-portal.example.com");
echo $cl->getReferer(); // "https://my-registrar-portal.example.com"

// Reset (remove) settings
$cl->setProxy();
$cl->setReferer();

```

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

### Get Records Limitation

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the limitation setting for the number of rows requested in the current list query.

```APIDOC
## getRecordsLimitation()

### Description
Get limit(ation) setting of the current list query This is the count of requested rows.

### Method
getRecordsLimitation()

### Parameters
None

### Response Example
```json
{
  "example": "int"
}
```
```

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

### request()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Client.html

Performs an API request using the given command and returns a Response object.

```APIDOC
## request()

### Description
Executes an API request with the specified command and returns the API response.

### Method
request

### Parameters
- **command** (mixed) - The command to be executed in the API request.

### Response
#### Success Response ([Response](classes/CNIC-IBS-Response.html))
- Returns a Response object containing the API result.
```

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

### Get Previous Page Number

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the page number for the previous set of results in a list query.

```APIDOC
## getPreviousPageNumber()

### Description
Get Page Number of previous list query.

### Method
getPreviousPageNumber()

### Parameters
None

### Response Example
```json
{
  "example": "int|null"
}
```
```

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

### __construct()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Client.html

Constructor for the CNIC-CNR-Client class.

```APIDOC
## __construct()

### Description
Constructor for the CNIC-CNR-Client class.

### Method
__construct

### Parameters
None
```

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

### Get Next Page Number

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the page number for the next set of results in a list query.

```APIDOC
## getNextPageNumber()

### Description
Get Page Number of next list query.

### Method
getNextPageNumber()

### Parameters
None

### Response Example
```json
{
  "example": "int|null"
}
```
```

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

### Get API Response as Hash

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the API response data structured as a hash (associative array).

```APIDOC
## getHash()

### Description
Get API response as Hash.

### Method
getHash()

### Parameters
None

### Response Example
```json
{
  "example": "array<string|int, mixed>"
}
```
```

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

### login()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-SessionClient.html

Logs into the CNIC-CNR service, establishing a session.

```APIDOC
## login()

### Description
Logs into the CNIC-CNR service, establishing a session. This method is part of the session management capabilities.

### Method
login

### Parameters
None explicitly documented in the provided text.

### Request Example
```php
// Example usage (assuming $sessionClient is an instance of CNIC-CNR-SessionClient)
$sessionClient->login();
```

### Response
Return values are documented as `array<string|int, string>` but specific details are not provided.
```

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

### __construct()

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-IBS-Client.html

Initializes the CNIC IBS Client. This is the constructor method for the class.

```APIDOC
## __construct()

### Description
Initializes the CNIC IBS Client.

### Method
constructor

### Parameters
This method does not appear to take any explicit parameters in the provided documentation.
```

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

### Get Total Records Count

Source: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/docs/classes/CNIC-CNR-Response.html

Retrieves the total count of records available for the list query, regardless of pagination.

```APIDOC
## getRecordsTotalCount()

### Description
Get total count of records available for the list query.

### Method
getRecordsTotalCount()

### Parameters
None

### Response Example
```json
{
  "example": "int"
}
```
```