diff --git a/errors_easypost_error.js.html b/errors_easypost_error.js.html index ee6a2bb5d..6deaae09e 100644 --- a/errors_easypost_error.js.html +++ b/errors_easypost_error.js.html @@ -49,13 +49,13 @@

Source: errors/easypost_error.js


diff --git a/errors_error_handler.js.html b/errors_error_handler.js.html index e7ba4e79e..fc4794034 100644 --- a/errors_error_handler.js.html +++ b/errors_error_handler.js.html @@ -135,13 +135,13 @@

Source: errors/error_handler.js


diff --git a/global.html b/global.html index af1185085..73d14d221 100644 --- a/global.html +++ b/global.html @@ -4643,6 +4643,166 @@
Returns:
+

(async) allChildren(params) → {Object}

+ + + + + + +
+ Retrieve a paginated list of children user user. +See EasyPost API Documentation for more information. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object + + + + Parameters to filter the list of children users.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ - An object containing a list of User and pagination information. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + + + +

(async) buy(id) → {Batch}

@@ -12897,6 +13057,203 @@
Parameters:
+
Returns:
+ + +
+ The retrieved EasyPostObject-based class instance, or a `Promise` that rejects with an error. +
+ + + +
+
+ Type +
+
+ +EasyPostObject +| + +Promise.<never> + + +
+
+ + + + + + + + + + + + + +

(async) getNextPage(children, pageSize) → {EasyPostObject|Promise.<never>}

+ + + + + + +
+ Retrieve the next page of children collection. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
children + + +Object + + + + + + An object containing a list of children and pagination information.
pageSize + + +Number + + + + + + null + + The number of records to return on each page
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
Returns:
@@ -21325,13 +21682,13 @@
Returns:

diff --git a/index.html b/index.html index f4cf86e9a..e9bbcdb63 100644 --- a/index.html +++ b/index.html @@ -50,13 +50,13 @@


diff --git a/models_address.js.html b/models_address.js.html index 730194d65..d1183113b 100644 --- a/models_address.js.html +++ b/models_address.js.html @@ -60,13 +60,13 @@

Source: models/address.js


diff --git a/models_api_key.js.html b/models_api_key.js.html index 0c979a7ff..3dd29612c 100644 --- a/models_api_key.js.html +++ b/models_api_key.js.html @@ -47,13 +47,13 @@

Source: models/api_key.js


diff --git a/models_batch.js.html b/models_batch.js.html index 887d33ac0..9253d23fc 100644 --- a/models_batch.js.html +++ b/models_batch.js.html @@ -53,13 +53,13 @@

Source: models/batch.js


diff --git a/models_brand.js.html b/models_brand.js.html index 4630812d8..2b97c67f7 100644 --- a/models_brand.js.html +++ b/models_brand.js.html @@ -54,13 +54,13 @@

Source: models/brand.js


diff --git a/models_carrier_account.js.html b/models_carrier_account.js.html index 4cb6d956a..3c6743c39 100644 --- a/models_carrier_account.js.html +++ b/models_carrier_account.js.html @@ -53,13 +53,13 @@

Source: models/carrier_account.js


diff --git a/models_carrier_type.js.html b/models_carrier_type.js.html index ed6fc5ade..9a05ea79e 100644 --- a/models_carrier_type.js.html +++ b/models_carrier_type.js.html @@ -47,13 +47,13 @@

Source: models/carrier_type.js


diff --git a/models_customs_info.js.html b/models_customs_info.js.html index 2dae632b0..4361e40a4 100644 --- a/models_customs_info.js.html +++ b/models_customs_info.js.html @@ -55,13 +55,13 @@

Source: models/customs_info.js


diff --git a/models_customs_item.js.html b/models_customs_item.js.html index d35a73cc6..3892b71b3 100644 --- a/models_customs_item.js.html +++ b/models_customs_item.js.html @@ -53,13 +53,13 @@

Source: models/customs_item.js


diff --git a/models_easypost_object.js.html b/models_easypost_object.js.html index 0e0e23864..35e86ee4d 100644 --- a/models_easypost_object.js.html +++ b/models_easypost_object.js.html @@ -49,13 +49,13 @@

Source: models/easypost_object.js


diff --git a/models_end_shipper.js.html b/models_end_shipper.js.html index 3efabeec5..868281b81 100644 --- a/models_end_shipper.js.html +++ b/models_end_shipper.js.html @@ -55,13 +55,13 @@

Source: models/end_shipper.js


