Donation Alerts

https://github.com/stimulcross/donation-alerts
Admin
Donation Alerts is a TypeScript/JavaScript suite of libraries for integrating with the Donation...
Tokens:60,348
Snippets:720
Trust Score:6.1
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Complete Implementation Example

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/GETTING_STARTED.md

A full example demonstrating authentication setup, API client initialization, data retrieval, and real-time event subscription.

```typescript
import { ApiClient } from '@donation-alerts/api';
import { RefreshingAuthProvider } from '@donation-alerts/auth';
import { EventsClient } from '@donation-alerts/events';

async function main() {
  // Setup authentication
  const authProvider = new RefreshingAuthProvider({
    clientId: process.env.CLIENT_ID!,
    clientSecret: process.env.CLIENT_SECRET!,
  });

  // Add user (from OAuth flow)
  await authProvider.addUserForCode(userId, authCode);

  // Create API client
  const apiClient = new ApiClient({ authProvider });

  // Fetch user data
  const user = await apiClient.users.getUser(userId);
  console.log(`Welcome ${user.name}!`);

  // Get recent donations
  const donations = await apiClient.donations.getDonations(userId, { page: 1 });
  console.log(`Latest donation: ${donations.data[0]?.username}`);

  // Set up real-time events
  const eventsClient = new EventsClient({ apiClient });
  const userEvents = eventsClient.addUser(userId);

  await userEvents.connect();

  userEvents.subscribe('donations', (event) => {
    console.log(`🎉 ${event.username} donated ${event.amount} ${event.currency}`);
  });

  console.log('Connected to real-time events!');
}

main().catch(console.error);
```

--------------------------------

### Install SDK Packages

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/GETTING_STARTED.md

Install the core API, events, and authentication packages via npm.

```bash
npm install @donation-alerts/api @donation-alerts/events @donation-alerts/auth
```

--------------------------------

### Install @donation-alerts/auth package

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/auth.html

Commands to install the authentication package using common package managers.

```bash
npm i @donation-alerts/auth
```

```bash
yarn add @donation-alerts/auth
```

```bash
pnpm add @donation-alerts/auth
```

--------------------------------

### API Call Usage Examples

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-call.md

Examples demonstrating basic API requests and the use of query parameters.

```typescript
try {
  const data = await callDonationAlertsApi<{ id: number; name: string }>(
    { 
      url: 'user/oauth', 
      type: 'api',
      method: 'GET',
    },
    'your-access-token'
  );
  
  console.log(data);
} catch (error) {
  if (error instanceof HttpError) {
    console.error(`API error: ${error.status} ${error.statusText}`);
    console.error(`Response body: ${error.body}`);
  }
}
```

```typescript
const donations = await callDonationAlertsApi(
  {
    url: 'alerts/donations',
    type: 'api',
    method: 'GET',
    query: { page: 2, per_page: 50 },
  },
  accessToken
);
```

--------------------------------

### Configure GET and POST API Requests

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/configuration.md

Examples demonstrating how to structure options for GET and POST requests using the DonationAlertsApiCallOptions interface.

```typescript
const options: DonationAlertsApiCallOptions = {
  url: 'alerts/donations',
  type: 'api',
  method: 'GET',
  query: { page: 1, per_page: 20 },
  scope: 'oauth-donation-index',
};
```

```typescript
const options: DonationAlertsApiCallOptions = {
  url: 'custom_alert',
  type: 'api',
  method: 'POST',
  formBody: {
    header: 'Alert Header',
    message: 'Alert message',
    is_shown: '1',
  },
  scope: 'oauth-custom_alert-store',
};
```

--------------------------------

### Install Donation Alerts packages

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/events.html

Commands to install the required event and API packages using different package managers.

```bash
npm i @donation-alerts/events @donation-alerts/api
```

```bash
yarn add @donation-alerts/events @donation-alerts/api
```

```bash
pnpm add @donation-alerts/events @donation-alerts/api
```

--------------------------------

### Install Donation Alerts API Call Package

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/api-call.html

Installation commands for the package using common Node.js package managers.

```bash
npm i @donation-alerts/api-call
```

```bash
yarn add @donation-alerts/api-call
```

```bash
pnpm add @donation-alerts/api-call
```

--------------------------------

### Initialize UserEventsClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Example showing how to instantiate the UserEventsClient with required user and API client dependencies.

```typescript
import { UserEventsClient } from '@donation-alerts/events';

const userEventsClient = new UserEventsClient({
  user: userId,
  apiClient,
});
```

--------------------------------

### Install @donation-alerts/common package

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/common.html

Commands to install the common package using different package managers.

```bash
npm i @donation-alerts/common
```

```bash
yarn add @donation-alerts/common
```

```bash
pnpm add @donation-alerts/common
```

--------------------------------

### Create Merchandise TypeScript Example

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/merchandise-api.md

Demonstrates creating a new merchandise item with localized titles and pricing details.

```typescript
try {
  const merchandise = await apiClient.merchandise.createMerchandise(userId, {
    merchantIdentifier: 'merchant-123',
    merchandiseIdentifier: 'item-001',
    title: {
      en_US: 'Limited Edition T-Shirt',
      ru_RU: 'Лимитированная футболка',
    },
    currency: 'USD',
    priceUser: 15,
    priceService: 5,
    imageUrl: 'https://example.com/tshirt.jpg',
    url: 'https://shop.example.com/tshirt?user_id={user_id}',
    isActive: true,
  });
  
  console.log(`Merchandise created: ${merchandise.id}`);
} catch (error) {
  console.error('Failed to create merchandise:', error.message);
}
```

--------------------------------

### Create and use a donations paginator

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/classes/api.DonationAlertsDonationsApi.html

Examples demonstrating how to initialize a paginator and retrieve donation data either manually or via iteration.

