docusign_rooms 1.0.0.beta
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +66 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +71 -0
- data/LICENSE +21 -0
- data/README.md +80 -0
- data/Rakefile +8 -0
- data/docusign_rooms-1.0.0.pre.alpha.gem +0 -0
- data/docusign_rooms.gemspec +45 -0
- data/git_push.sh +55 -0
- data/lib/.DS_Store +0 -0
- data/lib/docusign_rooms.rb +193 -0
- data/lib/docusign_rooms/.DS_Store +0 -0
- data/lib/docusign_rooms/api/accounts_api.rb +73 -0
- data/lib/docusign_rooms/api/activity_types_api.rb +69 -0
- data/lib/docusign_rooms/api/closing_statuses_api.rb +69 -0
- data/lib/docusign_rooms/api/contact_sides_api.rb +69 -0
- data/lib/docusign_rooms/api/countries_api.rb +69 -0
- data/lib/docusign_rooms/api/currencies_api.rb +69 -0
- data/lib/docusign_rooms/api/documents_api.rb +200 -0
- data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb +73 -0
- data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb +79 -0
- data/lib/docusign_rooms/api/fields_api.rb +92 -0
- data/lib/docusign_rooms/api/financing_types_api.rb +69 -0
- data/lib/docusign_rooms/api/form_details_api.rb +77 -0
- data/lib/docusign_rooms/api/form_groups_api.rb +89 -0
- data/lib/docusign_rooms/api/form_libraries_api.rb +158 -0
- data/lib/docusign_rooms/api/offices_api.rb +310 -0
- data/lib/docusign_rooms/api/origins_of_leads_api.rb +69 -0
- data/lib/docusign_rooms/api/property_types_api.rb +69 -0
- data/lib/docusign_rooms/api/regions_api.rb +306 -0
- data/lib/docusign_rooms/api/roles_api.rb +328 -0
- data/lib/docusign_rooms/api/room_contact_types_api.rb +69 -0
- data/lib/docusign_rooms/api/room_folders_api.rb +93 -0
- data/lib/docusign_rooms/api/room_templates_api.rb +97 -0
- data/lib/docusign_rooms/api/rooms_api.rb +1146 -0
- data/lib/docusign_rooms/api/seller_decision_types_api.rb +69 -0
- data/lib/docusign_rooms/api/special_circumstance_types_api.rb +69 -0
- data/lib/docusign_rooms/api/states_api.rb +69 -0
- data/lib/docusign_rooms/api/task_date_types_api.rb +69 -0
- data/lib/docusign_rooms/api/task_list_templates_api.rb +89 -0
- data/lib/docusign_rooms/api/task_lists_api.rb +188 -0
- data/lib/docusign_rooms/api/task_responsibility_types_api.rb +69 -0
- data/lib/docusign_rooms/api/task_statuses_api.rb +69 -0
- data/lib/docusign_rooms/api/time_zones_api.rb +69 -0
- data/lib/docusign_rooms/api/transaction_sides_api.rb +69 -0
- data/lib/docusign_rooms/api/users_api.rb +908 -0
- data/lib/docusign_rooms/client/.DS_Store +0 -0
- data/lib/docusign_rooms/client/api_client.rb +590 -0
- data/lib/docusign_rooms/client/api_error.rb +37 -0
- data/lib/docusign_rooms/client/auth/oauth.rb +1061 -0
- data/lib/docusign_rooms/configuration.rb +202 -0
- data/lib/docusign_rooms/models/account_summary.rb +262 -0
- data/lib/docusign_rooms/models/activity_type.rb +192 -0
- data/lib/docusign_rooms/models/api_error.rb +192 -0
- data/lib/docusign_rooms/models/assignable_roles.rb +239 -0
- data/lib/docusign_rooms/models/classic_admin_to_invite.rb +216 -0
- data/lib/docusign_rooms/models/classic_agent_to_invite.rb +240 -0
- data/lib/docusign_rooms/models/classic_manager_permissions.rb +291 -0
- data/lib/docusign_rooms/models/classic_manager_to_invite.rb +338 -0
- data/lib/docusign_rooms/models/closing_status.rb +192 -0
- data/lib/docusign_rooms/models/contact_side.rb +192 -0
- data/lib/docusign_rooms/models/country.rb +192 -0
- data/lib/docusign_rooms/models/currency.rb +192 -0
- data/lib/docusign_rooms/models/custom_data.rb +192 -0
- data/lib/docusign_rooms/models/depends_on.rb +192 -0
- data/lib/docusign_rooms/models/designated_office.rb +188 -0
- data/lib/docusign_rooms/models/designated_region.rb +188 -0
- data/lib/docusign_rooms/models/document.rb +265 -0
- data/lib/docusign_rooms/models/document_user.rb +291 -0
- data/lib/docusign_rooms/models/document_user_for_create.rb +188 -0
- data/lib/docusign_rooms/models/e_sign_account_role_settings.rb +183 -0
- data/lib/docusign_rooms/models/e_sign_permission_profile.rb +201 -0
- data/lib/docusign_rooms/models/e_sign_permission_profile_list.rb +185 -0
- data/lib/docusign_rooms/models/external_form_fill_session.rb +183 -0
- data/lib/docusign_rooms/models/external_form_fill_session_for_create.rb +211 -0
- data/lib/docusign_rooms/models/field.rb +248 -0
- data/lib/docusign_rooms/models/field_configuration.rb +259 -0
- data/lib/docusign_rooms/models/field_data.rb +185 -0
- data/lib/docusign_rooms/models/field_data_for_create.rb +185 -0
- data/lib/docusign_rooms/models/field_data_for_update.rb +185 -0
- data/lib/docusign_rooms/models/field_set.rb +203 -0
- data/lib/docusign_rooms/models/financing_type.rb +192 -0
- data/lib/docusign_rooms/models/form_details.rb +246 -0
- data/lib/docusign_rooms/models/form_for_add.rb +188 -0
- data/lib/docusign_rooms/models/form_group_summary.rb +201 -0
- data/lib/docusign_rooms/models/form_group_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/form_library_summary.rb +201 -0
- data/lib/docusign_rooms/models/form_library_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/form_summary.rb +201 -0
- data/lib/docusign_rooms/models/form_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/global_activity_types.rb +185 -0
- data/lib/docusign_rooms/models/global_closing_statuses.rb +185 -0
- data/lib/docusign_rooms/models/global_contact_sides.rb +185 -0
- data/lib/docusign_rooms/models/global_countries.rb +185 -0
- data/lib/docusign_rooms/models/global_currencies.rb +185 -0
- data/lib/docusign_rooms/models/global_financing_types.rb +185 -0
- data/lib/docusign_rooms/models/global_origins_of_leads.rb +185 -0
- data/lib/docusign_rooms/models/global_property_types.rb +185 -0
- data/lib/docusign_rooms/models/global_room_contact_types.rb +185 -0
- data/lib/docusign_rooms/models/global_seller_decision_types.rb +185 -0
- data/lib/docusign_rooms/models/global_special_circumstance_types.rb +185 -0
- data/lib/docusign_rooms/models/global_states.rb +185 -0
- data/lib/docusign_rooms/models/global_task_date_types.rb +185 -0
- data/lib/docusign_rooms/models/global_task_responsibility_types.rb +185 -0
- data/lib/docusign_rooms/models/global_task_statuses.rb +185 -0
- data/lib/docusign_rooms/models/global_time_zones.rb +185 -0
- data/lib/docusign_rooms/models/global_transaction_sides.rb +185 -0
- data/lib/docusign_rooms/models/locked_out_details.rb +188 -0
- data/lib/docusign_rooms/models/nullable_field_data.rb +185 -0
- data/lib/docusign_rooms/models/nullable_permissions.rb +660 -0
- data/lib/docusign_rooms/models/office.rb +287 -0
- data/lib/docusign_rooms/models/office_for_create.rb +269 -0
- data/lib/docusign_rooms/models/office_reference_count.rb +192 -0
- data/lib/docusign_rooms/models/office_reference_count_list.rb +185 -0
- data/lib/docusign_rooms/models/office_summary.rb +282 -0
- data/lib/docusign_rooms/models/office_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/origin_of_lead.rb +192 -0
- data/lib/docusign_rooms/models/permissions.rb +660 -0
- data/lib/docusign_rooms/models/property_type.rb +192 -0
- data/lib/docusign_rooms/models/region.rb +206 -0
- data/lib/docusign_rooms/models/region_reference_count.rb +192 -0
- data/lib/docusign_rooms/models/region_reference_count_list.rb +185 -0
- data/lib/docusign_rooms/models/region_summary.rb +201 -0
- data/lib/docusign_rooms/models/region_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/role.rb +246 -0
- data/lib/docusign_rooms/models/role_for_create.rb +201 -0
- data/lib/docusign_rooms/models/role_for_update.rb +201 -0
- data/lib/docusign_rooms/models/role_summary.rb +228 -0
- data/lib/docusign_rooms/models/role_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/room.rb +282 -0
- data/lib/docusign_rooms/models/room_contact_type.rb +192 -0
- data/lib/docusign_rooms/models/room_document.rb +246 -0
- data/lib/docusign_rooms/models/room_document_list.rb +230 -0
- data/lib/docusign_rooms/models/room_folder.rb +201 -0
- data/lib/docusign_rooms/models/room_folder_list.rb +230 -0
- data/lib/docusign_rooms/models/room_for_create.rb +248 -0
- data/lib/docusign_rooms/models/room_invite.rb +240 -0
- data/lib/docusign_rooms/models/room_invite_response.rb +237 -0
- data/lib/docusign_rooms/models/room_picture.rb +183 -0
- data/lib/docusign_rooms/models/room_summary.rb +273 -0
- data/lib/docusign_rooms/models/room_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/room_template.rb +201 -0
- data/lib/docusign_rooms/models/room_templates_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/room_user.rb +246 -0
- data/lib/docusign_rooms/models/room_user_for_update.rb +192 -0
- data/lib/docusign_rooms/models/room_user_removal_detail.rb +183 -0
- data/lib/docusign_rooms/models/room_user_summary.rb +237 -0
- data/lib/docusign_rooms/models/room_users_result.rb +230 -0
- data/lib/docusign_rooms/models/select_list_field_option.rb +201 -0
- data/lib/docusign_rooms/models/seller_decision_type.rb +192 -0
- data/lib/docusign_rooms/models/special_circumstance_type.rb +192 -0
- data/lib/docusign_rooms/models/state.rb +192 -0
- data/lib/docusign_rooms/models/task_date_type.rb +192 -0
- data/lib/docusign_rooms/models/task_list.rb +275 -0
- data/lib/docusign_rooms/models/task_list_for_create.rb +183 -0
- data/lib/docusign_rooms/models/task_list_summary.rb +264 -0
- data/lib/docusign_rooms/models/task_list_summary_list.rb +185 -0
- data/lib/docusign_rooms/models/task_list_template.rb +210 -0
- data/lib/docusign_rooms/models/task_list_template_list.rb +230 -0
- data/lib/docusign_rooms/models/task_responsibility_type.rb +192 -0
- data/lib/docusign_rooms/models/task_status.rb +192 -0
- data/lib/docusign_rooms/models/task_summary.rb +291 -0
- data/lib/docusign_rooms/models/time_zone.rb +192 -0
- data/lib/docusign_rooms/models/transaction_side.rb +192 -0
- data/lib/docusign_rooms/models/user.rb +338 -0
- data/lib/docusign_rooms/models/user_for_update.rb +188 -0
- data/lib/docusign_rooms/models/user_summary.rb +307 -0
- data/lib/docusign_rooms/models/user_summary_list.rb +230 -0
- data/lib/docusign_rooms/models/user_to_invite.rb +337 -0
- data/lib/docusign_rooms/version.rb +14 -0
- data/tests/Gemfile +5 -0
- data/tests/Gemfile.lock +42 -0
- data/tests/docs/Test.pdf +0 -0
- data/tests/docs/private.pem +27 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +125 -0
- 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 RoomContactTypesApi
|
18
|
+
attr_accessor :api_client
|
19
|
+
|
20
|
+
def initialize(api_client = RoomContactTypesApi.default)
|
21
|
+
@api_client = api_client
|
22
|
+
end
|
23
|
+
|
24
|
+
# Retrieves the list of valid room contact types.
|
25
|
+
#
|
26
|
+
# @return [GlobalRoomContactTypes]
|
27
|
+
def get_room_contact_types()
|
28
|
+
data, _status_code, _headers = get_room_contact_types_with_http_info()
|
29
|
+
return data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Retrieves the list of valid room contact types.
|
33
|
+
#
|
34
|
+
# @return [Array<(GlobalRoomContactTypes, Fixnum, Hash)>] GlobalRoomContactTypes data, response status code and response headers
|
35
|
+
def get_room_contact_types_with_http_info()
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug "Calling API: RoomContactTypesApi.get_room_contact_types ..."
|
38
|
+
end
|
39
|
+
# resource path
|
40
|
+
local_var_path = "/v2/room_contact_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 => 'GlobalRoomContactTypes')
|
63
|
+
if @api_client.config.debugging
|
64
|
+
@api_client.config.logger.debug "API called: RoomContactTypesApi#get_room_contact_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,93 @@
|
|
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 GetRoomFoldersOptions
|
17
|
+
# Position of the first item in the total results. Defaults to 0.
|
18
|
+
attr_accessor :start_position
|
19
|
+
|
20
|
+
# Number of room folders to return. Defaults to the maximum which is 100.
|
21
|
+
attr_accessor :count
|
22
|
+
|
23
|
+
def self.default
|
24
|
+
@@default ||= GetRoomFoldersOptions.new
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
|
29
|
+
class RoomFoldersApi
|
30
|
+
attr_accessor :api_client
|
31
|
+
|
32
|
+
def initialize(api_client = RoomFoldersApi.default)
|
33
|
+
@api_client = api_client
|
34
|
+
end
|
35
|
+
|
36
|
+
# Gets room folders accessible to the calling user.
|
37
|
+
#
|
38
|
+
# @param room_id The room id from which to retrieve folders.
|
39
|
+
# @param account_id
|
40
|
+
# @param DocuSign_Rooms::GetRoomFoldersOptions Options for modifying the behavior of the function.
|
41
|
+
# @return [RoomFolderList]
|
42
|
+
def get_room_folders(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default)
|
43
|
+
data, _status_code, _headers = get_room_folders_with_http_info(room_id, account_id, options)
|
44
|
+
return data
|
45
|
+
end
|
46
|
+
|
47
|
+
# Gets room folders accessible to the calling user.
|
48
|
+
#
|
49
|
+
# @param room_id The room id from which to retrieve folders.
|
50
|
+
# @param account_id
|
51
|
+
# @param DocuSign_Rooms::GetRoomFoldersOptions Options for modifying the behavior of the function.
|
52
|
+
# @return [Array<(RoomFolderList, Fixnum, Hash)>] RoomFolderList data, response status code and response headers
|
53
|
+
def get_room_folders_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default)
|
54
|
+
if @api_client.config.debugging
|
55
|
+
@api_client.config.logger.debug "Calling API: RoomFoldersApi.get_room_folders ..."
|
56
|
+
end
|
57
|
+
# verify the required parameter 'room_id' is set
|
58
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomFoldersApi.get_room_folders" if room_id.nil?
|
59
|
+
# verify the required parameter 'account_id' is set
|
60
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomFoldersApi.get_room_folders" if account_id.nil?
|
61
|
+
# resource path
|
62
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/room_folders".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
63
|
+
|
64
|
+
# query parameters
|
65
|
+
query_params = {}
|
66
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
67
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
68
|
+
|
69
|
+
# header parameters
|
70
|
+
header_params = {}
|
71
|
+
# HTTP header 'Accept' (if needed)
|
72
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
73
|
+
|
74
|
+
# form parameters
|
75
|
+
form_params = {}
|
76
|
+
|
77
|
+
# http body (model)
|
78
|
+
post_body = nil
|
79
|
+
auth_names = []
|
80
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
81
|
+
:header_params => header_params,
|
82
|
+
:query_params => query_params,
|
83
|
+
:form_params => form_params,
|
84
|
+
:body => post_body,
|
85
|
+
:auth_names => auth_names,
|
86
|
+
:return_type => 'RoomFolderList')
|
87
|
+
if @api_client.config.debugging
|
88
|
+
@api_client.config.logger.debug "API called: RoomFoldersApi#get_room_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
89
|
+
end
|
90
|
+
return data, status_code, headers
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
@@ -0,0 +1,97 @@
|
|
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 GetRoomTemplatesOptions
|
17
|
+
# Get all room templates you have access to for this office. Response includes Company and Region level templates. If onlyAssignable is true, and no officeId is provided, user's default office is assumed.
|
18
|
+
attr_accessor :office_id
|
19
|
+
|
20
|
+
# Get list of templates you have access to. Default value false.
|
21
|
+
attr_accessor :only_assignable
|
22
|
+
|
23
|
+
# Number of room templates to return. Defaults to the maximum which is 100.
|
24
|
+
attr_accessor :count
|
25
|
+
|
26
|
+
# Position of the first item in the total results. Defaults to 0.
|
27
|
+
attr_accessor :start_position
|
28
|
+
|
29
|
+
def self.default
|
30
|
+
@@default ||= GetRoomTemplatesOptions.new
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
|
35
|
+
class RoomTemplatesApi
|
36
|
+
attr_accessor :api_client
|
37
|
+
|
38
|
+
def initialize(api_client = RoomTemplatesApi.default)
|
39
|
+
@api_client = api_client
|
40
|
+
end
|
41
|
+
|
42
|
+
# Returns all room templates that the active user has access to
|
43
|
+
#
|
44
|
+
# @param account_id
|
45
|
+
# @param DocuSign_Rooms::GetRoomTemplatesOptions Options for modifying the behavior of the function.
|
46
|
+
# @return [RoomTemplatesSummaryList]
|
47
|
+
def get_room_templates(account_id, options = DocuSign_Rooms::GetRoomTemplatesOptions.default)
|
48
|
+
data, _status_code, _headers = get_room_templates_with_http_info(account_id, options)
|
49
|
+
return data
|
50
|
+
end
|
51
|
+
|
52
|
+
# Returns all room templates that the active user has access to
|
53
|
+
#
|
54
|
+
# @param account_id
|
55
|
+
# @param DocuSign_Rooms::GetRoomTemplatesOptions Options for modifying the behavior of the function.
|
56
|
+
# @return [Array<(RoomTemplatesSummaryList, Fixnum, Hash)>] RoomTemplatesSummaryList data, response status code and response headers
|
57
|
+
def get_room_templates_with_http_info(account_id, options = DocuSign_Rooms::GetRoomTemplatesOptions.default)
|
58
|
+
if @api_client.config.debugging
|
59
|
+
@api_client.config.logger.debug "Calling API: RoomTemplatesApi.get_room_templates ..."
|
60
|
+
end
|
61
|
+
# verify the required parameter 'account_id' is set
|
62
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomTemplatesApi.get_room_templates" if account_id.nil?
|
63
|
+
# resource path
|
64
|
+
local_var_path = "/v2/accounts/{accountId}/room_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
65
|
+
|
66
|
+
# query parameters
|
67
|
+
query_params = {}
|
68
|
+
query_params[:'officeId'] = options.office_id if !options.office_id.nil?
|
69
|
+
query_params[:'onlyAssignable'] = options.only_assignable if !options.only_assignable.nil?
|
70
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
71
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
72
|
+
|
73
|
+
# header parameters
|
74
|
+
header_params = {}
|
75
|
+
# HTTP header 'Accept' (if needed)
|
76
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
77
|
+
|
78
|
+
# form parameters
|
79
|
+
form_params = {}
|
80
|
+
|
81
|
+
# http body (model)
|
82
|
+
post_body = nil
|
83
|
+
auth_names = []
|
84
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
85
|
+
:header_params => header_params,
|
86
|
+
:query_params => query_params,
|
87
|
+
:form_params => form_params,
|
88
|
+
:body => post_body,
|
89
|
+
:auth_names => auth_names,
|
90
|
+
:return_type => 'RoomTemplatesSummaryList')
|
91
|
+
if @api_client.config.debugging
|
92
|
+
@api_client.config.logger.debug "API called: RoomTemplatesApi#get_room_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
93
|
+
end
|
94
|
+
return data, status_code, headers
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
@@ -0,0 +1,1146 @@
|
|
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 GetAssignableRolesOptions
|
17
|
+
# Optional parameter indicating to only return roles (internal/external) assignable to this user.
|
18
|
+
attr_accessor :assignee_email
|
19
|
+
|
20
|
+
#
|
21
|
+
attr_accessor :filter
|
22
|
+
|
23
|
+
#
|
24
|
+
attr_accessor :start_position
|
25
|
+
|
26
|
+
#
|
27
|
+
attr_accessor :count
|
28
|
+
|
29
|
+
def self.default
|
30
|
+
@@default ||= GetAssignableRolesOptions.new
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
class GetDocumentsOptions
|
35
|
+
# Number of documents to return. Defaults to the maximum which is 100.
|
36
|
+
attr_accessor :count
|
37
|
+
|
38
|
+
# Position of the first item in the total results. Defaults to 0.
|
39
|
+
attr_accessor :start_position
|
40
|
+
|
41
|
+
def self.default
|
42
|
+
@@default ||= GetDocumentsOptions.new
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
class GetRoomOptions
|
47
|
+
# Indicates if field data (a.k.a., room details) should be included in the response. Defaults to false.
|
48
|
+
attr_accessor :include_field_data
|
49
|
+
|
50
|
+
def self.default
|
51
|
+
@@default ||= GetRoomOptions.new
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
class GetRoomUsersOptions
|
56
|
+
# Number of room users to return. Defaults to the maximum which is 100.
|
57
|
+
attr_accessor :count
|
58
|
+
|
59
|
+
# Position of the first item in the total results. Defaults to 0.
|
60
|
+
attr_accessor :start_position
|
61
|
+
|
62
|
+
# Returns room users filtered by Name and Email.
|
63
|
+
attr_accessor :filter
|
64
|
+
|
65
|
+
# Sorts results. Options are FirstNameAsc, FirstNameDesc, LastNameAsc, LastNameDesc, EmailAsc, EmailDesc. Defaults to LastNameDesc
|
66
|
+
attr_accessor :sort
|
67
|
+
|
68
|
+
def self.default
|
69
|
+
@@default ||= GetRoomUsersOptions.new
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
class GetRoomsOptions
|
74
|
+
# Number of rooms to return. Defaults to the maximum which is 100.
|
75
|
+
attr_accessor :count
|
76
|
+
|
77
|
+
# Position of the first item in the total results. Defaults to 0.
|
78
|
+
attr_accessor :start_position
|
79
|
+
|
80
|
+
# Status of the rooms to return. Defaults to \"Active\".
|
81
|
+
attr_accessor :room_status
|
82
|
+
|
83
|
+
# Only return rooms in this office.
|
84
|
+
attr_accessor :office_id
|
85
|
+
|
86
|
+
# Fields data changed start datetime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.
|
87
|
+
attr_accessor :field_data_changed_start_date
|
88
|
+
|
89
|
+
# Fields-data changed end DateTime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.
|
90
|
+
attr_accessor :field_data_changed_end_date
|
91
|
+
|
92
|
+
# Room closed start datetime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.
|
93
|
+
attr_accessor :room_closed_start_date
|
94
|
+
|
95
|
+
# Room closed end datetime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.
|
96
|
+
attr_accessor :room_closed_end_date
|
97
|
+
|
98
|
+
def self.default
|
99
|
+
@@default ||= GetRoomsOptions.new
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
|
104
|
+
class RoomsApi
|
105
|
+
attr_accessor :api_client
|
106
|
+
|
107
|
+
def initialize(api_client = RoomsApi.default)
|
108
|
+
@api_client = api_client
|
109
|
+
end
|
110
|
+
|
111
|
+
# Add a document to a room.
|
112
|
+
#
|
113
|
+
# @param room_id
|
114
|
+
# @param account_id
|
115
|
+
# @param document
|
116
|
+
# @return [RoomDocument]
|
117
|
+
def add_document_to_room(room_id, account_id, document)
|
118
|
+
data, _status_code, _headers = add_document_to_room_with_http_info(room_id, account_id, document)
|
119
|
+
return data
|
120
|
+
end
|
121
|
+
|
122
|
+
# Add a document to a room.
|
123
|
+
#
|
124
|
+
# @param room_id
|
125
|
+
# @param account_id
|
126
|
+
# @param document
|
127
|
+
# @return [Array<(RoomDocument, Fixnum, Hash)>] RoomDocument data, response status code and response headers
|
128
|
+
def add_document_to_room_with_http_info(room_id, account_id, document)
|
129
|
+
if @api_client.config.debugging
|
130
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.add_document_to_room ..."
|
131
|
+
end
|
132
|
+
# verify the required parameter 'room_id' is set
|
133
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.add_document_to_room" if room_id.nil?
|
134
|
+
# verify the required parameter 'document' is set
|
135
|
+
fail ArgumentError, "Missing the required parameter 'document' when calling RoomsApi.add_document_to_room" if document.nil?
|
136
|
+
# verify the required parameter 'account_id' is set
|
137
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.add_document_to_room" if account_id.nil?
|
138
|
+
# resource path
|
139
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/documents".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
140
|
+
|
141
|
+
# query parameters
|
142
|
+
query_params = {}
|
143
|
+
|
144
|
+
# header parameters
|
145
|
+
header_params = {}
|
146
|
+
# HTTP header 'Accept' (if needed)
|
147
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
148
|
+
# HTTP header 'Content-Type'
|
149
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
150
|
+
|
151
|
+
# form parameters
|
152
|
+
form_params = {}
|
153
|
+
|
154
|
+
# http body (model)
|
155
|
+
post_body = @api_client.object_to_http_body(document)
|
156
|
+
auth_names = []
|
157
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
158
|
+
:header_params => header_params,
|
159
|
+
:query_params => query_params,
|
160
|
+
:form_params => form_params,
|
161
|
+
:body => post_body,
|
162
|
+
:auth_names => auth_names,
|
163
|
+
:return_type => 'RoomDocument')
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug "API called: RoomsApi#add_document_to_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
166
|
+
end
|
167
|
+
return data, status_code, headers
|
168
|
+
end
|
169
|
+
|
170
|
+
# Add a document to a room via file contents upload.
|
171
|
+
#
|
172
|
+
# @param room_id
|
173
|
+
# @param account_id
|
174
|
+
# @return [RoomDocument]
|
175
|
+
def add_document_to_room_via_file_upload(room_id, account_id)
|
176
|
+
data, _status_code, _headers = add_document_to_room_via_file_upload_with_http_info(room_id, account_id)
|
177
|
+
return data
|
178
|
+
end
|
179
|
+
|
180
|
+
# Add a document to a room via file contents upload.
|
181
|
+
#
|
182
|
+
# @param room_id
|
183
|
+
# @param account_id
|
184
|
+
# @return [Array<(RoomDocument, Fixnum, Hash)>] RoomDocument data, response status code and response headers
|
185
|
+
def add_document_to_room_via_file_upload_with_http_info(room_id, account_id)
|
186
|
+
if @api_client.config.debugging
|
187
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.add_document_to_room_via_file_upload ..."
|
188
|
+
end
|
189
|
+
# verify the required parameter 'room_id' is set
|
190
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.add_document_to_room_via_file_upload" if room_id.nil?
|
191
|
+
# verify the required parameter 'account_id' is set
|
192
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.add_document_to_room_via_file_upload" if account_id.nil?
|
193
|
+
# verify the required parameter 'file' is set
|
194
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling RoomsApi.add_document_to_room_via_file_upload" if file.nil?
|
195
|
+
# resource path
|
196
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/documents/contents".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
197
|
+
|
198
|
+
# query parameters
|
199
|
+
query_params = {}
|
200
|
+
|
201
|
+
# header parameters
|
202
|
+
header_params = {}
|
203
|
+
# HTTP header 'Accept' (if needed)
|
204
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
205
|
+
# HTTP header 'Content-Type'
|
206
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/form-data'])
|
207
|
+
|
208
|
+
# form parameters
|
209
|
+
form_params = {}
|
210
|
+
form_params["file"] = file
|
211
|
+
|
212
|
+
# http body (model)
|
213
|
+
post_body = nil
|
214
|
+
auth_names = []
|
215
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
216
|
+
:header_params => header_params,
|
217
|
+
:query_params => query_params,
|
218
|
+
:form_params => form_params,
|
219
|
+
:body => post_body,
|
220
|
+
:auth_names => auth_names,
|
221
|
+
:return_type => 'RoomDocument')
|
222
|
+
if @api_client.config.debugging
|
223
|
+
@api_client.config.logger.debug "API called: RoomsApi#add_document_to_room_via_file_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
224
|
+
end
|
225
|
+
return data, status_code, headers
|
226
|
+
end
|
227
|
+
|
228
|
+
# Adds a DocuSign Form to a room
|
229
|
+
#
|
230
|
+
# @param room_id Id of the room to which the DocuSign Form is being added
|
231
|
+
# @param account_id
|
232
|
+
# @param form_for_add Contains information about the form being added
|
233
|
+
# @return [RoomDocument]
|
234
|
+
def add_form_to_room(room_id, account_id, form_for_add)
|
235
|
+
data, _status_code, _headers = add_form_to_room_with_http_info(room_id, account_id, form_for_add)
|
236
|
+
return data
|
237
|
+
end
|
238
|
+
|
239
|
+
# Adds a DocuSign Form to a room
|
240
|
+
#
|
241
|
+
# @param room_id Id of the room to which the DocuSign Form is being added
|
242
|
+
# @param account_id
|
243
|
+
# @param form_for_add Contains information about the form being added
|
244
|
+
# @return [Array<(RoomDocument, Fixnum, Hash)>] RoomDocument data, response status code and response headers
|
245
|
+
def add_form_to_room_with_http_info(room_id, account_id, form_for_add)
|
246
|
+
if @api_client.config.debugging
|
247
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.add_form_to_room ..."
|
248
|
+
end
|
249
|
+
# verify the required parameter 'room_id' is set
|
250
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.add_form_to_room" if room_id.nil?
|
251
|
+
# verify the required parameter 'form_for_add' is set
|
252
|
+
fail ArgumentError, "Missing the required parameter 'form_for_add' when calling RoomsApi.add_form_to_room" if form_for_add.nil?
|
253
|
+
# verify the required parameter 'account_id' is set
|
254
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.add_form_to_room" if account_id.nil?
|
255
|
+
# resource path
|
256
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/forms".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
257
|
+
|
258
|
+
# query parameters
|
259
|
+
query_params = {}
|
260
|
+
|
261
|
+
# header parameters
|
262
|
+
header_params = {}
|
263
|
+
# HTTP header 'Accept' (if needed)
|
264
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
265
|
+
# HTTP header 'Content-Type'
|
266
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
267
|
+
|
268
|
+
# form parameters
|
269
|
+
form_params = {}
|
270
|
+
|
271
|
+
# http body (model)
|
272
|
+
post_body = @api_client.object_to_http_body(form_for_add)
|
273
|
+
auth_names = []
|
274
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
275
|
+
:header_params => header_params,
|
276
|
+
:query_params => query_params,
|
277
|
+
:form_params => form_params,
|
278
|
+
:body => post_body,
|
279
|
+
:auth_names => auth_names,
|
280
|
+
:return_type => 'RoomDocument')
|
281
|
+
if @api_client.config.debugging
|
282
|
+
@api_client.config.logger.debug "API called: RoomsApi#add_form_to_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
283
|
+
end
|
284
|
+
return data, status_code, headers
|
285
|
+
end
|
286
|
+
|
287
|
+
# Creates a new Room
|
288
|
+
#
|
289
|
+
# @param account_id
|
290
|
+
# @param room_for_create The properties of the new room
|
291
|
+
# @return [Room]
|
292
|
+
def create_room(account_id, room_for_create)
|
293
|
+
data, _status_code, _headers = create_room_with_http_info(account_id, room_for_create)
|
294
|
+
return data
|
295
|
+
end
|
296
|
+
|
297
|
+
# Creates a new Room
|
298
|
+
#
|
299
|
+
# @param account_id
|
300
|
+
# @param room_for_create The properties of the new room
|
301
|
+
# @return [Array<(Room, Fixnum, Hash)>] Room data, response status code and response headers
|
302
|
+
def create_room_with_http_info(account_id, room_for_create)
|
303
|
+
if @api_client.config.debugging
|
304
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.create_room ..."
|
305
|
+
end
|
306
|
+
# verify the required parameter 'room_for_create' is set
|
307
|
+
fail ArgumentError, "Missing the required parameter 'room_for_create' when calling RoomsApi.create_room" if room_for_create.nil?
|
308
|
+
# verify the required parameter 'account_id' is set
|
309
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.create_room" if account_id.nil?
|
310
|
+
# resource path
|
311
|
+
local_var_path = "/v2/accounts/{accountId}/rooms".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
312
|
+
|
313
|
+
# query parameters
|
314
|
+
query_params = {}
|
315
|
+
|
316
|
+
# header parameters
|
317
|
+
header_params = {}
|
318
|
+
# HTTP header 'Accept' (if needed)
|
319
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
320
|
+
# HTTP header 'Content-Type'
|
321
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
322
|
+
|
323
|
+
# form parameters
|
324
|
+
form_params = {}
|
325
|
+
|
326
|
+
# http body (model)
|
327
|
+
post_body = @api_client.object_to_http_body(room_for_create)
|
328
|
+
auth_names = []
|
329
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
330
|
+
:header_params => header_params,
|
331
|
+
:query_params => query_params,
|
332
|
+
:form_params => form_params,
|
333
|
+
:body => post_body,
|
334
|
+
:auth_names => auth_names,
|
335
|
+
:return_type => 'Room')
|
336
|
+
if @api_client.config.debugging
|
337
|
+
@api_client.config.logger.debug "API called: RoomsApi#create_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
338
|
+
end
|
339
|
+
return data, status_code, headers
|
340
|
+
end
|
341
|
+
|
342
|
+
# Deletes the room having the given room ID.
|
343
|
+
#
|
344
|
+
# @param room_id ID of the room to be deleted.
|
345
|
+
# @param account_id
|
346
|
+
# @return [nil]
|
347
|
+
def delete_room(room_id, account_id)
|
348
|
+
delete_room_with_http_info(room_id, account_id)
|
349
|
+
return nil
|
350
|
+
end
|
351
|
+
|
352
|
+
# Deletes the room having the given room ID.
|
353
|
+
#
|
354
|
+
# @param room_id ID of the room to be deleted.
|
355
|
+
# @param account_id
|
356
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
357
|
+
def delete_room_with_http_info(room_id, account_id)
|
358
|
+
if @api_client.config.debugging
|
359
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.delete_room ..."
|
360
|
+
end
|
361
|
+
# verify the required parameter 'room_id' is set
|
362
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.delete_room" if room_id.nil?
|
363
|
+
# verify the required parameter 'account_id' is set
|
364
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.delete_room" if account_id.nil?
|
365
|
+
# resource path
|
366
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
367
|
+
|
368
|
+
# query parameters
|
369
|
+
query_params = {}
|
370
|
+
|
371
|
+
# header parameters
|
372
|
+
header_params = {}
|
373
|
+
# HTTP header 'Accept' (if needed)
|
374
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
375
|
+
|
376
|
+
# form parameters
|
377
|
+
form_params = {}
|
378
|
+
|
379
|
+
# http body (model)
|
380
|
+
post_body = nil
|
381
|
+
auth_names = []
|
382
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
383
|
+
:header_params => header_params,
|
384
|
+
:query_params => query_params,
|
385
|
+
:form_params => form_params,
|
386
|
+
:body => post_body,
|
387
|
+
:auth_names => auth_names)
|
388
|
+
if @api_client.config.debugging
|
389
|
+
@api_client.config.logger.debug "API called: RoomsApi#delete_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
390
|
+
end
|
391
|
+
return data, status_code, headers
|
392
|
+
end
|
393
|
+
|
394
|
+
# Returns the roles for which the calling user, based on their role within the room, can assign to invitees.
|
395
|
+
#
|
396
|
+
# @param room_id
|
397
|
+
# @param account_id
|
398
|
+
# @param DocuSign_Rooms::GetAssignableRolesOptions Options for modifying the behavior of the function.
|
399
|
+
# @return [AssignableRoles]
|
400
|
+
def get_assignable_roles(room_id, account_id, options = DocuSign_Rooms::GetAssignableRolesOptions.default)
|
401
|
+
data, _status_code, _headers = get_assignable_roles_with_http_info(room_id, account_id, options)
|
402
|
+
return data
|
403
|
+
end
|
404
|
+
|
405
|
+
# Returns the roles for which the calling user, based on their role within the room, can assign to invitees.
|
406
|
+
#
|
407
|
+
# @param room_id
|
408
|
+
# @param account_id
|
409
|
+
# @param DocuSign_Rooms::GetAssignableRolesOptions Options for modifying the behavior of the function.
|
410
|
+
# @return [Array<(AssignableRoles, Fixnum, Hash)>] AssignableRoles data, response status code and response headers
|
411
|
+
def get_assignable_roles_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetAssignableRolesOptions.default)
|
412
|
+
if @api_client.config.debugging
|
413
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.get_assignable_roles ..."
|
414
|
+
end
|
415
|
+
# verify the required parameter 'room_id' is set
|
416
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_assignable_roles" if room_id.nil?
|
417
|
+
# verify the required parameter 'account_id' is set
|
418
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_assignable_roles" if account_id.nil?
|
419
|
+
# resource path
|
420
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/assignable_roles".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
421
|
+
|
422
|
+
# query parameters
|
423
|
+
query_params = {}
|
424
|
+
query_params[:'assigneeEmail'] = options.assignee_email if !options.assignee_email.nil?
|
425
|
+
query_params[:'filter'] = options.filter if !options.filter.nil?
|
426
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
427
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
428
|
+
|
429
|
+
# header parameters
|
430
|
+
header_params = {}
|
431
|
+
# HTTP header 'Accept' (if needed)
|
432
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
433
|
+
|
434
|
+
# form parameters
|
435
|
+
form_params = {}
|
436
|
+
|
437
|
+
# http body (model)
|
438
|
+
post_body = nil
|
439
|
+
auth_names = []
|
440
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
441
|
+
:header_params => header_params,
|
442
|
+
:query_params => query_params,
|
443
|
+
:form_params => form_params,
|
444
|
+
:body => post_body,
|
445
|
+
:auth_names => auth_names,
|
446
|
+
:return_type => 'AssignableRoles')
|
447
|
+
if @api_client.config.debugging
|
448
|
+
@api_client.config.logger.debug "API called: RoomsApi#get_assignable_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
449
|
+
end
|
450
|
+
return data, status_code, headers
|
451
|
+
end
|
452
|
+
|
453
|
+
# Get documents in the room accessible to the calling user.
|
454
|
+
#
|
455
|
+
# @param room_id
|
456
|
+
# @param account_id
|
457
|
+
# @param DocuSign_Rooms::GetDocumentsOptions Options for modifying the behavior of the function.
|
458
|
+
# @return [RoomDocumentList]
|
459
|
+
def get_documents(room_id, account_id, options = DocuSign_Rooms::GetDocumentsOptions.default)
|
460
|
+
data, _status_code, _headers = get_documents_with_http_info(room_id, account_id, options)
|
461
|
+
return data
|
462
|
+
end
|
463
|
+
|
464
|
+
# Get documents in the room accessible to the calling user.
|
465
|
+
#
|
466
|
+
# @param room_id
|
467
|
+
# @param account_id
|
468
|
+
# @param DocuSign_Rooms::GetDocumentsOptions Options for modifying the behavior of the function.
|
469
|
+
# @return [Array<(RoomDocumentList, Fixnum, Hash)>] RoomDocumentList data, response status code and response headers
|
470
|
+
def get_documents_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetDocumentsOptions.default)
|
471
|
+
if @api_client.config.debugging
|
472
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.get_documents ..."
|
473
|
+
end
|
474
|
+
# verify the required parameter 'room_id' is set
|
475
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_documents" if room_id.nil?
|
476
|
+
# verify the required parameter 'account_id' is set
|
477
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_documents" if account_id.nil?
|
478
|
+
# resource path
|
479
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/documents".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
480
|
+
|
481
|
+
# query parameters
|
482
|
+
query_params = {}
|
483
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
484
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
485
|
+
|
486
|
+
# header parameters
|
487
|
+
header_params = {}
|
488
|
+
# HTTP header 'Accept' (if needed)
|
489
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
490
|
+
|
491
|
+
# form parameters
|
492
|
+
form_params = {}
|
493
|
+
|
494
|
+
# http body (model)
|
495
|
+
post_body = nil
|
496
|
+
auth_names = []
|
497
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
498
|
+
:header_params => header_params,
|
499
|
+
:query_params => query_params,
|
500
|
+
:form_params => form_params,
|
501
|
+
:body => post_body,
|
502
|
+
:auth_names => auth_names,
|
503
|
+
:return_type => 'RoomDocumentList')
|
504
|
+
if @api_client.config.debugging
|
505
|
+
@api_client.config.logger.debug "API called: RoomsApi#get_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
506
|
+
end
|
507
|
+
return data, status_code, headers
|
508
|
+
end
|
509
|
+
|
510
|
+
# Gets information about the given room.
|
511
|
+
#
|
512
|
+
# @param room_id
|
513
|
+
# @param account_id
|
514
|
+
# @param DocuSign_Rooms::GetRoomOptions Options for modifying the behavior of the function.
|
515
|
+
# @return [Room]
|
516
|
+
def get_room(room_id, account_id, options = DocuSign_Rooms::GetRoomOptions.default)
|
517
|
+
data, _status_code, _headers = get_room_with_http_info(room_id, account_id, options)
|
518
|
+
return data
|
519
|
+
end
|
520
|
+
|
521
|
+
# Gets information about the given room.
|
522
|
+
#
|
523
|
+
# @param room_id
|
524
|
+
# @param account_id
|
525
|
+
# @param DocuSign_Rooms::GetRoomOptions Options for modifying the behavior of the function.
|
526
|
+
# @return [Array<(Room, Fixnum, Hash)>] Room data, response status code and response headers
|
527
|
+
def get_room_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomOptions.default)
|
528
|
+
if @api_client.config.debugging
|
529
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.get_room ..."
|
530
|
+
end
|
531
|
+
# verify the required parameter 'room_id' is set
|
532
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room" if room_id.nil?
|
533
|
+
# verify the required parameter 'account_id' is set
|
534
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room" if account_id.nil?
|
535
|
+
# resource path
|
536
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
537
|
+
|
538
|
+
# query parameters
|
539
|
+
query_params = {}
|
540
|
+
query_params[:'includeFieldData'] = options.include_field_data if !options.include_field_data.nil?
|
541
|
+
|
542
|
+
# header parameters
|
543
|
+
header_params = {}
|
544
|
+
# HTTP header 'Accept' (if needed)
|
545
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
546
|
+
|
547
|
+
# form parameters
|
548
|
+
form_params = {}
|
549
|
+
|
550
|
+
# http body (model)
|
551
|
+
post_body = nil
|
552
|
+
auth_names = []
|
553
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
554
|
+
:header_params => header_params,
|
555
|
+
:query_params => query_params,
|
556
|
+
:form_params => form_params,
|
557
|
+
:body => post_body,
|
558
|
+
:auth_names => auth_names,
|
559
|
+
:return_type => 'Room')
|
560
|
+
if @api_client.config.debugging
|
561
|
+
@api_client.config.logger.debug "API called: RoomsApi#get_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
562
|
+
end
|
563
|
+
return data, status_code, headers
|
564
|
+
end
|
565
|
+
|
566
|
+
# Returns the FieldData associated with the provided roomId.
|
567
|
+
#
|
568
|
+
# @param room_id
|
569
|
+
# @param account_id
|
570
|
+
# @return [FieldData]
|
571
|
+
def get_room_field_data(room_id, account_id)
|
572
|
+
data, _status_code, _headers = get_room_field_data_with_http_info(room_id, account_id)
|
573
|
+
return data
|
574
|
+
end
|
575
|
+
|
576
|
+
# Returns the FieldData associated with the provided roomId.
|
577
|
+
#
|
578
|
+
# @param room_id
|
579
|
+
# @param account_id
|
580
|
+
# @return [Array<(FieldData, Fixnum, Hash)>] FieldData data, response status code and response headers
|
581
|
+
def get_room_field_data_with_http_info(room_id, account_id)
|
582
|
+
if @api_client.config.debugging
|
583
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.get_room_field_data ..."
|
584
|
+
end
|
585
|
+
# verify the required parameter 'room_id' is set
|
586
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room_field_data" if room_id.nil?
|
587
|
+
# verify the required parameter 'account_id' is set
|
588
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room_field_data" if account_id.nil?
|
589
|
+
# resource path
|
590
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/field_data".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
591
|
+
|
592
|
+
# query parameters
|
593
|
+
query_params = {}
|
594
|
+
|
595
|
+
# header parameters
|
596
|
+
header_params = {}
|
597
|
+
# HTTP header 'Accept' (if needed)
|
598
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
599
|
+
|
600
|
+
# form parameters
|
601
|
+
form_params = {}
|
602
|
+
|
603
|
+
# http body (model)
|
604
|
+
post_body = nil
|
605
|
+
auth_names = []
|
606
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
607
|
+
:header_params => header_params,
|
608
|
+
:query_params => query_params,
|
609
|
+
:form_params => form_params,
|
610
|
+
:body => post_body,
|
611
|
+
:auth_names => auth_names,
|
612
|
+
:return_type => 'FieldData')
|
613
|
+
if @api_client.config.debugging
|
614
|
+
@api_client.config.logger.debug "API called: RoomsApi#get_room_field_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
615
|
+
end
|
616
|
+
return data, status_code, headers
|
617
|
+
end
|
618
|
+
|
619
|
+
# Gets the field set associated with the room.
|
620
|
+
#
|
621
|
+
# @param room_id
|
622
|
+
# @param account_id
|
623
|
+
# @return [FieldSet]
|
624
|
+
def get_room_field_set(room_id, account_id)
|
625
|
+
data, _status_code, _headers = get_room_field_set_with_http_info(room_id, account_id)
|
626
|
+
return data
|
627
|
+
end
|
628
|
+
|
629
|
+
# Gets the field set associated with the room.
|
630
|
+
#
|
631
|
+
# @param room_id
|
632
|
+
# @param account_id
|
633
|
+
# @return [Array<(FieldSet, Fixnum, Hash)>] FieldSet data, response status code and response headers
|
634
|
+
def get_room_field_set_with_http_info(room_id, account_id)
|
635
|
+
if @api_client.config.debugging
|
636
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.get_room_field_set ..."
|
637
|
+
end
|
638
|
+
# verify the required parameter 'room_id' is set
|
639
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room_field_set" if room_id.nil?
|
640
|
+
# verify the required parameter 'account_id' is set
|
641
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room_field_set" if account_id.nil?
|
642
|
+
# resource path
|
643
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/field_set".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
644
|
+
|
645
|
+
# query parameters
|
646
|
+
query_params = {}
|
647
|
+
|
648
|
+
# header parameters
|
649
|
+
header_params = {}
|
650
|
+
# HTTP header 'Accept' (if needed)
|
651
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
652
|
+
|
653
|
+
# form parameters
|
654
|
+
form_params = {}
|
655
|
+
|
656
|
+
# http body (model)
|
657
|
+
post_body = nil
|
658
|
+
auth_names = []
|
659
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
660
|
+
:header_params => header_params,
|
661
|
+
:query_params => query_params,
|
662
|
+
:form_params => form_params,
|
663
|
+
:body => post_body,
|
664
|
+
:auth_names => auth_names,
|
665
|
+
:return_type => 'FieldSet')
|
666
|
+
if @api_client.config.debugging
|
667
|
+
@api_client.config.logger.debug "API called: RoomsApi#get_room_field_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
668
|
+
end
|
669
|
+
return data, status_code, headers
|
670
|
+
end
|
671
|
+
|
672
|
+
# Retrieves the list of users in the given room.
|
673
|
+
#
|
674
|
+
# @param room_id
|
675
|
+
# @param account_id
|
676
|
+
# @param DocuSign_Rooms::GetRoomUsersOptions Options for modifying the behavior of the function.
|
677
|
+
# @return [RoomUsersResult]
|
678
|
+
def get_room_users(room_id, account_id, options = DocuSign_Rooms::GetRoomUsersOptions.default)
|
679
|
+
data, _status_code, _headers = get_room_users_with_http_info(room_id, account_id, options)
|
680
|
+
return data
|
681
|
+
end
|
682
|
+
|
683
|
+
# Retrieves the list of users in the given room.
|
684
|
+
#
|
685
|
+
# @param room_id
|
686
|
+
# @param account_id
|
687
|
+
# @param DocuSign_Rooms::GetRoomUsersOptions Options for modifying the behavior of the function.
|
688
|
+
# @return [Array<(RoomUsersResult, Fixnum, Hash)>] RoomUsersResult data, response status code and response headers
|
689
|
+
def get_room_users_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomUsersOptions.default)
|
690
|
+
if @api_client.config.debugging
|
691
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.get_room_users ..."
|
692
|
+
end
|
693
|
+
# verify the required parameter 'room_id' is set
|
694
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room_users" if room_id.nil?
|
695
|
+
# verify the required parameter 'account_id' is set
|
696
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room_users" if account_id.nil?
|
697
|
+
if options.sort && !['FirstNameAsc', 'LastNameAsc', 'EmailAsc', 'FirstNameDesc', 'LastNameDesc', 'EmailDesc'].include?(options.sort)
|
698
|
+
fail ArgumentError, 'invalid value for "sort", must be one of FirstNameAsc, LastNameAsc, EmailAsc, FirstNameDesc, LastNameDesc, EmailDesc'
|
699
|
+
end
|
700
|
+
# resource path
|
701
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
702
|
+
|
703
|
+
# query parameters
|
704
|
+
query_params = {}
|
705
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
706
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
707
|
+
query_params[:'filter'] = options.filter if !options.filter.nil?
|
708
|
+
query_params[:'sort'] = options.sort if !options.sort.nil?
|
709
|
+
|
710
|
+
# header parameters
|
711
|
+
header_params = {}
|
712
|
+
# HTTP header 'Accept' (if needed)
|
713
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
714
|
+
|
715
|
+
# form parameters
|
716
|
+
form_params = {}
|
717
|
+
|
718
|
+
# http body (model)
|
719
|
+
post_body = nil
|
720
|
+
auth_names = []
|
721
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
722
|
+
:header_params => header_params,
|
723
|
+
:query_params => query_params,
|
724
|
+
:form_params => form_params,
|
725
|
+
:body => post_body,
|
726
|
+
:auth_names => auth_names,
|
727
|
+
:return_type => 'RoomUsersResult')
|
728
|
+
if @api_client.config.debugging
|
729
|
+
@api_client.config.logger.debug "API called: RoomsApi#get_room_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
730
|
+
end
|
731
|
+
return data, status_code, headers
|
732
|
+
end
|
733
|
+
|
734
|
+
# Gets rooms available to the calling user.
|
735
|
+
#
|
736
|
+
# @param account_id
|
737
|
+
# @param DocuSign_Rooms::GetRoomsOptions Options for modifying the behavior of the function.
|
738
|
+
# @return [RoomSummaryList]
|
739
|
+
def get_rooms(account_id, options = DocuSign_Rooms::GetRoomsOptions.default)
|
740
|
+
data, _status_code, _headers = get_rooms_with_http_info(account_id, options)
|
741
|
+
return data
|
742
|
+
end
|
743
|
+
|
744
|
+
# Gets rooms available to the calling user.
|
745
|
+
#
|
746
|
+
# @param account_id
|
747
|
+
# @param DocuSign_Rooms::GetRoomsOptions Options for modifying the behavior of the function.
|
748
|
+
# @return [Array<(RoomSummaryList, Fixnum, Hash)>] RoomSummaryList data, response status code and response headers
|
749
|
+
def get_rooms_with_http_info(account_id, options = DocuSign_Rooms::GetRoomsOptions.default)
|
750
|
+
if @api_client.config.debugging
|
751
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.get_rooms ..."
|
752
|
+
end
|
753
|
+
# verify the required parameter 'account_id' is set
|
754
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_rooms" if account_id.nil?
|
755
|
+
if options.room_status && !['Active', 'Pending', 'Closed', 'Open'].include?(options.room_status)
|
756
|
+
fail ArgumentError, 'invalid value for "room_status", must be one of Active, Pending, Closed, Open'
|
757
|
+
end
|
758
|
+
# resource path
|
759
|
+
local_var_path = "/v2/accounts/{accountId}/rooms".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
760
|
+
|
761
|
+
# query parameters
|
762
|
+
query_params = {}
|
763
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
764
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
765
|
+
query_params[:'roomStatus'] = options.room_status if !options.room_status.nil?
|
766
|
+
query_params[:'officeId'] = options.office_id if !options.office_id.nil?
|
767
|
+
query_params[:'fieldDataChangedStartDate'] = options.field_data_changed_start_date if !options.field_data_changed_start_date.nil?
|
768
|
+
query_params[:'fieldDataChangedEndDate'] = options.field_data_changed_end_date if !options.field_data_changed_end_date.nil?
|
769
|
+
query_params[:'roomClosedStartDate'] = options.room_closed_start_date if !options.room_closed_start_date.nil?
|
770
|
+
query_params[:'roomClosedEndDate'] = options.room_closed_end_date if !options.room_closed_end_date.nil?
|
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
|
+
|
777
|
+
# form parameters
|
778
|
+
form_params = {}
|
779
|
+
|
780
|
+
# http body (model)
|
781
|
+
post_body = nil
|
782
|
+
auth_names = []
|
783
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
784
|
+
:header_params => header_params,
|
785
|
+
:query_params => query_params,
|
786
|
+
:form_params => form_params,
|
787
|
+
:body => post_body,
|
788
|
+
:auth_names => auth_names,
|
789
|
+
:return_type => 'RoomSummaryList')
|
790
|
+
if @api_client.config.debugging
|
791
|
+
@api_client.config.logger.debug "API called: RoomsApi#get_rooms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
792
|
+
end
|
793
|
+
return data, status_code, headers
|
794
|
+
end
|
795
|
+
|
796
|
+
# Invites a user to the room by email address.
|
797
|
+
#
|
798
|
+
# @param room_id
|
799
|
+
# @param account_id
|
800
|
+
# @param room_invite_request
|
801
|
+
# @return [RoomInviteResponse]
|
802
|
+
def invite_user(room_id, account_id, room_invite_request)
|
803
|
+
data, _status_code, _headers = invite_user_with_http_info(room_id, account_id, room_invite_request)
|
804
|
+
return data
|
805
|
+
end
|
806
|
+
|
807
|
+
# Invites a user to the room by email address.
|
808
|
+
#
|
809
|
+
# @param room_id
|
810
|
+
# @param account_id
|
811
|
+
# @param room_invite_request
|
812
|
+
# @return [Array<(RoomInviteResponse, Fixnum, Hash)>] RoomInviteResponse data, response status code and response headers
|
813
|
+
def invite_user_with_http_info(room_id, account_id, room_invite_request)
|
814
|
+
if @api_client.config.debugging
|
815
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.invite_user ..."
|
816
|
+
end
|
817
|
+
# verify the required parameter 'room_id' is set
|
818
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.invite_user" if room_id.nil?
|
819
|
+
# verify the required parameter 'room_invite_request' is set
|
820
|
+
fail ArgumentError, "Missing the required parameter 'room_invite_request' when calling RoomsApi.invite_user" if room_invite_request.nil?
|
821
|
+
# verify the required parameter 'account_id' is set
|
822
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.invite_user" if account_id.nil?
|
823
|
+
# resource path
|
824
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
825
|
+
|
826
|
+
# query parameters
|
827
|
+
query_params = {}
|
828
|
+
|
829
|
+
# header parameters
|
830
|
+
header_params = {}
|
831
|
+
# HTTP header 'Accept' (if needed)
|
832
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
833
|
+
# HTTP header 'Content-Type'
|
834
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
835
|
+
|
836
|
+
# form parameters
|
837
|
+
form_params = {}
|
838
|
+
|
839
|
+
# http body (model)
|
840
|
+
post_body = @api_client.object_to_http_body(room_invite_request)
|
841
|
+
auth_names = []
|
842
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
843
|
+
:header_params => header_params,
|
844
|
+
:query_params => query_params,
|
845
|
+
:form_params => form_params,
|
846
|
+
:body => post_body,
|
847
|
+
:auth_names => auth_names,
|
848
|
+
:return_type => 'RoomInviteResponse')
|
849
|
+
if @api_client.config.debugging
|
850
|
+
@api_client.config.logger.debug "API called: RoomsApi#invite_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
851
|
+
end
|
852
|
+
return data, status_code, headers
|
853
|
+
end
|
854
|
+
|
855
|
+
# Updates the specified user's role and transaction side.
|
856
|
+
#
|
857
|
+
# @param room_id
|
858
|
+
# @param user_id
|
859
|
+
# @param account_id
|
860
|
+
# @param room_user_for_update
|
861
|
+
# @return [RoomUser]
|
862
|
+
def put_room_user(room_id, user_id, account_id, room_user_for_update)
|
863
|
+
data, _status_code, _headers = put_room_user_with_http_info(room_id, user_id, account_id, room_user_for_update)
|
864
|
+
return data
|
865
|
+
end
|
866
|
+
|
867
|
+
# Updates the specified user's role and transaction side.
|
868
|
+
#
|
869
|
+
# @param room_id
|
870
|
+
# @param user_id
|
871
|
+
# @param account_id
|
872
|
+
# @param room_user_for_update
|
873
|
+
# @return [Array<(RoomUser, Fixnum, Hash)>] RoomUser data, response status code and response headers
|
874
|
+
def put_room_user_with_http_info(room_id, user_id, account_id, room_user_for_update)
|
875
|
+
if @api_client.config.debugging
|
876
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.put_room_user ..."
|
877
|
+
end
|
878
|
+
# verify the required parameter 'room_id' is set
|
879
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.put_room_user" if room_id.nil?
|
880
|
+
# verify the required parameter 'user_id' is set
|
881
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling RoomsApi.put_room_user" if user_id.nil?
|
882
|
+
# verify the required parameter 'room_user_for_update' is set
|
883
|
+
fail ArgumentError, "Missing the required parameter 'room_user_for_update' when calling RoomsApi.put_room_user" if room_user_for_update.nil?
|
884
|
+
# verify the required parameter 'account_id' is set
|
885
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.put_room_user" if account_id.nil?
|
886
|
+
# resource path
|
887
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
888
|
+
|
889
|
+
# query parameters
|
890
|
+
query_params = {}
|
891
|
+
|
892
|
+
# header parameters
|
893
|
+
header_params = {}
|
894
|
+
# HTTP header 'Accept' (if needed)
|
895
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
896
|
+
# HTTP header 'Content-Type'
|
897
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
898
|
+
|
899
|
+
# form parameters
|
900
|
+
form_params = {}
|
901
|
+
|
902
|
+
# http body (model)
|
903
|
+
post_body = @api_client.object_to_http_body(room_user_for_update)
|
904
|
+
auth_names = []
|
905
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
906
|
+
:header_params => header_params,
|
907
|
+
:query_params => query_params,
|
908
|
+
:form_params => form_params,
|
909
|
+
:body => post_body,
|
910
|
+
:auth_names => auth_names,
|
911
|
+
:return_type => 'RoomUser')
|
912
|
+
if @api_client.config.debugging
|
913
|
+
@api_client.config.logger.debug "API called: RoomsApi#put_room_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
914
|
+
end
|
915
|
+
return data, status_code, headers
|
916
|
+
end
|
917
|
+
|
918
|
+
# Restores the specified user's access to the room.
|
919
|
+
#
|
920
|
+
# @param room_id The room Id to restore access
|
921
|
+
# @param user_id The user Id getting restored to the room
|
922
|
+
# @param account_id
|
923
|
+
# @return [nil]
|
924
|
+
def restore_room_user_access(room_id, user_id, account_id)
|
925
|
+
restore_room_user_access_with_http_info(room_id, user_id, account_id)
|
926
|
+
return nil
|
927
|
+
end
|
928
|
+
|
929
|
+
# Restores the specified user's access to the room.
|
930
|
+
#
|
931
|
+
# @param room_id The room Id to restore access
|
932
|
+
# @param user_id The user Id getting restored to the room
|
933
|
+
# @param account_id
|
934
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
935
|
+
def restore_room_user_access_with_http_info(room_id, user_id, account_id)
|
936
|
+
if @api_client.config.debugging
|
937
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.restore_room_user_access ..."
|
938
|
+
end
|
939
|
+
# verify the required parameter 'room_id' is set
|
940
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.restore_room_user_access" if room_id.nil?
|
941
|
+
# verify the required parameter 'user_id' is set
|
942
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling RoomsApi.restore_room_user_access" if user_id.nil?
|
943
|
+
# verify the required parameter 'account_id' is set
|
944
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.restore_room_user_access" if account_id.nil?
|
945
|
+
# resource path
|
946
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/restore_access".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
947
|
+
|
948
|
+
# query parameters
|
949
|
+
query_params = {}
|
950
|
+
|
951
|
+
# header parameters
|
952
|
+
header_params = {}
|
953
|
+
# HTTP header 'Accept' (if needed)
|
954
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
955
|
+
|
956
|
+
# form parameters
|
957
|
+
form_params = {}
|
958
|
+
|
959
|
+
# http body (model)
|
960
|
+
post_body = nil
|
961
|
+
auth_names = []
|
962
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
963
|
+
:header_params => header_params,
|
964
|
+
:query_params => query_params,
|
965
|
+
:form_params => form_params,
|
966
|
+
:body => post_body,
|
967
|
+
:auth_names => auth_names)
|
968
|
+
if @api_client.config.debugging
|
969
|
+
@api_client.config.logger.debug "API called: RoomsApi#restore_room_user_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
970
|
+
end
|
971
|
+
return data, status_code, headers
|
972
|
+
end
|
973
|
+
|
974
|
+
# Revokes the specified user's access to the room.
|
975
|
+
#
|
976
|
+
# @param room_id The room Id to revoke access from
|
977
|
+
# @param user_id The user Id getting revoked from the room
|
978
|
+
# @param account_id
|
979
|
+
# @param room_user_removal_detail Contains the date on which the users room access should be revoked (optional parameter)
|
980
|
+
# @return [nil]
|
981
|
+
def revoke_room_user_access(room_id, user_id, account_id, room_user_removal_detail)
|
982
|
+
revoke_room_user_access_with_http_info(room_id, user_id, account_id, room_user_removal_detail)
|
983
|
+
return nil
|
984
|
+
end
|
985
|
+
|
986
|
+
# Revokes the specified user's access to the room.
|
987
|
+
#
|
988
|
+
# @param room_id The room Id to revoke access from
|
989
|
+
# @param user_id The user Id getting revoked from the room
|
990
|
+
# @param account_id
|
991
|
+
# @param room_user_removal_detail Contains the date on which the users room access should be revoked (optional parameter)
|
992
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
993
|
+
def revoke_room_user_access_with_http_info(room_id, user_id, account_id, room_user_removal_detail)
|
994
|
+
if @api_client.config.debugging
|
995
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.revoke_room_user_access ..."
|
996
|
+
end
|
997
|
+
# verify the required parameter 'room_id' is set
|
998
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.revoke_room_user_access" if room_id.nil?
|
999
|
+
# verify the required parameter 'user_id' is set
|
1000
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling RoomsApi.revoke_room_user_access" if user_id.nil?
|
1001
|
+
# verify the required parameter 'account_id' is set
|
1002
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.revoke_room_user_access" if account_id.nil?
|
1003
|
+
# resource path
|
1004
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/revoke_access".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
1005
|
+
|
1006
|
+
# query parameters
|
1007
|
+
query_params = {}
|
1008
|
+
|
1009
|
+
# header parameters
|
1010
|
+
header_params = {}
|
1011
|
+
# HTTP header 'Accept' (if needed)
|
1012
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1013
|
+
# HTTP header 'Content-Type'
|
1014
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1015
|
+
|
1016
|
+
# form parameters
|
1017
|
+
form_params = {}
|
1018
|
+
|
1019
|
+
# http body (model)
|
1020
|
+
post_body = @api_client.object_to_http_body(room_user_removal_detail)
|
1021
|
+
auth_names = []
|
1022
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1023
|
+
:header_params => header_params,
|
1024
|
+
:query_params => query_params,
|
1025
|
+
:form_params => form_params,
|
1026
|
+
:body => post_body,
|
1027
|
+
:auth_names => auth_names)
|
1028
|
+
if @api_client.config.debugging
|
1029
|
+
@api_client.config.logger.debug "API called: RoomsApi#revoke_room_user_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1030
|
+
end
|
1031
|
+
return data, status_code, headers
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# Update the picture for a room.
|
1035
|
+
# This endpoint supports the following content types, application/json as JSON PictureForUpdate{\"fileName\":\"string\", \"Base64Contents\":\"string\"}, multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).
|
1036
|
+
# @param room_id ID of the room the picture is for.
|
1037
|
+
# @param account_id
|
1038
|
+
# @return [RoomPicture]
|
1039
|
+
def update_picture(room_id, account_id)
|
1040
|
+
data, _status_code, _headers = update_picture_with_http_info(room_id, account_id)
|
1041
|
+
return data
|
1042
|
+
end
|
1043
|
+
|
1044
|
+
# Update the picture for a room.
|
1045
|
+
# This endpoint supports the following content types, application/json as JSON PictureForUpdate{\"fileName\":\"string\", \"Base64Contents\":\"string\"}, multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).
|
1046
|
+
# @param room_id ID of the room the picture is for.
|
1047
|
+
# @param account_id
|
1048
|
+
# @return [Array<(RoomPicture, Fixnum, Hash)>] RoomPicture data, response status code and response headers
|
1049
|
+
def update_picture_with_http_info(room_id, account_id)
|
1050
|
+
if @api_client.config.debugging
|
1051
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.update_picture ..."
|
1052
|
+
end
|
1053
|
+
# verify the required parameter 'room_id' is set
|
1054
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.update_picture" if room_id.nil?
|
1055
|
+
# verify the required parameter 'account_id' is set
|
1056
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.update_picture" if account_id.nil?
|
1057
|
+
# resource path
|
1058
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/picture".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
1059
|
+
|
1060
|
+
# query parameters
|
1061
|
+
query_params = {}
|
1062
|
+
|
1063
|
+
# header parameters
|
1064
|
+
header_params = {}
|
1065
|
+
# HTTP header 'Accept' (if needed)
|
1066
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1067
|
+
|
1068
|
+
# form parameters
|
1069
|
+
form_params = {}
|
1070
|
+
|
1071
|
+
# http body (model)
|
1072
|
+
post_body = nil
|
1073
|
+
auth_names = []
|
1074
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1075
|
+
:header_params => header_params,
|
1076
|
+
:query_params => query_params,
|
1077
|
+
:form_params => form_params,
|
1078
|
+
:body => post_body,
|
1079
|
+
:auth_names => auth_names,
|
1080
|
+
:return_type => 'RoomPicture')
|
1081
|
+
if @api_client.config.debugging
|
1082
|
+
@api_client.config.logger.debug "API called: RoomsApi#update_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1083
|
+
end
|
1084
|
+
return data, status_code, headers
|
1085
|
+
end
|
1086
|
+
|
1087
|
+
# Updates room field data.
|
1088
|
+
#
|
1089
|
+
# @param room_id
|
1090
|
+
# @param account_id
|
1091
|
+
# @param field_data_for_update
|
1092
|
+
# @return [FieldData]
|
1093
|
+
def update_room_field_data(room_id, account_id, field_data_for_update)
|
1094
|
+
data, _status_code, _headers = update_room_field_data_with_http_info(room_id, account_id, field_data_for_update)
|
1095
|
+
return data
|
1096
|
+
end
|
1097
|
+
|
1098
|
+
# Updates room field data.
|
1099
|
+
#
|
1100
|
+
# @param room_id
|
1101
|
+
# @param account_id
|
1102
|
+
# @param field_data_for_update
|
1103
|
+
# @return [Array<(FieldData, Fixnum, Hash)>] FieldData data, response status code and response headers
|
1104
|
+
def update_room_field_data_with_http_info(room_id, account_id, field_data_for_update)
|
1105
|
+
if @api_client.config.debugging
|
1106
|
+
@api_client.config.logger.debug "Calling API: RoomsApi.update_room_field_data ..."
|
1107
|
+
end
|
1108
|
+
# verify the required parameter 'room_id' is set
|
1109
|
+
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.update_room_field_data" if room_id.nil?
|
1110
|
+
# verify the required parameter 'field_data_for_update' is set
|
1111
|
+
fail ArgumentError, "Missing the required parameter 'field_data_for_update' when calling RoomsApi.update_room_field_data" if field_data_for_update.nil?
|
1112
|
+
# verify the required parameter 'account_id' is set
|
1113
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.update_room_field_data" if account_id.nil?
|
1114
|
+
# resource path
|
1115
|
+
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/field_data".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
1116
|
+
|
1117
|
+
# query parameters
|
1118
|
+
query_params = {}
|
1119
|
+
|
1120
|
+
# header parameters
|
1121
|
+
header_params = {}
|
1122
|
+
# HTTP header 'Accept' (if needed)
|
1123
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1124
|
+
# HTTP header 'Content-Type'
|
1125
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1126
|
+
|
1127
|
+
# form parameters
|
1128
|
+
form_params = {}
|
1129
|
+
|
1130
|
+
# http body (model)
|
1131
|
+
post_body = @api_client.object_to_http_body(field_data_for_update)
|
1132
|
+
auth_names = []
|
1133
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1134
|
+
:header_params => header_params,
|
1135
|
+
:query_params => query_params,
|
1136
|
+
:form_params => form_params,
|
1137
|
+
:body => post_body,
|
1138
|
+
:auth_names => auth_names,
|
1139
|
+
:return_type => 'FieldData')
|
1140
|
+
if @api_client.config.debugging
|
1141
|
+
@api_client.config.logger.debug "API called: RoomsApi#update_room_field_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1142
|
+
end
|
1143
|
+
return data, status_code, headers
|
1144
|
+
end
|
1145
|
+
end
|
1146
|
+
end
|