Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/attentive-node-sdk
Node SDK for Attentive API
https://github.com/speakeasy-sdks/attentive-node-sdk
attentive commerce messaging sdk sdk-node
Last synced: 2 days ago
JSON representation
Node SDK for Attentive API
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/attentive-node-sdk
- Owner: speakeasy-sdks
- License: apache-2.0
- Created: 2023-02-07T04:17:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:12:36.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:37.511Z (6 months ago)
- Topics: attentive, commerce, messaging, sdk, sdk-node
- Language: TypeScript
- Homepage: https://docs.attentive.com/
- Size: 109 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Attentive Node SDK
[Attentive’s APIs](https://docs.attentive.com/) allow you as a developer to integrate with the Attentive platform and build custom applications. Use our numerous endpoints to manage user subscriptions, trigger messages related to user actions, save subscriber attributes, and send personalized text messages.
## SDK Installation
### NPM
```bash
npm add @attentive/sdk
```
### Yarn
```bash
yarn add @attentive/sdk
```
## Authentication
Authentication
To keep data on Attentive’s platform safe and secure, all apps connecting with Attentive’s APIs must authenticate when making API requests. This article describes the different methods of authenticating and authorizing apps with Attentive’s platform.
Types of authentication
Different types of apps require different authentication or authorization methods:
Private apps use basic HTTP authentication.
Public apps use OAuth 2.0.
HTTP authentication
Private applications can authenticate through basic HTTP authentication by using their API key as the Bearer Token when making calls to Attentive’s APIs. To generate a unique API key, you must create an app in the Attentive platform. You should treat your API key as a password. If it is accidentally shared, other users may be able to send messages to customers on your behalf. Use the /me endpoint to verify that you are authenticating correctly.
For a GraphQL API example:
```bash
curl --location --request POST 'https://api.attentivemobile.com/v1/graphql' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"\nquery {\n viewer {\n installedApplication {\n installerCompany {\n id\n name\n }\n }\n }\n}\n\n","variables":{}}'
```
For a REST API example:
```bash
curl 'https://api.attentivemobile.com/v1/me' \
-X GET \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
```
Note: If you are unable to access the Attentive platform, please send an email to [email protected] for access.
## SDK Example Usage
```typescript
import { SDK, withSecurity} from "@attentive/sdk";
import { CreateTokenViaAuthorizationCodeRequest, CreateTokenViaAuthorizationCodeResponse } from "@attentive/sdk/src/sdk/models/operations";
import { AxiosError } from "axios";
const sdk = new SDK(withSecurity(
security: {
oAuthFlow: {
authorization: "Bearer YOUR_ACCESS_TOKEN_HERE",
},
}
));
const req: CreateTokenViaAuthorizationCodeRequest = {
request: {
clientId: "sit",
clientSecret: "voluptas",
code: "culpa",
grantType: "expedita",
redirectUri: "consequuntur",
},
};
sdk.accessToken.createTokenViaAuthorizationCode(req).then((res: CreateTokenViaAuthorizationCodeResponse | AxiosError) => {
// handle response
});
```
## SDK Available Operations
### Access Token
* `createTokenViaAuthorizationCode` - Access Token
### Custom Attributes
* `postCustomAttributes` - Custom Attributes
### Custom Events
* `postCustomEvents` - Custom Events
### Identity
* `identify` - Add a client user identifier or custom identifier(s) to a user
### Privacy Request
* `addDeleteRequest` - Sending a request to this endpoint will delete a subscriber in accordance with CCPA regulations within thirty days provided the call was successful.
* `getDeleteRequest` - Get a CCPA delete request by Id
### Product Catalog
* `getUploads` - View Recent Catalog Uploads
* `lookupUpload` - Lookup Product Catalog Ingestion
* `postUpload` - Upload Product Catalog
### Subscribers
* `addSubscriptions` - Subscribe user
* `getSubscriptions` - Get subscription eligibility for a user
* `unsubscribeSubscriptions` - Unsubscribe subscriptions for a user
### Test Authentication
* `getMe` - Me
### Webhooks
* `createWebhook` - Create webhook
* `deleteWebhook` - Delete webhook
* `getWebhooks` - List webhooks
* `updateWebhook` - Update webhook
### eCommerce
* `postAddToCartEvents` - Add to cart
* `postProductViewEvents` - Product view
* `postPurchaseEvents` - Purchase
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)