```typescript
const paginator = apiClient.donations.createDonationsPaginator(userId);const firstPage = await paginator.getNext();console.log(firstPage.data); // donations from the first page
```

```typescript
const paginator = apiClient.donations.createDonationsPaginator(userId);for await (const pageDonations of paginator) {    console.log(pageDonations);}
```

--------------------------------

### Custom TokenBucketLimiter Implementation

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/configuration.md

Example of initializing a custom rate limiter and applying it to an ApiClient instance.

```typescript
import { TokenBucketLimiter } from '@stimulcross/rate-limiter/token-bucket';

const rateLimiter = new TokenBucketLimiter({
  capacity: 3,              // Allow bursts of 3 requests
  refillRate: 1,            // Refill 1 per second
  limitBehavior: 'enqueue',
  queue: {
    capacity: 100,
    maxWaitMs: 60_000,       // Allow longer queue
  },
});

const apiClient = new ApiClient({
  authProvider,
  rateLimiter,
});
```

--------------------------------

### Update Merchandise TypeScript Examples

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/merchandise-api.md

Examples for updating existing merchandise, including deactivating an item and modifying pricing.

```typescript
try {
  const updated = await apiClient.merchandise.updateMerchandise(
    userId,
    'merchandise-id-123',
    { isActive: false }
  );
  
  console.log(`Merchandise status: ${updated.isActive ? 'active' : 'inactive'}`);
} catch (error) {
  console.error('Failed to update merchandise:', error.message);
}
```

```typescript
try {
  const updated = await apiClient.merchandise.updateMerchandise(
    userId,
    'merchandise-id-123',
    {
      priceUser: 20,    // Increase streamer revenue share
      priceService: 10, // Increase service fee
    }
  );
  
  console.log(`New price: ${updated.priceUser + updated.priceService} total`);
} catch (error) {
  console.error('Failed to update price:', error.message);
}
```

--------------------------------

### Channel naming formats

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/centrifugo-api.md

Examples of short and full channel naming conventions based on transformChannel setting.

```text
$alerts:donation
$goals:goal
$polls:poll
```

```text
$alerts:donation:123
$goals:goal:123
$polls:poll:123
```

--------------------------------

### Send a basic custom alert

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/custom-alerts-api.md

Example of sending a simple alert with a header and message.

```typescript
try {
  const customAlert = await apiClient.customAlerts.sendCustomAlert(userId, {
    header: 'Welcome!',
    message: 'Thanks for the support!',
    shouldShow: true,
  });
  
  console.log(`Alert sent with ID: ${customAlert.id}`);
} catch (error) {
  if (error instanceof MissingScopeError) {
    console.error('Missing oauth-custom_alert-store scope');
  }
}
```

--------------------------------

### Instantiate EventsClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Example of creating a new EventsClient instance with a required apiClient.

```typescript
import { EventsClient } from '@donation-alerts/events';

const eventsClient = new EventsClient({
  apiClient,
});
```

--------------------------------

### Configure API and Auth Requests

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/interfaces/api-call.DonationAlertsApiCallOptions.html

Examples showing how to set up options for different types of DonationAlerts API endpoints.

```typescript
const options: DonationAlertsApiCallOptions = {  url: "alerts/donations",  type: "api"};
```

```typescript
const options: DonationAlertsApiCallOptions = {  url: "oauth/token",  type: "auth",  method: "POST"};
```

--------------------------------

### Async Iteration Example

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/paginator.md

Iterate through all pages using the for await...of loop.

```typescript
const paginator = apiClient.donations.createDonationsPaginator(userId);

for await (const page of paginator) {
  console.log(`Processing ${page.length} items on this page`);
  page.forEach(item => {
    // Process each item
  });
}

console.log('All pages processed');
```

--------------------------------

### Configure RefreshingAuthProvider with OAuth Flow

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/configuration.md

Setup including redirect URI and scopes, followed by token retrieval via authorization code.

```typescript
const authProvider = new RefreshingAuthProvider({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'http://localhost:3000/oauth-callback',
  scopes: [
    'oauth-user-show',
    'oauth-donation-index',
  ],
});

// In your OAuth callback handler
const token = await authProvider.addUserForCode(userId, authCode);
```

--------------------------------

### Send a custom alert with media

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/custom-alerts-api.md

Example of sending an alert that includes custom image and sound URLs.

```typescript
try {
  const customAlert = await apiClient.customAlerts.sendCustomAlert(userId, {
    externalId: 'alert-001',
    header: 'Special Event!',
    message: 'Congratulations on the achievement!',
    shouldShow: true,
    imageUrl: 'https://example.com/special-event.jpg',
    soundUrl: 'https://example.com/special-sound.mp3',
  });
  
  console.log(`Custom alert created: ${customAlert.header}`);
  console.log(`Is shown: ${customAlert.isShown}`);
} catch (error) {
  console.error('Failed to send custom alert:', error.message);
}
```

--------------------------------

### EventsClient.addUser(userId: number)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/events.html

Registers a user in the EventsClient to start listening to their events. Returns a UserEventsClient instance.

```APIDOC
## addUser(userId: number)

### Description
Registers a user in the EventsClient. If the user is already registered, an error will be thrown.

### Parameters
- **userId** (number) - Required - The ID of the user to register.

### Returns
- **UserEventsClient** - An instance for the user.
```

--------------------------------

### Send Merchandise Sale Alert Example

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/merchandise-api.md

Demonstrates how to invoke the sendMerchandiseSaleAlert method with required sale data and handle potential errors.

```typescript
try {
  const sale = await apiClient.merchandise.sendMerchandiseSaleAlert(userId, {
    externalId: `sale-${Date.now()}`,
    merchantIdentifier: 'merchant-123',
    merchandiseIdentifier: 'item-001',
    amount: 50,
    currency: 'USD',
    boughtAmount: 2,      // Customer bought 2 units
    username: 'john_doe', // Customer name
    message: 'Thanks for the purchase!',
  });
  
  console.log(`Sale alert created: ${sale.id}`);
  console.log(`Amount: ${sale.amount} ${sale.currency}`);
} catch (error) {
  console.error('Failed to send merchandise sale alert:', error.message);
}
```

