Skip to content

Commit 4d9f03b

Browse files
ManavDocusignroot
andauthored
Version 3.1.0-v2.1-1.4.3 release (#16)
Co-authored-by: root <root@devcenteradmin.docusigntest.com>
1 parent c75056e commit 4d9f03b

24 files changed

Lines changed: 1953 additions & 10 deletions

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
44

55

6+
## [v3.1.0] - Admin API v2.1-1.4.3 - 2026-03-09
7+
### Changed
8+
- Added support for version v2.1-1.4.3 of the DocuSign Admin API.
9+
- Updated the SDK release version.
10+
611
## [v3.0.0] - Admin API v2.1-1.4.1 - 2024-10-28
712
### Changed
813
- Added support for version v2.1-1.4.1 of the DocuSign Admin API.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docusign-admin",
3-
"version": "3.0.0",
3+
"version": "3.1.0",
44
"description": "The Docusign Admin API enables you to automate user management with your existing systems while ensuring governance and compliance.",
55
"license": "MIT",
66
"main": "src/index.js",

src/api/BulkExportsApi.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
*/
6161

6262
/**
63-
* Creates a new Account Setting Export request.
63+
* Creates a new Account Setting Export request.
6464
* Required scopes: account_read
6565
* @param {String} organizationId The organization ID Guid
6666
* @param {module:model/OrganizationAccountsRequest} request Request body containing details about the accounts be compared

src/api/OrgConnectApi.js

Lines changed: 750 additions & 0 deletions
Large diffs are not rendered by default.

src/api/UsersApi.js

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,7 @@
456456
* @param {String} userId The user ID Guid
457457
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
458458
* @param {Boolean} optsOrCallback.sort Sorts user information by account name ascending
459+
* @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.
459460
* @param {module:api/UsersApi~getUserDSProfileCallback} callback The callback function, accepting three arguments: error, data, response
460461
* data is of type: {@link module:model/UsersDrilldownResponse}
461462
*/
@@ -491,7 +492,8 @@
491492
'userId': userId
492493
};
493494
var queryParams = {
494-
'sort': optsOrCallback['sort']
495+
'sort': optsOrCallback['sort'],
496+
'include_license': optsOrCallback['includeLicense']
495497
};
496498
var headerParams = {
497499
};
@@ -525,6 +527,7 @@
525527
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
526528
* @param {String} optsOrCallback.email The email address of the user
527529
* @param {Boolean} optsOrCallback.sort Sorts user information by account name ascending
530+
* @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.
528531
* @param {module:api/UsersApi~getUserDSProfilesByEmailCallback} callback The callback function, accepting three arguments: error, data, response
529532
* data is of type: {@link module:model/UsersDrilldownResponse}
530533
*/
@@ -555,7 +558,8 @@
555558
};
556559
var queryParams = {
557560
'email': optsOrCallback['email'],
558-
'sort': optsOrCallback['sort']
561+
'sort': optsOrCallback['sort'],
562+
'include_license': optsOrCallback['includeLicense']
559563
};
560564
var headerParams = {
561565
};
@@ -588,6 +592,7 @@
588592
* @param {String} organizationId The organization ID Guid
589593
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
590594
* @param {String} optsOrCallback.email The email address
595+
* @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.
591596
* @param {module:api/UsersApi~getUserProfilesCallback} callback The callback function, accepting three arguments: error, data, response
592597
* data is of type: {@link module:model/UsersDrilldownResponse}
593598
*/
@@ -617,7 +622,8 @@
617622
'organizationId': organizationId
618623
};
619624
var queryParams = {
620-
'email': optsOrCallback['email']
625+
'email': optsOrCallback['email'],
626+
'include_license': optsOrCallback['includeLicense']
621627
};
622628
var headerParams = {
623629
};
@@ -660,6 +666,7 @@
660666
* @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.
661667
* @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.
662668
* @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.
669+
* @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.
663670
* @param {module:api/UsersApi~getUsersCallback} callback The callback function, accepting three arguments: error, data, response
664671
* data is of type: {@link module:model/OrganizationUsersResponse}
665672
*/
@@ -699,7 +706,8 @@
699706
'account_id': optsOrCallback['accountId'],
700707
'organization_reserved_domain_id': optsOrCallback['organizationReservedDomainId'],
701708
'last_modified_since': optsOrCallback['lastModifiedSince'],
702-
'include_ds_groups': optsOrCallback['includeDsGroups']
709+
'include_ds_groups': optsOrCallback['includeDsGroups'],
710+
'include_license': optsOrCallback['includeLicense']
703711
};
704712
var headerParams = {
705713
};
@@ -789,10 +797,19 @@
789797
* Required scopes: user_write
790798
* @param {String} organizationId The organization ID Guid
791799
* @param {module:model/UpdateUsersRequest} request The user details to update
800+
* @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
801+
* @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
792802
* @param {module:api/UsersApi~updateUserCallback} callback The callback function, accepting three arguments: error, data, response
793803
* data is of type: {@link module:model/UsersUpdateResponse}
794804
*/
795-
this.updateUser = function(request, organizationId, callback) {
805+
this.updateUser = function(request, organizationId, optsOrCallback, callback) {
806+
optsOrCallback = optsOrCallback || {};
807+
808+
if (typeof optsOrCallback === 'function') {
809+
callback = optsOrCallback;
810+
optsOrCallback = {};
811+
}
812+
796813
var postBody = request;
797814

798815
// verify the required parameter 'organizationId' is set
@@ -816,6 +833,7 @@
816833
'organizationId': organizationId
817834
};
818835
var queryParams = {
836+
'apply_license_override': optsOrCallback['applyLicenseOverride']
819837
};
820838
var headerParams = {
821839
};

src/index.js

Lines changed: 48 additions & 3 deletions
Large diffs are not rendered by default.

src/model/AddUserResponseAccountProperties.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,18 @@
7272
if (data.hasOwnProperty('job_title')) {
7373
obj['job_title'] = ApiClient.convertToType(data['job_title'], 'String');
7474
}
75+
if (data.hasOwnProperty('license_type')) {
76+
obj['license_type'] = ApiClient.convertToType(data['license_type'], 'String');
77+
}
78+
if (data.hasOwnProperty('subscription_id')) {
79+
obj['subscription_id'] = ApiClient.convertToType(data['subscription_id'], 'String');
80+
}
81+
if (data.hasOwnProperty('plan_name')) {
82+
obj['plan_name'] = ApiClient.convertToType(data['plan_name'], 'String');
83+
}
84+
if (data.hasOwnProperty('license_status')) {
85+
obj['license_status'] = ApiClient.convertToType(data['license_status'], 'String');
86+
}
7587
}
7688
return obj;
7789
}
@@ -100,6 +112,22 @@
100112
* @member {String} job_title
101113
*/
102114
exports.prototype['job_title'] = undefined;
115+
/**
116+
* @member {String} license_type
117+
*/
118+
exports.prototype['license_type'] = undefined;
119+
/**
120+
* @member {String} subscription_id
121+
*/
122+
exports.prototype['subscription_id'] = undefined;
123+
/**
124+
* @member {String} plan_name
125+
*/
126+
exports.prototype['plan_name'] = undefined;
127+
/**
128+
* @member {String} license_status
129+
*/
130+
exports.prototype['license_status'] = undefined;
103131

