docusign_rooms 1.1.0 → 1.2.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. data/CHANGELOG.md +6 -0
  2. data/docusign_rooms.gemspec +1 -0
  3. data/lib/docusign_rooms/api/accounts_api.rb +6 -4
  4. data/lib/docusign_rooms/api/activity_types_api.rb +4 -2
  5. data/lib/docusign_rooms/api/closing_statuses_api.rb +4 -2
  6. data/lib/docusign_rooms/api/contact_sides_api.rb +4 -2
  7. data/lib/docusign_rooms/api/countries_api.rb +4 -2
  8. data/lib/docusign_rooms/api/currencies_api.rb +4 -2
  9. data/lib/docusign_rooms/api/documents_api.rb +23 -19
  10. data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb +6 -4
  11. data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb +4 -4
  12. data/lib/docusign_rooms/api/fields_api.rb +9 -7
  13. data/lib/docusign_rooms/api/financing_types_api.rb +4 -2
  14. data/lib/docusign_rooms/api/form_details_api.rb +6 -4
  15. data/lib/docusign_rooms/api/form_groups_api.rb +68 -56
  16. data/lib/docusign_rooms/api/form_libraries_api.rb +12 -8
  17. data/lib/docusign_rooms/api/offices_api.rb +32 -24
  18. data/lib/docusign_rooms/api/origins_of_leads_api.rb +4 -2
  19. data/lib/docusign_rooms/api/property_types_api.rb +4 -2
  20. data/lib/docusign_rooms/api/regions_api.rb +30 -22
  21. data/lib/docusign_rooms/api/roles_api.rb +44 -31
  22. data/lib/docusign_rooms/api/room_contact_types_api.rb +4 -2
  23. data/lib/docusign_rooms/api/room_folders_api.rb +6 -4
  24. data/lib/docusign_rooms/api/room_templates_api.rb +7 -5
  25. data/lib/docusign_rooms/api/rooms_api.rb +147 -113
  26. data/lib/docusign_rooms/api/seller_decision_types_api.rb +4 -2
  27. data/lib/docusign_rooms/api/special_circumstance_types_api.rb +4 -2
  28. data/lib/docusign_rooms/api/states_api.rb +4 -2
  29. data/lib/docusign_rooms/api/task_date_types_api.rb +4 -2
  30. data/lib/docusign_rooms/api/task_list_templates_api.rb +8 -6
  31. data/lib/docusign_rooms/api/task_lists_api.rb +20 -16
  32. data/lib/docusign_rooms/api/task_responsibility_types_api.rb +4 -2
  33. data/lib/docusign_rooms/api/task_statuses_api.rb +4 -2
  34. data/lib/docusign_rooms/api/time_zones_api.rb +4 -2
  35. data/lib/docusign_rooms/api/transaction_sides_api.rb +4 -2
  36. data/lib/docusign_rooms/api/users_api.rb +81 -71
  37. data/lib/docusign_rooms/client/api_client.rb +3 -2
  38. data/lib/docusign_rooms/configuration.rb +2 -1
  39. data/lib/docusign_rooms/models/document.rb +13 -4
  40. data/lib/docusign_rooms/models/permissions.rb +10 -10
  41. data/lib/docusign_rooms/models/roles_filter_context_types.rb +30 -0
  42. data/lib/docusign_rooms/models/room_document.rb +10 -1
  43. data/lib/docusign_rooms/version.rb +1 -1
  44. data/lib/docusign_rooms.rb +1 -0
  45. data/runLinter.sh +1 -0
  46. metadata +101 -60
  47. checksums.yaml +0 -7
  48. data/Gemfile.lock +0 -71
  49. data/lib/.DS_Store +0 -0
  50. data/lib/docusign_rooms/.DS_Store +0 -0
  51. data/lib/docusign_rooms/client/.DS_Store +0 -0
  52. data/tests/Gemfile.lock +0 -42
  53. data/tests/docs/private.pem +0 -27
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid states.
25
- #
25
+ # Returns a list of states.
26
26
  # @return [GlobalStates]
27
27
  def get_states()
28
28
  data, _status_code, _headers = get_states_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid states.
33
- #
33
+ # Returns a list of states.
34
34
  # @return [Array<(GlobalStates, Fixnum, Hash)>] GlobalStates data, response status code and response headers
