@stedi/sdk-client-as2

@stedi/sdk-client-as2

Description

Stedi As2 SDK for JavaScript.

Installing

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

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

Getting Started

Initialize the client

First, create a new As2Client.

import { As2Client, CreateAgreementCommand } from "@stedi/sdk-client-as2";

const client = new As2Client({
  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 CreateAgreementCommand.

import { As2Client, CreateAgreementCommand } from "@stedi/sdk-client-as2";

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

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

const command = new CreateAgreementCommand(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)

CreateAgreement

Command API Reference / Input / Output

CreateConnector

Command API Reference / Input / Output

CreateProfile

Command API Reference / Input / Output

CreateServer

Command API Reference / Input / Output

DeleteAgreement

Command API Reference / Input / Output

DeleteCertificate

Command API Reference / Input / Output

DeleteConnector

Command API Reference / Input / Output

DeleteProfile

Command API Reference / Input / Output

DeleteServer

Command API Reference / Input / Output

DescribeAgreement

Command API Reference / Input / Output

DescribeCertificate

Command API Reference / Input / Output

DescribeConnector

Command API Reference / Input / Output

DescribeProfile

Command API Reference / Input / Output

DescribeServer

Command API Reference / Input / Output

ImportCertificate

Command API Reference / Input / Output

ListAgreements

Command API Reference / Input / Output

ListCertificates

Command API Reference / Input / Output

ListConnectors

Command API Reference / Input / Output

ListProfiles

Command API Reference / Input / Output

ListServers

Command API Reference / Input / Output

StartFileTransfer

Command API Reference / Input / Output

UpdateAgreement

Command API Reference / Input / Output

UpdateCertificate

Command API Reference / Input / Output

UpdateConnector

Command API Reference / Input / Output

UpdateProfile

Command API Reference / Input / Output