https://github.com/oaphi/gas-mailchimp

Mailchimp API utilities for Google Apps Script
https://github.com/oaphi/gas-mailchimp

Last synced: 2 days ago
JSON representation

Mailchimp API utilities for Google Apps Script

• Host: GitHub
• URL: https://github.com/oaphi/gas-mailchimp
• Owner: Oaphi
• License: mit
• Created: 2020-08-25T18:26:13.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-26T23:01:34.000Z (about 1 year ago)
• Last Synced: 2023-08-27T00:18:24.699Z (about 1 year ago)
• Language: TypeScript
• Size: 426 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# About

This is a client library for Google Apps Script for interacting with [Mailchimp API](https://mailchimp.com/developer/marketing/api/list-members/list-members-info/)

# Installing

Add the library to your project with the following sript ID:

> 1VoL3BQ-cJyqYAul4wFwbJGjBCgmhnKCvkLFCKY7Q1pPWEiMwdLQ88bFa

# Using

By default, the library exposes a `MailchimpApp` global variable with the following list of methods:

## Settings

The library uses a settings object of the following structure:

```typescript

interface MailchimpSettings {

    api_key: string;

    domain: string;

    listName: string;

    server: string;

    version: string;

}

```

Settings can be retrieved and updated via the following methods:

| Method        | Description                         | Accepts             | Returns             |

| ------------- | ----------------------------------- | ------------------- | ------------------- |

| `getDefaults` | Gets default library settings       | -                   | `MailchimpSettings` |

| `getSettings` | Gets the current settings           | -                   | `MailchimpSettings` |

| `setSettings` | Sets settings (via partial updates) | `MailchimpSettings` | `boolean`           |

| `useSettings` | Overrides settings completely       | `MailchimpSettings` | `boolean`           |

## Lists

| Method     | Description                                      | Returns  |

| ---------- | ------------------------------------------------ | -------- |

| `getLists` | Gets a list of `List` objects (subscriber lists) | `List[]` |

## Members

| Method         | Description                                        | Returns          |

| -------------- | -------------------------------------------------- | ---------------- |

| `addMember`    | Adds a new `Member` to a subscriber list           | `boolean`        |

| `deleteMember` | Deletes a `Member` from a subscriber list          | `boolean`        |

| `getMember`    | Gets a `Member` from a subscriber list             | `Member \| null` |

| `getMembers`   | Gets a list of `Member` objects by list ID         | `Member[]`       |

| `hasMember`    | Checks if there is a `Member` with a given `email` | `boolean`        |

## Batch methods

Some actions can be batched - the library exposes the following batch methods:

| Method       | Description                    | Returns   |

| ------------ | ------------------------------ | --------- |

| `addMembers` | Adds several `Member`s at once | `boolean` |