Class: DocuSign_Admin::ProvisionAssetGroupApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/api/provision_asset_group_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ProvisionAssetGroupApi.default) ⇒ ProvisionAssetGroupApi

Returns a new instance of ProvisionAssetGroupApi.



50
51
52
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 50

def initialize(api_client = ProvisionAssetGroupApi.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



48
49
50
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 48

def api_client
  @api_client
end

Instance Method Details

#clone_asset_group_account(organization_id, request) ⇒ AssetGroupAccountClone

Clones an existing DocuSign account to a new DocuSign account. Currently this only clones eSign settings and asset group information. Required scopes: asset_group_account_clone_write

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • request —

    The request defails for the new asset group account clone.

Returns:



59
60
61
62
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 59

def (organization_id, request)
  data, _status_code, _headers = (organization_id,  request)
  return data
end

#clone_asset_group_account_with_http_info(organization_id, request) ⇒ Array<(AssetGroupAccountClone, Fixnum, Hash)>

Clones an existing DocuSign account to a new DocuSign account. Currently this only clones eSign settings and asset group information. Required scopes: asset_group_account_clone_write

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • request —

    The request defails for the new asset group account clone.

Returns:

  • (Array<(AssetGroupAccountClone, Fixnum, Hash)>) —

    AssetGroupAccountClone data, response status code and response headers



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 69

def (organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.clone_asset_group_account ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.clone_asset_group_account" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling ProvisionAssetGroupApi.clone_asset_group_account" if request.nil?
  # resource path
  local_var_path = "/v1/organizations/{organizationId}/assetGroups/accountClone".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AssetGroupAccountClone')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#clone_asset_group_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_asset_group_account_clone(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default) ⇒ AssetGroupAccountClone

Gets an asset group account clone by the asset group work id. Required scopes: asset_group_account_clone_read

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • asset_group_id —

    The Guid representing the asset group id.

  • asset_group_work_id —

    The Guid representing the asset group account clone id

  • DocuSign_Admin::GetAssetGroupAccountCloneOptions —

    Options for modifying the behavior of the function.

Returns:



116
117
118
119
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 116

def (organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default)
  data, _status_code, _headers = (organization_id, asset_group_id, asset_group_work_id, options)
  return data
end

#get_asset_group_account_clone_with_http_info(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default) ⇒ Array<(AssetGroupAccountClone, Fixnum, Hash)>

Gets an asset group account clone by the asset group work id. Required scopes: asset_group_account_clone_read

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • asset_group_id —

    The Guid representing the asset group id.

  • asset_group_work_id —

    The Guid representing the asset group account clone id

  • DocuSign_Admin::GetAssetGroupAccountCloneOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(AssetGroupAccountClone, Fixnum, Hash)>) —

    AssetGroupAccountClone data, response status code and response headers



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 128

def (organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_asset_group_account_clone ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clone" if organization_id.nil?
  # verify the required parameter 'asset_group_id' is set
  fail ArgumentError, "Missing the required parameter 'asset_group_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clone" if asset_group_id.nil?
  # verify the required parameter 'asset_group_work_id' is set
  fail ArgumentError, "Missing the required parameter 'asset_group_work_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clone" if asset_group_work_id.nil?
  # resource path
  local_var_path = "/v1/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)

  # query parameters
  query_params = {}
  query_params[:'include_details'] = options.include_details if !options.include_details.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AssetGroupAccountClone')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_asset_group_account_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_asset_group_account_clones_by_org_id(organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default) ⇒ AssetGroupAccountClones

Gets all asset group account clone(s) for an organization id. Required scopes: asset_group_account_clone_read

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions —

    Options for modifying the behavior of the function.

Returns:



176
177
178
179
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 176

def (organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default)
  data, _status_code, _headers = (organization_id, options)
  return data
end

#get_asset_group_account_clones_by_org_id_with_http_info(organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default) ⇒ Array<(AssetGroupAccountClones, Fixnum, Hash)>

Gets all asset group account clone(s) for an organization id. Required scopes: asset_group_account_clone_read

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(AssetGroupAccountClones, Fixnum, Hash)>) —

    AssetGroupAccountClones data, response status code and response headers



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 186

def (organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_asset_group_account_clones_by_org_id ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clones_by_org_id" if organization_id.nil?
  # resource path
  local_var_path = "/v1/organizations/{organizationId}/assetGroups/accountClones".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'since_updated_date'] = options.since_updated_date if !options.since_updated_date.nil?
  query_params[:'include_details'] = options.include_details if !options.include_details.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AssetGroupAccountClones')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_asset_group_account_clones_by_org_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_asset_group_accounts(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default) ⇒ AssetGroupAccountsResponse

Get all accounts in asset groups for the organization. Required scopes: asset_group_account_read

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • DocuSign_Admin::GetAssetGroupAccountsOptions —

    Options for modifying the behavior of the function.

Returns:



231
232
233
234
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 231

def get_asset_group_accounts(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default)
  data, _status_code, _headers = get_asset_group_accounts_with_http_info(organization_id, options)
  return data
end

#get_asset_group_accounts_with_http_info(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default) ⇒ Array<(AssetGroupAccountsResponse, Fixnum, Hash)>

Get all accounts in asset groups for the organization. Required scopes: asset_group_account_read

Parameters:

  • organization_id —

    The Guid representing the organization id.

  • DocuSign_Admin::GetAssetGroupAccountsOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(AssetGroupAccountsResponse, Fixnum, Hash)>) —

    AssetGroupAccountsResponse data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 241

def get_asset_group_accounts_with_http_info(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_asset_group_accounts ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_accounts" if organization_id.nil?
  # resource path
  local_var_path = "/v1/organizations/{organizationId}/assetGroups/accounts".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'compliant'] = options.compliant if !options.compliant.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AssetGroupAccountsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_asset_group_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end