Docs: Generate API docs in ./docs.

README.md

@@ -3,6 +3,8 @@ HTTP client for making requests to the Blue Canvas REST API. Use it in your app
 to call any of the API methods, and let it handle formatting, queuing, retrying,
 pagination, and more.
 
+* [Generated API Documentation](./docs)
+
 # Installation
 
 ```shell

docs/README.md

@@ -0,0 +1,15 @@
+
+# @bluecanvas/sdk
+
+## Index
+
+### Modules
+
+* ["client"](modules/_client_.md)
+* ["hapi/EventHandlerPlugin"](modules/_hapi_eventhandlerplugin_.md)
+* ["index"](modules/_index_.md)
+* ["types/index"](modules/_types_index_.md)
+* ["types/notifications"](modules/_types_notifications_.md)
+* ["types/requests"](modules/_types_requests_.md)
+* ["types/schema"](modules/_types_schema_.md)
+* ["utils"](modules/_utils_.md)

docs/classes/_client_.archivesclient.md

@@ -0,0 +1,34 @@
+
+# Class: ArchivesClient
+
+## Hierarchy
+
+* **ArchivesClient**
+
+## Index
+
+### Methods
+
+* [getTarGzipBlob](_client_.archivesclient.md#gettargzipblob)
+
+## Methods
+
+###  getTarGzipBlob
+
+▸ **getTarGzipBlob**(`__namedParameters`: object): *Promise‹[ArchivesGetTarGzipBlobResponse](../interfaces/_types_requests_.archivesgettargzipblobresponse.md)›*
+
+*Defined in [client.ts:182](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/client.ts#L182)*
+
+Fetches a repository snapshot for the specified git revision as a gzipped tarball.
+
+**`see`** https://docs.bluecanvas.io/reference/checks-api#get-archive
+
+**Parameters:**
+
+▪ **__namedParameters**: *object*
+
+Name | Type |
+------ | ------ |
+`revision` | string |
+
+**Returns:** *Promise‹[ArchivesGetTarGzipBlobResponse](../interfaces/_types_requests_.archivesgettargzipblobresponse.md)›*

docs/classes/_client_.client.md

@@ -0,0 +1,49 @@
+
+# Class: Client
+
+## Hierarchy
+
+* **Client**
+
+## Index
+
+### Constructors
+
+* [constructor](_client_.client.md#constructor)
+
+### Properties
+
+* [archives](_client_.client.md#readonly-archives)
+* [deployments](_client_.client.md#readonly-deployments)
+
+## Constructors
+
+###  constructor
+
+\+ **new Client**(`options`: [Options](../interfaces/_client_.options.md)): *[Client](_client_.client.md)*
+
+*Defined in [client.ts:72](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/client.ts#L72)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`options` | [Options](../interfaces/_client_.options.md) |
+
+**Returns:** *[Client](_client_.client.md)*
+
+## Properties
+
+### `Readonly` archives
+
+• **archives**: *[ArchivesClient](_client_.archivesclient.md)*
+
+*Defined in [client.ts:65](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/client.ts#L65)*
+
+___
+
+### `Readonly` deployments
+
+• **deployments**: *[DeploymentsClient](_client_.deploymentsclient.md)*
+
+*Defined in [client.ts:66](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/client.ts#L66)*

docs/classes/_client_.deploymentsclient.md

@@ -0,0 +1,41 @@
+
+# Class: DeploymentsClient
+
+## Hierarchy
+
+* **DeploymentsClient**
+
+## Index
+
+### Methods
+
+* [putCheck](_client_.deploymentsclient.md#putcheck)
+
+## Methods
+
+###  putCheck
+
+▸ **putCheck**(`__namedParameters`: object): *Promise‹[DeploymentsPutCheckResponse](../interfaces/_types_requests_.deploymentsputcheckresponse.md)›*
+
+*Defined in [client.ts:162](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/client.ts#L162)*
+
+Creates or updates the status of a check for a given deployment by its
+canonical check name. The first time you invoke this action, a new
+record for the check is created and will appear in the interface.
+Successive calls to this action update the state of that record. This
+allows you to update the status of a check as it progresses in your
+external system.
+
+**`see`** https://docs.bluecanvas.io/reference/checks-api#put-checks
+
+**Parameters:**
+
+▪ **__namedParameters**: *object*
+
+Name | Type |
+------ | ------ |
+`check` | [DeploymentCheck](../interfaces/_types_schema_.deploymentcheck.md) |
+`deploymentNumber` | number |
+`name` | string |
+
+**Returns:** *Promise‹[DeploymentsPutCheckResponse](../interfaces/_types_requests_.deploymentsputcheckresponse.md)›*

docs/classes/_hapi_eventhandlerplugin_.eventhandlerplugin.md

@@ -0,0 +1,47 @@
+
+# Class: EventHandlerPlugin
+
+## Hierarchy
+
+* **EventHandlerPlugin**
+
+## Index
+
+### Methods
+
+* [handle](_hapi_eventhandlerplugin_.eventhandlerplugin.md#handle)
+* [register](_hapi_eventhandlerplugin_.eventhandlerplugin.md#static-register)
+
+## Methods
+
+###  handle
+
+▸ **handle**(`request`: Request, `h`: ResponseToolkit): *Promise‹Lifecycle.ReturnValue›*
+
+*Defined in [hapi/EventHandlerPlugin.ts:139](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/hapi/EventHandlerPlugin.ts#L139)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`request` | Request |
+`h` | ResponseToolkit |
+
+**Returns:** *Promise‹Lifecycle.ReturnValue›*
+
+___
+
+### `Static` register
+
+▸ **register**(`server`: Server, `options`: [Options](../interfaces/_client_.options.md)): *Promise‹void›*
+
+*Defined in [hapi/EventHandlerPlugin.ts:114](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/hapi/EventHandlerPlugin.ts#L114)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`server` | Server |
+`options` | [Options](../interfaces/_client_.options.md) |
+
+**Returns:** *Promise‹void›*

docs/enums/_types_schema_.checkresult.md

@@ -0,0 +1,61 @@
+
+# Enumeration: CheckResult
+
+## Index
+
+### Enumeration members
+
+* [CANCELLED](_types_schema_.checkresult.md#cancelled)
+* [FAILURE](_types_schema_.checkresult.md#failure)
+* [NEUTRAL](_types_schema_.checkresult.md#neutral)
+* [SKIPPED](_types_schema_.checkresult.md#skipped)
+* [SUCCESS](_types_schema_.checkresult.md#success)
+* [TIMED_OUT](_types_schema_.checkresult.md#timed_out)
+
+## Enumeration members
+
+###  CANCELLED
+
+• **CANCELLED**: = "CANCELLED"
+
+*Defined in [types/schema.ts:65](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L65)*
+
+___
+
+###  FAILURE
+
+• **FAILURE**: = "FAILURE"
+
+*Defined in [types/schema.ts:63](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L63)*
+
+___
+
+###  NEUTRAL
+
+• **NEUTRAL**: = "NEUTRAL"
+
+*Defined in [types/schema.ts:64](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L64)*
+
+___
+
+###  SKIPPED
+
+• **SKIPPED**: = "SKIPPED"
+
+*Defined in [types/schema.ts:66](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L66)*
+
+___
+
+###  SUCCESS
+
+• **SUCCESS**: = "SUCCESS"
+
+*Defined in [types/schema.ts:62](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L62)*
+
+___
+
+###  TIMED_OUT
+
+• **TIMED_OUT**: = "TIMED_OUT"
+
+*Defined in [types/schema.ts:67](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L67)*

docs/enums/_types_schema_.checkstate.md

@@ -0,0 +1,34 @@
+
+# Enumeration: CheckState
+
+## Index
+
+### Enumeration members
+
+* [DONE](_types_schema_.checkstate.md#done)
+* [IN_PROGRESS](_types_schema_.checkstate.md#in_progress)
+* [QUEUED](_types_schema_.checkstate.md#queued)
+
+## Enumeration members
+
+###  DONE
+
+• **DONE**: = "DONE"
+
+*Defined in [types/schema.ts:58](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L58)*
+
+___
+
+###  IN_PROGRESS
+
+• **IN_PROGRESS**: = "IN_PROGRESS"
+
+*Defined in [types/schema.ts:57](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L57)*
+
+___
+
+###  QUEUED
+
+• **QUEUED**: = "QUEUED"
+
+*Defined in [types/schema.ts:56](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L56)*

docs/enums/_types_schema_.deploymentphase.md

@@ -0,0 +1,100 @@
+
+# Enumeration: DeploymentPhase
+
+Phases describe the progressive steps of a deploy request. An earlier
+phase must succeed for the run to progress to the next phase.
+
+## Index
+
+### Enumeration members
+
+* [ADVICE](_types_schema_.deploymentphase.md#advice)
+* [APPLY](_types_schema_.deploymentphase.md#apply)
+* [CHECKLIST](_types_schema_.deploymentphase.md#checklist)
+* [CONFLICT](_types_schema_.deploymentphase.md#conflict)
+* [DONE](_types_schema_.deploymentphase.md#done)
+* [DRAFT](_types_schema_.deploymentphase.md#draft)
+* [NEW](_types_schema_.deploymentphase.md#new)
+* [PLAN](_types_schema_.deploymentphase.md#plan)
+* [RECONCILE](_types_schema_.deploymentphase.md#reconcile)
+* [VALIDATE](_types_schema_.deploymentphase.md#validate)
+
+## Enumeration members
+
+###  ADVICE
+
+• **ADVICE**: = "ADVICE"
+
+*Defined in [types/schema.ts:30](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L30)*
+
+___
+
+###  APPLY
+
+• **APPLY**: = "APPLY"
+
+*Defined in [types/schema.ts:33](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L33)*
+
+___
+
+###  CHECKLIST
+
+• **CHECKLIST**: = "CHECKLIST"
+
+*Defined in [types/schema.ts:35](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L35)*
+
+___
+
+###  CONFLICT
+
+• **CONFLICT**: = "CONFLICT"
+
+*Defined in [types/schema.ts:31](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L31)*
+
+___
+
+###  DONE
+
+• **DONE**: = "DONE"
+
+*Defined in [types/schema.ts:36](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L36)*
+
+___
+
+###  DRAFT
+
+• **DRAFT**: = "DRAFT"
+
+*Defined in [types/schema.ts:27](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L27)*
+
+___
+
+###  NEW
+
+• **NEW**: = "NEW"
+
+*Defined in [types/schema.ts:28](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L28)*
+
+___
+
+###  PLAN
+
+• **PLAN**: = "PLAN"
+
+*Defined in [types/schema.ts:29](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L29)*
+
+___
+
+###  RECONCILE
+
+• **RECONCILE**: = "RECONCILE"
+
+*Defined in [types/schema.ts:34](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L34)*
+
+___
+
+###  VALIDATE
+
+• **VALIDATE**: = "VALIDATE"
+
+*Defined in [types/schema.ts:32](https://github.com/bluecanvas/node-bluecanvas-sdk/blob/6e3a4c7/src/types/schema.ts#L32)*