Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.


## [v3.1.0] - Admin API v2.1-1.4.3 - 2026-03-09
### Changed
- Added support for version v2.1-1.4.3 of the DocuSign Admin API.
- Updated the SDK release version.

## [v3.0.0] - Admin API v2.1-1.4.1 - 2024-10-28
### Changed
- Added support for version v2.1-1.4.1 of the DocuSign Admin API.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docusign-admin",
"version": "3.0.0",
"version": "3.1.0",
"description": "The Docusign Admin API enables you to automate user management with your existing systems while ensuring governance and compliance.",
"license": "MIT",
"main": "src/index.js",
Expand Down
2 changes: 1 addition & 1 deletion src/api/BulkExportsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
*/

/**
* Creates a new Account Setting Export request.
* Creates a new Account Setting Export request.
* Required scopes: account_read
* @param {String} organizationId The organization ID Guid
* @param {module:model/OrganizationAccountsRequest} request Request body containing details about the accounts be compared
Expand Down
750 changes: 750 additions & 0 deletions src/api/OrgConnectApi.js

Large diffs are not rendered by default.

28 changes: 23 additions & 5 deletions src/api/UsersApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,7 @@
* @param {String} userId The user ID Guid
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
* @param {Boolean} optsOrCallback.sort Sorts user information by account name ascending
* @param {Boolean} optsOrCallback.includeLicense When true: additional details about the user's license will be included in the response. The account must have an IAM plan with licenses.
* @param {module:api/UsersApi~getUserDSProfileCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/UsersDrilldownResponse}
*/
Expand Down Expand Up @@ -491,7 +492,8 @@
'userId': userId
};
var queryParams = {
'sort': optsOrCallback['sort']
'sort': optsOrCallback['sort'],
'include_license': optsOrCallback['includeLicense']
};
var headerParams = {
};
Expand Down Expand Up @@ -525,6 +527,7 @@
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
* @param {String} optsOrCallback.email The email address of the user
* @param {Boolean} optsOrCallback.sort Sorts user information by account name ascending
* @param {Boolean} optsOrCallback.includeLicense When true: additional details about the user's license will be included in the response. The account must have an IAM plan with licenses.
* @param {module:api/UsersApi~getUserDSProfilesByEmailCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/UsersDrilldownResponse}
*/
Expand Down Expand Up @@ -555,7 +558,8 @@
};
var queryParams = {
'email': optsOrCallback['email'],
'sort': optsOrCallback['sort']
'sort': optsOrCallback['sort'],
'include_license': optsOrCallback['includeLicense']
};
var headerParams = {
};
Expand Down Expand Up @@ -588,6 +592,7 @@
* @param {String} organizationId The organization ID Guid
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
* @param {String} optsOrCallback.email The email address
* @param {Boolean} optsOrCallback.includeLicense When true: additional details about the user's license will be included in the response. The account must have an IAM plan with licenses.
* @param {module:api/UsersApi~getUserProfilesCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/UsersDrilldownResponse}
*/
Expand Down Expand Up @@ -617,7 +622,8 @@
'organizationId': organizationId
};
var queryParams = {
'email': optsOrCallback['email']
'email': optsOrCallback['email'],
'include_license': optsOrCallback['includeLicense']
};
var headerParams = {
};
Expand Down Expand Up @@ -660,6 +666,7 @@
* @param {String} optsOrCallback.organizationReservedDomainId Select users that are in the specified domain. At least one of email, account_id or organization_reserved_domain_id must be specified.
* @param {String} optsOrCallback.lastModifiedSince Select users whose data have been modified since the date specified; account_id or organization_reserved_domain_id must be specified.
* @param {Boolean} optsOrCallback.includeDsGroups Select users with groups the users belong to; account_id must be specified. The organization must have the entitlement AllowMultiApplication enabled.
* @param {Boolean} optsOrCallback.includeLicense When true: additional details about the user's license will be included in the response; account_id must be specified and the account must have an IAM plan with licenses.
* @param {module:api/UsersApi~getUsersCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/OrganizationUsersResponse}
*/
Expand Down Expand Up @@ -699,7 +706,8 @@
'account_id': optsOrCallback['accountId'],
'organization_reserved_domain_id': optsOrCallback['organizationReservedDomainId'],
'last_modified_since': optsOrCallback['lastModifiedSince'],
'include_ds_groups': optsOrCallback['includeDsGroups']
'include_ds_groups': optsOrCallback['includeDsGroups'],
'include_license': optsOrCallback['includeLicense']
};
var headerParams = {
};
Expand Down Expand Up @@ -789,10 +797,19 @@
* Required scopes: user_write
* @param {String} organizationId The organization ID Guid
* @param {module:model/UpdateUsersRequest} request The user details to update
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
* @param {Boolean} optsOrCallback.applyLicenseOverride If an account has an IAM plan with licenses, this query specifies how a user's license is handled. Values: true - Updates the user's existing license; false - Adds a license to the user
* @param {module:api/UsersApi~updateUserCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/UsersUpdateResponse}
*/
this.updateUser = function(request, organizationId, callback) {
this.updateUser = function(request, organizationId, optsOrCallback, callback) {
optsOrCallback = optsOrCallback || {};

if (typeof optsOrCallback === 'function') {
callback = optsOrCallback;
optsOrCallback = {};
}

var postBody = request;

// verify the required parameter 'organizationId' is set
Expand All @@ -816,6 +833,7 @@
'organizationId': organizationId
};
var queryParams = {
'apply_license_override': optsOrCallback['applyLicenseOverride']
};
var headerParams = {
};
Expand Down
51 changes: 48 additions & 3 deletions src/index.js

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions src/model/AddUserResponseAccountProperties.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,18 @@
if (data.hasOwnProperty('job_title')) {
obj['job_title'] = ApiClient.convertToType(data['job_title'], 'String');
}
if (data.hasOwnProperty('license_type')) {
obj['license_type'] = ApiClient.convertToType(data['license_type'], 'String');
}
if (data.hasOwnProperty('subscription_id')) {
obj['subscription_id'] = ApiClient.convertToType(data['subscription_id'], 'String');
}
if (data.hasOwnProperty('plan_name')) {
obj['plan_name'] = ApiClient.convertToType(data['plan_name'], 'String');
}
if (data.hasOwnProperty('license_status')) {
obj['license_status'] = ApiClient.convertToType(data['license_status'], 'String');
}
}
return obj;
}
Expand Down Expand Up @@ -100,6 +112,22 @@
* @member {String} job_title
*/
exports.prototype['job_title'] = undefined;
/**
* @member {String} license_type
*/
exports.prototype['license_type'] = undefined;
/**
* @member {String} subscription_id
*/
exports.prototype['subscription_id'] = undefined;
/**
* @member {String} plan_name
*/
exports.prototype['plan_name'] = undefined;
/**
* @member {String} license_status
*/
exports.prototype['license_status'] = undefined;



