dnsimple - npm Package Compare versions

Comparing version 2.5.0 to 2.6.0

lib/dnsimple/collaborators.js

@@ -9,2 +9,3 @@ 'use strict';
  * @see https://developer.dnsimple.com/v2/domains/collaborators
+ * @deprecated Use domains.collaborators
  */
@@ -11,0 +12,0 @@ class Collaborators {

lib/dnsimple/domains.js

@@ -162,2 +162,70 @@ 'use strict';
   /**
+   * Lists the collaborators in the account attached to the given domain.
+   *
+   * @see https://developer.dnsimple.com/v2/domains/collaborators/#list
+   *
+   * @example List collaborators in the first page
+   * client.collaborators.listCollaborators(1010, 'example.com').then(function(response) {
+   *   // handle response
+   * }, function(error) {
+   *   // handle error
+   * });
+   *
+   * @example List collaborators, provide a specific page
+   * client.collaborators.listCollaborators(1010, 'example.com', {page: 2}).then(function(response) {
+   *   // handle response
+   * }, function(error) {
+   *   // handle error
+   * });
+   *
+   * @example List collaborators, provide a sorting policy
+   * client.collaborators.listCollaborators(1010, 'example.com', {sort: 'email:asc'}).then(function(response) {
+   *   // handle response
+   * }, function(error) {
+   *   // handle error
+   * });
+   *
+   * @param {number} accountId The account ID
+   * @param {number|string} domainId The domain identifier (name or numeric ID)
+   * @param {Object} [options] The filtering and sorting options
+   * @param {number} [options.page] The current page number
+   * @param {number} [options.per_page] The number of items per page
+   * @param {string} [options.sort] The sort definition in the form `key:direction`
+   * @return {Promise}
+   */
+  listCollaborators(accountId, domainId, options = {}) {
+    return this._client.get(`/${accountId}/domains/${domainId}/collaborators`, options);
+  }
+
+  /**
+   * Add a collaborator to the given domain.
+   *
+   * @see https://developer.dnsimple.com/v2/domains/collaborators/#add
+   *
+   * @param {number} accountId The account ID
+   * @param {string|number} domainId The domain name or ID.
+   * @param {Object} [collaborator]
+   * @param {Object} [options]
+   * @return {Promise}
+   */
+  addCollaborator(accountId, domainId, collaborator, options = {}) {
+    return this._client.post(`/${accountId}/domains/${domainId}/collaborators`, collaborator, options);
+  }
+
+  /**
+   * Remove a collaborator from the given domain.
+   *
+   * @see https://developer.dnsimple.com/v2/domains/collaborators/#delete
+   *
+   * @param {number} accountId The account ID
+   * @param {string|number} domainId The domain name or ID.
+   * @param {number} collaboratorId The collaborator ID
+   * @param {Object} [options]
+   * @return {Promise}
+   */
+  removeCollaborator(accountId, domainId, collaboratorId, options = {}) {
+    return this._client.delete(`/${accountId}/domains/${domainId}/collaborators/${collaboratorId}`, options);
+  }
+
+  /**
    * Enable DNSSEC for the domain.
@@ -164,0 +232,0 @@ *

package.json

 {
   "name": "dnsimple",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "DNSimple v2 API wrapper",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -96,2 +96,2 @@ # DNSimple Node.JS Client
 
-The value you provide will be appended to the default `User-Agent` the client uses. For example, if you use `my-app`, the final header value will be `dnsimple-node/2.5.0 my-app` (note that it will vary depending on the client version).
+The value you provide will be appended to the default `User-Agent` the client uses. For example, if you use `my-app`, the final header value will be `dnsimple-node/x.x.x my-app` (note that it will vary depending on the client version).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

94418

increased by2.82%

Lines of code

2527

increased by2.68%

No dependency changes