diff --git a/models_event.js.html b/models_event.js.html index c4195aa8c..033920992 100644 --- a/models_event.js.html +++ b/models_event.js.html @@ -51,13 +51,13 @@

Source: models/event.js


diff --git a/models_form.js.html b/models_form.js.html index 8c97c3320..132d492b4 100644 --- a/models_form.js.html +++ b/models_form.js.html @@ -48,13 +48,13 @@

Source: models/form.js


diff --git a/models_insurance.js.html b/models_insurance.js.html index c7698bc54..64533300b 100644 --- a/models_insurance.js.html +++ b/models_insurance.js.html @@ -57,13 +57,13 @@

Source: models/insurance.js


diff --git a/models_order.js.html b/models_order.js.html index de8918035..84a09a09a 100644 --- a/models_order.js.html +++ b/models_order.js.html @@ -69,13 +69,13 @@

Source: models/order.js


diff --git a/models_parcel.js.html b/models_parcel.js.html index dbf936023..fa7bb6cf3 100644 --- a/models_parcel.js.html +++ b/models_parcel.js.html @@ -50,13 +50,13 @@

Source: models/parcel.js


diff --git a/models_payload.js.html b/models_payload.js.html index 71ef1cf37..5e982a4df 100644 --- a/models_payload.js.html +++ b/models_payload.js.html @@ -46,13 +46,13 @@

Source: models/payload.js


diff --git a/models_pickup.js.html b/models_pickup.js.html index 22d005158..573c845de 100644 --- a/models_pickup.js.html +++ b/models_pickup.js.html @@ -72,13 +72,13 @@

Source: models/pickup.js


diff --git a/models_pickup_rate.js.html b/models_pickup_rate.js.html index 5123c5f60..1ee67bec5 100644 --- a/models_pickup_rate.js.html +++ b/models_pickup_rate.js.html @@ -50,13 +50,13 @@

Source: models/pickup_rate.js


diff --git a/models_postage_label.js.html b/models_postage_label.js.html index 68d3cc9cd..5129b8c38 100644 --- a/models_postage_label.js.html +++ b/models_postage_label.js.html @@ -54,13 +54,13 @@

Source: models/postage_label.js


diff --git a/models_rate.js.html b/models_rate.js.html index 90fd22179..c35d7d7aa 100644 --- a/models_rate.js.html +++ b/models_rate.js.html @@ -58,13 +58,13 @@

Source: models/rate.js


diff --git a/models_refund.js.html b/models_refund.js.html index c7cfd2c8b..6778bb5ae 100644 --- a/models_refund.js.html +++ b/models_refund.js.html @@ -50,13 +50,13 @@

Source: models/refund.js


diff --git a/models_report.js.html b/models_report.js.html index a8f331b42..3a5c6d647 100644 --- a/models_report.js.html +++ b/models_report.js.html @@ -52,13 +52,13 @@

Source: models/report.js


diff --git a/models_scan_form.js.html b/models_scan_form.js.html index 83565b1d4..ca0f72868 100644 --- a/models_scan_form.js.html +++ b/models_scan_form.js.html @@ -52,13 +52,13 @@

Source: models/scan_form.js


diff --git a/models_shipment.js.html b/models_shipment.js.html index f62bf811d..bae21b77f 100644 --- a/models_shipment.js.html +++ b/models_shipment.js.html @@ -85,13 +85,13 @@

Source: models/shipment.js


diff --git a/models_tracker.js.html b/models_tracker.js.html index eb78c85ef..28a3596a8 100644 --- a/models_tracker.js.html +++ b/models_tracker.js.html @@ -57,13 +57,13 @@

Source: models/tracker.js


diff --git a/models_user.js.html b/models_user.js.html index 7a5ffee2c..962a4b09b 100644 --- a/models_user.js.html +++ b/models_user.js.html @@ -58,13 +58,13 @@

Source: models/user.js


diff --git a/models_webhook.js.html b/models_webhook.js.html index 482e519cf..699cdea46 100644 --- a/models_webhook.js.html +++ b/models_webhook.js.html @@ -47,13 +47,13 @@

Source: models/webhook.js


diff --git a/module.html#.exports b/module.html#.exports index 5062e20c5..f526b23c2 100644 --- a/module.html#.exports +++ b/module.html#.exports @@ -4314,13 +4314,13 @@ This class is not designed to be used directly by consumers of the library.
diff --git a/services_address_service.js.html b/services_address_service.js.html index 52f6725ce..38e2b9b45 100644 --- a/services_address_service.js.html +++ b/services_address_service.js.html @@ -143,13 +143,13 @@

