docusign_rooms 1.0.0.beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (177) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +66 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +71 -0
  5. data/LICENSE +21 -0
  6. data/README.md +80 -0
  7. data/Rakefile +8 -0
  8. data/docusign_rooms-1.0.0.pre.alpha.gem +0 -0
  9. data/docusign_rooms.gemspec +45 -0
  10. data/git_push.sh +55 -0
  11. data/lib/.DS_Store +0 -0
  12. data/lib/docusign_rooms.rb +193 -0
  13. data/lib/docusign_rooms/.DS_Store +0 -0
  14. data/lib/docusign_rooms/api/accounts_api.rb +73 -0
  15. data/lib/docusign_rooms/api/activity_types_api.rb +69 -0
  16. data/lib/docusign_rooms/api/closing_statuses_api.rb +69 -0
  17. data/lib/docusign_rooms/api/contact_sides_api.rb +69 -0
  18. data/lib/docusign_rooms/api/countries_api.rb +69 -0
  19. data/lib/docusign_rooms/api/currencies_api.rb +69 -0
  20. data/lib/docusign_rooms/api/documents_api.rb +200 -0
  21. data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb +73 -0
  22. data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb +79 -0
  23. data/lib/docusign_rooms/api/fields_api.rb +92 -0
  24. data/lib/docusign_rooms/api/financing_types_api.rb +69 -0
  25. data/lib/docusign_rooms/api/form_details_api.rb +77 -0
  26. data/lib/docusign_rooms/api/form_groups_api.rb +89 -0
  27. data/lib/docusign_rooms/api/form_libraries_api.rb +158 -0
  28. data/lib/docusign_rooms/api/offices_api.rb +310 -0
  29. data/lib/docusign_rooms/api/origins_of_leads_api.rb +69 -0
  30. data/lib/docusign_rooms/api/property_types_api.rb +69 -0
  31. data/lib/docusign_rooms/api/regions_api.rb +306 -0
  32. data/lib/docusign_rooms/api/roles_api.rb +328 -0
  33. data/lib/docusign_rooms/api/room_contact_types_api.rb +69 -0
  34. data/lib/docusign_rooms/api/room_folders_api.rb +93 -0
  35. data/lib/docusign_rooms/api/room_templates_api.rb +97 -0
  36. data/lib/docusign_rooms/api/rooms_api.rb +1146 -0
  37. data/lib/docusign_rooms/api/seller_decision_types_api.rb +69 -0
  38. data/lib/docusign_rooms/api/special_circumstance_types_api.rb +69 -0
  39. data/lib/docusign_rooms/api/states_api.rb +69 -0
  40. data/lib/docusign_rooms/api/task_date_types_api.rb +69 -0
  41. data/lib/docusign_rooms/api/task_list_templates_api.rb +89 -0
  42. data/lib/docusign_rooms/api/task_lists_api.rb +188 -0
  43. data/lib/docusign_rooms/api/task_responsibility_types_api.rb +69 -0
  44. data/lib/docusign_rooms/api/task_statuses_api.rb +69 -0
  45. data/lib/docusign_rooms/api/time_zones_api.rb +69 -0
  46. data/lib/docusign_rooms/api/transaction_sides_api.rb +69 -0
  47. data/lib/docusign_rooms/api/users_api.rb +908 -0
  48. data/lib/docusign_rooms/client/.DS_Store +0 -0
  49. data/lib/docusign_rooms/client/api_client.rb +590 -0
  50. data/lib/docusign_rooms/client/api_error.rb +37 -0
  51. data/lib/docusign_rooms/client/auth/oauth.rb +1061 -0
  52. data/lib/docusign_rooms/configuration.rb +202 -0
  53. data/lib/docusign_rooms/models/account_summary.rb +262 -0
  54. data/lib/docusign_rooms/models/activity_type.rb +192 -0
  55. data/lib/docusign_rooms/models/api_error.rb +192 -0
  56. data/lib/docusign_rooms/models/assignable_roles.rb +239 -0
  57. data/lib/docusign_rooms/models/classic_admin_to_invite.rb +216 -0
  58. data/lib/docusign_rooms/models/classic_agent_to_invite.rb +240 -0
  59. data/lib/docusign_rooms/models/classic_manager_permissions.rb +291 -0
  60. data/lib/docusign_rooms/models/classic_manager_to_invite.rb +338 -0
  61. data/lib/docusign_rooms/models/closing_status.rb +192 -0
  62. data/lib/docusign_rooms/models/contact_side.rb +192 -0
  63. data/lib/docusign_rooms/models/country.rb +192 -0
  64. data/lib/docusign_rooms/models/currency.rb +192 -0
  65. data/lib/docusign_rooms/models/custom_data.rb +192 -0
  66. data/lib/docusign_rooms/models/depends_on.rb +192 -0
  67. data/lib/docusign_rooms/models/designated_office.rb +188 -0
  68. data/lib/docusign_rooms/models/designated_region.rb +188 -0
  69. data/lib/docusign_rooms/models/document.rb +265 -0
  70. data/lib/docusign_rooms/models/document_user.rb +291 -0
  71. data/lib/docusign_rooms/models/document_user_for_create.rb +188 -0
  72. data/lib/docusign_rooms/models/e_sign_account_role_settings.rb +183 -0
  73. data/lib/docusign_rooms/models/e_sign_permission_profile.rb +201 -0
  74. data/lib/docusign_rooms/models/e_sign_permission_profile_list.rb +185 -0
  75. data/lib/docusign_rooms/models/external_form_fill_session.rb +183 -0
  76. data/lib/docusign_rooms/models/external_form_fill_session_for_create.rb +211 -0
  77. data/lib/docusign_rooms/models/field.rb +248 -0
  78. data/lib/docusign_rooms/models/field_configuration.rb +259 -0
  79. data/lib/docusign_rooms/models/field_data.rb +185 -0
  80. data/lib/docusign_rooms/models/field_data_for_create.rb +185 -0
  81. data/lib/docusign_rooms/models/field_data_for_update.rb +185 -0
  82. data/lib/docusign_rooms/models/field_set.rb +203 -0
  83. data/lib/docusign_rooms/models/financing_type.rb +192 -0
  84. data/lib/docusign_rooms/models/form_details.rb +246 -0
  85. data/lib/docusign_rooms/models/form_for_add.rb +188 -0
  86. data/lib/docusign_rooms/models/form_group_summary.rb +201 -0
  87. data/lib/docusign_rooms/models/form_group_summary_list.rb +230 -0
  88. data/lib/docusign_rooms/models/form_library_summary.rb +201 -0
  89. data/lib/docusign_rooms/models/form_library_summary_list.rb +230 -0
  90. data/lib/docusign_rooms/models/form_summary.rb +201 -0
  91. data/lib/docusign_rooms/models/form_summary_list.rb +230 -0
  92. data/lib/docusign_rooms/models/global_activity_types.rb +185 -0
  93. data/lib/docusign_rooms/models/global_closing_statuses.rb +185 -0
  94. data/lib/docusign_rooms/models/global_contact_sides.rb +185 -0
  95. data/lib/docusign_rooms/models/global_countries.rb +185 -0
  96. data/lib/docusign_rooms/models/global_currencies.rb +185 -0
  97. data/lib/docusign_rooms/models/global_financing_types.rb +185 -0
  98. data/lib/docusign_rooms/models/global_origins_of_leads.rb +185 -0
  99. data/lib/docusign_rooms/models/global_property_types.rb +185 -0
  100. data/lib/docusign_rooms/models/global_room_contact_types.rb +185 -0
  101. data/lib/docusign_rooms/models/global_seller_decision_types.rb +185 -0
  102. data/lib/docusign_rooms/models/global_special_circumstance_types.rb +185 -0
  103. data/lib/docusign_rooms/models/global_states.rb +185 -0
  104. data/lib/docusign_rooms/models/global_task_date_types.rb +185 -0
  105. data/lib/docusign_rooms/models/global_task_responsibility_types.rb +185 -0
  106. data/lib/docusign_rooms/models/global_task_statuses.rb +185 -0
  107. data/lib/docusign_rooms/models/global_time_zones.rb +185 -0
  108. data/lib/docusign_rooms/models/global_transaction_sides.rb +185 -0
  109. data/lib/docusign_rooms/models/locked_out_details.rb +188 -0
  110. data/lib/docusign_rooms/models/nullable_field_data.rb +185 -0
  111. data/lib/docusign_rooms/models/nullable_permissions.rb +660 -0
  112. data/lib/docusign_rooms/models/office.rb +287 -0
  113. data/lib/docusign_rooms/models/office_for_create.rb +269 -0
  114. data/lib/docusign_rooms/models/office_reference_count.rb +192 -0
  115. data/lib/docusign_rooms/models/office_reference_count_list.rb +185 -0
  116. data/lib/docusign_rooms/models/office_summary.rb +282 -0
  117. data/lib/docusign_rooms/models/office_summary_list.rb +230 -0
  118. data/lib/docusign_rooms/models/origin_of_lead.rb +192 -0
  119. data/lib/docusign_rooms/models/permissions.rb +660 -0
  120. data/lib/docusign_rooms/models/property_type.rb +192 -0
  121. data/lib/docusign_rooms/models/region.rb +206 -0
  122. data/lib/docusign_rooms/models/region_reference_count.rb +192 -0
  123. data/lib/docusign_rooms/models/region_reference_count_list.rb +185 -0
  124. data/lib/docusign_rooms/models/region_summary.rb +201 -0
  125. data/lib/docusign_rooms/models/region_summary_list.rb +230 -0
  126. data/lib/docusign_rooms/models/role.rb +246 -0
  127. data/lib/docusign_rooms/models/role_for_create.rb +201 -0
  128. data/lib/docusign_rooms/models/role_for_update.rb +201 -0
  129. data/lib/docusign_rooms/models/role_summary.rb +228 -0
  130. data/lib/docusign_rooms/models/role_summary_list.rb +230 -0
  131. data/lib/docusign_rooms/models/room.rb +282 -0
  132. data/lib/docusign_rooms/models/room_contact_type.rb +192 -0
  133. data/lib/docusign_rooms/models/room_document.rb +246 -0
  134. data/lib/docusign_rooms/models/room_document_list.rb +230 -0
  135. data/lib/docusign_rooms/models/room_folder.rb +201 -0
  136. data/lib/docusign_rooms/models/room_folder_list.rb +230 -0
  137. data/lib/docusign_rooms/models/room_for_create.rb +248 -0
  138. data/lib/docusign_rooms/models/room_invite.rb +240 -0
  139. data/lib/docusign_rooms/models/room_invite_response.rb +237 -0
  140. data/lib/docusign_rooms/models/room_picture.rb +183 -0
  141. data/lib/docusign_rooms/models/room_summary.rb +273 -0
  142. data/lib/docusign_rooms/models/room_summary_list.rb +230 -0
  143. data/lib/docusign_rooms/models/room_template.rb +201 -0
  144. data/lib/docusign_rooms/models/room_templates_summary_list.rb +230 -0
  145. data/lib/docusign_rooms/models/room_user.rb +246 -0
  146. data/lib/docusign_rooms/models/room_user_for_update.rb +192 -0
  147. data/lib/docusign_rooms/models/room_user_removal_detail.rb +183 -0
  148. data/lib/docusign_rooms/models/room_user_summary.rb +237 -0
  149. data/lib/docusign_rooms/models/room_users_result.rb +230 -0
  150. data/lib/docusign_rooms/models/select_list_field_option.rb +201 -0
  151. data/lib/docusign_rooms/models/seller_decision_type.rb +192 -0
  152. data/lib/docusign_rooms/models/special_circumstance_type.rb +192 -0
  153. data/lib/docusign_rooms/models/state.rb +192 -0
  154. data/lib/docusign_rooms/models/task_date_type.rb +192 -0
  155. data/lib/docusign_rooms/models/task_list.rb +275 -0
  156. data/lib/docusign_rooms/models/task_list_for_create.rb +183 -0
  157. data/lib/docusign_rooms/models/task_list_summary.rb +264 -0
  158. data/lib/docusign_rooms/models/task_list_summary_list.rb +185 -0
  159. data/lib/docusign_rooms/models/task_list_template.rb +210 -0
  160. data/lib/docusign_rooms/models/task_list_template_list.rb +230 -0
  161. data/lib/docusign_rooms/models/task_responsibility_type.rb +192 -0
  162. data/lib/docusign_rooms/models/task_status.rb +192 -0
  163. data/lib/docusign_rooms/models/task_summary.rb +291 -0
  164. data/lib/docusign_rooms/models/time_zone.rb +192 -0
  165. data/lib/docusign_rooms/models/transaction_side.rb +192 -0
  166. data/lib/docusign_rooms/models/user.rb +338 -0
  167. data/lib/docusign_rooms/models/user_for_update.rb +188 -0
  168. data/lib/docusign_rooms/models/user_summary.rb +307 -0
  169. data/lib/docusign_rooms/models/user_summary_list.rb +230 -0
  170. data/lib/docusign_rooms/models/user_to_invite.rb +337 -0
  171. data/lib/docusign_rooms/version.rb +14 -0
  172. data/tests/Gemfile +5 -0
  173. data/tests/Gemfile.lock +42 -0
  174. data/tests/docs/Test.pdf +0 -0
  175. data/tests/docs/private.pem +27 -0
  176. data/tests/spec/unit_tests_using_jwt_spec.rb +125 -0
  177. metadata +420 -0
