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 SellerDecisionTypesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = SellerDecisionTypesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid seller decision types.
25
+ #
26
+ # @return [GlobalSellerDecisionTypes]
27
+ def get_seller_decision_types()
28
+ data, _status_code, _headers = get_seller_decision_types_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid seller decision types.
33
+ #
34
+ # @return [Array<(GlobalSellerDecisionTypes, Fixnum, Hash)>] GlobalSellerDecisionTypes data, response status code and response headers
35
+ def get_seller_decision_types_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: SellerDecisionTypesApi.get_seller_decision_types ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/seller_decision_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 => 'GlobalSellerDecisionTypes')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: SellerDecisionTypesApi#get_seller_decision_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 SpecialCircumstanceTypesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = SpecialCircumstanceTypesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid special circumstance types.
25
+ #
26
+ # @return [GlobalSpecialCircumstanceTypes]
27
+ def get_special_circumstance_types()
28
+ data, _status_code, _headers = get_special_circumstance_types_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid special circumstance types.
33
+ #
34
+ # @return [Array<(GlobalSpecialCircumstanceTypes, Fixnum, Hash)>] GlobalSpecialCircumstanceTypes data, response status code and response headers
35
+ def get_special_circumstance_types_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: SpecialCircumstanceTypesApi.get_special_circumstance_types ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/special_circumstance_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 => 'GlobalSpecialCircumstanceTypes')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: SpecialCircumstanceTypesApi#get_special_circumstance_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 StatesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = StatesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid states.
25
+ #
26
+ # @return [GlobalStates]
27
+ def get_states()
28
+ data, _status_code, _headers = get_states_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid states.
33
+ #
34
+ # @return [Array<(GlobalStates, Fixnum, Hash)>] GlobalStates data, response status code and response headers
35
+ def get_states_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: StatesApi.get_states ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/states".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 => 'GlobalStates')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: StatesApi#get_states\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 TaskDateTypesApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = TaskDateTypesApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Retrieves the list of valid task date types.
25
+ #
26
+ # @return [GlobalTaskDateTypes]
27
+ def get_task_date_types()
28
+ data, _status_code, _headers = get_task_date_types_with_http_info()
29
+ return data
30
+ end
31
+
32
+ # Retrieves the list of valid task date types.
33
+ #
34
+ # @return [Array<(GlobalTaskDateTypes, Fixnum, Hash)>] GlobalTaskDateTypes data, response status code and response headers
35
+ def get_task_date_types_with_http_info()
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug "Calling API: TaskDateTypesApi.get_task_date_types ..."
38
+ end
39
+ # resource path
40
+ local_var_path = "/v2/task_date_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 => 'GlobalTaskDateTypes')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: TaskDateTypesApi#get_task_date_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,89 @@
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 GetTaskListTemplatesOptions
17
+ #
18
+ attr_accessor :start_position
19
+
20
+ #
21
+ attr_accessor :count
22
+
23
+ def self.default
24
+ @@default ||= GetTaskListTemplatesOptions.new
25
+ end
26
+ end
27
+
28
+
29
+ class TaskListTemplatesApi
30
+ attr_accessor :api_client
31
+
32
+ def initialize(api_client = TaskListTemplatesApi.default)
33
+ @api_client = api_client
34
+ end
35
+
36
+ # Returns all task list templates for the company of the active user.
37
+ #
38
+ # @param account_id
39
+ # @param DocuSign_Rooms::GetTaskListTemplatesOptions Options for modifying the behavior of the function.
40
+ # @return [TaskListTemplateList]
41
+ def get_task_list_templates(account_id, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default)
42
+ data, _status_code, _headers = get_task_list_templates_with_http_info(account_id, options)
43
+ return data
44
+ end
45
+
46
+ # Returns all task list templates for the company of the active user.
47
+ #
48
+ # @param account_id
49
+ # @param DocuSign_Rooms::GetTaskListTemplatesOptions Options for modifying the behavior of the function.
50
+ # @return [Array<(TaskListTemplateList, Fixnum, Hash)>] TaskListTemplateList data, response status code and response headers
51
+ def get_task_list_templates_with_http_info(account_id, options = DocuSign_Rooms::GetTaskListTemplatesOptions.default)
52
+ if @api_client.config.debugging
53
+ @api_client.config.logger.debug "Calling API: TaskListTemplatesApi.get_task_list_templates ..."
54
+ end
55
+ # verify the required parameter 'account_id' is set
56
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling TaskListTemplatesApi.get_task_list_templates" if account_id.nil?
57
+ # resource path
58
+ local_var_path = "/v2/accounts/{accountId}/task_list_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
59
+
60
+ # query parameters
61
+ query_params = {}
62
+ query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
63
+ query_params[:'count'] = options.count if !options.count.nil?
64
+
65
+ # header parameters
66
+ header_params = {}
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
+
70
+ # form parameters
71
+ form_params = {}
72
+
73
+ # http body (model)
74
+ post_body = nil
75
+ auth_names = []
76
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
77
+ :header_params => header_params,
78
+ :query_params => query_params,
79
+ :form_params => form_params,
80
+ :body => post_body,
81
+ :auth_names => auth_names,
82
+ :return_type => 'TaskListTemplateList')
83
+ if @api_client.config.debugging
84
+ @api_client.config.logger.debug "API called: TaskListTemplatesApi#get_task_list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
+ end
86
+ return data, status_code, headers
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,188 @@
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 TaskListsApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = TaskListsApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Add a task list to a room based on a task list template.
25
+ #
26
+ # @param room_id Room ID.
27
+ # @param account_id
28
+ # @param task_list Details for task list creation.
29
+ # @return [TaskList]
30
+ def create_task_list(room_id, account_id, task_list)
31
+ data, _status_code, _headers = create_task_list_with_http_info(room_id, account_id, task_list)
32
+ return data
33
+ end
34
+
35
+ # Add a task list to a room based on a task list template.
36
+ #
37
+ # @param room_id Room ID.
38
+ # @param account_id
39
+ # @param task_list Details for task list creation.
40
+ # @return [Array<(TaskList, Fixnum, Hash)>] TaskList data, response status code and response headers
41
+ def create_task_list_with_http_info(room_id, account_id, task_list)
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug "Calling API: TaskListsApi.create_task_list ..."
44
+ end
45
+ # verify the required parameter 'room_id' is set
46
+ fail ArgumentError, "Missing the required parameter 'room_id' when calling TaskListsApi.create_task_list" if room_id.nil?
47
+ # verify the required parameter 'task_list' is set
48
+ fail ArgumentError, "Missing the required parameter 'task_list' when calling TaskListsApi.create_task_list" if task_list.nil?
49
+ # verify the required parameter 'account_id' is set
50
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling TaskListsApi.create_task_list" if account_id.nil?
51
+ # resource path
52
+ local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/task_lists".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
53
+
54
+ # query parameters
55
+ query_params = {}
56
+
57
+ # header parameters
58
+ header_params = {}
59
+ # HTTP header 'Accept' (if needed)
60
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
+ # HTTP header 'Content-Type'
62
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
63
+
64
+ # form parameters
65
+ form_params = {}
66
+
67
+ # http body (model)
68
+ post_body = @api_client.object_to_http_body(task_list)
69
+ auth_names = []
70
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => 'TaskList')
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: TaskListsApi#create_task_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
83
+ # Deletes a task list. If there are attached documents they will remain in the associated room.
84
+ #
85
+ # @param task_list_id Task List ID
86
+ # @param account_id
87
+ # @return [nil]
88
+ def delete_task_list(task_list_id, account_id)
89
+ delete_task_list_with_http_info(task_list_id, account_id)
90
+ return nil
91
+ end
92
+
93
+ # Deletes a task list. If there are attached documents they will remain in the associated room.
94
+ #
95
+ # @param task_list_id Task List ID
96
+ # @param account_id
97
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
98
+ def delete_task_list_with_http_info(task_list_id, account_id)
99
+ if @api_client.config.debugging
100
+ @api_client.config.logger.debug "Calling API: TaskListsApi.delete_task_list ..."
101
+ end
102
+ # verify the required parameter 'task_list_id' is set
103
+ fail ArgumentError, "Missing the required parameter 'task_list_id' when calling TaskListsApi.delete_task_list" if task_list_id.nil?
104
+ # verify the required parameter 'account_id' is set
105
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling TaskListsApi.delete_task_list" if account_id.nil?
106
+ # resource path
107
+ local_var_path = "/v2/accounts/{accountId}/task_lists/{taskListId}".sub('{format}','json').sub('{' + 'taskListId' + '}', task_list_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
108
+
109
+ # query parameters
110
+ query_params = {}
111
+
112
+ # header parameters
113
+ header_params = {}
114
+ # HTTP header 'Accept' (if needed)
115
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
116
+
117
+ # form parameters
118
+ form_params = {}
119
+
120
+ # http body (model)
121
+ post_body = nil
122
+ auth_names = []
123
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
124
+ :header_params => header_params,
125
+ :query_params => query_params,
126
+ :form_params => form_params,
127
+ :body => post_body,
128
+ :auth_names => auth_names)
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug "API called: TaskListsApi#delete_task_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
131
+ end
132
+ return data, status_code, headers
133
+ end
134
+
135
+ # Returns the summary for all viewable task lists in a room.
136
+ #
137
+ # @param room_id Room ID
138
+ # @param account_id
139
+ # @return [TaskListSummaryList]
140
+ def get_task_lists(room_id, account_id)
141
+ data, _status_code, _headers = get_task_lists_with_http_info(room_id, account_id)
142
+ return data
143
+ end
144
+
145
+ # Returns the summary for all viewable task lists in a room.
146
+ #
147
+ # @param room_id Room ID
148
+ # @param account_id
149
+ # @return [Array<(TaskListSummaryList, Fixnum, Hash)>] TaskListSummaryList data, response status code and response headers
150
+ def get_task_lists_with_http_info(room_id, account_id)
151
+ if @api_client.config.debugging
152
+ @api_client.config.logger.debug "Calling API: TaskListsApi.get_task_lists ..."
153
+ end
154
+ # verify the required parameter 'room_id' is set
155
+ fail ArgumentError, "Missing the required parameter 'room_id' when calling TaskListsApi.get_task_lists" if room_id.nil?
156
+ # verify the required parameter 'account_id' is set
157
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling TaskListsApi.get_task_lists" if account_id.nil?
158
+ # resource path
159
+ local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/task_lists".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
160
+
161
+ # query parameters
162
+ query_params = {}
163
+
164
+ # header parameters
165
+ header_params = {}
166
+ # HTTP header 'Accept' (if needed)
167
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
168
+
169
+ # form parameters
170
+ form_params = {}
171
+
172
+ # http body (model)
173
+ post_body = nil
174
+ auth_names = []
175
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
176
+ :header_params => header_params,
177
+ :query_params => query_params,
178
+ :form_params => form_params,
179
+ :body => post_body,
180
+ :auth_names => auth_names,
181
+ :return_type => 'TaskListSummaryList')
182
+ if @api_client.config.debugging
183
+ @api_client.config.logger.debug "API called: TaskListsApi#get_task_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
+ end
185
+ return data, status_code, headers
186
+ end
187
+ end
188
+ end