Xdev Platform XDK

https://github.com/xdevplatform/xdk-typescript
Admin
A comprehensive TypeScript SDK for the X API with support for multiple authentication methods,...
Tokens:40,154
Snippets:492
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### get Usage

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of a simple GET request.

```typescript
const response = await httpClient.get('https://api.x.com/2/users/783214', {
  'Authorization': 'Bearer token'
});
```

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

### Get User by Username Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Usage example for fetching a user profile and accessing specific fields from the response.

```typescript
const response = await client.users.getByUsername('XDevelopers', {
  userfields: ['id', 'name', 'username', 'created_at', 'public_metrics']
});

console.log(response.data?.username);
console.log(response.data?.public_metrics?.followers_count);
```

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

### Get Authenticated User Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Usage example for fetching the authenticated user's profile data.

```typescript
const response = await client.users.getMe({
  userfields: ['id', 'name', 'username', 'public_metrics']
});

console.log('Authenticated as:', response.data?.username);
```

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

### Create Post Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Demonstrates creating a post with text content.

```typescript
const tweet = await client.posts.create({
  text: 'Hello from X API! 🚀'
});

console.log('Created post:', tweet.data?.id);
```

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

### Performing API Requests

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/client-core.md

Examples of performing GET and POST requests with custom options and headers.

```typescript
// GET request
const user = await client.request('GET', '/2/users/by/username/XDevelopers', {
  timeout: 5000
});

// POST request with body
const tweet = await client.request('POST', '/2/tweets', {
  body: JSON.stringify({ text: 'Hello World!' })
});

// Request with custom headers
const response = await client.request('GET', '/2/users/783214', {
  headers: { 'X-Custom-Header': 'value' }
});
```

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

### createHeaders Usage

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of initializing headers and adding custom fields.

```typescript
import { httpClient } from '@xdevplatform/xdk';

const headers = httpClient.createHeaders({
  'Authorization': 'Bearer token',
  'Content-Type': 'application/json'
});

headers.set('X-Custom-Header', 'value');
```

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

### Initialize Client with Authentication

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/client-core.md

Examples of initializing the Client using different authentication strategies.

```typescript
import { Client, type ClientConfig } from '@xdevplatform/xdk';

// Bearer token authentication
const client = new Client({
  bearerToken: 'your-bearer-token'
});

// OAuth2 authentication
const client = new Client({
  accessToken: 'your-access-token'
});

// OAuth1 authentication
import { OAuth1, type OAuth1Config } from '@xdevplatform/xdk';
const oauth1 = new OAuth1({
  apiKey: 'consumer-key',
  apiSecret: 'consumer-secret',
  accessToken: 'access-token',
  accessTokenSecret: 'access-token-secret',
  callback: 'https://example.com/callback'
});
const client = new Client({ oauth1 });
```

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

### request Usage

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of performing a GET request with custom options and timeout.

```typescript
import { httpClient } from '@xdevplatform/xdk';

const response = await httpClient.request('https://api.x.com/2/users/by/username/username', {
  method: 'GET',
  headers: { 'Authorization': 'Bearer token' },
  timeout: 5000
});

const data = await response.json();
```

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

### Install XDK via Package Managers

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Commands to install the XDK package using common JavaScript package managers.

```bash
npm install @xdevplatform/xdk
```

```bash
yarn add @xdevplatform/xdk
```

```bash
pnpm add @xdevplatform/xdk
```

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

### Request Parameter Conventions

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/types-and-configuration.md

Examples of parameter formatting and additional HTTP request options.

```typescript
{ userFields: ['id', 'name', 'username'] }
```

```typescript
{ 'user.fields': ['id', 'name', 'username'] }
```

```typescript
{ 
  userfields: ['id', 'name'],
  requestOptions: { timeout: 5000, headers: { 'X-Custom': 'value' } }
}
```

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

### Define Users Module Structure

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/modules-overview.md

Specific file structure example for the Users module.

```text
src/users/
  ├── client.ts         # UsersClient class
  ├── models.ts         # GetByUsernameOptions, GetByUsernameResponse, etc.
  ├── index.ts          # Exports UsersClient and types
  └── stream_client.ts  # User-related streaming (optional)
```

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

### Initialize Client and Fetch User

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/README.md

Basic setup for the XDK client using a bearer token to retrieve user information.

```typescript
import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'token' });
const user = await client.users.getByUsername('XDevelopers');
```

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

### Initialize Paginator

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/pagination-and-streaming.md

Example of initializing a Paginator instance with a custom fetch function.

```typescript
import { Paginator, type PaginatedResponse, Schemas } from '@xdevplatform/xdk';
import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'your-token' });

const followers = new Paginator(
  async (token?: string): Promise<PaginatedResponse<Schemas.User>> => {
    const res = await client.users.getFollowers('783214', {
      maxResults: 100,
      paginationToken: token,
      userfields: ['id', 'name', 'username']
    });
    return {
      data: res.data ?? [],
      meta: res.meta,
      includes: res.includes,
      errors: res.errors
    };
  }
);
```

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

### Initialize and Configure Stream Endpoints

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/pagination-and-streaming.md

Examples of initializing different stream types and managing filter rules.