35
35
  def get_states_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid task date types.
25
- #
25
+ # Returns a list of date types that you can use with tasks, such as `Actual Close Date` and `Task Due Date`
26
26
  # @return [GlobalTaskDateTypes]
27
27
  def get_task_date_types()
28
28
  data, _status_code, _headers = get_task_date_types_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid task date types.
33
- #
33
+ # Returns a list of date types that you can use with tasks, such as &#x60;Actual Close Date&#x60; and &#x60;Task Due Date&#x60;
34
34
  # @return [Array<(GlobalTaskDateTypes, Fixnum, Hash)>] GlobalTaskDateTypes data, response status code and response headers
35
35
  def get_task_date_types_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}
@@ -14,10 +14,10 @@ require "uri"
14
14
  module DocuSign_Rooms
15
15
 
16
16
  class GetTaskListTemplatesOptions
17
- #
17
+ # The starting zero-based index position from which to start returning values. The default is `0`.
18
18
  attr_accessor :start_position
19
19
 
20
- #
20
+ # The number of results to return. This value must be a number between `1` and `100` (default).
21
21
  attr_accessor :count
22
22
 
23
23
  def self.default
@@ -34,8 +34,8 @@ module DocuSign_Rooms
34
34
  end
35
35
 
36
36
  # Returns all task list templates for the company of the active user.
37
- #
38
- # @param account_id
37
+ # Returns all task list templates for the company of the active user.
38
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
39
39
  # @param DocuSign_Rooms::GetTaskListTemplatesOptions Options for modifying the behavior of the function.
40
40
  # @return [TaskListTemplateList]
41
41
  def get_task_list_templates(account_id, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default)
@@ -44,8 +44,8 @@ module DocuSign_Rooms
44
44
  end
45
45
 
46
46
  # Returns all task list templates for the company of the active user.
47
- #
48
- # @param account_id
47
+ # Returns all task list templates for the company of the active user.
48
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
49
49
  # @param DocuSign_Rooms::GetTaskListTemplatesOptions Options for modifying the behavior of the function.
50
50
  # @return [Array<(TaskListTemplateList, Fixnum, Hash)>] TaskListTemplateList data, response status code and response headers
51
51
  def get_task_list_templates_with_http_info(account_id, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default)
@@ -66,6 +66,8 @@ module DocuSign_Rooms
66
66
  header_params = {}
67
67
  # HTTP header 'Accept' (if needed)
68
68
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
69
+ # HTTP header 'Content-Type'
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
69
71
 
70
72
  # form parameters
71
73
  form_params = {}
@@ -22,9 +22,9 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Add a task list to a room based on a task list template.
25
- #
25
+ # Applies a task list to a room, based on the `taskTemplateId` that you specify in the `taskList` request body.
26
26
  # @param room_id Room ID.
27
- # @param account_id
27
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
28
28
  # @param body (optional parameter)
29
29
  # @return [TaskList]
30
30
  def create_task_list(room_id, account_id, body)
@@ -33,9 +33,9 @@ module DocuSign_Rooms
33
33
  end
34
34
 
35
35
  # Add a task list to a room based on a task list template.
36
- #
36
+ # Applies a task list to a room, based on the &#x60;taskTemplateId&#x60; that you specify in the &#x60;taskList&#x60; request body.
37
37
  # @param room_id Room ID.
38
- # @param account_id
38
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
39
39
  # @param body (optional parameter)
40
40
  # @return [Array<(TaskList, Fixnum, Hash)>] TaskList data, response status code and response headers
41
41
  def create_task_list_with_http_info(room_id, account_id, body)
@@ -78,20 +78,20 @@ module DocuSign_Rooms
78
78
  return data, status_code, headers
79
79
  end
80
80
 
81
- # Deletes a task list. If there are attached documents they will remain in the associated
82
- #
81
+ # Deletes a task list. If there are attached documents they will remain in the associated room.
82
+ # Deletes the specified task list from a room. If there are attached documents, they will remain in the associated room.
83
83
  # @param task_list_id Task List ID
84
- # @param account_id
84
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
85
85
  # @return [nil]
86
86
  def delete_task_list(task_list_id, account_id)
87
87
  delete_task_list_with_http_info(task_list_id, account_id)
88
88
  return nil
89
89
  end
90
90
 