--------------------------------

### Fetch paginated donations example

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/donations-api.md

Demonstrates retrieving a specific page of donations and handling potential scope errors.

```typescript
try {
  const result = await apiClient.donations.getDonations(userId, { page: 1 });
  console.log(`Donations on page 1:`, result.data.length);
  console.log(`Total donations:`, result.pagination.total);
  
  result.data.forEach(donation => {
    console.log(`${donation.username} donated ${donation.amount} ${donation.currency}`);
  });
} catch (error) {
  if (error instanceof MissingScopeError) {
    console.error('Missing oauth-donation-index scope');
  }
}
```

--------------------------------

### Fetch all donations example

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/donations-api.md

Retrieves the complete list of donations for a user; note that this method is deprecated in favor of paginators.

```typescript
try {
  const allDonations = await apiClient.donations.getAllDonations(userId);
  console.log(`Retrieved ${allDonations.length} donations in total.`);
} catch (error) {
  console.error('Failed to fetch donations:', error.message);
}
```

--------------------------------

### Individual Property Definitions

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/interfaces/api.DonationAlertsCreateMerchandiseTitleData.html

Examples of individual property definitions within the interface, showing optional and required fields.

```typescript
be_BY?: string
```

```typescript
de_DE?: string
```

```typescript
en_US: string
```

```typescript
es_ES?: string
```

```typescript
es_US?: string
```

```typescript
et_EE?: string
```

```typescript
fr_FR?: string
```

```typescript
he_HE?: string
```

```typescript
it_IT?: string
```

```typescript
ka_GE?: string
```

```typescript
kk_KZ?: string
```

```typescript
ko_KR?: string
```

```typescript
lv_LV?: string
```

```typescript
pl_PL?: string
```

```typescript
pt_BR?: string
```

```typescript
ru_RU?: string
```

```typescript
sv_SE?: string
```

```typescript
tr_TR?: string
```

```typescript
uk_UA?: string
```

```typescript
zh_CN?: string
```

--------------------------------

### Add User to EventsClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/events/README.md

Register a user to the client to start listening to their events. Throws an error if the user is already registered.

```ts
import { UserEventsClient } from '@donation-alerts/events';

const userId = 123456789;
const userEventsClient = eventsClient.addUser(userId);
```

--------------------------------

### Implement Backoff Strategy

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/errors.md

Example of using exponential backoff to retry API calls when a RateLimitError occurs.

```typescript
import { RateLimitError } from '@donation-alerts/api';

async function callWithRetry(fn, maxRetries = 3) {
  let attempt = 0;
  while (attempt < maxRetries) {
    try {
      return await fn();
    } catch (error) {
      if (error instanceof RateLimitError) {
        attempt++;
        if (attempt >= maxRetries) throw error;
        
        // Exponential backoff: 2s, 4s, 8s
        const waitMs = Math.pow(2, attempt) * 1000;
        console.log(`Rate limited. Waiting ${waitMs}ms before retry...`);
        await new Promise(resolve => setTimeout(resolve, waitMs));
      } else {
        throw error;
      }
    }
  }
}

const result = await callWithRetry(() => 
  apiClient.donations.getDonations(userId)
);
```

--------------------------------

### Perform GET request with query parameters

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-call.md

Use this method to fetch paginated data from the API by specifying query parameters.

```typescript
const result = await callDonationAlertsApi(
  {
    url: 'alerts/donations',
    type: 'api',
    method: 'GET',
    query: { page: 1, per_page: 20 },
  },
  accessToken
);
```

--------------------------------

### Initialize and Subscribe to Events with EventsClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Demonstrates setting up authentication, initializing the client, and subscribing to donation and goal events.

```typescript
import { ApiClient } from '@donation-alerts/api';
import { RefreshingAuthProvider } from '@donation-alerts/auth';
import { EventsClient } from '@donation-alerts/events';

// Set up auth
const authProvider = new RefreshingAuthProvider({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
});

await authProvider.addUserForCode(userId, authCode);

// Create API client
const apiClient = new ApiClient({ authProvider });

// Set up events
const eventsClient = new EventsClient({ apiClient });
const userClient = eventsClient.addUser(userId);

// Connect and subscribe to events
await userClient.connect();

userClient.subscribe('donations', (event) => {
  console.log(`Donation from ${event.username}: ${event.amount}`);
});

userClient.subscribe('goals', (event) => {
  console.log(`Goal progress: ${event.progress}%`);
});

// Listen for connection events
eventsClient.onConnect(id => console.log(`User ${id} connected`));
eventsClient.onDisconnect((id, reason) => console.log(`User ${id} disconnected: ${reason}`));

// Clean up
await userClient.disconnect();
await eventsClient.removeUser(userId);
```

--------------------------------

### Retrieve UserEventsClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/events/README.md

Get the UserEventsClient instance associated with a specific user.

```ts
const userId = 123456789;
const userEventsClient = eventsClient.getUserClient(userId);
```

--------------------------------

### new UserEventsClient(config)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/classes/events.UserEventsClient.html

Initializes a new instance of the UserEventsClient with the required configuration.

```APIDOC
## Constructor

### Description
Initializes a client for listening to various Donation Alerts events. This client is designed for single-user scenarios, with event subscriptions managed through Centrifugo WebSocket connections.

### Signature
`new UserEventsClient(config: UserEventsClientConfig)`

### Parameters
- **config** (UserEventsClientConfig) - Required - Configuration required for setting up the client, including user information, an API client for server communication, and optional logger options.
```