104132

105133

src/model/ConnectEventData.js

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/**
2+
* Docusign Admin API
3+
* An API for an organization administrator to manage organizations, accounts and users
4+
*
5+
* OpenAPI spec version: v2.1
6+
* Contact: devcenter@docusign.com
7+
*
8+
* NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
9+
*
10+
*/
11+
12+
(function(root, factory) {
13+
if (typeof define === 'function' && define.amd) {
14+
// AMD. Register as an anonymous module.
15+
define(['ApiClient'], factory);
16+
} else if (typeof module === 'object' && module.exports) {
17+
// CommonJS-like environments that support module.exports, like Node.
18+
module.exports = factory(require('../ApiClient'));
19+
} else {
20+
// Browser globals (root is window)
21+
if (!root.DocusignAdmin) {
22+
root.DocusignAdmin = {};
23+
}
24+
root.DocusignAdmin.ConnectEventData = factory(root.DocusignAdmin.ApiClient);
25+
}
26+
}(this, function(ApiClient) {
27+
'use strict';
28+
29+
30+
/**
31+
* The ConnectEventData model module.
32+
* @module model/ConnectEventData
33+
*/
34+
35+
/**
36+
* Constructs a new <code>ConnectEventData</code>.
37+
* @alias module:model/ConnectEventData
38+
* @class
39+
*/
40+
var exports = function() {
41+
var _this = this;
42+
43+
44+
};
45+
46+
/**
47+
* Constructs a <code>ConnectEventData</code> from a plain JavaScript object, optionally creating a new instance.
48+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
49+
* @param {Object} data The plain JavaScript object bearing properties of interest.
50+
* @param {module:model/ConnectEventData} obj Optional instance to populate.
51+
* @return {module:model/ConnectEventData} The populated <code>ConnectEventData</code> instance.
52+
*/
53+
exports.constructFromObject = function(data, obj) {
54+
if (data) {
55+
obj = obj || new exports();
56+
57+
if (data.hasOwnProperty('version')) {
58+
obj['version'] = ApiClient.convertToType(data['version'], 'String');
59+
}
60+
if (data.hasOwnProperty('includeData')) {
61+
obj['includeData'] = ApiClient.convertToType(data['includeData'], ['String']);
62+
}
63+
}
64+
return obj;
65+
}
66+
67+
/**
68+
* @member {String} version
69+
*/
70+
exports.prototype['version'] = undefined;
71+
/**
72+
* @member {Array.<String>} includeData
73+
*/
74+
exports.prototype['includeData'] = undefined;
75+
76+
77+
78+
return exports;
79+
}));
80+
81+

