Skip to content

SenderAddressApi.md

Latest commit

 

History

History
130 lines (87 loc) · 4.08 KB

SenderAddressApi.md

File metadata and controls

130 lines (87 loc) · 4.08 KB

Toppy\Sendcloud\V2\SenderAddressApi

All URIs are relative to https://panel.sendcloud.sc/api/v2.

Method HTTP request Description
scPublicV2AddressesGetAllSenderAddresses() GET /user/addresses/sender Retrieve a list of sender addresses
scPublicV2AddressesGetSenderAddressById() GET /user/addresses/sender/{id} Retrieve a sender address

scPublicV2AddressesGetAllSenderAddresses()

scPublicV2AddressesGetAllSenderAddresses(): \Toppy\Sendcloud\V2\Model\ScPublicV2AddressesGetAllSenderAddresses200Response

Retrieve a list of sender addresses

Returns a list of all the sender addresses which have been saved to your account.

Example

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


// Configure HTTP basic authorization: HTTPBasicAuth
$config = Toppy\Sendcloud\V2\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Toppy\Sendcloud\V2\Api\SenderAddressApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Toppy\Sendcloud\V2\Model\ScPublicV2AddressesGetAllSenderAddresses200Response

Authorization

HTTPBasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

scPublicV2AddressesGetSenderAddressById()

scPublicV2AddressesGetSenderAddressById($id): \Toppy\Sendcloud\V2\Model\ScPublicV2AddressesGetSenderAddressById200Response

Retrieve a sender address

Retrieve information about a specific sender address saved to your account.

Example

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


// Configure HTTP basic authorization: HTTPBasicAuth
$config = Toppy\Sendcloud\V2\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Toppy\Sendcloud\V2\Api\SenderAddressApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 1234; // int | The sender address unique identifier

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

Parameters

Name Type Description Notes
id int The sender address unique identifier

Return type

\Toppy\Sendcloud\V2\Model\ScPublicV2AddressesGetSenderAddressById200Response

Authorization

HTTPBasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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