--------------------------------

### get(userId: number)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/interfaces/auth.AuthStorage.html

Retrieves an access token for the specified user ID.

```APIDOC
## get(userId: number)

### Description
Retrieves an access token for the given user ID.

### Parameters
- **userId** (number) - Required - The ID of the user for which to retrieve the token.

### Returns
- **AccessToken | null** - The retrieved token, or null if no token was found.
```

--------------------------------

### Project File Structure

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/README.md

Displays the directory layout of the documentation folder.

```text
output/
├── README.md                          (this file)
├── GETTING_STARTED.md                 Quick start guide
├── INDEX.md                           Complete index
├── types.md                           Type reference
├── configuration.md                   Configuration options
├── errors.md                          Error handling
└── api-reference/
    ├── api-client.md                 Main client
    ├── users-api.md                  User operations
    ├── donations-api.md              Donation data
    ├── custom-alerts-api.md          Custom alerts
    ├── merchandise-api.md              Merchandise
    ├── centrifugo-api.md             WebSocket channels
    ├── api-call.md                   HTTP utilities
    ├── paginator.md                  Pagination
    ├── auth-providers.md             Authentication
    └── events-client.md              Real-time events
```

--------------------------------

### Accessing pagination indices

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/paginator.md

Retrieves the start and end indices of the current page.

```typescript
public get from(): number | undefined
```

```typescript
public get to(): number | undefined
```

--------------------------------

### Connecting the client

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/events/README.md

Establishes a server connection. By default, it restores previously stored listeners.

```ts
// Reconnect and restore all listeners.
await userEventsClient.connect(true);
```

--------------------------------

### Catch RateLimitError

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/errors.md

Example of catching and handling specific rate limit error codes.

```typescript
import { RateLimitError, RateLimitErrorCode } from '@donation-alerts/api';

try {
  const result = await apiClient.callApi(userId, callOptions);
} catch (error) {
  if (error instanceof RateLimitError) {
    if (error.code === RateLimitErrorCode.LimitExceeded) {
      console.error('Rate limit exceeded. Donation Alerts allows 60 requests per minute.');
      console.error('Implement exponential backoff or queue your requests.');
    } else if (error.code === RateLimitErrorCode.QueueFull) {
      console.error('Rate limiter queue is full. Too many pending requests.');
    }
  }
}
```

--------------------------------

### connect(restoreExistingListeners?: boolean)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/classes/events.UserEventsClient.html

Establishes a connection to the Centrifugo server.

```APIDOC
## connect(restoreExistingListeners?: boolean)

### Description
Establishes a connection to the Centrifugo server.

### Parameters
- **restoreExistingListeners** (boolean) - Optional - Specifies whether existing listeners should be restored after connection. Defaults to true.

### Returns
- **Promise<void>**
```

--------------------------------

### connect()

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Establishes a WebSocket connection to the Centrifugo server.

```APIDOC
## connect()

### Description
Establishes a WebSocket connection to the Centrifugo server. Must be called before subscribing to events.

### Returns
- **Promise<void>**

### Example
```typescript
try {
  await userEventsClient.connect();
} catch (error) {
  console.error('Failed to connect:', error.message);
}
```
```

--------------------------------

### ApiClient Constructor

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-client.md

Initializes a new instance of the ApiClient with the required authentication configuration.

```APIDOC
## constructor(config: ApiConfig)

### Description
Initializes the ApiClient with an authentication provider.

### Parameters
- **config** (ApiConfig) - Required - Configuration object containing authentication provider and optional settings.

### Example
```typescript
import { ApiClient } from '@donation-alerts/api';
import { StaticAuthProvider } from '@donation-alerts/auth';

const authProvider = new StaticAuthProvider('your-client-id');
authProvider.addUser(userId, accessToken);

const apiClient = new ApiClient({
  authProvider,
});
```
```

--------------------------------

### Handle HttpError in API Calls

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-call.md

Example of catching and inspecting HttpError properties during an API request.

```typescript
try {
  const result = await callDonationAlertsApi(options, token);
} catch (error) {
  if (error instanceof HttpError) {
    console.error(`Error: ${error.status} ${error.statusText}`);
    console.error(`URL: ${error.url}`);
    console.error(`Method: ${error.method}`);
    console.error(`Body: ${error.body}`);
  }
}
```

--------------------------------

### connect()

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/classes/events.UserEventsClient.html

Establishes a connection to the Donation Alerts WebSocket server.

```APIDOC
## connect()

### Description
Establishes a connection to the Centrifugo WebSocket server to begin receiving real-time events.

### Method
`connect(): void`
```

--------------------------------

### constructor(clientId: string, scopes?: string[])

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/auth-providers.md

Creates a new instance of the non-refreshable authentication provider.

```APIDOC
## constructor(clientId: string, scopes?: string[])

### Description
Creates a new instance of the non-refreshable authentication provider.

### Parameters
- **clientId** (string) - Required - The client ID associated with your application.
- **scopes** (string[]) - Optional - An optional list of required scopes to validate registered tokens against.
```

--------------------------------

### Get User Data from Promocode

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/api.html

Use the getUserDataFromPromocode method to retrieve a user ID from an advertising promocode.

```typescript
// The ID of a user to use the access token ofconst userId = 123456789;const promocode = '<PROMOCODE>';const userData = await apiClient.merchandise.getUserDataFromPromocode(userId, promocode);
```

--------------------------------

### Initialize ApiClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-client.md

Instantiate the client using a configuration object that includes an authentication provider.

```typescript
import { ApiClient } from '@donation-alerts/api';
import { StaticAuthProvider } from '@donation-alerts/auth';

const authProvider = new StaticAuthProvider('your-client-id');
authProvider.addUser(userId, accessToken);

const apiClient = new ApiClient({
  authProvider,
});
```

--------------------------------