Expand Down
81 changes: 81 additions & 0 deletions src/model/ConnectEventData.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/**
* Docusign Admin API
* An API for an organization administrator to manage organizations, accounts and users
*
* OpenAPI spec version: v2.1
* Contact: devcenter@docusign.com
*
* NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
*
*/

(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['ApiClient'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'));
} else {
// Browser globals (root is window)
if (!root.DocusignAdmin) {
root.DocusignAdmin = {};
}
root.DocusignAdmin.ConnectEventData = factory(root.DocusignAdmin.ApiClient);
}
}(this, function(ApiClient) {
'use strict';


/**
* The ConnectEventData model module.
* @module model/ConnectEventData
*/

/**
* Constructs a new <code>ConnectEventData</code>.
* @alias module:model/ConnectEventData
* @class
*/
var exports = function() {
var _this = this;


};

/**
* Constructs a <code>ConnectEventData</code> from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
* @param {module:model/ConnectEventData} obj Optional instance to populate.
* @return {module:model/ConnectEventData} The populated <code>ConnectEventData</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();

if (data.hasOwnProperty('version')) {
obj['version'] = ApiClient.convertToType(data['version'], 'String');
}
if (data.hasOwnProperty('includeData')) {
obj['includeData'] = ApiClient.convertToType(data['includeData'], ['String']);
}
}
return obj;
}

/**
* @member {String} version
*/
exports.prototype['version'] = undefined;
/**
* @member {Array.<String>} includeData
*/
exports.prototype['includeData'] = undefined;



return exports;
}));


7 changes: 7 additions & 0 deletions src/model/DSGroupResponse.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@
if (data.hasOwnProperty('account_name')) {
obj['account_name'] = ApiClient.convertToType(data['account_name'], 'String');
}
if (data.hasOwnProperty('is_managed_by_scim')) {
obj['is_managed_by_scim'] = ApiClient.convertToType(data['is_managed_by_scim'], 'Boolean');
}
}
return obj;
}
Expand Down Expand Up @@ -135,6 +138,10 @@
* @member {String} account_name
*/
exports.prototype['account_name'] = undefined;
/**
* @member {Boolean} is_managed_by_scim
*/
exports.prototype['is_managed_by_scim'] = undefined;



Expand Down
81 changes: 81 additions & 0 deletions src/model/ErrorDetail.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/**
* Docusign Admin API
* An API for an organization administrator to manage organizations, accounts and users
*
* OpenAPI spec version: v2.1
* Contact: devcenter@docusign.com
*
* NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
*
*/

(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['ApiClient'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'));
} else {
// Browser globals (root is window)
if (!root.DocusignAdmin) {
root.DocusignAdmin = {};
}
root.DocusignAdmin.ErrorDetail = factory(root.DocusignAdmin.ApiClient);
}
}(this, function(ApiClient) {
'use strict';


/**
* The ErrorDetail model module.
* @module model/ErrorDetail
*/

/**
* Constructs a new <code>ErrorDetail</code>.
* @alias module:model/ErrorDetail
* @class
*/
var exports = function() {
var _this = this;


};

/**
* Constructs a <code>ErrorDetail</code> from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
* @param {module:model/ErrorDetail} obj Optional instance to populate.
* @return {module:model/ErrorDetail} The populated <code>ErrorDetail</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();

if (data.hasOwnProperty('errorMessage')) {
obj['errorMessage'] = ApiClient.convertToType(data['errorMessage'], 'String');
}
if (data.hasOwnProperty('referenceId')) {
obj['referenceId'] = ApiClient.convertToType(data['referenceId'], 'String');
}
}
return obj;
}

/**
* @member {String} errorMessage
*/
exports.prototype['errorMessage'] = undefined;
/**
* @member {String} referenceId
*/
exports.prototype['referenceId'] = undefined;



return exports;
}));


Loading