@flashcoffee/fcbraze/README.md

flashcoffee braze sdk

# fcbraze

## Installation
```sh
$ yarn add @flashcoffee/fcbraze
```

## Setup
Set required environment variable for credentials

```
BRAZE_BASE_URL=https://some-rest-endpoint.braze.com
BRAZE_API_KEY=your-api-key-here
```

## Usage
```typescript
import FCBraze from '@flashcoffee/fcbraze';

await FCBraze.triggerCampaign();
```

OR

```typescript
import {BrazeService} from '@flashcoffee/fcbraze';

@Injectable()
export class SomeService {
  constructor(
    private readonly braze: BrazeService,
  ) {}

  public async someMethod() {
    await this.braze.triggerCampaign();
  }
}

@Module({
  providers: [SomeService, BrazeService],
})
export class SomeModule {}
```

## Available API
```typescript
braze.api; // axios instance, example: braze.api.post('url', payload)
braze.trackUser();
braze.patchUserAttributes();
braze.patchUserEvents();
braze.patchUserPurchases();
braze.triggerCampaign();
braze.triggerCanvas();
braze.exportUser();
```