@prezly/sdk 15.7.0 → 15.8.0

package/dist/Client.cjs

@@ -23,6 +23,7 @@ function createClient({
     billing: new _index2.Billing.Client(apiClient),
     campaigns: new _index2.Campaigns.Client(apiClient),
     campaignRecipients: new _index2.CampaignRecipients.Client(apiClient),
+    contacts: new _index2.Contacts.Client(apiClient),
     contactsExports: new _index2.ContactsExports.Client(apiClient),
     coverage: new _index2.Coverage.Client(apiClient),
     jobs: new _index2.Jobs.Client(apiClient),

package/dist/Client.d.ts

@@ -1,4 +1,5 @@
 import { DeferredJobsApiClient } from './api';
+import { Contacts } from './endpoints';
 import { Accounts, Billing, Campaigns, CampaignRecipients, ContactsExports, Coverage, Jobs, Licenses, Newsrooms, NewsroomCategories, NewsroomContacts, NewsroomLanguages, NewsroomThemes, NewsroomWebhooks, NewsroomPrivacyRequests, NewsroomDomains, NewsroomGalleries, NewsroomHub, PricingTables, SenderAddresses, Signup, Stories, Snippets, Subscriptions, NotificationSubscriptions } from './endpoints';
 import type { HeadersMap } from './http';
 export interface ClientOptions {
@@ -12,6 +13,7 @@ export interface Client {
     billing: Billing.Client;
     campaigns: Campaigns.Client;
     campaignRecipients: CampaignRecipients.Client;
+    contacts: Contacts.Client;
     contactsExports: ContactsExports.Client;
     coverage: Coverage.Client;
     jobs: Jobs.Client;

package/dist/Client.js

@@ -1,4 +1,5 @@
 import { ApiClient, DeferredJobsApiClient } from "./api/index.js";
+import { Contacts } from "./endpoints/index.js";
 import { Accounts, Billing, Campaigns, CampaignRecipients, ContactsExports, Coverage, Jobs, Licenses, Newsrooms, NewsroomCategories, NewsroomContacts, NewsroomLanguages, NewsroomThemes, NewsroomWebhooks, NewsroomPrivacyRequests, NewsroomDomains, NewsroomGalleries, NewsroomHub, PricingTables, SenderAddresses, Signup, Stories, Snippets, Subscriptions, NotificationSubscriptions } from "./endpoints/index.js";
 const DEFAULT_BASE_URL = 'https://api.prezly.com';
 export function createClient({
@@ -17,6 +18,7 @@ export function createClient({
     billing: new Billing.Client(apiClient),
     campaigns: new Campaigns.Client(apiClient),
     campaignRecipients: new CampaignRecipients.Client(apiClient),
+    contacts: new Contacts.Client(apiClient),
     contactsExports: new ContactsExports.Client(apiClient),
     coverage: new Coverage.Client(apiClient),
     jobs: new Jobs.Client(apiClient),

package/dist/api/constants.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DEFAULT_USER_AGENT = void 0;
-const VERSION = "15.6.0";
+const VERSION = "15.7.0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;
 exports.DEFAULT_USER_AGENT = DEFAULT_USER_AGENT;

package/dist/api/constants.js

@@ -1,3 +1,3 @@
-const VERSION = "15.6.0";
+const VERSION = "15.7.0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 export const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;

package/dist/endpoints/Contacts/Client.cjs

@@ -0,0 +1,149 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Client = void 0;
+var _routing = require("../../routing.cjs");
+var _index = require("../../types/index.cjs");
+class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+
+  /**
+   * List Contacts Exports with sorting, and pagination.
+   */
+  async list(options) {
+    const {
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    const {
+      contacts,
+      pagination,
+      sort
+    } = await this.apiClient.get(_routing.routing.contactsUrl, {
+      query: {
+        limit,
+        offset,
+        sort: _index.SortOrder.stringify(sortOrder)
+      }
+    });
+    return {
+      contacts,
+      pagination,
+      sortOrder: _index.SortOrder.parse(sort)
+    };
+  }
+
+  /**
+   * List Contacts Exports with sorting, pagination, and filtering.
+   */
+  async search(options) {
+    const {
+      limit,
+      offset,
+      query,
+      sortOrder
+    } = options;
+    const url = `${_routing.routing.contactsUrl}/search`;
+    const {
+      contacts,
+      pagination,
+      sort
+    } = await this.apiClient.post(url, {
+      payload: {
+        limit,
+        offset,
+        sort: _index.SortOrder.stringify(sortOrder),
+        query
+      }
+    });
+    return {
+      contacts,
+      pagination,
+      sortOrder: _index.SortOrder.parse(sort)
+    };
+  }
+  async get(id) {
+    const url = `${_routing.routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.get(url);
+    return contact;
+  }
+  async getMany(ids) {
+    const {
+      contacts
+    } = await this.search({
+      query: {
+        id: {
+          $in: ids
+        }
+      },
+      limit: ids.length
+    });
+    // Reorder results to match the order of `ids`.
+    return contacts.sort((a, b) => ids.indexOf(a.id) - ids.indexOf(b.id));
+  }
+  async create(payload) {
+    const {
+      contact
+    } = await this.apiClient.post(_routing.routing.contactsUrl, {
+      payload
+    });
+    return contact;
+  }
+  async update(id, payload) {
+    const url = `${_routing.routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.patch(url, {
+      payload
+    });
+    return contact;
+  }
+  async tag(id, tags) {
+    const url = `${_routing.routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.patch(url, {
+      payload: {
+        '+tags': tags
+      }
+    });
+    return contact;
+  }
+  async untag(id, tags) {
+    const url = `${_routing.routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.patch(url, {
+      payload: {
+        '-tags': tags
+      }
+    });
+    return contact;
+  }
+  async bulkTag(selector, tags) {
+    return this.apiClient.patch(_routing.routing.contactsUrl, {
+      payload: {
+        scope: selector.scope,
+        query: selector.query,
+        '+tags': tags
+      }
+    });
+  }
+  async bulkUntag(selector, tags) {
+    return this.apiClient.patch(_routing.routing.contactsUrl, {
+      payload: {
+        scope: selector.scope,
+        query: selector.query,
+        '-tags': tags
+      }
+    });
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Contacts/Client.d.ts

@@ -0,0 +1,28 @@
+import type { ProgressPromise } from '@prezly/progress-promise';
+import type { DeferredJobsApiClient } from '../../api';
+import type { Contact } from '../../types';
+import type { ContactsBulkSelector } from '../ContactsExports';
+import type { CreateRequest, ListOptions, ListResponse, SearchOptions, SearchResponse, UpdateRequest } from './types';
+declare type TagId = number;
+declare type TagName = string;
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    /**
+     * List Contacts Exports with sorting, and pagination.
+     */
+    list(options: ListOptions): Promise<ListResponse>;
+    /**
+     * List Contacts Exports with sorting, pagination, and filtering.
+     */
+    search(options: SearchOptions): Promise<SearchResponse>;
+    get(id: Contact['id']): Promise<Contact>;
+    getMany(ids: Contact['id'][]): Promise<Contact[]>;
+    create(payload: CreateRequest): Promise<Contact>;
+    update(id: Contact['id'], payload: UpdateRequest): Promise<Contact>;
+    tag(id: Contact['id'], tags: (TagId | TagName)[]): Promise<Contact>;
+    untag(id: Contact['id'], tags: (TagId | TagName)[]): Promise<Contact>;
+    bulkTag(selector: ContactsBulkSelector, tags: (TagId | TagName)[]): ProgressPromise<undefined>;
+    bulkUntag(selector: ContactsBulkSelector, tags: (TagId | TagName)[]): ProgressPromise<undefined>;
+}
+export {};

package/dist/endpoints/Contacts/Client.js

@@ -0,0 +1,142 @@
+import { routing } from "../../routing.js";
+import { SortOrder } from "../../types/index.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+
+  /**
+   * List Contacts Exports with sorting, and pagination.
+   */
+  async list(options) {
+    const {
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    const {
+      contacts,
+      pagination,
+      sort
+    } = await this.apiClient.get(routing.contactsUrl, {
+      query: {
+        limit,
+        offset,
+        sort: SortOrder.stringify(sortOrder)
+      }
+    });
+    return {
+      contacts,
+      pagination,
+      sortOrder: SortOrder.parse(sort)
+    };
+  }
+
+  /**
+   * List Contacts Exports with sorting, pagination, and filtering.
+   */
+  async search(options) {
+    const {
+      limit,
+      offset,
+      query,
+      sortOrder
+    } = options;
+    const url = `${routing.contactsUrl}/search`;
+    const {
+      contacts,
+      pagination,
+      sort
+    } = await this.apiClient.post(url, {
+      payload: {
+        limit,
+        offset,
+        sort: SortOrder.stringify(sortOrder),
+        query
+      }
+    });
+    return {
+      contacts,
+      pagination,
+      sortOrder: SortOrder.parse(sort)
+    };
+  }
+  async get(id) {
+    const url = `${routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.get(url);
+    return contact;
+  }
+  async getMany(ids) {
+    const {
+      contacts
+    } = await this.search({
+      query: {
+        id: {
+          $in: ids
+        }
+      },
+      limit: ids.length
+    });
+    // Reorder results to match the order of `ids`.
+    return contacts.sort((a, b) => ids.indexOf(a.id) - ids.indexOf(b.id));
+  }
+  async create(payload) {
+    const {
+      contact
+    } = await this.apiClient.post(routing.contactsUrl, {
+      payload
+    });
+    return contact;
+  }
+  async update(id, payload) {
+    const url = `${routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.patch(url, {
+      payload
+    });
+    return contact;
+  }
+  async tag(id, tags) {
+    const url = `${routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.patch(url, {
+      payload: {
+        '+tags': tags
+      }
+    });
+    return contact;
+  }
+  async untag(id, tags) {
+    const url = `${routing.contactsUrl}/${id}`;
+    const {
+      contact
+    } = await this.apiClient.patch(url, {
+      payload: {
+        '-tags': tags
+      }
+    });
+    return contact;
+  }
+  async bulkTag(selector, tags) {
+    return this.apiClient.patch(routing.contactsUrl, {
+      payload: {
+        scope: selector.scope,
+        query: selector.query,
+        '+tags': tags
+      }
+    });
+  }
+  async bulkUntag(selector, tags) {
+    return this.apiClient.patch(routing.contactsUrl, {
+      payload: {
+        scope: selector.scope,
+        query: selector.query,
+        '-tags': tags
+      }
+    });
+  }
+}

package/dist/endpoints/Contacts/index.cjs

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  ContactsScope: true
+};
+Object.defineProperty(exports, "ContactsScope", {
+  enumerable: true,
+  get: function () {
+    return _index.ContactsScope;
+  }
+});
+var _Client = require("./Client.cjs");
+Object.keys(_Client).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Client[key];
+    }
+  });
+});
+var _types = require("./types.cjs");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});
+var _index = require("../../types/index.cjs");

package/dist/endpoints/Contacts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Client';
+export * from './types';
+export { ContactsScope } from '../../types';
+export type { ContactsBulkSelector } from '../ContactsExports';

package/dist/endpoints/Contacts/index.js

@@ -0,0 +1,4 @@
+export * from "./Client.js";
+export * from "./types.js";
+export { ContactsScope } from "../../types/index.js"; // convenience shortcut
+// convenience shortcut

package/dist/endpoints/Contacts/types.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/endpoints/Contacts/types.d.ts

@@ -0,0 +1,58 @@
+import type { Contact, Pagination, Query } from '../../types';
+import type { SortOrder } from '../../types';
+export interface ListOptions {
+    limit?: number;
+    offset?: number;
+    sortOrder?: SortOrder | string;
+}
+export interface SearchOptions extends ListOptions {
+    query?: Query;
+}
+export interface ListResponse {
+    contacts: Contact[];
+    pagination: Pagination;
+    sortOrder: SortOrder;
+}
+export declare type SearchResponse = ListResponse;
+export declare type CreateRequest = OrganisationCreateRequest | PersonCreateRequest;
+export declare type UpdateRequest = OrganisationUpdateRequest | PersonUpdateRequest;
+interface BaseContactPayload {
+    avatar_image?: string | null;
+    languages?: string[];
+    emails?: string[];
+    phone_numbers?: Contact.PhoneNumber[];
+    urls?: string[];
+    social_accounts?: {
+        type: Contact.SocialNetwork;
+        username: string;
+    }[];
+    tags?: (number | string)[];
+    periodicity?: Contact.Periodicity | null;
+    medium_types?: Contact.MediumType[];
+    salutation?: string;
+    address?: {
+        street?: string;
+        zip?: string;
+        city?: string;
+        region?: string;
+        country?: string | null;
+    };
+}
+export interface OrganisationUpdateRequest extends BaseContactPayload {
+    company_name?: string;
+}
+export interface OrganisationCreateRequest extends BaseContactPayload {
+    contact_type: `${Contact.Type.ORGANISATION}`;
+    company_name: string;
+}
+export interface PersonUpdateRequest extends BaseContactPayload {
+    first_name?: string;
+    last_name?: string;
+    gender?: Contact.Gender;
+    function_name?: string;
+    organisations?: (number | string)[];
+}
+export interface PersonCreateRequest extends PersonUpdateRequest {
+    contact_type: `${Contact.Type.PERSON}`;
+}
+export {};

package/dist/endpoints/Contacts/types.js

@@ -0,0 +1 @@
+export {};

package/dist/endpoints/index.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.NotificationSubscriptions = exports.Subscriptions = exports.Stories = exports.Snippets = exports.Signup = exports.SenderAddresses = exports.PricingTables = exports.NewsroomWebhooks = exports.NewsroomThemes = exports.NewsroomSubscriptions = exports.Newsrooms = exports.NewsroomPrivacyRequests = exports.NewsroomLanguages = exports.NewsroomHub = exports.NewsroomGalleries = exports.NewsroomDomains = exports.NewsroomContacts = exports.NewsroomCategories = exports.Licenses = exports.Jobs = exports.Coverage = exports.ContactsExports = exports.Campaigns = exports.CampaignRecipients = exports.Billing = exports.Accounts = void 0;
+exports.NotificationSubscriptions = exports.Subscriptions = exports.Stories = exports.Snippets = exports.Signup = exports.SenderAddresses = exports.PricingTables = exports.NewsroomWebhooks = exports.NewsroomThemes = exports.NewsroomSubscriptions = exports.Newsrooms = exports.NewsroomPrivacyRequests = exports.NewsroomLanguages = exports.NewsroomHub = exports.NewsroomGalleries = exports.NewsroomDomains = exports.NewsroomContacts = exports.NewsroomCategories = exports.Licenses = exports.Jobs = exports.Coverage = exports.ContactsExports = exports.Contacts = exports.Campaigns = exports.CampaignRecipients = exports.Billing = exports.Accounts = void 0;
 var _Accounts = _interopRequireWildcard(require("./Accounts/index.cjs"));
 exports.Accounts = _Accounts;
 var _Billing = _interopRequireWildcard(require("./Billing/index.cjs"));
@@ -12,6 +12,8 @@ var _CampaignRecipients = _interopRequireWildcard(require("./CampaignRecipients/
 exports.CampaignRecipients = _CampaignRecipients;
 var _Campaigns = _interopRequireWildcard(require("./Campaigns/index.cjs"));
 exports.Campaigns = _Campaigns;
+var _Contacts = _interopRequireWildcard(require("./Contacts/index.cjs"));
+exports.Contacts = _Contacts;
 var _ContactsExports = _interopRequireWildcard(require("./ContactsExports/index.cjs"));
 exports.ContactsExports = _ContactsExports;
 var _Coverage = _interopRequireWildcard(require("./Coverage/index.cjs"));

package/dist/endpoints/index.d.ts

@@ -2,6 +2,7 @@ export * as Accounts from './Accounts';
 export * as Billing from './Billing';
 export * as CampaignRecipients from './CampaignRecipients';
 export * as Campaigns from './Campaigns';
+export * as Contacts from './Contacts';
 export * as ContactsExports from './ContactsExports';
 export * as Coverage from './Coverage';
 export * as Jobs from './Jobs';

package/dist/endpoints/index.js

@@ -2,6 +2,7 @@ export * as Accounts from "./Accounts/index.js";
 export * as Billing from "./Billing/index.js";
 export * as CampaignRecipients from "./CampaignRecipients/index.js";
 export * as Campaigns from "./Campaigns/index.js";
+export * as Contacts from "./Contacts/index.js";
 export * as ContactsExports from "./ContactsExports/index.js";
 export * as Coverage from "./Coverage/index.js";
 export * as Jobs from "./Jobs/index.js";

package/dist/routing.cjs

@@ -10,6 +10,7 @@ const routing = {
   campaignsUrl: '/v2/campaigns',
   campaignRecipientsUrl: '/v2/campaigns/:campaign_id/recipients',
   contactsExportsUrl: '/v2/contacts/exports',
+  contactsUrl: '/v2/contacts',
   coverageUrl: '/v2/coverage',
   jobsUrl: '/v2/jobs',
   licenseUrl: '/v2/licenses',

package/dist/routing.d.ts

@@ -4,6 +4,7 @@ export declare const routing: {
     campaignsUrl: string;
     campaignRecipientsUrl: string;
     contactsExportsUrl: string;
+    contactsUrl: string;
     coverageUrl: string;
     jobsUrl: string;
     licenseUrl: string;

package/dist/routing.js

@@ -4,6 +4,7 @@ export const routing = {
   campaignsUrl: '/v2/campaigns',
   campaignRecipientsUrl: '/v2/campaigns/:campaign_id/recipients',
   contactsExportsUrl: '/v2/contacts/exports',
+  contactsUrl: '/v2/contacts',
   coverageUrl: '/v2/coverage',
   jobsUrl: '/v2/jobs',
   licenseUrl: '/v2/licenses',

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@prezly/sdk",
-    "version": "15.7.0",
+    "version": "15.8.0",
     "description": "Prezly API SDK",
     "type": "module",
     "main": "dist/index.cjs",