npm package: @stedi/sdk-client-guides
Description: Stedi SDK for JavaScript that includes Guides client for Node.js, Browser and React Native
Author: Stedi Team
Latest version: 0.4.78
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

<!-- generated file, do not edit directly -->

# @stedi/sdk-client-guides

[![NPM version](https://img.shields.io/npm/v/@stedi/sdk-client-guides/latest.svg)](https://www.npmjs.com/package/@stedi/sdk-client-guides)
[![NPM downloads](https://img.shields.io/npm/dm/@stedi/sdk-client-guides.svg)](https://www.npmjs.com/package/@stedi/sdk-client-guides)
[![Stability Index](https://img.shields.io/badge/dynamic/json?color=yellow&url=https://unpkg.com/@stedi/sdk-client-guides/package.json&query=$.stability&label=stability)](https://github.com/dominictarr/stability)
[![Minimum Node.js version](https://img.shields.io/badge/dynamic/json?color=brightgreen&url=https://unpkg.com/@stedi/sdk-client-guides/package.json&query=$.engines.node&label=nodejs)](https://nodejs.org/)

## 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`.

```ts
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`.

```ts
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).

```js
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](http://www.apache.org/licenses/LICENSE-2.0),
see LICENSE for more information.

## Client Commands (Operations List)

<details>
<summary>
ChangeGuideNetworkSettings
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ChangeGuideNetworkSettingsCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ChangeGuideNetworkSettingsCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ChangeGuideNetworkSettingsCommandOutput.html)

</details>
<details>
<summary>
ChangeGuideVisibility
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ChangeGuideVisibilityCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ChangeGuideVisibilityCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ChangeGuideVisibilityCommandOutput.html)

</details>
<details>
<summary>
CreateGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/CreateGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/CreateGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/CreateGuideCommandOutput.html)

</details>
<details>
<summary>
CreateGuideAttachment
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/CreateGuideAttachmentCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/CreateGuideAttachmentCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/CreateGuideAttachmentCommandOutput.html)

</details>
<details>
<summary>
CreateGuideSample
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/CreateGuideSampleCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/CreateGuideSampleCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/CreateGuideSampleCommandOutput.html)

</details>
<details>
<summary>
DeleteGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/DeleteGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/DeleteGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/DeleteGuideCommandOutput.html)

</details>
<details>
<summary>
DeleteGuideAttachment
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/DeleteGuideAttachmentCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/DeleteGuideAttachmentCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/DeleteGuideAttachmentCommandOutput.html)

</details>
<details>
<summary>
DeleteGuideSample
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/DeleteGuideSampleCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/DeleteGuideSampleCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/DeleteGuideSampleCommandOutput.html)

</details>
<details>
<summary>
GetAccountConfig
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/GetAccountConfigCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/GetAccountConfigCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/GetAccountConfigCommandOutput.html)

</details>
<details>
<summary>
GetGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/GetGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/GetGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/GetGuideCommandOutput.html)

</details>
<details>
<summary>
GetGuidesNetwork
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/GetGuidesNetworkCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/GetGuidesNetworkCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/GetGuidesNetworkCommandOutput.html)

</details>
<details>
<summary>
GetPublicAccountConfig
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/GetPublicAccountConfigCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/GetPublicAccountConfigCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/GetPublicAccountConfigCommandOutput.html)

</details>
<details>
<summary>
GetPublicGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/GetPublicGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/GetPublicGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/GetPublicGuideCommandOutput.html)

</details>
<details>
<summary>
GetPublicSharedGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/GetPublicSharedGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/GetPublicSharedGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/GetPublicSharedGuideCommandOutput.html)

</details>
<details>
<summary>
GetX12TransactionSetMetadata
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/GetX12TransactionSetMetadataCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/GetX12TransactionSetMetadataCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/GetX12TransactionSetMetadataCommandOutput.html)

</details>
<details>
<summary>
ListAllPublicGuides
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListAllPublicGuidesCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListAllPublicGuidesCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListAllPublicGuidesCommandOutput.html)

</details>
<details>
<summary>
ListGuideAttachments
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListGuideAttachmentsCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListGuideAttachmentsCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListGuideAttachmentsCommandOutput.html)

</details>
<details>
<summary>
ListGuides
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListGuidesCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListGuidesCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListGuidesCommandOutput.html)

</details>
<details>
<summary>
ListGuideSamples
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListGuideSamplesCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListGuideSamplesCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListGuideSamplesCommandOutput.html)

</details>
<details>
<summary>
ListPublicGuideAttachments
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListPublicGuideAttachmentsCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListPublicGuideAttachmentsCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListPublicGuideAttachmentsCommandOutput.html)

</details>
<details>
<summary>
ListPublicGuides
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListPublicGuidesCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListPublicGuidesCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListPublicGuidesCommandOutput.html)

</details>
<details>
<summary>
ListPublicGuideSamples
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListPublicGuideSamplesCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListPublicGuideSamplesCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListPublicGuideSamplesCommandOutput.html)

</details>
<details>
<summary>
ListPublicSharedGuideAttachments
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListPublicSharedGuideAttachmentsCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListPublicSharedGuideAttachmentsCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListPublicSharedGuideAttachmentsCommandOutput.html)

</details>
<details>
<summary>
ListPublicSharedGuideSamples
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListPublicSharedGuideSamplesCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListPublicSharedGuideSamplesCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListPublicSharedGuideSamplesCommandOutput.html)

</details>
<details>
<summary>
ListX12TransactionSets
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/ListX12TransactionSetsCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/ListX12TransactionSetsCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/ListX12TransactionSetsCommandOutput.html)

</details>
<details>
<summary>
LockGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/LockGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/LockGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/LockGuideCommandOutput.html)

</details>
<details>
<summary>
PublishGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/PublishGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/PublishGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/PublishGuideCommandOutput.html)

</details>
<details>
<summary>
RevertGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/RevertGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/RevertGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/RevertGuideCommandOutput.html)

</details>
<details>
<summary>
UnlockGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/UnlockGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/UnlockGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/UnlockGuideCommandOutput.html)

</details>
<details>
<summary>
UpdateAccountConfig
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/UpdateAccountConfigCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/UpdateAccountConfigCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/UpdateAccountConfigCommandOutput.html)

</details>
<details>
<summary>
UpdateGuide
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/UpdateGuideCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/UpdateGuideCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/UpdateGuideCommandOutput.html)

</details>
<details>
<summary>
UpdateGuideAttachment
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/UpdateGuideAttachmentCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/UpdateGuideAttachmentCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/UpdateGuideAttachmentCommandOutput.html)

</details>
<details>
<summary>
UpdateGuideSample
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/UpdateGuideSampleCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/UpdateGuideSampleCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/UpdateGuideSampleCommandOutput.html)

</details>
<details>
<summary>
UpdateShareConfig
</summary>

[Command API Reference](/docs/sdk/clients/guides/docs/classes/UpdateShareConfigCommand.html) / [Input](/docs/sdk/clients/guides/docs/interfaces/UpdateShareConfigCommandInput.html) / [Output](/docs/sdk/clients/guides/docs/interfaces/UpdateShareConfigCommandOutput.html)

</details>