Wraps

https://github.com/wraps-team/wraps-js
Admin
Wraps provides TypeScript SDKs for AWS services including email (SES), SMS, and platform APIs with...
Tokens:385
Snippets:3
Trust Score:5.3
License:MIT
Update:7 months ago
Show doc for...
Tokens:
Raw
================
LIBRARY RULES
================
- BYOC (Bring Your Own Credentials) — SDKs call AWS APIs directly in the user's account, not a managed service
- Credential resolution order: pre-configured AWS client > OIDC role > explicit credentials > AWS credential chain
- AWS SDK packages (@aws-sdk/*) are peer dependencies — never bundle them
- Dual CJS + ESM output via tsup
- All public methods require JSDoc with @example, @throws, @param, @returns

================
CODE SNIPPETS
================
### Interact with Wraps Platform API using TypeScript Client

Source: https://github.com/wraps-team/wraps-js/blob/main/README.md

This snippet demonstrates how to create a client to interact with the Wraps Platform API. It requires the '@wraps.dev/client' package and an API key. The example shows how to make a GET request to retrieve contacts, with support for query parameters like pagination.

```typescript
import { createPlatformClient } from '@wraps.dev/client';

const client = createPlatformClient({ apiKey: 'your-api-key' });

const { data } = await client.GET('/v1/contacts/', {
  params: { query: { page: '1', pageSize: '10' } },
});
```

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

### Send Email using AWS SES SDK with Wraps.js

Source: https://github.com/wraps-team/wraps-js/blob/main/README.md

This snippet demonstrates how to send an email using the WrapsEmail SDK, which integrates with AWS SES. It requires the '@wraps.dev/email' package. The function takes sender, recipient, subject, and HTML content as input and returns a message ID.

```typescript
import { WrapsEmail } from '@wraps.dev/email';

const email = new WrapsEmail();

const { messageId } = await email.send({
  from: 'hello@yourapp.com',
  to: 'user@example.com',
  subject: 'Welcome!',
  html: '<h1>Hello from Wraps!</h1>',
});
```

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

### Send SMS using AWS End User Messaging SDK with Wraps.js

Source: https://github.com/wraps-team/wraps-js/blob/main/README.md

This snippet shows how to send an SMS message using the WrapsSMS SDK, which integrates with AWS End User Messaging. It requires the '@wraps.dev/sms' package. The function takes a recipient phone number and the message content as input.

```typescript
import { WrapsSMS } from '@wraps.dev/sms';

const sms = new WrapsSMS();

await sms.send({
  to: '+14155551234',
  message: 'Your verification code is 123456',
});
```
Tokens:
Raw