### Initialize Donation Alerts Clients

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/configuration.md

Configures the API and Events clients with authentication, rate limiting, and logging options. Requires environment variables for client credentials.

```typescript
import { ApiClient } from '@donation-alerts/api';
import { RefreshingAuthProvider } from '@donation-alerts/auth';
import { EventsClient } from '@donation-alerts/events';
import { TokenBucketLimiter } from '@stimulcross/rate-limiter/token-bucket';
import { LogLevel } from '@stimulcross/logger';

// Authentication
const authProvider = new RefreshingAuthProvider({
  clientId: process.env.CLIENT_ID!,
  clientSecret: process.env.CLIENT_SECRET!,
  redirectUri: 'http://localhost:3000/oauth',
  scopes: [
    'oauth-user-show',
    'oauth-donation-index',
    'oauth-custom_alert-store',
  ],
});

// Rate Limiter
const rateLimiter = new TokenBucketLimiter({
  capacity: 2,
  refillRate: 1.5,
  limitBehavior: 'enqueue',
  queue: { capacity: 50, maxWaitMs: 30_000 },
});

// API Client
const apiClient = new ApiClient({
  authProvider,
  rateLimiter,
  fetchOptions: {
    credentials: 'same-origin',
    cache: 'no-cache',
  },
  loggerOptions: {
    level: LogLevel.Debug,
  },
});

// Events Client
const eventsClient = new EventsClient({
  apiClient,
  loggerOptions: {
    level: LogLevel.Info,
  },
});

export { apiClient, authProvider, eventsClient };
```

--------------------------------

### Checking before access

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/errors.md

Shows how to verify user registration status before performing operations to avoid errors.

```typescript
import { StaticAuthProvider } from '@donation-alerts/auth';

const authProvider = new StaticAuthProvider('client-id');

if (!authProvider.hasUser(userId)) {
  console.log('Registering user...');
  authProvider.addUser(userId, accessToken);
} else {
  console.log('User already registered');
}
```

--------------------------------

### RefreshingAuthProvider Constructor

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/auth-providers.md

Initializes a new instance of the RefreshingAuthProvider with the required client credentials and configuration.

```APIDOC
## constructor(config: RefreshingAuthProviderConfig)

### Description
Creates a new instance of the auto-refreshing authentication provider.

### Parameters
- **config** (RefreshingAuthProviderConfig) - Required - Configuration object with client credentials and optional settings.
```

--------------------------------

### Initialize RefreshingAuthProvider

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/auth-providers.md

Instantiate the provider with client credentials and configuration settings.

```typescript
constructor(config: RefreshingAuthProviderConfig)
```

```typescript
interface RefreshingAuthProviderConfig {
  clientId: string;
  clientSecret: string;
  redirectUri?: string;
  scopes?: string[];
  storage?: AuthStorage;
}
```

```typescript
import { RefreshingAuthProvider } from '@donation-alerts/auth';

const authProvider = new RefreshingAuthProvider({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'http://localhost:3000/callback',
  scopes: ['oauth-user-show', 'oauth-donation-index'],
});
```

--------------------------------

### Initialize ApiClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/api.html

Instantiate the ApiClient by providing an AuthProvider instance.

```typescript
import { ApiClient } from '@donation-alerts/api';const apiClient = new ApiClient({	authProvider: authProvider,});
```

--------------------------------

### Resetting Paginator State

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/paginator.md

Use the reset method to clear the current state and start a new pagination cycle.

```typescript
const paginator = apiClient.donations.createDonationsPaginator(userId);

// First pagination cycle
console.log(`First cycle: Got ${(await paginator.getNext()).length} items`);

// Reset for a new cycle
paginator.reset();

// Second pagination cycle (starts fresh)
console.log(`Second cycle: Got ${(await paginator.getNext()).length} items`);
```

--------------------------------

### Subscribe to Real-Time Donation Events

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/GETTING_STARTED.md

Initializes the EventsClient and establishes a WebSocket connection to listen for donation events.

```typescript
import { EventsClient } from '@donation-alerts/events';

// Create events manager
const eventsClient = new EventsClient({ apiClient });

// Add user to events
const userEvents = eventsClient.addUser(userId);

// Connect to WebSocket
await userEvents.connect();

// Subscribe to donation events
userEvents.subscribe('donations', (event) => {
  console.log(`${event.username} donated ${event.amount} ${event.currency}`);
});

// Listen for connection events
eventsClient.onConnect((userId) => {
  console.log(`User ${userId} connected to events`);
});

eventsClient.onDisconnect((userId, reason) => {
  console.log(`User ${userId} disconnected: ${reason}`);
});
```

--------------------------------

### new StaticAuthProvider(clientId, scopes?)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/classes/auth.StaticAuthProvider.html

Creates a new instance of the StaticAuthProvider with the specified client ID and optional scopes.

```APIDOC
## Constructor

### Description
Creates a new instance of StaticAuthProvider.

### Signature
`new StaticAuthProvider(clientId: string, scopes?: string[])`

### Parameters
- **clientId** (string) - Required - The client ID associated with your application.
- **scopes** (string[]) - Optional - An optional list of required scopes to validate the token against.

### Returns
- **StaticAuthProvider** - A new instance of the provider.
```

--------------------------------

### Execute API Request

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-client.md

Demonstrates performing a GET request to the Donation Alerts API with error handling for HTTP failures.

```typescript
try {
  const result = await apiClient.callApi(userId, {
    url: 'user/oauth',
    type: 'api',
    method: 'GET',
    scope: 'oauth-user-show',
  });
  console.log(result);
} catch (error) {
  if (error instanceof HttpError) {
    console.error(`API Error: ${error.status} ${error.statusText}`);
  }
}
```

--------------------------------

### Implement EventsClient for Simplified Subscriptions

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/centrifugo-api.md

