1.16.5 • Published 4 months ago

@testquality/sdk v1.16.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

TestQuality SDK

TestQuality SDK is a JavaScript and TypeScript package that you can use in your node.js or browser applications to access the TestQuality API.

Further documentation of the API can be found on https://doc.testquality.com

For an example of using the API, review https://github.com/BitModern/testQualityCli

ClientSdk

The client is the root of SDK, you must create a Client object in order for the SDK functions to work.

To request a client id and secret please contact support@bitmodern.com.

const singleClient = new ClientSdk({
  // clientId is provided when registering your app
  clientId: 'your client id',

  // clientSecret is provided when registering your app
  clientSecret: 'your client secret',

  // errorHandler is convient function for capturing any backend error,
  // errors are also provided in promises
  errorHandler: (newError: HttpError) => {
    logError(newError);
  },

  // persistentStorage is required if saving the tokens is needed,
  // this may not be the case if you are using personal access tokens
  persistentStorage: new EnvStorage(),

  // logger provides way of captures any log information
  logger: logger as LoggerInterface,
});

There is a rich set of functions available for performing crud opperations with TestQuality data. Please look under the ./src/gen to learn more.

Authentication

There are two ways to authenticate, either via login or personal access token.

Personal Access Token

If a personal access token has been generated. Once client is created set the token.

  const client = new ClientSdk({...});
  client.getAuth().setToken({access_token: 'your personal access token'});

  ... call functions ...

Login

  const client = new ClientSdk({...});
  client.getAuth().login('email', 'password', true /* store token using persistentStorage */);

  ... call functions ...

Test

Before you run the tests, you need to specify a email and password in .env file. Look at the .env.example.

cp .env.example .env

Then to run tests

yarn test
1.16.3

4 months ago

1.16.5

4 months ago

1.16.4

4 months ago

1.16.2

4 months ago

1.16.1

4 months ago

1.15.7

4 months ago

1.15.6

4 months ago

1.15.4-alpha.2

5 months ago

1.15.5

4 months ago

1.15.4-alpha.1

5 months ago

1.15.3

6 months ago

1.15.2

6 months ago

1.15.1

7 months ago

1.15.0

7 months ago

1.14.11

7 months ago

1.14.10

8 months ago

1.14.9

8 months ago

1.14.8

9 months ago

1.15.8

9 months ago

1.14.7

9 months ago

1.14.1

10 months ago

1.14.5

9 months ago

1.14.4

9 months ago

1.14.3

9 months ago

1.14.2

10 months ago

1.14.6

9 months ago

1.13.2

10 months ago

1.13.1

11 months ago

1.12.32

1 year ago

1.12.31

1 year ago

1.12.34

12 months ago

1.12.33

12 months ago

1.12.36

11 months ago

1.12.35

12 months ago

1.12.30

1 year ago

1.12.29

1 year ago

1.12.28

1 year ago

1.12.27

1 year ago

1.12.26

1 year ago

1.12.25

1 year ago

1.12.24

1 year ago

1.12.23

1 year ago

1.12.22

1 year ago

1.12.21

1 year ago

1.12.20

1 year ago

1.12.19

1 year ago

1.12.19-alpha.1

1 year ago

1.12.18

1 year ago

1.12.18-alpha.1

1 year ago

1.12.3

2 years ago

1.12.2

2 years ago

1.12.7

2 years ago

1.12.6

2 years ago

1.12.5

2 years ago

1.12.4

2 years ago

1.12.9

2 years ago

1.12.8

2 years ago

1.12.10

2 years ago

1.12.16

2 years ago

1.12.15

2 years ago

1.12.17

2 years ago

1.12.12

2 years ago

1.12.11

2 years ago

1.12.14

2 years ago

1.12.13

2 years ago

1.12.1

2 years ago

1.12.0

2 years ago

1.11.2

2 years ago

1.10.4

2 years ago

1.11.0

2 years ago

1.11.1

2 years ago

1.10.3

2 years ago

1.10.2

2 years ago

1.10.1

2 years ago

1.8.2

2 years ago

1.9.0

2 years ago

1.8.4

2 years ago

1.8.3

2 years ago

1.10.0

2 years ago

1.8.1

2 years ago

1.8.0

2 years ago

1.7.2

2 years ago

1.6.0-rc.4

2 years ago

1.6.0-rc.3

2 years ago

1.6.0-rc.2

2 years ago

1.6.0-rc.1

2 years ago

1.4.36

3 years ago

1.7.1

2 years ago

1.7.0

2 years ago

1.5.2

2 years ago

1.5.1

2 years ago

1.5.0

3 years ago

1.4.33

3 years ago

1.4.35

3 years ago

1.4.34

3 years ago

1.4.31

3 years ago

1.4.32

3 years ago

1.4.30

3 years ago

1.4.28

3 years ago

1.4.29

3 years ago

1.4.22

3 years ago

1.4.24

3 years ago

1.4.23

3 years ago

1.4.26

3 years ago

1.4.25

3 years ago

1.4.27

3 years ago

1.4.20

4 years ago

1.4.21

4 years ago

1.4.17

4 years ago

1.4.19

4 years ago

1.4.18

4 years ago

1.4.16

4 years ago

1.4.15

4 years ago

1.4.11

4 years ago

1.4.13

4 years ago

1.4.12

4 years ago

1.4.14

4 years ago

1.4.10

4 years ago

1.4.9

4 years ago

1.4.8

4 years ago

1.4.7

4 years ago

1.4.6

4 years ago

1.4.5

4 years ago

1.4.4

4 years ago

1.4.3

4 years ago

1.4.2

4 years ago

1.4.1

4 years ago

1.1.1

4 years ago

1.3.3

4 years ago

1.3.2

4 years ago

1.4.0

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.0

4 years ago

1.1.0

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago