docusign_admin 1.3.0 → 2.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/docusign_admin.gemspec +3 -3
- data/lib/docusign_admin/api/accounts_api.rb +1 -1
- data/lib/docusign_admin/api/bulk_exports_api.rb +1 -1
- data/lib/docusign_admin/api/bulk_imports_api.rb +1 -1
- data/lib/docusign_admin/api/ds_groups_api.rb +1 -1
- data/lib/docusign_admin/api/identity_providers_api.rb +1 -1
- data/lib/docusign_admin/api/organizations_api.rb +1 -1
- data/lib/docusign_admin/api/product_permission_profiles_api.rb +1 -1
- data/lib/docusign_admin/api/provision_asset_group_api.rb +251 -7
- data/lib/docusign_admin/api/reserved_domains_api.rb +1 -1
- data/lib/docusign_admin/api/users_api.rb +5 -1
- data/lib/docusign_admin/client/api_client.rb +10 -10
- data/lib/docusign_admin/client/api_error.rb +1 -1
- data/lib/docusign_admin/configuration.rb +1 -1
- data/lib/docusign_admin/models/add_ds_group_and_users_response.rb +1 -1
- data/lib/docusign_admin/models/add_ds_group_users_response.rb +1 -1
- data/lib/docusign_admin/models/add_user_response.rb +1 -1
- data/lib/docusign_admin/models/add_user_response_account_properties.rb +1 -1
- data/lib/docusign_admin/models/address_information.rb +246 -0
- data/lib/docusign_admin/models/asset_group_account_clone.rb +6 -6
- data/lib/docusign_admin/models/asset_group_account_clone_source_account.rb +1 -1
- data/lib/docusign_admin/models/asset_group_account_clone_target_account.rb +1 -1
- data/lib/docusign_admin/models/asset_group_account_clone_target_account_admin.rb +1 -1
- data/lib/docusign_admin/models/asset_group_account_clones.rb +1 -1
- data/lib/docusign_admin/models/asset_group_account_response.rb +1 -1
- data/lib/docusign_admin/models/asset_group_accounts_response.rb +1 -1
- data/lib/docusign_admin/models/certificate_response.rb +1 -1
- data/lib/docusign_admin/models/delete_membership_request.rb +1 -1
- data/lib/docusign_admin/models/delete_membership_response.rb +1 -1
- data/lib/docusign_admin/models/delete_memberships_request.rb +1 -1
- data/lib/docusign_admin/models/delete_memberships_response.rb +1 -1
- data/lib/docusign_admin/models/delete_response.rb +1 -1
- data/lib/docusign_admin/models/delete_user_identity_request.rb +1 -1
- data/lib/docusign_admin/models/docu_sign_account_domain_model_address.rb +255 -0
- data/lib/docusign_admin/models/domain_response.rb +1 -1
- data/lib/docusign_admin/models/domains_response.rb +1 -1
- data/lib/docusign_admin/models/ds_group_add_request.rb +1 -1
- data/lib/docusign_admin/models/ds_group_and_users_response.rb +1 -1
- data/lib/docusign_admin/models/ds_group_list_response.rb +1 -1
- data/lib/docusign_admin/models/ds_group_request.rb +1 -1
- data/lib/docusign_admin/models/ds_group_response.rb +1 -1
- data/lib/docusign_admin/models/ds_group_user_response.rb +1 -1
- data/lib/docusign_admin/models/ds_group_users_add_request.rb +1 -1
- data/lib/docusign_admin/models/ds_group_users_remove_request.rb +1 -1
- data/lib/docusign_admin/models/ds_group_users_response.rb +1 -1
- data/lib/docusign_admin/models/error_details.rb +1 -1
- data/lib/docusign_admin/models/force_activate_membership_request.rb +1 -1
- data/lib/docusign_admin/models/group_request.rb +1 -1
- data/lib/docusign_admin/models/identity_provider_response.rb +1 -1
- data/lib/docusign_admin/models/identity_providers_response.rb +1 -1
- data/lib/docusign_admin/models/individual_membership_data_redaction_request.rb +1 -1
- data/lib/docusign_admin/models/individual_user_data_redaction_request.rb +1 -1
- data/lib/docusign_admin/models/individual_user_data_redaction_response.rb +1 -1
- data/lib/docusign_admin/models/link_response.rb +1 -1
- data/lib/docusign_admin/models/member_group_response.rb +1 -1
- data/lib/docusign_admin/models/member_groups_response.rb +1 -1
- data/lib/docusign_admin/models/membership_data_redaction_request.rb +1 -1
- data/lib/docusign_admin/models/membership_data_redaction_response.rb +1 -1
- data/lib/docusign_admin/models/membership_response.rb +1 -1
- data/lib/docusign_admin/models/new_account_user_request.rb +1 -1
- data/lib/docusign_admin/models/new_multi_product_user_add_request.rb +1 -1
- data/lib/docusign_admin/models/new_user_request.rb +1 -1
- data/lib/docusign_admin/models/new_user_request_account_properties.rb +1 -1
- data/lib/docusign_admin/models/new_user_response.rb +1 -1
- data/lib/docusign_admin/models/new_user_response_account_properties.rb +1 -1
- data/lib/docusign_admin/models/oasirr_error_details.rb +1 -1
- data/lib/docusign_admin/models/oasirr_organization_account_settings_error_data_response.rb +1 -1
- data/lib/docusign_admin/models/oetr_error_details.rb +1 -1
- data/lib/docusign_admin/models/org_export_selected_account.rb +1 -1
- data/lib/docusign_admin/models/org_export_selected_domain.rb +1 -1
- data/lib/docusign_admin/models/org_report_configuration_response.rb +1 -1
- data/lib/docusign_admin/models/org_report_create_response.rb +1 -1
- data/lib/docusign_admin/models/org_report_list_response.rb +1 -1
- data/lib/docusign_admin/models/org_report_list_response_org_report.rb +1 -1
- data/lib/docusign_admin/models/org_report_list_response_requestor.rb +1 -1
- data/lib/docusign_admin/models/org_report_request.rb +1 -1
- data/lib/docusign_admin/models/organization_account_request.rb +1 -1
- data/lib/docusign_admin/models/organization_account_response.rb +1 -1
- data/lib/docusign_admin/models/organization_account_settings_import_requestor_response.rb +1 -1
- data/lib/docusign_admin/models/organization_account_settings_import_response.rb +1 -1
- data/lib/docusign_admin/models/organization_account_settings_import_result_response.rb +1 -1
- data/lib/docusign_admin/models/organization_accounts_request.rb +1 -1
- data/lib/docusign_admin/models/organization_export_account.rb +1 -1
- data/lib/docusign_admin/models/organization_export_domain.rb +1 -1
- data/lib/docusign_admin/models/organization_export_request.rb +1 -1
- data/lib/docusign_admin/models/organization_export_requestor_response.rb +1 -1
- data/lib/docusign_admin/models/organization_export_response.rb +1 -1
- data/lib/docusign_admin/models/organization_export_task_response.rb +1 -1
- data/lib/docusign_admin/models/organization_exports_response.rb +1 -1
- data/lib/docusign_admin/models/organization_import_response.rb +1 -1
- data/lib/docusign_admin/models/organization_import_response_error_rollup.rb +1 -1
- data/lib/docusign_admin/models/organization_import_response_requestor.rb +1 -1
- data/lib/docusign_admin/models/organization_import_response_warning_rollup.rb +1 -1
- data/lib/docusign_admin/models/organization_imports_response.rb +1 -1
- data/lib/docusign_admin/models/organization_response.rb +1 -1
- data/lib/docusign_admin/models/organization_salesforce_account_managers_response.rb +1 -1
- data/lib/docusign_admin/models/organization_simple_id_object.rb +1 -1
- data/lib/docusign_admin/models/organization_subscription_response.rb +248 -0
- data/lib/docusign_admin/models/organization_user_response.rb +1 -1
- data/lib/docusign_admin/models/organization_users_response.rb +1 -1
- data/lib/docusign_admin/models/organizations_response.rb +1 -1
- data/lib/docusign_admin/models/osamr_contact.rb +1 -1
- data/lib/docusign_admin/models/paging_response_properties.rb +1 -1
- data/lib/docusign_admin/models/permission_profile_request.rb +1 -1
- data/lib/docusign_admin/models/permission_profile_response.rb +1 -1
- data/lib/docusign_admin/models/permission_profile_response2_1.rb +1 -1
- data/lib/docusign_admin/models/permissions_response.rb +1 -1
- data/lib/docusign_admin/models/product_permission_profile_request.rb +1 -1
- data/lib/docusign_admin/models/product_permission_profile_response.rb +1 -1
- data/lib/docusign_admin/models/product_permission_profiles_request.rb +1 -1
- data/lib/docusign_admin/models/product_permission_profiles_response.rb +1 -1
- data/lib/docusign_admin/models/remove_ds_group_users_response.rb +1 -1
- data/lib/docusign_admin/models/remove_user_products_response.rb +1 -1
- data/lib/docusign_admin/models/required_attribute_mapping_response.rb +1 -1
- data/lib/docusign_admin/models/saml2_identity_provider_response.rb +1 -1
- data/lib/docusign_admin/models/setting_response.rb +1 -1
- data/lib/docusign_admin/models/sub_account_create_request.rb +192 -0
- data/lib/docusign_admin/models/sub_account_create_request_sub_account_creation_subscription.rb +203 -0
- data/lib/docusign_admin/models/sub_account_create_request_sub_account_creation_target_account_admin.rb +253 -0
- data/lib/docusign_admin/models/sub_account_create_request_sub_account_creation_target_account_details.rb +237 -0
- data/lib/docusign_admin/models/sub_account_create_subscription_details.rb +216 -0
- data/lib/docusign_admin/models/sub_account_create_subscription_module_details.rb +194 -0
- data/lib/docusign_admin/models/sub_account_create_target_account.rb +234 -0
- data/lib/docusign_admin/models/sub_account_create_target_account_admin.rb +248 -0
- data/lib/docusign_admin/models/sub_account_create_worker.rb +360 -0
- data/lib/docusign_admin/models/sub_account_create_worker_response.rb +186 -0
- data/lib/docusign_admin/models/sub_account_error_details.rb +204 -0
- data/lib/docusign_admin/models/subscription_plan_item_response.rb +210 -0
- data/lib/docusign_admin/models/subscription_provision_model_account_create_account_admin.rb +253 -0
- data/lib/docusign_admin/models/subscription_provision_model_account_create_create_account_details.rb +271 -0
- data/lib/docusign_admin/models/subscription_provision_model_account_create_create_account_subscription_details.rb +203 -0
- data/lib/docusign_admin/models/subscription_provision_model_account_create_create_sub_account_details.rb +280 -0
- data/lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb +516 -0
- data/lib/docusign_admin/models/subscription_provision_model_asset_group_work_result.rb +201 -0
- data/lib/docusign_admin/models/subscription_provision_model_change_event.rb +201 -0
- data/lib/docusign_admin/models/subscription_provision_model_service_error_details.rb +210 -0
- data/lib/docusign_admin/models/update_membership_request.rb +1 -1
- data/lib/docusign_admin/models/update_response.rb +1 -1
- data/lib/docusign_admin/models/update_user_email_request.rb +1 -1
- data/lib/docusign_admin/models/update_user_request.rb +1 -1
- data/lib/docusign_admin/models/update_users_email_request.rb +1 -1
- data/lib/docusign_admin/models/update_users_request.rb +1 -1
- data/lib/docusign_admin/models/user_drilldown_response.rb +1 -1
- data/lib/docusign_admin/models/user_identity_request.rb +1 -1
- data/lib/docusign_admin/models/user_identity_response.rb +1 -1
- data/lib/docusign_admin/models/user_product_permission_profiles_request.rb +1 -1
- data/lib/docusign_admin/models/user_product_permission_profiles_response.rb +1 -1
- data/lib/docusign_admin/models/user_product_profile_delete_request.rb +1 -1
- data/lib/docusign_admin/models/user_update_response.rb +1 -1
- data/lib/docusign_admin/models/users_drilldown_response.rb +1 -1
- data/lib/docusign_admin/models/users_update_response.rb +1 -1
- data/lib/docusign_admin/version.rb +2 -2
- data/lib/docusign_admin.rb +24 -2
- data/tests/Gemfile +1 -0
- metadata +29 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 765e6f3659b1f43176a293934bbd3b6b269a456de710aa7049b8372a269633c5
|
4
|
+
data.tar.gz: f9d1487ca2b985793d699ab73b1b37f9b67ede30520572cf7910367a97547645
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bd00e38258a6a7d2fafaa9a5416d9f40c9ad3eab42648dbcfc8a3a8dba76c74ebc385c8d78c3cc665ea6f8c3bf3811629c108004b8095cc2f6b0720ceb9d5794
|
7
|
+
data.tar.gz: 379f9f4efe5c35b3392357cc0d6ea6f9253682b970a9d341d55179dd49afacfbcb1c589d7b6e17bf1bd2f8b6ac11458c090526373d82cdf6d4a6bf64d627f0ca
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,28 @@
|
|
1
|
+
## [v2.0.0.rc1] - Admin API v2.1-1.4.0 - 2024-08-27
|
2
|
+
### Breaking Changes
|
3
|
+
<details>
|
4
|
+
<summary>API Changes (Click to expand)</summary>
|
5
|
+
|
6
|
+
<br/>
|
7
|
+
<div style="margin-left: 20px;">
|
8
|
+
|
9
|
+
Added new query parameter "include_ds_groups" to the API "/v2/organizations/{organizationId}/users":
|
10
|
+
|
11
|
+
<h3>Added New APIs for Account Creation</h3>
|
12
|
+
<li>GET: get subscription details for organization</li>
|
13
|
+
<li>POST: initiate Create account request</li>
|
14
|
+
<li>GET: get ongoing process details by org ID</li>
|
15
|
+
<li>GET: get individual process details by org ID, asset group ID, asset group work ID</li>
|
16
|
+
|
17
|
+
|
18
|
+
</div>
|
19
|
+
</details>
|
20
|
+
|
21
|
+
### Other Changes
|
22
|
+
- Updated logic to derive the `oauth_base_path` from `base_path`.
|
23
|
+
- Added support for version v2.1-1.4.0 of the DocuSign Admin API.
|
24
|
+
- Updated the SDK release version.
|
25
|
+
|
1
26
|
## [v1.3.0] - Admin API v2.1-1.3.0 - 2023-08-02
|
2
27
|
### Changed
|
3
28
|
- Added support for version v2.1-1.3.0 of the DocuSign Admin API.
|
data/docusign_admin.gemspec
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
2
2
|
|
3
3
|
=begin
|
4
|
-
#
|
4
|
+
#Docusign Admin API
|
5
5
|
|
6
6
|
#An API for an organization administrator to manage organizations, accounts and users
|
7
7
|
|
@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
|
|
21
21
|
s.authors = ["DocuSign"]
|
22
22
|
s.email = ["devcenter@docusign.com"]
|
23
23
|
s.homepage = "https://github.com/docusign/docusign-admin-ruby-client"
|
24
|
-
s.summary = "
|
25
|
-
s.description = "The
|
24
|
+
s.summary = "Docusign Admin API Ruby Gem"
|
25
|
+
s.description = "The Docusign Admin API enables you to automate user management with your existing systems while ensuring governance and compliance."
|
26
26
|
s.license = "MIT"
|
27
27
|
s.required_ruby_version = ">= 1.9"
|
28
28
|
|
@@ -1,5 +1,5 @@
|
|
1
1
|
=begin
|
2
|
-
#
|
2
|
+
#Docusign Admin API
|
3
3
|
|
4
4
|
#An API for an organization administrator to manage organizations, accounts and users
|
5
5
|
|
@@ -43,6 +43,27 @@ module DocuSign_Admin
|
|
43
43
|
end
|
44
44
|
end
|
45
45
|
|
46
|
+
class GetSubAccountCreateProcessByAssetGroupWorkIdOptions
|
47
|
+
# When true, include details for the asset group account create.
|
48
|
+
attr_accessor :include_details
|
49
|
+
|
50
|
+
def self.default
|
51
|
+
@@default ||= GetSubAccountCreateProcessByAssetGroupWorkIdOptions.new
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
class GetSubAccountCreateProcessesByOrgIdOptions
|
56
|
+
# When provided and is in the past, only return asset group account create processes that are updated after the date.
|
57
|
+
attr_accessor :since_updated_date
|
58
|
+
|
59
|
+
# When true, include details for the asset group account create processes.
|
60
|
+
attr_accessor :include_details
|
61
|
+
|
62
|
+
def self.default
|
63
|
+
@@default ||= GetSubAccountCreateProcessesByOrgIdOptions.new
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
46
67
|
|
47
68
|
class ProvisionAssetGroupApi
|
48
69
|
attr_accessor :api_client
|
@@ -51,7 +72,7 @@ module DocuSign_Admin
|
|
51
72
|
@api_client = api_client
|
52
73
|
end
|
53
74
|
|
54
|
-
# Clones an existing
|
75
|
+
# Clones an existing Docusign account to a new Docusign account.
|
55
76
|
# Currently this only clones eSign settings and asset group information. Required scopes: asset_group_account_clone_write
|
56
77
|
# @param organization_id The Guid representing the organization id.
|
57
78
|
# @param request The request defails for the new asset group account clone.
|
@@ -61,7 +82,7 @@ module DocuSign_Admin
|
|
61
82
|
return data
|
62
83
|
end
|
63
84
|
|
64
|
-
# Clones an existing
|
85
|
+
# Clones an existing Docusign account to a new Docusign account.
|
65
86
|
# Currently this only clones eSign settings and asset group information. Required scopes: asset_group_account_clone_write
|
66
87
|
# @param organization_id The Guid representing the organization id.
|
67
88
|
# @param request The request defails for the new asset group account clone.
|
@@ -75,7 +96,7 @@ module DocuSign_Admin
|
|
75
96
|
# verify the required parameter 'request' is set
|
76
97
|
fail ArgumentError, "Missing the required parameter 'request' when calling ProvisionAssetGroupApi.clone_asset_group_account" if request.nil?
|
77
98
|
# resource path
|
78
|
-
local_var_path = "/
|
99
|
+
local_var_path = "/v2/organizations/{organizationId}/assetGroups/accountClone".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
79
100
|
|
80
101
|
# query parameters
|
81
102
|
query_params = {}
|
@@ -106,6 +127,61 @@ module DocuSign_Admin
|
|
106
127
|
return data, status_code, headers
|
107
128
|
end
|
108
129
|
|
130
|
+
# Creates a new Docusign account using the plan and modules specified in request body.
|
131
|
+
# Currently this only supports eSign plans and modules. Required scopes: organization_sub_account_write
|
132
|
+
# @param organization_id The Guid representing the organization id.
|
133
|
+
# @param request The request details for the new account.
|
134
|
+
# @return [SubscriptionProvisionModelAssetGroupWorkResult]
|
135
|
+
def create_asset_group_account(organization_id, request)
|
136
|
+
data, _status_code, _headers = create_asset_group_account_with_http_info(organization_id, request)
|
137
|
+
return data
|
138
|
+
end
|
139
|
+
|
140
|
+
# Creates a new Docusign account using the plan and modules specified in request body.
|
141
|
+
# Currently this only supports eSign plans and modules. Required scopes: organization_sub_account_write
|
142
|
+
# @param organization_id The Guid representing the organization id.
|
143
|
+
# @param request The request details for the new account.
|
144
|
+
# @return [Array<(SubscriptionProvisionModelAssetGroupWorkResult, Fixnum, Hash)>] SubscriptionProvisionModelAssetGroupWorkResult data, response status code and response headers
|
145
|
+
def create_asset_group_account_with_http_info(organization_id, request)
|
146
|
+
if @api_client.config.debugging
|
147
|
+
@api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.create_asset_group_account ..."
|
148
|
+
end
|
149
|
+
# verify the required parameter 'organization_id' is set
|
150
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.create_asset_group_account" if organization_id.nil?
|
151
|
+
# verify the required parameter 'request' is set
|
152
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling ProvisionAssetGroupApi.create_asset_group_account" if request.nil?
|
153
|
+
# resource path
|
154
|
+
local_var_path = "/v2/organizations/{organizationId}/assetGroups/accountCreate".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
155
|
+
|
156
|
+
# query parameters
|
157
|
+
query_params = {}
|
158
|
+
|
159
|
+
# header parameters
|
160
|
+
header_params = {}
|
161
|
+
# HTTP header 'Accept' (if needed)
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
163
|
+
# HTTP header 'Content-Type'
|
164
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
165
|
+
|
166
|
+
# form parameters
|
167
|
+
form_params = {}
|
168
|
+
|
169
|
+
# http body (model)
|
170
|
+
post_body = @api_client.object_to_http_body(request)
|
171
|
+
auth_names = []
|
172
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
173
|
+
:header_params => header_params,
|
174
|
+
:query_params => query_params,
|
175
|
+
:form_params => form_params,
|
176
|
+
:body => post_body,
|
177
|
+
:auth_names => auth_names,
|
178
|
+
:return_type => 'SubscriptionProvisionModelAssetGroupWorkResult')
|
179
|
+
if @api_client.config.debugging
|
180
|
+
@api_client.config.logger.debug "API called: ProvisionAssetGroupApi#create_asset_group_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
181
|
+
end
|
182
|
+
return data, status_code, headers
|
183
|
+
end
|
184
|
+
|
109
185
|
# Gets an asset group account clone by the asset group work id.
|
110
186
|
# Required scopes: asset_group_account_clone_read
|
111
187
|
# @param organization_id The Guid representing the organization id.
|
@@ -136,7 +212,7 @@ module DocuSign_Admin
|
|
136
212
|
# verify the required parameter 'asset_group_work_id' is set
|
137
213
|
fail ArgumentError, "Missing the required parameter 'asset_group_work_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clone" if asset_group_work_id.nil?
|
138
214
|
# resource path
|
139
|
-
local_var_path = "/
|
215
|
+
local_var_path = "/v2/organizations/{organizationId}/assetGroups/{assetGroupId}/accountClones/{assetGroupWorkId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'assetGroupId' + '}', asset_group_id.to_s).sub('{' + 'assetGroupWorkId' + '}', asset_group_work_id.to_s)
|
140
216
|
|
141
217
|
# query parameters
|
142
218
|
query_params = {}
|
@@ -190,7 +266,7 @@ module DocuSign_Admin
|
|
190
266
|
# verify the required parameter 'organization_id' is set
|
191
267
|
fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clones_by_org_id" if organization_id.nil?
|
192
268
|
# resource path
|
193
|
-
local_var_path = "/
|
269
|
+
local_var_path = "/v2/organizations/{organizationId}/assetGroups/accountClones".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
194
270
|
|
195
271
|
# query parameters
|
196
272
|
query_params = {}
|
@@ -245,7 +321,7 @@ module DocuSign_Admin
|
|
245
321
|
# verify the required parameter 'organization_id' is set
|
246
322
|
fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_accounts" if organization_id.nil?
|
247
323
|
# resource path
|
248
|
-
local_var_path = "/
|
324
|
+
local_var_path = "/v2/organizations/{organizationId}/assetGroups/accounts".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
249
325
|
|
250
326
|
# query parameters
|
251
327
|
query_params = {}
|
@@ -276,5 +352,173 @@ module DocuSign_Admin
|
|
276
352
|
end
|
277
353
|
return data, status_code, headers
|
278
354
|
end
|
355
|
+
|
356
|
+
# Gets the subscription details for an organization id.
|
357
|
+
# Currently charges and non e-sign assets are excluded in the response. Required scopes: organization_sub_account_read
|
358
|
+
# @param organization_id The Guid representing the organization id.
|
359
|
+
# @return [Array<OrganizationSubscriptionResponse>]
|
360
|
+
def get_organization_plan_items(organization_id)
|
361
|
+
data, _status_code, _headers = get_organization_plan_items_with_http_info(organization_id)
|
362
|
+
return data
|
363
|
+
end
|
364
|
+
|
365
|
+
# Gets the subscription details for an organization id.
|
366
|
+
# Currently charges and non e-sign assets are excluded in the response. Required scopes: organization_sub_account_read
|
367
|
+
# @param organization_id The Guid representing the organization id.
|
368
|
+
# @return [Array<(Array<OrganizationSubscriptionResponse>, Fixnum, Hash)>] Array<OrganizationSubscriptionResponse> data, response status code and response headers
|
369
|
+
def get_organization_plan_items_with_http_info(organization_id)
|
370
|
+
if @api_client.config.debugging
|
371
|
+
@api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_organization_plan_items ..."
|
372
|
+
end
|
373
|
+
# verify the required parameter 'organization_id' is set
|
374
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_organization_plan_items" if organization_id.nil?
|
375
|
+
# resource path
|
376
|
+
local_var_path = "/v2/organizations/{organizationId}/planItems".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
377
|
+
|
378
|
+
# query parameters
|
379
|
+
query_params = {}
|
380
|
+
|
381
|
+
# header parameters
|
382
|
+
header_params = {}
|
383
|
+
# HTTP header 'Accept' (if needed)
|
384
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
385
|
+
# HTTP header 'Content-Type'
|
386
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
387
|
+
|
388
|
+
# form parameters
|
389
|
+
form_params = {}
|
390
|
+
|
391
|
+
# http body (model)
|
392
|
+
post_body = nil
|
393
|
+
auth_names = []
|
394
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
395
|
+
:header_params => header_params,
|
396
|
+
:query_params => query_params,
|
397
|
+
:form_params => form_params,
|
398
|
+
:body => post_body,
|
399
|
+
:auth_names => auth_names,
|
400
|
+
:return_type => 'Array<OrganizationSubscriptionResponse>')
|
401
|
+
if @api_client.config.debugging
|
402
|
+
@api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_organization_plan_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
403
|
+
end
|
404
|
+
return data, status_code, headers
|
405
|
+
end
|
406
|
+
|
407
|
+
# Gets an asset group account create process info by the asset group work id.
|
408
|
+
# Required scopes: organization_sub_account_read
|
409
|
+
# @param organization_id The Guid representing the organization id.
|
410
|
+
# @param asset_group_id The Guid representing the asset group id.
|
411
|
+
# @param asset_group_work_id The Guid representing the asset group account create id
|
412
|
+
# @param DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions Options for modifying the behavior of the function.
|
413
|
+
# @return [SubAccountCreateWorker]
|
414
|
+
def get_sub_account_create_process_by_asset_group_work_id(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions.default)
|
415
|
+
data, _status_code, _headers = get_sub_account_create_process_by_asset_group_work_id_with_http_info(organization_id, asset_group_id, asset_group_work_id, options)
|
416
|
+
return data
|
417
|
+
end
|
418
|
+
|
419
|
+
# Gets an asset group account create process info by the asset group work id.
|
420
|
+
# Required scopes: organization_sub_account_read
|
421
|
+
# @param organization_id The Guid representing the organization id.
|
422
|
+
# @param asset_group_id The Guid representing the asset group id.
|
423
|
+
# @param asset_group_work_id The Guid representing the asset group account create id
|
424
|
+
# @param DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions Options for modifying the behavior of the function.
|
425
|
+
# @return [Array<(SubAccountCreateWorker, Fixnum, Hash)>] SubAccountCreateWorker data, response status code and response headers
|
426
|
+
def get_sub_account_create_process_by_asset_group_work_id_with_http_info(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions.default)
|
427
|
+
if @api_client.config.debugging
|
428
|
+
@api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id ..."
|
429
|
+
end
|
430
|
+
# verify the required parameter 'organization_id' is set
|
431
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id" if organization_id.nil?
|
432
|
+
# verify the required parameter 'asset_group_id' is set
|
433
|
+
fail ArgumentError, "Missing the required parameter 'asset_group_id' when calling ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id" if asset_group_id.nil?
|
434
|
+
# verify the required parameter 'asset_group_work_id' is set
|
435
|
+
fail ArgumentError, "Missing the required parameter 'asset_group_work_id' when calling ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id" if asset_group_work_id.nil?
|
436
|
+
# resource path
|
437
|
+
local_var_path = "/v2/organizations/{organizationId}/assetGroup/{assetGroupId}/subAccountCreated/{assetGroupWorkId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'assetGroupId' + '}', asset_group_id.to_s).sub('{' + 'assetGroupWorkId' + '}', asset_group_work_id.to_s)
|
438
|
+
|
439
|
+
# query parameters
|
440
|
+
query_params = {}
|
441
|
+
query_params[:'include_details'] = options.include_details if !options.include_details.nil?
|
442
|
+
|
443
|
+
# header parameters
|
444
|
+
header_params = {}
|
445
|
+
# HTTP header 'Accept' (if needed)
|
446
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
447
|
+
# HTTP header 'Content-Type'
|
448
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
449
|
+
|
450
|
+
# form parameters
|
451
|
+
form_params = {}
|
452
|
+
|
453
|
+
# http body (model)
|
454
|
+
post_body = nil
|
455
|
+
auth_names = []
|
456
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
457
|
+
:header_params => header_params,
|
458
|
+
:query_params => query_params,
|
459
|
+
:form_params => form_params,
|
460
|
+
:body => post_body,
|
461
|
+
:auth_names => auth_names,
|
462
|
+
:return_type => 'SubAccountCreateWorker')
|
463
|
+
if @api_client.config.debugging
|
464
|
+
@api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_sub_account_create_process_by_asset_group_work_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
465
|
+
end
|
466
|
+
return data, status_code, headers
|
467
|
+
end
|
468
|
+
|
469
|
+
# Gets all asset group account creation processes for an organization id.
|
470
|
+
# Required scopes: organization_sub_account_read
|
471
|
+
# @param organization_id The Guid representing the organization id.
|
472
|
+
# @param DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions Options for modifying the behavior of the function.
|
473
|
+
# @return [SubAccountCreateWorkerResponse]
|
474
|
+
def get_sub_account_create_processes_by_org_id(organization_id, options = DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions.default)
|
475
|
+
data, _status_code, _headers = get_sub_account_create_processes_by_org_id_with_http_info(organization_id, options)
|
476
|
+
return data
|
477
|
+
end
|
478
|
+
|
479
|
+
# Gets all asset group account creation processes for an organization id.
|
480
|
+
# Required scopes: organization_sub_account_read
|
481
|
+
# @param organization_id The Guid representing the organization id.
|
482
|
+
# @param DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions Options for modifying the behavior of the function.
|
483
|
+
# @return [Array<(SubAccountCreateWorkerResponse, Fixnum, Hash)>] SubAccountCreateWorkerResponse data, response status code and response headers
|
484
|
+
def get_sub_account_create_processes_by_org_id_with_http_info(organization_id, options = DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions.default)
|
485
|
+
if @api_client.config.debugging
|
486
|
+
@api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_sub_account_create_processes_by_org_id ..."
|
487
|
+
end
|
488
|
+
# verify the required parameter 'organization_id' is set
|
489
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_sub_account_create_processes_by_org_id" if organization_id.nil?
|
490
|
+
# resource path
|
491
|
+
local_var_path = "/v2/organizations/{organizationId}/subAccountsCreated".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
492
|
+
|
493
|
+
# query parameters
|
494
|
+
query_params = {}
|
495
|
+
query_params[:'since_updated_date'] = options.since_updated_date if !options.since_updated_date.nil?
|
496
|
+
query_params[:'include_details'] = options.include_details if !options.include_details.nil?
|
497
|
+
|
498
|
+
# header parameters
|
499
|
+
header_params = {}
|
500
|
+
# HTTP header 'Accept' (if needed)
|
501
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
502
|
+
# HTTP header 'Content-Type'
|
503
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
504
|
+
|
505
|
+
# form parameters
|
506
|
+
form_params = {}
|
507
|
+
|
508
|
+
# http body (model)
|
509
|
+
post_body = nil
|
510
|
+
auth_names = []
|
511
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
512
|
+
:header_params => header_params,
|
513
|
+
:query_params => query_params,
|
514
|
+
:form_params => form_params,
|
515
|
+
:body => post_body,
|
516
|
+
:auth_names => auth_names,
|
517
|
+
:return_type => 'SubAccountCreateWorkerResponse')
|
518
|
+
if @api_client.config.debugging
|
519
|
+
@api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_sub_account_create_processes_by_org_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
520
|
+
end
|
521
|
+
return data, status_code, headers
|
522
|
+
end
|
279
523
|
end
|
280
524
|
end
|
@@ -1,5 +1,5 @@
|
|
1
1
|
=begin
|
2
|
-
#
|
2
|
+
#Docusign Admin API
|
3
3
|
|
4
4
|
#An API for an organization administrator to manage organizations, accounts and users
|
5
5
|
|
@@ -74,6 +74,9 @@ module DocuSign_Admin
|
|
74
74
|
# Select users whose data have been modified since the date specified; account_id or organization_reserved_domain_id must be specified.
|
75
75
|
attr_accessor :last_modified_since
|
76
76
|
|
77
|
+
# Select users with groups the users belong to; The organization must have entitlement AllowMultiApplication enabled.
|
78
|
+
attr_accessor :include_ds_groups
|
79
|
+
|
77
80
|
def self.default
|
78
81
|
@@default ||= GetUsersOptions.new
|
79
82
|
end
|
@@ -644,6 +647,7 @@ module DocuSign_Admin
|
|
644
647
|
query_params[:'account_id'] = options.account_id if !options.account_id.nil?
|
645
648
|
query_params[:'organization_reserved_domain_id'] = options.organization_reserved_domain_id if !options.organization_reserved_domain_id.nil?
|
646
649
|
query_params[:'last_modified_since'] = options.last_modified_since if !options.last_modified_since.nil?
|
650
|
+
query_params[:'include_ds_groups'] = options.include_ds_groups if !options.include_ds_groups.nil?
|
647
651
|
|
648
652
|
# header parameters
|
649
653
|
header_params = {}
|
@@ -1,5 +1,5 @@
|
|
1
1
|
=begin
|
2
|
-
#
|
2
|
+
#Docusign Admin API
|
3
3
|
|
4
4
|
#An API for an organization administrator to manage organizations, accounts and users
|
5
5
|
|
@@ -35,7 +35,7 @@ module DocuSign_Admin
|
|
35
35
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
36
36
|
def initialize(config = Configuration.default)
|
37
37
|
@config = config
|
38
|
-
@user_agent = "Swagger-Codegen/1.
|
38
|
+
@user_agent = "Swagger-Codegen/v2.1/2.0.0.rc1/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
|
39
39
|
@default_headers = {
|
40
40
|
'Content-Type' => "application/json",
|
41
41
|
'User-Agent' => @user_agent
|
@@ -407,9 +407,9 @@ module DocuSign_Admin
|
|
407
407
|
#raise ArgumentError.new('oAuthBasePath cannot be empty') unless oauth_base_path
|
408
408
|
|
409
409
|
# Derive OAuth Base Path if not given
|
410
|
-
if self.base_path.start_with?("https://demo") or self.base_path.start_with?("http://demo")
|
410
|
+
if self.base_path.nil? or self.base_path.start_with?("https://demo") or self.base_path.start_with?("http://demo") or self.base_path.start_with?("https://apps-d") or self.base_path.start_with?("http://apps-d")
|
411
411
|
self.oauth_base_path = OAuth::DEMO_OAUTH_BASE_PATH
|
412
|
-
elsif self.base_path.start_with?("https://stage") or self.base_path.start_with?("http://stage")
|
412
|
+
elsif self.base_path.start_with?("https://stage") or self.base_path.start_with?("http://stage") or self.base_path.start_with?("https://apps-s") or self.base_path.start_with?("http://apps-s")
|
413
413
|
self.oauth_base_path = OAuth::STAGE_OAUTH_BASE_PATH
|
414
414
|
else
|
415
415
|
self.oauth_base_path = OAuth::PRODUCTION_OAUTH_BASE_PATH
|
@@ -426,7 +426,7 @@ module DocuSign_Admin
|
|
426
426
|
end
|
427
427
|
|
428
428
|
# Helper method to configure the OAuth accessCode/implicit flow parameters
|
429
|
-
# @param [String] client_id
|
429
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
430
430
|
# @param scopes The list of requested scopes. Client applications may be scoped to a limited set of system access.
|
431
431
|
# @param [String] redirect_uri This determines where to deliver the response containing the authorization code
|
432
432
|
# @param [String] response_type Determines the response type of the authorization request, NOTE: these response types are mutually exclusive for a client application. A public/native client application may only request a response type
|
@@ -446,8 +446,8 @@ module DocuSign_Admin
|
|
446
446
|
end
|
447
447
|
|
448
448
|
# Request JWT User Token
|
449
|
-
# @param [String] client_id
|
450
|
-
# @param [String] user_id
|
449
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
450
|
+
# @param [String] user_id Docusign user Id to be impersonated
|
451
451
|
# @param [String] private_key_or_filename the RSA private key
|
452
452
|
# @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
|
453
453
|
# @param scopes The list of requested scopes. Client applications may be scoped to a limited set of system access.
|
@@ -497,7 +497,7 @@ module DocuSign_Admin
|
|
497
497
|
end
|
498
498
|
|
499
499
|
# Request JWT User Token
|
500
|
-
# @param [String] client_id
|
500
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
501
501
|
# @param [String] private_key_or_filename the RSA private key
|
502
502
|
# @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
|
503
503
|
# @param scopes The list of requested scopes. Client applications may be scoped to a limited set of system access.
|
@@ -559,8 +559,8 @@ module DocuSign_Admin
|
|
559
559
|
end
|
560
560
|
|
561
561
|
# GenerateAccessToken will exchange the authorization code for an access token and refresh tokens.
|
562
|
-
# @param [String] client_id
|
563
|
-
# @param [String] client_secret The secret key you generated when you set up the integration in
|
562
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
563
|
+
# @param [String] client_secret The secret key you generated when you set up the integration in Docusign Admin console.
|
564
564
|
# @param [String] code The authorization code
|
565
565
|
def generate_access_token(client_id, client_secret, code)
|
566
566
|
raise ArgumentError.new('client_id cannot be empty') if client_id.empty?
|