```typescript
// Sample stream
const sampleStream = await client.stream.postsSample({
  tweetfields: ['public_metrics'],
  expansions: ['author_id']
});

// Filter stream with rules
const filterStream = await client.stream.postsFilter({
  tweetfields: ['text', 'created_at'],
  userfields: ['username'],
  backfill_minutes: 5
});

// Search stream
const searchStream = await client.stream.postsSearch({
  query: 'lang:en has:geo',
  tweetfields: ['geo']
});

// Add rules to filter stream
await filterStream.addRule({
  value: 'from:xdev',
  tag: 'xdev_tweets'
});

const rules = await filterStream.getRules();
console.log('Active rules:', rules);
```

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

### get

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Executes an HTTP GET request.

```APIDOC
## get(url: string, headers?: Record<string, string>)

### Description
Make an HTTP GET request.

### Parameters
- **url** (string) - Required - URL to fetch
- **headers** (Record<string, string>) - Optional - Request headers

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

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

### generateTimestamp Usage Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of generating a Unix timestamp string.

```typescript
import { CryptoUtils } from '@xdevplatform/xdk';

const timestamp = CryptoUtils.generateTimestamp();
console.log('Timestamp:', timestamp); // e.g., '1673456789'
```

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

### Implement PostPaginator

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/pagination-and-streaming.md

Example of using PostPaginator to fetch a timeline with pagination support.

```typescript
import { PostPaginator, Schemas } from '@xdevplatform/xdk';

const timeline = new PostPaginator(
  async (token?: string) => {
    const res = await client.posts.getTimeline({
      maxResults: 100,
      paginationToken: token,
      tweetfields: ['created_at', 'public_metrics']
    });
    return {
      data: res.data ?? [],
      meta: res.meta,
      includes: res.includes,
      errors: res.errors
    };
  }
);

// Access with all Paginator methods
await timeline.fetchNext();
console.log(timeline.posts); // posts property (alias for items)
```

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

### post Usage

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of a POST request with a JSON body.

```typescript
const response = await httpClient.post(
  'https://api.x.com/2/tweets',
  JSON.stringify({ text: 'Hello' }),
  {
    'Authorization': 'Bearer token',
    'Content-Type': 'application/json'
  }
);
```

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

### Implement UserPaginator

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/pagination-and-streaming.md

Example of using UserPaginator to fetch followers with pagination support.

```typescript
import { UserPaginator, Schemas } from '@xdevplatform/xdk';

const followers = new UserPaginator(
  async (token?: string) => {
    const res = await client.users.getFollowers('783214', {
      maxResults: 100,
      paginationToken: token,
      userfields: ['id', 'name', 'username']
    });
    return {
      data: res.data ?? [],
      meta: res.meta,
      includes: res.includes,
      errors: res.errors
    };
  }
);

// Access with all Paginator methods
await followers.fetchNext();
console.log(followers.users); // users property (alias for items)
```

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

### generateCodeVerifier Usage Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of generating a code verifier for OAuth2 PKCE flows.

```typescript
import { CryptoUtils } from '@xdevplatform/xdk';

const codeVerifier = CryptoUtils.generateCodeVerifier();
console.log('Code verifier:', codeVerifier);

// Use with OAuth2
const codeChallenge = await CryptoUtils.generateCodeChallenge(codeVerifier);
```

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

### hmacSha1 Usage Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of generating an HMAC-SHA1 signature.

```typescript
import { CryptoUtils } from '@xdevplatform/xdk';

const signature = await CryptoUtils.hmacSha1(
  'secret_key',
  'message_to_sign'
);
console.log('Signature:', signature);
```

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

### Perform Requests with RequestOptions

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/client-core.md

Examples demonstrating how to use RequestOptions for timeouts, custom headers, and request cancellation.

```typescript
const client = new Client({ bearerToken: 'token' });

// Request with timeout override
const response = await client.request('GET', '/2/users/by/username/username', {
  timeout: 10000
});

// Request with custom headers
await client.request('POST', '/2/tweets', {
  body: JSON.stringify({ text: 'Hello' }),
  headers: { 'X-Custom-Header': 'value' }
});

// Request with cancellation support
const controller = new AbortController();
setTimeout(() => controller.abort(), 5000);

try {
  await client.request('GET', '/2/tweets/123', {
    signal: controller.signal
  });
} catch (error) {
  if (error.name === 'AbortError') {
    console.log('Request was cancelled');
  }
}
```

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

### generateCodeChallenge Usage Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of generating a code challenge from a verifier for OAuth2.

```typescript
import { CryptoUtils, generateCodeVerifier } from '@xdevplatform/xdk';

const codeVerifier = generateCodeVerifier();
const codeChallenge = await CryptoUtils.generateCodeChallenge(codeVerifier);

// Use with OAuth2
oauth2.setPkceParameters(codeVerifier, codeChallenge);
const authUrl = await oauth2.getAuthorizationUrl();
```

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

### generateNonce Usage Example

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example of generating random nonces of varying lengths.

```typescript
import { CryptoUtils } from '@xdevplatform/xdk';

const nonce = CryptoUtils.generateNonce();
console.log('Nonce:', nonce); // e.g., 'a1b2c3d4...'

const longNonce = CryptoUtils.generateNonce(64);
```

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

### Configure OAuth2 Authentication

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/README.md

Setup for OAuth2 flow including code verifier and challenge generation for PKCE.

```typescript
import { OAuth2, generateCodeVerifier, generateCodeChallenge } from '@xdevplatform/xdk';

const oauth2 = new OAuth2({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'https://example.com/callback'
});

const verifier = generateCodeVerifier();
const challenge = await generateCodeChallenge(verifier);
const authUrl = await oauth2.getAuthorizationUrl();
```

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

### Initialize Client with Bearer Token

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Basic setup for read-only operations using a bearer token.

```typescript
import { 
  Client, 
  type ClientConfig,
  type UsersGetByUsernameResponse
} from '@xdevplatform/xdk';

const config: ClientConfig = { bearerToken: 'your-bearer-token' };

const client: Client = new Client(config);

async function main(): Promise<void> {
  const userResponse: UsersGetByUsernameResponse = await client.users.getByUsername('XDevelopers');
  const username: string = userResponse.data?.username!;
  console.log(username);
}

main();
```

```typescript
import { 
  Client, 
  type ClientConfig,
  type Users
} from '@xdevplatform/xdk';

const config: ClientConfig = { bearerToken: 'your-bearer-token' };

const client: Client = new Client(config);

async function main(): Promise<void> {
  const userResponse: Users.GetByUsernameResponse = await client.users.getByUsername('XDevelopers');
  const username: string = userResponse.data?.username!;
  console.log(username);
}

main();
```

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

### get Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Signature for making a GET request.

```typescript
async get(url: string, headers?: Record<string, string>): Promise<HttpResponse>
```

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

### Manage and Consume Filtered Stream

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Example demonstrating how to initialize a filtered stream, add rules, and process matching events.

```typescript
const stream = await client.stream.postsFilter({
  tweetfields: ['id', 'text', 'author_id'],
  backfill_minutes: 5
});

await stream.addRule({
  value: 'from:xdev',
  tag: 'xdev_tweets'
});

stream.on('data', (event) => {
  const rule = event.matching_rules?.[0];
  console.log(`Matched rule: ${rule?.tag}`);
});
```

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

### httpClient.get(url, headers)

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Performs an HTTP GET request using the global httpClient instance.

```APIDOC
## GET httpClient

### Description
Performs an HTTP GET request to the specified URL with provided headers. The client automatically handles environment-specific fetch implementations and timeout logic.

### Method
GET

### Parameters
#### Path Parameters
- **url** (string) - Required - The target URL for the request.

#### Request Headers
- **headers** (object) - Optional - Key-value pairs representing request headers, such as Authorization.

### Request Example
```typescript
import { httpClient } from '@xdevplatform/xdk';

const response = await httpClient.get('https://api.x.com/2/users/783214', {
  'Authorization': 'Bearer token'
});
```

### Response
#### Success Response (200)
- **response** (Response) - Returns a standard Response object compatible with the Fetch API.
```

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

### Handle HTTP response

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Example demonstrating how to process an HttpResponse, including status checking, parsing JSON or text, and accessing headers.

```typescript
const response = await httpClient.get('https://api.x.com/2/users/783214', {
  'Authorization': 'Bearer token'
});

// Check status
if (response.ok) {
  const data = await response.json();
  console.log('User:', data);
} else {
  const errorText = await response.text();
  console.error(`Error: ${response.status} ${response.statusText}`);
  console.error('Body:', errorText);
}

// Access headers
console.log('Rate limit:', response.headers.get('x-rate-limit-remaining'));
```

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

### Consume Sampled Posts Stream

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Example usage for connecting to the sample stream and handling incoming data events.

```typescript
const stream = await client.stream.postsSample({
  tweetfields: ['id', 'text', 'created_at'],
  expansions: ['author_id']
});

stream.on('data', (event) => {
  console.log(event.data?.text);
});
```

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

### Get User Bookmarks Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for retrieving a user's bookmarks.

```typescript
client.posts.getBookmarks(options?: GetBookmarksOptions): Promise<GetBookmarksResponse>
```

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

### new Client(config: ClientConfig)

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/client-core.md

Initializes a new instance of the X API Client. This is the primary entry point for interacting with the API.

```APIDOC
## new Client(config: ClientConfig)

### Description
Initializes a new instance of the X API Client. This is the primary entry point for interacting with the API.

### Parameters
- **config** (ClientConfig) - Required - Configuration object containing authentication and client options.

### Returns
- **Client** (instance) - A new instance of the Client class.

### Example
```typescript
import { Client } from '@xdevplatform/xdk';

const client = new Client({
  bearerToken: 'your-bearer-token'
});
```
```

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

### Start Complete OAuth1 Flow

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

A convenience method to initiate the OAuth1 flow and retrieve the authorization URL in one step.

```typescript
const oauth1 = new OAuth1({
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  callback: 'https://example.com/callback'
});

// Start the flow and get authorization URL
const authUrl = await oauth1.startOAuthFlow(true);
console.log('Redirect user to:', authUrl);
```

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

### Initialize Client with Environment Variables

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/types-and-configuration.md

Configure the SDK client by reading credentials and settings from environment variables.

```typescript
import { Client } from '@xdevplatform/xdk';

// Environment variables (typically in .env file)
const config = {
  bearerToken: process.env.X_API_BEARER_TOKEN,
  baseUrl: process.env.X_API_BASE_URL || 'https://api.x.com',
  timeout: parseInt(process.env.X_API_TIMEOUT || '30000'),
};

const client = new Client(config);
```

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

### Initialize and Use Users Client

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/modules-overview.md

Demonstrates initializing the main client and accessing the users module with type inference.

```typescript
import { Client, type Users } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'token' });

// Access users client
const user = await client.users.getByUsername('username', {
  userfields: ['id', 'name', 'username']
});

// Type inference works with module namespacing
const typedUser: Users.GetByUsernameResponse = user;
```

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

### Connect to real-time sampled posts

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Initializes the client and sets up event listeners for data, errors, and closure events.

```typescript
import { Client } from '@xdevplatform/xdk';

const client: Client = new Client({ bearerToken: 'your-bearer-token' });

// 1% sampled public posts
const stream = await client.stream.postsSample({
  tweetfields: ['id','text','created_at'],
  expansions: ['author_id'],
  userfields: ['id','username','name']
});

// Listen to events
stream.on('data', (event) => {
  // event is the parsed JSON line (data/includes/matching_rules)
  console.log('New data:', event);
});

stream.on('error', (e) => console.error('Stream error:', e));
stream.on('close', () => console.log('Stream closed'));
```

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

### Get Multiple Posts by IDs Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for retrieving multiple posts by an array of IDs.

```typescript
client.posts.getByIds(ids: string[], options?: GetByIdsOptions): Promise<GetByIdsResponse>
```

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

### Get User Information in TypeScript

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/examples-and-patterns.md

Retrieves specific user fields by username. Ensure the client is initialized before calling the users service.

```typescript
// Get user by username
const user = await client.users.getByUsername('xdev', {
  userfields: [
    'id',
    'name',
    'username',
    'created_at',
    'description',
    'location',
    'public_metrics',
    'verified'
  ]
});

const userData = user.data;
console.log(`Name: ${userData?.name}`);
console.log(`Username: @${userData?.username}`);
console.log(`Created: ${userData?.created_at}`);
console.log(`Followers: ${userData?.public_metrics?.followers_count}`);
```

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

### Initialize XDK Client

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Basic initialization of the XDK client using a bearer token for authentication.

```javascript
import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'your-token' });
```

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

### HttpClient GET Request Usage

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Perform a GET request using the global httpClient instance with authorization headers.

```typescript
import { httpClient } from '@xdevplatform/xdk';

const response = await httpClient.get('https://api.x.com/2/users/783214', {
  'Authorization': 'Bearer token'
});

const data = await response.json();
```

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

### Create and Manage Lists in TypeScript

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/examples-and-patterns.md

Demonstrates creating a list, adding members, paginating through list members, and pinning a list.

```typescript
// Create a list
const list = await client.lists.create({
  name: 'Breaking News Sources',
  description: 'News outlets I follow for breaking news'
});

console.log('Created list:', list.data?.id);

// Add members
const member1 = await client.lists.addMember(
  list.data!.id,
  newsOutletUserId1
);
console.log('Added member:', member1.data?.member);

// Get list members
const members = new UserPaginator(async (token) => {
  const res = await client.lists.getListMembers(list.data!.id, {
    maxResults: 100,
    paginationToken: token
  });
  return {
    data: res.data ?? [],
    meta: res.meta
  };
});

for await (const member of members) {
  console.log(`- @${member.username}`);
}

// Pin list
const pinResult = await client.lists.pinList(list.data!.id);
console.log('List pinned:', pinResult.data?.pinned);
```

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

### Get Conversations

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Retrieves a list of direct message conversations.

```typescript
client.directMessages.getConversations(options?: GetConversationsOptions): Promise<GetConversationsResponse>
```

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

### Managing Real-time Streams

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/README.md

Shows how to initialize a stream, add filtering rules, and listen for incoming data events.

```typescript
const stream = await client.stream.postsFilter();
await stream.addRule({ value: 'from:xdev', tag: 'xdev' });
stream.on('data', (event) => { /* process */ });
```

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

### Define Module File Structure

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/modules-overview.md

Standard directory layout for all SDK modules.

```text
src/{module}/
  ├── client.ts         # Main client class with all methods
  ├── models.ts         # Request/Response types and interfaces
  ├── index.ts          # Module exports
  ├── stream_client.ts  # Streaming support (if applicable)
  └── event_driven_stream.ts  # Event handling (if applicable)
```

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

### Initialize OAuth2 Instance

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

Create an OAuth2 instance by providing the required client credentials, redirect URI, and requested scopes.

```typescript
import { OAuth2, type OAuth2Config } from '@xdevplatform/xdk';

const oauth2Config: OAuth2Config = {
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'https://example.com/callback',
  scope: ['tweet.read', 'users.read', 'offline.access']
};

const oauth2 = new OAuth2(oauth2Config);
```

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

### Get Users Missing Fields

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Retrieves a list of users that are missing specific fields.

```typescript
client.compliance.getUsersMissingFields(options: GetUsersMissingFieldsOptions): Promise<GetUsersMissingFieldsResponse>
```

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

### Get Tweets Missing Fields

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Retrieves a list of tweets that are missing specific fields.

```typescript
client.compliance.getTweetsMissingFields(options: GetTweetsMissingFieldsOptions): Promise<GetTweetsMissingFieldsResponse>
```

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

### Initialize XDK Client

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/README.md

Requires the @xdevplatform/xdk package. Ensure the X_API_BEARER_TOKEN environment variable is set.

```typescript
import { Client } from '@xdevplatform/xdk';

const client = new Client({
  bearerToken: process.env.X_API_BEARER_TOKEN
});
```

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

### Get Space by ID

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Retrieves details for a specific space using its unique identifier.

```typescript
client.spaces.getById(id: string, options?: GetByIdOptions): Promise<GetByIdResponse>
```

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

### Get Conversation Messages

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Fetches messages within a specific conversation identified by its ID.

```typescript
client.directMessages.getConversationMessages(conversationId: string, options?: GetConversationMessagesOptions): Promise<GetConversationMessagesResponse>
```

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

### client.lists.create

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Creates a new list with the specified name, description, and privacy settings.

```APIDOC
## client.lists.create(request: CreateListRequest, options?: CreateListOptions)

### Description
Creates a new list. Requires OAuth1 or OAuth2 User Context.

### Parameters
- **request** (CreateListRequest) - Required - Object containing:
  - **name** (string) - Required - List name
  - **description** (string) - Optional - List description
  - **private** (boolean) - Optional - Is list private
- **options** (CreateListOptions) - Optional - Additional configuration options
```

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

### client.request(method, path, options)

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/client-core.md

Executes an HTTP request using the configured client instance with optional request-specific configurations.

```APIDOC
## client.request(method, path, options)

### Description
Performs an HTTP request to the specified path using the provided HTTP method and optional request configurations.

### Parameters
- **method** (string) - Required - The HTTP method (e.g., 'GET', 'POST').
- **path** (string) - Required - The API endpoint path.
- **options** (RequestOptions) - Optional - Configuration object for the request.

### RequestOptions Fields
- **timeout** (number) - Optional - Request timeout in milliseconds.
- **headers** (Record<string, string>) - Optional - Additional headers to include.
- **signal** (AbortSignal) - Optional - AbortSignal for request cancellation.
- **body** (string) - Optional - Request body as a JSON string.
- **raw** (boolean) - Optional - If true, returns the raw HTTP wrapper.
- **security** (Array<Record<string, string[]>>) - Optional - Security requirements for auth selection.
- **binary** (boolean) - Optional - Indicates if the response is binary data.

### Example
```typescript
const response = await client.request('POST', '/2/tweets', {
  body: JSON.stringify({ text: 'Hello' }),
  headers: { 'X-Custom-Header': 'value' }
});
```
```

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

### Configure Environment Variables

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Store credentials in a .env file and access them via process.env.

```bash
# .env
X_API_BEARER_TOKEN=your-bearer-token
X_API_CLIENT_ID=your-client-id
X_API_CLIENT_SECRET=your-client-secret
```

```typescript
import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: process.env.X_API_BEARER_TOKEN });
```

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

### Get User Mentions Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for retrieving mentions for a user.

```typescript
client.posts.getMentions(options: GetMentionsOptions): Promise<GetMentionsResponse>
```

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

### Initialize OAuth1 Handler

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

Demonstrates how to instantiate the OAuth1 handler using a configuration object.

```typescript
import { OAuth1, type OAuth1Config } from '@xdevplatform/xdk';

const oauth1Config: OAuth1Config = {
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  callback: 'https://example.com/callback',
  accessToken: 'user-access-token',
  accessTokenSecret: 'user-access-token-secret'
};

const oauth1 = new OAuth1(oauth1Config);
```

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

### Get Muted Users Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving a paginated list of muted users.

```typescript
client.users.getMuting(options?: GetMutingOptions): Promise<GetMutingResponse>
```

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

### Get Blocked Users Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving a paginated list of blocked users.

```typescript
client.users.getBlocking(options?: GetBlockingOptions): Promise<GetBlockingResponse>
```

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

### Get Authenticated User Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving the profile of the currently authenticated user.

```typescript
client.users.getMe(options?: GetMeOptions): Promise<GetMeResponse>
```

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

### Accessing Domain Clients

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/README.md

Demonstrates how a single client instance provides access to various domain-specific operations.

```typescript
client.users      // User operations
client.posts      // Tweet operations
client.lists      // List management
client.stream     // Real-time streaming
client.media      // Media upload
// ... 18 more domain clients
```

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

### Get User by ID Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving a user profile by their unique ID.

```typescript
client.users.getById(id: string, options?: GetByIdOptions): Promise<GetByIdResponse>
```

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

### client.posts.create

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Creates a new post with the specified content and metadata.

```APIDOC
## client.posts.create

### Description
Creates a new post. Requires OAuth1 or OAuth2 User Context.

### Method
SDK Method

### Parameters
- **request** (CreatePostRequest) - Required - Post content and metadata (text, media, reply, quote_tweet_id, reply_settings)
- **options** (CreatePostOptions) - Optional - HTTP request options
```

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

### Get User by Username Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving a user profile by their Twitter username.

```typescript
client.users.getByUsername(username: string, options?: GetByUsernameOptions): Promise<GetByUsernameResponse>
```

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

### Accessing API Endpoints via Client

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Demonstrates the pattern for initializing the client and invoking domain-specific operations.

```typescript
const client = new Client({ bearerToken: 'token' });

// Access domain client
const response = await client.{domain}.{operation}(parameters, options);

// Example
const user = await client.users.getByUsername('username', { userfields: ['id', 'name'] });
```

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

### Get User Reposts Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for retrieving a user's reposts.

```typescript
client.posts.getReposts(options: GetRepostsOptions): Promise<GetRepostsResponse>
```

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

### Get User Timeline Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for retrieving a user's timeline.

```typescript
client.posts.getTimeline(options: GetTimelineOptions): Promise<GetTimelineResponse>
```

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

### Upload Media and Create Posts with MediaClient

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/modules-overview.md

Upload media files to obtain an ID, then reference that ID when creating a post.

```typescript
const mediaResponse = await client.media.upload({
  media_data: base64EncodedImage
});

const tweet = await client.posts.create({
  text: 'Check out this image!',
  media: {
    media_ids: [mediaResponse.data.media_id]
  }
});
```

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

### Get Post by ID Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for retrieving a single post by its ID.

```typescript
client.posts.getById(id: string, options?: GetByIdOptions): Promise<GetByIdResponse>
```

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

### OAuth2 Constructor

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

Initializes a new OAuth2 authentication handler instance using the provided configuration.

```APIDOC
## OAuth2 Constructor

### Description
Initializes a new instance of the OAuth2 authentication handler for user context authentication.

### Signature
`new OAuth2(config: OAuth2Config)`

### Parameters
- **config** (OAuth2Config) - Required - OAuth2 configuration object

### Example
```typescript
import { OAuth2, type OAuth2Config } from '@xdevplatform/xdk';

const oauth2Config: OAuth2Config = {
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'https://example.com/callback',
  scope: ['tweet.read', 'users.read', 'offline.access']
};

const oauth2 = new OAuth2(oauth2Config);
```
```

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

### Get User Followers Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving a list of followers for a specific user ID.

```typescript
client.users.getFollowers(id: string, options?: GetFollowersOptions): Promise<GetFollowersResponse>
```

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

### Create, Like, and Repost a Post

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/examples-and-patterns.md

Demonstrates creating a text post followed by liking and reposting it using the post ID.

```typescript
// Create a post
const tweet = await client.posts.create({
  text: 'Hello from the X API SDK! 🚀'
});

console.log('Created tweet:', tweet.data?.id);

// Like the post
const likeResult = await client.posts.likePost(tweet.data!.id);
console.log('Liked:', likeResult.data?.liked);

// Repost
const repostResult = await client.posts.repostPost(tweet.data!.id);
console.log('Reposted:', repostResult.data?.retweeted);
```

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

### Manage Post Bookmarks in TypeScript

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/examples-and-patterns.md

Shows how to bookmark a post, retrieve a paginated list of bookmarks, and remove a bookmark.

```typescript
// Bookmark a post
const bookmark = await client.posts.createBookmark(tweetId);
console.log('Bookmarked:', bookmark.data?.bookmarked);

// Get bookmarks
const bookmarks = new PostPaginator(async (token) => {
  const res = await client.posts.getBookmarks({
    maxResults: 100,
    paginationToken: token,
    tweetfields: ['created_at', 'public_metrics']
  });
  return {
    data: res.data ?? [],
    meta: res.meta
  };
});

// Process bookmarks
for await (const bookmarkedTweet of bookmarks) {
  console.log(`Bookmarked: ${bookmarkedTweet.text}`);
}

// Remove bookmark
const removeBookmark = await client.posts.deleteBookmark(tweetId);
console.log('Bookmark removed:', !removeBookmark.data?.bookmarked);
```

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

### Initialize Client with Bearer Token

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

Configures the XDK client using a bearer token for app-only authentication.

```typescript
import { Client } from '@xdevplatform/xdk';

const client = new Client({
  bearerToken: 'your-bearer-token-from-dashboard'
});

const user = await client.users.getByUsername('XDevelopers');
```

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

### Get User Likes Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for retrieving a user's liked posts.

```typescript
client.posts.getLikes(options: GetLikesOptions): Promise<GetLikesResponse>
```

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

### Default Import Pattern

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/modules-overview.md

Use this pattern for standard client initialization and basic method calls.

```typescript
import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'token' });
const user = await client.users.getByUsername('username');
```

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

### OAuth1 Constructor

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

Initializes a new OAuth 1.0a authentication handler for user context authentication.

```APIDOC
## OAuth1 Constructor

### Description
Initializes a new instance of the OAuth1 authentication handler using the provided configuration.

### Parameters
- **config** (OAuth1Config) - Required - OAuth1 configuration object containing apiKey, apiSecret, callback, accessToken, and accessTokenSecret.

### Example
```typescript
import { OAuth1, type OAuth1Config } from '@xdevplatform/xdk';

const oauth1Config: OAuth1Config = {
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  callback: 'https://example.com/callback',
  accessToken: 'user-access-token',
  accessTokenSecret: 'user-access-token-secret'
};

const oauth1 = new OAuth1(oauth1Config);
```
```

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

### Get User Following Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving a list of users followed by a specific user ID.

```typescript
client.users.getFollowing(id: string, options?: GetFollowingOptions): Promise<GetFollowingResponse>
```

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

### Interact with posts using PostsClient

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/modules-overview.md

Create posts, perform interactions like liking, and paginate through bookmarks.

```typescript
const tweet = await client.posts.create({
  text: 'Hello from the X API SDK!'
});

await client.posts.likePost(tweet.data.id);

const bookmarks = new PostPaginator(async (token) => {
  const res = await client.posts.getBookmarks({
    maxResults: 100,
    paginationToken: token,
    tweetfields: ['created_at', 'public_metrics']
  });
  return {
    data: res.data ?? [],
    meta: res.meta
  };
});

for await (const post of bookmarks) {
  console.log(post.text);
}
```

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

### Get Multiple Users by IDs Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving multiple user profiles by an array of IDs.

```typescript
client.users.getByIds(ids: string[], options?: GetByIdsOptions): Promise<GetByIdsResponse>
```

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

### Get Multiple Users by Usernames Definition

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Method signature for retrieving multiple user profiles by an array of usernames.

```typescript
client.users.getByUsernames(usernames: string[], options?: GetByUsernamesOptions): Promise<GetByUsernamesResponse>
```

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

### createHeaders

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/utilities.md

Creates a new platform-compatible Headers instance.

```APIDOC
## createHeaders(init?: Record<string, string> | Headers)

