google-admin-sdk - npm Package Compare versions

Comparing version 0.0.5 to 1.0.0

package.json

 {
   "name": "google-admin-sdk",
-  "version": "0.0.5",
+  "version": "1.0.0",
   "description": "node.js library that wraps the Directory and Groups APIs in the Google Admin SDK",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

@@ -1,2 +0,184 @@
-# node-google-admin-sdk
-node.js library for Google's Admin SDK
+# google-admin-sdk
+node.js library that wraps Google's Admin SDK. A subset of CRUD actions in the [Directory API](https://developers.google.com/admin-sdk/directory/v1/reference/) are supported.
+
+[![Build Status](https://drone.ops.clever.com/github.com/Clever/node-google-admin-sdk/status.svg?branch=master)](https://drone.ops.clever.com/github.com/Clever/node-google-admin-sdk)
+
+## Initializing the library
+The library includes 4 submodules:
+* [`OrgUnitProvisioning`](#OrgUnitProvisioning) for CRUD operations on [OrgUnits](https://support.google.com/a/answer/4352075?hl=en)
+* [`UserProvisioning`](#UserProvisioning) for CRUD operations on Google Apps users
+* [`GroupProvisioning`](#GroupProvisioning) for CRUD operations on Groups
+* [`Batch`](#Batch) for [batching requests](https://developers.google.com/+/domains/batch)
+
+To use the library, you must have your Google credentials in the form
+```
+opts = {
+  client: {
+    id: '12345.apps.googleusercontent.com',
+    secret: 'abcdefgh'
+  },
+  token: {
+    refresh: 'your_refresh_token'
+  }
+};
+
+```
+
+The library is designed such that you can initialize and use any submodule independently of the other three. Any or all submodules can be initialized using the credentials above:
+```
+admin_sdk = require('google-admin-sdk');
+user_provisioning = new admin_sdk.UserProvisioning(opts);
+```
+
+## Example usage
+```
+new_user = {
+  name: {
+    givenName: 'Grace',
+    familyName: 'Hopper',
+  },
+  password: 'password1234',
+  primaryEmail: '[e-mail]'
+  fields: "kind,nextPageToken,users(id,kind,name,orgUnitPath,primaryEmail)"
+};
+user_provisioning.insert(new_user, function(err, body) {
+  console.log("Received response: " + body);
+});
+```
+Note: it is recommended to use Google's [fields editor](https://developers.google.com/admin-sdk/directory/v1/reference/users/insert) to construct queries with `fields` arguments.
+
+```
+new_user = {
+  name: {
+    givenName: 'Grace',
+    familyName: 'Hopper',
+  },
+  password: 'password1234',
+  primaryEmail: '[e-mail]'
+};
+query = user_provisioning.insert(new_usery);
+query.exec(function(err, body){
+  // Handle error and body
+});
+```
+<a name="OrgUnitProvisioning" />
+## OrgUnitProvisioning
+The following provide functionality for querying the orgunits endpoint of the Directory API. For information on constructing queries and parsing responses, see the [official documentation](https://developers.google.com/admin-sdk/directory/v1/reference/orgunits).
+### OrgUnitProvisioning.findOrCreate(customer_id, org_unit[, cache, callback])
+Creates an OrgUnit and any of its parents that need to be created. Accepts arguments:
+* `customer_id`: your Google customer id.
+* `org_unit`: an array of the form that specifies the path of the OrgUnit to create. For example, to create the OrgUnit "/Users/Admins/SuperAdmins", pass in `['Users', 'Admins', 'SuperAdmins'].
+* `cache` (optional): a list of strings representing OrgUnits that are known to exist. For example, `['/', 'Users', 'Admins']
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+### OrgUnitProvisioning.insert(customer_id, properties[, fields, callback])
+Creates an OrgUnit. Accepts arguments:
+* `customer_id`: your Google customer id.
+* `properties`: an object that specifies the name of the OrgUnit to create. Uses the form `{ name: 'X', parent: 'Y' }`. Note that the parent must already exist; to deep create an OrgUnit, use `OrgUnitProvisioning.findOrCreate`.
+* `fields` (optional): fields to return in the response.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+### OrgUnitProvisioning.list(customer_id, params, [, callback])
+Lists OrgUnits owned by a customer. Accepts arguments:
+* `customer_id`: your Google customer id.
+* `params` (optional): object containing querystring arguments.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+### OrgUnitProvisioning.get(customer_id, org_unit_path, [, callback])
+Gets a single OrgUnit owned by a customer. Accepts arguments:
+* `customer_id`: your Google customer id.
+* `org_unit_path`: String representation of the OrgUnit to find.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+### OrgUnitProvisioning.patch(customer_id, org_unit_path[, body, fields, callback])
+Updates an OrgUnit using [patch semantics](https://developers.google.com/admin-sdk/directory/v1/guides/performance#patch). Accepts arguments:
+* `customer_id`: your Google customer id.
+* `org_unit_path`: the full OrgUnit path to update.
+* `body` (optional): object containing the fields to update on the OrgUnit and their new values.
+* `fields` (optional): fields to return in the response.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+### OrgUnitProvisioning.delete(customer_id, org_unit_path, [, callback])
+Deletes an OrgUnit. Accepts arguments:
+* `customer_id`: your Google customer id.
+* `org_unit_path`: String representation of the OrgUnit to delete.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+
+<a name="UserProvisioning" />
+## User Provisioning
+The following provide functionality for querying the Users endpoint of the Directory API. For information on constructing queries and parsing responses, see the [official documentation](https://developers.google.com/admin-sdk/directory/v1/reference/users).
+### UserProvisioning.insert(body[, fields, callback])
+Creates a Google Apps user. Accepts arguments:
+* `body`: specifies the `name`, `password`, and `primaryEmail` of the user.
+* `fields` (optional): specifies which user fields are included in the response.
+* `callback` (optional): a function of the form `callback(error, body)` to be called when the response is received.
+
+### UserProvisioning.get(userkey[, callback])
+Gets information for a single user. Accepts arguments:
+* `userkey`: the unique userkey of the user to find.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+### UserProvisioning.list(params[, callback])
+Lists Google Apps users. Accepts arguments:
+* `params`: user fields to query by
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+#### Example
+```
+// Get at most 200 users in the domain `example.com`
+params = {
+  domain: 'example.com',
+  max_results: 200
+};
+
+user_provisioning.list(params, function(err, body) {
+  // Handle error and do something with users
+});
+```
+
+### UserProvisioning.patch(userkey, body[, fields, callback])
+Updates a user using [patch semantics](https://developers.google.com/admin-sdk/directory/v1/guides/performance#patch). Accepts arguments:
+* `userkey`: the unique userkey of the user to update.
+* `body`: object containing fields to update on the user and their new values.
+* `fields` (optional): fields to return in the response.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+### UserProvisioning.update(userkey, body[, fields, callback])
+Same as `patch`, but updates a user without using [patch semantics](https://developers.google.com/admin-sdk/directory/v1/guides/performance#patch).
+
+### UserProvisioning.delete(userkey[, callback])
+Deletes a user. Accepts arguments:
+* `userkey`: the unique userkey of the user to delete.
+* `callback` (optional): function of the form `callback(error, body)` to call when the response is received.
+
+<a name="GroupProvisioning" />
+## Group Provisioning
+GroupProvisioning supports all functions supported by UserProvisioning except `update`. The function signatures and behaviors are identical, except they accept a unique groupkey instead of a unique userkey.
+
+<a name="Batch" />
+## Batch
+### Batch.go(queries, callback)
+Executes queries in batches. Accepts arguments:
+* `queries`: an array of GoogleQueries (returned by invoking CRUD functions in other submodules without a callback) to execute.
+* `callback`: function of the form `callback(error, body)` to call when the response is received.
+
+#### Example
+```
+  queries = [];
+  user1_properties = {
+    name: { familyName: 'Parr', givenName: 'Bob' },
+    password: 'password12345',
+    primaryEmail: '[e-mail]'
+  };
+  user2_properties = {
+    name: { familyName: 'Huph', givenName: 'Gilbert' },
+    password: 'password12345',
+    primaryEmail: '[e-mail]'
+  };
+  queries.push(UserProvisioning.insert(user1_properties));
+  queries.push(UserProvisioning.insert(user2_properties));
+  Batch.go(queries, function(error, results){
+    // Handle error and parse results
+  });
+```

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

82442

increased by11.82%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

185

increased by6066.67%

No dependency changes