@stedi/sdk-client-guides

@stedi/sdk-client-guides

Description

Stedi Guides SDK for JavaScript.

Installing

To install the this package, simply type add or install @stedi/sdk-client-guides using your favorite package manager:

• npm install @stedi/sdk-client-guides
• yarn add @stedi/sdk-client-guides
• pnpm add @stedi/sdk-client-guides

Getting Started

Initialize the client

First, create a new GuidesClient.

import { GuidesClient, ChangeGuideNetworkSettingsCommand } from "@stedi/sdk-client-guides";

const client = new GuidesClient({
  region: "us",
  apiKey: "my-api-key",
});

Usage

Once the client is initiated, you may use it to send multiple commands. If you are using a custom http handler, you may call destroy() to close open connections.

Create a command by creating a new ChangeGuideNetworkSettingsCommand.

import { GuidesClient, ChangeGuideNetworkSettingsCommand } from "@stedi/sdk-client-guides";

const client = new GuidesClient({
  region: "us",
  apiKey: "my-api-key",
});

const params = {
  /** input parameters */
};

const command = new ChangeGuideNetworkSettingsCommand(params);

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by checking if it is a certain instance of exception:
   * if (error instanceof SomeServiceException) {
   *     const value = error.specialKeyInException;
   * }
   */
}

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

ChangeGuideNetworkSettings

Command API Reference / Input / Output

ChangeGuideVisibility

Command API Reference / Input / Output

CreateGuide

Command API Reference / Input / Output

CreateGuideAttachment

Command API Reference / Input / Output

CreateGuideSample

Command API Reference / Input / Output

DeleteGuide

Command API Reference / Input / Output

DeleteGuideAttachment

Command API Reference / Input / Output

DeleteGuideSample

Command API Reference / Input / Output

GetAccountConfig

Command API Reference / Input / Output

GetGuide

Command API Reference / Input / Output

GetGuidesNetwork

Command API Reference / Input / Output

GetPublicAccountConfig

Command API Reference / Input / Output

GetPublicGuide

Command API Reference / Input / Output

GetPublicSharedGuide

Command API Reference / Input / Output

GetX12TransactionSetMetadata

Command API Reference / Input / Output

ListAllPublicGuides

Command API Reference / Input / Output

ListGuideAttachments

Command API Reference / Input / Output

ListGuides

Command API Reference / Input / Output

ListGuideSamples

Command API Reference / Input / Output

ListPublicGuideAttachments

Command API Reference / Input / Output

ListPublicGuides

Command API Reference / Input / Output

ListPublicGuideSamples

Command API Reference / Input / Output

ListPublicSharedGuideAttachments

Command API Reference / Input / Output

ListPublicSharedGuideSamples

Command API Reference / Input / Output

ListX12TransactionSets

Command API Reference / Input / Output

LockGuide

Command API Reference / Input / Output

PublishGuide

Command API Reference / Input / Output

RevertGuide

Command API Reference / Input / Output

UnlockGuide

Command API Reference / Input / Output

UpdateAccountConfig

Command API Reference / Input / Output

UpdateGuide

Command API Reference / Input / Output

UpdateGuideAttachment

Command API Reference / Input / Output

UpdateGuideSample

Command API Reference / Input / Output

UpdateShareConfig

Command API Reference / Input / Output