Skip to content

Latest commit

 

History

History
207 lines (143 loc) · 12.8 KB

README.md

File metadata and controls

207 lines (143 loc) · 12.8 KB

Subscriptions

(subscriptions)

Overview

REST APIs for managing subscriptions

Available Operations

activateSubscriptionNamespace

Activate an ignored namespace for a subscription

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.subscriptions.activateSubscriptionNamespace({
    subscriptionID: "<id>",
    namespaceName: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { subscriptionsActivateSubscriptionNamespace } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/subscriptionsActivateSubscriptionNamespace.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await subscriptionsActivateSubscriptionNamespace(speakeasy, {
    subscriptionID: "<id>",
    namespaceName: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useSubscriptionsActivateSubscriptionNamespaceMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/subscriptionsActivateSubscriptionNamespace.js";

Parameters

Parameter Type Required Description
request operations.ActivateSubscriptionNamespaceRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

ignoreSubscriptionNamespace

Ignored a namespace for a subscription

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.subscriptions.ignoreSubscriptionNamespace({
    subscriptionID: "<id>",
    namespaceName: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { subscriptionsIgnoreSubscriptionNamespace } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/subscriptionsIgnoreSubscriptionNamespace.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await subscriptionsIgnoreSubscriptionNamespace(speakeasy, {
    subscriptionID: "<id>",
    namespaceName: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useSubscriptionsIgnoreSubscriptionNamespaceMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/subscriptionsIgnoreSubscriptionNamespace.js";

Parameters

Parameter Type Required Description
request operations.IgnoreSubscriptionNamespaceRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*