notifications-node-client 8.3.0 → 8.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "8.3.0",
+  "version": "8.3.2",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -9,12 +9,17 @@
   "description": "GOV.UK Notify Node.js client ",
   "main": "index.js",
   "types": "types/index.d.ts",
+  "files": [
+    "client",
+    "types",
+    "tsconfig.json"
+  ],
   "scripts": {
     "test": "mocha \"spec/**/*.js\" && npm run test:markdown:standard",
     "test:markdown:standard": "standard-markdown DOCUMENTATION.md",
     "integration": "mocha spec/integration/test.js",
     "build:types": "tsc",
-    "check:types": "tsc --noEmit"
+    "check:types": "tsc --noEmit ./spec/types-test.ts"
   },
   "engines": {
     "npm": ">=6.14.13",

package/types/client/api_client.d.ts

@@ -0,0 +1,44 @@
+export = ApiClient;
+/**
+ * @param {string} apiKeyOrUrl - API key (1 arg), or base URL (2-3 args)
+ * @param {string} [serviceIdOrApiKey] - API key (2 args), or service ID (3 args)
+ * @param {string} [apiKeyId] - API key (3 args)
+ * @constructor
+ */
+declare function ApiClient(apiKeyOrUrl: string, serviceIdOrApiKey?: string, apiKeyId?: string, ...args: any[]): void;
+declare class ApiClient {
+    /**
+     * @param {string} apiKeyOrUrl - API key (1 arg), or base URL (2-3 args)
+     * @param {string} [serviceIdOrApiKey] - API key (2 args), or service ID (3 args)
+     * @param {string} [apiKeyId] - API key (3 args)
+     * @constructor
+     */
+    constructor(apiKeyOrUrl: string, serviceIdOrApiKey?: string, apiKeyId?: string, ...args: any[]);
+    proxy: import("axios").AxiosProxyConfig;
+    restClient: import("axios").AxiosStatic;
+    urlBase: any;
+    apiKeyId: any;
+    serviceId: any;
+    /**
+     * @param {string} path
+     * @param {import('axios').AxiosRequestConfig} [additionalOptions]
+     * @returns {Promise<import('axios').AxiosResponse>}
+     */
+    get(path: string, additionalOptions?: import("axios").AxiosRequestConfig): Promise<import("axios").AxiosResponse>;
+    /**
+     * @param {string} path
+     * @param {object} data
+     * @returns {Promise<import('axios').AxiosResponse>}
+     */
+    post(path: string, data: object): Promise<import("axios").AxiosResponse>;
+    /**
+     * @param {import('axios').AxiosProxyConfig} proxyConfig
+     * @returns {void}
+     */
+    setProxy(proxyConfig: import("axios").AxiosProxyConfig): void;
+    /**
+     * @param {import('axios').AxiosInstance} restClient
+     * @returns {void}
+     */
+    setClient(restClient: import("axios").AxiosInstance): void;
+}

package/types/client/authentication.d.ts

@@ -0,0 +1,2 @@
+export = createGovukNotifyToken;
+declare function createGovukNotifyToken(request_method: any, request_path: any, secret: any, client_id: any): any;

package/types/client/notification.d.ts

@@ -0,0 +1,365 @@
+declare namespace _exports {
+    export { NotificationType, PostageType, TemplateRef, NotificationResponse, TemplateData };
+}
+declare namespace _exports {
+    export { NotifyClient };
+}
+export = _exports;
+type NotificationType = "sms" | "letter" | "email";
+type PostageType = "first" | "second" | "economy" | "europe" | "rest-of-world";
+type TemplateRef = {
+    id: string;
+    version: number;
+    uri: string;
+};
+type NotificationResponse = {
+    id: string;
+    reference?: string;
+    type: NotificationType;
+    status: string;
+    template: {
+        id: string;
+        name: string;
+        version: number;
+    };
+    body: string;
+    created_at: string;
+    created_by_name?: string;
+    sent_at?: string;
+    completed_at?: string;
+    scheduled_for?: string;
+    one_click_unsubscribe?: string;
+    is_cost_data_ready: boolean;
+    cost_in_pounds?: number;
+    cost_details?: {
+        billable_sheets_of_paper?: number;
+        postage?: string;
+    } | {
+        billable_sms_fragments?: number;
+        international_rate_multiplier?: number;
+        sms_rate?: number;
+    };
+    email_address?: string;
+    phone_number?: string;
+    subject?: string;
+    line_1?: string;
+    line_2?: string;
+    line_3?: string;
+    line_4?: string;
+    line_5?: string;
+    line_6?: string;
+    line_7?: string;
+    postage?: PostageType;
+};
+type TemplateData = {
+    id: string;
+    name: string;
+    type: NotificationType;
+    created_at: string;
+    updated_at: string | null;
+    created_by: string;
+    version: number;
+    body: string;
+    subject?: string;
+    letter_contact_block?: string;
+    postage?: PostageType;
+};
+/**
+ * @typedef {"sms" | "letter" | "email"} NotificationType
+ */
+/**
+ * @typedef {"first" | "second" | "economy" | "europe" | "rest-of-world"} PostageType
+ */
+/**
+ * @typedef {Object} TemplateRef
+ * @property {string} id
+ * @property {number} version
+ * @property {string} uri
+ */
+/**
+ * @typedef {Object} NotificationResponse
+ * @property {string} id
+ * @property {string} [reference]
+ * @property {NotificationType} type
+ * @property {string} status
+ * @property {{id: string, name: string, version: number}} template
+ * @property {string} body
+ * @property {string} created_at
+ * @property {string} [created_by_name]
+ * @property {string} [sent_at]
+ * @property {string} [completed_at]
+ * @property {string} [scheduled_for]
+ * @property {string} [one_click_unsubscribe]
+ * @property {boolean} is_cost_data_ready
+ * @property {number} [cost_in_pounds]
+ * @property {{billable_sheets_of_paper?: number, postage?: string} | {billable_sms_fragments?: number, international_rate_multiplier?: number, sms_rate?: number}} [cost_details]
+ * @property {string} [email_address]
+ * @property {string} [phone_number]
+ * @property {string} [subject]
+ * @property {string} [line_1]
+ * @property {string} [line_2]
+ * @property {string} [line_3]
+ * @property {string} [line_4]
+ * @property {string} [line_5]
+ * @property {string} [line_6]
+ * @property {string} [line_7]
+ * @property {PostageType} [postage]
+ */
+/**
+ * @typedef {Object} TemplateData
+ * @property {string} id
+ * @property {string} name
+ * @property {NotificationType} type
+ * @property {string} created_at
+ * @property {string | null} updated_at
+ * @property {string} created_by
+ * @property {number} version
+ * @property {string} body
+ * @property {string} [subject]
+ * @property {string} [letter_contact_block]
+ * @property {PostageType} [postage]
+ */
+/**
+ * @param {string} apiKeyOrUrl - API key (1 arg), or base URL (2-3 args)
+ * @param {string} [serviceIdOrApiKey] - API key (2 args), or service ID (3 args)
+ * @param {string} [apiKeyId] - API key (3 args)
+ * @constructor
+ */
+declare function NotifyClient(apiKeyOrUrl: string, serviceIdOrApiKey?: string, apiKeyId?: string, ...args: any[]): void;
+declare class NotifyClient {
+    /**
+     * @typedef {"sms" | "letter" | "email"} NotificationType
+     */
+    /**
+     * @typedef {"first" | "second" | "economy" | "europe" | "rest-of-world"} PostageType
+     */
+    /**
+     * @typedef {Object} TemplateRef
+     * @property {string} id
+     * @property {number} version
+     * @property {string} uri
+     */
+    /**
+     * @typedef {Object} NotificationResponse
+     * @property {string} id
+     * @property {string} [reference]
+     * @property {NotificationType} type
+     * @property {string} status
+     * @property {{id: string, name: string, version: number}} template
+     * @property {string} body
+     * @property {string} created_at
+     * @property {string} [created_by_name]
+     * @property {string} [sent_at]
+     * @property {string} [completed_at]
+     * @property {string} [scheduled_for]
+     * @property {string} [one_click_unsubscribe]
+     * @property {boolean} is_cost_data_ready
+     * @property {number} [cost_in_pounds]
+     * @property {{billable_sheets_of_paper?: number, postage?: string} | {billable_sms_fragments?: number, international_rate_multiplier?: number, sms_rate?: number}} [cost_details]
+     * @property {string} [email_address]
+     * @property {string} [phone_number]
+     * @property {string} [subject]
+     * @property {string} [line_1]
+     * @property {string} [line_2]
+     * @property {string} [line_3]
+     * @property {string} [line_4]
+     * @property {string} [line_5]
+     * @property {string} [line_6]
+     * @property {string} [line_7]
+     * @property {PostageType} [postage]
+     */
+    /**
+     * @typedef {Object} TemplateData
+     * @property {string} id
+     * @property {string} name
+     * @property {NotificationType} type
+     * @property {string} created_at
+     * @property {string | null} updated_at
+     * @property {string} created_by
+     * @property {number} version
+     * @property {string} body
+     * @property {string} [subject]
+     * @property {string} [letter_contact_block]
+     * @property {PostageType} [postage]
+     */
+    /**
+     * @param {string} apiKeyOrUrl - API key (1 arg), or base URL (2-3 args)
+     * @param {string} [serviceIdOrApiKey] - API key (2 args), or service ID (3 args)
+     * @param {string} [apiKeyId] - API key (3 args)
+     * @constructor
+     */
+    constructor(apiKeyOrUrl: string, serviceIdOrApiKey?: string, apiKeyId?: string, ...args: any[]);
+    apiClient: any;
+    /**
+     * @param {string} templateId
+     * @param {string} emailAddress
+     * @param {{personalisation?: Object, reference?: string, emailReplyToId?: string, oneClickUnsubscribeURL?: string}} [options]
+     * @returns {Promise<import('axios').AxiosResponse<{id: string, reference?: string, content: {body: string, subject: string, from_email: string, one_click_unsubscribe_url?: string}, uri: string, template: TemplateRef}>>}
+     */
+    sendEmail(templateId: string, emailAddress: string, options?: {
+        personalisation?: any;
+        reference?: string;
+        emailReplyToId?: string;
+        oneClickUnsubscribeURL?: string;
+    }): Promise<import("axios").AxiosResponse<{
+        id: string;
+        reference?: string;
+        content: {
+            body: string;
+            subject: string;
+            from_email: string;
+            one_click_unsubscribe_url?: string;
+        };
+        uri: string;
+        template: TemplateRef;
+    }>>;
+    /**
+     * @param {string} templateId
+     * @param {string} phoneNumber
+     * @param {{personalisation?: Object, reference?: string, smsSenderId?: string}} [options]
+     * @returns {Promise<import('axios').AxiosResponse<{id: string, reference?: string, content: {body: string, from_number: string}, uri: string, template: TemplateRef}>>}
+     */
+    sendSms(templateId: string, phoneNumber: string, options?: {
+        personalisation?: any;
+        reference?: string;
+        smsSenderId?: string;
+    }): Promise<import("axios").AxiosResponse<{
+        id: string;
+        reference?: string;
+        content: {
+            body: string;
+            from_number: string;
+        };
+        uri: string;
+        template: TemplateRef;
+    }>>;
+    /**
+     * @param {string} templateId
+     * @param {{personalisation?: Object, reference?: string}} [options]
+     * @returns {Promise<import('axios').AxiosResponse<{id: string, reference?: string, content: {body: string, subject: string}, uri: string, template: TemplateRef, scheduled_for: string | null}>>}
+     */
+    sendLetter(templateId: string, options?: {
+        personalisation?: any;
+        reference?: string;
+    }): Promise<import("axios").AxiosResponse<{
+        id: string;
+        reference?: string;
+        content: {
+            body: string;
+            subject: string;
+        };
+        uri: string;
+        template: TemplateRef;
+        scheduled_for: string | null;
+    }>>;
+    /**
+     * @param {string} reference
+     * @param {Buffer | string} pdf_file
+     * @param {"first" | "second" | "economy" | "europe" | "rest-of-world"} [postage]
+     * @returns {Promise<import('axios').AxiosResponse<{id: string, reference: string, postage: PostageType}>>}
+     */
+    sendPrecompiledLetter(reference: string, pdf_file: Buffer | string, postage?: "first" | "second" | "economy" | "europe" | "rest-of-world"): Promise<import("axios").AxiosResponse<{
+        id: string;
+        reference: string;
+        postage: PostageType;
+    }>>;
+    /**
+     * @param {string} notificationId
+     * @returns {Promise<import('axios').AxiosResponse<NotificationResponse>>}
+     */
+    getNotificationById(notificationId: string): Promise<import("axios").AxiosResponse<NotificationResponse>>;
+    /**
+     * @param {string} [templateType]
+     * @param {string} [status]
+     * @param {string} [reference]
+     * @param {string} [olderThanId]
+     * @returns {Promise<import('axios').AxiosResponse<{notifications: NotificationResponse[], links: {current: string, next: string}}>>}
+     */
+    getNotifications(templateType?: string, status?: string, reference?: string, olderThanId?: string): Promise<import("axios").AxiosResponse<{
+        notifications: NotificationResponse[];
+        links: {
+            current: string;
+            next: string;
+        };
+    }>>;
+    /**
+     * @param {string} notificationId
+     * @returns {Promise<Buffer>}
+     */
+    getPdfForLetterNotification(notificationId: string): Promise<Buffer>;
+    /**
+     * @param {string} templateId
+     * @returns {Promise<import('axios').AxiosResponse<TemplateData>>}
+     */
+    getTemplateById(templateId: string): Promise<import("axios").AxiosResponse<TemplateData>>;
+    /**
+     * @param {string} templateId
+     * @param {number} version
+     * @returns {Promise<import('axios').AxiosResponse<TemplateData>>}
+     */
+    getTemplateByIdAndVersion(templateId: string, version: number): Promise<import("axios").AxiosResponse<TemplateData>>;
+    /**
+     * @param {NotificationType} [templateType]
+     * @returns {Promise<import('axios').AxiosResponse<{templates: TemplateData[]}>>}
+     */
+    getAllTemplates(templateType?: NotificationType): Promise<import("axios").AxiosResponse<{
+        templates: TemplateData[];
+    }>>;
+    /**
+     * @param {string} templateId
+     * @param {Object} [personalisation]
+     * @returns {Promise<import('axios').AxiosResponse<{id: string, type: NotificationType, version: number, body: string, html?: string, subject?: string, postage?: PostageType}>>}
+     */
+    previewTemplateById(templateId: string, personalisation?: any): Promise<import("axios").AxiosResponse<{
+        id: string;
+        type: NotificationType;
+        version: number;
+        body: string;
+        html?: string;
+        subject?: string;
+        postage?: PostageType;
+    }>>;
+    /**
+     * @param {string} [olderThan]
+     * @returns {Promise<import('axios').AxiosResponse<{received_text_messages: Array<{id: string, user_number: string, notify_number: string, created_at: string, service_id: string, content: string}>, links: {current: string, next: string}}>>}
+     */
+    getReceivedTexts(olderThan?: string): Promise<import("axios").AxiosResponse<{
+        received_text_messages: Array<{
+            id: string;
+            user_number: string;
+            notify_number: string;
+            created_at: string;
+            service_id: string;
+            content: string;
+        }>;
+        links: {
+            current: string;
+            next: string;
+        };
+    }>>;
+    /**
+     * @param {import('axios').AxiosProxyConfig} proxyConfig
+     * @returns {void}
+     */
+    setProxy(proxyConfig: import("axios").AxiosProxyConfig): void;
+    /**
+     * @param {import('axios').AxiosInstance} client
+     * @returns {void}
+     */
+    setClient(client: import("axios").AxiosInstance): void;
+    /**
+     * @param {Buffer | string} fileData
+     * @param {{filename?: string, confirmEmailBeforeDownload?: boolean, retentionPeriod?: string}} [options]
+     * @returns {{file: string, filename: string | null, confirm_email_before_download: boolean | null, retention_period: string | null}}
+     */
+    prepareUpload(fileData: Buffer | string, options?: {
+        filename?: string;
+        confirmEmailBeforeDownload?: boolean;
+        retentionPeriod?: string;
+    }): {
+        file: string;
+        filename: string | null;
+        confirm_email_before_download: boolean | null;
+        retention_period: string | null;
+    };
+}

package/types/index.d.ts

@@ -0,0 +1,3 @@
+import NotifyClient_1 = require("./client/notification.js");
+import NotifyClient = NotifyClient_1.NotifyClient;
+export { NotifyClient };

package/.dockerignore

@@ -1 +0,0 @@
-**/.git/*

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +0,0 @@
-<!--Thanks for contributing to GOV.UK Notify. Using this template to write your pull request message will help get it merged as soon as possible. -->
-
-## What problem does the pull request solve?
-<!--- Describe why you’re making this change -->
-
-## Checklist
-
-<!--- All of the following are normally needed. Don’t worry if you haven’t done them or don’t know how – someone from the Notify team will be able to help. -->
-- [x] I’ve used the pull request template
-- [ ] I’ve written unit tests for these changes
-- [ ] I’ve updated the documentation in
-  - [notifications-tech-docs repository](https://github.com/alphagov/notifications-tech-docs/blob/main/source/documentation/client_docs/_node.md)
-  - `CHANGELOG.md`
-- [ ] I’ve bumped the version number in
-  - `package.json`
-- [ ] I've added new environment variables in
-  - `CONTRIBUTING.md`
-  - `notifications-node-client/scripts/generate_docker_env.sh`