Use the EventsClient for automatic connection and subscription management, recommended for most applications.

```typescript
import { EventsClient } from '@donation-alerts/events';

const eventsClient = new EventsClient({ apiClient });
const userEvents = eventsClient.addUser(userId);

await userEvents.connect();
userEvents.subscribe('donations', (event) => {
  console.log(`Donation from ${event.username}: ${event.amount}`);
});
```

--------------------------------

### Create Merchandise

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-client.md

Create new merchandise items using the merchandise namespace.

```typescript
const merchandise = await apiClient.merchandise.createMerchandise(userId, {
  merchantIdentifier: 'merchant-id',
  merchandiseIdentifier: 'item-123',
  title: { en_US: 'T-Shirt' },
  currency: 'USD',
  priceUser: 10,
  priceService: 5,
});
```

--------------------------------

### UserEventsClient Constructor

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Creates a new instance of the UserEventsClient using the provided configuration.

```APIDOC
## constructor(config: UserEventsClientConfig)

### Description
Initializes a new UserEventsClient instance.

### Parameters
- **config** (UserEventsClientConfig) - Required - Configuration object containing user ID, API client, and optional logger settings.

### Example
```typescript
import { UserEventsClient } from '@donation-alerts/events';
const userEventsClient = new UserEventsClient({ user: userId, apiClient });
```
```

--------------------------------

### Raw API Call Usage

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/api-call.md

Example of using the raw API call utility to access response headers and status codes directly.

```typescript
const response = await callDonationAlertsApiRaw(
  { 
    url: 'user/oauth', 
    type: 'api',
    method: 'GET',
  },
  'your-access-token'
);

console.log(response.status); // 200
console.log(response.headers.get('content-type')); // application/json
const data = await response.json();
console.log(data);
```

--------------------------------

### Configure rate limiter options

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/api.html

Use rateLimiterOptions to manage request priority, queue wait times, and cancellation during the queuing phase.

```javascript
import { Priority, RateLimitError, RateLimitErrorCode } from '@donation-alerts/api';const abortController = new AbortController();const userId = 123456789;try {	// Rate limiter options as the last argument	const connectionToken = await apiClient.users.getSocketConnectionToken(userId, {		rateLimiterOptions: {			priority: Priority.Highest,			signal: abortController.signal,			maxWaitMs: 5000,		},	});} catch (e) {	if (e instanceof RateLimitError) {		switch (e.code) {			case RateLimitErrorCode.LIMIT_EXCEEDED:				// Handle rate limit exceeded				break;			case RateLimitErrorCode.QUEUE_OVERFLOW:				// Handle queue overflow				break;			case RateLimitErrorCode.EXPIRED:				// Handle request expired				break;			case RateLimitErrorCode.CANCELLED:				// Handle request expired				break;			default:		}	}}
```

--------------------------------

### Environment Variable Configuration

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/GETTING_STARTED.md

Store sensitive credentials in environment variables and initialize the RefreshingAuthProvider.

```bash
DONATION_ALERTS_CLIENT_ID=your-client-id
DONATION_ALERTS_CLIENT_SECRET=your-client-secret
DONATION_ALERTS_REDIRECT_URI=http://localhost:3000/oauth
```

```typescript
const authProvider = new RefreshingAuthProvider({
  clientId: process.env.DONATION_ALERTS_CLIENT_ID!,
  clientSecret: process.env.DONATION_ALERTS_CLIENT_SECRET!,
  redirectUri: process.env.DONATION_ALERTS_REDIRECT_URI,
});
```

--------------------------------

### callDonationAlertsApiRaw(options, accessToken?, fetchOptions?)

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/api-call/README.md

Executes an API request and returns the native Fetch API Response object.

```APIDOC
## callDonationAlertsApiRaw

### Description
Executes a request to the Donation Alerts API and returns the raw native Response object.

### Parameters
- **options** (DonationAlertsApiCallOptions) - Required - Configuration object for the API call.
- **accessToken** (string) - Optional - The access token for authentication.
- **fetchOptions** (DonationAlertsCallFetchOptions) - Optional - Additional options for the underlying fetch call.
```

--------------------------------

### Initialize StaticAuthProvider

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/auth-providers.md

Instantiate the provider with a client ID and optional required scopes.

```typescript
import { StaticAuthProvider } from '@donation-alerts/auth';

const authProvider = new StaticAuthProvider('your-client-id', [
  'oauth-user-show',
  'oauth-donation-index',
]);
```

--------------------------------

### select(candidates)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/interfaces/api.SelectionPolicy.html

Selects a queue from the provided candidates based on the policy implementation.

```APIDOC
### select(candidates)

#### Description
Selects a queue for the given candidates.

#### Parameters
- **candidates** (Iterable<SelectionPolicyCandidate<T>>) - Required - A set of candidates to select from.

#### Returns
- **Queue<T> | null** - The selected queue or null if no queue was selected.
```

--------------------------------

### Subscribe to multiple private channels

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/centrifugo-api.md

Demonstrates subscribing a user to a list of specific channel names and processing the returned subscription tokens.

```typescript
try {
  const channels = await apiClient.centrifugo.subscribeUserToPrivateChannels(
    userId,
    clientId,
    ['$alerts:donation', '$goals:goal', '$polls:poll']
  );
  
  channels.forEach(channel => {
    console.log(`Channel: ${channel.channel}`);
    console.log(`Token: ${channel.token}`);
    // Use token with WebSocket subscription
  });
} catch (error) {
  console.error('Failed to subscribe to channels:', error.message);
}
```

--------------------------------

### Configure RefreshingAuthProvider with Custom Storage

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/configuration.md

Use a custom storage adapter, such as Redis, for persisting tokens in multi-process environments.

```typescript
import { RedisAuthStorageAdapter } from 'your-adapter-package';

const storage = new RedisAuthStorageAdapter({
  host: 'localhost',
  port: 6379,
});

const authProvider = new RefreshingAuthProvider({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  storage,
});
```

