postgrid-node 0.3.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/README.md +31 -0
- package/client.d.mts +8 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +8 -2
- package/client.d.ts.map +1 -1
- package/client.js +8 -0
- package/client.js.map +1 -1
- package/client.mjs +9 -1
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +60 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +60 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +107 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +101 -0
- package/core/pagination.mjs.map +1 -0
- package/index.d.mts +1 -0
- package/index.d.mts.map +1 -1
- package/index.d.ts +1 -0
- package/index.d.ts.map +1 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -0
- package/index.mjs.map +1 -1
- package/internal/tslib.js +17 -17
- package/package.json +11 -1
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/print-mail/bank-accounts.d.mts +9 -14
- package/resources/print-mail/bank-accounts.d.mts.map +1 -1
- package/resources/print-mail/bank-accounts.d.ts +9 -14
- package/resources/print-mail/bank-accounts.d.ts.map +1 -1
- package/resources/print-mail/bank-accounts.js +9 -3
- package/resources/print-mail/bank-accounts.js.map +1 -1
- package/resources/print-mail/bank-accounts.mjs +9 -3
- package/resources/print-mail/bank-accounts.mjs.map +1 -1
- package/resources/print-mail/boxes.d.mts +14 -566
- package/resources/print-mail/boxes.d.mts.map +1 -1
- package/resources/print-mail/boxes.d.ts +14 -566
- package/resources/print-mail/boxes.d.ts.map +1 -1
- package/resources/print-mail/boxes.js +6 -2
- package/resources/print-mail/boxes.js.map +1 -1
- package/resources/print-mail/boxes.mjs +6 -2
- package/resources/print-mail/boxes.mjs.map +1 -1
- package/resources/print-mail/campaigns.d.mts +9 -16
- package/resources/print-mail/campaigns.d.mts.map +1 -1
- package/resources/print-mail/campaigns.d.ts +9 -16
- package/resources/print-mail/campaigns.d.ts.map +1 -1
- package/resources/print-mail/campaigns.js +6 -2
- package/resources/print-mail/campaigns.js.map +1 -1
- package/resources/print-mail/campaigns.mjs +6 -2
- package/resources/print-mail/campaigns.mjs.map +1 -1
- package/resources/print-mail/cheques.d.mts +13 -426
- package/resources/print-mail/cheques.d.mts.map +1 -1
- package/resources/print-mail/cheques.d.ts +13 -426
- package/resources/print-mail/cheques.d.ts.map +1 -1
- package/resources/print-mail/cheques.js +6 -2
- package/resources/print-mail/cheques.js.map +1 -1
- package/resources/print-mail/cheques.mjs +6 -2
- package/resources/print-mail/cheques.mjs.map +1 -1
- package/resources/print-mail/contacts.d.mts +11 -152
- package/resources/print-mail/contacts.d.mts.map +1 -1
- package/resources/print-mail/contacts.d.ts +11 -152
- package/resources/print-mail/contacts.d.ts.map +1 -1
- package/resources/print-mail/contacts.js +6 -2
- package/resources/print-mail/contacts.js.map +1 -1
- package/resources/print-mail/contacts.mjs +6 -2
- package/resources/print-mail/contacts.mjs.map +1 -1
- package/resources/print-mail/index.d.mts +14 -14
- package/resources/print-mail/index.d.mts.map +1 -1
- package/resources/print-mail/index.d.ts +14 -14
- package/resources/print-mail/index.d.ts.map +1 -1
- package/resources/print-mail/index.js.map +1 -1
- package/resources/print-mail/index.mjs.map +1 -1
- package/resources/print-mail/letters.d.mts +14 -565
- package/resources/print-mail/letters.d.mts.map +1 -1
- package/resources/print-mail/letters.d.ts +14 -565
- package/resources/print-mail/letters.d.ts.map +1 -1
- package/resources/print-mail/letters.js +6 -2
- package/resources/print-mail/letters.js.map +1 -1
- package/resources/print-mail/letters.mjs +6 -2
- package/resources/print-mail/letters.mjs.map +1 -1
- package/resources/print-mail/mailing-list-imports.d.mts +9 -17
- package/resources/print-mail/mailing-list-imports.d.mts.map +1 -1
- package/resources/print-mail/mailing-list-imports.d.ts +9 -17
- package/resources/print-mail/mailing-list-imports.d.ts.map +1 -1
- package/resources/print-mail/mailing-list-imports.js +6 -3
- package/resources/print-mail/mailing-list-imports.js.map +1 -1
- package/resources/print-mail/mailing-list-imports.mjs +6 -3
- package/resources/print-mail/mailing-list-imports.mjs.map +1 -1
- package/resources/print-mail/mailing-lists.d.mts +9 -17
- package/resources/print-mail/mailing-lists.d.mts.map +1 -1
- package/resources/print-mail/mailing-lists.d.ts +9 -17
- package/resources/print-mail/mailing-lists.d.ts.map +1 -1
- package/resources/print-mail/mailing-lists.js +9 -3
- package/resources/print-mail/mailing-lists.js.map +1 -1
- package/resources/print-mail/mailing-lists.mjs +9 -3
- package/resources/print-mail/mailing-lists.mjs.map +1 -1
- package/resources/print-mail/order-profiles/cheques.d.mts +80 -90
- package/resources/print-mail/order-profiles/cheques.d.mts.map +1 -1
- package/resources/print-mail/order-profiles/cheques.d.ts +80 -90
- package/resources/print-mail/order-profiles/cheques.d.ts.map +1 -1
- package/resources/print-mail/order-profiles/cheques.js +9 -3
- package/resources/print-mail/order-profiles/cheques.js.map +1 -1
- package/resources/print-mail/order-profiles/cheques.mjs +9 -3
- package/resources/print-mail/order-profiles/cheques.mjs.map +1 -1
- package/resources/print-mail/order-profiles/index.d.mts +4 -4
- package/resources/print-mail/order-profiles/index.d.mts.map +1 -1
- package/resources/print-mail/order-profiles/index.d.ts +4 -4
- package/resources/print-mail/order-profiles/index.d.ts.map +1 -1
- package/resources/print-mail/order-profiles/index.js.map +1 -1
- package/resources/print-mail/order-profiles/index.mjs.map +1 -1
- package/resources/print-mail/order-profiles/letters.d.mts +9 -17
- package/resources/print-mail/order-profiles/letters.d.mts.map +1 -1
- package/resources/print-mail/order-profiles/letters.d.ts +9 -17
- package/resources/print-mail/order-profiles/letters.d.ts.map +1 -1
- package/resources/print-mail/order-profiles/letters.js +9 -3
- package/resources/print-mail/order-profiles/letters.js.map +1 -1
- package/resources/print-mail/order-profiles/letters.mjs +9 -3
- package/resources/print-mail/order-profiles/letters.mjs.map +1 -1
- package/resources/print-mail/order-profiles/order-profiles.d.mts +8 -8
- package/resources/print-mail/order-profiles/order-profiles.d.mts.map +1 -1
- package/resources/print-mail/order-profiles/order-profiles.d.ts +8 -8
- package/resources/print-mail/order-profiles/order-profiles.d.ts.map +1 -1
- package/resources/print-mail/order-profiles/order-profiles.js.map +1 -1
- package/resources/print-mail/order-profiles/order-profiles.mjs.map +1 -1
- package/resources/print-mail/order-profiles/postcards.d.mts +9 -17
- package/resources/print-mail/order-profiles/postcards.d.mts.map +1 -1
- package/resources/print-mail/order-profiles/postcards.d.ts +9 -17
- package/resources/print-mail/order-profiles/postcards.d.ts.map +1 -1
- package/resources/print-mail/order-profiles/postcards.js +9 -3
- package/resources/print-mail/order-profiles/postcards.js.map +1 -1
- package/resources/print-mail/order-profiles/postcards.mjs +9 -3
- package/resources/print-mail/order-profiles/postcards.mjs.map +1 -1
- package/resources/print-mail/order-profiles/self-mailers.d.mts +9 -17
- package/resources/print-mail/order-profiles/self-mailers.d.mts.map +1 -1
- package/resources/print-mail/order-profiles/self-mailers.d.ts +9 -17
- package/resources/print-mail/order-profiles/self-mailers.d.ts.map +1 -1
- package/resources/print-mail/order-profiles/self-mailers.js +6 -3
- package/resources/print-mail/order-profiles/self-mailers.js.map +1 -1
- package/resources/print-mail/order-profiles/self-mailers.mjs +6 -3
- package/resources/print-mail/order-profiles/self-mailers.mjs.map +1 -1
- package/resources/print-mail/postcards.d.mts +16 -841
- package/resources/print-mail/postcards.d.mts.map +1 -1
- package/resources/print-mail/postcards.d.ts +16 -841
- package/resources/print-mail/postcards.d.ts.map +1 -1
- package/resources/print-mail/postcards.js +6 -2
- package/resources/print-mail/postcards.js.map +1 -1
- package/resources/print-mail/postcards.mjs +6 -2
- package/resources/print-mail/postcards.mjs.map +1 -1
- package/resources/print-mail/print-mail.d.mts +163 -26
- package/resources/print-mail/print-mail.d.mts.map +1 -1
- package/resources/print-mail/print-mail.d.ts +163 -26
- package/resources/print-mail/print-mail.d.ts.map +1 -1
- package/resources/print-mail/print-mail.js.map +1 -1
- package/resources/print-mail/print-mail.mjs.map +1 -1
- package/resources/print-mail/reports/index.d.mts +1 -1
- package/resources/print-mail/reports/index.d.mts.map +1 -1
- package/resources/print-mail/reports/index.d.ts +1 -1
- package/resources/print-mail/reports/index.d.ts.map +1 -1
- package/resources/print-mail/reports/reports.d.mts +9 -16
- package/resources/print-mail/reports/reports.d.mts.map +1 -1
- package/resources/print-mail/reports/reports.d.ts +9 -16
- package/resources/print-mail/reports/reports.d.ts.map +1 -1
- package/resources/print-mail/reports/reports.js +6 -2
- package/resources/print-mail/reports/reports.js.map +1 -1
- package/resources/print-mail/reports/reports.mjs +6 -2
- package/resources/print-mail/reports/reports.mjs.map +1 -1
- package/resources/print-mail/self-mailers.d.mts +16 -842
- package/resources/print-mail/self-mailers.d.mts.map +1 -1
- package/resources/print-mail/self-mailers.d.ts +16 -842
- package/resources/print-mail/self-mailers.d.ts.map +1 -1
- package/resources/print-mail/self-mailers.js +9 -3
- package/resources/print-mail/self-mailers.js.map +1 -1
- package/resources/print-mail/self-mailers.mjs +9 -3
- package/resources/print-mail/self-mailers.mjs.map +1 -1
- package/resources/print-mail/sub-organizations.d.mts +9 -14
- package/resources/print-mail/sub-organizations.d.mts.map +1 -1
- package/resources/print-mail/sub-organizations.d.ts +9 -14
- package/resources/print-mail/sub-organizations.d.ts.map +1 -1
- package/resources/print-mail/sub-organizations.js +9 -3
- package/resources/print-mail/sub-organizations.js.map +1 -1
- package/resources/print-mail/sub-organizations.mjs +9 -3
- package/resources/print-mail/sub-organizations.mjs.map +1 -1
- package/resources/print-mail/templates.d.mts +9 -13
- package/resources/print-mail/templates.d.mts.map +1 -1
- package/resources/print-mail/templates.d.ts +9 -13
- package/resources/print-mail/templates.d.ts.map +1 -1
- package/resources/print-mail/templates.js +6 -2
- package/resources/print-mail/templates.js.map +1 -1
- package/resources/print-mail/templates.mjs +6 -2
- package/resources/print-mail/templates.mjs.map +1 -1
- package/src/client.ts +34 -2
- package/src/core/pagination.ts +171 -0
- package/src/index.ts +1 -0
- package/src/pagination.ts +2 -0
- package/src/resources/index.ts +5 -1
- package/src/resources/print-mail/bank-accounts.ts +14 -22
- package/src/resources/print-mail/boxes.ts +19 -686
- package/src/resources/print-mail/campaigns.ts +11 -24
- package/src/resources/print-mail/cheques.ts +15 -527
- package/src/resources/print-mail/contacts.ts +14 -189
- package/src/resources/print-mail/index.ts +14 -14
- package/src/resources/print-mail/letters.ts +16 -697
- package/src/resources/print-mail/mailing-list-imports.ts +15 -25
- package/src/resources/print-mail/mailing-lists.ts +14 -25
- package/src/resources/print-mail/order-profiles/cheques.ts +91 -103
- package/src/resources/print-mail/order-profiles/index.ts +4 -3
- package/src/resources/print-mail/order-profiles/letters.ts +14 -25
- package/src/resources/print-mail/order-profiles/order-profiles.ts +8 -6
- package/src/resources/print-mail/order-profiles/postcards.ts +14 -25
- package/src/resources/print-mail/order-profiles/self-mailers.ts +15 -25
- package/src/resources/print-mail/postcards.ts +18 -1035
- package/src/resources/print-mail/print-mail.ts +195 -26
- package/src/resources/print-mail/reports/index.ts +1 -1
- package/src/resources/print-mail/reports/reports.ts +11 -24
- package/src/resources/print-mail/self-mailers.ts +21 -1036
- package/src/resources/print-mail/sub-organizations.ts +14 -22
- package/src/resources/print-mail/templates.ts +11 -21
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import * as BoxesAPI from "./boxes.mjs";
|
|
3
3
|
import * as ContactsAPI from "./contacts.mjs";
|
|
4
|
+
import * as PrintMailAPI from "./print-mail.mjs";
|
|
4
5
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
6
|
+
import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.mjs";
|
|
5
7
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
6
8
|
export declare class Cheques extends APIResource {
|
|
7
9
|
/**
|
|
@@ -59,10 +61,13 @@ export declare class Cheques extends APIResource {
|
|
|
59
61
|
*
|
|
60
62
|
* @example
|
|
61
63
|
* ```ts
|
|
62
|
-
*
|
|
64
|
+
* // Automatically fetches more pages as needed.
|
|
65
|
+
* for await (const cheque of client.printMail.cheques.list()) {
|
|
66
|
+
* // ...
|
|
67
|
+
* }
|
|
63
68
|
* ```
|
|
64
69
|
*/
|
|
65
|
-
list(query?: ChequeListParams | null | undefined, options?: RequestOptions):
|
|
70
|
+
list(query?: ChequeListParams | null | undefined, options?: RequestOptions): PagePromise<ChequesSkipLimit, Cheque>;
|
|
66
71
|
/**
|
|
67
72
|
* Cancel a cheque by ID. Note that this operation cannot be undone.
|
|
68
73
|
*
|
|
@@ -104,6 +109,7 @@ export declare class Cheques extends APIResource {
|
|
|
104
109
|
*/
|
|
105
110
|
retrieveWithDepositReadyPdf(id: string, options?: RequestOptions): APIPromise<Cheque>;
|
|
106
111
|
}
|
|
112
|
+
export type ChequesSkipLimit = SkipLimit<Cheque>;
|
|
107
113
|
export interface Cheque {
|
|
108
114
|
/**
|
|
109
115
|
* A unique ID prefixed with cheque\_
|
|
@@ -269,13 +275,6 @@ export interface DigitalOnly {
|
|
|
269
275
|
*/
|
|
270
276
|
watermark: string;
|
|
271
277
|
}
|
|
272
|
-
export interface ChequeListResponse {
|
|
273
|
-
data: Array<Cheque>;
|
|
274
|
-
limit: number;
|
|
275
|
-
object: 'list';
|
|
276
|
-
skip: number;
|
|
277
|
-
totalCount: number;
|
|
278
|
-
}
|
|
279
278
|
export interface ChequeRetrieveURLResponse {
|
|
280
279
|
/**
|
|
281
280
|
* A unique ID prefixed with cheque\_
|
|
@@ -301,14 +300,14 @@ export interface ChequeCreateParams {
|
|
|
301
300
|
* The contact information of the sender. You can pass contact information inline
|
|
302
301
|
* here just like you can for the `to`.
|
|
303
302
|
*/
|
|
304
|
-
from:
|
|
303
|
+
from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
|
|
305
304
|
/**
|
|
306
305
|
* The recipient of this order. You can either supply the contact information
|
|
307
306
|
* inline here or provide a contact ID. PostGrid will automatically deduplicate
|
|
308
307
|
* contacts regardless of whether you provide the information inline here or call
|
|
309
308
|
* the contact creation endpoint.
|
|
310
309
|
*/
|
|
311
|
-
to:
|
|
310
|
+
to: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
|
|
312
311
|
/**
|
|
313
312
|
* The currency code of the cheque. This will be set to the default currency of the
|
|
314
313
|
* bank account (`USD` for US bank accounts and `CAD` for Canadian bank accounts)
|
|
@@ -378,7 +377,7 @@ export interface ChequeCreateParams {
|
|
|
378
377
|
* mail it forward to the final recipient yourself. One use case for this is
|
|
379
378
|
* signing cheques at your office before mailing them out yourself.
|
|
380
379
|
*/
|
|
381
|
-
redirectTo?:
|
|
380
|
+
redirectTo?: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
|
|
382
381
|
/**
|
|
383
382
|
* This order will transition from `ready` to `printing` on the day after this
|
|
384
383
|
* date. You can use this parameter to schedule orders for a future date.
|
|
@@ -389,418 +388,7 @@ export interface ChequeCreateParams {
|
|
|
389
388
|
*/
|
|
390
389
|
size?: ChequeSize;
|
|
391
390
|
}
|
|
392
|
-
export
|
|
393
|
-
interface ContactCreateWithFirstName {
|
|
394
|
-
/**
|
|
395
|
-
* The first line of the contact's address.
|
|
396
|
-
*/
|
|
397
|
-
addressLine1: string;
|
|
398
|
-
/**
|
|
399
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
400
|
-
*/
|
|
401
|
-
countryCode: string;
|
|
402
|
-
firstName: string;
|
|
403
|
-
/**
|
|
404
|
-
* Second line of the contact's address, if applicable.
|
|
405
|
-
*/
|
|
406
|
-
addressLine2?: string;
|
|
407
|
-
/**
|
|
408
|
-
* The city of the contact's address.
|
|
409
|
-
*/
|
|
410
|
-
city?: string;
|
|
411
|
-
/**
|
|
412
|
-
* Company name of the contact.
|
|
413
|
-
*/
|
|
414
|
-
companyName?: string;
|
|
415
|
-
/**
|
|
416
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
417
|
-
* dashboard.
|
|
418
|
-
*/
|
|
419
|
-
description?: string;
|
|
420
|
-
/**
|
|
421
|
-
* Email of the contact.
|
|
422
|
-
*/
|
|
423
|
-
email?: string;
|
|
424
|
-
/**
|
|
425
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
426
|
-
* `verified` even if our address verification system says otherwise.
|
|
427
|
-
*/
|
|
428
|
-
forceVerifiedStatus?: boolean;
|
|
429
|
-
/**
|
|
430
|
-
* Job title of the contact.
|
|
431
|
-
*/
|
|
432
|
-
jobTitle?: string;
|
|
433
|
-
/**
|
|
434
|
-
* Last name of the contact.
|
|
435
|
-
*/
|
|
436
|
-
lastName?: string;
|
|
437
|
-
/**
|
|
438
|
-
* See the section on Metadata.
|
|
439
|
-
*/
|
|
440
|
-
metadata?: {
|
|
441
|
-
[key: string]: unknown;
|
|
442
|
-
};
|
|
443
|
-
/**
|
|
444
|
-
* Phone number of the contact.
|
|
445
|
-
*/
|
|
446
|
-
phoneNumber?: string;
|
|
447
|
-
/**
|
|
448
|
-
* The postal or ZIP code of the contact's address.
|
|
449
|
-
*/
|
|
450
|
-
postalOrZip?: string;
|
|
451
|
-
/**
|
|
452
|
-
* Province or state of the contact's address.
|
|
453
|
-
*/
|
|
454
|
-
provinceOrState?: string;
|
|
455
|
-
/**
|
|
456
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
457
|
-
* verification system.
|
|
458
|
-
*/
|
|
459
|
-
skipVerification?: boolean;
|
|
460
|
-
}
|
|
461
|
-
interface ContactCreateWithCompanyName {
|
|
462
|
-
/**
|
|
463
|
-
* The first line of the contact's address.
|
|
464
|
-
*/
|
|
465
|
-
addressLine1: string;
|
|
466
|
-
companyName: string;
|
|
467
|
-
/**
|
|
468
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
469
|
-
*/
|
|
470
|
-
countryCode: string;
|
|
471
|
-
/**
|
|
472
|
-
* Second line of the contact's address, if applicable.
|
|
473
|
-
*/
|
|
474
|
-
addressLine2?: string;
|
|
475
|
-
/**
|
|
476
|
-
* The city of the contact's address.
|
|
477
|
-
*/
|
|
478
|
-
city?: string;
|
|
479
|
-
/**
|
|
480
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
481
|
-
* dashboard.
|
|
482
|
-
*/
|
|
483
|
-
description?: string;
|
|
484
|
-
/**
|
|
485
|
-
* Email of the contact.
|
|
486
|
-
*/
|
|
487
|
-
email?: string;
|
|
488
|
-
/**
|
|
489
|
-
* First name of the contact.
|
|
490
|
-
*/
|
|
491
|
-
firstName?: string;
|
|
492
|
-
/**
|
|
493
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
494
|
-
* `verified` even if our address verification system says otherwise.
|
|
495
|
-
*/
|
|
496
|
-
forceVerifiedStatus?: boolean;
|
|
497
|
-
/**
|
|
498
|
-
* Job title of the contact.
|
|
499
|
-
*/
|
|
500
|
-
jobTitle?: string;
|
|
501
|
-
/**
|
|
502
|
-
* Last name of the contact.
|
|
503
|
-
*/
|
|
504
|
-
lastName?: string;
|
|
505
|
-
/**
|
|
506
|
-
* See the section on Metadata.
|
|
507
|
-
*/
|
|
508
|
-
metadata?: {
|
|
509
|
-
[key: string]: unknown;
|
|
510
|
-
};
|
|
511
|
-
/**
|
|
512
|
-
* Phone number of the contact.
|
|
513
|
-
*/
|
|
514
|
-
phoneNumber?: string;
|
|
515
|
-
/**
|
|
516
|
-
* The postal or ZIP code of the contact's address.
|
|
517
|
-
*/
|
|
518
|
-
postalOrZip?: string;
|
|
519
|
-
/**
|
|
520
|
-
* Province or state of the contact's address.
|
|
521
|
-
*/
|
|
522
|
-
provinceOrState?: string;
|
|
523
|
-
/**
|
|
524
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
525
|
-
* verification system.
|
|
526
|
-
*/
|
|
527
|
-
skipVerification?: boolean;
|
|
528
|
-
}
|
|
529
|
-
interface ContactCreateWithFirstName {
|
|
530
|
-
/**
|
|
531
|
-
* The first line of the contact's address.
|
|
532
|
-
*/
|
|
533
|
-
addressLine1: string;
|
|
534
|
-
/**
|
|
535
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
536
|
-
*/
|
|
537
|
-
countryCode: string;
|
|
538
|
-
firstName: string;
|
|
539
|
-
/**
|
|
540
|
-
* Second line of the contact's address, if applicable.
|
|
541
|
-
*/
|
|
542
|
-
addressLine2?: string;
|
|
543
|
-
/**
|
|
544
|
-
* The city of the contact's address.
|
|
545
|
-
*/
|
|
546
|
-
city?: string;
|
|
547
|
-
/**
|
|
548
|
-
* Company name of the contact.
|
|
549
|
-
*/
|
|
550
|
-
companyName?: string;
|
|
551
|
-
/**
|
|
552
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
553
|
-
* dashboard.
|
|
554
|
-
*/
|
|
555
|
-
description?: string;
|
|
556
|
-
/**
|
|
557
|
-
* Email of the contact.
|
|
558
|
-
*/
|
|
559
|
-
email?: string;
|
|
560
|
-
/**
|
|
561
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
562
|
-
* `verified` even if our address verification system says otherwise.
|
|
563
|
-
*/
|
|
564
|
-
forceVerifiedStatus?: boolean;
|
|
565
|
-
/**
|
|
566
|
-
* Job title of the contact.
|
|
567
|
-
*/
|
|
568
|
-
jobTitle?: string;
|
|
569
|
-
/**
|
|
570
|
-
* Last name of the contact.
|
|
571
|
-
*/
|
|
572
|
-
lastName?: string;
|
|
573
|
-
/**
|
|
574
|
-
* See the section on Metadata.
|
|
575
|
-
*/
|
|
576
|
-
metadata?: {
|
|
577
|
-
[key: string]: unknown;
|
|
578
|
-
};
|
|
579
|
-
/**
|
|
580
|
-
* Phone number of the contact.
|
|
581
|
-
*/
|
|
582
|
-
phoneNumber?: string;
|
|
583
|
-
/**
|
|
584
|
-
* The postal or ZIP code of the contact's address.
|
|
585
|
-
*/
|
|
586
|
-
postalOrZip?: string;
|
|
587
|
-
/**
|
|
588
|
-
* Province or state of the contact's address.
|
|
589
|
-
*/
|
|
590
|
-
provinceOrState?: string;
|
|
591
|
-
/**
|
|
592
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
593
|
-
* verification system.
|
|
594
|
-
*/
|
|
595
|
-
skipVerification?: boolean;
|
|
596
|
-
}
|
|
597
|
-
interface ContactCreateWithCompanyName {
|
|
598
|
-
/**
|
|
599
|
-
* The first line of the contact's address.
|
|
600
|
-
*/
|
|
601
|
-
addressLine1: string;
|
|
602
|
-
companyName: string;
|
|
603
|
-
/**
|
|
604
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
605
|
-
*/
|
|
606
|
-
countryCode: string;
|
|
607
|
-
/**
|
|
608
|
-
* Second line of the contact's address, if applicable.
|
|
609
|
-
*/
|
|
610
|
-
addressLine2?: string;
|
|
611
|
-
/**
|
|
612
|
-
* The city of the contact's address.
|
|
613
|
-
*/
|
|
614
|
-
city?: string;
|
|
615
|
-
/**
|
|
616
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
617
|
-
* dashboard.
|
|
618
|
-
*/
|
|
619
|
-
description?: string;
|
|
620
|
-
/**
|
|
621
|
-
* Email of the contact.
|
|
622
|
-
*/
|
|
623
|
-
email?: string;
|
|
624
|
-
/**
|
|
625
|
-
* First name of the contact.
|
|
626
|
-
*/
|
|
627
|
-
firstName?: string;
|
|
628
|
-
/**
|
|
629
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
630
|
-
* `verified` even if our address verification system says otherwise.
|
|
631
|
-
*/
|
|
632
|
-
forceVerifiedStatus?: boolean;
|
|
633
|
-
/**
|
|
634
|
-
* Job title of the contact.
|
|
635
|
-
*/
|
|
636
|
-
jobTitle?: string;
|
|
637
|
-
/**
|
|
638
|
-
* Last name of the contact.
|
|
639
|
-
*/
|
|
640
|
-
lastName?: string;
|
|
641
|
-
/**
|
|
642
|
-
* See the section on Metadata.
|
|
643
|
-
*/
|
|
644
|
-
metadata?: {
|
|
645
|
-
[key: string]: unknown;
|
|
646
|
-
};
|
|
647
|
-
/**
|
|
648
|
-
* Phone number of the contact.
|
|
649
|
-
*/
|
|
650
|
-
phoneNumber?: string;
|
|
651
|
-
/**
|
|
652
|
-
* The postal or ZIP code of the contact's address.
|
|
653
|
-
*/
|
|
654
|
-
postalOrZip?: string;
|
|
655
|
-
/**
|
|
656
|
-
* Province or state of the contact's address.
|
|
657
|
-
*/
|
|
658
|
-
provinceOrState?: string;
|
|
659
|
-
/**
|
|
660
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
661
|
-
* verification system.
|
|
662
|
-
*/
|
|
663
|
-
skipVerification?: boolean;
|
|
664
|
-
}
|
|
665
|
-
interface ContactCreateWithFirstName {
|
|
666
|
-
/**
|
|
667
|
-
* The first line of the contact's address.
|
|
668
|
-
*/
|
|
669
|
-
addressLine1: string;
|
|
670
|
-
/**
|
|
671
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
672
|
-
*/
|
|
673
|
-
countryCode: string;
|
|
674
|
-
firstName: string;
|
|
675
|
-
/**
|
|
676
|
-
* Second line of the contact's address, if applicable.
|
|
677
|
-
*/
|
|
678
|
-
addressLine2?: string;
|
|
679
|
-
/**
|
|
680
|
-
* The city of the contact's address.
|
|
681
|
-
*/
|
|
682
|
-
city?: string;
|
|
683
|
-
/**
|
|
684
|
-
* Company name of the contact.
|
|
685
|
-
*/
|
|
686
|
-
companyName?: string;
|
|
687
|
-
/**
|
|
688
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
689
|
-
* dashboard.
|
|
690
|
-
*/
|
|
691
|
-
description?: string;
|
|
692
|
-
/**
|
|
693
|
-
* Email of the contact.
|
|
694
|
-
*/
|
|
695
|
-
email?: string;
|
|
696
|
-
/**
|
|
697
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
698
|
-
* `verified` even if our address verification system says otherwise.
|
|
699
|
-
*/
|
|
700
|
-
forceVerifiedStatus?: boolean;
|
|
701
|
-
/**
|
|
702
|
-
* Job title of the contact.
|
|
703
|
-
*/
|
|
704
|
-
jobTitle?: string;
|
|
705
|
-
/**
|
|
706
|
-
* Last name of the contact.
|
|
707
|
-
*/
|
|
708
|
-
lastName?: string;
|
|
709
|
-
/**
|
|
710
|
-
* See the section on Metadata.
|
|
711
|
-
*/
|
|
712
|
-
metadata?: {
|
|
713
|
-
[key: string]: unknown;
|
|
714
|
-
};
|
|
715
|
-
/**
|
|
716
|
-
* Phone number of the contact.
|
|
717
|
-
*/
|
|
718
|
-
phoneNumber?: string;
|
|
719
|
-
/**
|
|
720
|
-
* The postal or ZIP code of the contact's address.
|
|
721
|
-
*/
|
|
722
|
-
postalOrZip?: string;
|
|
723
|
-
/**
|
|
724
|
-
* Province or state of the contact's address.
|
|
725
|
-
*/
|
|
726
|
-
provinceOrState?: string;
|
|
727
|
-
/**
|
|
728
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
729
|
-
* verification system.
|
|
730
|
-
*/
|
|
731
|
-
skipVerification?: boolean;
|
|
732
|
-
}
|
|
733
|
-
interface ContactCreateWithCompanyName {
|
|
734
|
-
/**
|
|
735
|
-
* The first line of the contact's address.
|
|
736
|
-
*/
|
|
737
|
-
addressLine1: string;
|
|
738
|
-
companyName: string;
|
|
739
|
-
/**
|
|
740
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
741
|
-
*/
|
|
742
|
-
countryCode: string;
|
|
743
|
-
/**
|
|
744
|
-
* Second line of the contact's address, if applicable.
|
|
745
|
-
*/
|
|
746
|
-
addressLine2?: string;
|
|
747
|
-
/**
|
|
748
|
-
* The city of the contact's address.
|
|
749
|
-
*/
|
|
750
|
-
city?: string;
|
|
751
|
-
/**
|
|
752
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
753
|
-
* dashboard.
|
|
754
|
-
*/
|
|
755
|
-
description?: string;
|
|
756
|
-
/**
|
|
757
|
-
* Email of the contact.
|
|
758
|
-
*/
|
|
759
|
-
email?: string;
|
|
760
|
-
/**
|
|
761
|
-
* First name of the contact.
|
|
762
|
-
*/
|
|
763
|
-
firstName?: string;
|
|
764
|
-
/**
|
|
765
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
766
|
-
* `verified` even if our address verification system says otherwise.
|
|
767
|
-
*/
|
|
768
|
-
forceVerifiedStatus?: boolean;
|
|
769
|
-
/**
|
|
770
|
-
* Job title of the contact.
|
|
771
|
-
*/
|
|
772
|
-
jobTitle?: string;
|
|
773
|
-
/**
|
|
774
|
-
* Last name of the contact.
|
|
775
|
-
*/
|
|
776
|
-
lastName?: string;
|
|
777
|
-
/**
|
|
778
|
-
* See the section on Metadata.
|
|
779
|
-
*/
|
|
780
|
-
metadata?: {
|
|
781
|
-
[key: string]: unknown;
|
|
782
|
-
};
|
|
783
|
-
/**
|
|
784
|
-
* Phone number of the contact.
|
|
785
|
-
*/
|
|
786
|
-
phoneNumber?: string;
|
|
787
|
-
/**
|
|
788
|
-
* The postal or ZIP code of the contact's address.
|
|
789
|
-
*/
|
|
790
|
-
postalOrZip?: string;
|
|
791
|
-
/**
|
|
792
|
-
* Province or state of the contact's address.
|
|
793
|
-
*/
|
|
794
|
-
provinceOrState?: string;
|
|
795
|
-
/**
|
|
796
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
797
|
-
* verification system.
|
|
798
|
-
*/
|
|
799
|
-
skipVerification?: boolean;
|
|
800
|
-
}
|
|
801
|
-
}
|
|
802
|
-
export interface ChequeListParams {
|
|
803
|
-
limit?: number;
|
|
391
|
+
export interface ChequeListParams extends SkipLimitParams {
|
|
804
392
|
/**
|
|
805
393
|
* You can supply any string to help narrow down the list of resources. For
|
|
806
394
|
* example, if you pass `"New York"` (quoted), it will return resources that have
|
|
@@ -809,9 +397,8 @@ export interface ChequeListParams {
|
|
|
809
397
|
* more details.
|
|
810
398
|
*/
|
|
811
399
|
search?: string;
|
|
812
|
-
skip?: number;
|
|
813
400
|
}
|
|
814
401
|
export declare namespace Cheques {
|
|
815
|
-
export { type Cheque as Cheque, type ChequeSize as ChequeSize, type DigitalOnly as DigitalOnly, type
|
|
402
|
+
export { type Cheque as Cheque, type ChequeSize as ChequeSize, type DigitalOnly as DigitalOnly, type ChequeRetrieveURLResponse as ChequeRetrieveURLResponse, type ChequesSkipLimit as ChequesSkipLimit, type ChequeCreateParams as ChequeCreateParams, type ChequeListParams as ChequeListParams, };
|
|
816
403
|
}
|
|
817
404
|
//# sourceMappingURL=cheques.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cheques.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/cheques.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE
|
|
1
|
+
{"version":3,"file":"cheques.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/cheques.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,WAAW;OAChB,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAIxC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIxF;;;;;;;;;;;;;OAaG;IACH,2BAA2B,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGtF;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;AAEjD,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,YAAY,EAAE,KAAK,GAAG,KAAK,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAEzC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC;IAE7B;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;IAErC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;IAEpC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,UAAU,CAAC;AAElD,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAEnG;;;;;OAKG;IACH,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAEjG;;;;;OAKG;IACH,YAAY,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAE1G;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|