@prezly/sdk 11.3.1 → 11.5.0

package/dist/Client.d.ts

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

package/dist/Client.js

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

package/dist/api/constants.js

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

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

@@ -1,8 +1,7 @@
 import type { DeferredJobsApiClient } from '../../api';
-import type { Campaign, Contact, EmailRecipient } from '../../types';
+import type { Campaign, Contact, ContactsScope, EmailRecipient } from '../../types';
 import { Query } from '../../types';
 import type { RecipientsOperationResponse } from '../Campaigns';
-import type { ContactsScope } from './scopes';
 import type { ListOptions, ListResponse, SearchOptions } from './types';
 declare type CampaignId = Campaign['id'];
 declare type ContactId = Contact['id'];

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

@@ -1,3 +1,3 @@
 export * from './Client';
-export * from './scopes';
 export * from './types';
+export { ContactsScope } from '../../types';

package/dist/endpoints/CampaignRecipients/index.js

@@ -1,3 +1,3 @@
 export * from "./Client.js";
-export * from "./scopes.js";
-export * from "./types.js";
+export * from "./types.js";
+export { ContactsScope } from "../../types/index.js"; // convenience shortcut & BC

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

@@ -0,0 +1,36 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { ContactsExport } from '../../types';
+import type { ContactsBulkSelector, ListOptions, ListResponse, SearchOptions } from './types';
+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<ListResponse>;
+    /**
+     * Fetch Contacts Export object by its uuid.
+     */
+    get(uuid: ContactsExport['uuid']): Promise<ContactsExport>;
+    /**
+     * Request export of the given selection of Contacts.
+     * If the selection size is small enough, it can be processed right away,
+     * returning an export with `status: "done"`.
+     *
+     * Otherwise, returns an export with `status: "new"`,
+     * and will notify the user over email when it's done.
+     */
+    create(selector: ContactsBulkSelector): Promise<ContactsExport>;
+    /**
+     * Fetch a download URL to retrieve the given Contacts Export file.
+     * Only works for exports with status = "done"
+     * Fails with Method Not Allowed (405) error for pending and failed exports.
+     */
+    download(uuid: ContactsExport['uuid']): Promise<{
+        downloadUrl: string;
+    }>;
+}

package/dist/endpoints/ContactsExports/Client.js

