SDK Installation

NPM

npm add supaglue-crm

Yarn

yarn add supaglue-crm

SDK Example Usage

import {
  CreateAccountRequest,
  CreateAccountResponse
} from "supaglue-crm/dist/sdk/models/operations";
import {
  PhoneNumbersPhoneNumberTypeEnum,
  AddressesAddressTypeEnum,
} from "supaglue-crm/dist/sdk/models/shared";

import { AxiosError } from "axios";
import { Supaglue } from "supaglue-crm";
const sdk = new Supaglue({
  security: {
    apiKeyAuth: "YOUR_API_KEY_HERE",
  },
});

const req: CreateAccountRequest = {
  requestBody: {
    model: {
      addresses: [
        {
          addressType: AddressesAddressTypeEnum.Other,
          city: "San Francisco",
          country: "USA",
          postalCode: "94107",
          state: "CA",
          street1: "525 Brannan",
          street2: "null",
        },
        {
          addressType: AddressesAddressTypeEnum.Billing,
          city: "San Francisco",
          country: "USA",
          postalCode: "94107",
          state: "CA",
          street1: "525 Brannan",
          street2: "null",
        },
        {
          addressType: AddressesAddressTypeEnum.Shipping,
          city: "San Francisco",
          country: "USA",
          postalCode: "94107",
          state: "CA",
          street1: "525 Brannan",
          street2: "null",
        },
      ],
      customFields: {
        "vero": "perspiciatis",
        "nulla": "nihil",
        "fuga": "facilis",
      },
      description: "Integration API",
      industry: "API's",
      name: "Sample Customer",
      numberOfEmployees: 276000,
      ownerId: "9f3e97fd-4d5d-4efc-959d-bbebfac079f5",
      phoneNumbers: [
        {
          phoneNumber: "+14151234567",
          phoneNumberType: PhoneNumbersPhoneNumberTypeEnum.Mobile,
        },
        {
          phoneNumber: "+14151234567",
          phoneNumberType: PhoneNumbersPhoneNumberTypeEnum.Primary,
        },
      ],
      website: "https://supaglue.com/",
    },
  },
  xCustomerId: "my-customer-1",
  xProviderName: "salesforce",
};

sdk.accounts.create(req).then((res: CreateAccountResponse | AxiosError) => {
   // handle response
});

SDK Available Operations

accounts

• create - Create account
• get - Get account
• list - List accounts
• search - Search accounts
• update - Update account

contacts

• create - Create contact
• get - Get contact
• list - List contacts
• search - Search contacts
• update - Update contact

leads

• create - Create lead
• get - Get lead
• list - List leads
• update - Update lead

opportunities

• create - Create opportunity
• get - Get opportunity
• list - List opportunities
• search - Search Opportunities
• update - Update opportunity

passthrough

• send - Send passthrough request

users

• get - Get user
• list - List users

SDK Generated by Speakeasy