Source: services/address_service.js


diff --git a/services_api_key_service.js.html b/services_api_key_service.js.html index a2e3530d9..c1059733d 100644 --- a/services_api_key_service.js.html +++ b/services_api_key_service.js.html @@ -89,13 +89,13 @@

Source: services/api_key_service.js


diff --git a/services_base_service.js.html b/services_base_service.js.html index c43c8b08f..060454977 100644 --- a/services_base_service.js.html +++ b/services_base_service.js.html @@ -267,13 +267,13 @@

Source: services/base_service.js


diff --git a/services_batch_service.js.html b/services_batch_service.js.html index fbcff9d2c..d4e277106 100644 --- a/services_batch_service.js.html +++ b/services_batch_service.js.html @@ -185,13 +185,13 @@

Source: services/batch_service.js


diff --git a/services_beta_rate_service.js.html b/services_beta_rate_service.js.html index ce70b46de..c5581810d 100644 --- a/services_beta_rate_service.js.html +++ b/services_beta_rate_service.js.html @@ -63,13 +63,13 @@

Source: services/beta_rate_service.js


diff --git a/services_beta_referral_customer_service.js.html b/services_beta_referral_customer_service.js.html index ec95fe7cf..64c70899c 100644 --- a/services_beta_referral_customer_service.js.html +++ b/services_beta_referral_customer_service.js.html @@ -97,13 +97,13 @@

Source: services/beta_referral_customer_service.js


diff --git a/services_billing_service.js.html b/services_billing_service.js.html index b451f9119..b05e0dcbc 100644 --- a/services_billing_service.js.html +++ b/services_billing_service.js.html @@ -130,13 +130,13 @@

Source: services/billing_service.js


diff --git a/services_carrier_account_service.js.html b/services_carrier_account_service.js.html index cec850d85..322198ce4 100644 --- a/services_carrier_account_service.js.html +++ b/services_carrier_account_service.js.html @@ -147,13 +147,13 @@

Source: services/carrier_account_service.js


diff --git a/services_carrier_metadata_service.js.html b/services_carrier_metadata_service.js.html index 435e7cf4b..560beece0 100644 --- a/services_carrier_metadata_service.js.html +++ b/services_carrier_metadata_service.js.html @@ -64,13 +64,13 @@

Source: services/carrier_metadata_service.js


diff --git a/services_carrier_type_service.js.html b/services_carrier_type_service.js.html index 6a88ba089..5092dffcb 100644 --- a/services_carrier_type_service.js.html +++ b/services_carrier_type_service.js.html @@ -62,13 +62,13 @@

Source: services/carrier_type_service.js


diff --git a/services_customs_info_service.js.html b/services_customs_info_service.js.html index 12a8e4cdc..8069a0bb7 100644 --- a/services_customs_info_service.js.html +++ b/services_customs_info_service.js.html @@ -72,13 +72,13 @@

Source: services/customs_info_service.js


diff --git a/services_customs_item_service.js.html b/services_customs_item_service.js.html index fdaf124cd..4bbe3fbf9 100644 --- a/services_customs_item_service.js.html +++ b/services_customs_item_service.js.html @@ -72,13 +72,13 @@

Source: services/customs_item_service.js


diff --git a/services_end_shipper_service.js.html b/services_end_shipper_service.js.html index 679888d45..d649bd293 100644 --- a/services_end_shipper_service.js.html +++ b/services_end_shipper_service.js.html @@ -101,13 +101,13 @@

Source: services/end_shipper_service.js


diff --git a/services_event_service.js.html b/services_event_service.js.html index 9e9ce25eb..e83af70c8 100644 --- a/services_event_service.js.html +++ b/services_event_service.js.html @@ -116,13 +116,13 @@

Source: services/event_service.js


diff --git a/services_insurance_service.js.html b/services_insurance_service.js.html index 67f86397e..979f3d2b6 100644 --- a/services_insurance_service.js.html +++ b/services_insurance_service.js.html @@ -95,13 +95,13 @@

Source: services/insurance_service.js


diff --git a/services_order_service.js.html b/services_order_service.js.html index a6f3b4844..9b9fb139c 100644 --- a/services_order_service.js.html +++ b/services_order_service.js.html @@ -110,13 +110,13 @@

Source: services/order_service.js


