npm package: @stedi/sdk-client-sftp
Description: Stedi SDK for JavaScript that includes Sftp 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-sftp

[![NPM version](https://img.shields.io/npm/v/@stedi/sdk-client-sftp/latest.svg)](https://www.npmjs.com/package/@stedi/sdk-client-sftp)
[![NPM downloads](https://img.shields.io/npm/dm/@stedi/sdk-client-sftp.svg)](https://www.npmjs.com/package/@stedi/sdk-client-sftp)
[![Stability Index](https://img.shields.io/badge/dynamic/json?color=yellow&url=https://unpkg.com/@stedi/sdk-client-sftp/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-sftp/package.json&query=$.engines.node&label=nodejs)](https://nodejs.org/)

## Description

Stedi Sftp SDK for JavaScript.

Stedi SFTP provides a fully managed, serverless SFTP infrastructure. You can use the SFTP API to manage SFTP users.

> For [accessing files programmatically](/docs/legacy/sftp/accessing-files), you should use the [Stedi Buckets SDK](/docs/sdk).

## Installing

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

- `npm install @stedi/sdk-client-sftp`
- `yarn add @stedi/sdk-client-sftp`
- `pnpm add @stedi/sdk-client-sftp`

## Getting Started

### Initialize the client

First, create a new `SftpClient`.

```ts
import { SftpClient, CreateUserCommand } from "@stedi/sdk-client-sftp";

const client = new SftpClient({
  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 `CreateUserCommand`.

```ts
import { SftpClient, CreateUserCommand } from "@stedi/sdk-client-sftp";

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

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

const command = new CreateUserCommand(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>
CreateUser
</summary>

[Command API Reference](/docs/sdk/clients/sftp/docs/classes/CreateUserCommand.html) / [Input](/docs/sdk/clients/sftp/docs/interfaces/CreateUserCommandInput.html) / [Output](/docs/sdk/clients/sftp/docs/interfaces/CreateUserCommandOutput.html)

</details>
<details>
<summary>
DeleteUser
</summary>

[Command API Reference](/docs/sdk/clients/sftp/docs/classes/DeleteUserCommand.html) / [Input](/docs/sdk/clients/sftp/docs/interfaces/DeleteUserCommandInput.html) / [Output](/docs/sdk/clients/sftp/docs/interfaces/DeleteUserCommandOutput.html)

</details>
<details>
<summary>
ListUsers
</summary>

[Command API Reference](/docs/sdk/clients/sftp/docs/classes/ListUsersCommand.html) / [Input](/docs/sdk/clients/sftp/docs/interfaces/ListUsersCommandInput.html) / [Output](/docs/sdk/clients/sftp/docs/interfaces/ListUsersCommandOutput.html)

</details>
<details>
<summary>
ReadUser
</summary>

[Command API Reference](/docs/sdk/clients/sftp/docs/classes/ReadUserCommand.html) / [Input](/docs/sdk/clients/sftp/docs/interfaces/ReadUserCommandInput.html) / [Output](/docs/sdk/clients/sftp/docs/interfaces/ReadUserCommandOutput.html)

</details>
<details>
<summary>
UpdateUser
</summary>

[Command API Reference](/docs/sdk/clients/sftp/docs/classes/UpdateUserCommand.html) / [Input](/docs/sdk/clients/sftp/docs/interfaces/UpdateUserCommandInput.html) / [Output](/docs/sdk/clients/sftp/docs/interfaces/UpdateUserCommandOutput.html)

</details>