Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/supaglue-ts
A typescript SDK for accessing the Supaglue API.
https://github.com/speakeasy-sdks/supaglue-ts
api crm sdk ts typescript unified-api
Last synced: 2 days ago
JSON representation
A typescript SDK for accessing the Supaglue API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/supaglue-ts
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-03-28T07:38:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:19:34.000Z (7 months ago)
- Last Synced: 2024-10-11T13:50:01.175Z (27 days ago)
- Topics: api, crm, sdk, ts, typescript, unified-api
- Language: TypeScript
- Homepage: https://docs.supaglue.com/api/crm
- Size: 952 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Typescript SDK
The Open Source Unified API for CRM integrations
## SDK Installation
### NPM
```bash
npm add @speakeasy-sdks/supaglue
```
### Yarn
```bash
yarn add @speakeasy-sdks/supaglue
```
## SDK Example Usage
```typescript
import { Supaglue } from "@speakeasy-sdks/supaglue";
import { CreateAccountResponse } from "@speakeasy-sdks/supaglue/dist/sdk/models/operations";
import { AddressType, PhoneNumberType } from "@speakeasy-sdks/supaglue/dist/sdk/models/shared";
const sdk = new Supaglue({
security: {
apiKeyAuth: "",
},
});
sdk.accounts.create({
requestBody: {
model: {
addresses: [
{
addressType: AddressType.Other,
city: "San Francisco",
country: "USA",
postalCode: "94107",
state: "CA",
street1: "525 Brannan",
street2: "null",
},
{
addressType: AddressType.Billing,
city: "San Francisco",
country: "USA",
postalCode: "94107",
state: "CA",
street1: "525 Brannan",
street2: "null",
},
{
addressType: AddressType.Shipping,
city: "San Francisco",
country: "USA",
postalCode: "94107",
state: "CA",
street1: "525 Brannan",
street2: "null",
},
],
customFields: {
"nulla": "corrupti",
"illum": "vel",
"error": "deserunt",
},
description: "Integration API",
industry: "API's",
name: "Sample Customer",
numberOfEmployees: 276000,
ownerId: "9f3e97fd-4d5d-4efc-959d-bbebfac079f5",
phoneNumbers: [
{
phoneNumber: "+14151234567",
phoneNumberType: PhoneNumberType.Mobile,
},
{
phoneNumber: "+14151234567",
phoneNumberType: PhoneNumberType.Primary,
},
],
website: "https://supaglue.com/",
},
},
xCustomerId: "my-customer-1",
xProviderName: "salesforce",
}).then((res: CreateAccountResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```
## Available Resources and Operations
### [accounts](docs/sdks/accounts/README.md)
* [create](docs/sdks/accounts/README.md#create) - Create account
* [get](docs/sdks/accounts/README.md#get) - Get account
* [list](docs/sdks/accounts/README.md#list) - List accounts
* [search](docs/sdks/accounts/README.md#search) - Search accounts
* [update](docs/sdks/accounts/README.md#update) - Update account
### [contacts](docs/sdks/contacts/README.md)
* [create](docs/sdks/contacts/README.md#create) - Create contact
* [get](docs/sdks/contacts/README.md#get) - Get contact
* [list](docs/sdks/contacts/README.md#list) - List contacts
* [search](docs/sdks/contacts/README.md#search) - Search contacts
* [update](docs/sdks/contacts/README.md#update) - Update contact
### [leads](docs/sdks/leads/README.md)
* [create](docs/sdks/leads/README.md#create) - Create lead
* [get](docs/sdks/leads/README.md#get) - Get lead
* [list](docs/sdks/leads/README.md#list) - List leads
* [update](docs/sdks/leads/README.md#update) - Update lead
### [opportunities](docs/sdks/opportunities/README.md)
* [create](docs/sdks/opportunities/README.md#create) - Create opportunity
* [get](docs/sdks/opportunities/README.md#get) - Get opportunity
* [list](docs/sdks/opportunities/README.md#list) - List opportunities
* [search](docs/sdks/opportunities/README.md#search) - Search Opportunities
* [update](docs/sdks/opportunities/README.md#update) - Update opportunity
### [passthrough](docs/sdks/passthrough/README.md)
* [send](docs/sdks/passthrough/README.md#send) - Send passthrough request
### [users](docs/sdks/users/README.md)
* [get](docs/sdks/users/README.md#get) - Get user
* [list](docs/sdks/users/README.md#list) - List users
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)