Client
in package
Authenticated entry point for every Inttegro API resource.
Construct one client with a server-side secret key, then use its typed resource properties for operations. The client owns a shared HTTP transport so timeout, telemetry, error reporting, and test-adapter configuration apply consistently to every request.
Table of Contents
Properties
- $apps : Apps
- Application creation, lookup, and update operations.
- $balances : Balances
- Current application-balance lookup operations.
- $balanceTransactions : BalanceTransactions
- Balance-ledger lookup and pagination operations.
- $broadcasts : Broadcasts
- Broadcast lookup and cancellation operations.
- $chimes : Chimes
- Notification send, lookup, scheduling, broadcast, and pagination operations.
- $customers : Customers
- Customer creation, lookup, update, and pagination operations.
- $fileLinks : FileLinks
- Public file-link creation, lookup, revocation, and download operations.
- $fileReferences : FileReferences
- File-reference reconciliation operations.
- $files : Files
- File creation, lookup, download, pagination, and deletion operations.
- $financialAccounts : FinancialAccounts
- Financial-account creation, verification, connection, and lifecycle operations.
- $keys : Keys
- Application secret-key generation, lookup, rotation, revocation, and usage operations.
- $messageTemplates : MessageTemplates
- Reusable message-template and preview operations.
- $orders : Orders
- Order creation, payment, document, fulfillment, and lifecycle operations.
- $otp : Otp
- One-time-password initiation, verification, lookup, and cancellation operations.
- $paymentMethods : PaymentMethods
- Payment-method tokenization, verification, settings, and lifecycle operations.
- $payouts : Payouts
- Payout settings, scheduling, lookup, cancellation, and pagination operations.
- $prices : Prices
- Catalog-price creation, lookup, update, activation, and pagination operations.
- $products : Products
- Product catalog and publication operations.
- $purchaseIntents : PurchaseIntents
- Purchase-intent creation, lookup, update, cancellation, and pagination operations.
- $refunds : Refunds
- Refund creation, lookup, cancellation, and pagination operations.
- $schedules : Schedules
- Scheduled-notification lookup and cancellation operations.
- $spec : Spec
- Country and payment-rail specification operations.
- $uploadRequests : UploadRequests
- Managed upload-request creation, review, fulfillment, and lifecycle operations.
Methods
- __construct() : mixed
- Creates a client and binds every resource to one authenticated transport.
Properties
$apps
Application creation, lookup, and update operations.
public
Apps
$apps
$balances
Current application-balance lookup operations.
public
Balances
$balances
$balanceTransactions
Balance-ledger lookup and pagination operations.
public
BalanceTransactions
$balanceTransactions
$broadcasts
Broadcast lookup and cancellation operations.
public
Broadcasts
$broadcasts
$chimes
Notification send, lookup, scheduling, broadcast, and pagination operations.
public
Chimes
$chimes
$customers
Customer creation, lookup, update, and pagination operations.
public
Customers
$customers
$fileLinks
Public file-link creation, lookup, revocation, and download operations.
public
FileLinks
$fileLinks
$fileReferences
File-reference reconciliation operations.
public
FileReferences
$fileReferences
$files
File creation, lookup, download, pagination, and deletion operations.
public
Files
$files
$financialAccounts
Financial-account creation, verification, connection, and lifecycle operations.
public
FinancialAccounts
$financialAccounts
$keys
Application secret-key generation, lookup, rotation, revocation, and usage operations.
public
Keys
$keys
$messageTemplates
Reusable message-template and preview operations.
public
MessageTemplates
$messageTemplates
$orders
Order creation, payment, document, fulfillment, and lifecycle operations.
public
Orders
$orders
$otp
One-time-password initiation, verification, lookup, and cancellation operations.
public
Otp
$otp
$paymentMethods
Payment-method tokenization, verification, settings, and lifecycle operations.
public
PaymentMethods
$paymentMethods
$payouts
Payout settings, scheduling, lookup, cancellation, and pagination operations.
public
Payouts
$payouts
$prices
Catalog-price creation, lookup, update, activation, and pagination operations.
public
Prices
$prices
$products
Product catalog and publication operations.
public
Products
$products
$purchaseIntents
Purchase-intent creation, lookup, update, cancellation, and pagination operations.
public
PurchaseIntents
$purchaseIntents
$refunds
Refund creation, lookup, cancellation, and pagination operations.
public
Refunds
$refunds
$schedules
Scheduled-notification lookup and cancellation operations.
public
Schedules
$schedules
$spec
Country and payment-rail specification operations.
public
Spec
$spec
$uploadRequests
Managed upload-request creation, review, fulfillment, and lifecycle operations.
public
UploadRequests
$uploadRequests
Methods
__construct()
Creates a client and binds every resource to one authenticated transport.
public
__construct(string $apiKey[, string $baseUrl = 'https://api.inttegro.com' ][, int $timeout = 30 ][, mixed $adapter = null ][, bool $telemetryEnabled = true ][, TracerProviderInterface|null $tracerProvider = null ][, TextMapPropagatorInterface|null $propagator = null ][, callable(ErrorReport): void|null $errorReporter = null ][, string $errorReportingPolicy = 'unexpected' ]) : mixed
Keep apiKey in a server-side secret store. The SDK never configures or exports telemetry by
itself; optional OpenTelemetry and error-reporting collaborators remain application-owned.
Parameters
- $apiKey : string
-
Required Inttegro secret key. Never expose it to browser or mobile code.
- $baseUrl : string = 'https://api.inttegro.com'
-
API origin; normally leave this at the production default.
- $timeout : int = 30
-
Request timeout in seconds.
- $adapter : mixed = null
-
Optional transport adapter used primarily for deterministic tests.
- $telemetryEnabled : bool = true
-
Whether to create vendor-neutral OpenTelemetry spans.
- $tracerProvider : TracerProviderInterface|null = null
-
Application-owned tracer provider.
- $propagator : TextMapPropagatorInterface|null = null
-
Application-owned trace propagator.
- $errorReporter : callable(ErrorReport): void|null = null
-
Privacy-safe terminal-failure callback.
- $errorReportingPolicy : string = 'unexpected'
-
Either
unexpectedorall.