diff --git a/services_parcel_service.js.html b/services_parcel_service.js.html index ffb48d58b..9140e8d28 100644 --- a/services_parcel_service.js.html +++ b/services_parcel_service.js.html @@ -72,13 +72,13 @@

Source: services/parcel_service.js


diff --git a/services_pickup_service.js.html b/services_pickup_service.js.html index 34566f636..2e5992e0a 100644 --- a/services_pickup_service.js.html +++ b/services_pickup_service.js.html @@ -132,13 +132,13 @@

Source: services/pickup_service.js


diff --git a/services_rate_service.js.html b/services_rate_service.js.html index adb6c856f..d9804aac0 100644 --- a/services_rate_service.js.html +++ b/services_rate_service.js.html @@ -56,13 +56,13 @@

Source: services/rate_service.js


diff --git a/services_referral_customer_service.js.html b/services_referral_customer_service.js.html index f678180cd..d178508e3 100644 --- a/services_referral_customer_service.js.html +++ b/services_referral_customer_service.js.html @@ -221,13 +221,13 @@

Source: services/referral_customer_service.js


diff --git a/services_refund_service.js.html b/services_refund_service.js.html index b1929d0a6..3ddd8f868 100644 --- a/services_refund_service.js.html +++ b/services_refund_service.js.html @@ -95,13 +95,13 @@

Source: services/refund_service.js


diff --git a/services_report_service.js.html b/services_report_service.js.html index 0e946fa9e..5c10f1fe6 100644 --- a/services_report_service.js.html +++ b/services_report_service.js.html @@ -104,13 +104,13 @@

Source: services/report_service.js


diff --git a/services_scan_form_service.js.html b/services_scan_form_service.js.html index 5dc5dd3b1..ef03d6207 100644 --- a/services_scan_form_service.js.html +++ b/services_scan_form_service.js.html @@ -107,13 +107,13 @@

Source: services/scan_form_service.js


diff --git a/services_shipment_service.js.html b/services_shipment_service.js.html index 546e1db54..c4a07ba7f 100644 --- a/services_shipment_service.js.html +++ b/services_shipment_service.js.html @@ -297,13 +297,13 @@

Source: services/shipment_service.js


diff --git a/services_tracker_service.js.html b/services_tracker_service.js.html index fc1229e01..8a85757b8 100644 --- a/services_tracker_service.js.html +++ b/services_tracker_service.js.html @@ -107,13 +107,13 @@

Source: services/tracker_service.js


diff --git a/services_user_service.js.html b/services_user_service.js.html index c037664be..f8d4eebef 100644 --- a/services_user_service.js.html +++ b/services_user_service.js.html @@ -144,6 +144,35 @@

Source: services/user_service.js

return Promise.reject(e); } } + + /** + * Retrieve a paginated list of children user {@link User user}. + * See {@link https://www.easypost.com/docs/api/node#child-users EasyPost API Documentation} for more information. + * @param {Object} params - Parameters to filter the list of children users. + * @returns {Object} - An object containing a list of {@link Children User} and pagination information. + */ + static async allChildren(params) { + const url = 'users/children'; + + try { + const response = await easypostClient._get(url, params); + + return this._convertToEasyPostObject(response.body, params); + } catch (e) { + return Promise.reject(e); + } + } + + /** + * Retrieve the next page of children collection. + * @param {Object} children An object containing a list of {@link Children children} and pagination information. + * @param {Number} pageSize The number of records to return on each page + * @returns {EasyPostObject|Promise<never>} The retrieved {@link EasyPostObject}-based class instance, or a `Promise` that rejects with an error. + */ + static async getNextPage(children, pageSize = null) { + const url = 'users/children'; + return this._getNextPage(url, 'children', children, pageSize); + } }; @@ -155,13 +184,13 @@

Source: services/user_service.js


diff --git a/services_webhook_service.js.html b/services_webhook_service.js.html index 48821d28d..13c14e1a0 100644 --- a/services_webhook_service.js.html +++ b/services_webhook_service.js.html @@ -121,13 +121,13 @@

Source: services/webhook_service.js


diff --git a/utils_internal_util.js.html b/utils_internal_util.js.html index 893d321c7..f8f384e4b 100644 --- a/utils_internal_util.js.html +++ b/utils_internal_util.js.html @@ -43,13 +43,13 @@

Source: utils/internal_util.js


diff --git a/utils_util.js.html b/utils_util.js.html index 02685bd03..66321e089 100644 --- a/utils_util.js.html +++ b/utils_util.js.html @@ -186,13 +186,13 @@

Source: utils/util.js