Skip to content

Files

subscriptions

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jan 10, 2025

Subscriptions

(subscriptions)

Overview

REST APIs for managing subscriptions

Available Operations

activateSubscriptionNamespace

Activate an ignored namespace for a subscription

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$sdk = SpeakeasyClientSDK\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            apiKey: '<YOUR_API_KEY_HERE>',
        )
    )
    ->build();

$request = new Operations\ActivateSubscriptionNamespaceRequest(
    namespaceName: '<value>',
    subscriptionID: '<id>',
);

$response = $sdk->subscriptions->activateSubscriptionNamespace(
    request: $request
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\ActivateSubscriptionNamespaceRequest ✔️ The request object to use for the request.

Response

?Operations\ActivateSubscriptionNamespaceResponse

Errors

Error Type Status Code Content Type
Errorors\Error 4XX application/json
Errorors\SDKException 5XX */*

ignoreSubscriptionNamespace

Ignored a namespace for a subscription

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$sdk = SpeakeasyClientSDK\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            apiKey: '<YOUR_API_KEY_HERE>',
        )
    )
    ->build();

$request = new Operations\IgnoreSubscriptionNamespaceRequest(
    namespaceName: '<value>',
    subscriptionID: '<id>',
);

$response = $sdk->subscriptions->ignoreSubscriptionNamespace(
    request: $request
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\IgnoreSubscriptionNamespaceRequest ✔️ The request object to use for the request.

Response

?Operations\IgnoreSubscriptionNamespaceResponse

Errors

Error Type Status Code Content Type
Errorors\Error 4XX application/json
Errorors\SDKException 5XX */*