@stedi/sdk-client-edi-translate

@stedi/sdk-client-edi-translate

Description

Stedi EDITranslate SDK for JavaScript.

The EDI Translate product is responsible for translating data between JSON and EDI formats. It uses a Stedi guide, which validates the data being translated, and is the resource which enables the API to determine how the EDI output is structured and formatted.

Installing

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

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

Getting Started

Initialize the client

First, create a new EDITranslateClient.

import { EDITranslateClient, TranslateJsonToX12Command } from "@stedi/sdk-client-edi-translate";

const client = new EDITranslateClient({
  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 TranslateJsonToX12Command.

import { EDITranslateClient, TranslateJsonToX12Command } from "@stedi/sdk-client-edi-translate";

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

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

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

TranslateJsonToX12

Command API Reference / Input / Output

TranslateX12ToJson

Command API Reference / Input / Output