@datenkraft/bb-fulfillment-shopify-service-ts-client/README.md

The fulfillment-shopify-service API TS Client enables you to work with the fulfillment-shopify-service API

# Backbone - fulfillment-shopify-service API TS Client

## Introduction

The fulfillment-shopify-service API TS Client enables you to work with the fulfillment-shopify-service API.

## Prerequisites

- npm

## Installation

You can use [npm](https://www.npmjs.com/) to install the package.

```bash
npm install @datenkraft/bb-fulfillment-shopify-service-ts-client
```

## Using the package

The package can be used to communicate with the fulfillment-shopify-service API.
The Client includes functionalities for every endpoint defined in the openapi.json.
The Client is auto-generated with [OpenAPITools](https://openapi-generator.tech/docs/generators/typescript-axios) using an openapi.json file.

### Initializing the Client and calling an Endpoint

```typescript
import { ConfigOptions } from '@datenkraft/bb-base-api-ts-client';
import { FulfillmentShopifyServiceClient } from '@datenkraft/bb-fulfillment-shopify-service-ts-client';
import { XxxApi } from '@datenkraft/bb-fulfillment-shopify-service-ts-client/Generated';

const configOptions: ConfigOptions = {
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  oAuthTokenHost: 'oAuthTokenHost',
  tokenTradeInPath: 'tokenTradeInPath',
  externalIdToken: 'externalIdToken',
  useExternalIdToken: true,
};

FulfillmentShopifyServiceClient.getApiConfig(configOptions).then((config) => {
  const XxxApi = new XxxApi(config);
  XxxApi.getXxxCollection().then((data) => {});
});
```

## License

This repository is available under the [MIT license](https://opensource.org/licenses/MIT).