Fez::API

This module contains all of the interaction you can perform with the fez|zef ecosystem. Enjoy

org-create

You, too, can create orgs

params:

1. api-key: required

2. name: required, the org name to create

3. email: required, the email to use for this account

returns: api-response

org-join

Allows you to accept an org invitation

params:

1. api-key: required

2. name: required, the name of the org you have a pending invite for

returns: api-response

org-leave

Allows you to leave an org. If you're the last admin of the org then you must first set your role to member. This is to avoid an accidentally orphaned org

1. api-key: required,

2. name: required, the name of the org you'd like to leave

returns: api-response

org-pending

Lists your pending org invites

1. api-key: required

returns: list-org-response

org-list

Lists the orgs you currently belong to

1. api-key: required

returns: list-org-response

org-members

Lists the members of an org. All members of an org are public

1. api-key: required

returns: members-org-response

org-invite

Invites a user to an org. You must be an admin of that org

1. api-key: required

2. username: required, org to invite user to

3. role: required, member|admin

4. user: user to invite

returns: api-response

org-mod

Changes a user's role. You must be an admin of the org to do this

1. api-key: required

2. name: required, org to alter user's role

3. role: required, member|admin

4. user: user to alter

returns: api-response

init-password-reset

Initializes a password reset

1. username: required, the username you'd like to initiate a password reset for

returns: api-response

password-reset

Resets the password

1. username: required, the username you'd like to initiate a password reset for

2. key: required, the key emailed to user (initiated by calling init-password-reset)

3. password: required, the user's new password

returns: auth-response

register

Creates an auth, if not exists. Orgs and users share an auth namespace. This does NOT log you in, you must call login after this to obtain an api key.

1. email: required, the user's email to send password reset, ecosystem notifications to, etc

2. username: required, the auth to create

3. password: required, the user's password

returns: api-response

login

Logs the user in and creates an api-key for use with other functions

1. username: required

2. password: required

returns: auth-response

update-meta

Updates the user's meta

1. api-key: required

2. display name: optional, if an empty string is given then no update will be made

3. website: optional, if an empty string is given then no update will be made

4. display email: optional, if an empty string is given then no update will be made

returns: api-response

update-org-meta

Updates the org's meta

1. api-key: required

2. org: required, the org name to change meta data for

3. display name: optional, if an empty string is given then no update will be made

4. website: optional, if an empty string is given then no update will be made

5. display email: optional, if an empty string is given then no update will be made

returns: api-response

upload

Uploads a dist to the fez|zef ecosystem

1. api-key: required

2. file: required, path to a file to upload

returns: api-response

remove

USE SPARINGLY. Removes a dist from the ecosystem. This will fail if the dist has been uploaded more than 24 hours before this command is dispatched. The intent of this method is to give some room for module authors to remit sensitive data.

1. api-key: required

2. dist: required, the full dist string you'd see in the fez list output

returns: api-response