@stedi/sdk-client-partners

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.

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.

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

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)

CreateAs2Connection

Command API Reference / Input / Output

CreateBucketConnection

Command API Reference / Input / Output

CreateGlobalConnection

Command API Reference / Input / Output

CreateInboundX12TransactionSettings

Command API Reference / Input / Output

CreateOutboundX12TransactionSettings

Command API Reference / Input / Output

CreateRemoteFtpConnection

Command API Reference / Input / Output

CreateStediFtpConnection

Command API Reference / Input / Output

CreateX12Partnership

Command API Reference / Input / Output

CreateX12Profile

Command API Reference / Input / Output

DeleteAs2BasicAuth

Command API Reference / Input / Output

DeleteAs2Connection

Command API Reference / Input / Output

DeleteBucketConnection

Command API Reference / Input / Output

DeleteGlobalConnection

Command API Reference / Input / Output

DeleteInboundX12TransactionSettings

Command API Reference / Input / Output

DeleteOutboundX12TransactionSettings

Command API Reference / Input / Output

DeleteRemoteFtpConnection

Command API Reference / Input / Output

DeleteStediFtpConnection

Command API Reference / Input / Output

DeleteX12Partnership

Command API Reference / Input / Output

DeleteX12Profile

Command API Reference / Input / Output

GenerateEdi

Command API Reference / Input / Output

GetAs2Connection

Command API Reference / Input / Output

GetBucketConnection

Command API Reference / Input / Output

GetConnections

Command API Reference / Input / Output

GetGlobalConnection

Command API Reference / Input / Output

GetInboundX12TransactionSettings

Command API Reference / Input / Output

GetOutboundX12ControlNumbers

Command API Reference / Input / Output

GetOutboundX12TransactionSettings

Command API Reference / Input / Output

GetRemoteFtpConnection

Command API Reference / Input / Output

GetStediFtpConnection

Command API Reference / Input / Output

GetX12Partnership

Command API Reference / Input / Output

GetX12PartnershipByInterchanges

Command API Reference / Input / Output

GetX12Profile

Command API Reference / Input / Output

GetX12ProfileByInterchange

Command API Reference / Input / Output

IncrementX12ControlNumber

Command API Reference / Input / Output

ListGlobalConnections

Command API Reference / Input / Output

ListX12Partnerships

Command API Reference / Input / Output

ListX12Profiles

Command API Reference / Input / Output

SetOutboundX12ControlNumber

Command API Reference / Input / Output

UpdateAs2BasicAuth

Command API Reference / Input / Output

UpdateAs2Connection

Command API Reference / Input / Output

UpdateAs2Credentials

Command API Reference / Input / Output

UpdateBucketConnection

Command API Reference / Input / Output

UpdateGlobalConnection

Command API Reference / Input / Output

UpdateInboundX12TransactionSettings

Command API Reference / Input / Output

UpdateOutboundX12TransactionSettings

Command API Reference / Input / Output

UpdateRemoteFtpConnection

Command API Reference / Input / Output

UpdateRemoteFtpCredentials

Command API Reference / Input / Output

UpdateRemoteFtpLastPollTime

Command API Reference / Input / Output

UpdateStediFtpConnection

Command API Reference / Input / Output

UpdateX12Partnership

Command API Reference / Input / Output

UpdateX12Profile

Command API Reference / Input / Output