### Description
Creates a new platform-compatible Headers instance for use with HTTP requests.

### Parameters
- **init** (Record<string, string> | Headers) - Optional - Initial header values

### Returns
- **Headers** - Platform-compatible Headers instance
```

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

### Configure Request Timeouts

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/examples-and-patterns.md

Demonstrates setting a global timeout during client initialization and overriding it for individual requests.

```typescript
// Global timeout for all requests
const client = new Client({
  bearerToken: 'token',
  timeout: 10000  // 10 seconds
});

// Override timeout for specific request
const user = await client.users.getByUsername('username', {
  userfields: ['id', 'name'],
  requestOptions: {
    timeout: 5000  // 5 seconds for this request
  }
});
```

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

### Handling API Errors

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/client-core.md

Example of catching and inspecting ApiError instances to handle specific HTTP status codes.

```typescript
import { Client, ApiError } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'token' });

try {
  const user = await client.users.getByUsername('nonexistent');
} catch (error) {
  if (error instanceof ApiError) {
    console.error(`API Error ${error.status}: ${error.message}`);
    if (error.status === 429) {
      console.log('Rate limited, retry after:', error.headers.get('x-rate-limit-reset'));
    } else if (error.status === 401) {
      console.log('Invalid authentication token');
    }
    // Access original error data
    console.log('API response:', error.data);
  } else {
    throw error;
  }
}
```

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

### Get Authorization URL

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

Generates an authorization URL for the OAuth2 flow, optionally including PKCE parameters for enhanced security.

```typescript
const oauth2 = new OAuth2({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'https://example.com/callback'
});

// Generate PKCE parameters (for enhanced security)
const codeVerifier = generateCodeVerifier();
const codeChallenge = await generateCodeChallenge(codeVerifier);
oauth2.setPkceParameters(codeVerifier, codeChallenge);

// Get authorization URL
const state = 'random-state-string';
const authUrl = await oauth2.getAuthorizationUrl(state);

// Redirect user to authUrl
console.log('Redirect user to:', authUrl);
```

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

### Initialize a UserPaginator

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Wrap a list endpoint with the UserPaginator class to enable paginated data retrieval.

```typescript
import { Client, UserPaginator, PaginatedResponse, Schemas } from '@xdevplatform/xdk';

const client: Client = new Client({ bearerToken: 'your-bearer-token' });

// Wrap any list endpoint with proper typing
const followers: UserPaginator = new UserPaginator(
  async (token?: string): Promise<PaginatedResponse<Schemas.User>> => {
    const res = await client.users.getFollowers('<userId>', {
      maxResults: 100,
      paginationToken: token,
      userfields: ['id','name','username'],
    });
    return { 
      data: res.data ?? [], 
      meta: res.meta, 
      includes: res.includes, 
      errors: res.errors 
    };
  }
);
```

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

### Fetch Next Page

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/pagination-and-streaming.md

Demonstrates fetching pages sequentially and accessing accumulated items.

```typescript
async fetchNext(): Promise<void>
```

```typescript
const followers = new Paginator(async (token) => {
  // ... fetch logic
});

// Fetch first page
await followers.fetchNext();
console.log(followers.items.length); // Items from first page

// Fetch second page (items accumulate)
if (!followers.done) {
  await followers.fetchNext();
  console.log(followers.items.length); // All items from both pages
}

// Check pagination metadata
console.log(followers.meta?.nextToken); // Token for next page
console.log(followers.meta?.resultCount); // Items in last fetched page
```

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

### Set PKCE Parameters

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/authentication.md

Configures PKCE parameters for enhanced security by providing a code verifier and its corresponding code challenge.

```typescript
import { generateCodeVerifier, generateCodeChallenge } from '@xdevplatform/xdk';

const codeVerifier = generateCodeVerifier();
const codeChallenge = await generateCodeChallenge(codeVerifier);

oauth2.setPkceParameters(codeVerifier, codeChallenge);
```

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

### Next Page as New Instance

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Retrieve an independent paginator instance starting from the next page using the next() method.

```typescript
import { UserPaginator } from '@xdevplatform/xdk';

await followers.fetchNext();
if (!followers.done) {
  const page2: UserPaginator = await followers.next(); // independent paginator starting at next page
  await page2.fetchNext();
  console.log(page2.users.length);  // items from second page
}
```

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

### Create Post with Media Attachment

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/examples-and-patterns.md

Uploads a local image file and attaches it to a new post using the returned media ID.

```typescript
import * as fs from 'fs';

// Upload media
const imageBuffer = fs.readFileSync('image.jpg');
const mediaResponse = await client.media.upload({
  media_data: imageBuffer.toString('base64')
});

// Create post with media
const tweet = await client.posts.create({
  text: 'Check out this image!',
  media: {
    media_ids: [mediaResponse.data!.media_id]
  }
});

console.log('Created tweet with media:', tweet.data?.id);
```

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

### client.request(method, path, options)

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/client-core.md

The request method allows users to make authenticated HTTP requests to the X API. It automatically handles authentication based on client configuration.

```APIDOC
## client.request(method, path, options)

### Description
Make an authenticated request to the X API. The method automatically selects the best authentication method based on endpoint requirements and client configuration.

### Signature
`async request<T = any>(method: string, path: string, options?: RequestOptions): Promise<T>`

### Parameters
- **method** (string) - Required - HTTP method (GET, POST, PUT, DELETE, etc.)
- **path** (string) - Required - API endpoint path (e.g., `/2/users/by/username/username`)
- **options** (RequestOptions) - Optional - Request options including timeout, headers, and body

### Returns
`Promise<T>` resolving to the parsed response data

### Throws
`ApiError` when the API returns an error response
```

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

### Create a new list

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Requires OAuth1 or OAuth2 User Context authentication.

```typescript
client.lists.create(request: CreateListRequest, options?: CreateListOptions): Promise<CreateListResponse>
```

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

### Advanced Client Configuration

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/types-and-configuration.md

Configures the client with custom headers, timeouts, retry logic, and authentication options.

```typescript
import { Client, type ClientConfig } from '@xdevplatform/xdk';

const advancedConfig: ClientConfig = {
  // Base URL (can be overridden for testing or alternative endpoints)
  baseUrl: 'https://api.x.com',
  
  // Authentication: choose ONE of these
  bearerToken: 'app-only-token',        // App-only auth
  accessToken: 'oauth2-user-token',     // OAuth2 user auth
  oauth1: oauth1Instance,                // OAuth1.0a user auth
  
  // Custom headers (merged with defaults)
  headers: {
    'X-Custom-Header': 'value',
    'User-Agent': 'MyApp/1.0'
  },
  
  // Request timeout in milliseconds (default: 30000)
  timeout: 30000,
  
  // Automatic retry on failures (default: true)
  retry: true,
  
  // Maximum retry attempts (default: 3)
  maxRetries: 3
};

const client = new Client(advancedConfig);
```

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

### Implement OAuth2 Flow with PKCE

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/examples-and-patterns.md

Uses PKCE for secure authorization. Requires storing the state and code verifier for validation during the token exchange step.

```typescript
import { 
  OAuth2, 
  generateCodeVerifier, 
  generateCodeChallenge,
  Client 
} from '@xdevplatform/xdk';

// Step 1: Create OAuth2 instance
const oauth2 = new OAuth2({
  clientId: process.env.OAUTH2_CLIENT_ID!,
  clientSecret: process.env.OAUTH2_CLIENT_SECRET!,
  redirectUri: 'https://example.com/callback',
  scope: ['tweet.read', 'users.read', 'offline.access']
});

// Step 2: Generate PKCE parameters
const codeVerifier = generateCodeVerifier();
const codeChallenge = await generateCodeChallenge(codeVerifier);
oauth2.setPkceParameters(codeVerifier, codeChallenge);

// Step 3: Get authorization URL
const state = crypto.randomUUID(); // Store for validation
const authUrl = await oauth2.getAuthorizationUrl(state);

// Redirect user to authUrl...
// User authorizes app and is redirected back with code

// Step 4: Exchange code for token
const code = getCodeFromRedirectUrl();
const token = await oauth2.exchangeCode(code, codeVerifier);

// Step 5: Use token to create client
const client = new Client({
  accessToken: token.access_token
});

const user = await client.users.getMe();
console.log('Authenticated user:', user.data?.username);
```

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

### Create Bookmark Method Signature

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Defines the method signature for bookmarking a post.

```typescript
client.posts.createBookmark(id: string, options?: CreateBookmarkOptions): Promise<CreateBookmarkResponse>
```

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

### client.stream.postsSample

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/README.md

Initiates a connection to the real-time sampled public posts stream. Returns a stream object that supports event listeners and async iteration.

```APIDOC
## client.stream.postsSample

### Description
Connects to the real-time sampled public posts stream. The returned stream object provides data events and lifecycle management.

### Parameters
- **tweetfields** (array) - Optional - List of fields to include for tweets (e.g., 'id', 'text', 'created_at').
- **expansions** (array) - Optional - List of expansions to include (e.g., 'author_id').
- **userfields** (array) - Optional - List of fields to include for users (e.g., 'id', 'username', 'name').

### Usage Example
```typescript
const stream = await client.stream.postsSample({
  tweetfields: ['id', 'text'],
  expansions: ['author_id']
});

for await (const event of stream) {
  console.log(event);
}
```

### Events
- **data**: Emitted when a new JSON line is received.
- **error**: Emitted when a streaming error occurs.
- **close**: Emitted when the stream is closed.
- **keepAlive**: Emitted on heartbeat events.
```

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

### client.directMessages.create

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Creates a new direct message.

```APIDOC
## client.directMessages.create

### Description
Creates a new direct message.

### Method
client.directMessages.create(request: CreateDirectMessageRequest, options?: CreateOptions): Promise<CreateDirectMessageResponse>
```

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

### client.lists.followList

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/endpoints-reference.md

Follows a specific list.

```APIDOC
## client.lists.followList(id: string, options?: FollowListOptions)

### Parameters
- **id** (string) - Required - The unique identifier of the list.
```

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

### Fetch Previous Page

Source: https://github.com/xdevplatform/xdk-typescript/blob/main/_autodocs/pagination-and-streaming.md

Navigates backward through pages if the API supports it.

```typescript
async fetchPrevious(): Promise<void>
```

```typescript
// After fetching several pages forward
await paginator.fetchNext();
await paginator.fetchNext();

// Go back one page
if (paginator.meta?.previousToken) {
  await paginator.fetchPrevious();
}
```
Tokens:
Raw