Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.79 KB

CreditsApi.md

File metadata and controls

67 lines (43 loc) · 1.79 KB

OpenAPI\Client\CreditsApi

All URIs are relative to https://api.thesmsworks.co.uk/v1, except if the operation defines another base path.

Method HTTP request Description
creditsBalanceGet() GET /credits/balance

creditsBalanceGet()

creditsBalanceGet(): \OpenAPI\Client\Model\CreditsResponse

Returns the number of credits currently available on the account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CreditsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->creditsBalanceGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreditsApi->creditsBalanceGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\CreditsResponse

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]