src/model/DSGroupResponse.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@
8787
if (data.hasOwnProperty('account_name')) {
8888
obj['account_name'] = ApiClient.convertToType(data['account_name'], 'String');
8989
}
90+
if (data.hasOwnProperty('is_managed_by_scim')) {
91+
obj['is_managed_by_scim'] = ApiClient.convertToType(data['is_managed_by_scim'], 'Boolean');
92+
}
9093
}
9194
return obj;
9295
}
@@ -135,6 +138,10 @@
135138
* @member {String} account_name
136139
*/
137140
exports.prototype['account_name'] = undefined;
141+
/**
142+
* @member {Boolean} is_managed_by_scim
143+
*/
144+
exports.prototype['is_managed_by_scim'] = undefined;
138145

139146

140147

src/model/ErrorDetail.js

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/**
2+
* Docusign Admin API
3+
* An API for an organization administrator to manage organizations, accounts and users
4+
*
5+
* OpenAPI spec version: v2.1
6+
* Contact: devcenter@docusign.com
7+
*
8+
* NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
9+
*
10+
*/
11+
12+
(function(root, factory) {
13+
if (typeof define === 'function' && define.amd) {
14+
// AMD. Register as an anonymous module.
15+
define(['ApiClient'], factory);
16+
} else if (typeof module === 'object' && module.exports) {
17+
// CommonJS-like environments that support module.exports, like Node.
18+
module.exports = factory(require('../ApiClient'));
19+
} else {
20+
// Browser globals (root is window)
21+
if (!root.DocusignAdmin) {
22+
root.DocusignAdmin = {};
23+
}
24+
root.DocusignAdmin.ErrorDetail = factory(root.DocusignAdmin.ApiClient);
25+
}
26+
}(this, function(ApiClient) {
27+
'use strict';
28+
29+
30+
/**
31+
* The ErrorDetail model module.
32+
* @module model/ErrorDetail
33+
*/
34+
35+
/**
36+
* Constructs a new <code>ErrorDetail</code>.
37+
* @alias module:model/ErrorDetail
38+
* @class
39+
*/
40+
var exports = function() {
41+
var _this = this;
42+
43+
44+
};
45+
46+
/**
47+
* Constructs a <code>ErrorDetail</code> from a plain JavaScript object, optionally creating a new instance.
48+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
49+
* @param {Object} data The plain JavaScript object bearing properties of interest.
50+
* @param {module:model/ErrorDetail} obj Optional instance to populate.
51+
* @return {module:model/ErrorDetail} The populated <code>ErrorDetail</code> instance.
52+
*/
53+
exports.constructFromObject = function(data, obj) {
54+
if (data) {
55+
obj = obj || new exports();
56+
57+
if (data.hasOwnProperty('errorMessage')) {
58+
obj['errorMessage'] = ApiClient.convertToType(data['errorMessage'], 'String');
59+
}
60+
if (data.hasOwnProperty('referenceId')) {
61+
obj['referenceId'] = ApiClient.convertToType(data['referenceId'], 'String');
62+
}
63+
}
64+
return obj;
65+
}
66+
67+
/**
68+
* @member {String} errorMessage
69+
*/
70+
exports.prototype['errorMessage'] = undefined;
71+
/**
72+
* @member {String} referenceId
73+
*/
74+
exports.prototype['referenceId'] = undefined;
75+
76+
77+
78+
return exports;
79+
}));
80+
81+

0 commit comments

Comments
 (0)