@@ -0,0 +1,69 @@
1
+ =begin
2
+ #DocuSign Rooms API - v2
3
+
4
+ #An API for an integrator to access the features of DocuSign Rooms
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module DocuSign_Rooms
15
+
16
+
17
+ class TaskResponsibilityTypesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = TaskResponsibilityTypesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid task responsibility types.
25
+ #
26
+ # @return [GlobalTaskResponsibilityTypes]
27
+ def get_task_responsibility_types()
28
+ data, _status_code, _headers = get_task_responsibility_types_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid task responsibility types.
33
+ #
34
+ # @return [Array<(GlobalTaskResponsibilityTypes, Fixnum, Hash)>] GlobalTaskResponsibilityTypes data, response status code and response headers
35
+ def get_task_responsibility_types_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: TaskResponsibilityTypesApi.get_task_responsibility_types ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/task_responsibility_types".sub('{format}','json')
41
+
42
+ # query parameters
43
+ query_params = {}
44
+
45
+ # header parameters
46
+ header_params = {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = {}
52
+
53
+ # http body (model)
54
+ post_body = nil
55
+ auth_names = []
56
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names,
62
+ :return_type => 'GlobalTaskResponsibilityTypes')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: TaskResponsibilityTypesApi#get_task_responsibility_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
+ end
66
+ return data, status_code, headers
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,69 @@
1
+ =begin
2
+ #DocuSign Rooms API - v2
3
+
4
+ #An API for an integrator to access the features of DocuSign Rooms
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module DocuSign_Rooms
15
+
16
+
17
+ class TaskStatusesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = TaskStatusesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid task statuses.
25
+ #
26
+ # @return [GlobalTaskStatuses]
27
+ def get_task_statuses()
28
+ data, _status_code, _headers = get_task_statuses_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid task statuses.
33
+ #
34
+ # @return [Array<(GlobalTaskStatuses, Fixnum, Hash)>] GlobalTaskStatuses data, response status code and response headers
35
+ def get_task_statuses_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: TaskStatusesApi.get_task_statuses ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/task_statuses".sub('{format}','json')
41
+
42
+ # query parameters
43
+ query_params = {}
44
+
45
+ # header parameters
46
+ header_params = {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = {}
52
+
53
+ # http body (model)
54
+ post_body = nil
55
+ auth_names = []
56
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names,
62
+ :return_type => 'GlobalTaskStatuses')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: TaskStatusesApi#get_task_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
+ end
66
+ return data, status_code, headers
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,69 @@
1
+ =begin
2
+ #DocuSign Rooms API - v2
3
+
4
+ #An API for an integrator to access the features of DocuSign Rooms
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module DocuSign_Rooms
15
+
16
+
17
+ class TimeZonesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = TimeZonesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid time zones.
25
+ #
26
+ # @return [GlobalTimeZones]
27
+ def get_time_zones()
28
+ data, _status_code, _headers = get_time_zones_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid time zones.
33
+ #
34
+ # @return [Array<(GlobalTimeZones, Fixnum, Hash)>] GlobalTimeZones data, response status code and response headers
35
+ def get_time_zones_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: TimeZonesApi.get_time_zones ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/time_zones".sub('{format}','json')
41
+
42
+ # query parameters
43
+ query_params = {}
44
+
45
+ # header parameters
46
+ header_params = {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = {}
52
+
53
+ # http body (model)
54
+ post_body = nil
55
+ auth_names = []
56
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names,
62
+ :return_type => 'GlobalTimeZones')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: TimeZonesApi#get_time_zones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
+ end
66
+ return data, status_code, headers
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,69 @@
1
+ =begin
2
+ #DocuSign Rooms API - v2
3
+
4
+ #An API for an integrator to access the features of DocuSign Rooms
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module DocuSign_Rooms
15
+
16
+
17
+ class TransactionSidesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = TransactionSidesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid transaction sides.
25
+ #
26
+ # @return [GlobalTransactionSides]
27
+ def get_transaction_sides()
28
+ data, _status_code, _headers = get_transaction_sides_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid transaction sides.
33
+ #
34
+ # @return [Array<(GlobalTransactionSides, Fixnum, Hash)>] GlobalTransactionSides data, response status code and response headers
35
+ def get_transaction_sides_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: TransactionSidesApi.get_transaction_sides ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/transaction_sides".sub('{format}','json')
41
+
42
+ # query parameters
43
+ query_params = {}
44
+
45
+ # header parameters
46
+ header_params = {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = {}
52
+
53
+ # http body (model)
54
+ post_body = nil
55
+ auth_names = []
56
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names,
62
+ :return_type => 'GlobalTransactionSides')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: TransactionSidesApi#get_transaction_sides\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
+ end
66
+ return data, status_code, headers
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,908 @@
1
+ =begin
2
+ #DocuSign Rooms API - v2
3
+
4
+ #An API for an integrator to access the features of DocuSign Rooms
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module DocuSign_Rooms
15
+
16
+ class GetUsersOptions
17
+ # Filters by name and email
18
+ attr_accessor :filter
19
+
20
+ # Valid values are 'FirstNameAsc', 'FirstNameDesc', 'LastNameAsc', 'LastNameDesc', 'EmailAsc', 'EmailDesc'
21
+ attr_accessor :sort
22
+
23
+ #
24
+ attr_accessor :default_office_id
25
+
26
+ # Valid values are 'Company', 'Region', 'Office', 'Contributor'
27
+ attr_accessor :access_level
28
+
29
+ # Only valid for classic companies
30
+ attr_accessor :title_id
31
+
32
+ # Only valid for next gen companies
33
+ attr_accessor :role_id
34
+
35
+ # Valid values are 'Active', 'Pending'
36
+ attr_accessor :status
37
+
38
+ #
39
+ attr_accessor :locked_only
40
+
41
+ # Defaults to 0
42
+ attr_accessor :start_position
43
+
44
+ # Defaults to 100. Must be less than or equal to 100
45
+ attr_accessor :count
46
+
47
+ def self.default
48
+ @@default ||= GetUsersOptions.new
49
+ end
50
+ end
51
+
52
+
53
+ class UsersApi
54
+ attr_accessor :api_client
55
+
56
+ def initialize(api_client = UsersApi.default)
57
+ @api_client = api_client
58
+ end
59
+
60
+ # Adds the user to the designated office.
61
+ #
62
+ # @param user_id
63
+ # @param account_id
64
+ # @param designated_office
65
+ # @return [nil]
66
+ def add_user_to_office(user_id, account_id, designated_office)
67
+ add_user_to_office_with_http_info(user_id, account_id, designated_office)
68
+ return nil
69
+ end
70
+
71
+ # Adds the user to the designated office.
72
+ #
73
+ # @param user_id
74
+ # @param account_id
75
+ # @param designated_office
76
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
77
+ def add_user_to_office_with_http_info(user_id, account_id, designated_office)
78
+ if @api_client.config.debugging
79
+ @api_client.config.logger.debug "Calling API: UsersApi.add_user_to_office ..."
80
+ end
81
+ # verify the required parameter 'user_id' is set
82
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.add_user_to_office" if user_id.nil?
83
+ # verify the required parameter 'designated_office' is set
84
+ fail ArgumentError, "Missing the required parameter 'designated_office' when calling UsersApi.add_user_to_office" if designated_office.nil?
85
+ # verify the required parameter 'account_id' is set
86
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.add_user_to_office" if account_id.nil?
87
+ # resource path
88
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/add_to_office".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
89
+
90
+ # query parameters
91
+ query_params = {}
92
+
93
+ # header parameters
94
+ header_params = {}
95
+ # HTTP header 'Accept' (if needed)
96
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
97
+ # HTTP header 'Content-Type'
98
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
99
+
100
+ # form parameters
101
+ form_params = {}
102
+
103
+ # http body (model)
104
+ post_body = @api_client.object_to_http_body(designated_office)
105
+ auth_names = []
106
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
107
+ :header_params => header_params,
108
+ :query_params => query_params,
109
+ :form_params => form_params,
110
+ :body => post_body,
111
+ :auth_names => auth_names)
112
+ if @api_client.config.debugging
113
+ @api_client.config.logger.debug "API called: UsersApi#add_user_to_office\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
114
+ end
115
+ return data, status_code, headers
116
+ end
117
+
118
+ # Adds the user to the designated region.
119
+ #
120
+ # @param user_id
121
+ # @param account_id
122
+ # @param designated_region
123
+ # @return [nil]
124
+ def add_user_to_region(user_id, account_id, designated_region)
125
+ add_user_to_region_with_http_info(user_id, account_id, designated_region)
126
+ return nil
127
+ end
128
+
129
+ # Adds the user to the designated region.
130
+ #
131
+ # @param user_id
132
+ # @param account_id
133
+ # @param designated_region
134
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
135
+ def add_user_to_region_with_http_info(user_id, account_id, designated_region)
136
+ if @api_client.config.debugging
137
+ @api_client.config.logger.debug "Calling API: UsersApi.add_user_to_region ..."
138
+ end
139
+ # verify the required parameter 'user_id' is set
140
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.add_user_to_region" if user_id.nil?
141
+ # verify the required parameter 'designated_region' is set
142
+ fail ArgumentError, "Missing the required parameter 'designated_region' when calling UsersApi.add_user_to_region" if designated_region.nil?
143
+ # verify the required parameter 'account_id' is set
144
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.add_user_to_region" if account_id.nil?
145
+ # resource path
146
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/add_to_region".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
147
+
148
+ # query parameters
149
+ query_params = {}
150
+
151
+ # header parameters
152
+ header_params = {}
153
+ # HTTP header 'Accept' (if needed)
154
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
155
+ # HTTP header 'Content-Type'
156
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
157
+
158
+ # form parameters
159
+ form_params = {}
160
+
161
+ # http body (model)
162
+ post_body = @api_client.object_to_http_body(designated_region)
163
+ auth_names = []
164
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
165
+ :header_params => header_params,
166
+ :query_params => query_params,
167
+ :form_params => form_params,
168
+ :body => post_body,
169
+ :auth_names => auth_names)
170
+ if @api_client.config.debugging
171
+ @api_client.config.logger.debug "API called: UsersApi#add_user_to_region\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
172
+ end
173
+ return data, status_code, headers
174
+ end
175
+
176
+ # Retrieves user information for the user having the given UserId.
177
+ #
178
+ # @param user_id
179
+ # @param account_id
180
+ # @return [User]
181
+ def get_user(user_id, account_id)
182
+ data, _status_code, _headers = get_user_with_http_info(user_id, account_id)
183
+ return data
184
+ end
185
+
186
+ # Retrieves user information for the user having the given UserId.
187
+ #
188
+ # @param user_id
189
+ # @param account_id
190
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
191
+ def get_user_with_http_info(user_id, account_id)
192
+ if @api_client.config.debugging
193
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user ..."
194
+ end
195
+ # verify the required parameter 'user_id' is set
196
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user" if user_id.nil?
197
+ # verify the required parameter 'account_id' is set
198
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_user" if account_id.nil?
199
+ # resource path
200
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
201
+
202
+ # query parameters
203
+ query_params = {}
204
+
205
+ # header parameters
206
+ header_params = {}
207
+ # HTTP header 'Accept' (if needed)
208
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
209
+
210
+ # form parameters
211
+ form_params = {}
212
+
213
+ # http body (model)
214
+ post_body = nil
215
+ auth_names = []
216
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
217
+ :header_params => header_params,
218
+ :query_params => query_params,
219
+ :form_params => form_params,
220
+ :body => post_body,
221
+ :auth_names => auth_names,
222
+ :return_type => 'User')
223
+ if @api_client.config.debugging
224
+ @api_client.config.logger.debug "API called: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
225
+ end
226
+ return data, status_code, headers
227
+ end
228
+
229
+ # Gets a paged-list of users.
230
+ # Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.
231
+ # @param account_id
232
+ # @param DocuSign_Rooms::GetUsersOptions Options for modifying the behavior of the function.
233
+ # @return [UserSummaryList]
234
+ def get_users(account_id, options = DocuSign_Rooms::GetUsersOptions.default)
235
+ data, _status_code, _headers = get_users_with_http_info(account_id, options)
236
+ return data
237
+ end
238
+
239
+ # Gets a paged-list of users.
240
+ # Retrieves a paged-list of Company Users in the User&#39;s company using the given filter and sort parameters.
241
+ # @param account_id
242
+ # @param DocuSign_Rooms::GetUsersOptions Options for modifying the behavior of the function.
243
+ # @return [Array<(UserSummaryList, Fixnum, Hash)>] UserSummaryList data, response status code and response headers
244
+ def get_users_with_http_info(account_id, options = DocuSign_Rooms::GetUsersOptions.default)
245
+ if @api_client.config.debugging
246
+ @api_client.config.logger.debug "Calling API: UsersApi.get_users ..."
247
+ end
248
+ # verify the required parameter 'account_id' is set
249
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_users" if account_id.nil?
250
+ if options.sort && !['FirstNameAsc', 'LastNameAsc', 'EmailAsc', 'FirstNameDesc', 'LastNameDesc', 'EmailDesc'].include?(options.sort)
251
+ fail ArgumentError, 'invalid value for "sort", must be one of FirstNameAsc, LastNameAsc, EmailAsc, FirstNameDesc, LastNameDesc, EmailDesc'
252
+ end
253
+ if options.access_level && !['Contributor', 'Office', 'Region', 'Company', 'Admin'].include?(options.access_level)
254
+ fail ArgumentError, 'invalid value for "access_level", must be one of Contributor, Office, Region, Company, Admin'
255
+ end
256
+ if options.status && !['Active', 'Pending'].include?(options.status)
257
+ fail ArgumentError, 'invalid value for "status", must be one of Active, Pending'
258
+ end
259
+ # resource path
260
+ local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
261
+
262
+ # query parameters
263
+ query_params = {}
264
+ query_params[:'filter'] = options.filter if !options.filter.nil?
265
+ query_params[:'sort'] = options.sort if !options.sort.nil?
266
+ query_params[:'defaultOfficeId'] = options.default_office_id if !options.default_office_id.nil?
267
+ query_params[:'accessLevel'] = options.access_level if !options.access_level.nil?
268
+ query_params[:'titleId'] = options.title_id if !options.title_id.nil?
269
+ query_params[:'roleId'] = options.role_id if !options.role_id.nil?
270
+ query_params[:'status'] = options.status if !options.status.nil?
271
+ query_params[:'lockedOnly'] = options.locked_only if !options.locked_only.nil?
272
+ query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
273
+ query_params[:'count'] = options.count if !options.count.nil?
274
+
275
+ # header parameters
276
+ header_params = {}
277
+ # HTTP header 'Accept' (if needed)
278
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
279
+
280
+ # form parameters
281
+ form_params = {}
282
+
283
+ # http body (model)
284
+ post_body = nil
285
+ auth_names = []
286
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
287
+ :header_params => header_params,
288
+ :query_params => query_params,
289
+ :form_params => form_params,
290
+ :body => post_body,
291
+ :auth_names => auth_names,
292
+ :return_type => 'UserSummaryList')
293
+ if @api_client.config.debugging
294
+ @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
295
+ end
296
+ return data, status_code, headers
297
+ end
298
+
299
+ # CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.
300
+ #
301
+ # @param account_id
302
+ # @param invitee Invitee information.
303
+ # @return [User]
304
+ def invite_classic_admin(account_id, invitee)
305
+ data, _status_code, _headers = invite_classic_admin_with_http_info(account_id, invitee)
306
+ return data
307
+ end
308
+
309
+ # CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.
310
+ #
311
+ # @param account_id
312
+ # @param invitee Invitee information.
313
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
314
+ def invite_classic_admin_with_http_info(account_id, invitee)
315
+ if @api_client.config.debugging
316
+ @api_client.config.logger.debug "Calling API: UsersApi.invite_classic_admin ..."
317
+ end
318
+ # verify the required parameter 'invitee' is set
319
+ fail ArgumentError, "Missing the required parameter 'invitee' when calling UsersApi.invite_classic_admin" if invitee.nil?
320
+ # verify the required parameter 'account_id' is set
321
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_admin" if account_id.nil?
322
+ # resource path
323
+ local_var_path = "/v2/accounts/{accountId}/users/invite_classic_admin".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
324
+
325
+ # query parameters
326
+ query_params = {}
327
+
328
+ # header parameters
329
+ header_params = {}
330
+ # HTTP header 'Accept' (if needed)
331
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
332
+ # HTTP header 'Content-Type'
333
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
334
+
335
+ # form parameters
336
+ form_params = {}
337
+
338
+ # http body (model)
339
+ post_body = @api_client.object_to_http_body(invitee)
340
+ auth_names = []
341
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
342
+ :header_params => header_params,
343
+ :query_params => query_params,
344
+ :form_params => form_params,
345
+ :body => post_body,
346
+ :auth_names => auth_names,
347
+ :return_type => 'User')
348
+ if @api_client.config.debugging
349
+ @api_client.config.logger.debug "API called: UsersApi#invite_classic_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
350
+ end
351
+ return data, status_code, headers
352
+ end
353
+
354
+ # CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.
355
+ #
356
+ # @param account_id
357
+ # @param invitee Invitee information.
358
+ # @return [User]
359
+ def invite_classic_agent(account_id, invitee)
360
+ data, _status_code, _headers = invite_classic_agent_with_http_info(account_id, invitee)
361
+ return data
362
+ end
363
+
364
+ # CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.
365
+ #
366
+ # @param account_id
367
+ # @param invitee Invitee information.
368
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
369
+ def invite_classic_agent_with_http_info(account_id, invitee)
370
+ if @api_client.config.debugging
371
+ @api_client.config.logger.debug "Calling API: UsersApi.invite_classic_agent ..."
372
+ end
373
+ # verify the required parameter 'invitee' is set
374
+ fail ArgumentError, "Missing the required parameter 'invitee' when calling UsersApi.invite_classic_agent" if invitee.nil?
375
+ # verify the required parameter 'account_id' is set
376
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_agent" if account_id.nil?
377
+ # resource path
378
+ local_var_path = "/v2/accounts/{accountId}/users/invite_classic_agent".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
379
+
380
+ # query parameters
381
+ query_params = {}
382
+
383
+ # header parameters
384
+ header_params = {}
385
+ # HTTP header 'Accept' (if needed)
386
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
387
+ # HTTP header 'Content-Type'
388
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
389
+
390
+ # form parameters
391
+ form_params = {}
392
+
393
+ # http body (model)
394
+ post_body = @api_client.object_to_http_body(invitee)
395
+ auth_names = []
396
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
397
+ :header_params => header_params,
398
+ :query_params => query_params,
399
+ :form_params => form_params,
400
+ :body => post_body,
401
+ :auth_names => auth_names,
402
+ :return_type => 'User')
403
+ if @api_client.config.debugging
404
+ @api_client.config.logger.debug "API called: UsersApi#invite_classic_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
405
+ end
406
+ return data, status_code, headers
407
+ end
408
+
409
+ # CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.
410
+ #
411
+ # @param account_id
412
+ # @param invitee Invitee information.
413
+ # @return [User]
414
+ def invite_classic_manager(account_id, invitee)
415
+ data, _status_code, _headers = invite_classic_manager_with_http_info(account_id, invitee)
416
+ return data
417
+ end
418
+
419
+ # CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.
420
+ #
421
+ # @param account_id
422
+ # @param invitee Invitee information.
423
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
424
+ def invite_classic_manager_with_http_info(account_id, invitee)
425
+ if @api_client.config.debugging
426
+ @api_client.config.logger.debug "Calling API: UsersApi.invite_classic_manager ..."
427
+ end
428
+ # verify the required parameter 'invitee' is set
429
+ fail ArgumentError, "Missing the required parameter 'invitee' when calling UsersApi.invite_classic_manager" if invitee.nil?
430
+ # verify the required parameter 'account_id' is set
431
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_manager" if account_id.nil?
432
+ # resource path
433
+ local_var_path = "/v2/accounts/{accountId}/users/invite_classic_manager".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
434
+
435
+ # query parameters
436
+ query_params = {}
437
+
438
+ # header parameters
439
+ header_params = {}
440
+ # HTTP header 'Accept' (if needed)
441
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
442
+ # HTTP header 'Content-Type'
443
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
444
+
445
+ # form parameters
446
+ form_params = {}
447
+
448
+ # http body (model)
449
+ post_body = @api_client.object_to_http_body(invitee)
450
+ auth_names = []
451
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
452
+ :header_params => header_params,
453
+ :query_params => query_params,
454
+ :form_params => form_params,
455
+ :body => post_body,
456
+ :auth_names => auth_names,
457
+ :return_type => 'User')
458
+ if @api_client.config.debugging
459
+ @api_client.config.logger.debug "API called: UsersApi#invite_classic_manager\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
460
+ end
461
+ return data, status_code, headers
462
+ end
463
+
464
+ # NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.
465
+ #
466
+ # @param account_id
467
+ # @param invitee Invitee information
468
+ # @return [User]
469
+ def invite_user(account_id, invitee)
470
+ data, _status_code, _headers = invite_user_with_http_info(account_id, invitee)
471
+ return data
472
+ end
473
+
474
+ # NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.
475
+ #
476
+ # @param account_id
477
+ # @param invitee Invitee information
478
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
479
+ def invite_user_with_http_info(account_id, invitee)
480
+ if @api_client.config.debugging
481
+ @api_client.config.logger.debug "Calling API: UsersApi.invite_user ..."
482
+ end
483
+ # verify the required parameter 'invitee' is set
484
+ fail ArgumentError, "Missing the required parameter 'invitee' when calling UsersApi.invite_user" if invitee.nil?
485
+ # verify the required parameter 'account_id' is set
486
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_user" if account_id.nil?
487
+ # resource path
488
+ local_var_path = "/v2/accounts/{accountId}/users/invite_user".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
489
+
490
+ # query parameters
491
+ query_params = {}
492
+
493
+ # header parameters
494
+ header_params = {}
495
+ # HTTP header 'Accept' (if needed)
496
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
497
+ # HTTP header 'Content-Type'
498
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
499
+
500
+ # form parameters
501
+ form_params = {}
502
+
503
+ # http body (model)
504
+ post_body = @api_client.object_to_http_body(invitee)
505
+ auth_names = []
506
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
507
+ :header_params => header_params,
508
+ :query_params => query_params,
509
+ :form_params => form_params,
510
+ :body => post_body,
511
+ :auth_names => auth_names,
512
+ :return_type => 'User')
513
+ if @api_client.config.debugging
514
+ @api_client.config.logger.debug "API called: UsersApi#invite_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
515
+ end
516
+ return data, status_code, headers
517
+ end
518
+
519
+ # Locks the account of the user.
520
+ #
521
+ # @param user_id User Id of the user attempting to be locked.
522
+ # @param account_id
523
+ # @param details Details containing the reason the user is being locked out
524
+ # @return [nil]
525
+ def lock_user(user_id, account_id, details)
526
+ lock_user_with_http_info(user_id, account_id, details)
527
+ return nil
528
+ end
529
+
530
+ # Locks the account of the user.
531
+ #
532
+ # @param user_id User Id of the user attempting to be locked.
533
+ # @param account_id
534
+ # @param details Details containing the reason the user is being locked out
535
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
536
+ def lock_user_with_http_info(user_id, account_id, details)
537
+ if @api_client.config.debugging
538
+ @api_client.config.logger.debug "Calling API: UsersApi.lock_user ..."
539
+ end
540
+ # verify the required parameter 'user_id' is set
541
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.lock_user" if user_id.nil?
542
+ # verify the required parameter 'details' is set
543
+ fail ArgumentError, "Missing the required parameter 'details' when calling UsersApi.lock_user" if details.nil?
544
+ # verify the required parameter 'account_id' is set
545
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.lock_user" if account_id.nil?
546
+ # resource path
547
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/lock".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
548
+
549
+ # query parameters
550
+ query_params = {}
551
+
552
+ # header parameters
553
+ header_params = {}
554
+ # HTTP header 'Accept' (if needed)
555
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
556
+ # HTTP header 'Content-Type'
557
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
558
+
559
+ # form parameters
560
+ form_params = {}
561
+
562
+ # http body (model)
563
+ post_body = @api_client.object_to_http_body(details)
564
+ auth_names = []
565
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
566
+ :header_params => header_params,
567
+ :query_params => query_params,
568
+ :form_params => form_params,
569
+ :body => post_body,
570
+ :auth_names => auth_names)
571
+ if @api_client.config.debugging
572
+ @api_client.config.logger.debug "API called: UsersApi#lock_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
573
+ end
574
+ return data, status_code, headers
575
+ end
576
+
577
+ # Reinvites the pending user with the given userId.
578
+ #
579
+ # @param user_id
580
+ # @param account_id
581
+ # @return [nil]
582
+ def reinvite_user(user_id, account_id)
583
+ reinvite_user_with_http_info(user_id, account_id)
584
+ return nil
585
+ end
586
+
587
+ # Reinvites the pending user with the given userId.
588
+ #
589
+ # @param user_id
590
+ # @param account_id
591
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
592
+ def reinvite_user_with_http_info(user_id, account_id)
593
+ if @api_client.config.debugging
594
+ @api_client.config.logger.debug "Calling API: UsersApi.reinvite_user ..."
595
+ end
596
+ # verify the required parameter 'user_id' is set
597
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.reinvite_user" if user_id.nil?
598
+ # verify the required parameter 'account_id' is set
599
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.reinvite_user" if account_id.nil?
600
+ # resource path
601
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/reinvite".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
602
+
603
+ # query parameters
604
+ query_params = {}
605
+
606
+ # header parameters
607
+ header_params = {}
608
+ # HTTP header 'Accept' (if needed)
609
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
610
+
611
+ # form parameters
612
+ form_params = {}
613
+
614
+ # http body (model)
615
+ post_body = nil
616
+ auth_names = []
617
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
618
+ :header_params => header_params,
619
+ :query_params => query_params,
620
+ :form_params => form_params,
621
+ :body => post_body,
622
+ :auth_names => auth_names)
623
+ if @api_client.config.debugging
624
+ @api_client.config.logger.debug "API called: UsersApi#reinvite_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
625
+ end
626
+ return data, status_code, headers
627
+ end
628
+
629
+ # Removes a user from the company.
630
+ # Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.
631
+ # @param user_id Id of the user you wish to remove.
632
+ # @param account_id
633
+ # @return [nil]
634
+ def remove_user(user_id, account_id)
635
+ remove_user_with_http_info(user_id, account_id)
636
+ return nil
637
+ end
638
+
639
+ # Removes a user from the company.
640
+ # Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.
641
+ # @param user_id Id of the user you wish to remove.
642
+ # @param account_id
643
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
644
+ def remove_user_with_http_info(user_id, account_id)
645
+ if @api_client.config.debugging
646
+ @api_client.config.logger.debug "Calling API: UsersApi.remove_user ..."
647
+ end
648
+ # verify the required parameter 'user_id' is set
649
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.remove_user" if user_id.nil?
650
+ # verify the required parameter 'account_id' is set
651
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.remove_user" if account_id.nil?
652
+ # resource path
653
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
654
+
655
+ # query parameters
656
+ query_params = {}
657
+
658
+ # header parameters
659
+ header_params = {}
660
+ # HTTP header 'Accept' (if needed)
661
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
662
+
663
+ # form parameters
664
+ form_params = {}
665
+
666
+ # http body (model)
667
+ post_body = nil
668
+ auth_names = []
669
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
670
+ :header_params => header_params,
671
+ :query_params => query_params,
672
+ :form_params => form_params,
673
+ :body => post_body,
674
+ :auth_names => auth_names)
675
+ if @api_client.config.debugging
676
+ @api_client.config.logger.debug "API called: UsersApi#remove_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
677
+ end
678
+ return data, status_code, headers
679
+ end
680
+
681
+ # Removes the user from the designated office.
682
+ #
683
+ # @param user_id
684
+ # @param account_id
685
+ # @param designated_office
686
+ # @return [nil]
687
+ def remove_user_from_office(user_id, account_id, designated_office)
688
+ remove_user_from_office_with_http_info(user_id, account_id, designated_office)
689
+ return nil
690
+ end
691
+
692
+ # Removes the user from the designated office.
693
+ #
694
+ # @param user_id
695
+ # @param account_id
696
+ # @param designated_office
697
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
698
+ def remove_user_from_office_with_http_info(user_id, account_id, designated_office)
699
+ if @api_client.config.debugging
700
+ @api_client.config.logger.debug "Calling API: UsersApi.remove_user_from_office ..."
701
+ end
702
+ # verify the required parameter 'user_id' is set
703
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.remove_user_from_office" if user_id.nil?
704
+ # verify the required parameter 'designated_office' is set
705
+ fail ArgumentError, "Missing the required parameter 'designated_office' when calling UsersApi.remove_user_from_office" if designated_office.nil?
706
+ # verify the required parameter 'account_id' is set
707
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.remove_user_from_office" if account_id.nil?
708
+ # resource path
709
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/remove_from_office".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
710
+
711
+ # query parameters
712
+ query_params = {}
713
+
714
+ # header parameters
715
+ header_params = {}
716
+ # HTTP header 'Accept' (if needed)
717
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
718
+ # HTTP header 'Content-Type'
719
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
720
+
721
+ # form parameters
722
+ form_params = {}
723
+
724
+ # http body (model)
725
+ post_body = @api_client.object_to_http_body(designated_office)
726
+ auth_names = []
727
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
728
+ :header_params => header_params,
729
+ :query_params => query_params,
730
+ :form_params => form_params,
731
+ :body => post_body,
732
+ :auth_names => auth_names)
733
+ if @api_client.config.debugging
734
+ @api_client.config.logger.debug "API called: UsersApi#remove_user_from_office\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
735
+ end
736
+ return data, status_code, headers
737
+ end
738
+
739
+ # Removes the user from the designated region.
740
+ #
741
+ # @param user_id
742
+ # @param account_id
743
+ # @param designated_region
744
+ # @return [nil]
745
+ def remove_user_from_region(user_id, account_id, designated_region)
746
+ remove_user_from_region_with_http_info(user_id, account_id, designated_region)
747
+ return nil
748
+ end
749
+
750
+ # Removes the user from the designated region.
751
+ #
752
+ # @param user_id
753
+ # @param account_id
754
+ # @param designated_region
755
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
756
+ def remove_user_from_region_with_http_info(user_id, account_id, designated_region)
757
+ if @api_client.config.debugging
758
+ @api_client.config.logger.debug "Calling API: UsersApi.remove_user_from_region ..."
759
+ end
760
+ # verify the required parameter 'user_id' is set
761
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.remove_user_from_region" if user_id.nil?
762
+ # verify the required parameter 'designated_region' is set
763
+ fail ArgumentError, "Missing the required parameter 'designated_region' when calling UsersApi.remove_user_from_region" if designated_region.nil?
764
+ # verify the required parameter 'account_id' is set
765
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.remove_user_from_region" if account_id.nil?
766
+ # resource path
767
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/remove_from_region".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
768
+
769
+ # query parameters
770
+ query_params = {}
771
+
772
+ # header parameters
773
+ header_params = {}
774
+ # HTTP header 'Accept' (if needed)
775
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
776
+ # HTTP header 'Content-Type'
777
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
778
+
779
+ # form parameters
780
+ form_params = {}
781
+
782
+ # http body (model)
783
+ post_body = @api_client.object_to_http_body(designated_region)
784
+ auth_names = []
785
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
786
+ :header_params => header_params,
787
+ :query_params => query_params,
788
+ :form_params => form_params,
789
+ :body => post_body,
790
+ :auth_names => auth_names)
791
+ if @api_client.config.debugging
792
+ @api_client.config.logger.debug "API called: UsersApi#remove_user_from_region\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
793
+ end
794
+ return data, status_code, headers
795
+ end
796
+
797
+ # Unlocks the account of the user.
798
+ #
799
+ # @param user_id User Id of the user attempting to be unlocked.
800
+ # @param account_id
801
+ # @return [nil]
802
+ def unlock_user(user_id, account_id)
803
+ unlock_user_with_http_info(user_id, account_id)
804
+ return nil
805
+ end
806
+
807
+ # Unlocks the account of the user.
808
+ #
809
+ # @param user_id User Id of the user attempting to be unlocked.
810
+ # @param account_id
811
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
812
+ def unlock_user_with_http_info(user_id, account_id)
813
+ if @api_client.config.debugging
814
+ @api_client.config.logger.debug "Calling API: UsersApi.unlock_user ..."
815
+ end
816
+ # verify the required parameter 'user_id' is set
817
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.unlock_user" if user_id.nil?
818
+ # verify the required parameter 'account_id' is set
819
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.unlock_user" if account_id.nil?
820
+ # resource path
821
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/unlock".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
822
+
823
+ # query parameters
824
+ query_params = {}
825
+
826
+ # header parameters
827
+ header_params = {}
828
+ # HTTP header 'Accept' (if needed)
829
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
830
+
831
+ # form parameters
832
+ form_params = {}
833
+
834
+ # http body (model)
835
+ post_body = nil
836
+ auth_names = []
837
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
838
+ :header_params => header_params,
839
+ :query_params => query_params,
840
+ :form_params => form_params,
841
+ :body => post_body,
842
+ :auth_names => auth_names)
843
+ if @api_client.config.debugging
844
+ @api_client.config.logger.debug "API called: UsersApi#unlock_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
845
+ end
846
+ return data, status_code, headers
847
+ end
848
+
849
+ # Updates user information
850
+ #
851
+ # @param user_id
852
+ # @param account_id
853
+ # @param user_for_update
854
+ # @return [User]
855
+ def update_user(user_id, account_id, user_for_update)
856
+ data, _status_code, _headers = update_user_with_http_info(user_id, account_id, user_for_update)
857
+ return data
858
+ end
859
+
860
+ # Updates user information
861
+ #
862
+ # @param user_id
863
+ # @param account_id
864
+ # @param user_for_update
865
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
866
+ def update_user_with_http_info(user_id, account_id, user_for_update)
867
+ if @api_client.config.debugging
868
+ @api_client.config.logger.debug "Calling API: UsersApi.update_user ..."
869
+ end
870
+ # verify the required parameter 'user_id' is set
871
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_user" if user_id.nil?
872
+ # verify the required parameter 'user_for_update' is set
873
+ fail ArgumentError, "Missing the required parameter 'user_for_update' when calling UsersApi.update_user" if user_for_update.nil?
874
+ # verify the required parameter 'account_id' is set
875
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_user" if account_id.nil?
876
+ # resource path
877
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
878
+
879
+ # query parameters
880
+ query_params = {}
881
+
882
+ # header parameters
883
+ header_params = {}
884
+ # HTTP header 'Accept' (if needed)
885
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
886
+ # HTTP header 'Content-Type'
887
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
888
+
889
+ # form parameters
890
+ form_params = {}
891
+
892
+ # http body (model)
893
+ post_body = @api_client.object_to_http_body(user_for_update)
894
+ auth_names = []
895
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
896
+ :header_params => header_params,
897
+ :query_params => query_params,
898
+ :form_params => form_params,
899
+ :body => post_body,
900
+ :auth_names => auth_names,
901
+ :return_type => 'User')
902
+ if @api_client.config.debugging
903
+ @api_client.config.logger.debug "API called: UsersApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
904
+ end
905
+ return data, status_code, headers
906
+ end
907
+ end
908
+ end