@@ -0,0 +1,91 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+
+  /**
+   * List Contacts Exports with sorting, and pagination.
+   */
+  async list(options) {
+    const {
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    return this.apiClient.get(routing.contactsExportsUrl, {
+      query: {
+        limit,
+        offset,
+        sort: sortOrder
+      }
+    });
+  }
+
+  /**
+   * List Contacts Exports with sorting, pagination, and filtering.
+   */
+  async search(options) {
+    const {
+      query,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    const url = `${routing.contactsExportsUrl}/search`;
+    return this.apiClient.post(url, {
+      payload: {
+        limit,
+        offset,
+        query,
+        sort: sortOrder
+      }
+    });
+  }
+
+  /**
+   * Fetch Contacts Export object by its uuid.
+   */
+  async get(uuid) {
+    const url = `${routing.contactsExportsUrl}/${uuid}`;
+    const response = await this.apiClient.get(url);
+    return response.export;
+  }
+
+  /**
+   * Request export of the given selection of Contacts.
+   * If the selection size is small enough, it can be processed right away,
+   * returning an export with `status: "done"`.
+   *
+   * Otherwise, returns an export with `status: "new"`,
+   * and will notify the user over email when it's done.
+   */
+  async create(selector) {
+    const {
+      query,
+      scope
+    } = selector;
+    const response = await this.apiClient.post(routing.contactsExportsUrl, {
+      payload: {
+        contacts: {
+          query,
+          scope
+        }
+      }
+    });
+    return response.export;
+  }
+
+  /**
+   * Fetch a download URL to retrieve the given Contacts Export file.
+   * Only works for exports with status = "done"
+   * Fails with Method Not Allowed (405) error for pending and failed exports.
+   */
+  async download(uuid) {
+    const url = `${routing.contactsExportsUrl}/${uuid}/download`;
+    const response = await this.apiClient.post(url);
+    return {
+      downloadUrl: response.download_url
+    };
+  }
+}

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

@@ -0,0 +1,3 @@
+export * from './Client';
+export * from './types';
+export { ContactsScope } from '../../types';

package/dist/endpoints/ContactsExports/index.js

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

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

@@ -0,0 +1,18 @@
+import type { ContactsExport, ContactsScope, Pagination, Query } from '../../types';
+export interface ListOptions {
+    limit?: number;
+    offset?: number;
+    sortOrder?: string;
+}
+export interface SearchOptions extends ListOptions {
+    query?: Query;
+}
+export interface ListResponse {
+    exports: ContactsExport[];
+    pagination: Pagination;
+    sort: string;
+}
+export interface ContactsBulkSelector {
+    scope?: ContactsScope;
+    query?: Query;
+}

package/dist/endpoints/ContactsExports/types.js

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

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 ContactsExports from './ContactsExports';
 export * as Coverage from './Coverage';
 export * as Jobs from './Jobs';
 export * as Licenses from './Licenses';

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 ContactsExports from "./ContactsExports/index.js";
 export * as Coverage from "./Coverage/index.js";
 export * as Jobs from "./Jobs/index.js";
 export * as Licenses from "./Licenses/index.js";

package/dist/routing.d.ts

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

package/dist/routing.js

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

package/dist/types/ContactsExport.d.ts

@@ -0,0 +1,18 @@
+import type { UserRef } from './User';
+declare type Iso8601DateTime = string;
+export interface ContactsExport {
+    uuid: string;
+    status: ContactsExport.Status;
+    contacts_count: number;
+    user: UserRef;
+    created_at: Iso8601DateTime;
+    updated_at: Iso8601DateTime;
+}
+export declare namespace ContactsExport {
+    enum Status {
+        NEW = "new",
+        DONE = "done",
+        FAILED = "failed"
+    }
+}
+export {};

package/dist/types/ContactsExport.js

@@ -0,0 +1,10 @@
+export let ContactsExport;
+(function (_ContactsExport) {
+  let Status;
+  (function (Status) {
+    Status["NEW"] = "new";
+    Status["DONE"] = "done";
+    Status["FAILED"] = "failed";
+  })(Status || (Status = {}));
+  _ContactsExport.Status = Status;
+})(ContactsExport || (ContactsExport = {}));

package/dist/types/ContactsScope.d.ts

@@ -0,0 +1,39 @@
+import type { Campaign } from './Campaign';
+import type { SelectionValue } from './common';
+import type { Contact } from './Contact';
+import type { EmailRecipient } from './EmailRecipient';
+export declare type ContactsScope = ContactsScope.AllContactsScope | ContactsScope.ContactOrganisationsScope | ContactsScope.ContactEmployeesScope | ContactsScope.CampaignRecipientsScope | ContactsScope.CampaignReportScope;
+export declare namespace ContactsScope {
+    enum Type {
+        ALL_CONTACTS = "scope:contacts",
+        CONTACT_EMPLOYEES = "scope:contact_employees",
+        CONTACT_ORGANISATIONS = "scope:contact_organisations",
+        CAMPAIGN_RECIPIENTS = "scope:campaign_recipients",
+        CAMPAIGN_REPORT = "scope:campaign_report"
+    }
+    interface AllContactsScope {
+        type: ContactsScope.Type.ALL_CONTACTS;
+        selection?: SelectionValue<Contact['id']>;
+    }
+    interface ContactOrganisationsScope {
+        type: ContactsScope.Type.CONTACT_ORGANISATIONS;
+        contact_id: Contact['id'];
+        selection?: SelectionValue<Contact['id']>;
+    }
+    interface ContactEmployeesScope {
+        type: ContactsScope.Type.CONTACT_EMPLOYEES;
+        contact_id: Contact['id'];
+        selection?: SelectionValue<Contact['id']>;
+    }
+    interface CampaignRecipientsScope {
+        type: ContactsScope.Type.CAMPAIGN_RECIPIENTS;
+        campaign_id: Campaign['id'];
+        selection?: SelectionValue<EmailRecipient['id']>;
+    }
+    interface CampaignReportScope {
+        type: ContactsScope.Type.CAMPAIGN_REPORT;
+        campaign_id: Campaign['id'];
+        report: 'recipients' | 'sent' | 'clicked' | 'opened' | 'unopened' | 'undelivered' | 'unsubscribed';
+        selection?: SelectionValue<EmailRecipient['id']>;
+    }
+}

package/dist/types/Newsroom.d.ts

@@ -72,6 +72,8 @@ export interface Newsroom extends NewsroomRef {
     cultures: CultureRef[];
     campaigns_number: number;
     stories_number: number;
+    pitches_number: number;
+    coverage_number: number;
     public_galleries_number: number;
     square_logo: UploadedImage | null;
     newsroom_logo: UploadedImage | null;

package/dist/types/index.d.ts

@@ -2,6 +2,8 @@ export * from './common';
 export * from './Campaign';
 export * from './Category';
 export * from './Contact';
+export * from './ContactsExport';
+export * from './ContactsScope';
 export * from './Country';
 export * from './CoverageEntry';
 export * from './Culture';

package/dist/types/index.js

@@ -3,6 +3,8 @@ export * from "./common/index.js"; // Entities
 export * from "./Campaign.js";
 export * from "./Category.js";
 export * from "./Contact.js";
+export * from "./ContactsExport.js";
+export * from "./ContactsScope.js";
 export * from "./Country.js";
 export * from "./CoverageEntry.js";
 export * from "./Culture.js";

package/package.json

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

package/dist/endpoints/CampaignRecipients/scopes.d.ts

@@ -1,36 +0,0 @@
-import type { Campaign, Contact, EmailRecipient, SelectionValue } from '../../types';
-export interface AllContactsScope {
-    type: ContactsScope.Type.ALL_CONTACTS;
-    selection?: SelectionValue<Contact['id']>;
-}
-export interface ContactOrganisationsScope {
-    type: ContactsScope.Type.CONTACT_ORGANISATIONS;
-    contact_id: Contact['id'];
-    selection?: SelectionValue<Contact['id']>;
-}
-export interface ContactEmployeesScope {
-    type: ContactsScope.Type.CONTACT_EMPLOYEES;
-    contact_id: Contact['id'];
-    selection?: SelectionValue<Contact['id']>;
-}
-export interface CampaignRecipientsScope {
-    type: ContactsScope.Type.CAMPAIGN_RECIPIENTS;
-    campaign_id: Campaign['id'];
-    selection?: SelectionValue<EmailRecipient['id']>;
-}
-export interface CampaignReportScope {
-    type: ContactsScope.Type.CAMPAIGN_REPORT;
-    campaign_id: Campaign['id'];
-    report: 'recipients' | 'sent' | 'clicked' | 'opened' | 'unopened' | 'undelivered' | 'unsubscribed';
-    selection?: SelectionValue<EmailRecipient['id']>;
-}
-export declare type ContactsScope = AllContactsScope | ContactOrganisationsScope | ContactEmployeesScope | CampaignRecipientsScope | CampaignReportScope;
-export declare namespace ContactsScope {
-    enum Type {
-        ALL_CONTACTS = "scope:contacts",
-        CONTACT_EMPLOYEES = "scope:contact_employees",
-        CONTACT_ORGANISATIONS = "scope:contact_organisations",
-        CAMPAIGN_RECIPIENTS = "scope:campaign_recipients",
-        CAMPAIGN_REPORT = "scope:campaign_report"
-    }
-}