Class: DocuSign_Rooms::TaskListTemplatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_rooms/api/task_list_templates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = TaskListTemplatesApi.default) ⇒ TaskListTemplatesApi

Returns a new instance of TaskListTemplatesApi.



32
33
34
 
# File 'lib/docusign_rooms/api/task_list_templates_api.rb', line 32

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



30
31
32
 
# File 'lib/docusign_rooms/api/task_list_templates_api.rb', line 30

def api_client
  @api_client
end

Instance Method Details

#get_task_list_templates(account_id, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default) ⇒ TaskListTemplateList

Returns all task list templates for the company of the active user. Returns all task list templates for the company of the active user.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetTaskListTemplatesOptions —

    Options for modifying the behavior of the function.

Returns:



41
42
43
44
 
# File 'lib/docusign_rooms/api/task_list_templates_api.rb', line 41

def get_task_list_templates(, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default)
  data, _status_code, _headers = get_task_list_templates_with_http_info(, options)
  return data
end

#get_task_list_templates_with_http_info(account_id, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default) ⇒ Array<(TaskListTemplateList, Fixnum, Hash)>

Returns all task list templates for the company of the active user. Returns all task list templates for the company of the active user.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetTaskListTemplatesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    TaskListTemplateList data, response status code and response headers



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/docusign_rooms/api/task_list_templates_api.rb', line 51

def get_task_list_templates_with_http_info(, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TaskListTemplatesApi.get_task_list_templates ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling TaskListTemplatesApi.get_task_list_templates" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/task_list_templates".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # 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 = 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 => 'TaskListTemplateList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaskListTemplatesApi#get_task_list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end