postgrid-node 0.1.0-alpha.3 → 0.1.0-alpha.4

package/resources/mailing-lists.js

@@ -0,0 +1,101 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MailingListListResponsesList = exports.MailingLists = void 0;
+const resource_1 = require("../resource.js");
+const core_1 = require("../core.js");
+const pagination_1 = require("../pagination.js");
+class MailingLists extends resource_1.APIResource {
+    /**
+     * Create a new mailing list.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.create({
+     *   description: 'Test Mailing List',
+     *   metadata: { campaign: 'launch' },
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/mailing_lists', { body, ...options });
+    }
+    /**
+     * Retrieve a specific mailing list by its ID.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(`/mailing_lists/${id}`, options);
+    }
+    /**
+     * Update an existing mailing list.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.update('id', {
+     *   description: 'Updated Mailing List Description',
+     * });
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.post(`/mailing_lists/${id}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/mailing_lists', MailingListListResponsesList, { query, ...options });
+    }
+    /**
+     * Delete a mailing list.
+     *
+     * This permanently deletes the mailing list and its associations. This operation
+     * cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.delete('id');
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(`/mailing_lists/${id}`, options);
+    }
+    /**
+     * Runs a mailing list job. Mailing list jobs allow you to add or remove contacts
+     * to your mailing list from mailing list imports or directly with contact IDs.
+     * Only one job can be ran at a time and jobs are only able to be ran while the
+     * mailing list has a `status` of "completed".
+     *
+     * Once a job as successfully been kicked off, the mailing list will have a
+     * `status` of either `creating_contacts` or `removing_contacts` depending on which
+     * job was ran. After the job has finished, the mailing list will go back into the
+     * `completed` state where more jobs can be ran. If there are any errors while
+     * running a job, the `errors` field on the mailing list will contain a list of
+     * error objects which describe the errors.
+     *
+     * @example
+     * ```ts
+     * const response = await client.mailingLists.submitJob('id', {
+     *   removeMailingListImports: [
+     *     'mailing_list_import_123',
+     *     'mailing_list_import_456',
+     *   ],
+     * });
+     * ```
+     */
+    submitJob(id, body, options) {
+        return this._client.post(`/mailing_lists/${id}/jobs`, { body, ...options });
+    }
+}
+exports.MailingLists = MailingLists;
+class MailingListListResponsesList extends pagination_1.List {
+}
+exports.MailingListListResponsesList = MailingListListResponsesList;
+MailingLists.MailingListListResponsesList = MailingListListResponsesList;
+//# sourceMappingURL=mailing-lists.js.map

package/resources/mailing-lists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailing-lists.js","sourceRoot":"","sources":["../src/resources/mailing-lists.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAuBD,IAAI,CACF,QAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,CACP,EAAU,EACV,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AA/HD,oCA+HC;AAED,MAAa,4BAA6B,SAAQ,iBAA6B;CAAG;AAAlF,oEAAkF;AAsWlF,YAAY,CAAC,4BAA4B,GAAG,4BAA4B,CAAC"}

package/resources/mailing-lists.mjs

@@ -0,0 +1,96 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../resource.mjs";
+import { isRequestOptions } from "../core.mjs";
+import { List } from "../pagination.mjs";
+export class MailingLists extends APIResource {
+    /**
+     * Create a new mailing list.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.create({
+     *   description: 'Test Mailing List',
+     *   metadata: { campaign: 'launch' },
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/mailing_lists', { body, ...options });
+    }
+    /**
+     * Retrieve a specific mailing list by its ID.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(`/mailing_lists/${id}`, options);
+    }
+    /**
+     * Update an existing mailing list.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.update('id', {
+     *   description: 'Updated Mailing List Description',
+     * });
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.post(`/mailing_lists/${id}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/mailing_lists', MailingListListResponsesList, { query, ...options });
+    }
+    /**
+     * Delete a mailing list.
+     *
+     * This permanently deletes the mailing list and its associations. This operation
+     * cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const mailingList = await client.mailingLists.delete('id');
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(`/mailing_lists/${id}`, options);
+    }
+    /**
+     * Runs a mailing list job. Mailing list jobs allow you to add or remove contacts
+     * to your mailing list from mailing list imports or directly with contact IDs.
+     * Only one job can be ran at a time and jobs are only able to be ran while the
+     * mailing list has a `status` of "completed".
+     *
+     * Once a job as successfully been kicked off, the mailing list will have a
+     * `status` of either `creating_contacts` or `removing_contacts` depending on which
+     * job was ran. After the job has finished, the mailing list will go back into the
+     * `completed` state where more jobs can be ran. If there are any errors while
+     * running a job, the `errors` field on the mailing list will contain a list of
+     * error objects which describe the errors.
+     *
+     * @example
+     * ```ts
+     * const response = await client.mailingLists.submitJob('id', {
+     *   removeMailingListImports: [
+     *     'mailing_list_import_123',
+     *     'mailing_list_import_456',
+     *   ],
+     * });
+     * ```
+     */
+    submitJob(id, body, options) {
+        return this._client.post(`/mailing_lists/${id}/jobs`, { body, ...options });
+    }
+}
+export class MailingListListResponsesList extends List {
+}
+MailingLists.MailingListListResponsesList = MailingListListResponsesList;
+//# sourceMappingURL=mailing-lists.mjs.map

package/resources/mailing-lists.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailing-lists.mjs","sourceRoot":"","sources":["../src/resources/mailing-lists.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAuBD,IAAI,CACF,QAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,CACP,EAAU,EACV,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,IAA6B;CAAG;AAsWlF,YAAY,CAAC,4BAA4B,GAAG,4BAA4B,CAAC"}