--------------------------------

### Initialize EventsClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/events.html

Create an instance of EventsClient by providing an ApiClient configuration.

```typescript
import { ApiClient } from '@donation-alerts/api';import { EventsClient } from '@donation-alerts/events';const apiClient = new ApiClient({	// Provide your ApiClient configuration here});const eventsClient = new EventsClient({	apiClient: apiClient,});
```

--------------------------------

### Connect UserEventsClient

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/events.html

Establishes a connection to the server. By default, it restores previously stored listeners.

```typescript
// Reconnect and restore all listeners.await userEventsClient.connect(true);
```

--------------------------------

### getAllDonations

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/api/README.md

Fetches all donations for a user at once.

```APIDOC
## getAllDonations(userId: number)

### Description
Retrieves all donation records for the specified user. Warning: This may cause performance issues or crashes with large datasets.

### Parameters
- **userId** (number) - Required - The ID of the user to fetch all donations for.

### Example
```ts
const donations = await apiClient.donations.getAllDonations(123456789);
```
```

--------------------------------

### Accessing Donation Event Data

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/events/README.md

Demonstrates how to listen for donation events and log the event instance.

```ts
import { getRawData } from '@donation-alerts/common';

const donationsListener = userEventsClient.onDonation((evt: DonationAlertsDonationEvent) => {
	console.log(evt);
});
```

--------------------------------

### AuthStorage Interface Methods

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/interfaces/auth.AuthStorage.html

Methods available for implementing custom token storage solutions.

```APIDOC
## AuthStorage Interface

### Methods

- **acquireLock(userId: number): Promise<void>** (Optional) - Acquires a lock for the specified user ID.
- **clear(): Promise<void>** - Clears all stored tokens.
- **delete(userId: number): Promise<boolean>** - Deletes the token associated with the specified user ID.
- **destroy(): Promise<void>** (Optional) - Destroys the storage instance.
- **get(userId: number): Promise<AccessToken | null>** - Retrieves the access token for the specified user ID.
- **releaseLock(userId: number): Promise<void>** (Optional) - Releases the lock for the specified user ID.
- **set(userId: number, token: AccessToken, ttlMs?: number): Promise<boolean>** - Stores an access token for the specified user ID with an optional TTL.
```

--------------------------------

### getAll()

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/paginator.md

Fetches all pages and aggregates the results into a single array.

```APIDOC
## getAll()

### Description
Fetches all pages and aggregates the results into a single array. Note that this may take longer to execute for users with large volumes of data.

### Signature
`public async getAll(): Promise<T[]>`

### Throws
- `HttpError`
- `UnregisteredUserError`
- `MissingScopeError`
- `RateLimitError`
```

--------------------------------

### Event Listeners

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/classes/events.UserEventsClient.html

Available event binders for monitoring connection status.

```APIDOC
## Event Listeners

### onConnect
Fires when the client establishes a connection with the Centrifugo server.

### onDisconnect
Fires when the client disconnects from the Centrifugo server.
- **reason** (string) - The reason for disconnection.
- **reconnect** (boolean) - Indicates if a reconnection attempt will occur.
```

--------------------------------

### EventsClientConfig

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/configuration.md

Configuration interface for initializing a central events manager.

```APIDOC
## EventsClientConfig

### Description
Configuration object required for creating a central events manager instance.

### Parameters
- **apiClient** (ApiClient) - Required - The API client used to fetch connection tokens and channel info.
- **loggerOptions** (Partial<LoggerOptions>) - Optional - Logger configuration for events client.
```

--------------------------------

### run<T>(task: () => T | Promise<T>, options?: RateLimiterRunOptions): Promise<T>

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/interfaces/api.RateLimiter.html

Executes a task within the rate limiter constraints.

```APIDOC
## run<T>(task, options?)

### Description
Runs the given task under the rate limiter's control.

### Parameters
- **task** (() => T | Promise<T>) - Required - The task to run.
- **options** (RateLimiterRunOptions) - Optional - Options for running the task.

### Returns
- **Promise<T>**
```

--------------------------------

### Obtaining an Access Token

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/functions/auth.getAccessToken.html

Demonstrates the asynchronous usage of getAccessToken to retrieve an access token, including error handling for failed requests.

```typescript
try {    const accessToken = await getAccessToken(        'your-client-id',        'your-client-secret',        'http://your-redirect-uri',        'authorization-code'    );    console.log('Access Token:', accessToken.accessToken);} catch (e) {    console.error('Failed to get access token:', e);}
```

--------------------------------

### addUserForToken(tokenData: object)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/modules/auth.html

Adds a user using only token data by fetching the user internally.

```APIDOC
## addUserForToken(tokenData: object)

### Description
Adds a user using only token data. The user will be fetched internally followed by adding it to the provider.

### Parameters
- **tokenData** (object) - Required - Object containing accessToken, refreshToken, expiresIn, obtainmentTimestamp, and scopes.

### Returns
- **AccessTokenWithUserId** - Returns the registered token object.
```

--------------------------------

### UserEventsClientConfig

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/configuration.md

Configuration interface for initializing a user-specific events client.

```APIDOC
## UserEventsClientConfig

### Description
Configuration object required for creating a user-specific events client instance.

### Parameters
- **user** (UserIdResolvable) - Required - User ID or object with an id property.
- **apiClient** (ApiClient) - Required - The API client used for API calls.
- **loggerOptions** (Partial<LoggerOptions>) - Optional - Logger configuration.
```

--------------------------------

### Create and use merchandise paginator

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/merchandise-api.md

Creates a paginator instance to handle large merchandise catalogs, supporting both bulk retrieval and iterative processing.

