Skip to content

Commit a08997a

Browse files
Justintime50Justintime50
authored
Merge pull request #499 from EasyPost/update_docs_links
fix: all references to the docs
2 parents 42d02e1 + a1fb125 commit a08997a

File tree

109 files changed

+282
-282
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+282
-282
lines changed

Diff for: ‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- `betaReferralCustomer.createBankAccountClientSecret`
1010
- `referralCustomer.addCreditCardFromStripe`
1111
- `referralCustomer.addBankAccountFromStripe`
12+
- Fixes all references to the docs
1213
- Properly returns the response body of the following functions: `addPaymentMethod`, `refundByAmount`, `refundByPaymentLog`
1314
- `findMatchingMockRequest` mocking function made private
1415
- Removes undocumented and unmaintained `repl`

Diff for: ‎README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ client.clearResponseHooks();
197197

198198
## Documentation
199199

200-
API documentation can be found at: <https://easypost.com/docs/api>.
200+
API documentation can be found at: <https://docs.easypost.com>.
201201

202202
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.
203203

@@ -249,9 +249,9 @@ Starting with `v5.3.0`, this project has Typescript definitions included.
249249
#### Typescript Exclusions
250250

251251
- We do not provide a DefinitelyTyped version of these definitions at this time
252-
- Predefined packages (see [Carrier Metadata](https://www.easypost.com/docs/api#carrier-metadata) in our docs for more details)
253-
- Carrier service levels (see [Carrier Metadata](https://www.easypost.com/docs/api#carrier-metadata) in our docs for more details)
254-
- Carrier list (see [Carrier Types](https://www.easypost.com/docs/api#carrier-types) in our docs for more details)
252+
- Predefined packages (see [Carrier Metadata](https://docs.easypost.com/docs/carrier-metadata) in our docs for more details)
253+
- Carrier service levels (see [Carrier Metadata](https://docs.easypost.com/docs/carrier-metadata) in our docs for more details)
254+
- Carrier list (see [Carrier Types](https://docs.easypost.com/docs/carrier-types) in our docs for more details)
255255

256256
### Testing
257257

Diff for: ‎src/models/address.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* An {@link https://www.easypost.com/docs/api/node#addresses Address} represents people, places, and organizations in a number of contexts.
4+
* An {@link https://docs.easypost.com/docs/addresses Address} represents people, places, and organizations in a number of contexts.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/api_key.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* 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.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/batch.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#batches Batch} represents a collection of {@link Shipment shipments} that can be processed together.
4+
* A {@link https://docs.easypost.com/docs/batches Batch} represents a collection of {@link Shipment shipments} that can be processed together.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/brand.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#brand Brand} represents custom branding for an EasyPost user's public-facing tracking details page.
4+
* A {@link https://docs.easypost.com/docs/users/brand Brand} represents custom branding for an EasyPost user's public-facing tracking details page.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/carrier_account.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#carrier-accounts CarrierAccount} represents details about a specific enabled carrier, including credentials and other information.
4+
* A {@link https://docs.easypost.com/docs/carrier-accounts CarrierAccount} represents details about a specific enabled carrier, including credentials and other information.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/carrier_type.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#carrier-types CarrierType} represents the valid fields for a {@link CarrierAccount carrier account}.
4+
* A {@link https://docs.easypost.com/docs/carrier-types CarrierType} represents the valid fields for a {@link CarrierAccount carrier account}.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/customs_info.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* 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.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/customs_item.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#customs-item CustomsItem} represents a single item being shipped internationally.
4+
* A {@link https://docs.easypost.com/docs/customs-items CustomsItem} represents a single item being shipped internationally.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/end_shipper.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* 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.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/event.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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}.
4+
* 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}.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/form.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* 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.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/insurance.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* An {@link https://www.easypost.com/docs/api/node#api-keys Insurance} object represents insurance for a {@link Shipment shipment}.
4+
* An {@link https://docs.easypost.com/docs/api-keys Insurance} object represents insurance for a {@link Shipment shipment}.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/order.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import Constants from '../constants';
22
import EasyPostObject from './easypost_object';
33

44
/**
5-
* An {@link https://www.easypost.com/docs/api/node#orders Order} represents a collection of packages, intended only for multi-parcel shipments.
5+
* An {@link https://docs.easypost.com/docs/orders Order} represents a collection of packages, intended only for multi-parcel shipments.
66
* @public
77
* @extends EasyPostObject
88
*/

Diff for: ‎src/models/parcel.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* 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.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/payload.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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}.
4+
* 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}.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/pickup.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import Constants from '../constants';
22
import EasyPostObject from './easypost_object';
33

44
/**
5-
* 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}.
5+
* 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}.
66
* @public
77
* @extends EasyPostObject
88
*/

Diff for: ‎src/models/rate.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* 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.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/refund.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#refunds Refund} represents a refunded {@link Shipment}.
4+
* A {@link https://docs.easypost.com/docs/refunds Refund} represents a refunded {@link Shipment}.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/report.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* A {@link https://docs.easypost.com/docs/reports Report} represents a CSV file containing a log of all objects within a specific time frame.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/scan_form.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* 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.
4+
* 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.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/shipment.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import Constants from '../constants';
22
import EasyPostObject from './easypost_object';
33

44
/**
5-
* 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}.
5+
* 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}.
66
* @public
77
* @extends EasyPostObject
88
*/

Diff for: ‎src/models/tracker.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#trackers Tracker} represents the available tracking information for a package.
4+
* A {@link https://docs.easypost.com/docs/trackers Tracker} represents the available tracking information for a package.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/user.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#user ApiKey} represents an EasyPost account or child account.
4+
* A {@link https://docs.easypost.com/docs/users ApiKey} represents an EasyPost account or child account.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/models/webhook.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import EasyPostObject from './easypost_object';
22

33
/**
4-
* A {@link https://www.easypost.com/docs/api/node#webhooks Webhook} represents a URL that will receive notifications when certain {@link Event} occur.
4+
* A {@link https://docs.easypost.com/docs/webhooks Webhook} represents a URL that will receive notifications when certain {@link Event} occur.
55
* @public
66
* @extends EasyPostObject
77
*/

Diff for: ‎src/services/address_service.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export default (easypostClient) =>
88
class AddressService extends baseService(easypostClient) {
99
/**
1010
* Create an {@link Address address}.
11-
* See {@link https://www.easypost.com/docs/api/node#create-an-address EasyPost API Documentation} for more information.
11+
* See {@link https://docs.easypost.com/docs/addresses#create-an-address EasyPost API Documentation} for more information.
1212
* @param {Object} params - Parameters for the address to be created.
1313
* @returns {Address} - The created address.
1414
*/
@@ -36,7 +36,7 @@ export default (easypostClient) =>
3636

3737
/**
3838
* Create and verify an {@link Address address} in a single request.
39-
* See {@link https://www.easypost.com/docs/api/node#create-and-verify-addresses EasyPost API Documentation} for more information.
39+
* See {@link https://docs.easypost.com/docs/addresses#verify-an-address EasyPost API Documentation} for more information.
4040
* @param {Object} params - Parameters for the address to be created.
4141
* @returns {Address} - The created and verified address.
4242
*/
@@ -55,7 +55,7 @@ export default (easypostClient) =>
5555

5656
/**
5757
* Retrieve all {@link Address addresses} associated with the current authenticated user.
58-
* See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-addresses EasyPost API Documentation} for more information.
58+
* See {@link https://docs.easypost.com/docs/addresses#retrieve-all-addresses EasyPost API Documentation} for more information.
5959
* @param {Object} [params] - Parameters to filter the list of addresses.
6060
* @returns {Object} - An object containing a list of {@link Address addresses} and pagination information.
6161
*/
@@ -78,7 +78,7 @@ export default (easypostClient) =>
7878

7979
/**
8080
* Retrieve an {@link Address address} by its ID.
81-
* See {@link https://www.easypost.com/docs/api/node#retrieve-an-address EasyPost API Documentation} for more information.
81+
* See {@link https://docs.easypost.com/docs/addresses#retrieve-an-address EasyPost API Documentation} for more information.
8282
* @param {string} id - The ID of the address to retrieve.
8383
* @returns {Address} - The retrieved address.
8484
*/
@@ -90,7 +90,7 @@ export default (easypostClient) =>
9090

9191
/**
9292
* Verify an {@link Address address} by its ID.
93-
* See {@link https://www.easypost.com/docs/api/node#create-and-verify-addresses EasyPost API Documentation} for more information.
93+
* See {@link https://docs.easypost.com/docs/addresses#verify-an-address EasyPost API Documentation} for more information.
9494
* @param {string} id - The ID of the address to verify.
9595
* @returns {Address} - The verified address.
9696
*/

Diff for: ‎src/services/api_key_service.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export default (easypostClient) =>
1212
class ApiKeyService extends baseService(easypostClient) {
1313
/**
1414
* Retrieve all {@link ApiKey API keys} associated with the current authenticated user.
15-
* See {@link https://www.easypost.com/docs/api/node#retrieve-an-api-key EasyPost API Documentation} for more information.
15+
* See {@link https://docs.easypost.com/docs/api-keys#retrieve-an-api-key EasyPost API Documentation} for more information.
1616
* @returns {Object} - An object containing the API keys associated with the current authenticated user and its child users.
1717
*/
1818
static async all(params = {}) {
@@ -23,7 +23,7 @@ export default (easypostClient) =>
2323

2424
/**
2525
* Retrieve API Keys for a specified {@link User user}.
26-
* See {@link https://www.easypost.com/docs/api/node#retrieve-an-api-key EasyPost API Documentation} for more information.
26+
* See {@link https://docs.easypost.com/docs/api-keys#retrieve-an-api-key EasyPost API Documentation} for more information.
2727
* @param {string} id - The ID of the user to retrieve keys for.
2828
* @returns {Array} - List of associated API Keys.
2929
* @throws {FilteringError} If user or API Keys are not found.

0 commit comments

Comments
 (0)