Skip to content

Update SLAS Commands #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Update SLAS Commands #282

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
3fe366f
Remove `slas:tenant:list`
johnboxall Jan 27, 2022
dd73e32
Fix `slas:tenant:add`
johnboxall Jan 28, 2022
c357f15
WIP – client list and get
johnboxall Jan 28, 2022
40c9de7
Update SLAS integration
johnboxall Jan 28, 2022
1dc5cdc
Fix linting issues
johnboxall Jan 28, 2022
cbe226f
Really fix linting.
johnboxall Jan 28, 2022
4db82e7
Adds SLAS unittests
johnboxall Feb 3, 2022
712de9c
Merge branch 'master' into fix-slas
johnboxall Feb 3, 2022
8a662ae
Test all the things
johnboxall Feb 4, 2022
3ffff8f
Hopefully fix weird test.
johnboxall Feb 4, 2022
b963a28
Merge branch 'master' into fix-slas
tobiaslohr Feb 11, 2022
3d8bcb7
Merge branch 'master' into fix-slas
tobiaslohr Feb 15, 2022
611f21f
Add credential quality command
johnboxall Feb 25, 2022
4e31d33
Merge branch 'fix-slas' of https://github.com/johnboxall/sfcc-ci into…
johnboxall Feb 25, 2022
e7c6539
Rename SLAS commands add -> create
johnboxall Feb 25, 2022
7e5bd60
Consolidate client list command
johnboxall Feb 25, 2022
2a9473c
...
johnboxall Feb 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 38 additions & 76 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ You are now ready to use the tool by running the main command `sfcc-ci`.

Use `sfcc-ci --help` or just `sfcc-ci` to get started and see the full list of commands available:

```bash
```txt
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes highlighting issues:

Screen Shot 2022-01-28 at 2 41 20 PM

Usage: cli [options] [command]

Options:
Expand Down Expand Up @@ -334,16 +334,13 @@ Use `sfcc-ci --help` or just `sfcc-ci` to get started and see the full list of c
user:create [options] Create a new user
user:update [options] Update a user
user:delete [options] Delete a user
slas:tenant:list [options] Lists all tenants that belong to a given organization
slas:tenant:add [options] Adds a SLAS tenant to a given organization or updates an existing one
slas:tenant:get [options] Gets a SLAS tenant from a given organization
slas:tenant:delete [options] Deletes a SLAS tenant from a given organization
slas:client:add [options] Adds a SLAS client to a given tenant or updates an existing one
slas:client:get [options] Gets a SLAS client from a given tenant
slas:client:list [options] Lists all SLAS clients that belong to a given tenant
slas:client:delete [options] Deletes a SLAS client from a given tenant

Environment:
slas:tenant:add [options] Add or update SLAS a tenant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in #282 (comment), I'd suggest to rename to :create, instead of :add, to follow existing patterns.

Copy link
Contributor

@tobiaslohr tobiaslohr Feb 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in #282 (comment), I'd suggest to leave slas:tenant:list

slas:tenant:get [options] Get a SLAS tenant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in #282 (comment), I'd suggest to use slas:tenant:list --tenant <tenant> instead of sfcc-ci slas:tenant:get --tenant <tenant> to retrieve details of a single tenant.

slas:client:add [options] Add or update a SLAS client for a tenant
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in #282 (comment), I'd suggest to rename to :create, instead of :add, to follow existing patterns.

slas:client:get [options] Get a SLAS client for a tenant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in #282 (comment), I'd suggest to use slas:client:list --tenant <tenant> --clientid <clientid> instead of sfcc-ci slas:client:get --tenant <tenant> --clientid <clientid> to retrieve details of a single client.

slas:client:list [options] List SLAS clients for a tenant.
slas:client:delete [options] Delete a SLAS client for a tenant.
Environment:

$SFCC_LOGIN_URL set login url used for authentication
$SFCC_OAUTH_LOCAL_PORT set Oauth local port for authentication flow
Expand Down Expand Up @@ -401,6 +398,8 @@ The use of environment variables is optional. `sfcc-ci` respects the following e
* `SFCC_OAUTH_USER_PASSWORD` user password used for authentication
* `SFCC_SANDBOX_API_HOST` set sandbox API host
* `SFCC_SANDBOX_API_POLLING_TIMEOUT` set timeout for sandbox polling in minutes
* `SFCC_SCAPI_SHORTCODE` the Salesforce Commerce (Headless) API Shortcode
* `SFCC_SCAPI_TENANTID` the Salesforce Commerce (Headless) API TenantId
* `DEBUG` enable verbose output

If you only want a single CLI command to write debug messages prepend the command using, e.g. `DEBUG=* sfcc-ci <sub:command>`.
Expand Down Expand Up @@ -978,121 +977,84 @@ callback | (Function) | Callback function executed as a result. The err

APIs available in `require('sfcc').slas`:

