From 8cf8d205ce9a37f3984f481108dba4aa5e66792b Mon Sep 17 00:00:00 2001 From: Igor Balos Date: Wed, 31 Oct 2018 14:02:03 +0100 Subject: [PATCH] updated aliases for types for backward compatibility --- docs/classes/serverclient.html | 102 ++++++++++++++++----------------- package-lock.json | 28 ++++----- package.json | 2 +- src/client/BaseClient.ts | 4 +- src/client/ServerClient.ts | 1 - src/index.ts | 19 +++--- 6 files changed, 78 insertions(+), 78 deletions(-) diff --git a/docs/classes/serverclient.html b/docs/classes/serverclient.html index bb6c512b..7587d1cd 100644 --- a/docs/classes/serverclient.html +++ b/docs/classes/serverclient.html @@ -1191,7 +1191,7 @@

constructor

  • @@ -1260,7 +1260,7 @@

    activateBounce

  • @@ -1298,7 +1298,7 @@

    bypassBlockedInboundMessage

  • @@ -1336,7 +1336,7 @@

    createInboundRuleTrigger

  • @@ -1374,7 +1374,7 @@

    createTagTrigger

  • @@ -1412,7 +1412,7 @@

    createTemplate

  • @@ -1450,7 +1450,7 @@

    deleteInboundRuleTrigger

  • @@ -1488,7 +1488,7 @@

    deleteTagTrigger

  • @@ -1526,7 +1526,7 @@

    deleteTemplate

  • @@ -1564,7 +1564,7 @@

    editServer

  • @@ -1602,7 +1602,7 @@

    editTagTrigger

  • @@ -1646,7 +1646,7 @@

    editTemplate

  • @@ -1690,7 +1690,7 @@

    getBounce

  • @@ -1728,7 +1728,7 @@

    getBounceCounts

  • @@ -1766,7 +1766,7 @@

    getBounceDump

  • @@ -1804,7 +1804,7 @@

    getBounceTags

  • @@ -1836,7 +1836,7 @@

    getBounces

  • @@ -1874,7 +1874,7 @@

    getClickBrowserUsage

  • @@ -1912,7 +1912,7 @@

    getClickCounts

  • @@ -1950,7 +1950,7 @@

    getClickLocation

  • @@ -1988,7 +1988,7 @@

    getClickPlatformUsage

  • @@ -2026,7 +2026,7 @@

    getDeliveryStatistics

  • @@ -2058,7 +2058,7 @@

    getEmailOpenClientUsage

  • @@ -2096,7 +2096,7 @@

    getEmailOpenCounts

  • @@ -2134,7 +2134,7 @@

    getEmailOpenPlatformUsage

  • @@ -2172,7 +2172,7 @@

    getEmailOpenReadTimes

  • @@ -2210,7 +2210,7 @@

    getInboundMessageDetails

  • @@ -2248,7 +2248,7 @@

    getInboundMessages

  • @@ -2286,7 +2286,7 @@

    getInboundRuleTriggers

  • @@ -2324,7 +2324,7 @@

    getMessageClicks

  • @@ -2362,7 +2362,7 @@

    getMessageClicksForSingleMessage

  • @@ -2406,7 +2406,7 @@

    getMessageOpens

  • @@ -2444,7 +2444,7 @@

    getMessageOpensForSingleMessage

  • @@ -2485,7 +2485,7 @@

    getOutboundMessageDetails

  • @@ -2523,7 +2523,7 @@

    getOutboundMessageDump

  • @@ -2561,7 +2561,7 @@

    getOutboundMessages

  • @@ -2599,7 +2599,7 @@

    getOutboundOverview

  • @@ -2637,7 +2637,7 @@

    getSentCounts

  • @@ -2675,7 +2675,7 @@

    getServer

  • @@ -2707,7 +2707,7 @@

    getSpamComplaintsCounts

  • @@ -2745,7 +2745,7 @@

    getTagTrigger

  • @@ -2783,7 +2783,7 @@

    getTagTriggers

  • @@ -2821,7 +2821,7 @@

    getTemplate

  • @@ -2859,7 +2859,7 @@

    getTemplates

  • @@ -2897,7 +2897,7 @@

    getTrackedEmailCounts

  • @@ -2935,7 +2935,7 @@

    retryInboundHookForMessage

  • @@ -2973,7 +2973,7 @@

    sendEmail

  • @@ -3011,7 +3011,7 @@

    sendEmailBatch

  • @@ -3049,7 +3049,7 @@

    sendEmailBatchWithTemplates

  • @@ -3087,7 +3087,7 @@

    sendEmailWithTemplate

  • @@ -3125,7 +3125,7 @@

    validateTemplate

  • diff --git a/package-lock.json b/package-lock.json index b6949496..2cedcd02 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "postmark", - "version": "2.1.1", + "version": "2.2.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -11,9 +11,9 @@ "dev": true }, "@types/chai": { - "version": "4.1.6", - "resolved": "https://registry.npmjs.org/@types/chai/-/chai-4.1.6.tgz", - "integrity": "sha512-CBk7KTZt3FhPsEkYioG6kuCIpWISw+YI8o+3op4+NXwTpvAPxE1ES8+PY8zfaK2L98b1z5oq03UHa4VYpeUxnw==", + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-4.1.7.tgz", + "integrity": "sha512-2Y8uPt0/jwjhQ6EiluT0XCri1Dbplr0ZxfFXUz+ye13gaqE8u5gL5ppao1JrUYr9cIip5S6MvQzBS7Kke7U9VA==", "dev": true }, "@types/events": { @@ -88,15 +88,15 @@ "dev": true }, "@types/node": { - "version": "10.12.0", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.12.0.tgz", - "integrity": "sha512-3TUHC3jsBAB7qVRGxT6lWyYo2v96BMmD2PTcl47H25Lu7UXtFH/2qqmKiVrnel6Ne//0TFYf6uvNX+HW2FRkLQ==", + "version": "10.12.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.12.1.tgz", + "integrity": "sha512-i1sl+WCX2OCHeUi9oi7PiCNUtYFrpWhpcx878vpeq/tlZTKzcFdHePlyFHVbWqeuKN0SRPl/9ZFDSTsfv9h7VQ==", "dev": true }, "@types/request": { - "version": "2.47.1", - "resolved": "https://registry.npmjs.org/@types/request/-/request-2.47.1.tgz", - "integrity": "sha512-TV3XLvDjQbIeVxJ1Z3oCTDk/KuYwwcNKVwz2YaT0F5u86Prgc4syDAp6P96rkTQQ4bIdh+VswQIC9zS6NjY7/g==", + "version": "2.48.0", + "resolved": "https://registry.npmjs.org/@types/request/-/request-2.48.0.tgz", + "integrity": "sha512-KnfoOtqXKllSqfXSEvGTd8KDkNlpHs+PWr6I6XiEIWk/jckH3pNmWDXNFZyPkB9wApb8vzDq2wMByM/0GFSmXg==", "dev": true, "requires": { "@types/caseless": "*", @@ -333,7 +333,7 @@ }, "fast-deep-equal": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-1.1.0.tgz", + "resolved": "http://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-1.1.0.tgz", "integrity": "sha1-wFNHeBfIa1HaqFPIHgWbcz0CNhQ=" }, "fast-json-stable-stringify": { @@ -802,9 +802,9 @@ } }, "sshpk": { - "version": "1.15.1", - "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.15.1.tgz", - "integrity": "sha512-mSdgNUaidk+dRU5MhYtN9zebdzF2iG0cNPWy8HG+W8y+fT1JnSkh0fzzpjOa0L7P8i1Rscz38t0h4gPcKz43xA==", + "version": "1.15.2", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.15.2.tgz", + "integrity": "sha512-Ra/OXQtuh0/enyl4ETZAfTaeksa6BXks5ZcjpSUNrjBr0DvrJKX+1fsKDPpT9TBXgHAFsa4510aNVgI8g/+SzA==", "requires": { "asn1": "~0.2.3", "assert-plus": "^1.0.0", diff --git a/package.json b/package.json index c1620917..6a5fb776 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "sending", "transactional" ], - "version": "2.1.1", + "version": "2.2.0", "author": "Igor Balos", "contributors": [ "Aaron Blum", diff --git a/src/client/BaseClient.ts b/src/client/BaseClient.ts index 158cc39d..aaff234d 100644 --- a/src/client/BaseClient.ts +++ b/src/client/BaseClient.ts @@ -192,10 +192,10 @@ export default abstract class BaseClient { } /** - * Set default values for count and offset when doing filtering with API requests. + * Set default values for count and offset when doing filtering with API requests if they are not specified by filter. * Defaults can be seen in [[DefaultPaginationValues]]. */ - protected setDefaultPaginationValues(filter: FilteringParameters) { + protected setDefaultPaginationValues(filter: FilteringParameters): void { filter.count = filter.count || DefaultPaginationValues.count; filter.offset = filter.offset || DefaultPaginationValues.offset; } diff --git a/src/client/ServerClient.ts b/src/client/ServerClient.ts index 0dc0651e..097135ec 100644 --- a/src/client/ServerClient.ts +++ b/src/client/ServerClient.ts @@ -5,7 +5,6 @@ import { Callback, DefaultResponse, FilteringParameters, - DefaultPaginationValues, } from './models/index'; import { diff --git a/src/index.ts b/src/index.ts index 467626a8..a0574e71 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,14 +4,15 @@ import AccountClient from './client/AccountClient'; import * as Models from './client/models'; import * as Errors from './client/models/client/Errors' -// New client types are provided also as aliases, to provide compatibility with version 1.x of the library. -type Client = ServerClient; -type AdminClient = AccountClient; +// Essential types are exposed directly +// to make working with common requests simpler. +import {Message} from "./client/models"; +import {TemplatedMessage} from "./client/models"; +import {Attachment} from "./client/models"; +import {Header} from "./client/models"; -// These essential types are exposed directly to make working with common requests simpler. -type Message = Models.Message; -type TemplatedMessage = Models.TemplatedMessage; -type Attachment = Models.Attachment; -type Header = Models.Header; +export {ServerClient, AccountClient, Models, Errors}; +export {Message, TemplatedMessage, Attachment, Header} -export { ServerClient, AccountClient,Client, AdminClient, Models, Errors, Message, TemplatedMessage, Attachment, Header }; \ No newline at end of file +// Client aliases are provided for backward compatibility with version 1.x +export {ServerClient as Client, AccountClient as AdminClient} \ No newline at end of file