class DocuSign_Rooms::FormGroupsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = FormGroupsApi.default) click to toggle source
# File lib/docusign_rooms/api/form_groups_api.rb, line 32
def initialize(api_client = FormGroupsApi.default)
  @api_client = api_client
end

Public Instance Methods

assign_form_group_form(form_group_id, account_id, body) click to toggle source

Assigns a form to a form group.

@param form_group_id @param account_id @param body (optional parameter) @return [FormGroupFormToAssign]

# File lib/docusign_rooms/api/form_groups_api.rb, line 42
def assign_form_group_form(form_group_id, account_id, body)
  data, _status_code, _headers = assign_form_group_form_with_http_info(form_group_id, account_id,  body)
  return data
end
assign_form_group_form_with_http_info(form_group_id, account_id, body) click to toggle source

Assigns a form to a form group.

@param form_group_id @param account_id @param body (optional parameter) @return [Array<(FormGroupFormToAssign, Fixnum, Hash)>] FormGroupFormToAssign data, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 53
def assign_form_group_form_with_http_info(form_group_id, account_id, body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.assign_form_group_form ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.assign_form_group_form" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.assign_form_group_form" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/assign_form".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  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 => 'FormGroupFormToAssign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#assign_form_group_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_form_group(account_id, body) click to toggle source

Creates a form group.

@param account_id @param body (optional parameter) @return [FormGroup]

# File lib/docusign_rooms/api/form_groups_api.rb, line 98
def create_form_group(account_id, body)
  data, _status_code, _headers = create_form_group_with_http_info(account_id,  body)
  return data
end
create_form_group_with_http_info(account_id, body) click to toggle source

Creates a form group.

@param account_id @param body (optional parameter) @return [Array<(FormGroup, Fixnum, Hash)>] FormGroup data, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 108
def create_form_group_with_http_info(account_id, body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.create_form_group ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.create_form_group" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  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 => 'FormGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#create_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_form_group(form_group_id, account_id) click to toggle source

Deletes a form group.

@param form_group_id @param account_id @return [nil]

# File lib/docusign_rooms/api/form_groups_api.rb, line 151
def delete_form_group(form_group_id, account_id)
  delete_form_group_with_http_info(form_group_id, account_id)
  return nil
end
delete_form_group_with_http_info(form_group_id, account_id) click to toggle source

Deletes a form group.

@param form_group_id @param account_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 161
def delete_form_group_with_http_info(form_group_id, account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.delete_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.delete_form_group" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.delete_form_group" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#delete_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_form_group(form_group_id, account_id) click to toggle source

Gets a form group.

@param form_group_id @param account_id @return [FormGroup]

# File lib/docusign_rooms/api/form_groups_api.rb, line 203
def get_form_group(form_group_id, account_id)
  data, _status_code, _headers = get_form_group_with_http_info(form_group_id, account_id)
  return data
end
get_form_group_with_http_info(form_group_id, account_id) click to toggle source

Gets a form group.

@param form_group_id @param account_id @return [Array<(FormGroup, Fixnum, Hash)>] FormGroup data, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 213
def get_form_group_with_http_info(form_group_id, account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.get_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.get_form_group" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.get_form_group" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/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 => 'FormGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#get_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_form_groups(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default) click to toggle source

Get account Form Groups.

@param account_id @param DocuSign_Rooms::GetFormGroupsOptions Options for modifying the behavior of the function. @return [FormGroupSummaryList]

# File lib/docusign_rooms/api/form_groups_api.rb, line 256
def get_form_groups(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default)
  data, _status_code, _headers = get_form_groups_with_http_info(account_id, options)
  return data
end
get_form_groups_with_http_info(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default) click to toggle source

Get account Form Groups.

@param account_id @param DocuSign_Rooms::GetFormGroupsOptions Options for modifying the behavior of the function. @return [Array<(FormGroupSummaryList, Fixnum, Hash)>] FormGroupSummaryList data, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 266
def get_form_groups_with_http_info(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.get_form_groups ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.get_form_groups" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/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 => 'FormGroupSummaryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#get_form_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
grant_office_access_to_form_group(form_group_id, office_id, account_id) click to toggle source

Assign office to a form group so the specified office has access to the form group.

@param form_group_id @param office_id @param account_id @return [nil]

# File lib/docusign_rooms/api/form_groups_api.rb, line 310
def grant_office_access_to_form_group(form_group_id, office_id, account_id)
  grant_office_access_to_form_group_with_http_info(form_group_id, office_id, account_id)
  return nil
end
grant_office_access_to_form_group_with_http_info(form_group_id, office_id, account_id) click to toggle source

Assign office to a form group so the specified office has access to the form group.

@param form_group_id @param office_id @param account_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 321
def grant_office_access_to_form_group_with_http_info(form_group_id, office_id, account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.grant_office_access_to_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.grant_office_access_to_form_group" if form_group_id.nil?
  # verify the required parameter 'office_id' is set
  fail ArgumentError, "Missing the required parameter 'office_id' when calling FormGroupsApi.grant_office_access_to_form_group" if office_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.grant_office_access_to_form_group" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/grant_office_access/{officeId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'officeId' + '}', office_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#grant_office_access_to_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
remove_form_group_form(form_group_id, form_id, account_id) click to toggle source

Removes a form from a form group.

@param form_group_id @param form_id @param account_id @return [nil]

# File lib/docusign_rooms/api/form_groups_api.rb, line 366
def remove_form_group_form(form_group_id, form_id, account_id)
  remove_form_group_form_with_http_info(form_group_id, form_id, account_id)
  return nil
end
remove_form_group_form_with_http_info(form_group_id, form_id, account_id) click to toggle source

Removes a form from a form group.

@param form_group_id @param form_id @param account_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 377
def remove_form_group_form_with_http_info(form_group_id, form_id, account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.remove_form_group_form ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.remove_form_group_form" if form_group_id.nil?
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling FormGroupsApi.remove_form_group_form" if form_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.remove_form_group_form" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/unassign_form/{formId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'formId' + '}', form_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#remove_form_group_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
rename_form_group(form_group_id, account_id, body) click to toggle source

Renames a form group.

@param form_group_id @param account_id @param body (optional parameter) @return [FormGroup]

# File lib/docusign_rooms/api/form_groups_api.rb, line 422
def rename_form_group(form_group_id, account_id, body)
  data, _status_code, _headers = rename_form_group_with_http_info(form_group_id, account_id,  body)
  return data
end
rename_form_group_with_http_info(form_group_id, account_id, body) click to toggle source

Renames a form group.

@param form_group_id @param account_id @param body (optional parameter) @return [Array<(FormGroup, Fixnum, Hash)>] FormGroup data, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 433
def rename_form_group_with_http_info(form_group_id, account_id, body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.rename_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.rename_form_group" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.rename_form_group" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FormGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#rename_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
revoke_office_access_from_form_group(form_group_id, office_id, account_id) click to toggle source

Remove office to a form group so the specified office doesn't have access to the form group.

@param form_group_id @param office_id @param account_id @return [nil]

# File lib/docusign_rooms/api/form_groups_api.rb, line 479
def revoke_office_access_from_form_group(form_group_id, office_id, account_id)
  revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, account_id)
  return nil
end
revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, account_id) click to toggle source

Remove office to a form group so the specified office doesn&#39;t have access to the form group.

@param form_group_id @param office_id @param account_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_rooms/api/form_groups_api.rb, line 490
def revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.revoke_office_access_from_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.revoke_office_access_from_form_group" if form_group_id.nil?
  # verify the required parameter 'office_id' is set
  fail ArgumentError, "Missing the required parameter 'office_id' when calling FormGroupsApi.revoke_office_access_from_form_group" if office_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.revoke_office_access_from_form_group" if account_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/revoke_office_access/{officeId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'officeId' + '}', office_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#revoke_office_access_from_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end