@botmatic/now-client v0.0.1

now client

DEPRECATED: Read more here.

The official JavaScript client for interacting with the now instant API (please note that this API only allows you to send strings, it doesn't support streaming - but binary files can be encoded as base64 strings).

Usage

Firstly, install the package using npm:

npm install --save now-client

Next, load it:

const NowClient = require('now-client')

Then initialize it:

• <token> holds your token, which can obtained here (optional, will read from ~/.now/auth.json if not defined - you can also define it using the NOW_TOKEN environment variable)
• <team> specifies the ID of the team to which the actions should apply (optional)

const now = new NowClient(<token>, <team>)

And finally, you can use its methods to retrieve data:

await now.getDeployments()

API Reference

Kind: global class

• Now
  • new Now([token])
  • .getDeployments([callback]) ⇒ Promise
  • .getDeployment(id, [callback]) ⇒ Promise
  • .createDeployment(body, [callback]) ⇒ Promise
  • .deleteDeployment(id, [callback]) ⇒ Promise
  • .getFiles(id, [callback]) ⇒ Promise
  • .getFile(id, fileId, [callback]) ⇒ Promise
  • .getDomains([callback]) ⇒ Promise
  • .addDomain(domain, [callback]) ⇒ Promise
  • .deleteDomain(name, [callback]) ⇒ Promise
  • .getCertificates([cn], [callback]) ⇒ Promise
  • .createCertificate(cn, [callback]) ⇒ Promise
  • .renewCertificate(cn, [callback]) ⇒ Promise
  • .replaceCertificate(cn, cert, key, [ca], [callback]) ⇒ Promise
  • .deleteCertificate(cn, [callback]) ⇒ Promise
  • .getAliases([id OR callback], [callback]) ⇒ Promise
  • .createAlias(id, alias, [callback]) ⇒ Promise
  • .deleteAlias(id, [callback]) ⇒ Promise
  • .getSecrets([id OR callback], [callback]) ⇒ Promise
  • .createSecret(name, value, [callback]) ⇒ Promise
  • .renameSecret(id, name, [callback]) ⇒ Promise
  • .deleteSecret(id, [callback]) ⇒ Promise

new Now(token)

Initializes the API. Looks for token in ~/.now.json if none is provided.

now.getDeployments(callback) ⇒ Promise

Returns an array with all deployments.

Kind: instance method of Now
See: https://zeit.co/api#list-endpoint

now.getDeployment(id, callback) ⇒ Promise

Returns an object with deployment data.

Kind: instance method of Now
See: https://zeit.co/api#get-endpoint

now.createDeployment(body, callback) ⇒ Promise

Creates a new deployment and returns its data.

Kind: instance method of Now
See: https://zeit.co/api#instant-endpoint

now.deleteDeployment(id, callback) ⇒ Promise

Deletes a deployment and returns its data.

Kind: instance method of Now
See: https://zeit.co/api#rm-endpoint

now.getFiles(id, callback) ⇒ Promise

Returns an array with the file structure.

Kind: instance method of Now
See: https://zeit.co/api#file-structure-endpoint

now.getFile(id, fileId, callback) ⇒ Promise

Returns the content of a file either as string or object, depending on the filetype.

Kind: instance method of Now
See: https://zeit.co/api#file--endpoint

now.getDomains(callback)] ⇒ Promise

Returns an array with all domain names and related aliases.

Kind: instance method of Now See: https://zeit.co/api#get-domains

now.addDomain(domain, callback)] ⇒ Promise

Adds a new domain and returns its data.

Kind: instance method of Now See: https://zeit.co/api#post.domains

now.deleteDomain(name, callback)] ⇒ Promise

Deletes a domain name.

Kind: instance method of Now See: https://zeit.co/api#delete-domains

now.getDomainRecords(domain, callback)] ⇒ Promise

Returns an array with all DNS records configured for a domain name.

Kind: instance method of Now See: https://zeit.co/api#get-domain-records

now.addDomainRecord(domain, recordData, callback)] ⇒ Promise

Adds a new DNS record for a domain.

Kind: instance method of Now See: https://zeit.co/api#post-domain-records

now.deleteDomainRecord(name, recordId, callback)] ⇒ Promise

Deletes a DNS record associated with a domain.

Kind: instance method of Now See: https://zeit.co/api#delete-domain-records

now.getCertificates(cn, callback)] ⇒ Promise

Returns an array of all certificates.

Kind: instance method of Now See: https://zeit.co/api#get-certs

now.createCertificate(cn, callback)] ⇒ Promise

Creates a new certificate for a domain registered to the user.

Kind: instance method of Now See: https://zeit.co/api#post-certs

now.renewCertificate(cn, callback)] ⇒ Promise

Renews an existing certificate.

Kind: instance method of Now See: https://zeit.co/api#post-certs

now.replaceCertificate(cn, cert, key, ca, callback)] ⇒ Promise

Replace an existing certificate.

Kind: instance method of Now See: https://zeit.co/api#put-certs

now.deleteCertificate(cn, callback)] ⇒ Promise

Deletes a certificate.

Kind: instance method of Now See: https://zeit.co/api#delete-certs

now.getAliases(id OR callback, callback) ⇒ Promise

Returns an array with all aliases.

Kind: instance method of Now
See: https://zeit.co/api#user-aliases

now.createAlias(id, alias, callback) ⇒ Promise

Creates an alias for the given deployment.

Kind: instance method of Now
See: https://zeit.co/api#create-alias

now.deleteAlias(id, callback) ⇒ Promise

Deletes an alias and returns a status.

Kind: instance method of Now
See: https://zeit.co/api#delete-user-aliases

now.getSecrets(id OR callback, callback) ⇒ Promise

Returns an array with all secrets.

Kind: instance method of Now
See: https://zeit.co/api#get-now-secrets

now.createSecret(name, value, callback) ⇒ Promise

Creates a secret and returns its ID.

Kind: instance method of Now
See: https://zeit.co/api#post-now-secrets

now.renameSecret(id, name, callback) ⇒ Promise

Changes the name of the given secret and returns its ID and name.

Kind: instance method of Now
See: https://zeit.co/api#patch-now-secrets

now.deleteSecret(id, callback) ⇒ Promise

Deletes a secret and returns its ID.

Kind: instance method of Now
See: https://zeit.co/api#delete-now-secrets