`tenant.add(tenantId, shortcode, description, merchantName, contact, emailAddress, fileName)`
`tenant.add({shortcode, tenant, file})`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These many argument style interfaces are error prone and very hard to change in a backwards compatible way.

I've moved all the interfaces to accepting objects with named attributes.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand. Please see the dicusssion for the original intent and the suggestion in last line of combining best of both worlds


Adds the tenant details to the SLAS organization
Add or update SLAS a tenant.

Param | Type | Description
------------- | ------------| --------------------------------
tenantId | (String) | The tenant ID
shortcode | (String) | The short code of the org
description | (String) | Description of the tenant
merchantName | (String) | Name of the merchant
contact | (String) | Username of the user
emailAddress | (String) | Email address of the user
fileName | (String) | Path of the file containing all the params required for the tenant creation.
shortcode | (String) | Realm short code, `kv7kzm78`
tenant | (String) | Tenant ID, `zzrf_001`
file | (String) | Path to a JSON file with object details, `file.json`

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is the newly created tenant reponse.

***

`tenant.get(tenantId, shortcode)`
`tenant.get({shortcode, tenant})`

Gets the tenant matching the given `tenantId` for the given `shortCode`
Get a SLAS tenant.

Param | Type | Description
------------- | ------------| --------------------------------
tenantId | (String) | The tenant ID
shortcode | (String) | The short code of the org
shortcode | (String) | Realm short code, `kv7kzm78`
tenant | (String) | Tenant ID, `zzrf_001`

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is the tenant reponse.

***

`tenant.list(shortcode)`

Lists all the tenants for the given `shortCode`

Param | Type | Description
------------- | ------------| --------------------------------
shortcode | (String) | The short code of the org

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is list of tenants reponse.

***

`tenant.delete(tenantId, shortcode)`

Deletes the tenant matching the given `tenantId` for the given `shortCode`

Param | Type | Description
------------- | ------------| --------------------------------
tenantId | (String) | The tenant ID
shortcode | (String) | The short code of the org

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is the deletion reponse.

***

`client.add(tenantId, shortcode, file, clientid, clientname, privateclient, ecomtenant, ecomsite, secret, channels, scopes, redirecturis)`
`client.add({shortcode, tenant, client, body})`

Registers a new client within a given tenant
Add or update a SLAS client for a tenant

Param | Type | Description
------------- | ------------| --------------------------------
tenantId | (String) | The tenant ID
shortcode | (String) | The short code of the org
file | (String) | Path of the file containing all the params required for the client creation.
clientid | (String) | SLAS client id
clientname | (String) | The client name
privateclient | (Boolean) | Is the client a private client or not
ecomtenant | (String) | The ecom tenant
ecomsite | (String) | The ecom site
secret | (String) | The secret tied to the client ID
channels | (Array) | The list of channels for the client
scopes | (Array) | The list of scopes authorized for the client
redirecturis | (Array) | The list of redirect URIs authorized for the client
shortcode | (String) | Realm short code, `kv7kzm78`
tenant | (String) | Tenant ID, `zzrf_001`
client | (String) | Client ID, `aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa`
body | (Object) | Object with client's properties.

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is the newly created client reponse.

***

`client.get(tenantId, shortcode, clientId)`
`client.get({shortcode, tenant, client})`

Gets the tenant matching the given `clientid` for the given `tenantId` and `shortCode`
Get a SLAS client for a tenant.

Param | Type | Description
------------- | ------------| --------------------------------
tenantId | (String) | The tenant ID
shortcode | (String) | The short code of the org
clientid | (String) | SLAS client id
shortcode | (String) | Realm short code, `kv7kzm78`
tenant | (String) | Tenant ID, `zzrf_001`
client | (String) | Client ID, `aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa`

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is the client reponse.

***

`client.list(shortcode, tenantId)`
`client.list({shortcode, tenantId})`

Lists all the clients for the given `tenantId` and `shortCode`
List SLAS clients for a tenant.

Param | Type | Description
------------- | ------------| --------------------------------
shortcode | (String) | The short code of the org
tenantId | (String) | The tenant ID
shortcode | (String) | Realm short code, `kv7kzm78`
tenant | (String) | Tenant ID, `zzrf_001`

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is list of clients reponse.

***

`client.delete(tenantId, shortcode, clientId)`

Deletes the client matching the given `clientId` for the given `tenantId` and `shortCode`
Delete a SLAS client for a tenant.

Param | Type | Description
------------- | ------------| --------------------------------
tenantId | (String) | The tenant ID
shortcode | (String) | The short code of the org
clientid | (String) | SLAS client id
shortcode | (String) | Realm short code, `kv7kzm78`
tenant | (String) | Tenant ID, `zzrf_001`
client | (String) | Client ID, `aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa`

**Returns:** (Promise) The [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with its `resolve` or `reject` methods called respectively with the `result` or the `error`. The `result` variable here is the deletion reponse.

Expand Down
Loading