```typescript
try {
  const paginator = apiClient.merchandise.createMerchandisePaginator(userId);
  const allMerchandise = await paginator.getAll();
  
  console.log(`Total merchandise: ${allMerchandise.length}`);
} catch (error) {
  console.error('Failed to fetch merchandise:', error.message);
}
```

```typescript
try {
  const paginator = apiClient.merchandise.createMerchandisePaginator(userId);
  
  for await (const page of paginator) {
    console.log(`Processing ${page.length} merchandise items`);
    page.forEach(item => console.log(`  - ${item.title.en_US}`));
  }
} catch (error) {
  console.error('Failed to iterate merchandise:', error.message);
}
```

--------------------------------

### Navigate Backward with getPrev

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/paginator.md

Moves the paginator to the previous page. Returns the first page if called while on page 1.

```typescript
const paginator = apiClient.donations.createDonationsPaginator(userId);

// Navigate forward
await paginator.getNext(); // Page 1
await paginator.getNext(); // Page 2
await paginator.getNext(); // Page 3

// Navigate backward
const prev = await paginator.getPrev(); // Back to page 2
console.log(`Back to page ${paginator.currentPage}`);
```

--------------------------------

### Apply Rate Limiter Options

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/api/README.md

Configure request priority, cancellation signals, and wait times using the rateLimiterOptions object.

```ts
import { Priority, RateLimitError, RateLimitErrorCode } from '@donation-alerts/api';

const abortController = new AbortController();
const userId = 123456789;

try {
	// Rate limiter options as the last argument
	const connectionToken = await apiClient.users.getSocketConnectionToken(userId, {
		rateLimiterOptions: {
			priority: Priority.Highest,
			signal: abortController.signal,
			maxWaitMs: 5000,
		},
	});
} catch (e) {
	if (e instanceof RateLimitError) {
		switch (e.code) {
			case RateLimitErrorCode.LIMIT_EXCEEDED:
				// Handle rate limit exceeded
				break;

			case RateLimitErrorCode.QUEUE_OVERFLOW:
				// Handle queue overflow
				break;

			case RateLimitErrorCode.EXPIRED:
				// Handle request expired
				break;

			case RateLimitErrorCode.CANCELLED:
				// Handle request expired
				break;

			default:
		}
	}
}
```

--------------------------------

### Register a user with addUser

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Registers a user and returns a new UserEventsClient instance.

```typescript
public addUser(user: UserIdResolvable): UserEventsClient
```

```typescript
const userClient = eventsClient.addUser(userId);
```

--------------------------------

### Connect to Event Stream

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Establishes the WebSocket connection. Must be called before subscribing to any channels.

```typescript
try {
  await userEventsClient.connect();
  console.log('Connected to event stream');
} catch (error) {
  console.error('Failed to connect:', error.message);
}
```

--------------------------------

### getNext()

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/paginator.md

Fetches the next page of data, or the first page if no pages have been loaded yet.

```APIDOC
## getNext()

### Description
Fetches the next page of data, or the first page if no pages have been loaded yet. Automatically increments the page counter.

### Signature
`public async getNext(): Promise<T[]>`

### Throws
- `HttpError`
- `UnregisteredUserError`
- `MissingScopeError`
- `RateLimitError`
```

--------------------------------

### Initialize and use DonationAlertsApiPaginator

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/api/README.md

Creates a paginator instance for flexible navigation. Provides methods for sequential, specific, and full data retrieval.

```ts
const userId = 123456789;
const paginator = apiClient.donations.createDonationsPaginator(userId);
```

```ts
const nextPage = await paginator.getNext();
const prevPage = await paginator.getPrev();
const page5 = await paginator.getPage(5);
const donations = await paginator.getAll();
```

--------------------------------

### Performing an Authenticated API Call

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/functions/api-call.callDonationAlertsApi.html

Demonstrates how to use callDonationAlertsApi to fetch user data with an access token and handle potential errors.

```typescript
try {    const data = await callDonationAlertsApi<{ id: number; name: string }>(        { url: 'user/oauth', type: 'api' },        'your-access-token'    );    console.log(data);} catch (e) {    console.error('Failed to fetch user:', e);}
```

--------------------------------

### UserEventsClient.connect

Source: https://github.com/stimulcross/donation-alerts/blob/main/packages/events/README.md

Establishes a connection to the Donation Alerts Centrifugo server.

```APIDOC
## connect(restoreExistingListeners?: boolean)

### Description
Establishes a connection to the server. If listeners were retained during a previous disconnection, this method can restore them.

### Parameters
- **restoreExistingListeners** (boolean) - Optional - When true (default), previously stored listeners are restored automatically. Pass false to skip restoring listeners.
```

--------------------------------

### getAllDonations method signature

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/donations-api.md

Defines the interface for fetching all donations for a user.

```typescript
public async getAllDonations(
  user: UserIdResolvable,
  requestOptions?: DonationAlertsApiRequestOptions,
): Promise<DonationAlertsDonation[]>
```

--------------------------------

### ReadDocumentation(pkg: DocumentationPackage)

Source: https://github.com/stimulcross/donation-alerts/blob/main/docs/functions/common.ReadDocumentation.html

A class decorator that accepts a DocumentationPackage and returns a decorator function for classes.

```APIDOC
## ReadDocumentation

### Description
A class decorator used to attach documentation metadata to a class definition.

### Signature
`ReadDocumentation(pkg: DocumentationPackage): (cls: new (...args: any[]) => any, context: ClassDecoratorContext) => void`

### Parameters
- **pkg** (DocumentationPackage) - Required - The documentation package to associate with the class.
```

--------------------------------

### Initialize EventsClient constructor

Source: https://github.com/stimulcross/donation-alerts/blob/main/_autodocs/api-reference/events-client.md

Defines the constructor signature for creating a new EventsClient instance.

```typescript
constructor(config: EventsClientConfig)
```
Tokens:
Raw