postgrid-node 0.3.0 → 0.4.0
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 +13 -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.js";
|
|
2
2
|
import * as BoxesAPI from "./boxes.js";
|
|
3
3
|
import * as ContactsAPI from "./contacts.js";
|
|
4
|
+
import * as PrintMailAPI from "./print-mail.js";
|
|
4
5
|
import { APIPromise } from "../../core/api-promise.js";
|
|
6
|
+
import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.js";
|
|
5
7
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
6
8
|
export declare class Boxes extends APIResource {
|
|
7
9
|
/**
|
|
@@ -54,10 +56,13 @@ export declare class Boxes extends APIResource {
|
|
|
54
56
|
*
|
|
55
57
|
* @example
|
|
56
58
|
* ```ts
|
|
57
|
-
*
|
|
59
|
+
* // Automatically fetches more pages as needed.
|
|
60
|
+
* for await (const box of client.printMail.boxes.list()) {
|
|
61
|
+
* // ...
|
|
62
|
+
* }
|
|
58
63
|
* ```
|
|
59
64
|
*/
|
|
60
|
-
list(query?: BoxListParams | null | undefined, options?: RequestOptions):
|
|
65
|
+
list(query?: BoxListParams | null | undefined, options?: RequestOptions): PagePromise<BoxesSkipLimit, Box>;
|
|
61
66
|
/**
|
|
62
67
|
* Cancel a box by ID (cannot be undone).
|
|
63
68
|
*
|
|
@@ -68,6 +73,7 @@ export declare class Boxes extends APIResource {
|
|
|
68
73
|
*/
|
|
69
74
|
delete(id: string, options?: RequestOptions): APIPromise<Box>;
|
|
70
75
|
}
|
|
76
|
+
export type BoxesSkipLimit = SkipLimit<Box>;
|
|
71
77
|
export interface Box {
|
|
72
78
|
/**
|
|
73
79
|
* A unique ID prefixed with box\_
|
|
@@ -238,16 +244,6 @@ export interface Cancellation {
|
|
|
238
244
|
export type OrderImbStatus = 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
|
|
239
245
|
export type OrderMailingClass = 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
|
|
240
246
|
export type OrderStatus = 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
|
|
241
|
-
/**
|
|
242
|
-
* A list of Boxes.
|
|
243
|
-
*/
|
|
244
|
-
export interface BoxListResponse {
|
|
245
|
-
data: Array<Box>;
|
|
246
|
-
limit: number;
|
|
247
|
-
object: 'list';
|
|
248
|
-
skip: number;
|
|
249
|
-
totalCount: number;
|
|
250
|
-
}
|
|
251
247
|
export interface BoxCreateParams {
|
|
252
248
|
/**
|
|
253
249
|
* The cheques to be mailed in the box. Only 100 cheques can be included in a box
|
|
@@ -258,14 +254,14 @@ export interface BoxCreateParams {
|
|
|
258
254
|
* The 'from' (sender) of the entire box. Accepts inline ContactCreate or a
|
|
259
255
|
* contactID.
|
|
260
256
|
*/
|
|
261
|
-
from:
|
|
257
|
+
from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
|
|
262
258
|
/**
|
|
263
259
|
* The recipient of this order. You can either supply the contact information
|
|
264
260
|
* inline here or provide a contact ID. PostGrid will automatically deduplicate
|
|
265
261
|
* contacts regardless of whether you provide the information inline here or call
|
|
266
262
|
* the contact creation endpoint.
|
|
267
263
|
*/
|
|
268
|
-
to:
|
|
264
|
+
to: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
|
|
269
265
|
/**
|
|
270
266
|
* An optional string describing this resource. Will be visible in the API and the
|
|
271
267
|
* dashboard.
|
|
@@ -305,558 +301,11 @@ export declare namespace BoxCreateParams {
|
|
|
305
301
|
* contactIDs.
|
|
306
302
|
*/
|
|
307
303
|
interface Cheque extends BoxesAPI.BoxChequeBase {
|
|
308
|
-
from:
|
|
309
|
-
to:
|
|
310
|
-
}
|
|
311
|
-
namespace Cheque {
|
|
312
|
-
interface ContactCreateWithFirstName {
|
|
313
|
-
/**
|
|
314
|
-
* The first line of the contact's address.
|
|
315
|
-
*/
|
|
316
|
-
addressLine1: string;
|
|
317
|
-
/**
|
|
318
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
319
|
-
*/
|
|
320
|
-
countryCode: string;
|
|
321
|
-
firstName: string;
|
|
322
|
-
/**
|
|
323
|
-
* Second line of the contact's address, if applicable.
|
|
324
|
-
*/
|
|
325
|
-
addressLine2?: string;
|
|
326
|
-
/**
|
|
327
|
-
* The city of the contact's address.
|
|
328
|
-
*/
|
|
329
|
-
city?: string;
|
|
330
|
-
/**
|
|
331
|
-
* Company name of the contact.
|
|
332
|
-
*/
|
|
333
|
-
companyName?: string;
|
|
334
|
-
/**
|
|
335
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
336
|
-
* dashboard.
|
|
337
|
-
*/
|
|
338
|
-
description?: string;
|
|
339
|
-
/**
|
|
340
|
-
* Email of the contact.
|
|
341
|
-
*/
|
|
342
|
-
email?: string;
|
|
343
|
-
/**
|
|
344
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
345
|
-
* `verified` even if our address verification system says otherwise.
|
|
346
|
-
*/
|
|
347
|
-
forceVerifiedStatus?: boolean;
|
|
348
|
-
/**
|
|
349
|
-
* Job title of the contact.
|
|
350
|
-
*/
|
|
351
|
-
jobTitle?: string;
|
|
352
|
-
/**
|
|
353
|
-
* Last name of the contact.
|
|
354
|
-
*/
|
|
355
|
-
lastName?: string;
|
|
356
|
-
/**
|
|
357
|
-
* See the section on Metadata.
|
|
358
|
-
*/
|
|
359
|
-
metadata?: {
|
|
360
|
-
[key: string]: unknown;
|
|
361
|
-
};
|
|
362
|
-
/**
|
|
363
|
-
* Phone number of the contact.
|
|
364
|
-
*/
|
|
365
|
-
phoneNumber?: string;
|
|
366
|
-
/**
|
|
367
|
-
* The postal or ZIP code of the contact's address.
|
|
368
|
-
*/
|
|
369
|
-
postalOrZip?: string;
|
|
370
|
-
/**
|
|
371
|
-
* Province or state of the contact's address.
|
|
372
|
-
*/
|
|
373
|
-
provinceOrState?: string;
|
|
374
|
-
/**
|
|
375
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
376
|
-
* verification system.
|
|
377
|
-
*/
|
|
378
|
-
skipVerification?: boolean;
|
|
379
|
-
}
|
|
380
|
-
interface ContactCreateWithCompanyName {
|
|
381
|
-
/**
|
|
382
|
-
* The first line of the contact's address.
|
|
383
|
-
*/
|
|
384
|
-
addressLine1: string;
|
|
385
|
-
companyName: string;
|
|
386
|
-
/**
|
|
387
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
388
|
-
*/
|
|
389
|
-
countryCode: string;
|
|
390
|
-
/**
|
|
391
|
-
* Second line of the contact's address, if applicable.
|
|
392
|
-
*/
|
|
393
|
-
addressLine2?: string;
|
|
394
|
-
/**
|
|
395
|
-
* The city of the contact's address.
|
|
396
|
-
*/
|
|
397
|
-
city?: string;
|
|
398
|
-
/**
|
|
399
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
400
|
-
* dashboard.
|
|
401
|
-
*/
|
|
402
|
-
description?: string;
|
|
403
|
-
/**
|
|
404
|
-
* Email of the contact.
|
|
405
|
-
*/
|
|
406
|
-
email?: string;
|
|
407
|
-
/**
|
|
408
|
-
* First name of the contact.
|
|
409
|
-
*/
|
|
410
|
-
firstName?: string;
|
|
411
|
-
/**
|
|
412
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
413
|
-
* `verified` even if our address verification system says otherwise.
|
|
414
|
-
*/
|
|
415
|
-
forceVerifiedStatus?: boolean;
|
|
416
|
-
/**
|
|
417
|
-
* Job title of the contact.
|
|
418
|
-
*/
|
|
419
|
-
jobTitle?: string;
|
|
420
|
-
/**
|
|
421
|
-
* Last name of the contact.
|
|
422
|
-
*/
|
|
423
|
-
lastName?: string;
|
|
424
|
-
/**
|
|
425
|
-
* See the section on Metadata.
|
|
426
|
-
*/
|
|
427
|
-
metadata?: {
|
|
428
|
-
[key: string]: unknown;
|
|
429
|
-
};
|
|
430
|
-
/**
|
|
431
|
-
* Phone number of the contact.
|
|
432
|
-
*/
|
|
433
|
-
phoneNumber?: string;
|
|
434
|
-
/**
|
|
435
|
-
* The postal or ZIP code of the contact's address.
|
|
436
|
-
*/
|
|
437
|
-
postalOrZip?: string;
|
|
438
|
-
/**
|
|
439
|
-
* Province or state of the contact's address.
|
|
440
|
-
*/
|
|
441
|
-
provinceOrState?: string;
|
|
442
|
-
/**
|
|
443
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
444
|
-
* verification system.
|
|
445
|
-
*/
|
|
446
|
-
skipVerification?: boolean;
|
|
447
|
-
}
|
|
448
|
-
interface ContactCreateWithFirstName {
|
|
449
|
-
/**
|
|
450
|
-
* The first line of the contact's address.
|
|
451
|
-
*/
|
|
452
|
-
addressLine1: string;
|
|
453
|
-
/**
|
|
454
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
455
|
-
*/
|
|
456
|
-
countryCode: string;
|
|
457
|
-
firstName: string;
|
|
458
|
-
/**
|
|
459
|
-
* Second line of the contact's address, if applicable.
|
|
460
|
-
*/
|
|
461
|
-
addressLine2?: string;
|
|
462
|
-
/**
|
|
463
|
-
* The city of the contact's address.
|
|
464
|
-
*/
|
|
465
|
-
city?: string;
|
|
466
|
-
/**
|
|
467
|
-
* Company name of the contact.
|
|
468
|
-
*/
|
|
469
|
-
companyName?: string;
|
|
470
|
-
/**
|
|
471
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
472
|
-
* dashboard.
|
|
473
|
-
*/
|
|
474
|
-
description?: string;
|
|
475
|
-
/**
|
|
476
|
-
* Email of the contact.
|
|
477
|
-
*/
|
|
478
|
-
email?: string;
|
|
479
|
-
/**
|
|
480
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
481
|
-
* `verified` even if our address verification system says otherwise.
|
|
482
|
-
*/
|
|
483
|
-
forceVerifiedStatus?: boolean;
|
|
484
|
-
/**
|
|
485
|
-
* Job title of the contact.
|
|
486
|
-
*/
|
|
487
|
-
jobTitle?: string;
|
|
488
|
-
/**
|
|
489
|
-
* Last name of the contact.
|
|
490
|
-
*/
|
|
491
|
-
lastName?: string;
|
|
492
|
-
/**
|
|
493
|
-
* See the section on Metadata.
|
|
494
|
-
*/
|
|
495
|
-
metadata?: {
|
|
496
|
-
[key: string]: unknown;
|
|
497
|
-
};
|
|
498
|
-
/**
|
|
499
|
-
* Phone number of the contact.
|
|
500
|
-
*/
|
|
501
|
-
phoneNumber?: string;
|
|
502
|
-
/**
|
|
503
|
-
* The postal or ZIP code of the contact's address.
|
|
504
|
-
*/
|
|
505
|
-
postalOrZip?: string;
|
|
506
|
-
/**
|
|
507
|
-
* Province or state of the contact's address.
|
|
508
|
-
*/
|
|
509
|
-
provinceOrState?: string;
|
|
510
|
-
/**
|
|
511
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
512
|
-
* verification system.
|
|
513
|
-
*/
|
|
514
|
-
skipVerification?: boolean;
|
|
515
|
-
}
|
|
516
|
-
interface ContactCreateWithCompanyName {
|
|
517
|
-
/**
|
|
518
|
-
* The first line of the contact's address.
|
|
519
|
-
*/
|
|
520
|
-
addressLine1: string;
|
|
521
|
-
companyName: string;
|
|
522
|
-
/**
|
|
523
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
524
|
-
*/
|
|
525
|
-
countryCode: string;
|
|
526
|
-
/**
|
|
527
|
-
* Second line of the contact's address, if applicable.
|
|
528
|
-
*/
|
|
529
|
-
addressLine2?: string;
|
|
530
|
-
/**
|
|
531
|
-
* The city of the contact's address.
|
|
532
|
-
*/
|
|
533
|
-
city?: string;
|
|
534
|
-
/**
|
|
535
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
536
|
-
* dashboard.
|
|
537
|
-
*/
|
|
538
|
-
description?: string;
|
|
539
|
-
/**
|
|
540
|
-
* Email of the contact.
|
|
541
|
-
*/
|
|
542
|
-
email?: string;
|
|
543
|
-
/**
|
|
544
|
-
* First name of the contact.
|
|
545
|
-
*/
|
|
546
|
-
firstName?: string;
|
|
547
|
-
/**
|
|
548
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
549
|
-
* `verified` even if our address verification system says otherwise.
|
|
550
|
-
*/
|
|
551
|
-
forceVerifiedStatus?: boolean;
|
|
552
|
-
/**
|
|
553
|
-
* Job title of the contact.
|
|
554
|
-
*/
|
|
555
|
-
jobTitle?: string;
|
|
556
|
-
/**
|
|
557
|
-
* Last name of the contact.
|
|
558
|
-
*/
|
|
559
|
-
lastName?: string;
|
|
560
|
-
/**
|
|
561
|
-
* See the section on Metadata.
|
|
562
|
-
*/
|
|
563
|
-
metadata?: {
|
|
564
|
-
[key: string]: unknown;
|
|
565
|
-
};
|
|
566
|
-
/**
|
|
567
|
-
* Phone number of the contact.
|
|
568
|
-
*/
|
|
569
|
-
phoneNumber?: string;
|
|
570
|
-
/**
|
|
571
|
-
* The postal or ZIP code of the contact's address.
|
|
572
|
-
*/
|
|
573
|
-
postalOrZip?: string;
|
|
574
|
-
/**
|
|
575
|
-
* Province or state of the contact's address.
|
|
576
|
-
*/
|
|
577
|
-
provinceOrState?: string;
|
|
578
|
-
/**
|
|
579
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
580
|
-
* verification system.
|
|
581
|
-
*/
|
|
582
|
-
skipVerification?: boolean;
|
|
583
|
-
}
|
|
584
|
-
}
|
|
585
|
-
interface ContactCreateWithFirstName {
|
|
586
|
-
/**
|
|
587
|
-
* The first line of the contact's address.
|
|
588
|
-
*/
|
|
589
|
-
addressLine1: string;
|
|
590
|
-
/**
|
|
591
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
592
|
-
*/
|
|
593
|
-
countryCode: string;
|
|
594
|
-
firstName: string;
|
|
595
|
-
/**
|
|
596
|
-
* Second line of the contact's address, if applicable.
|
|
597
|
-
*/
|
|
598
|
-
addressLine2?: string;
|
|
599
|
-
/**
|
|
600
|
-
* The city of the contact's address.
|
|
601
|
-
*/
|
|
602
|
-
city?: string;
|
|
603
|
-
/**
|
|
604
|
-
* Company name of the contact.
|
|
605
|
-
*/
|
|
606
|
-
companyName?: string;
|
|
607
|
-
/**
|
|
608
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
609
|
-
* dashboard.
|
|
610
|
-
*/
|
|
611
|
-
description?: string;
|
|
612
|
-
/**
|
|
613
|
-
* Email of the contact.
|
|
614
|
-
*/
|
|
615
|
-
email?: string;
|
|
616
|
-
/**
|
|
617
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
618
|
-
* `verified` even if our address verification system says otherwise.
|
|
619
|
-
*/
|
|
620
|
-
forceVerifiedStatus?: boolean;
|
|
621
|
-
/**
|
|
622
|
-
* Job title of the contact.
|
|
623
|
-
*/
|
|
624
|
-
jobTitle?: string;
|
|
625
|
-
/**
|
|
626
|
-
* Last name of the contact.
|
|
627
|
-
*/
|
|
628
|
-
lastName?: string;
|
|
629
|
-
/**
|
|
630
|
-
* See the section on Metadata.
|
|
631
|
-
*/
|
|
632
|
-
metadata?: {
|
|
633
|
-
[key: string]: unknown;
|
|
634
|
-
};
|
|
635
|
-
/**
|
|
636
|
-
* Phone number of the contact.
|
|
637
|
-
*/
|
|
638
|
-
phoneNumber?: string;
|
|
639
|
-
/**
|
|
640
|
-
* The postal or ZIP code of the contact's address.
|
|
641
|
-
*/
|
|
642
|
-
postalOrZip?: string;
|
|
643
|
-
/**
|
|
644
|
-
* Province or state of the contact's address.
|
|
645
|
-
*/
|
|
646
|
-
provinceOrState?: string;
|
|
647
|
-
/**
|
|
648
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
649
|
-
* verification system.
|
|
650
|
-
*/
|
|
651
|
-
skipVerification?: boolean;
|
|
652
|
-
}
|
|
653
|
-
interface ContactCreateWithCompanyName {
|
|
654
|
-
/**
|
|
655
|
-
* The first line of the contact's address.
|
|
656
|
-
*/
|
|
657
|
-
addressLine1: string;
|
|
658
|
-
companyName: string;
|
|
659
|
-
/**
|
|
660
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
661
|
-
*/
|
|
662
|
-
countryCode: string;
|
|
663
|
-
/**
|
|
664
|
-
* Second line of the contact's address, if applicable.
|
|
665
|
-
*/
|
|
666
|
-
addressLine2?: string;
|
|
667
|
-
/**
|
|
668
|
-
* The city of the contact's address.
|
|
669
|
-
*/
|
|
670
|
-
city?: string;
|
|
671
|
-
/**
|
|
672
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
673
|
-
* dashboard.
|
|
674
|
-
*/
|
|
675
|
-
description?: string;
|
|
676
|
-
/**
|
|
677
|
-
* Email of the contact.
|
|
678
|
-
*/
|
|
679
|
-
email?: string;
|
|
680
|
-
/**
|
|
681
|
-
* First name of the contact.
|
|
682
|
-
*/
|
|
683
|
-
firstName?: string;
|
|
684
|
-
/**
|
|
685
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
686
|
-
* `verified` even if our address verification system says otherwise.
|
|
687
|
-
*/
|
|
688
|
-
forceVerifiedStatus?: boolean;
|
|
689
|
-
/**
|
|
690
|
-
* Job title of the contact.
|
|
691
|
-
*/
|
|
692
|
-
jobTitle?: string;
|
|
693
|
-
/**
|
|
694
|
-
* Last name of the contact.
|
|
695
|
-
*/
|
|
696
|
-
lastName?: string;
|
|
697
|
-
/**
|
|
698
|
-
* See the section on Metadata.
|
|
699
|
-
*/
|
|
700
|
-
metadata?: {
|
|
701
|
-
[key: string]: unknown;
|
|
702
|
-
};
|
|
703
|
-
/**
|
|
704
|
-
* Phone number of the contact.
|
|
705
|
-
*/
|
|
706
|
-
phoneNumber?: string;
|
|
707
|
-
/**
|
|
708
|
-
* The postal or ZIP code of the contact's address.
|
|
709
|
-
*/
|
|
710
|
-
postalOrZip?: string;
|
|
711
|
-
/**
|
|
712
|
-
* Province or state of the contact's address.
|
|
713
|
-
*/
|
|
714
|
-
provinceOrState?: string;
|
|
715
|
-
/**
|
|
716
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
717
|
-
* verification system.
|
|
718
|
-
*/
|
|
719
|
-
skipVerification?: boolean;
|
|
720
|
-
}
|
|
721
|
-
interface ContactCreateWithFirstName {
|
|
722
|
-
/**
|
|
723
|
-
* The first line of the contact's address.
|
|
724
|
-
*/
|
|
725
|
-
addressLine1: string;
|
|
726
|
-
/**
|
|
727
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
728
|
-
*/
|
|
729
|
-
countryCode: string;
|
|
730
|
-
firstName: string;
|
|
731
|
-
/**
|
|
732
|
-
* Second line of the contact's address, if applicable.
|
|
733
|
-
*/
|
|
734
|
-
addressLine2?: string;
|
|
735
|
-
/**
|
|
736
|
-
* The city of the contact's address.
|
|
737
|
-
*/
|
|
738
|
-
city?: string;
|
|
739
|
-
/**
|
|
740
|
-
* Company name of the contact.
|
|
741
|
-
*/
|
|
742
|
-
companyName?: string;
|
|
743
|
-
/**
|
|
744
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
745
|
-
* dashboard.
|
|
746
|
-
*/
|
|
747
|
-
description?: string;
|
|
748
|
-
/**
|
|
749
|
-
* Email of the contact.
|
|
750
|
-
*/
|
|
751
|
-
email?: string;
|
|
752
|
-
/**
|
|
753
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
754
|
-
* `verified` even if our address verification system says otherwise.
|
|
755
|
-
*/
|
|
756
|
-
forceVerifiedStatus?: boolean;
|
|
757
|
-
/**
|
|
758
|
-
* Job title of the contact.
|
|
759
|
-
*/
|
|
760
|
-
jobTitle?: string;
|
|
761
|
-
/**
|
|
762
|
-
* Last name of the contact.
|
|
763
|
-
*/
|
|
764
|
-
lastName?: string;
|
|
765
|
-
/**
|
|
766
|
-
* See the section on Metadata.
|
|
767
|
-
*/
|
|
768
|
-
metadata?: {
|
|
769
|
-
[key: string]: unknown;
|
|
770
|
-
};
|
|
771
|
-
/**
|
|
772
|
-
* Phone number of the contact.
|
|
773
|
-
*/
|
|
774
|
-
phoneNumber?: string;
|
|
775
|
-
/**
|
|
776
|
-
* The postal or ZIP code of the contact's address.
|
|
777
|
-
*/
|
|
778
|
-
postalOrZip?: string;
|
|
779
|
-
/**
|
|
780
|
-
* Province or state of the contact's address.
|
|
781
|
-
*/
|
|
782
|
-
provinceOrState?: string;
|
|
783
|
-
/**
|
|
784
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
785
|
-
* verification system.
|
|
786
|
-
*/
|
|
787
|
-
skipVerification?: boolean;
|
|
788
|
-
}
|
|
789
|
-
interface ContactCreateWithCompanyName {
|
|
790
|
-
/**
|
|
791
|
-
* The first line of the contact's address.
|
|
792
|
-
*/
|
|
793
|
-
addressLine1: string;
|
|
794
|
-
companyName: string;
|
|
795
|
-
/**
|
|
796
|
-
* The ISO 3611-1 country code of the contact's address.
|
|
797
|
-
*/
|
|
798
|
-
countryCode: string;
|
|
799
|
-
/**
|
|
800
|
-
* Second line of the contact's address, if applicable.
|
|
801
|
-
*/
|
|
802
|
-
addressLine2?: string;
|
|
803
|
-
/**
|
|
804
|
-
* The city of the contact's address.
|
|
805
|
-
*/
|
|
806
|
-
city?: string;
|
|
807
|
-
/**
|
|
808
|
-
* An optional string describing this resource. Will be visible in the API and the
|
|
809
|
-
* dashboard.
|
|
810
|
-
*/
|
|
811
|
-
description?: string;
|
|
812
|
-
/**
|
|
813
|
-
* Email of the contact.
|
|
814
|
-
*/
|
|
815
|
-
email?: string;
|
|
816
|
-
/**
|
|
817
|
-
* First name of the contact.
|
|
818
|
-
*/
|
|
819
|
-
firstName?: string;
|
|
820
|
-
/**
|
|
821
|
-
* If `true`, PostGrid will force this contact to have an `addressStatus` of
|
|
822
|
-
* `verified` even if our address verification system says otherwise.
|
|
823
|
-
*/
|
|
824
|
-
forceVerifiedStatus?: boolean;
|
|
825
|
-
/**
|
|
826
|
-
* Job title of the contact.
|
|
827
|
-
*/
|
|
828
|
-
jobTitle?: string;
|
|
829
|
-
/**
|
|
830
|
-
* Last name of the contact.
|
|
831
|
-
*/
|
|
832
|
-
lastName?: string;
|
|
833
|
-
/**
|
|
834
|
-
* See the section on Metadata.
|
|
835
|
-
*/
|
|
836
|
-
metadata?: {
|
|
837
|
-
[key: string]: unknown;
|
|
838
|
-
};
|
|
839
|
-
/**
|
|
840
|
-
* Phone number of the contact.
|
|
841
|
-
*/
|
|
842
|
-
phoneNumber?: string;
|
|
843
|
-
/**
|
|
844
|
-
* The postal or ZIP code of the contact's address.
|
|
845
|
-
*/
|
|
846
|
-
postalOrZip?: string;
|
|
847
|
-
/**
|
|
848
|
-
* Province or state of the contact's address.
|
|
849
|
-
*/
|
|
850
|
-
provinceOrState?: string;
|
|
851
|
-
/**
|
|
852
|
-
* If `true`, PostGrid will skip running this contact's address through our address
|
|
853
|
-
* verification system.
|
|
854
|
-
*/
|
|
855
|
-
skipVerification?: boolean;
|
|
304
|
+
from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
|
|
305
|
+
to: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
|
|
856
306
|
}
|
|
857
307
|
}
|
|
858
|
-
export interface BoxListParams {
|
|
859
|
-
limit?: number;
|
|
308
|
+
export interface BoxListParams extends SkipLimitParams {
|
|
860
309
|
/**
|
|
861
310
|
* You can supply any string to help narrow down the list of resources. For
|
|
862
311
|
* example, if you pass `"New York"` (quoted), it will return resources that have
|
|
@@ -865,9 +314,8 @@ export interface BoxListParams {
|
|
|
865
314
|
* more details.
|
|
866
315
|
*/
|
|
867
316
|
search?: string;
|
|
868
|
-
skip?: number;
|
|
869
317
|
}
|
|
870
318
|
export declare namespace Boxes {
|
|
871
|
-
export { type Box as Box, type BoxChequeBase as BoxChequeBase, type Cancellation as Cancellation, type OrderImbStatus as OrderImbStatus, type OrderMailingClass as OrderMailingClass, type OrderStatus as OrderStatus, type
|
|
319
|
+
export { type Box as Box, type BoxChequeBase as BoxChequeBase, type Cancellation as Cancellation, type OrderImbStatus as OrderImbStatus, type OrderMailingClass as OrderMailingClass, type OrderStatus as OrderStatus, type BoxesSkipLimit as BoxesSkipLimit, type BoxCreateParams as BoxCreateParams, type BoxListParams as BoxListParams, };
|
|
872
320
|
}
|
|
873
321
|
//# sourceMappingURL=boxes.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"boxes.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/boxes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;IAIxE;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/D
|
|
1
|
+
{"version":3,"file":"boxes.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/boxes.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,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;IAIxE;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/D;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,GAAG,CAAC;IAInC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;CAG9D;AAED,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;AAE5C,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EAAE,iBAAiB,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;IAE3B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,GAAG,CAAC;IACnB;;;;OAIG;IACH,UAAiB,MAAO,SAAQ,QAAQ,CAAC,aAAa;QACpD,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;QAE1B,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,6BAA6B,CAAC;IAE7E;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAE/F,MAAM,MAAM,iBAAiB,GACzB,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;AAE3B,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;AAEtG,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAEvC;;;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;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAEjC;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;;;;OAKG;IACH,UAAiB,MAAO,SAAQ,QAAQ,CAAC,aAAa;QACpD,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEnG,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;KAClG;CACF;AAED,MAAM,WAAW,aAAc,SAAQ,eAAe;IACpD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,GAAG,IAAI,GAAG,EACf,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.Boxes = void 0;
|
|
5
5
|
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
6
7
|
const path_1 = require("../../internal/utils/path.js");
|
|
7
8
|
class Boxes extends resource_1.APIResource {
|
|
8
9
|
/**
|
|
@@ -59,11 +60,14 @@ class Boxes extends resource_1.APIResource {
|
|
|
59
60
|
*
|
|
60
61
|
* @example
|
|
61
62
|
* ```ts
|
|
62
|
-
*
|
|
63
|
+
* // Automatically fetches more pages as needed.
|
|
64
|
+
* for await (const box of client.printMail.boxes.list()) {
|
|
65
|
+
* // ...
|
|
66
|
+
* }
|
|
63
67
|
* ```
|
|
64
68
|
*/
|
|
65
69
|
list(query = {}, options) {
|
|
66
|
-
return this._client.
|
|
70
|
+
return this._client.getAPIList('/print-mail/v1/boxes', (pagination_1.SkipLimit), { query, ...options });
|
|
67
71
|
}
|
|
68
72
|
/**
|
|
69
73
|
* Cancel a box by ID (cannot be undone).
|