91
- # Deletes a task list. If there are attached documents they will remain in the associated
92
- #
91
+ # Deletes a task list. If there are attached documents they will remain in the associated room.
92
+ # Deletes the specified task list from a room. If there are attached documents, they will remain in the associated room.
93
93
  # @param task_list_id Task List ID
94
- # @param account_id
94
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
95
95
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
96
96
  def delete_task_list_with_http_info(task_list_id, account_id)
97
97
  if @api_client.config.debugging
@@ -111,6 +111,8 @@ module DocuSign_Rooms
111
111
  header_params = {}
112
112
  # HTTP header 'Accept' (if needed)
113
113
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
114
+ # HTTP header 'Content-Type'
115
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
114
116
 
115
117
  # form parameters
116
118
  form_params = {}
@@ -130,20 +132,20 @@ module DocuSign_Rooms
130
132
  return data, status_code, headers
131
133
  end
132
134
 
133
- # Returns the summary for all viewable task lists in a
134
- #
135
+ # Returns the summary for all viewable task lists in a room.
136
+ # Returns the task lists associated with a room.
135
137
  # @param room_id Room ID
136
- # @param account_id
138
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
137
139
  # @return [TaskListSummaryList]
138
140
  def get_task_lists(room_id, account_id)
139
141
  data, _status_code, _headers = get_task_lists_with_http_info(room_id, account_id)
140
142
  return data
141
143
  end
142
144
 
143
- # Returns the summary for all viewable task lists in a
144
- #
145
+ # Returns the summary for all viewable task lists in a room.
146
+ # Returns the task lists associated with a room.
145
147
  # @param room_id Room ID
146
- # @param account_id
148
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
147
149
  # @return [Array<(TaskListSummaryList, Fixnum, Hash)>] TaskListSummaryList data, response status code and response headers
148
150
  def get_task_lists_with_http_info(room_id, account_id)
149
151
  if @api_client.config.debugging
@@ -163,6 +165,8 @@ module DocuSign_Rooms
163
165
  header_params = {}
164
166
  # HTTP header 'Accept' (if needed)
165
167
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
168
+ # HTTP header 'Content-Type'
169
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
166
170
 
167
171
  # form parameters
168
172
  form_params = {}
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid task responsibility types.
25
- #
25
+ # Returns a list of responsibility types that you can assign to users when you add them to a task.
26
26
  # @return [GlobalTaskResponsibilityTypes]
27
27
  def get_task_responsibility_types()
28
28
  data, _status_code, _headers = get_task_responsibility_types_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid task responsibility types.
33
- #
33
+ # Returns a list of responsibility types that you can assign to users when you add them to a task.
34
34
  # @return [Array<(GlobalTaskResponsibilityTypes, Fixnum, Hash)>] GlobalTaskResponsibilityTypes data, response status code and response headers
35
35
  def get_task_responsibility_types_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid task statuses.
25
- #
25
+ # Returns a list of valid task statuses.
26
26
  # @return [GlobalTaskStatuses]
27
27
  def get_task_statuses()
28
28
  data, _status_code, _headers = get_task_statuses_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid task statuses.
33
- #
33
+ # Returns a list of valid task statuses.
34
34
  # @return [Array<(GlobalTaskStatuses, Fixnum, Hash)>] GlobalTaskStatuses data, response status code and response headers
35
35
  def get_task_statuses_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid time zones.
25
- #
25
+ # Gets a list of time zones that you can assign to an office.
26
26
  # @return [GlobalTimeZones]
27
27
  def get_time_zones()
28
28
  data, _status_code, _headers = get_time_zones_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid time zones.
33
- #
33
+ # Gets a list of time zones that you can assign to an office.
34
34
  # @return [Array<(GlobalTimeZones, Fixnum, Hash)>] GlobalTimeZones data, response status code and response headers
35
35
  def get_time_zones_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid transaction sides.
25
- #
25
+ # Returns a list of valid transaction sides.
26
26
  # @return [GlobalTransactionSides]
27
27
  def get_transaction_sides()
28
28
  data, _status_code, _headers = get_transaction_sides_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid transaction sides.
33
- #
33
+ # Returns a list of valid transaction sides.
34
34
  # @return [Array<(GlobalTransactionSides, Fixnum, Hash)>] GlobalTransactionSides data, response status code and response headers
35
35
  def get_transaction_sides_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}