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

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

## Description

Stedi Partners SDK for JavaScript.

## Installing

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

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

## Getting Started

### Initialize the client

First, create a new `PartnersClient`.

```ts
import { PartnersClient, CreateAs2ConnectionCommand } from "@stedi/sdk-client-partners";

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

```ts
import { PartnersClient, CreateAs2ConnectionCommand } from "@stedi/sdk-client-partners";

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

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

const command = new CreateAs2ConnectionCommand(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>
CreateAs2Connection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateAs2ConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateAs2ConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateAs2ConnectionCommandOutput.html)

</details>
<details>
<summary>
CreateBucketConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateBucketConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateBucketConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateBucketConnectionCommandOutput.html)

</details>
<details>
<summary>
CreateGlobalConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateGlobalConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateGlobalConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateGlobalConnectionCommandOutput.html)

</details>
<details>
<summary>
CreateInboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateInboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateInboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateInboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
CreateOutboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateOutboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateOutboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateOutboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
CreateRemoteFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateRemoteFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateRemoteFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateRemoteFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
CreateStediFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateStediFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateStediFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateStediFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
CreateX12Partnership
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateX12PartnershipCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateX12PartnershipCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateX12PartnershipCommandOutput.html)

</details>
<details>
<summary>
CreateX12Profile
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/CreateX12ProfileCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/CreateX12ProfileCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/CreateX12ProfileCommandOutput.html)

</details>
<details>
<summary>
DeleteAs2BasicAuth
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteAs2BasicAuthCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteAs2BasicAuthCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteAs2BasicAuthCommandOutput.html)

</details>
<details>
<summary>
DeleteAs2Connection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteAs2ConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteAs2ConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteAs2ConnectionCommandOutput.html)

</details>
<details>
<summary>
DeleteBucketConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteBucketConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteBucketConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteBucketConnectionCommandOutput.html)

</details>
<details>
<summary>
DeleteGlobalConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteGlobalConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteGlobalConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteGlobalConnectionCommandOutput.html)

</details>
<details>
<summary>
DeleteInboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteInboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteInboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteInboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
DeleteOutboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteOutboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteOutboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteOutboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
DeleteRemoteFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteRemoteFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteRemoteFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteRemoteFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
DeleteStediFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteStediFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteStediFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteStediFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
DeleteX12Partnership
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteX12PartnershipCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteX12PartnershipCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteX12PartnershipCommandOutput.html)

</details>
<details>
<summary>
DeleteX12Profile
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/DeleteX12ProfileCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/DeleteX12ProfileCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/DeleteX12ProfileCommandOutput.html)

</details>
<details>
<summary>
GenerateEdi
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GenerateEdiCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GenerateEdiCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GenerateEdiCommandOutput.html)

</details>
<details>
<summary>
GetAs2Connection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetAs2ConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetAs2ConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetAs2ConnectionCommandOutput.html)

</details>
<details>
<summary>
GetBucketConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetBucketConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetBucketConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetBucketConnectionCommandOutput.html)

</details>
<details>
<summary>
GetConnections
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetConnectionsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetConnectionsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetConnectionsCommandOutput.html)

</details>
<details>
<summary>
GetGlobalConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetGlobalConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetGlobalConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetGlobalConnectionCommandOutput.html)

</details>
<details>
<summary>
GetInboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetInboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetInboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetInboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
GetOutboundX12ControlNumbers
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetOutboundX12ControlNumbersCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetOutboundX12ControlNumbersCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetOutboundX12ControlNumbersCommandOutput.html)

</details>
<details>
<summary>
GetOutboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetOutboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetOutboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetOutboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
GetRemoteFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetRemoteFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetRemoteFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetRemoteFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
GetStediFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetStediFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetStediFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetStediFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
GetX12Partnership
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetX12PartnershipCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetX12PartnershipCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetX12PartnershipCommandOutput.html)

</details>
<details>
<summary>
GetX12PartnershipByInterchanges
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetX12PartnershipByInterchangesCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetX12PartnershipByInterchangesCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetX12PartnershipByInterchangesCommandOutput.html)

</details>
<details>
<summary>
GetX12Profile
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetX12ProfileCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetX12ProfileCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetX12ProfileCommandOutput.html)

</details>
<details>
<summary>
GetX12ProfileByInterchange
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/GetX12ProfileByInterchangeCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/GetX12ProfileByInterchangeCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/GetX12ProfileByInterchangeCommandOutput.html)

</details>
<details>
<summary>
IncrementX12ControlNumber
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/IncrementX12ControlNumberCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/IncrementX12ControlNumberCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/IncrementX12ControlNumberCommandOutput.html)

</details>
<details>
<summary>
ListGlobalConnections
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/ListGlobalConnectionsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/ListGlobalConnectionsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/ListGlobalConnectionsCommandOutput.html)

</details>
<details>
<summary>
ListX12Partnerships
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/ListX12PartnershipsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/ListX12PartnershipsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/ListX12PartnershipsCommandOutput.html)

</details>
<details>
<summary>
ListX12Profiles
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/ListX12ProfilesCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/ListX12ProfilesCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/ListX12ProfilesCommandOutput.html)

</details>
<details>
<summary>
SetOutboundX12ControlNumber
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/SetOutboundX12ControlNumberCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/SetOutboundX12ControlNumberCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/SetOutboundX12ControlNumberCommandOutput.html)

</details>
<details>
<summary>
UpdateAs2BasicAuth
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateAs2BasicAuthCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateAs2BasicAuthCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateAs2BasicAuthCommandOutput.html)

</details>
<details>
<summary>
UpdateAs2Connection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateAs2ConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateAs2ConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateAs2ConnectionCommandOutput.html)

</details>
<details>
<summary>
UpdateAs2Credentials
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateAs2CredentialsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateAs2CredentialsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateAs2CredentialsCommandOutput.html)

</details>
<details>
<summary>
UpdateBucketConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateBucketConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateBucketConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateBucketConnectionCommandOutput.html)

</details>
<details>
<summary>
UpdateGlobalConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateGlobalConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateGlobalConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateGlobalConnectionCommandOutput.html)

</details>
<details>
<summary>
UpdateInboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateInboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateInboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateInboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
UpdateOutboundX12TransactionSettings
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateOutboundX12TransactionSettingsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateOutboundX12TransactionSettingsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateOutboundX12TransactionSettingsCommandOutput.html)

</details>
<details>
<summary>
UpdateRemoteFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateRemoteFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateRemoteFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateRemoteFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
UpdateRemoteFtpCredentials
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateRemoteFtpCredentialsCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateRemoteFtpCredentialsCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateRemoteFtpCredentialsCommandOutput.html)

</details>
<details>
<summary>
UpdateRemoteFtpLastPollTime
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateRemoteFtpLastPollTimeCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateRemoteFtpLastPollTimeCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateRemoteFtpLastPollTimeCommandOutput.html)

</details>
<details>
<summary>
UpdateStediFtpConnection
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateStediFtpConnectionCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateStediFtpConnectionCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateStediFtpConnectionCommandOutput.html)

</details>
<details>
<summary>
UpdateX12Partnership
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateX12PartnershipCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateX12PartnershipCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateX12PartnershipCommandOutput.html)

</details>
<details>
<summary>
UpdateX12Profile
</summary>

[Command API Reference](/docs/sdk/clients/partners/docs/classes/UpdateX12ProfileCommand.html) / [Input](/docs/sdk/clients/partners/docs/interfaces/UpdateX12ProfileCommandInput.html) / [Output](/docs/sdk/clients/partners/docs/interfaces/UpdateX12ProfileCommandOutput.html)

</details>