groupcollection v0.1.0

groupcollection

SDK Installation

NPM

npm add https://github.com/speakeasy-sdks/email-collections

Yarn

yarn add https://github.com/speakeasy-sdks/email-collections

SDK Example Usage

import { Groupcollection } from "groupcollection";

(async() => {
  const sdk = new Groupcollection();

  const res = await sdk.contact.addcontacttag({
    tagId: "VMM6CHWA5I",
  });

  if (res.statusCode == 200) {
    // handle response
  }
})();

Available Resources and Operations

contact

• addcontacttag - addContactTag
• createcontact - createContact
• removecontacttag - removeContactTag
• updatecontact - updateContact

group

• createGroup - create group
• deletegroup - DeleteGroup
• retrievegroup - retrievegroup
• updateGroup - Update group

tag

• createTag - create tag
• deletetag - DeleteTag
• listtag - listTag
• retrievetag - retrieveTag
• updatetag - Updatetag

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a next method that can be called to pull down the next group of results. If the return value of next is null, then there are no more pages to be fetched.

Here's an example of one such pagination call:

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy