Skip to content

Commit d8ae1e4

Browse files
Merge pull request #38 from crhistianramirez/custom-roles
adds endpoints for managing security profiles and custom roles
2 parents 9609050 + d6ddedb commit d8ae1e4

18 files changed

Lines changed: 1359 additions & 248 deletions

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ of your imagination.
1010
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1111

1212
- API version: 1.0
13-
- Package version: 3.3.6
14-
- Build date: 2019-06-10T08:23:44.872-05:00
13+
- Package version: 3.4.6
14+
- Build date: 2019-07-01T18:52:25.266-05:00
1515

16-
For more information, please visit [https://documentation.ordercloud.io](https://documentation.ordercloud.io/platform-guides/getting-started/introduction-to-ordercloud)
16+
For more information, please visit [https://developer.ordercloud.io/documentation/](https://developer.ordercloud.io/documentation/getting-started/introduction-to-ordercloud)
1717

1818
## Installation
1919

@@ -26,7 +26,7 @@ npm install ordercloud-javascript-sdk --save
2626
## Authentication
2727

2828
We'll need to get a token before we can make any API calls. The platform offers four different
29-
[auth workflows](https://documentation.ordercloud.io/platform-guides/authentication/oauth2-workflows)
29+
[auth workflows](https://developer.ordercloud.io/documentation/platform-guides/authentication/oauth2-workflows)
3030
all found under the [Auth class](https://github.com/ordercloud-api/OrderCloud-JavaScript-SDK/blob/staging/src/api/Auth.js).
3131

3232
We'll use the password-grant type for this example.
@@ -37,8 +37,8 @@ var defaultClient = OrderCloud.Sdk.instance;
3737

3838
var username = 'YOUR_USERNAME'; //username of the user logging in
3939
var password = 'YOUR_PASSWORD'; //password of the user logging in
40-
var clientID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'; //clientID of the application the user is logging in to ([sign up for free](https://account.ordercloud.io/login/)
41-
var scope = ['FullAccess']; //string array of roles the application has access to ([more info](https://documentation.ordercloud.io/platform-guides/authentication/security-profiles))
40+
var clientID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'; //clientID of the application the user is logging in to ([sign up for free](https://developer.ordercloud.io/account)
41+
var scope = ['FullAccess']; //string array of roles the application has access to ([more info](https://developer.ordercloud.io/documentation/platform-guides/authentication/security-profiles))
4242

4343
return OrderCloud.Auth.Login(username, password, clientID, scope)
4444
.then(response => {
@@ -152,7 +152,7 @@ This package is fully compatible with typescript and comes bundles with its own
152152
153153
## Further Reading
154154
155-
You should now have enough information to get started building on our platform! The platform guides[https://documentation.ordercloud.io/platform-guides] and [API reference](https://documentation.ordercloud.io/api-reference)
155+
You should now have enough information to get started building on our platform! The platform guides[https://developer.ordercloud.io/documentation/platform-guides] and [API reference](https://developer.ordercloud.io/documentation/api-reference)
156156
should be your go-to guide for working with the API.
157157
158158
@@ -400,10 +400,14 @@ Class | Method | HTTP request | Description
400400
*OrderCloud.Promotions* | [**Patch**](docs/Promotions.md#Patch) | **PATCH** /promotions/{promotionID} |
401401
*OrderCloud.Promotions* | [**Save**](docs/Promotions.md#Save) | **PUT** /promotions/{promotionID} |
402402
*OrderCloud.Promotions* | [**SaveAssignment**](docs/Promotions.md#SaveAssignment) | **POST** /promotions/assignments |
403+
*OrderCloud.SecurityProfiles* | [**Create**](docs/SecurityProfiles.md#Create) | **POST** /securityprofiles |
404+
*OrderCloud.SecurityProfiles* | [**Delete**](docs/SecurityProfiles.md#Delete) | **DELETE** /securityprofiles/{securityProfileID} |
403405
*OrderCloud.SecurityProfiles* | [**DeleteAssignment**](docs/SecurityProfiles.md#DeleteAssignment) | **DELETE** /securityprofiles/{securityProfileID}/assignments |
404406
*OrderCloud.SecurityProfiles* | [**Get**](docs/SecurityProfiles.md#Get) | **GET** /securityprofiles/{securityProfileID} |
405407
*OrderCloud.SecurityProfiles* | [**List**](docs/SecurityProfiles.md#List) | **GET** /securityprofiles |
406408
*OrderCloud.SecurityProfiles* | [**ListAssignments**](docs/SecurityProfiles.md#ListAssignments) | **GET** /securityprofiles/assignments |
409+
*OrderCloud.SecurityProfiles* | [**Patch**](docs/SecurityProfiles.md#Patch) | **PATCH** /securityprofiles/{securityProfileID} |
410+
*OrderCloud.SecurityProfiles* | [**Save**](docs/SecurityProfiles.md#Save) | **PUT** /securityprofiles/{securityProfileID} |
407411
*OrderCloud.SecurityProfiles* | [**SaveAssignment**](docs/SecurityProfiles.md#SaveAssignment) | **POST** /securityprofiles/assignments |
408412
*OrderCloud.Shipments* | [**Create**](docs/Shipments.md#Create) | **POST** /shipments |
409413
*OrderCloud.Shipments* | [**Delete**](docs/Shipments.md#Delete) | **DELETE** /shipments/{shipmentID} |
@@ -498,6 +502,7 @@ Class | Method | HTTP request | Description
498502
## Documentation for Models
499503
500504
- [OrderCloud.AccessToken](docs/AccessToken.md)
505+
- [OrderCloud.AccessTokenBasic](docs/AccessTokenBasic.md)
501506
- [OrderCloud.Address](docs/Address.md)
502507
- [OrderCloud.AddressAssignment](docs/AddressAssignment.md)
503508
- [OrderCloud.ApiClient](docs/ApiClient.md)
@@ -623,6 +628,7 @@ Class | Method | HTTP request | Description
623628
- [OrderCloud.PartialProduct](docs/PartialProduct.md)
624629
- [OrderCloud.PartialProductFacet](docs/PartialProductFacet.md)
625630
- [OrderCloud.PartialPromotion](docs/PartialPromotion.md)
631+
- [OrderCloud.PartialSecurityProfile](docs/PartialSecurityProfile.md)
626632
- [OrderCloud.PartialShipment](docs/PartialShipment.md)
627633
- [OrderCloud.PartialSpec](docs/PartialSpec.md)
628634
- [OrderCloud.PartialSpecOption](docs/PartialSpecOption.md)
@@ -728,6 +734,8 @@ Class | Method | HTTP request | Description
728734
- ProductReader:
729735
- PromotionAdmin:
730736
- PromotionReader:
737+
- SecurityProfileAdmin:
738+
- SecurityProfileReader:
731739
- SetSecurityProfile:
732740
- ShipmentAdmin:
733741
- ShipmentReader:

0 commit comments

Comments
 (0)