0.4.71 • Published 1 month ago

@stedi/sdk-client-as2 v0.4.71

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 month ago

@stedi/sdk-client-as2

NPM version NPM downloads Stability Index Minimum Node.js version

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)

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

Command API Reference / Input / Output

0.4.71

1 month ago

0.4.70

1 month ago

0.4.68

3 months ago

0.4.69

3 months ago

0.4.67

3 months ago

0.4.66

3 months ago

0.4.65

4 months ago

0.4.64

4 months ago

0.4.63

4 months ago

0.4.61

4 months ago

0.4.60

5 months ago

0.4.59

5 months ago

0.4.42

8 months ago

0.4.43

8 months ago

0.4.40

8 months ago

0.4.41

8 months ago

0.4.9

10 months ago

0.4.8

10 months ago

0.4.48

7 months ago

0.4.49

7 months ago

0.4.46

8 months ago

0.4.47

7 months ago

0.4.44

8 months ago

0.4.45

8 months ago

0.4.31

8 months ago

0.4.32

8 months ago

0.4.30

9 months ago

0.4.39

8 months ago

0.4.37

8 months ago

0.4.38

8 months ago

0.4.35

8 months ago

0.4.36

8 months ago

0.4.33

8 months ago

0.4.34

8 months ago

0.3.5

11 months ago

0.4.20

9 months ago

0.4.21

9 months ago

0.4.28

9 months ago

0.4.29

9 months ago

0.4.26

9 months ago

0.4.27

9 months ago

0.4.24

9 months ago

0.4.25

9 months ago

0.4.22

9 months ago

0.4.23

9 months ago

0.4.19

9 months ago

0.4.10

10 months ago

0.4.17

10 months ago

0.4.18

10 months ago

0.4.15

10 months ago

0.4.16

10 months ago

0.4.13

10 months ago

0.4.14

10 months ago

0.4.11

10 months ago

0.4.12

10 months ago

0.4.5

11 months ago

0.4.4

11 months ago

0.4.7

10 months ago

0.4.6

10 months ago

0.4.1

11 months ago

0.4.0

11 months ago

0.4.3

11 months ago

0.4.2

11 months ago

0.4.53

6 months ago

0.4.54

6 months ago

0.4.51

7 months ago

0.4.52

7 months ago

0.4.50

7 months ago

0.4.57

6 months ago

0.4.58

6 months ago

0.4.55

6 months ago

0.4.56

6 months ago

0.3.2

11 months ago

0.3.4

11 months ago

0.3.3

11 months ago

0.3.0

11 months ago

0.3.1

11 months ago

0.2.27

12 months ago

0.2.30

11 months ago

0.2.37

11 months ago

0.2.36

11 months ago

0.2.35

11 months ago

0.2.34

11 months ago

0.2.33

11 months ago

0.2.32

11 months ago

0.2.31

11 months ago

0.2.29

11 months ago

0.2.28

12 months ago

0.2.26

12 months ago

0.2.25

12 months ago

0.2.24

12 months ago

0.2.23

12 months ago

0.2.22

12 months ago

0.2.21

12 months ago

0.2.20

12 months ago

0.2.19

12 months ago

0.2.18

12 months ago

0.2.17

12 months ago

0.2.16

12 months ago

0.2.15

12 months ago

0.2.14

1 year ago

0.2.13

1 year ago

0.2.11

1 year ago

0.2.10

1 year ago

0.2.1

1 year ago

0.2.7

1 year ago

0.2.6

1 year ago

0.2.9

1 year ago

0.2.8

1 year ago

0.2.3

1 year ago

0.2.2

1 year ago

0.2.5

1 year ago

0.2.4

1 year ago

0.1.52

1 year ago

0.1.53

1 year ago

0.1.50

1 year ago

0.1.51

1 year ago

0.1.49

1 year ago

0.1.41

1 year ago

0.1.42

1 year ago

0.1.43

1 year ago

0.1.44

1 year ago

0.1.45

1 year ago

0.1.46

1 year ago

0.1.47

1 year ago

0.1.48

1 year ago

0.1.40

1 year ago

0.1.38

1 year ago

0.1.39

1 year ago

0.1.30

1 year ago

0.1.31

1 year ago

0.1.32

1 year ago

0.1.33

1 year ago

0.1.34

1 year ago

0.1.35

1 year ago

0.1.36

1 year ago

0.1.37

1 year ago

0.1.29

1 year ago

0.2.0

1 year ago

0.1.28

1 year ago

0.1.27

1 year ago

0.1.21

1 year ago

0.1.22

1 year ago

0.1.23

1 year ago

0.1.24

1 year ago

0.1.25

1 year ago

0.1.26

1 year ago

0.1.15

1 year ago

0.1.20

1 year ago

0.1.16

1 year ago

0.1.17

1 year ago

0.1.18

1 year ago

0.1.19

1 year ago

0.1.0-beta.2

1 year ago

0.1.10

1 year ago

0.0.42

1 year ago

0.0.43

1 year ago

0.1.12

1 year ago

0.0.44

1 year ago

0.1.13

1 year ago

0.0.45

1 year ago

0.1.14

1 year ago

0.0.46

1 year ago

0.1.0

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago

0.1.8

1 year ago

0.1.7

1 year ago

0.1.9

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.6

1 year ago

0.1.5

1 year ago

0.0.3-beta.1

2 years ago