fix: all references to the docs

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`

README.md

@@ -197,7 +197,7 @@ client.clearResponseHooks();
 
 ## Documentation
 
-API documentation can be found at: <https://easypost.com/docs/api>.
+API documentation can be found at: <https://docs.easypost.com>.
 
 Library documentation can be found on the web at: <https://easypost.github.io/easypost-node/> 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
 

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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
  */

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.
      */

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.