From a1fb1259641dcdd3c358f9e457afd0147fcadf65 Mon Sep 17 00:00:00 2001 From: Justintime50 <39606064+Justintime50@users.noreply.github.com> Date: Wed, 26 Mar 2025 13:51:09 -0600 Subject: [PATCH] fix: all references to the docs --- CHANGELOG.md | 1 + README.md | 8 ++++---- src/models/address.js | 2 +- src/models/api_key.js | 2 +- src/models/batch.js | 2 +- src/models/brand.js | 2 +- src/models/carrier_account.js | 2 +- src/models/carrier_type.js | 2 +- src/models/customs_info.js | 2 +- src/models/customs_item.js | 2 +- src/models/end_shipper.js | 2 +- src/models/event.js | 2 +- src/models/form.js | 2 +- src/models/insurance.js | 2 +- src/models/order.js | 2 +- src/models/parcel.js | 2 +- src/models/payload.js | 2 +- src/models/pickup.js | 2 +- src/models/rate.js | 2 +- src/models/refund.js | 2 +- src/models/report.js | 2 +- src/models/scan_form.js | 2 +- src/models/shipment.js | 2 +- src/models/tracker.js | 2 +- src/models/user.js | 2 +- src/models/webhook.js | 2 +- src/services/address_service.js | 10 +++++----- src/services/api_key_service.js | 4 ++-- src/services/batch_service.js | 16 +++++++-------- src/services/billing_service.js | 6 +++--- src/services/carrier_account_service.js | 10 +++++----- src/services/carrier_type_service.js | 2 +- src/services/customs_info_service.js | 4 ++-- src/services/customs_item_service.js | 4 ++-- src/services/end_shipper_service.js | 8 ++++---- src/services/event_service.js | 8 ++++---- src/services/insurance_service.js | 8 ++++---- src/services/order_service.js | 8 ++++---- src/services/parcel_service.js | 4 ++-- src/services/pickup_service.js | 10 +++++----- src/services/rate_service.js | 2 +- src/services/referral_customer_service.js | 8 ++++---- src/services/refund_service.js | 6 +++--- src/services/report_service.js | 6 +++--- src/services/scan_form_service.js | 6 +++--- src/services/shipment_service.js | 20 +++++++++---------- src/services/tracker_service.js | 6 +++--- src/services/user_service.js | 16 +++++++-------- src/services/webhook_service.js | 10 +++++----- types/Address/Address.d.ts | 16 +++++++-------- types/Address/AddressCreateParameters.d.ts | 2 +- types/Address/AddressListParameters.d.ts | 2 +- types/Address/Verification.d.ts | 2 +- types/Address/VerificationDetails.d.ts | 2 +- types/Address/Verifications.d.ts | 2 +- types/ApiKey/ApiKey.d.ts | 3 +-- types/Batch/Batch.d.ts | 20 +++++++++---------- types/Batch/BatchListParameters.d.ts | 2 +- types/Batch/BatchShipment.d.ts | 2 +- types/Billing/Billing.d.ts | 8 ++++---- types/Brand/Brand.d.ts | 4 ++-- .../CarrierAccount/CarrierAccount.d.ts | 12 +++++------ .../CarrierAccount/CarrierAccountField.d.ts | 2 +- .../CarrierAccount/CarrierAccountFields.d.ts | 2 +- .../CarrierMetadata/CarrierMetadata.d.ts | 4 ++-- types/Carrier/CarrierType/CarrierType.d.ts | 4 ++-- .../CarrierType/CarrierTypeCredentials.d.ts | 2 +- .../CarrierType/CarrierTypeFields.d.ts | 2 +- types/Claim/Claim.d.ts | 10 +++++----- types/Customs/CustomsInfo/CustomsInfo.d.ts | 8 ++++---- types/Customs/CustomsItem/CustomsItem.d.ts | 6 +++--- types/EndShipper/EndShipper.d.ts | 10 +++++----- .../EndShipper/EndShipperListParameters.d.ts | 2 +- types/Event/Event.d.ts | 4 ++-- types/Event/EventListParameters.d.ts | 2 +- types/Event/Payload/Payload.d.ts | 4 ++-- .../Event/Payload/PayloadListParameters.d.ts | 2 +- types/Fee/Fee.d.ts | 2 +- types/Insurance/Insurance.d.ts | 12 +++++------ types/Order/Order.d.ts | 8 ++++---- types/Parcel/Parcel.d.ts | 6 +++--- types/Pickup/Pickup.d.ts | 14 ++++++------- types/Pickup/PickupListParameters.d.ts | 2 +- types/Pickup/PickupRate.d.ts | 2 +- types/Rate/Rate.d.ts | 2 +- types/Referral/Referral.d.ts | 16 +++++++-------- types/Referral/ReferralListParameters.d.ts | 2 +- types/Refund/Refund.d.ts | 8 ++++---- types/Refund/RefundCreateParameters.d.ts | 2 +- types/Refund/RefundListParameters.d.ts | 2 +- types/Report/Report.d.ts | 10 +++++----- types/Report/ReportListParameters.d.ts | 2 +- types/ScanForm/ScanForm.d.ts | 10 +++++----- types/ScanForm/ScanFormListParameters.d.ts | 2 +- types/Shipment/Form.d.ts | 2 +- types/Shipment/Message.d.ts | 2 +- types/Shipment/Options/Options.d.ts | 4 ++-- types/Shipment/Rate.d.ts | 4 ++-- types/Shipment/Shipment.d.ts | 20 +++++++++---------- types/Shipment/ShipmentListParameters.d.ts | 2 +- types/SmartRate/SmartRate.d.ts | 2 +- types/Tracker/CarrierDetail.d.ts | 2 +- types/Tracker/Tracker.d.ts | 10 +++++----- types/Tracker/TrackingDetail.d.ts | 2 +- types/Tracker/TrackingLocation.d.ts | 2 +- types/User/User.d.ts | 14 ++++++------- types/Webhook/Webhook.d.ts | 12 +++++------ types/Webhook/WebhookListParameters.d.ts | 2 +- types/errors/Error.d.ts | 2 +- 109 files changed, 282 insertions(+), 282 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 55f627f37..bfffe0421 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ - `betaReferralCustomer.createBankAccountClientSecret` - `referralCustomer.addCreditCardFromStripe` - `referralCustomer.addBankAccountFromStripe` +- Fixes all references to the docs - Properly returns the response body of the following functions: `addPaymentMethod`, `refundByAmount`, `refundByPaymentLog` - `findMatchingMockRequest` mocking function made private - Removes undocumented and unmaintained `repl` diff --git a/README.md b/README.md index b3036d081..804af2b14 100644 --- a/README.md +++ b/README.md @@ -197,7 +197,7 @@ client.clearResponseHooks(); ## Documentation -API documentation can be found at: . +API documentation can be found at: . Library documentation can be found on the web at: or by building them locally via the `make docs` command. @@ -249,9 +249,9 @@ Starting with `v5.3.0`, this project has Typescript definitions included. #### Typescript Exclusions - We do not provide a DefinitelyTyped version of these definitions at this time -- Predefined packages (see [Carrier Metadata](https://www.easypost.com/docs/api#carrier-metadata) in our docs for more details) -- Carrier service levels (see [Carrier Metadata](https://www.easypost.com/docs/api#carrier-metadata) in our docs for more details) -- Carrier list (see [Carrier Types](https://www.easypost.com/docs/api#carrier-types) in our docs for more details) +- Predefined packages (see [Carrier Metadata](https://docs.easypost.com/docs/carrier-metadata) in our docs for more details) +- Carrier service levels (see [Carrier Metadata](https://docs.easypost.com/docs/carrier-metadata) in our docs for more details) +- Carrier list (see [Carrier Types](https://docs.easypost.com/docs/carrier-types) in our docs for more details) ### Testing diff --git a/src/models/address.js b/src/models/address.js index 4442336bf..aff20ae41 100644 --- a/src/models/address.js +++ b/src/models/address.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * An {@link https://www.easypost.com/docs/api/node#addresses Address} represents people, places, and organizations in a number of contexts. + * An {@link https://docs.easypost.com/docs/addresses Address} represents people, places, and organizations in a number of contexts. * @public * @extends EasyPostObject */ diff --git a/src/models/api_key.js b/src/models/api_key.js index a1133b82c..1ceff1ea2 100644 --- a/src/models/api_key.js +++ b/src/models/api_key.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * An {@link https://www.easypost.com/docs/api/node#api-keys ApiKey} represents an authentication token that can be used to make requests to the EasyPost API. + * An {@link https://docs.easypost.com/docs/api-keys ApiKey} represents an authentication token that can be used to make requests to the EasyPost API. * @public * @extends EasyPostObject */ diff --git a/src/models/batch.js b/src/models/batch.js index b6d1d7bb9..8b5534e90 100644 --- a/src/models/batch.js +++ b/src/models/batch.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#batches Batch} represents a collection of {@link Shipment shipments} that can be processed together. + * A {@link https://docs.easypost.com/docs/batches Batch} represents a collection of {@link Shipment shipments} that can be processed together. * @public * @extends EasyPostObject */ diff --git a/src/models/brand.js b/src/models/brand.js index 1c4a57f30..585f27f43 100644 --- a/src/models/brand.js +++ b/src/models/brand.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#brand Brand} represents custom branding for an EasyPost user's public-facing tracking details page. + * A {@link https://docs.easypost.com/docs/users/brand Brand} represents custom branding for an EasyPost user's public-facing tracking details page. * @public * @extends EasyPostObject */ diff --git a/src/models/carrier_account.js b/src/models/carrier_account.js index 6f3c75a65..05163014d 100644 --- a/src/models/carrier_account.js +++ b/src/models/carrier_account.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#carrier-accounts CarrierAccount} represents details about a specific enabled carrier, including credentials and other information. + * A {@link https://docs.easypost.com/docs/carrier-accounts CarrierAccount} represents details about a specific enabled carrier, including credentials and other information. * @public * @extends EasyPostObject */ diff --git a/src/models/carrier_type.js b/src/models/carrier_type.js index 04fe2799b..74cb573c4 100644 --- a/src/models/carrier_type.js +++ b/src/models/carrier_type.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#carrier-types CarrierType} represents the valid fields for a {@link CarrierAccount carrier account}. + * A {@link https://docs.easypost.com/docs/carrier-types CarrierType} represents the valid fields for a {@link CarrierAccount carrier account}. * @public * @extends EasyPostObject */ diff --git a/src/models/customs_info.js b/src/models/customs_info.js index 1734147c5..e448a737f 100644 --- a/src/models/customs_info.js +++ b/src/models/customs_info.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#customs-infos CustomsInfo} represents a collection of {@link CustomsItem CustomsItems} and associated information for generating international shipping customs forms. + * A {@link https://docs.easypost.com/docs/customs-infos CustomsInfo} represents a collection of {@link CustomsItem CustomsItems} and associated information for generating international shipping customs forms. * @public * @extends EasyPostObject */ diff --git a/src/models/customs_item.js b/src/models/customs_item.js index ebb4763d3..ec60ac54f 100644 --- a/src/models/customs_item.js +++ b/src/models/customs_item.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#customs-item CustomsItem} represents a single item being shipped internationally. + * A {@link https://docs.easypost.com/docs/customs-items CustomsItem} represents a single item being shipped internationally. * @public * @extends EasyPostObject */ diff --git a/src/models/end_shipper.js b/src/models/end_shipper.js index 5017fe6b4..4caad0508 100644 --- a/src/models/end_shipper.js +++ b/src/models/end_shipper.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * An {@link https://www.easypost.com/docs/api/node#endshipper EndShipper} represents a person or business entity that is authorized to purchase postage on behalf of another person and is ultimately responsible for the shipment. + * An {@link https://docs.easypost.com/docs/endshippers EndShipper} represents a person or business entity that is authorized to purchase postage on behalf of another person and is ultimately responsible for the shipment. * @public * @extends EasyPostObject */ diff --git a/src/models/event.js b/src/models/event.js index d43b9719b..f63cd7edd 100644 --- a/src/models/event.js +++ b/src/models/event.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * An {@link https://www.easypost.com/docs/api/node#events Event} represents a change in state for elements such as {@link Shipment shipments} and {@link Tracker trackers}, that triggers a {@link Webhook webhook}. + * An {@link https://docs.easypost.com/docs/events Event} represents a change in state for elements such as {@link Shipment shipments} and {@link Tracker trackers}, that triggers a {@link Webhook webhook}. * @public * @extends EasyPostObject */ diff --git a/src/models/form.js b/src/models/form.js index b042591e1..a80030bc8 100644 --- a/src/models/form.js +++ b/src/models/form.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#forms Form} represents a printable form for a {@link Shipment shipment}, such as a return packing slip, QR code or international shipping form. + * A {@link https://docs.easypost.com/docs/shipments/forms Form} represents a printable form for a {@link Shipment shipment}, such as a return packing slip, QR code or international shipping form. * @public * @extends EasyPostObject */ diff --git a/src/models/insurance.js b/src/models/insurance.js index 29dbcf196..ea020b634 100644 --- a/src/models/insurance.js +++ b/src/models/insurance.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * An {@link https://www.easypost.com/docs/api/node#api-keys Insurance} object represents insurance for a {@link Shipment shipment}. + * An {@link https://docs.easypost.com/docs/api-keys Insurance} object represents insurance for a {@link Shipment shipment}. * @public * @extends EasyPostObject */ diff --git a/src/models/order.js b/src/models/order.js index b4db435f9..476583001 100644 --- a/src/models/order.js +++ b/src/models/order.js @@ -2,7 +2,7 @@ import Constants from '../constants'; import EasyPostObject from './easypost_object'; /** - * An {@link https://www.easypost.com/docs/api/node#orders Order} represents a collection of packages, intended only for multi-parcel shipments. + * An {@link https://docs.easypost.com/docs/orders Order} represents a collection of packages, intended only for multi-parcel shipments. * @public * @extends EasyPostObject */ diff --git a/src/models/parcel.js b/src/models/parcel.js index c7be50849..d8c31515a 100644 --- a/src/models/parcel.js +++ b/src/models/parcel.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#parcels Parcel} represents a physical container being shipped, such as a box or envelope, with corresponding dimensions and weight. + * A {@link https://docs.easypost.com/docs/parcels Parcel} represents a physical container being shipped, such as a box or envelope, with corresponding dimensions and weight. * @public * @extends EasyPostObject */ diff --git a/src/models/payload.js b/src/models/payload.js index a4ac8c8f1..7fb47ac8d 100644 --- a/src/models/payload.js +++ b/src/models/payload.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#payloads Payload} represents an attempt by EasyPost to send an {@link Event event} to a {@link Webhook webhook}. + * A {@link https://docs.easypost.com/docs/events/payloads Payload} represents an attempt by EasyPost to send an {@link Event event} to a {@link Webhook webhook}. * @public * @extends EasyPostObject */ diff --git a/src/models/pickup.js b/src/models/pickup.js index a600f77b3..c5087a17c 100644 --- a/src/models/pickup.js +++ b/src/models/pickup.js @@ -2,7 +2,7 @@ import Constants from '../constants'; import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#pickups Pickup} represents a scheduled carrier pickup of packages from an {@link https://www.easypost.com/docs/api/node#addresses Address}. + * A {@link https://docs.easypost.com/docs/pickups Pickup} represents a scheduled carrier pickup of packages from an {@link https://docs.easypost.com/docs/addresses Address}. * @public * @extends EasyPostObject */ diff --git a/src/models/rate.js b/src/models/rate.js index f8f040e45..2b757f9e4 100644 --- a/src/models/rate.js +++ b/src/models/rate.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#rates Rate} represents pricing information for shipping a specific {@link Parcel} with a specific carrier and service level. + * A {@link https://docs.easypost.com/docs/shipments/rates Rate} represents pricing information for shipping a specific {@link Parcel} with a specific carrier and service level. * @public * @extends EasyPostObject */ diff --git a/src/models/refund.js b/src/models/refund.js index 28af6c6a1..dab7c280d 100644 --- a/src/models/refund.js +++ b/src/models/refund.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#refunds Refund} represents a refunded {@link Shipment}. + * A {@link https://docs.easypost.com/docs/refunds Refund} represents a refunded {@link Shipment}. * @public * @extends EasyPostObject */ diff --git a/src/models/report.js b/src/models/report.js index 92b65d1ba..f8d38bbff 100644 --- a/src/models/report.js +++ b/src/models/report.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#reports Report} represents a CSV file containing a log of all objects within a specific time frame. + * A {@link https://docs.easypost.com/docs/reports Report} represents a CSV file containing a log of all objects within a specific time frame. * @public * @extends EasyPostObject */ diff --git a/src/models/scan_form.js b/src/models/scan_form.js index e2a92ed0d..b4e7d4312 100644 --- a/src/models/scan_form.js +++ b/src/models/scan_form.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#scan-form ScanForm} represents a single document that can be scanned to mark all included tracking codes as "Accepted for Shipment" by the carrier. + * A {@link https://docs.easypost.com/docs/scan-form ScanForm} represents a single document that can be scanned to mark all included tracking codes as "Accepted for Shipment" by the carrier. * @public * @extends EasyPostObject */ diff --git a/src/models/shipment.js b/src/models/shipment.js index 270e57c2c..8d82b5e18 100644 --- a/src/models/shipment.js +++ b/src/models/shipment.js @@ -2,7 +2,7 @@ import Constants from '../constants'; import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#shipments Shipment} represents a physical {@link Parcel}, the origin and destination {@link Address Addresses}, and any associated {@link CustomsInfo}. + * A {@link https://docs.easypost.com/docs/shipments Shipment} represents a physical {@link Parcel}, the origin and destination {@link Address Addresses}, and any associated {@link CustomsInfo}. * @public * @extends EasyPostObject */ diff --git a/src/models/tracker.js b/src/models/tracker.js index 5b3b00d4f..da1dbc642 100644 --- a/src/models/tracker.js +++ b/src/models/tracker.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#trackers Tracker} represents the available tracking information for a package. + * A {@link https://docs.easypost.com/docs/trackers Tracker} represents the available tracking information for a package. * @public * @extends EasyPostObject */ diff --git a/src/models/user.js b/src/models/user.js index 5dc0071ed..0a32af626 100644 --- a/src/models/user.js +++ b/src/models/user.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#user ApiKey} represents an EasyPost account or child account. + * A {@link https://docs.easypost.com/docs/users ApiKey} represents an EasyPost account or child account. * @public * @extends EasyPostObject */ diff --git a/src/models/webhook.js b/src/models/webhook.js index 333d51cb6..6417304a6 100644 --- a/src/models/webhook.js +++ b/src/models/webhook.js @@ -1,7 +1,7 @@ import EasyPostObject from './easypost_object'; /** - * A {@link https://www.easypost.com/docs/api/node#webhooks Webhook} represents a URL that will receive notifications when certain {@link Event} occur. + * A {@link https://docs.easypost.com/docs/webhooks Webhook} represents a URL that will receive notifications when certain {@link Event} occur. * @public * @extends EasyPostObject */ diff --git a/src/services/address_service.js b/src/services/address_service.js index afd6b4507..1b859eb44 100644 --- a/src/services/address_service.js +++ b/src/services/address_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class AddressService extends baseService(easypostClient) { /** * Create an {@link Address address}. - * See {@link https://www.easypost.com/docs/api/node#create-an-address EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/addresses#create-an-address EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the address to be created. * @returns {Address} - The created address. */ @@ -36,7 +36,7 @@ export default (easypostClient) => /** * Create and verify an {@link Address address} in a single request. - * See {@link https://www.easypost.com/docs/api/node#create-and-verify-addresses EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/addresses#verify-an-address EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the address to be created. * @returns {Address} - The created and verified address. */ @@ -55,7 +55,7 @@ export default (easypostClient) => /** * Retrieve all {@link Address addresses} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-addresses EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/addresses#retrieve-all-addresses EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the list of addresses. * @returns {Object} - An object containing a list of {@link Address addresses} and pagination information. */ @@ -78,7 +78,7 @@ export default (easypostClient) => /** * Retrieve an {@link Address address} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-an-address EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/addresses#retrieve-an-address EasyPost API Documentation} for more information. * @param {string} id - The ID of the address to retrieve. * @returns {Address} - The retrieved address. */ @@ -90,7 +90,7 @@ export default (easypostClient) => /** * Verify an {@link Address address} by its ID. - * See {@link https://www.easypost.com/docs/api/node#create-and-verify-addresses EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/addresses#verify-an-address EasyPost API Documentation} for more information. * @param {string} id - The ID of the address to verify. * @returns {Address} - The verified address. */ diff --git a/src/services/api_key_service.js b/src/services/api_key_service.js index f9817b097..e798faf2b 100644 --- a/src/services/api_key_service.js +++ b/src/services/api_key_service.js @@ -12,7 +12,7 @@ export default (easypostClient) => class ApiKeyService extends baseService(easypostClient) { /** * Retrieve all {@link ApiKey API keys} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-an-api-key EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/api-keys#retrieve-an-api-key EasyPost API Documentation} for more information. * @returns {Object} - An object containing the API keys associated with the current authenticated user and its child users. */ static async all(params = {}) { @@ -23,7 +23,7 @@ export default (easypostClient) => /** * Retrieve API Keys for a specified {@link User user}. - * See {@link https://www.easypost.com/docs/api/node#retrieve-an-api-key EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/api-keys#retrieve-an-api-key EasyPost API Documentation} for more information. * @param {string} id - The ID of the user to retrieve keys for. * @returns {Array} - List of associated API Keys. * @throws {FilteringError} If user or API Keys are not found. diff --git a/src/services/batch_service.js b/src/services/batch_service.js index 5db04c49f..bbd13f97d 100644 --- a/src/services/batch_service.js +++ b/src/services/batch_service.js @@ -10,7 +10,7 @@ export default (easypostClient) => class BatchService extends baseService(easypostClient) { /** * Create a {@link Batch batch}. - * See {@link https://www.easypost.com/docs/api/node#create-a-batch EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#create-a-batch EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the batch to be created. * @returns {Batch} - The created batch. */ @@ -26,7 +26,7 @@ export default (easypostClient) => /** * Add {@link Shipment shipments} to a {@link Batch batch}. - * See {@link https://www.easypost.com/docs/api/node#add-shipments-to-a-batch EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#add-shipments-to-a-batch EasyPost API Documentation} for more information. * @param {string} id - The id of the batch to add shipments to. * @param {Array} shipmentIds - The ids of the shipments to add to the batch. * @returns {Batch} - The updated batch. @@ -47,7 +47,7 @@ export default (easypostClient) => /** * Removes {@link Shipment shipments} from a {@link Batch batch}. - * See {@link https://www.easypost.com/docs/api/node#remove-shipments-from-a-batch EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#remove-shipments-from-a-batch EasyPost API Documentation} for more information. * @param {string} id - The id of the batch to remove shipments from. * @param {Array} shipmentIds - The ids of the shipments to remove from the batch. * @returns {Batch} - The updated batch. @@ -69,7 +69,7 @@ export default (easypostClient) => /** * Generate a label for a {@link Batch batch}. - * See {@link https://www.easypost.com/docs/api/node#batch-labels EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#batch-labels EasyPost API Documentation} for more information. * @param {string} id - The id of the batch to generate a label for. * @param {string} fileFormat - The format of the label to generate. Defaults to 'pdf'. * @returns {Batch} - The updated batch. @@ -89,7 +89,7 @@ export default (easypostClient) => /** * Create a {@link ScanForm scan form} for a {@link Batch batch}. - * See {@link https://www.easypost.com/docs/api/node#manifesting-scan-form EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#manifesting-scan-form EasyPost API Documentation} for more information. * @param {string} id - The id of the batch to create a scan form for. * @returns {Batch} - The updated batch. */ @@ -107,7 +107,7 @@ export default (easypostClient) => /** * Purchase a {@link Batch batch}. - * See {@link https://www.easypost.com/docs/api/node#buy-a-batch EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#buy-a-batch EasyPost API Documentation} for more information. * @param {string} id - The id of the batch to purchase. * @returns {Batch} - The purchased batch. */ @@ -125,7 +125,7 @@ export default (easypostClient) => /** * Retrieve all {@link Batch batches} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#list-all-batches EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#retrieve-all-batches EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the list of batches. * @returns {Object} - An object containing a list of {@link Batch batches} and pagination information. */ @@ -137,7 +137,7 @@ export default (easypostClient) => /** * Retrieve a {@link Batch batch} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-batch EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/batches#retrieve-batch EasyPost API Documentation} for more information. * @param {string} id - The ID of the batch to retrieve. * @returns {Batch} - The retrieved batch. */ diff --git a/src/services/billing_service.js b/src/services/billing_service.js index 6807fdd05..a4732fefe 100644 --- a/src/services/billing_service.js +++ b/src/services/billing_service.js @@ -10,7 +10,7 @@ export default (easypostClient) => class BillingService extends baseService(easypostClient) { /** * Fund your EasyPost wallet by charging your primary or secondary payment method on file. - * See {@link https://www.easypost.com/docs/api/node#add-funds-to-your-wallet-one-time-charge EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/billing#add-funds-to-your-wallet-one-time-charge EasyPost API Documentation} for more information. * @param {String} amount - The amount to charge to your payment method. * @param {String} priority - The priority of the payment method to charge. Can be either 'primary' or 'secondary'. */ @@ -27,7 +27,7 @@ export default (easypostClient) => /** * Delete a payment method from the current authenticated user's account. - * See {@link https://www.easypost.com/docs/api/node#delete-a-payment-method EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/billing#delete-a-payment-method EasyPost API Documentation} for more information. * @param {String} priority - The priority of the payment method to delete. Can be either 'primary' or 'secondary'. */ static async deletePaymentMethod(priority) { @@ -42,7 +42,7 @@ export default (easypostClient) => /** * Retrieve all payment methods associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-payment-methods EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/billing#retrieve-payment-methods EasyPost API Documentation} for more information. * @returns {Object} - An object containing the payment methods associated with the current authenticated user. */ static async retrievePaymentMethods() { diff --git a/src/services/carrier_account_service.js b/src/services/carrier_account_service.js index 09a9f45f0..1237bd0ef 100644 --- a/src/services/carrier_account_service.js +++ b/src/services/carrier_account_service.js @@ -12,7 +12,7 @@ export default (easypostClient) => class CarrierAccountService extends baseService(easypostClient) { /** * Create a {@link CarrierAccount carrier account}. - * See {@link https://www.easypost.com/docs/api/node#create-a-carrier-account EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/carrier-accounts#create-a-carrieraccount EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the carrier account to be created. * @returns {CarrierAccount} - The created carrier account. */ @@ -33,7 +33,7 @@ export default (easypostClient) => /** * Update a {@link CarrierAccount carrier account}. - * See {@link https://www.easypost.com/docs/api/node#update-a-carrieraccount EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/carrier-accounts#update-a-carrieraccount EasyPost API Documentation} for more information. * @param {string} id - The id of the carrier account to be updated. * @param {Object} params - Parameters for the carrier account to be updated. * @returns {CarrierAccount} - The updated carrier account. @@ -57,7 +57,7 @@ export default (easypostClient) => /** * Delete a {@link CarrierAccount carrier account}. - * See {@link https://www.easypost.com/docs/api/node#delete-a-carrier-account EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/carrier-accounts#delete-a-carrieraccount EasyPost API Documentation} for more information. * @param {string} id - The id of the carrier account to be deleted. * @returns {Promise|Promise} - A promise that resolves when the carrier account has been deleted. */ @@ -119,7 +119,7 @@ export default (easypostClient) => /** * Retrieve all {@link CarrierAccount carrier accounts} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#list-all-carrier-accounts EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/carrier-accounts#retrieve-all-carrieraccounts EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the list of carrier accounts. * @returns {Object} - An object containing a list of {@link CarrierAccount carrier accounts} and pagination information. */ @@ -131,7 +131,7 @@ export default (easypostClient) => /** * Retrieve a {@link CarrierAccount carrier account} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-carrieraccount EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/carrier-accounts#retrieve-a-carrieraccount EasyPost API Documentation} for more information. * @param {string} id - The ID of the carrier account to retrieve. * @returns {CarrierAccount} - The retrieved carrier account. */ diff --git a/src/services/carrier_type_service.js b/src/services/carrier_type_service.js index cad3e3ddf..bb4b9ded9 100644 --- a/src/services/carrier_type_service.js +++ b/src/services/carrier_type_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class CarrierTypeService extends baseService(easypostClient) { /** * Retrieve all {@link CarrierType carrier types} available to the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-available-carrier-types EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/carrier-types#retrieve-available-carrier-types EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the list of carrier types. * @returns {CarrierType[]} - A list of {@link CarrierType carrier types}. */ diff --git a/src/services/customs_info_service.js b/src/services/customs_info_service.js index 0c36e56a7..c781bfbc7 100644 --- a/src/services/customs_info_service.js +++ b/src/services/customs_info_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class CustomsInfoService extends baseService(easypostClient) { /** * Create a {@link CustomsInfo customs info} record. - * See {@link https://www.easypost.com/docs/api/node#create-a-customsinfo EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/customs-infos#create-a-customsinfo EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the customs info to be created. * @returns {CustomsInfo} - The created customs info. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Retrieve a {@link CustomsInfo customs info} record by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-customsinfo EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/customs-infos#retrieve-a-customsinfo EasyPost API Documentation} for more information. * @param {string} id - The ID of the customs info to retrieve. * @returns {CustomsInfo} - The retrieved customs info. */ diff --git a/src/services/customs_item_service.js b/src/services/customs_item_service.js index ae36b7fce..aca0f97f5 100644 --- a/src/services/customs_item_service.js +++ b/src/services/customs_item_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class CustomsItemService extends baseService(easypostClient) { /** * Create a {@link CustomsItem customs item}. - * See {@link https://www.easypost.com/docs/api/node#create-a-customsitem EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/customs-items#create-a-customsitem EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the customs item to be created. * @returns {CustomsItem} - The created customs item. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Retrieve a {@link CustomsItem customs item} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-customsitem EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/customs-items#retrieve-a-customsitem EasyPost API Documentation} for more information. * @param {string} id - The ID of the customs item to retrieve. * @returns {CustomsItem} - The retrieved customs item. */ diff --git a/src/services/end_shipper_service.js b/src/services/end_shipper_service.js index 1aefe88b1..7c2515422 100644 --- a/src/services/end_shipper_service.js +++ b/src/services/end_shipper_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class EndShipperService extends baseService(easypostClient) { /** * Create an {@link EndShipper end shipper}. - * See {@link https://www.easypost.com/docs/api/node#create-an-endshipper EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/endshippers#create-an-endshipper EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the end shipper to be created. * @returns {EndShipper} - The created end shipper. */ @@ -21,7 +21,7 @@ export default (easypostClient) => /** * Update an {@link EndShipper end shipper}. - * See {@link https://www.easypost.com/docs/api/node#update-an-endshipper EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/endshippers#update-an-endshipper EasyPost API Documentation} for more information. * @param {string} id - The ID of the end shipper to update. * @param {Object} params - Parameters for the end shipper to be updated. * @returns {EndShipper} - The updated end shipper. @@ -41,7 +41,7 @@ export default (easypostClient) => /** * Retrieve an {@link EndShipper end shipper} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-an-endshipper EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/endshippers#retrieve-an-endshipper EasyPost API Documentation} for more information. * @param {string} id - The ID of the end shipper to retrieve. * @returns {EndShipper} - The retrieved end shipper. */ @@ -53,7 +53,7 @@ export default (easypostClient) => /** * Retrieve all {@link EndShipper end shippers} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-endshippers EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/endshippers#retrieve-all-endshippers EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the list of end shippers. * @returns {Object} - An object containing a list of {@link EndShipper end shippers} and pagination information. */ diff --git a/src/services/event_service.js b/src/services/event_service.js index 6bcd8fa63..3e3f05ae0 100644 --- a/src/services/event_service.js +++ b/src/services/event_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class EventService extends baseService(easypostClient) { /** * Retrieve all {@link Payload payloads} for an {@link Event event}. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-payloads EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/events/payloads#retrieve-all-payloads EasyPost API Documentation} for more information. * @param {string} id - The ID of the event to retrieve payloads for. * @returns {Payload[]} - A list of {@link Payload payloads} for the event. */ @@ -26,7 +26,7 @@ export default (easypostClient) => /** * Retrieve a specific {@link Payload payload} for an {@link Event event}. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-payload EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/events/payloads#retrieve-a-payload EasyPost API Documentation} for more information. * @param {string} id - The ID of the event to retrieve the payload for. * @param {string} payloadId - The ID of the payload to retrieve. * @returns {Payload} - The {@link Payload payload} for the event. @@ -45,7 +45,7 @@ export default (easypostClient) => /** * Retrieve all {@link Event events} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-events EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/events#retrieve-all-events EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the list of events. * @returns {Object} - An object containing the list of {@link Event events} and pagination information. */ @@ -68,7 +68,7 @@ export default (easypostClient) => /** * Retrieve an {@link Event event} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-an-event EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/events#retrieve-an-event EasyPost API Documentation} for more information. * @param {string} id - The ID of the event to retrieve. * @returns {Event} - The retrieved event. */ diff --git a/src/services/insurance_service.js b/src/services/insurance_service.js index 0946ede97..4c433a431 100644 --- a/src/services/insurance_service.js +++ b/src/services/insurance_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class InsuranceService extends baseService(easypostClient) { /** * Create an {@link Insurance insurance} record. - * See {@link https://www.easypost.com/docs/api/node#create-an-insurance EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/insurance#create-an-insurance EasyPost API Documentation} for more information. * @param {Object} params - Parameters for the insurance to be created. * @returns {Insurance} - The created insurance. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Retrieve all {@link Insurance} records associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-insurances EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/insurance#retrieve-all-insurances EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the insurance records. * @returns {Object} - An object containing the list of {@link Insurance insurance} records and pagination information. */ @@ -47,7 +47,7 @@ export default (easypostClient) => /** * Retrieve an {@link Insurance insurance} record by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-an-insurance EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/insurance#retrieve-an-insurance EasyPost API Documentation} for more information. * @param {string} id - The ID of the insurance to retrieve. * @returns {Insurance} - The retrieved insurance. */ @@ -59,7 +59,7 @@ export default (easypostClient) => /** * Refund an {@link Insurance insurance} record by its ID. - * See {@link https://www.easypost.com/docs/api/node#refund-an-insurance EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/insurance#refund-an-insurance EasyPost API Documentation} for more information. * @param {string} id - The ID of the insurance to be refunded. * @returns {Insurance} - The refunded insurance. */ diff --git a/src/services/order_service.js b/src/services/order_service.js index a65e57127..01fb6cf3e 100644 --- a/src/services/order_service.js +++ b/src/services/order_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class OrderService extends baseService(easypostClient) { /** * Create an {@link Order order}. - * See {@link https://www.easypost.com/docs/api/node#create-an-order EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/orders#create-an-order EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create an order with. * @returns {Order} - The created order. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Purchase an {@link Order order}. - * See {@link https://www.easypost.com/docs/api/node#buy-an-order EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/orders#buy-an-order EasyPost API Documentation} for more information. * @param {string} id - The ID of the order to buy. * @param {string} carrier - The carrier to use for the order purchase. * @param {string} service - The service to use for the order purchase. @@ -44,7 +44,7 @@ export default (easypostClient) => /** * Get updated rates for an {@link Order order}. - * See {@link https://www.easypost.com/docs/api/node#orders EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/orders EasyPost API Documentation} for more information. * @param {string} id - The ID of the order to get rates for. * @returns {Order} - The order with rates. */ @@ -62,7 +62,7 @@ export default (easypostClient) => /** * Retrieve an {@link Order order} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-an-order EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/orders#retrieve-an-order EasyPost API Documentation} for more information. * @param {string} id - The ID of the order to retrieve. * @returns {Order} - The retrieved order. */ diff --git a/src/services/parcel_service.js b/src/services/parcel_service.js index 0fab06796..c12c4f3d9 100644 --- a/src/services/parcel_service.js +++ b/src/services/parcel_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class ParcelService extends baseService(easypostClient) { /** * Create a {@link Parcel parcel}. - * See {@link https://www.easypost.com/docs/api/node#create-a-parcel EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/parcels#create-a-parcel EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a parcel with. * @returns {Parcel} - The created parcel. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Retrieve a {@link Parcel parcel} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-parcel EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/parcels#retrieve-a-parcel EasyPost API Documentation} for more information. * @param {string} id - The ID of the parcel to retrieve. * @returns {Parcel} - The retrieved parcel. */ diff --git a/src/services/pickup_service.js b/src/services/pickup_service.js index aa595c533..0968dc8d1 100644 --- a/src/services/pickup_service.js +++ b/src/services/pickup_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class PickupService extends baseService(easypostClient) { /** * Create a {@link Pickup pickup}. - * See {@link https://www.easypost.com/docs/api/node#create-a-pickup EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/pickups#create-a-pickup EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a pickup with. * @returns {Pickup} - The created pickup. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Purchase a {@link Pickup pickup}. - * See {@link https://www.easypost.com/docs/api/node#buy-a-pickup EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/pickups#buy-a-pickup EasyPost API Documentation} for more information. * @param {string} id - The ID of the pickup to purchase. * @param {string} carrier - The carrier to purchase the pickup with. * @param {string} service - The service to purchase the pickup with. @@ -44,7 +44,7 @@ export default (easypostClient) => /** * Cancel a {@link Pickup pickup}. - * See {@link https://www.easypost.com/docs/api/node#cancel-a-pickup EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/pickups#cancel-a-pickup EasyPost API Documentation} for more information. * @param {string} id - The ID of the pickup to cancel. * @returns {Pickup} - The cancelled pickup. */ @@ -61,7 +61,7 @@ export default (easypostClient) => /** * Retrieve all {@link Pickup pickups} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-pickups EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/pickups#retrieve-all-pickups EasyPost API Documentation} for more information. * @param {Object} [params] - The parameters to filter the pickups by. * @returns {Object} - An object containing a list of {@link Pickup pickups} and pagination information. */ @@ -84,7 +84,7 @@ export default (easypostClient) => /** * Retrieve a {@link Pickup pickup} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-pickup EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/pickups#retrieve-a-pickup EasyPost API Documentation} for more information. * @param {string} id - The ID of the pickup to retrieve. * @returns {Pickup} - The retrieved pickup. */ diff --git a/src/services/rate_service.js b/src/services/rate_service.js index 34d33bfeb..4f65069e3 100644 --- a/src/services/rate_service.js +++ b/src/services/rate_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class RateService extends baseService(easypostClient) { /** * Retrieve a {@link Rate rate} by its ID. - * See {@link https://www.easypost.com/docs/api/node#rates EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments/rates EasyPost API Documentation} for more information. * @param {string} id - The ID of the rate to retrieve. * @returns {Rate} - The retrieved rate. */ diff --git a/src/services/referral_customer_service.js b/src/services/referral_customer_service.js index 8806c91c6..3200936eb 100644 --- a/src/services/referral_customer_service.js +++ b/src/services/referral_customer_service.js @@ -90,7 +90,7 @@ export default (easypostClient) => class ReferralCustomerService extends baseService(easypostClient) { /** * Create a {@link User referral customer}. - * See {@link https://www.easypost.com/docs/api/node#create-a-referral-customer EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/referral-customers#create-a-referralcustomer EasyPost API Documentation} for more information. * @param {Object} params - The referral customer's information. * @returns {User} - The newly created referral customer. */ @@ -106,7 +106,7 @@ export default (easypostClient) => /** * Update a {@link User referral customer's} email address. - * See {@link https://www.easypost.com/docs/api/node#update-a-referral-customer EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/referral-customers#update-a-referralcustomer EasyPost API Documentation} for more information. * @param {string} referralUserId - The ID of the referral customer to update. * @param {string} email - The new email address. * @returns {boolean} - Returns true if the referral was updated successfully, false otherwise. @@ -122,7 +122,7 @@ export default (easypostClient) => /** * Add a credit card to EasyPost for a ReferralCustomer without needing a Stripe account. This function requires the ReferralCustomer User's API key. - * See {@link https://www.easypost.com/docs/api/node#create-credit-card EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/billing#create-credit-card EasyPost API Documentation} for more information. * @param {string} referralApiKey - The referral customer's production API key. * @param {string} number - The credit card number. * @param {string} expirationMonth - The credit card expiration month. @@ -206,7 +206,7 @@ export default (easypostClient) => /** * Retrieve all {@link User referral customers} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-referral-customers EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/referral-customers#retrieve-all-referralcustomers EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the referral customers by. * @returns {Object} - An object containing a list of {@link User referral customers} and pagination information. */ diff --git a/src/services/refund_service.js b/src/services/refund_service.js index 6c388be02..6012e7d0b 100644 --- a/src/services/refund_service.js +++ b/src/services/refund_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class RefundService extends baseService(easypostClient) { /** * Create a {@link Refund refund}. - * See {@link https://www.easypost.com/docs/api/node#create-a-refund EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/refunds#create-a-refund EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a refund with. * @returns {Refund} - The created refund. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Retrieve all {@link Refund refunds} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-refunds EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/refunds#retrieve-all-refunds EasyPost API Documentation} for more information. * @param {Object} [params] - The parameters to filter the refunds by. * @returns {Object} - An object containing the list of {@link Refund refunds} and pagination information. */ @@ -47,7 +47,7 @@ export default (easypostClient) => /** * Retrieve a {@link Refund refund} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-refund EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/refunds#retrieve-a-refund EasyPost API Documentation} for more information. * @param {string} id - The ID of the refund to retrieve. * @returns {Refund} - The retrieved refund. */ diff --git a/src/services/report_service.js b/src/services/report_service.js index c78bf07bd..3e48a275c 100644 --- a/src/services/report_service.js +++ b/src/services/report_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class ReportService extends baseService(easypostClient) { /** * Create a {@link Report report}. - * See {@link https://www.easypost.com/docs/api/node#create-a-report EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/reports#create-a-report EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a report with. * @returns {Report} - The created report. */ @@ -19,7 +19,7 @@ export default (easypostClient) => /** * Retrieve all {@link Report reports} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-reports EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/reports#retrieve-all-reports EasyPost API Documentation} for more information. * @param {Object} [params] - The parameters to filter the reports by. * @returns {Object} - An object containing the list of {@link Report reports} and pagination information. */ @@ -56,7 +56,7 @@ export default (easypostClient) => /** * Retrieve a {@link Report report} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-report EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/reports#retrieve-a-report EasyPost API Documentation} for more information. * @param {string} id - The ID of the report to retrieve. * @returns {Report} - The retrieved report. */ diff --git a/src/services/scan_form_service.js b/src/services/scan_form_service.js index 51dfb3a88..75d7de9cc 100644 --- a/src/services/scan_form_service.js +++ b/src/services/scan_form_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class ScanFormService extends baseService(easypostClient) { /** * Create a {@link ScanForm scan form}. - * See {@link https://www.easypost.com/docs/api/node#create-a-scanform EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/scan-form#create-a-scanform EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a scan form with. * @returns {ScanForm} - The created scan form. */ @@ -36,7 +36,7 @@ export default (easypostClient) => /** * Retrieve all {@link ScanForm scan forms} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-scanforms EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/scan-form#retrieve-all-scanforms EasyPost API Documentation} for more information. * @param {Object} [params] - The parameters to filter the scan forms by. * @returns {Object} - An object containing the list of {@link ScanForm scan forms} and pagination information. */ @@ -59,7 +59,7 @@ export default (easypostClient) => /** * Retrieve a {@link ScanForm scan form} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-scanform EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/scan-form#retrieve-a-scanform EasyPost API Documentation} for more information. * @param {string} id - The ID of the scan form to retrieve. * @returns {ScanForm} - The retrieved scan form. */ diff --git a/src/services/shipment_service.js b/src/services/shipment_service.js index 9d17cb5a9..34e362894 100644 --- a/src/services/shipment_service.js +++ b/src/services/shipment_service.js @@ -9,7 +9,7 @@ export default (easypostClient) => class ShipmentService extends baseService(easypostClient) { /** * Create a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#create-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments#create-a-shipment EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a shipment with. * @returns {Shipment} - The created shipment. */ @@ -25,7 +25,7 @@ export default (easypostClient) => /** * Purchase a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#buy-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments#buy-a-shipment EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to purchase. * @param {Rate} rate - The rate to purchase the shipment with. * @param {number|null} [insuranceAmount] - The amount of insurance to purchase for the shipment. @@ -66,7 +66,7 @@ export default (easypostClient) => /** * Convert the label format of a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#convert-the-label-format-of-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments#converting-the-label-format-of-a-shipment EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to convert the label format of. * @param {string} format - The format to convert the label to. * @returns {Shipment} - The shipment with the converted label format. @@ -86,7 +86,7 @@ export default (easypostClient) => /** * Regenerate {@link Rate rates} for a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#regenerate-rates-for-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments/rates#regenerate-rates-for-a-shipment EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to regenerate rates for. * @returns {Shipment} - The shipment with regenerated rates. */ @@ -105,7 +105,7 @@ export default (easypostClient) => /** * Get SmartRates for a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#retrieve-time-in-transit-statistics-across-all-rates-for-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments/shipping-smartrate#shipping-smartrate-1 EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to get SmartRates for. * @returns {Rate[]} - The SmartRates for the shipment. */ @@ -123,7 +123,7 @@ export default (easypostClient) => /** * Insure a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#insure-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments/shipping-insurance#insure-a-shipment EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to insure. * @param {number|string} amount - The amount to insure the shipment for. * @returns {Shipment} - The insured shipment. @@ -143,7 +143,7 @@ export default (easypostClient) => /** * Generate a form for a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#create-form EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments/forms#create-form EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to generate a form for. * @param {string} formType - The type of form to generate. * @param {Map} [formOptions] - Options for the form. @@ -169,7 +169,7 @@ export default (easypostClient) => /** * Refund a {@link Shipment shipment}. - * See {@link https://www.easypost.com/docs/api/node#refund-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments/shipping-refund#refund-a-shipment EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to refund. * @returns {Shipment} - The refunded shipment. */ @@ -203,7 +203,7 @@ export default (easypostClient) => /** * Retrieve all {@link Shipment shipments} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-shipments EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments#retrieve-all-shipments EasyPost API Documentation} for more information. * @param {Object} [params] - Parameters to filter the shipments by. * @returns {Object} - An object containing a list of {@link Shipment shipments} and pagination information. */ @@ -227,7 +227,7 @@ export default (easypostClient) => /** * Retrieve a {@link Shipment shipment} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-shipment EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/shipments#retrieve-a-shipment EasyPost API Documentation} for more information. * @param {string} id - The ID of the shipment to retrieve. * @returns {Shipment} - The shipment with the given ID. */ diff --git a/src/services/tracker_service.js b/src/services/tracker_service.js index 0c3997b95..10db3c530 100644 --- a/src/services/tracker_service.js +++ b/src/services/tracker_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class TrackerService extends baseService(easypostClient) { /** * Create a {@link Tracker tracker}. - * See {@link https://www.easypost.com/docs/api/node#create-a-tracker EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/trackers#create-a-tracker EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a tracker with. * @returns {Tracker} - The created tracker. */ @@ -24,7 +24,7 @@ export default (easypostClient) => /** * Retrieve all {@link Tracker trackers} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-trackers EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/trackers#retrieve-all-trackers EasyPost API Documentation} for more information. * @param {Object} [params] - The parameters to filter the trackers by. * @returns {Object} - An object containing the list of {@link Tracker trackers} and pagination information. */ @@ -48,7 +48,7 @@ export default (easypostClient) => /** * Retrieve a {@link Tracker tracker} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-tracker EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/trackers#retrieve-a-tracker EasyPost API Documentation} for more information. * @param {string} id - The ID of the tracker to retrieve. * @returns {Tracker} - The retrieved tracker. */ diff --git a/src/services/user_service.js b/src/services/user_service.js index f4676d57f..7bfc6e382 100644 --- a/src/services/user_service.js +++ b/src/services/user_service.js @@ -1,5 +1,5 @@ -import baseService from './base_service'; import EndOfPaginationError from '../errors/general/end_of_pagination_error'; +import baseService from './base_service'; export default (easypostClient) => /** @@ -9,7 +9,7 @@ export default (easypostClient) => class UserService extends baseService(easypostClient) { /** * Create a {@link User child user}. - * See {@link https://www.easypost.com/docs/api/node#create-a-child-user EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/child-users#create-a-child-user EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a child user with. * @returns {User} - The created child user. */ @@ -25,7 +25,7 @@ export default (easypostClient) => /** * Update a {@link User user}. - * See {@link https://www.easypost.com/docs/api/node#update-a-user EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users#update-a-user EasyPost API Documentation} for more information. * @param {string} id - The ID of the user to update (either the current authenticated user or a child user). * @param {Object} params - The parameters to update the user with. * @returns {User} - The updated user. @@ -47,7 +47,7 @@ export default (easypostClient) => /** * Retrieve a {@link User child user}. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-user EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users#retrieve-a-user EasyPost API Documentation} for more information. * @param {string} id - The ID of the child user to retrieve. * @returns {User} - The retrieved child user. */ @@ -65,7 +65,7 @@ export default (easypostClient) => /** * Retrieve the {@link User current authenticated user}. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-user EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users#retrieve-a-user EasyPost API Documentation} for more information. * @returns {User} - The retrieved user. */ static async retrieveMe() { @@ -82,7 +82,7 @@ export default (easypostClient) => /** * Delete a {@link User child user}. - * See {@link https://www.easypost.com/docs/api/node#delete-a-child-user EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/child-users#delete-a-child-user EasyPost API Documentation} for more information. * @param {string} id - The ID of the child user to delete. * @returns {Promise|Promise} - A promise that resolves when the child user is deleted successfully. */ @@ -100,7 +100,7 @@ export default (easypostClient) => /** * Update the brand of a {@link User user}. - * See {@link https://www.easypost.com/docs/api/node#update-a-brand EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/users/brand#update-a-brand EasyPost API Documentation} for more information. * @param {string} id - The ID of the user to update the brand of. * @param {Object} params - The parameters to update the brand with. * @returns {Brand} - The updated brand. @@ -120,7 +120,7 @@ export default (easypostClient) => /** * 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. + * See {@link https://docs.easypost.com/docs/users/child-users#retrieve-all-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. */ diff --git a/src/services/webhook_service.js b/src/services/webhook_service.js index 8166533e7..aed890d51 100644 --- a/src/services/webhook_service.js +++ b/src/services/webhook_service.js @@ -8,7 +8,7 @@ export default (easypostClient) => class WebhookService extends baseService(easypostClient) { /** * Create a {@link Webhook webhook}. - * See {@link https://www.easypost.com/docs/api/node#create-a-webhook EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/webhooks#create-a-webhook EasyPost API Documentation} for more information. * @param {Object} params - The parameters to create a webhook with. * @returns {Webhook} - The created webhook. */ @@ -25,7 +25,7 @@ export default (easypostClient) => /** * Update a {@link Webhook webhook}. * A disabled webhook will be re-enabled if it is updated. - * See {@link https://www.easypost.com/docs/api/node#update-a-webhook EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/webhooks#update-a-webhook EasyPost API Documentation} for more information. * @param {string} id - The ID of the webhook to update. * @param {Object} params - The parameters to update the webhook with. * @returns {Webhook} - The updated webhook. @@ -44,7 +44,7 @@ export default (easypostClient) => /** * Delete a {@link Webhook webhook}. - * See {@link https://www.easypost.com/docs/api/node#delete-a-webhook EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/webhooks#delete-a-webhook EasyPost API Documentation} for more information. * @param {string} id - The ID of the webhook to delete. * @returns {Promise|Promise} - A promise that resolves if the webhook was successfully deleted. */ @@ -62,7 +62,7 @@ export default (easypostClient) => /** * Retrieve all {@link Webhook webhooks} associated with the current authenticated user. - * See {@link https://www.easypost.com/docs/api/node#list-a-webhooks EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/webhooks#retrieve-all-webhooks EasyPost API Documentation} for more information. * @param {Object} [params] * @returns {Webhook[]} */ @@ -74,7 +74,7 @@ export default (easypostClient) => /** * Retrieve a {@link Webhook webhook} by its ID. - * See {@link https://www.easypost.com/docs/api/node#retrieve-a-webhook EasyPost API Documentation} for more information. + * See {@link https://docs.easypost.com/docs/webhooks#retrieve-a-webhook EasyPost API Documentation} for more information. * @param {string} id - The ID of the webhook to retrieve. * @returns {Webhook} - The retrieved webhook. */ diff --git a/types/Address/Address.d.ts b/types/Address/Address.d.ts index db7f1a008..fba5f0cdf 100644 --- a/types/Address/Address.d.ts +++ b/types/Address/Address.d.ts @@ -1,8 +1,8 @@ import { IObjectWithId } from '../base'; import { DeepPartial } from '../utils'; import { IAddressCreateParameters } from './AddressCreateParameters'; -import { IVerifications } from './Verifications'; import { IAddressListParameters } from './AddressListParameters'; +import { IVerifications } from './Verifications'; /** * Address objects are used to represent people, places, and organizations in a number of contexts. @@ -10,7 +10,7 @@ import { IAddressListParameters } from './AddressListParameters'; * * Additionally, EasyPost offers several verification tools that can be used to detect deliverability issues, correct minor errors in spelling/formatting, and determine if an Address is residential or not (which has a significant effect on Shipment rating for many carriers). * - * @see https://www.easypost.com/docs/api/node#address-object + * @see https://docs.easypost.com/docs/addresses#address-object */ export declare interface IAddress extends IObjectWithId<'Address'> { /** @@ -113,7 +113,7 @@ export declare class Address implements IAddress { /** * Create an {@link Address address}. - * @see https://www.easypost.com/docs/api/node#create-an-address + * @see https://docs.easypost.com/docs/addresses#create-an-address * @param {Object} params - Parameters for the address to be created. * @returns {Address} - The created address. */ @@ -127,7 +127,7 @@ export declare class Address implements IAddress { * The has_more attribute indicates whether additional pages can be requested. * The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-addresses + * @see https://docs.easypost.com/docs/addresses#retrieve-all-addresses * * @param {Object} params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Address addresses} and pagination information. @@ -147,7 +147,7 @@ export declare class Address implements IAddress { * When designing a shopping cart it is recommended to ask the shopper for their address and verify it on the spot. * If verification fails, ask them to double-check their input; if they confirm that their data is correct, assume they know their address more correctly than the verification process. * - * @see https://www.easypost.com/docs/api/node#create-and-verify-addresses + * @see https://docs.easypost.com/docs/addresses#verify-an-address * * @param {Object} params The parameters to create an {@link Address} with. * @returns {Promise
} The created and verified {@link Address}. @@ -157,7 +157,7 @@ export declare class Address implements IAddress { /** * Verify an {@link Address}. * - * @see https://www.easypost.com/docs/api/node#create-and-verify-addresses + * @see https://docs.easypost.com/docs/addresses#verify-an-address * * @param addressId Unique, begins with "adr_" * @returns {Promise
} The verified {@link Address}. @@ -167,7 +167,7 @@ export declare class Address implements IAddress { /** * An Address can be retrieved by its id. * - * @see https://www.easypost.com/docs/api/node#retrieve-an-address + * @see https://docs.easypost.com/docs/addresses#retrieve-an-address * * @param addressId Unique, begins with "adr_" * @returns {Promise
} The verified {@link Address} address. @@ -179,7 +179,7 @@ export declare class Address implements IAddress { * * This automatically reuses the parameters from the previous call or the original {@link Address.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-addresses + * @see https://docs.easypost.com/docs/addresses#retrieve-all-addresses * * @param {Object} addresses - The previous page of addresses (the response from the last {@link Address.getNextPage} or {@link Address.all} call). * @param {number} [pageSize] - The number of addresses to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Address/AddressCreateParameters.d.ts b/types/Address/AddressCreateParameters.d.ts index b29bd06f8..0468dcc06 100644 --- a/types/Address/AddressCreateParameters.d.ts +++ b/types/Address/AddressCreateParameters.d.ts @@ -2,7 +2,7 @@ import { ParametersToOmitOnCreate } from '../utils'; import { IAddress } from './Address'; /** - * @see https://www.easypost.com/docs/api/node#create-and-verify-addresses + * @see https://docs.easypost.com/docs/addresses#verify-an-address */ export declare interface IAddressCreateParameters extends Omit { diff --git a/types/Address/AddressListParameters.d.ts b/types/Address/AddressListParameters.d.ts index 23bf72b08..08cbc90ff 100644 --- a/types/Address/AddressListParameters.d.ts +++ b/types/Address/AddressListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api#retrieve-a-list-of-addresses + * @see https://docs.easypost.com/docs/addresses#retrieve-all-addresses */ export declare interface IAddressListParameters extends IAllMethodParameters {} diff --git a/types/Address/Verification.d.ts b/types/Address/Verification.d.ts index 6eecb63db..14f981013 100644 --- a/types/Address/Verification.d.ts +++ b/types/Address/Verification.d.ts @@ -2,7 +2,7 @@ import { IFieldError } from '../errors'; import { IVerificationDetails } from './VerificationDetails'; /** - * @see https://www.easypost.com/docs/api/node#verification-object + * @see https://docs.easypost.com/docs/addresses#verification-object */ export declare interface IVerification { /** diff --git a/types/Address/VerificationDetails.d.ts b/types/Address/VerificationDetails.d.ts index dbe668415..5e55ad6e1 100644 --- a/types/Address/VerificationDetails.d.ts +++ b/types/Address/VerificationDetails.d.ts @@ -1,5 +1,5 @@ /** - * @see https://www.easypost.com/docs/api/node#verification_details-object + * @see https://docs.easypost.com/docs/addresses#verificationdetails-object */ export declare interface IVerificationDetails { /** diff --git a/types/Address/Verifications.d.ts b/types/Address/Verifications.d.ts index 0bd339755..0ddbfed2a 100644 --- a/types/Address/Verifications.d.ts +++ b/types/Address/Verifications.d.ts @@ -1,7 +1,7 @@ import { IVerification } from './Verification'; /** - * @see https://www.easypost.com/docs/api/node#verifications-object + * @see https://docs.easypost.com/docs/addresses#verification-object */ export declare interface IVerifications { /** diff --git a/types/ApiKey/ApiKey.d.ts b/types/ApiKey/ApiKey.d.ts index 3d7a0e041..0d41af79c 100644 --- a/types/ApiKey/ApiKey.d.ts +++ b/types/ApiKey/ApiKey.d.ts @@ -1,5 +1,4 @@ import { IObjectWithId } from '../base'; -import { DeepPartial } from '../utils'; export declare interface IApiKey extends IObjectWithId<'ApiKey'> { /** @@ -30,7 +29,7 @@ export declare class ApiKey implements IApiKey { * Both production and test keys will be returned for a User and all of its children. * If the request is authenticated as a Child, only the API Keys for that Child will be returned. * - * @see https://www.easypost.com/docs/api/node#retrieve-an-api-key + * @see https://docs.easypost.com/docs/api-keys#retrieve-an-api-key * * @param apiKeyId Unique, begins with "user_" * @returns {Promise} The verified {@link ApiKey}. diff --git a/types/Batch/Batch.d.ts b/types/Batch/Batch.d.ts index 7665ad47c..5a8b437a4 100644 --- a/types/Batch/Batch.d.ts +++ b/types/Batch/Batch.d.ts @@ -13,7 +13,7 @@ import { TBatchStatuses } from './BatchStatuses'; * This includes scheduling a Pickup, creating a ScanForm and consolidating labels. * Operations performed on Batches are asynchronous and take advantage of our webhook infrastructure. * - * @see https://www.easypost.com/docs/api/node#batch-object + * @see https://docs.easypost.com/docs/batches#batch-object */ export declare interface IBatch extends IObjectWithId<'Batch'>, IDatedObject { /** @@ -80,7 +80,7 @@ export declare class Batch implements IBatch { * Once the state changes to created a webhook Event will be sent. * When created with no Shipments the initial state will be created and webhook will be sent. * - * @see https://www.easypost.com/docs/api/node#create-a-batch + * @see https://docs.easypost.com/docs/batches#create-a-batch * * @param {Object} params The parameters to create an {@link Batch} with. * @returns {Promise} The {@link Batch}. @@ -90,7 +90,7 @@ export declare class Batch implements IBatch { /** * A Batch can be retrieved by its id. * - * @see https://www.easypost.com/docs/api/node#retrieve-batch + * @see https://docs.easypost.com/docs/batches#retrieve-batch * * @param batchId Unique, begins with "batch_" * @@ -102,7 +102,7 @@ export declare class Batch implements IBatch { * Shipments can be added to a Batch throughout its life cycle. * Just remember that the state change of a Batch is asynchronous and will fire a webhook Event when the state change is completed. * - * @see https://www.easypost.com/docs/api/node#add-shipments-to-a-batch + * @see https://docs.easypost.com/docs/batches#add-shipments-to-a-batch * * @param id Unique, begins with "batch_" * @param shipments An array of shipments @@ -115,7 +115,7 @@ export declare class Batch implements IBatch { * There could be times when a Shipment needs to be removed from the Batch during its life cycle. * Removing a Shipment does not remove it from the consolidated label or ScanForm. * - * @see https://www.easypost.com/docs/api/node#remove-shipments-from-a-batch + * @see https://docs.easypost.com/docs/batches#remove-shipments-from-a-batch * * @param id Unique, begins with "batch_" * @param shipments An array of shipments @@ -134,7 +134,7 @@ export declare class Batch implements IBatch { * Available label formats are 'pdf', 'zpl' or 'epl2' format. * Like converting a PostageLabel format, if this process will change the format of the labels they must have been created as PNGs. * - * @see https://www.easypost.com/docs/api/node#batch-labels + * @see https://docs.easypost.com/docs/batches#batch-labels * * @param id Unique, begins with "batch_" * @param labelFormat The format of label @@ -144,9 +144,9 @@ export declare class Batch implements IBatch { static generateLabel(id: string, labelFormat: LabelFormat): Promise; /** - * See [Scan Form](https://www.easypost.com/docs/api/node#scan-form) rules and [Object Definition](https://www.easypost.com/docs/api/node#scan-form-object). + * See [Scan Form](https://docs.easypost.com/docs/scan-form) rules and [Object Definition](https://docs.easypost.com/docs/scan-form-object). * - * @see https://www.easypost.com/docs/api/node#manifesting-scan-form + * @see https://docs.easypost.com/docs/batches#manifesting-scan-form * * @param id Unique, begins with "batch_" * @@ -158,7 +158,7 @@ export declare class Batch implements IBatch { * Once you have added all of your Shipments to a Batch, issue a buy request to enqueue a background job to purchase the shipments and generate all necessary labels. * Purchasing may take anywhere from a few seconds to an hour, depending on the size of the batch, the carrier, and Internet weather. * - * @see https://www.easypost.com/docs/api/node#buy-a-batch + * @see https://docs.easypost.com/docs/batches#buy-a-batch * * @param id Unique, begins with "batch_" * @returns {Promise} The {@link Batch}. @@ -170,7 +170,7 @@ export declare class Batch implements IBatch { * See the Pagination section of our docs for more details on retrieving all records when * multiple pages are available. * - * @see https://www.easypost.com/docs/api/node#list-all-batches + * @see https://docs.easypost.com/docs/batches#retrieve-all-batches * * @param {Object} params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Batch batches} and pagination information. diff --git a/types/Batch/BatchListParameters.d.ts b/types/Batch/BatchListParameters.d.ts index 74cbdcfe6..a6e0fc7a4 100644 --- a/types/Batch/BatchListParameters.d.ts +++ b/types/Batch/BatchListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#list-all-batches + * @see https://docs.easypost.com/docs/batches#retrieve-all-batches */ export declare interface IBatchListParameters extends IAllMethodParameters {} diff --git a/types/Batch/BatchShipment.d.ts b/types/Batch/BatchShipment.d.ts index 7c57eefe3..9368ef1ec 100644 --- a/types/Batch/BatchShipment.d.ts +++ b/types/Batch/BatchShipment.d.ts @@ -1,7 +1,7 @@ import { TBatchStatus } from './BatchStatus'; /** - * @see https://www.easypost.com/docs/api/node#batch-shipment-object + * @see https://docs.easypost.com/docs/batches#batchshipment-object */ export declare interface IBatchShipment { /** diff --git a/types/Billing/Billing.d.ts b/types/Billing/Billing.d.ts index 2e71f8a7b..d624c5be6 100644 --- a/types/Billing/Billing.d.ts +++ b/types/Billing/Billing.d.ts @@ -2,13 +2,13 @@ * The Billing class allow you to fund wallet by using primary or secondary payment method, * delete a existing payment method, and retrieve all payment methods associated to the user. * - * @see https://www.easypost.com/docs/api/node#billing + * @see https://docs.easypost.com/docs/users/billing */ export declare class Billing { /** * Fund your EasyPost wallet by charging your primary or secondary payment method on file. * - * @see https://www.easypost.com/docs/api/node#add-funds-to-your-wallet-one-time-charge + * @see https://docs.easypost.com/docs/users/billing#add-funds-to-your-wallet-one-time-charge * @requires production API Key. * * @param amount Amount in cents to be deposited into the user's wallet. Amount must be greater than or equal to the user's current balance. @@ -18,7 +18,7 @@ export declare class Billing { /** * Delete a payment method from your account. - * @see https://www.easypost.com/docs/api/node#delete-a-payment-method + * @see https://docs.easypost.com/docs/users/billing#delete-a-payment-method * @requires production API Key. * * @param priority The payment method from your account, either primary or secondary. @@ -28,7 +28,7 @@ export declare class Billing { /** * Retrieve all payment methods. * - * @see https://www.easypost.com/docs/api/node#retrieve-payment-methods + * @see https://docs.easypost.com/docs/users/billing#retrieve-payment-methods * @requires production API Key. */ static retrievePaymentMethods(): object; diff --git a/types/Brand/Brand.d.ts b/types/Brand/Brand.d.ts index ef5432675..fb06857d9 100644 --- a/types/Brand/Brand.d.ts +++ b/types/Brand/Brand.d.ts @@ -3,7 +3,7 @@ import { IObjectWithId } from '../base'; /** * The Brand class represents the public-accessible information about a user's brand, including logos, colors and themes. * - * @see https://www.easypost.com/docs/api/node#brand + * @see https://docs.easypost.com/docs/users/brand */ export declare interface IBrand extends IObjectWithId<'Brand'> { /** @@ -64,7 +64,7 @@ export declare class Brand implements IBrand { /** * Update the brand of the current authenticated user. * - * @see https://www.easypost.com/docs/api/node#update-a-brand + * @see https://docs.easypost.com/docs/users/brand#update-a-brand * * @param params The parameters to update the {@link Brand} with * @returns {Promise} The updated Brand. diff --git a/types/Carrier/CarrierAccount/CarrierAccount.d.ts b/types/Carrier/CarrierAccount/CarrierAccount.d.ts index 478ceaeec..0f8cf95be 100644 --- a/types/Carrier/CarrierAccount/CarrierAccount.d.ts +++ b/types/Carrier/CarrierAccount/CarrierAccount.d.ts @@ -13,7 +13,7 @@ import { ICarrierAccountFields } from './CarrierAccountFields'; * For instance, you may have multiple warehouses that need to use distinct FedEx SmartPost credentials to request the correct rates. * Rate objects will include a `carrier_account_id` field which can be used to determine the account used for rating. * - * @see https://www.easypost.com/docs/api/node#carrier-account-object + * @see https://docs.easypost.com/docs/carrier-accounts#carrieraccount-object */ export declare interface ICarrierAccount extends IObjectWithId<'CarrierAccount'>, IDatedObject { /** @@ -86,7 +86,7 @@ export declare class CarrierAccount implements ICarrierAccount { * * The CarrierType of the preferred CarrierAccount should be consulted before attempting to create a new CarrierAccount, as it will inform you of the field names expected by a certain carrier. * - * @see https://www.easypost.com/docs/api/node#create-a-carrier-account + * @see https://docs.easypost.com/docs/carrier-accounts#create-a-carrieraccount * @requires production API Key. * * @param {Object} params The parameters to create an {@link CarrierAccount} with @@ -95,7 +95,7 @@ export declare class CarrierAccount implements ICarrierAccount { static create(params: Object): Promise; /** - * @see https://www.easypost.com/docs/api/node#update-a-carrieraccount + * @see https://docs.easypost.com/docs/carrier-accounts#update-a-carrieraccount * * @param carrierAccountId Unique, begins with "ca_" * @param {Object} params The parameters to create an {@link CarrierAccount} with @@ -107,7 +107,7 @@ export declare class CarrierAccount implements ICarrierAccount { * Retrieve an unpaginated list of all CarrierAccounts available to the authenticated account. * Only Production API keys may be used to retrieve this list, as there is no test mode equivalent. * - * @see https://www.easypost.com/docs/api/node#list-all-carrier-accounts + * @see https://docs.easypost.com/docs/carrier-accounts#retrieve-all-carrieraccounts * @requires production API Key. * * @returns {Object} - An object containing a list of {@link CarrierAccount carrier accounts}. @@ -120,7 +120,7 @@ export declare class CarrierAccount implements ICarrierAccount { * * @param carrierAccountId Unique, begins with "ca_" * - * @see https://www.easypost.com/docs/api/node#retrieve-a-carrieraccount + * @see https://docs.easypost.com/docs/carrier-accounts#retrieve-a-carrieraccount * @requires production API Key. * * @returns {Promise} The {@link CarrierAccount} object. @@ -130,7 +130,7 @@ export declare class CarrierAccount implements ICarrierAccount { /** * CarrierAccount objects may be removed from your account when they become out of date or no longer useful. * - * @see https://www.easypost.com/docs/api/node#delete-a-carrier-account + * @see https://docs.easypost.com/docs/carrier-accounts#delete-a-carrieraccount * @requires production API Key. * * @param carrierAccountId Unique, begins with "ca_" diff --git a/types/Carrier/CarrierAccount/CarrierAccountField.d.ts b/types/Carrier/CarrierAccount/CarrierAccountField.d.ts index b2170dcba..d6c103a3d 100644 --- a/types/Carrier/CarrierAccount/CarrierAccountField.d.ts +++ b/types/Carrier/CarrierAccount/CarrierAccountField.d.ts @@ -1,5 +1,5 @@ /** - * @see https://www.easypost.com/docs/api/node#carrier-account-field-object + * @see https://docs.easypost.com/docs/carrier-accounts#fields-object */ export declare interface ICarrierAccountField { /** diff --git a/types/Carrier/CarrierAccount/CarrierAccountFields.d.ts b/types/Carrier/CarrierAccount/CarrierAccountFields.d.ts index f7922f954..13a74a63a 100644 --- a/types/Carrier/CarrierAccount/CarrierAccountFields.d.ts +++ b/types/Carrier/CarrierAccount/CarrierAccountFields.d.ts @@ -1,7 +1,7 @@ import { ICarrierAccountField } from './CarrierAccountField'; /** - * @see https://www.easypost.com/docs/api/node#carrier-account-fields-object + * @see https://docs.easypost.com/docs/carrier-accounts#fields-object */ export declare interface ICarrierAccountFields { /** diff --git a/types/Carrier/CarrierMetadata/CarrierMetadata.d.ts b/types/Carrier/CarrierMetadata/CarrierMetadata.d.ts index fb74d8f2c..7f41b6247 100644 --- a/types/Carrier/CarrierMetadata/CarrierMetadata.d.ts +++ b/types/Carrier/CarrierMetadata/CarrierMetadata.d.ts @@ -4,7 +4,7 @@ * more that are available per carrier. This metadata can be useful during onboarding and integration or when * determining the ideal carrier mix for your setup. * - * @see https://www.easypost.com/docs/api/node#carriermetadata-object + * @see https://docs.easypost.com/docs/carrier-metadata#carriermetadata-object */ export declare interface ICarrierMetadata { /** @@ -53,7 +53,7 @@ export declare class CarrierMetadata implements ICarrierMetadata { * @param {Array} carriers A comma-delimited list of single-word carriers you'd like to filter the response by * @param {Array} types A comma-delimited list of the metadata types you'd like to filter the response by * - * @see https://www.easypost.com/docs/api/node#retrieve-carrier-metadata + * @see https://docs.easypost.com/docs/carrier-metadata#retrieve-carrier-metadata * * @returns {Promise} The {@link CarrierMetadata} object. */ diff --git a/types/Carrier/CarrierType/CarrierType.d.ts b/types/Carrier/CarrierType/CarrierType.d.ts index 347b33437..aa20acd6e 100644 --- a/types/Carrier/CarrierType/CarrierType.d.ts +++ b/types/Carrier/CarrierType/CarrierType.d.ts @@ -14,7 +14,7 @@ import { ICarrierTypeFields } from './CarrierTypeFields'; * The other custom option in the fields list is custom_workflow: true, which indicates that the EasyPost website export declare interface includes special processing for signups for the associated CarrierType. * Carriers with a custom workflow will also present their normal credential rules, but it is considered unsafe to directly add a CarrierAccount of this type with these attributes filled out via another source than the EasyPost custom workflow. * - * @see https://www.easypost.com/docs/api/node#carrier-type-object + * @see https://docs.easypost.com/docs/carrier-types#carriertype-object */ export declare interface ICarrierType extends IBaseObject<'CarrierType'> { /** @@ -36,7 +36,7 @@ export declare class CarrierType implements ICarrierType { /** * The CarrierType list is an unpaginated list of all carrier types available to the account of the given API key. * - * @see https://www.easypost.com/docs/api/node#retrieve-available-carrier-types + * @see https://docs.easypost.com/docs/carrier-types#retrieve-available-carrier-types * @requires production API Key. * * @returns {Object} - An object containing a list of {@link CarrierType carrier types}. diff --git a/types/Carrier/CarrierType/CarrierTypeCredentials.d.ts b/types/Carrier/CarrierType/CarrierTypeCredentials.d.ts index ba47cfb1f..671c0470a 100644 --- a/types/Carrier/CarrierType/CarrierTypeCredentials.d.ts +++ b/types/Carrier/CarrierType/CarrierTypeCredentials.d.ts @@ -1,5 +1,5 @@ /** - * @see https://www.easypost.com/docs/api/node#carrier-type-credentials-object + * @see https://docs.easypost.com/docs/carrier-types#credentials-object */ export declare interface ICarrierTypeCredentials { /** diff --git a/types/Carrier/CarrierType/CarrierTypeFields.d.ts b/types/Carrier/CarrierType/CarrierTypeFields.d.ts index fea487750..663f32034 100644 --- a/types/Carrier/CarrierType/CarrierTypeFields.d.ts +++ b/types/Carrier/CarrierType/CarrierTypeFields.d.ts @@ -1,7 +1,7 @@ import { ICarrierTypeCredentials } from './CarrierTypeCredentials'; /** - * @see https://www.easypost.com/docs/api/node#carrier-type-fields-object + * @see https://docs.easypost.com/docs/carrier-types#fields-object */ export declare interface ICarrierTypeFields { /** diff --git a/types/Claim/Claim.d.ts b/types/Claim/Claim.d.ts index a95ed7ee1..43396ff3b 100644 --- a/types/Claim/Claim.d.ts +++ b/types/Claim/Claim.d.ts @@ -95,7 +95,7 @@ export declare class Claim implements IClaim { /** * Create a claim * - * @see https://www.easypost.com/docs/api/node#create-an-claim + * @see https://docs.easypost.com/docs/insurance/claims#create-a-claim * * @param {Object} params The parameters to create an {@link Claim} with. * @returns {Promise} The created and verified {@link Claim}. @@ -108,7 +108,7 @@ export declare class Claim implements IClaim { * The has_more attribute indicates whether or not additional pages can be requested. * The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-claims + * @see https://docs.easypost.com/docs/insurance/claims#retrieve-all-claims * * @returns {Object} - An object containing a list of {@link Claim claim} and pagination information. */ @@ -117,7 +117,7 @@ export declare class Claim implements IClaim { /** * Retrieve an Claim by id. * - * @see https://www.easypost.com/docs/api/node#retrieve-an-claim + * @see https://docs.easypost.com/docs/insurance/claims#retrieve-a-claim * * @param claimId Unique, starts with "clm_" * @returns {Promise} The retrieved {@link Claim}. @@ -129,7 +129,7 @@ export declare class Claim implements IClaim { * * This automatically reuses the parameters from the previous call or the original {@link Claim.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-claims + * @see https://docs.easypost.com/docs/insurance/claims#retrieve-all-claims * * @param {Object} claims - The previous page of claims (the response from the last {@link Claim.getNextPage} or {@link Claim.all} call). * @param {number} [pageSize] - The number of claims to retrieve per page, optional. Defaults to server-side default. @@ -143,7 +143,7 @@ export declare class Claim implements IClaim { /** * Cancel an Claim by id. * - * @see https://www.easypost.com/docs/api/node#cancel-an-claim + * @see https://docs.easypost.com/docs/insurance/claims#cancel-a-claim * * @param claimId Unique, starts with "clm_" * @returns {Promise} The refunded {@link Claim}. diff --git a/types/Customs/CustomsInfo/CustomsInfo.d.ts b/types/Customs/CustomsInfo/CustomsInfo.d.ts index 353dfae7f..6edd1de9b 100644 --- a/types/Customs/CustomsInfo/CustomsInfo.d.ts +++ b/types/Customs/CustomsInfo/CustomsInfo.d.ts @@ -8,13 +8,13 @@ import { ICustomsInfoCreateParameters } from './CustomsInfoCreateParameters'; * * Please see the Shipments documentation for examples of including a CustomsInfo object in a shipment. * - * @see https://www.easypost.com/docs/api/node#customs-info-object + * @see https://docs.easypost.com/docs/customs-infos#customsinfo-object */ export declare interface ICustomsInfo extends IObjectWithId<'CustomsInfo'>, IDatedObject { /** * "EEL" or "PFC" * value less than $2500: "NOEEI 30.37(a)" - * value greater than $2500: see [Customs Guide](https://www.easypost.com/customs-guide) + * value greater than $2500: see [Customs Guide](https://docs.easypost.com/guides/customs-guide) */ eel_pfc?: string | null; @@ -87,7 +87,7 @@ export declare class CustomsInfo implements ICustomsInfo { /** * A CustomsInfo object contains all administrative information for processing customs, as well as a list of CustomsItems. When creating a CustomsInfo, you may store the ID from the response for use later in shipment creation. * - * @see https://www.easypost.com/docs/api#create-a-customs-info + * @see https://docs.easypost.com/docs/customs-infos#create-a-customsinfo * * @param {Object} params The parameters to create an {@link CustomsInfo} with. * @returns {Promise} The {@link CustomsInfo}. @@ -99,7 +99,7 @@ export declare class CustomsInfo implements ICustomsInfo { * * @param CustomsInfoId Unique, begins with "cstinfo_" * - * @see https://www.easypost.com/docs/api/node#retrieve-a-customs-info + * @see https://docs.easypost.com/docs/customs-infos#retrieve-a-customsinfo * * @returns {Promise} The {@link CustomsInfo}. */ diff --git a/types/Customs/CustomsItem/CustomsItem.d.ts b/types/Customs/CustomsItem/CustomsItem.d.ts index f81a258f8..9deaf4ea5 100644 --- a/types/Customs/CustomsItem/CustomsItem.d.ts +++ b/types/Customs/CustomsItem/CustomsItem.d.ts @@ -5,7 +5,7 @@ import { ICustomsItemCreateParameters } from './CustomsItemCreateParameters'; /** * A CustomsItem object describes goods for international shipment and should be created then included in a CustomsInfo object. * - * @see https://www.easypost.com/docs/api/node#customs-item-object + * @see https://docs.easypost.com/docs/customs-items-object */ export declare interface ICustomsItem extends IObjectWithId<'CustomsItem'>, IDatedObject { /** @@ -74,7 +74,7 @@ export declare class CustomsItem implements ICustomsItem { /** * A CustomsItem contains information relating to each product within the package. When creating a customs item, you may store the ID from the response for use later in CustomsInfo creation. * - * @see https://www.easypost.com/docs/api#create-a-customs-item + * @see https://docs.easypost.com/docs/customs-items#create-a-customsitem * * @param {Object} params The parameters to create an {@link CustomsItem} with. * @returns {Promise} The {@link CustomsItem}. @@ -86,7 +86,7 @@ export declare class CustomsItem implements ICustomsItem { * * @param CustomsItemId Unique, begins with "cstitem_" * - * @see https://www.easypost.com/docs/api/node#retrieve-a-customs-item + * @see https://docs.easypost.com/docs/customs-items#retrieve-a-customsitem * * @returns {Promise} The {@link CustomsItem}. */ diff --git a/types/EndShipper/EndShipper.d.ts b/types/EndShipper/EndShipper.d.ts index ffc020930..6ba20d004 100644 --- a/types/EndShipper/EndShipper.d.ts +++ b/types/EndShipper/EndShipper.d.ts @@ -10,7 +10,7 @@ import { IEndShipperListParameters } from './EndShipperListParameters'; * EndShipper objects must be created prior to buying a Shipment. Once EndShipper objects have been created, * you must keep track of their public id in order to use them during a label buy. * - * @see https://www.easypost.com/docs/api/node#endshipper + * @see https://docs.easypost.com/docs/endshippers */ export declare interface IEndshipper extends IObjectWithId<'EndShipper'> { /** @@ -87,7 +87,7 @@ export declare class EndShipper implements IEndshipper { * name and company fields. At least one of these fields must be filled (when both are present, name will take precedence). * street2 field. This fieldcan be empty if the address does not include multiple lines. * - * @see https://www.easypost.com/docs/api/node#create-an-endshipper + * @see https://docs.easypost.com/docs/endshippers#create-an-endshipper * * @param {Object} params The parameters to create an {@link EndShipper} with. * @returns {Promise} The created and verified {@link EndShipper}. @@ -98,7 +98,7 @@ export declare class EndShipper implements IEndshipper { * An EndShipper object may be updated using the EndShipper API. * All required fields for creating an EndShipper are required in an update request. Partial updates are not supported. * - * @see https://www.easypost.com/docs/api/node#update-an-endshipper + * @see https://docs.easypost.com/docs/endshippers#update-an-endshipper * * @param id Unique, start with "es_". * @param params The parameters to update an {@link EndShipper} with. @@ -109,7 +109,7 @@ export declare class EndShipper implements IEndshipper { /** * Similar to retrieving a list of EndShippers, you can retrieve an individual EndShipper. * - * @see https://www.easypost.com/docs/api/node#retrieve-an-endshipper + * @see https://docs.easypost.com/docs/endshippers#retrieve-an-endshipper * * @param id Unique, start with "es_". * @returns {Promise} The retrieved {@link EndShipper}. @@ -119,7 +119,7 @@ export declare class EndShipper implements IEndshipper { /** * List the EndShippers that have been created. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-endshippers + * @see https://docs.easypost.com/docs/endshippers#retrieve-all-endshippers * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link EndShipper endshippers} and pagination information. diff --git a/types/EndShipper/EndShipperListParameters.d.ts b/types/EndShipper/EndShipperListParameters.d.ts index 43720d66c..c31f2e038 100644 --- a/types/EndShipper/EndShipperListParameters.d.ts +++ b/types/EndShipper/EndShipperListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api#endshipper + * @see https://docs.easypost.com/docs/endshippers */ export declare interface IEndShipperListParameters extends IAllMethodParameters {} diff --git a/types/Event/Event.d.ts b/types/Event/Event.d.ts index 32786466c..5fcb5fbc2 100644 --- a/types/Event/Event.d.ts +++ b/types/Event/Event.d.ts @@ -7,7 +7,7 @@ import { IEventListParameters } from './EventListParameters'; * For this reason, we strongly encourage your webhook handler to be idempotent. * See the webhooks guide for more information. * - * @see https://www.easypost.com/docs/api/node#events + * @see https://docs.easypost.com/docs/events */ export declare interface IEvent extends IObjectWithId<'Event'>, IDatedObject { /** @@ -79,7 +79,7 @@ export declare class Event implements IEvent { * * This automatically reuses the parameters from the previous call or the original {@link Event.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-events + * @see https://docs.easypost.com/docs/events#retrieve-all-events * * @param {Object} events - The previous page of events (the response from the last {@link Event.getNextPage} or {@link Event.all} call). * @param {number} [pageSize] - The number of events to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Event/EventListParameters.d.ts b/types/Event/EventListParameters.d.ts index cce9b08c0..30a2e6419 100644 --- a/types/Event/EventListParameters.d.ts +++ b/types/Event/EventListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-events + * @see https://docs.easypost.com/docs/events#retrieve-all-events */ export declare interface IEventListParameters extends IAllMethodParameters {} diff --git a/types/Event/Payload/Payload.d.ts b/types/Event/Payload/Payload.d.ts index 2155c8425..325f40103 100644 --- a/types/Event/Payload/Payload.d.ts +++ b/types/Event/Payload/Payload.d.ts @@ -25,7 +25,7 @@ export declare class Payload implements IPayload { /** * Payload can be retrieved by their ID. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-payload + * @see https://docs.easypost.com/docs/events/payloads#retrieve-a-payload * * @param eventId the ID of the event object. * @param payloadId the ID of the payload. @@ -36,7 +36,7 @@ export declare class Payload implements IPayload { /** * Retrieve all payload objects. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-payloads + * @see https://docs.easypost.com/docs/events/payloads#retrieve-all-payloads * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Payload payloads} and pagination information. diff --git a/types/Event/Payload/PayloadListParameters.d.ts b/types/Event/Payload/PayloadListParameters.d.ts index 572af796d..22f2f7170 100644 --- a/types/Event/Payload/PayloadListParameters.d.ts +++ b/types/Event/Payload/PayloadListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-payloads + * @see https://docs.easypost.com/docs/events/payloads#retrieve-all-payloads */ export declare interface IPayloadListParameters extends IAllMethodParameters {} diff --git a/types/Fee/Fee.d.ts b/types/Fee/Fee.d.ts index eb9373246..df0f589e2 100644 --- a/types/Fee/Fee.d.ts +++ b/types/Fee/Fee.d.ts @@ -10,7 +10,7 @@ import { TFeeType } from './FeeType'; * Insurance on a Shipment will add an "InsuranceFee" with the insurance premium (not the covered value) for the amount. * Tracker objects will have a "TrackerFee" with the price, even when a Tracker is free. * - * @see https://www.easypost.com/docs/api/node#fee-object + * @see https://docs.easypost.com/docs/fees#fee-object */ export declare interface IFee extends IBaseObject<'Fee'> { /** diff --git a/types/Insurance/Insurance.d.ts b/types/Insurance/Insurance.d.ts index e3ae9e1e5..c39c997ec 100644 --- a/types/Insurance/Insurance.d.ts +++ b/types/Insurance/Insurance.d.ts @@ -21,7 +21,7 @@ import { TInsuranceStatus } from './InsuranceStatus'; * This means that a Shipment with "is_return: true" actually ships to the listed From Address. * Insurance does not have a concept of "is_return", so all insurance records refer to their true package destination as "to_address", regardless of whether or not the shipment is a return. * - * @see https://www.easypost.com/docs/api/node#insurance-object + * @see https://docs.easypost.com/docs/insurance#insurance-object */ export declare interface IInsurance extends IObjectWithId<'Insurance'>, IDatedObject { /** @@ -115,7 +115,7 @@ export declare class Insurance implements IInsurance { * Providing a carrier parameter is recommended, since some tracking_codes are ambiguous and may match with more than one carrier. * In addition, not having to auto-match the carrier will significantly speed up the response time. * - * @see https://www.easypost.com/docs/api/node#create-an-insurance + * @see https://docs.easypost.com/docs/insurance#create-an-insurance * * @param {Object} params The parameters to create an {@link Insurance} with. * @returns {Promise} The created and verified {@link Insurance}. @@ -128,7 +128,7 @@ export declare class Insurance implements IInsurance { * The has_more attribute indicates whether or not additional pages can be requested. * The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-insurances + * @see https://docs.easypost.com/docs/insurance#retrieve-all-insurances * * @returns {Object} - An object containing a list of {@link Insurance insurance} and pagination information. */ @@ -139,7 +139,7 @@ export declare class Insurance implements IInsurance { /** * Retrieve an Insurance by id. * - * @see https://www.easypost.com/docs/api/node#retrieve-an-insurance + * @see https://docs.easypost.com/docs/insurance#retrieve-an-insurance * * @param insuranceId Unique, starts with "ins_" * @returns {Promise} The retrieved {@link Insurance}. @@ -151,7 +151,7 @@ export declare class Insurance implements IInsurance { * * This automatically reuses the parameters from the previous call or the original {@link Insurance.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-insurances + * @see https://docs.easypost.com/docs/insurance#retrieve-all-insurances * * @param {Object} insurances - The previous page of insurances (the response from the last {@link Insurance.getNextPage} or {@link Insurance.all} call). * @param {number} [pageSize] - The number of insurances to retrieve per page, optional. Defaults to server-side default. @@ -165,7 +165,7 @@ export declare class Insurance implements IInsurance { /** * Refund an Insurance by id. * - * @see https://www.easypost.com/docs/api/node#refund-an-insurance + * @see https://docs.easypost.com/docs/insurance#refund-an-insurance * * @param insuranceId Unique, starts with "ins_" * @returns {Promise} The refunded {@link Insurance}. diff --git a/types/Order/Order.d.ts b/types/Order/Order.d.ts index 7858e2847..74f7d3caa 100644 --- a/types/Order/Order.d.ts +++ b/types/Order/Order.d.ts @@ -12,7 +12,7 @@ import { IOrderCreateParameters } from './OrderCreateParameters'; * * An Order created with valid Address Objects and Parcel data nested within the Order's Shipment object will automatically retrieve available shipping Rate options. * - * @see https://www.easypost.com/docs/api/node#order-object + * @see https://docs.easypost.com/docs/orders#order-object */ export declare interface IOrder extends IObjectWithId<'Order'>, IDatedObject { /** @@ -85,7 +85,7 @@ export declare class Order implements IOrder { * * You can limit the CarrierAccounts to use for rating by passing the carrier_accounts parameter. * - * @see https://www.easypost.com/docs/api/node#create-an-order + * @see https://docs.easypost.com/docs/orders#create-an-order * * @param {Object} params The parameters to create an {@link Order} with. * @returns {Promise} The created and verified {@link Order}. @@ -96,7 +96,7 @@ export declare class Order implements IOrder { * An Order can be retrieved by either its id or reference. * However it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced. * - * @see https://www.easypost.com/docs/api/node#retrieve-an-order + * @see https://docs.easypost.com/docs/orders#retrieve-an-order * * @param orderId Unique, begins with "order_" * @returns {Promise} The retrieved {@link Order}. @@ -107,7 +107,7 @@ export declare class Order implements IOrder { * To purchase an Order you only need to specify the carrier and service to purchase. * This operation populates the `tracking_code` and `postage_label` attributes of each Shipment. * - * @see https://www.easypost.com/docs/api/node#buy-an-order + * @see https://docs.easypost.com/docs/orders#buy-an-order * * @param orderId Unique, begins with "order_" * @param carrier Carrier (UPS, FedEx, USPS) diff --git a/types/Parcel/Parcel.d.ts b/types/Parcel/Parcel.d.ts index 49b051af1..119b37609 100644 --- a/types/Parcel/Parcel.d.ts +++ b/types/Parcel/Parcel.d.ts @@ -10,7 +10,7 @@ import { IParcelCreateParameters } from './ParcelCreateParameters'; * Weights are in OUNCES (OZ) and go to one decimal point. * Dimensions are in INCHES (IN) and go to one decimal point. * - * @see https://www.easypost.com/docs/api/node#parcel-object + * @see https://docs.easypost.com/docs/parcels#parcel-object */ export declare interface IParcel extends IObjectWithId<'Parcel'>, IDatedObject { /** @@ -60,7 +60,7 @@ export declare class Parcel implements IParcel { /** * Include the `weight`, and either a `predefined_package` or `length`, `width` and `height` if applicable. * - * @see https://www.easypost.com/docs/api/node#create-a-parcel + * @see https://docs.easypost.com/docs/parcels#create-a-parcel * * @param {Object} params The parameters to create an {@link Parcel} with. * @returns {Promise} The created and verified {@link Parcel}. @@ -73,7 +73,7 @@ export declare class Parcel implements IParcel { * A Parcel's id can be inlined into the creation call to other objects. * This allows you to only create one Parcel for each package you will be using. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-parcel + * @see https://docs.easypost.com/docs/parcels#retrieve-a-parcel * * @param parcelId Unique, begins with "prcl_" * @returns {Promise} The retrieved {@link Parcel}. diff --git a/types/Pickup/Pickup.d.ts b/types/Pickup/Pickup.d.ts index 258494697..048c4bb9e 100644 --- a/types/Pickup/Pickup.d.ts +++ b/types/Pickup/Pickup.d.ts @@ -25,7 +25,7 @@ import { IPickupRate } from './PickupRate'; * After a Pickup is successfully created, it will automatically fetch PickupRates for each CarrierAccount specified that supports scheduled pickups. * Then a PickupRate must be selected and purchased before the pickup can be successfully scheduled. * - * @see https://www.easypost.com/docs/api/node#pickup-object + * @see https://docs.easypost.com/docs/pickups#pickup-object */ export declare interface IPickup extends IObjectWithId<'Pickup'>, IDatedObject { /** @@ -117,7 +117,7 @@ export declare class Pickup implements IPickup { * Pickups work with existing shipments or a batch and either a fully-specified Address object or id. * The examples below assume that a shipment and address have both already been created. * - * @see https://www.easypost.com/docs/api/node#create-a-pickup + * @see https://docs.easypost.com/docs/pickups#create-a-pickup * * @param {Object} params The parameters to create an {@link Pickup} with. * @returns {Promise} The created and verified {@link Pickup}. @@ -130,7 +130,7 @@ export declare class Pickup implements IPickup { * The has_more attribute indicates whether additional pages can be requested. * The recommended way of paginating is to use either the before_id or after_id parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-pickups + * @see https://docs.easypost.com/docs/pickups#retrieve-all-pickups * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Pickup pickups} and pagination information. @@ -141,7 +141,7 @@ export declare class Pickup implements IPickup { * A Pickup object can be retrieved by either an id or reference. * However it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-pickup + * @see https://docs.easypost.com/docs/pickups#retrieve-a-pickup * * @param pickupId Unique, starts with "pickup_" * @returns {Promise} The created and verified {@link Pickup}. @@ -152,7 +152,7 @@ export declare class Pickup implements IPickup { * To purchase a Pickup a PickupRate must be specified by its carrier and service name, instead of its id. * The client libraries will handle this automatically if a PickupRate is provided. * - * @see https://www.easypost.com/docs/api/node#buy-a-pickup + * @see https://docs.easypost.com/docs/pickups#buy-a-pickup * * @param pickupId Unique, begins with "pickup_" * @param carrier Carrier (UPS, FedEx, USPS) @@ -166,7 +166,7 @@ export declare class Pickup implements IPickup { * It requires no additional parameters other than the id or reference. * The status will change to "canceled" on success. * - * @see https://www.easypost.com/docs/api/node#cancel-a-pickup + * @see https://docs.easypost.com/docs/pickups#cancel-a-pickup * * @param pickupId Unique, begins with "pickup_" * @returns {Promise} The created and verified {@link Pickup}. @@ -178,7 +178,7 @@ export declare class Pickup implements IPickup { * * This automatically reuses the parameters from the previous call or the original {@link Pickup.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-pickups + * @see https://docs.easypost.com/docs/pickups#retrieve-all-pickups * * @param {Object} pickups - The previous page of pickups (the response from the last {@link Pickup.getNextPage} or {@link Pickup.all} call). * @param {number} [pageSize] - The number of pickups to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Pickup/PickupListParameters.d.ts b/types/Pickup/PickupListParameters.d.ts index 35bfff86e..d43400459 100644 --- a/types/Pickup/PickupListParameters.d.ts +++ b/types/Pickup/PickupListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-pickups + * @see https://docs.easypost.com/docs/pickups#retrieve-all-pickups */ export declare interface IPickupListParameters extends IAllMethodParameters {} diff --git a/types/Pickup/PickupRate.d.ts b/types/Pickup/PickupRate.d.ts index 3d2177b36..b308dd240 100644 --- a/types/Pickup/PickupRate.d.ts +++ b/types/Pickup/PickupRate.d.ts @@ -1,7 +1,7 @@ import { IDatedObject, IObjectWithId } from '../base'; /** - * @see https://www.easypost.com/docs/api/node#pickup-rate-object + * @see https://docs.easypost.com/docs/pickups#pickuprate-object */ export declare interface IPickupRate extends IObjectWithId<'PickupRate'>, IDatedObject { /** diff --git a/types/Rate/Rate.d.ts b/types/Rate/Rate.d.ts index 15922b3dd..1d6417b23 100644 --- a/types/Rate/Rate.d.ts +++ b/types/Rate/Rate.d.ts @@ -3,7 +3,7 @@ import { IDatedObject, IObjectWithId } from '../base'; /** * The Rate class represents a summary of the price and details of a delivery service quote. * - * @see https://www.easypost.com/docs/api/node#rates + * @see https://docs.easypost.com/docs/shipments/rates */ export declare interface IRate extends IObjectWithId<'Rate'>, IDatedObject { /** diff --git a/types/Referral/Referral.d.ts b/types/Referral/Referral.d.ts index 2150e1a51..941c57e5d 100644 --- a/types/Referral/Referral.d.ts +++ b/types/Referral/Referral.d.ts @@ -5,7 +5,7 @@ import { IReferralListParameters } from './ReferralListParameters'; /** * A Referral represents a sub-user under a Partner or white-label account. * - * @see https://www.easypost.com/docs/api/node#referral-customers + * @see https://docs.easypost.com/docs/users/referral-customers */ export declare interface IReferral extends IUser {} @@ -30,7 +30,7 @@ export declare class Referral implements IReferral { /** * Creates a referral customer. * - * @see https://www.easypost.com/docs/api/node#create-a-referral-customer + * @see https://docs.easypost.com/docs/users/referral-customers#create-a-referralcustomer * * @param {Object} params The parameters to create an {@link Referral} with. * @returns {Promise} The created Referral. @@ -43,7 +43,7 @@ export declare class Referral implements IReferral { * The `has_more` attribute indicates whether additional pages can be requested. * The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-referral-customers + * @see https://docs.easypost.com/docs/users/referral-customers#retrieve-all-referralcustomers * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Referral referral customers} and pagination information. @@ -55,7 +55,7 @@ export declare class Referral implements IReferral { /** * Update a Referral's email address. * - * @see https://www.easypost.com/docs/api/node#update-a-referral-customer + * @see https://docs.easypost.com/docs/users/referral-customers#update-a-referralcustomer * * @param {string} referralUserId ID of the referral user to update * @param {string} email New email address for the referral user @@ -66,7 +66,7 @@ export declare class Referral implements IReferral { /** * Add Stripe payment method to referral customer. * - * @see https://www.easypost.com/docs/api/node#add-payment-method-to-referral-user + * @see https://docs.easypost.com/docs/users/referral-customers#add-payment-method-to-referralcustomer * * @param {string} stripeCustomerId Stripe customer ID * @param {string} paymentMethodReference Reference for the Stripe payment method @@ -81,7 +81,7 @@ export declare class Referral implements IReferral { /** * Refund by amount for a recent payment. - * @see https://www.easypost.com/docs/api/node#refund-a-referral-user + * @see https://docs.easypost.com/docs/users/referral-customers#refund-a-referralcustomer * * @param {number} refundAmount Amount to refund * @returns {object} Object representing the newly-added payment method @@ -90,7 +90,7 @@ export declare class Referral implements IReferral { /** * Refund a payment by a payment log ID. - * @see https://www.easypost.com/docs/api/node#refund-a-referral-user + * @see https://docs.easypost.com/docs/users/referral-customers#refund-a-referralcustomer * * @param {string} paymentLogId ID of the payment log to refund * @returns {object} Object representing the newly-added payment method @@ -102,7 +102,7 @@ export declare class Referral implements IReferral { * * This automatically reuses the parameters from the previous call or the original {@link Referral.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-referral-customers + * @see https://docs.easypost.com/docs/users/referral-customers#retrieve-all-referralcustomers * * @param {Object} referralCustomers - The previous page of referrals (the response from the last {@link Referral.getNextPage} or {@link Referral.all} call). * @param {number} [pageSize] - The number of referrals to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Referral/ReferralListParameters.d.ts b/types/Referral/ReferralListParameters.d.ts index a317e3967..5ebd59f20 100644 --- a/types/Referral/ReferralListParameters.d.ts +++ b/types/Referral/ReferralListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-referral-customers + * @see https://docs.easypost.com/docs/users/referral-customers#retrieve-all-referralcustomers */ export declare interface IReferralListParameters extends IAllMethodParameters {} diff --git a/types/Refund/Refund.d.ts b/types/Refund/Refund.d.ts index 30e2731a3..0889c6276 100644 --- a/types/Refund/Refund.d.ts +++ b/types/Refund/Refund.d.ts @@ -54,7 +54,7 @@ export declare class Refund implements IRefund { * This endpoint is intended to be used to bulk-process multiple refunds; as a result, this endpoint will return a list of Refund objects. * To refund a single shipment, use the Refund a Shipment endpoint instead. * - * @see https://www.easypost.com/docs/api/node#create-a-refund + * @see https://docs.easypost.com/docs/refunds#create-a-refund * * @param {Object} params The parameters to create an {@link Refund} with. * @returns {Promise} The created and verified {@link Refund}. @@ -65,7 +65,7 @@ export declare class Refund implements IRefund { * Retrieve a paginated list of all Refunds associated with the given API Key. * See the Pagination section of our docs for more details on retrieving all records when multiple pages are available. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-refunds + * @see https://docs.easypost.com/docs/refunds#retrieve-all-refunds * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Refund refunds} and pagination information. @@ -75,7 +75,7 @@ export declare class Refund implements IRefund { /** * Retrieve a Refund by id. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-refund + * @see https://docs.easypost.com/docs/refunds#retrieve-a-refund * * @param refundId Unique, starts with "refund_" * @returns {Promise} The created and verified {@link Refund}. @@ -87,7 +87,7 @@ export declare class Refund implements IRefund { * * This automatically reuses the parameters from the previous call or the original {@link Refund.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-refunds + * @see https://docs.easypost.com/docs/refunds#retrieve-all-refunds * * @param {Object} refunds - The previous page of refunds (the response from the last {@link Refund.getNextPage} or {@link Refund.all} call). * @param {number} [pageSize] - The number of refunds to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Refund/RefundCreateParameters.d.ts b/types/Refund/RefundCreateParameters.d.ts index 9340be75f..e4d498e68 100644 --- a/types/Refund/RefundCreateParameters.d.ts +++ b/types/Refund/RefundCreateParameters.d.ts @@ -1,5 +1,5 @@ /** - * @see https://www.easypost.com/docs/api/node#create-a-refund + * @see https://docs.easypost.com/docs/refunds#create-a-refund */ export declare interface IRefundCreateParameters { /** diff --git a/types/Refund/RefundListParameters.d.ts b/types/Refund/RefundListParameters.d.ts index cfbee60c8..6210bf30b 100644 --- a/types/Refund/RefundListParameters.d.ts +++ b/types/Refund/RefundListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-refunds + * @see https://docs.easypost.com/docs/refunds#retrieve-all-refunds */ export declare interface IRefundListParameters extends IAllMethodParameters {} diff --git a/types/Report/Report.d.ts b/types/Report/Report.d.ts index 665ee2e5a..7c406e220 100644 --- a/types/Report/Report.d.ts +++ b/types/Report/Report.d.ts @@ -19,7 +19,7 @@ import { TReportObjectType } from './ReportObjectType'; * - shipment_invoice * - tracker * - * @see https://www.easypost.com/docs/api/node#report-object + * @see https://docs.easypost.com/docs/reports#report-object */ export declare interface IReport extends IObjectWithId, IDatedObject { /** @@ -85,7 +85,7 @@ export declare class Report implements IReport { * * When a Report's status changes, a webhook will be created. See our Webhooks Guide for help on Event handling. * - * @see https://www.easypost.com/docs/api/node#create-a-report + * @see https://docs.easypost.com/docs/reports#create-a-report * * @param {Object} params The parameters to create an {@link Report} with. * @returns {Promise} The created and verified {@link Report}. @@ -98,7 +98,7 @@ export declare class Report implements IReport { * be requested. The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where * the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-reports + * @see https://docs.easypost.com/docs/reports#retrieve-all-reports * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Report reports} and pagination information. @@ -111,7 +111,7 @@ export declare class Report implements IReport { * @param reportId Unique, starts with the prefix for that particular report, * eg: "cfrep_", "plrep_", "refrep_", "shprep_", "shpinvrep_", "trkrep_" * - * @see https://www.easypost.com/docs/api/node#retrieve-a-report + * @see https://docs.easypost.com/docs/reports#retrieve-a-report */ static retrieve(reportId: string): Promise; @@ -120,7 +120,7 @@ export declare class Report implements IReport { * * This automatically reuses the parameters from the previous call or the original {@link Report.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-reports + * @see https://docs.easypost.com/docs/reports#retrieve-all-reports * * @param {Object} reports - The previous page of reports (the response from the last {@link Report.getNextPage} or {@link Report.all} call). * @param {number} [pageSize] - The number of reports to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Report/ReportListParameters.d.ts b/types/Report/ReportListParameters.d.ts index d36b03bc1..deaefc273 100644 --- a/types/Report/ReportListParameters.d.ts +++ b/types/Report/ReportListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-refunds + * @see https://docs.easypost.com/docs/refunds#retrieve-all-refunds */ export declare interface IReportListParameters extends IAllMethodParameters {} diff --git a/types/ScanForm/ScanForm.d.ts b/types/ScanForm/ScanForm.d.ts index 91502e07b..3610266a2 100644 --- a/types/ScanForm/ScanForm.d.ts +++ b/types/ScanForm/ScanForm.d.ts @@ -14,7 +14,7 @@ import { IScanFormListParameters } from './ScanFormListParameters'; * - Existing ScanForms may not be updated with additional Shipments. If a ScanForm already exists, and new Shipments need to be added, a new ScanForm must be created. * - Shipments should be provided in the form of an array * - * @see https://www.easypost.com/docs/api/node#scan-form-object + * @see https://docs.easypost.com/docs/scan-form-object */ export declare interface IScanForm extends IObjectWithId<'ScanForm'>, IDatedObject { /** @@ -74,7 +74,7 @@ export declare class ScanForm implements IScanForm { * A ScanForm can be created to speed up and simplify the carrier pickup process. * The Scan Form is one document that can be scanned to mark all included tracking codes as "Accepted for Shipment" by the carrier. * - * @see https://www.easypost.com/docs/api/node#scan-form + * @see https://docs.easypost.com/docs/scan-form * * @returns {Promise} The created ScanForm * @@ -89,7 +89,7 @@ export declare class ScanForm implements IScanForm { * The `has_more` attribute indicates whether additional pages can be requested. * The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-scan-forms + * @see https://docs.easypost.com/docs/scan-form#retrieve-all-scanforms * * @param {object} params The parameters to use for the request. * @returns {Object} - An object containing a list of {@link ScanForm scanforms} and pagination information. @@ -102,7 +102,7 @@ export declare class ScanForm implements IScanForm { * A ScanForm can be retrieved by either its id or reference. * However, it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-scan-form + * @see https://docs.easypost.com/docs/scan-form#retrieve-a-scanform * * @param {string} scanFormId Unique, begins with "sf_". */ @@ -113,7 +113,7 @@ export declare class ScanForm implements IScanForm { * * This automatically reuses the parameters from the previous call or the original {@link ScanForm.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-scanforms + * @see https://docs.easypost.com/docs/scan-form#retrieve-all-scanforms * * @param {Object} scanforms - The previous page of scan forms (the response from the last {@link ScanForm.getNextPage} or {@link ScanForm.all} call). * @param {number} [pageSize] - The number of scan forms to retrieve per page, optional. Defaults to server-side default. diff --git a/types/ScanForm/ScanFormListParameters.d.ts b/types/ScanForm/ScanFormListParameters.d.ts index 9558603a6..f2b5f77ad 100644 --- a/types/ScanForm/ScanFormListParameters.d.ts +++ b/types/ScanForm/ScanFormListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-scan-forms + * @see https://docs.easypost.com/docs/scan-form#retrieve-all-scanforms */ export declare interface IScanFormListParameters extends IAllMethodParameters {} diff --git a/types/Shipment/Form.d.ts b/types/Shipment/Form.d.ts index bb42ba8c8..a6c7e14ca 100644 --- a/types/Shipment/Form.d.ts +++ b/types/Shipment/Form.d.ts @@ -1,7 +1,7 @@ import { IDatedObject, IObjectWithId } from '../base'; /** - * @see https://www.easypost.com/docs/api/node#form-object + * @see https://docs.easypost.com/docs/shipments/forms#form-object */ export declare interface IForm extends IObjectWithId<'Form'>, IDatedObject { /** diff --git a/types/Shipment/Message.d.ts b/types/Shipment/Message.d.ts index 131cd22c3..042733380 100644 --- a/types/Shipment/Message.d.ts +++ b/types/Shipment/Message.d.ts @@ -5,7 +5,7 @@ * It is important to note that the message value for any member of this list comes directly from the carrier, not from EasyPost. * This means that if you see an authentication or other non-shipping error here, it is not an issue between you and EasyPost, it is an issue between you and the carrier, or an issue with the given data. * - * @see https://www.easypost.com/docs/api/node#message-object + * @see https://docs.easypost.com/docs/shipments/messages#message-object */ export declare interface IMessage { /** diff --git a/types/Shipment/Options/Options.d.ts b/types/Shipment/Options/Options.d.ts index f7ec2ad86..81b0393ec 100644 --- a/types/Shipment/Options/Options.d.ts +++ b/types/Shipment/Options/Options.d.ts @@ -5,7 +5,7 @@ import { TPrintCustomCode } from './PrintCustomCode'; * Shipments can have a variety of additional options which you can specify when creating a shipment. * The Options object can be populated with the keys below. * - * @see https://www.easypost.com/docs/api/node#options-object + * @see https://docs.easypost.com/docs/shipments/options#options-object */ export declare interface IOptions { /** @@ -230,7 +230,7 @@ export declare interface IOptions { * Supported label formats include "PNG", "PDF", "ZPL", and "EPL2". * "PNG" is the only format that allows for conversion. * - * @see https://www.easypost.com/docs/api#convert-the-label-format-of-a-shipment + * @see https://docs.easypost.com/docs/shipments#converting-the-label-format-of-a-shipment */ label_format?: LabelFormat | null; diff --git a/types/Shipment/Rate.d.ts b/types/Shipment/Rate.d.ts index 0ead594b6..1df3315b7 100644 --- a/types/Shipment/Rate.d.ts +++ b/types/Shipment/Rate.d.ts @@ -6,12 +6,12 @@ import { IDatedObject, IObjectWithId } from '../base'; * * There are three rate types: the actual rate that will be purchased, rate and currency, the published non-discounted rate, list_rate and list_currency, and the rate if purchased from the post office, retail_rate and retail_currency. * - * @see https://www.easypost.com/docs/api/node#rate-object + * @see https://docs.easypost.com/docs/shipments/rates#rate-object */ export declare interface IRate extends IObjectWithId<'Rate'>, IDatedObject { /** * service level/name - * @see https://www.easypost.com/docs/api/node#service-levels + * @see https://docs.easypost.com/docs/shipments/rates#service-levels */ service: string; diff --git a/types/Shipment/Shipment.d.ts b/types/Shipment/Shipment.d.ts index d1ee03098..75b76bc5a 100644 --- a/types/Shipment/Shipment.d.ts +++ b/types/Shipment/Shipment.d.ts @@ -21,7 +21,7 @@ import { IShipmentListParameters } from './ShipmentListParameters'; * * A Shipment created with a valid to_address, from_address, and parcel will automatically populate its rates attribute. * - * @see https://www.easypost.com/docs/api/node#shipment-object + * @see https://docs.easypost.com/docs/shipments#shipment-object */ export declare interface IShipment extends IObjectWithId<'Shipment'>, IDatedObject { /** @@ -194,7 +194,7 @@ export declare class Shipment implements IShipment { * * You can limit the CarrierAccounts to use for rating by passing the carrier_accounts parameter. * - * @see https://www.easypost.com/docs/api/node#create-a-shipment + * @see https://docs.easypost.com/docs/shipments#create-a-shipment * * @param {Object} params The parameters to create an {@link Shipment} with. * @returns {Promise} The created {@link Shipment}. @@ -207,7 +207,7 @@ export declare class Shipment implements IShipment { * The `has_more` attribute indicates whether additional pages can be requested. * The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-shipments + * @see https://docs.easypost.com/docs/shipments#retrieve-all-shipments * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Shipment shipments} and pagination information. @@ -220,7 +220,7 @@ export declare class Shipment implements IShipment { * A Shipment can be retrieved by either its id or reference. * However, it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-shipment + * @see https://docs.easypost.com/docs/shipments#retrieve-a-shipment * * @param {string} id Unique, begins with "shp_". * @returns {Promise} The created {@link Shipment}. @@ -237,7 +237,7 @@ export declare class Shipment implements IShipment { * To specify an amount to insure, pass the insurance attribute as a string. * The currency of all insurance is USD. * - * @see https://www.easypost.com/docs/api/node#buy-a-shipment + * @see https://docs.easypost.com/docs/shipments#buy-a-shipment * * @param id shipment id (begins with "shp_"). * @param rate rate id (begins with "rate_") or rate object. @@ -262,7 +262,7 @@ export declare class Shipment implements IShipment { * Refunds created very shortly after a label is generated may be improperly flagged as invalid, but you may retry a refund with the "rejected" status by submitting the same request again. * Carriers that are bill-on-scan tend to have refunds attempts return as "not_applicable", which will not change with multiple retries. * - * @see https://www.easypost.com/docs/api/node#refund-a-shipment + * @see https://docs.easypost.com/docs/shipments/shipping-refund#refund-a-shipment * * @param id shipment id (begins with "shp_"). * @returns {Promise} The created {@link Shipment}. @@ -281,7 +281,7 @@ export declare class Shipment implements IShipment { * A Shipment's PostageLabel can be converted from PNG to other formats. * If the PostageLabel was originally generated in a format other than PNG it cannot be converted. * - * @see https://www.easypost.com/docs/api/node#convert-the-label-format-of-a-shipment + * @see https://docs.easypost.com/docs/shipments#converting-the-label-format-of-a-shipment * * @param id shipment id (begins with "shp_"). * @param format Format of the label ("PNG", "PDF", "ZPL", and "EPL2"). @@ -293,7 +293,7 @@ export declare class Shipment implements IShipment { * You can update the Rates of a Shipment at any time. * This operation respects the `carrier_accounts` attribute. * - * @see https://www.easypost.com/docs/api/node#regenerate-rates-for-a-shipment + * @see https://docs.easypost.com/docs/shipments/rates#regenerate-rates-for-a-shipment * * @param id shipment id (begins with "shp_"). * @returns {Promise} The created {@link Shipment}. @@ -307,7 +307,7 @@ export declare class Shipment implements IShipment { * * To buy insurance, first purchase the Shipment, then make the insurance call before the package begins being handled by the carrier. * - * @see https://www.easypost.com/docs/api/node#insure-a-shipment + * @see https://docs.easypost.com/docs/shipments/shipping-insurance#insure-a-shipment * * @param id shipment id (begins with "shp_"). * @param amount amount to insure the shipment for. @@ -347,7 +347,7 @@ export declare class Shipment implements IShipment { * * This automatically reuses the parameters from the previous call or the original {@link Shipment.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-shipments + * @see https://docs.easypost.com/docs/shipments#retrieve-all-shipments * * @param {Object} shipments - The previous page of shipments (the response from the last {@link Shipment.getNextPage} or {@link Shipment.all} call). * @param {number} [pageSize] - The number of shipments to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Shipment/ShipmentListParameters.d.ts b/types/Shipment/ShipmentListParameters.d.ts index 35bc53513..8117a2c1a 100644 --- a/types/Shipment/ShipmentListParameters.d.ts +++ b/types/Shipment/ShipmentListParameters.d.ts @@ -1,7 +1,7 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-shipments + * @see https://docs.easypost.com/docs/shipments#retrieve-all-shipments */ export declare interface IShipmentListParameters extends IAllMethodParameters { /** diff --git a/types/SmartRate/SmartRate.d.ts b/types/SmartRate/SmartRate.d.ts index 9c2d6399d..68f970c9d 100644 --- a/types/SmartRate/SmartRate.d.ts +++ b/types/SmartRate/SmartRate.d.ts @@ -1,7 +1,7 @@ /** * The SmartRate class interacts with the SmartRate API to provide optimized shipping rates and estimates. * - * @see https://www.easypost.com/smartrate + * @see https://docs.easypost.com/docs/smartrate */ export declare class SmartRate { /** diff --git a/types/Tracker/CarrierDetail.d.ts b/types/Tracker/CarrierDetail.d.ts index 4ef685664..9d3136878 100644 --- a/types/Tracker/CarrierDetail.d.ts +++ b/types/Tracker/CarrierDetail.d.ts @@ -2,7 +2,7 @@ import { IBaseObject } from '../base'; import { ITrackingLocation } from './TrackingLocation'; /** - * @see https://www.easypost.com/docs/api/node#carrier-detail-object + * @see https://docs.easypost.com/docs/trackers#carrierdetail-object */ export declare interface ICarrierDetail extends IBaseObject<'CarrierDetail'> { /** diff --git a/types/Tracker/Tracker.d.ts b/types/Tracker/Tracker.d.ts index 74e85f86b..ac1d7f32e 100644 --- a/types/Tracker/Tracker.d.ts +++ b/types/Tracker/Tracker.d.ts @@ -33,7 +33,7 @@ import { ITrackingDetail } from './TrackingDetail'; * The carriers do eventually recycle `tracking_codes`, and for this reason enforcing uniqueness on the `tracking_code` field is not recommended. * EasyPost does, however, prevent the creation of duplicate Trackers based on tracking_code and carrier; duplicate requests by the same User will simply return the original Tracker. * - * @see https://www.easypost.com/docs/api/node#tracker-object + * @see https://docs.easypost.com/docs/trackers#tracker-object */ export declare interface ITracker extends IObjectWithId<'Tracker'>, IDatedObject { /** @@ -130,7 +130,7 @@ export declare class Tracker implements ITracker { * A Tracker is considered to be a duplicate if another Tracker with the same tracking_code and carrier was created by the same User in the last three months. * In the case where a duplicate request is submitted, the original Tracker will be returned. * - * @see https://www.easypost.com/docs/api/node#create-a-tracker + * @see https://docs.easypost.com/docs/trackers#create-a-tracker * * @param {Object} params The parameters to create an {@link Tracker} with. * @returns {Promise} The {@link Tracker}. @@ -147,7 +147,7 @@ export declare class Tracker implements ITracker { * Unlike the retrieving a Tracker using the Retrieve endpoint, which accepts an id, the List endpoint accepts the tracking_code as the search parameter. * Normally, you'll only have one Tracker with a given `tracking_code`, but it is also possible to further filter those results by including the carrier parameter in your request. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-trackers + * @see https://docs.easypost.com/docs/trackers#retrieve-all-trackers * * @param params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Tracker trackers} and pagination information. @@ -159,7 +159,7 @@ export declare class Tracker implements ITracker { * * @param trackerId Unique, starts with "trk_" * - * @see https://www.easypost.com/docs/api/node#retrieve-a-tracker + * @see https://docs.easypost.com/docs/trackers#retrieve-a-tracker * * @param trackerId The id of tracker, starts with "trk_" * @returns {Promise} The retrieved {@link Tracker}. @@ -171,7 +171,7 @@ export declare class Tracker implements ITracker { * * This automatically reuses the parameters from the previous call or the original {@link Tracker.all} call. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-list-of-trackers + * @see https://docs.easypost.com/docs/trackers#retrieve-all-trackers * * @param {Object} trackers - The previous page of trackers (the response from the last {@link Tracker.getNextPage} or {@link Tracker.all} call). * @param {number} [pageSize] - The number of trackers to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Tracker/TrackingDetail.d.ts b/types/Tracker/TrackingDetail.d.ts index bf2391ff2..6b715cbd9 100644 --- a/types/Tracker/TrackingDetail.d.ts +++ b/types/Tracker/TrackingDetail.d.ts @@ -3,7 +3,7 @@ import { ITrackerStatus } from './TrackerStatus'; import { ITrackingLocation } from './TrackingLocation'; /** - * @see https://www.easypost.com/docs/api/node#tracking-detail-object + * @see https://docs.easypost.com/docs/trackers#trackingdetail-object */ export declare interface ITrackingDetail extends IBaseObject<'TrackingDetail'> { /** diff --git a/types/Tracker/TrackingLocation.d.ts b/types/Tracker/TrackingLocation.d.ts index d621343a1..a094ddbc6 100644 --- a/types/Tracker/TrackingLocation.d.ts +++ b/types/Tracker/TrackingLocation.d.ts @@ -1,7 +1,7 @@ import { IBaseObject } from '../base'; /** - * @see https://www.easypost.com/docs/api/node#tracking-location-object + * @see https://docs.easypost.com/docs/trackers#trackinglocation-object */ export declare interface ITrackingLocation extends IBaseObject<'TrackingLocation'> { /** diff --git a/types/User/User.d.ts b/types/User/User.d.ts index 5e2a7ec47..7abe4a5af 100644 --- a/types/User/User.d.ts +++ b/types/User/User.d.ts @@ -7,7 +7,7 @@ import { IUserCreateParameters } from './UserCreateParameters'; * * Balance and recharge values on User objects are expressed in higher precision USD. * - * @see https://www.easypost.com/docs/api/node#user-object + * @see https://docs.easypost.com/docs/users-object */ export declare interface IUser extends IObjectWithId<'User'> { /** @@ -100,7 +100,7 @@ export declare class User implements IUser { /** * Creates a child user. * - * @see https://www.easypost.com/docs/api/node#create-a-child-user + * @see https://docs.easypost.com/docs/users/child-users#create-a-child-user * @requires production API Key. * * @param {Object} params The parameters to create an {@link User} with. @@ -112,7 +112,7 @@ export declare class User implements IUser { * Retrieve a child user. * @requires production API Key. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-user + * @see https://docs.easypost.com/docs/users#retrieve-a-user * * @param {string} id ID of the child user to retrieve * @param urlPrefix Override the prefix to use for the request URL, optional @@ -124,7 +124,7 @@ export declare class User implements IUser { * Retrieve the current authenticated user. * @requires production API Key. * - * @see https://www.easypost.com/docs/api/node#retrieve-a-user + * @see https://docs.easypost.com/docs/users#retrieve-a-user * * @returns {Promise} The current authenticated user. */ @@ -139,7 +139,7 @@ export declare class User implements IUser { * Update requests for Users are partial updates. Only attributes specifically passed in will be updated. * The current_password attribute is required when updating email or password. * - * @see https://www.easypost.com/docs/api/node#update-a-user + * @see https://docs.easypost.com/docs/users#update-a-user * @requires production API Key. * * @param id The id of the user @@ -165,7 +165,7 @@ export declare class User implements IUser { * The has_more attribute indicates whether additional pages can be requested. * The recommended way of paginating is to use either the `before_id` or `after_id` parameter to specify where the next page begins. * - * @see https://www.easypost.com/docs/api/node#child-users + * @see https://docs.easypost.com/docs/users/child-users#retrieve-all-child-users * * @param {Object} params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Children children} and pagination information. @@ -177,7 +177,7 @@ export declare class User implements IUser { * * This automatically reuses the parameters from the previous call or the original {@link User.allChildren} call. * - * @see https://www.easypost.com/docs/api/node#child-users + * @see https://docs.easypost.com/docs/users/child-users#retrieve-all-child-users * * @param {Object} children - The previous page of child users (the response from the last {@link User.getNextPage} or {@link User.allChildren} call). * @param {number} [pageSize] - The number of child users to retrieve per page, optional. Defaults to server-side default. diff --git a/types/Webhook/Webhook.d.ts b/types/Webhook/Webhook.d.ts index b324e86cb..cc886e299 100644 --- a/types/Webhook/Webhook.d.ts +++ b/types/Webhook/Webhook.d.ts @@ -17,7 +17,7 @@ import { IWebhookListParameters } from './WebhookListParameters'; * A 200 is preferred, but any 2XX status will indicate to our system that the Webhook request was successful. * Endpoints that return a large volume and rate of failures over a period of time will get automatically disabled by the system; a disabled Webhook can be re-enabled using the Webhook update endpoint. * - * @see https://www.easypost.com/docs/api/node#webhook-object + * @see https://docs.easypost.com/docs/webhooks#webhook-object */ export declare interface IWebhook extends IObjectWithId<'Webhook'> { /** @@ -48,7 +48,7 @@ export declare class Webhook implements IWebhook { /** * To create a Webhook, you simply need to provide a url parameter that you wish to receive notifications to. * - * @see https://www.easypost.com/docs/api/node#create-a-webhook + * @see https://docs.easypost.com/docs/webhooks#create-a-webhook * * @param {Object} params The parameters to create an {@link Webhook} with * @returns {Promise} The created and verified {@link Webhook} @@ -58,7 +58,7 @@ export declare class Webhook implements IWebhook { /** * Enables a Webhook that has been disabled. You can also secure your webhook by adding a webhook_secret. * - * @see https://www.easypost.com/docs/api/node#update-a-webhook + * @see https://docs.easypost.com/docs/webhooks#update-a-webhook * * @param webhookId Unique, starts with "hook_" * @param params The parameters to update an {@link Webhook} with @@ -69,7 +69,7 @@ export declare class Webhook implements IWebhook { /** * Retrieve an unpaginated list of all Webhooks available to the authenticated account. * - * @see https://www.easypost.com/docs/api/node#list-a-webhooks + * @see https://docs.easypost.com/docs/webhooks#retrieve-all-webhooks * * @param {Object} params - The parameters to use for the request. * @returns {Object} - An object containing a list of {@link Webhook webhooks} and pagination information. @@ -81,7 +81,7 @@ export declare class Webhook implements IWebhook { * * @param webhookId Unique, starts with "hook_" * - * @see https://www.easypost.com/docs/api/node#retrieve-a-webhook + * @see https://docs.easypost.com/docs/webhooks#retrieve-a-webhook * * @returns {Promise} The created and verified {@link Webhook} */ @@ -92,7 +92,7 @@ export declare class Webhook implements IWebhook { * * @param webhookId Unique, starts with "hook_" * - * @see https://www.easypost.com/docs/api/node#delete-a-webhook + * @see https://docs.easypost.com/docs/webhooks#delete-a-webhook */ static delete(webhookId: string): void; } diff --git a/types/Webhook/WebhookListParameters.d.ts b/types/Webhook/WebhookListParameters.d.ts index 3307e35ad..1fb245edd 100644 --- a/types/Webhook/WebhookListParameters.d.ts +++ b/types/Webhook/WebhookListParameters.d.ts @@ -1,6 +1,6 @@ import { IAllMethodParameters } from '../utils'; /** - * @see https://www.easypost.com/docs/api/node#list-a-webhooks + * @see https://docs.easypost.com/docs/webhooks#retrieve-all-webhooks */ export declare interface IWebhookListParameters extends IAllMethodParameters {} diff --git a/types/errors/Error.d.ts b/types/errors/Error.d.ts index b19e66278..ea944154d 100644 --- a/types/errors/Error.d.ts +++ b/types/errors/Error.d.ts @@ -7,7 +7,7 @@ import { IFieldError } from './FieldError'; * Each client library will encapsulate these errors and raise an exception, in addition to other exceptional cases, such as network failures. * It is recommended to handle exceptions gracefully and to report any issues to support@easypost.com. * - * @see https://www.easypost.com/docs/api/node#error-object + * @see https://docs.easypost.com/docs/errors */ export declare interface IError { /**