Skip to content

Commit 82d7ee7

Browse files
author
Crhistian Ramirez
committed
✏️ fix links to autogenerated docs
1 parent 73fc93c commit 82d7ee7

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The OrderCloud SDK for Javascript is a modern client library for building soluti
3232
- ESM module available for bundlers that support it. This enables tree shaking - use only what you import.
3333
- Built-in Typescript support, no additional types package necessary
3434
- Full feature parity with API
35-
- Auto-generated [API reference](https://ordercloud-api.github.io/ordercloud-javascript-sdk/)
35+
- Auto-generated [API reference](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK)
3636

3737
> Coming from an older version? Check out the [migration guide](./MIGRATION_GUIDE.md) so you can upgrade to the latest and greatest.
3838
@@ -84,7 +84,7 @@ const OrderCloudSDK = require('ordercloud-javascript-sdk');
8484

8585
## 🔐 Authentication
8686

87-
We'll need to get a token before we can make any API calls. The SDK offers five different ways of getting a token as part of the [Auth class](https://ordercloud-api.github.io/ordercloud-javascript-sdk/classes/auth).
87+
We'll need to get a token before we can make any API calls. The SDK offers five different ways of getting a token as part of the [Auth class](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/classes/auth).
8888

8989
We'll use the login method for this example.
9090

@@ -198,7 +198,7 @@ Me.ListProducts(null, { accessToken: token3 })
198198

199199
## Configuration
200200

201-
The [`Configuration`](https://ordercloud-api.github.io/ordercloud-javascript-sdk/classes/configuration) service can be used to set sdk level [options](https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/sdkconfiguration).
201+
The [`Configuration`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/classes/configuration) service can be used to set sdk level [options](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/interfaces/sdkconfiguration).
202202

203203
Simply set the options you need to override and the SDK will merge it with the default options object.
204204

@@ -222,15 +222,15 @@ console.log(configuration); // the current sdk configuration
222222

223223
## Handling Errors 🐛
224224

225-
The SDK uses a custom error ([`OrderCloudError`](https://ordercloud-api.github.io/ordercloud-javascript-sdk/classes/orderclouderror)) to provide rich and useful information in the case of an error.
225+
The SDK uses a custom error ([`OrderCloudError`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/classes/orderclouderror)) to provide rich and useful information in the case of an error.
226226

227227
```javascript
228228
Products.Get('my-product')
229229
.catch(error => {
230230
if(error.isOrderCloudError) {
231231
// the request was made and the API responded with a status code
232232
// that falls outside of the range of 2xx, the error will be of type OrderCloudError
233-
// https://ordercloud-api.github.io/ordercloud-javascript-sdk/classes/orderclouderror
233+
// https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/classes/orderclouderror
234234
console.log(error.message);
235235
console.log(JSON.stringify(error.errors, null, 4));
236236
} else if (error.request) {
@@ -337,7 +337,7 @@ While Typescript is not required to use this project (we compile it down to ES5
337337

338338
### Understanding OrderCloud's models
339339

340-
By default, properties of ordercloud models are required if their Create or Save operation requires them. For example the [`LineItem` model](https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/lineitem) has the properties `ProductID` and `Quantity` required. This is important to know if you need to define an object by type before using it.
340+
By default, properties of ordercloud models are required if their Create or Save operation requires them. For example the [`LineItem` model](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/interfaces/lineitem) has the properties `ProductID` and `Quantity` required. This is important to know if you need to define an object by type before using it.
341341

342342
```typescript
343343
import { LineItems, LineItem } from 'ordercloud-javascript-sdk';
@@ -419,14 +419,14 @@ Various helpers and utilities that may be useful. We also recommend using [Types
419419

420420
| Utility | Description |
421421
|-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
422-
| [`ListPage<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/listpage) | Takes in a type for the item in the list. For example `ListPage<Order>` will be the type for an order list page. |
423-
| [`ListPageWithFacets<T>`]( https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/listpagewithfacets ) | Similar to `ListPage` but for [premium search](https://ordercloud.io/blog/introducing-premium-search) models. For example `ListPageWithFacets<Product>` will be the type for a product list page. |
424-
| [`Searchable<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#searchable) | Takes in a [`SearchableEndpoint`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#searchableendpoint) and returns the type for a valid `searchOn` field on list calls. For example `Searchable<'Orders.List'>`. |
425-
| [`Sortable<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#sortable) | Takes in a [`SortableEndpoint`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#sortableendpoint) and returns the type for a valid `sortBy` field on list calls. For example `Sortable<'Orders.List'>`. |
426-
| [`Filters<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#filters) | Takes in an ordercloud model and returns the type for a valid `filter` field on list calls. For example `Filters<Product>`. This also works for any custom models that extend an OrderCloud model, for example `Filters<MyProduct>`. |
427-
| [`PartialDeep<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#partialdeep) | Similar to Typescript's [`Partial<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialt) except works on nested properties as well. |
428-
| [`RequiredDeep<T>`]( https://ordercloud-api.github.io/ordercloud-javascript-sdk#requireddeep ) | Similar to Typescript's [`Required<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredt) except works on nested properties as well. |
429-
| [`DecodedToken`](https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/decodedtoken) | A type representing a decoded OrderCloud token | |
422+
| [`ListPage<T>`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/interfaces/listpage) | Takes in a type for the item in the list. For example `ListPage<Order>` will be the type for an order list page. |
423+
| [`ListPageWithFacets<T>`]( https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/interfaces/listpagewithfacets ) | Similar to `ListPage` but for [premium search](https://ordercloud.io/blog/introducing-premium-search) models. For example `ListPageWithFacets<Product>` will be the type for a product list page. |
424+
| [`Searchable<T>`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK#searchable) | Takes in a [`SearchableEndpoint`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK#searchableendpoint) and returns the type for a valid `searchOn` field on list calls. For example `Searchable<'Orders.List'>`. |
425+
| [`Sortable<T>`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK#sortable) | Takes in a [`SortableEndpoint`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK#sortableendpoint) and returns the type for a valid `sortBy` field on list calls. For example `Sortable<'Orders.List'>`. |
426+
| [`Filters<T>`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK#filters) | Takes in an ordercloud model and returns the type for a valid `filter` field on list calls. For example `Filters<Product>`. This also works for any custom models that extend an OrderCloud model, for example `Filters<MyProduct>`. |
427+
| [`PartialDeep<T>`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK#partialdeep) | Similar to Typescript's [`Partial<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialt) except works on nested properties as well. |
428+
| [`RequiredDeep<T>`]( https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK#requireddeep ) | Similar to Typescript's [`Required<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredt) except works on nested properties as well. |
429+
| [`DecodedToken`](https://ordercloud-api.github.io/OrderCloud-JavaScript-SDK/interfaces/decodedtoken) | A type representing a decoded OrderCloud token | |
430430

431431
## 📄 License
432432

0 commit comments

Comments
 (0)