xbim_comms 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +210 -0
  4. data/Rakefile +10 -0
  5. data/lib/xbim_comms/api/contacts_api.rb +206 -0
  6. data/lib/xbim_comms/api/conversations_api.rb +2670 -0
  7. data/lib/xbim_comms/api/files_api.rb +107 -0
  8. data/lib/xbim_comms/api/snapshots_api.rb +100 -0
  9. data/lib/xbim_comms/api_client.rb +390 -0
  10. data/lib/xbim_comms/api_error.rb +57 -0
  11. data/lib/xbim_comms/configuration.rb +278 -0
  12. data/lib/xbim_comms/models/aggregate.rb +227 -0
  13. data/lib/xbim_comms/models/aggregate_list_value.rb +220 -0
  14. data/lib/xbim_comms/models/analytical_result.rb +270 -0
  15. data/lib/xbim_comms/models/analytical_result_all_of.rb +258 -0
  16. data/lib/xbim_comms/models/animation.rb +232 -0
  17. data/lib/xbim_comms/models/animation_all_of.rb +220 -0
  18. data/lib/xbim_comms/models/bitmap.rb +303 -0
  19. data/lib/xbim_comms/models/blob.rb +245 -0
  20. data/lib/xbim_comms/models/boolean_value.rb +218 -0
  21. data/lib/xbim_comms/models/clipping_plane.rb +231 -0
  22. data/lib/xbim_comms/models/coloring.rb +229 -0
  23. data/lib/xbim_comms/models/column_request.rb +279 -0
  24. data/lib/xbim_comms/models/component.rb +236 -0
  25. data/lib/xbim_comms/models/components.rb +240 -0
  26. data/lib/xbim_comms/models/contact.rb +227 -0
  27. data/lib/xbim_comms/models/contact_list.rb +238 -0
  28. data/lib/xbim_comms/models/conversation.rb +392 -0
  29. data/lib/xbim_comms/models/conversation_create.rb +273 -0
  30. data/lib/xbim_comms/models/conversation_list.rb +238 -0
  31. data/lib/xbim_comms/models/conversation_tenant.rb +254 -0
  32. data/lib/xbim_comms/models/conversation_update.rb +302 -0
  33. data/lib/xbim_comms/models/entity_key.rb +227 -0
  34. data/lib/xbim_comms/models/exception_message.rb +245 -0
  35. data/lib/xbim_comms/models/file.rb +266 -0
  36. data/lib/xbim_comms/models/file_all_of.rb +254 -0
  37. data/lib/xbim_comms/models/int32_value.rb +218 -0
  38. data/lib/xbim_comms/models/key_frame.rb +236 -0
  39. data/lib/xbim_comms/models/line.rb +231 -0
  40. data/lib/xbim_comms/models/message.rb +416 -0
  41. data/lib/xbim_comms/models/message_content.rb +220 -0
  42. data/lib/xbim_comms/models/message_create.rb +273 -0
  43. data/lib/xbim_comms/models/message_list.rb +238 -0
  44. data/lib/xbim_comms/models/message_part.rb +246 -0
  45. data/lib/xbim_comms/models/message_update.rb +297 -0
  46. data/lib/xbim_comms/models/orthogonal_camera.rb +269 -0
  47. data/lib/xbim_comms/models/participant.rb +232 -0
  48. data/lib/xbim_comms/models/participant_with_role.rb +293 -0
  49. data/lib/xbim_comms/models/participant_with_role_create.rb +266 -0
  50. data/lib/xbim_comms/models/participant_with_role_list.rb +238 -0
  51. data/lib/xbim_comms/models/participant_with_role_update.rb +261 -0
  52. data/lib/xbim_comms/models/perspective_camera.rb +269 -0
  53. data/lib/xbim_comms/models/pie_chart.rb +257 -0
  54. data/lib/xbim_comms/models/pie_chart_all_of.rb +245 -0
  55. data/lib/xbim_comms/models/point.rb +227 -0
  56. data/lib/xbim_comms/models/preview_row.rb +220 -0
  57. data/lib/xbim_comms/models/schedule.rb +270 -0
  58. data/lib/xbim_comms/models/schedule_all_of.rb +258 -0
  59. data/lib/xbim_comms/models/schedule_column.rb +384 -0
  60. data/lib/xbim_comms/models/schedule_request.rb +252 -0
  61. data/lib/xbim_comms/models/schedule_request_all_of.rb +240 -0
  62. data/lib/xbim_comms/models/section_box.rb +274 -0
  63. data/lib/xbim_comms/models/sheet.rb +268 -0
  64. data/lib/xbim_comms/models/sheet_all_of.rb +256 -0
  65. data/lib/xbim_comms/models/sheet_part.rb +254 -0
  66. data/lib/xbim_comms/models/snapshot.rb +270 -0
  67. data/lib/xbim_comms/models/text.rb +220 -0
  68. data/lib/xbim_comms/models/view.rb +239 -0
  69. data/lib/xbim_comms/models/view_all_of.rb +227 -0
  70. data/lib/xbim_comms/models/view_setup_hints.rb +236 -0
  71. data/lib/xbim_comms/models/viewpoint.rb +296 -0
  72. data/lib/xbim_comms/models/visibility.rb +238 -0
  73. data/lib/xbim_comms/version.rb +15 -0
  74. data/lib/xbim_comms.rb +104 -0
  75. data/spec/api/contacts_api_spec.rb +74 -0
  76. data/spec/api/conversations_api_spec.rb +521 -0
  77. data/spec/api/files_api_spec.rb +50 -0
  78. data/spec/api/snapshots_api_spec.rb +49 -0
  79. data/spec/api_client_spec.rb +226 -0
  80. data/spec/configuration_spec.rb +42 -0
  81. data/spec/models/aggregate_list_value_spec.rb +34 -0
  82. data/spec/models/aggregate_spec.rb +40 -0
  83. data/spec/models/analytical_result_all_of_spec.rb +58 -0
  84. data/spec/models/analytical_result_spec.rb +58 -0
  85. data/spec/models/animation_all_of_spec.rb +34 -0
  86. data/spec/models/animation_spec.rb +34 -0
  87. data/spec/models/bitmap_spec.rb +68 -0
  88. data/spec/models/blob_spec.rb +52 -0
  89. data/spec/models/boolean_value_spec.rb +34 -0
  90. data/spec/models/clipping_plane_spec.rb +40 -0
  91. data/spec/models/coloring_spec.rb +40 -0
  92. data/spec/models/column_request_spec.rb +56 -0
  93. data/spec/models/component_spec.rb +46 -0
  94. data/spec/models/components_spec.rb +46 -0
  95. data/spec/models/contact_list_spec.rb +46 -0
  96. data/spec/models/contact_spec.rb +40 -0
  97. data/spec/models/conversation_create_spec.rb +64 -0
  98. data/spec/models/conversation_list_spec.rb +46 -0
  99. data/spec/models/conversation_spec.rb +122 -0
  100. data/spec/models/conversation_tenant_spec.rb +58 -0
  101. data/spec/models/conversation_update_spec.rb +68 -0
  102. data/spec/models/entity_key_spec.rb +40 -0
  103. data/spec/models/exception_message_spec.rb +52 -0
  104. data/spec/models/file_all_of_spec.rb +58 -0
  105. data/spec/models/file_spec.rb +58 -0
  106. data/spec/models/int32_value_spec.rb +34 -0
  107. data/spec/models/key_frame_spec.rb +46 -0
  108. data/spec/models/line_spec.rb +40 -0
  109. data/spec/models/message_content_spec.rb +34 -0
  110. data/spec/models/message_create_spec.rb +64 -0
  111. data/spec/models/message_list_spec.rb +46 -0
  112. data/spec/models/message_part_spec.rb +46 -0
  113. data/spec/models/message_spec.rb +146 -0
  114. data/spec/models/message_update_spec.rb +68 -0
  115. data/spec/models/orthogonal_camera_spec.rb +64 -0
  116. data/spec/models/participant_spec.rb +40 -0
  117. data/spec/models/participant_with_role_create_spec.rb +44 -0
  118. data/spec/models/participant_with_role_list_spec.rb +46 -0
  119. data/spec/models/participant_with_role_spec.rb +62 -0
  120. data/spec/models/participant_with_role_update_spec.rb +44 -0
  121. data/spec/models/perspective_camera_spec.rb +64 -0
  122. data/spec/models/pie_chart_all_of_spec.rb +52 -0
  123. data/spec/models/pie_chart_spec.rb +52 -0
  124. data/spec/models/point_spec.rb +40 -0
  125. data/spec/models/preview_row_spec.rb +34 -0
  126. data/spec/models/schedule_all_of_spec.rb +58 -0
  127. data/spec/models/schedule_column_spec.rb +118 -0
  128. data/spec/models/schedule_request_all_of_spec.rb +46 -0
  129. data/spec/models/schedule_request_spec.rb +46 -0
  130. data/spec/models/schedule_spec.rb +58 -0
  131. data/spec/models/section_box_spec.rb +70 -0
  132. data/spec/models/sheet_all_of_spec.rb +58 -0
  133. data/spec/models/sheet_part_spec.rb +58 -0
  134. data/spec/models/sheet_spec.rb +58 -0
  135. data/spec/models/snapshot_spec.rb +50 -0
  136. data/spec/models/text_spec.rb +28 -0
  137. data/spec/models/view_all_of_spec.rb +40 -0
  138. data/spec/models/view_setup_hints_spec.rb +46 -0
  139. data/spec/models/view_spec.rb +40 -0
  140. data/spec/models/viewpoint_spec.rb +82 -0
  141. data/spec/models/visibility_spec.rb +46 -0
  142. data/spec/spec_helper.rb +111 -0
  143. data/xbim_comms-1.0.0.gem +0 -0
  144. data/xbim_comms.gemspec +38 -0
  145. metadata +226 -0
@@ -0,0 +1,74 @@
1
+ =begin
2
+ #Flex Comms API 2.0
3
+
4
+ #Communication centralised around construction data
5
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: info@xbim.net
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for XbimComms::ContactsApi
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'ContactsApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = XbimComms::ContactsApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of ContactsApi' do
30
+ it 'should create an instance of ContactsApi' do
31
+ expect(@api_instance).to be_instance_of(XbimComms::ContactsApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for contacts_search
36
+ # Get Contacts search
37
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ContactList</b><br/><br/>
38
+ # @param term
39
+ # @param region The data center region the data resides in
40
+ # @param [Hash] opts the optional parameters
41
+ # @option opts [String] :expand
42
+ # @option opts [String] :filter
43
+ # @option opts [String] :select
44
+ # @option opts [String] :orderby
45
+ # @option opts [Integer] :top
46
+ # @option opts [Integer] :skip
47
+ # @option opts [Boolean] :count
48
+ # @return [ContactList]
49
+ describe 'contacts_search test' do
50
+ it 'should work' do
51
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
52
+ end
53
+ end
54
+
55
+ # unit tests for get_contacts
56
+ # Get Contacts
57
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ContactList</b><br/><br/>
58
+ # @param region The data center region the data resides in
59
+ # @param [Hash] opts the optional parameters
60
+ # @option opts [String] :expand
61
+ # @option opts [String] :filter
62
+ # @option opts [String] :select
63
+ # @option opts [String] :orderby
64
+ # @option opts [Integer] :top
65
+ # @option opts [Integer] :skip
66
+ # @option opts [Boolean] :count
67
+ # @return [ContactList]
68
+ describe 'get_contacts test' do
69
+ it 'should work' do
70
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
71
+ end
72
+ end
73
+
74
+ end
@@ -0,0 +1,521 @@
1
+ =begin
2
+ #Flex Comms API 2.0
3
+
4
+ #Communication centralised around construction data
5
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: info@xbim.net
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for XbimComms::ConversationsApi
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'ConversationsApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = XbimComms::ConversationsApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of ConversationsApi' do
30
+ it 'should create an instance of ConversationsApi' do
31
+ expect(@api_instance).to be_instance_of(XbimComms::ConversationsApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for aggregate_data
36
+ # Aggregates conversation data efficiently for reporting purposes
37
+ # <span style='font-size: 17px;'>Summary:</span>Aggregates conversation data efficiently for reporting purposes.<br/>Return Type: <b>AggregateListValue</b><br/><br/>
38
+ # @param region The data center region the data resides in
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [String] :expand
41
+ # @option opts [String] :filter
42
+ # @option opts [String] :select
43
+ # @option opts [String] :orderby
44
+ # @option opts [Boolean] :count
45
+ # @option opts [String] :field The field to aggregate on
46
+ # @return [AggregateListValue]
47
+ describe 'aggregate_data test' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ # unit tests for clone_conversation
54
+ # Get Conversations clone conversation
55
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>Int32Value</b><br/><br/>
56
+ # @param key
57
+ # @param region The data center region the data resides in
58
+ # @param [Hash] opts the optional parameters
59
+ # @return [Int32Value]
60
+ describe 'clone_conversation test' do
61
+ it 'should work' do
62
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
63
+ end
64
+ end
65
+
66
+ # unit tests for delete_conversation
67
+ # Delete Conversations conversation
68
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b></b><br/><br/>
69
+ # @param key
70
+ # @param region The data center region the data resides in
71
+ # @param [Hash] opts the optional parameters
72
+ # @return [nil]
73
+ describe 'delete_conversation test' do
74
+ it 'should work' do
75
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
76
+ end
77
+ end
78
+
79
+ # unit tests for delete_file
80
+ # Delete Conversations file
81
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b></b><br/><br/>
82
+ # @param conversation_id
83
+ # @param id
84
+ # @param file_id
85
+ # @param region The data center region the data resides in
86
+ # @param [Hash] opts the optional parameters
87
+ # @return [nil]
88
+ describe 'delete_file test' do
89
+ it 'should work' do
90
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
91
+ end
92
+ end
93
+
94
+ # unit tests for delete_message
95
+ # Delete Conversations message
96
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b></b><br/><br/>
97
+ # @param conversation_id
98
+ # @param id
99
+ # @param region The data center region the data resides in
100
+ # @param [Hash] opts the optional parameters
101
+ # @return [nil]
102
+ describe 'delete_message test' do
103
+ it 'should work' do
104
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
105
+ end
106
+ end
107
+
108
+ # unit tests for delete_message_part
109
+ # Delete Conversations message part
110
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b></b><br/><br/>
111
+ # @param conversation_id
112
+ # @param id
113
+ # @param region The data center region the data resides in
114
+ # @param [Hash] opts the optional parameters
115
+ # @option opts [Integer] :index
116
+ # @option opts [String] :ref
117
+ # @return [nil]
118
+ describe 'delete_message_part test' do
119
+ it 'should work' do
120
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
121
+ end
122
+ end
123
+
124
+ # unit tests for delete_participant
125
+ # Delete Conversations participant
126
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b></b><br/><br/>
127
+ # @param conversation_id
128
+ # @param id
129
+ # @param region The data center region the data resides in
130
+ # @param [Hash] opts the optional parameters
131
+ # @return [nil]
132
+ describe 'delete_participant test' do
133
+ it 'should work' do
134
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
135
+ end
136
+ end
137
+
138
+ # unit tests for get_conversations
139
+ # Get Conversations
140
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ConversationList</b><br/><br/>
141
+ # @param region The data center region the data resides in
142
+ # @param [Hash] opts the optional parameters
143
+ # @option opts [String] :expand
144
+ # @option opts [String] :filter
145
+ # @option opts [String] :select
146
+ # @option opts [String] :orderby
147
+ # @option opts [Integer] :top
148
+ # @option opts [Integer] :skip
149
+ # @option opts [Boolean] :count
150
+ # @return [ConversationList]
151
+ describe 'get_conversations test' do
152
+ it 'should work' do
153
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
154
+ end
155
+ end
156
+
157
+ # unit tests for get_conversations_by_id
158
+ # Get Conversations by id
159
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>Conversation</b><br/><br/>
160
+ # @param key
161
+ # @param region The data center region the data resides in
162
+ # @param [Hash] opts the optional parameters
163
+ # @option opts [String] :expand
164
+ # @option opts [String] :select
165
+ # @return [Conversation]
166
+ describe 'get_conversations_by_id test' do
167
+ it 'should work' do
168
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
169
+ end
170
+ end
171
+
172
+ # unit tests for get_demo_conversation
173
+ # Get Conversations demo conversation
174
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ConversationTenant</b><br/><br/>
175
+ # @param region The data center region the data resides in
176
+ # @param [Hash] opts the optional parameters
177
+ # @option opts [Integer] :original
178
+ # @option opts [Boolean] :as_owner
179
+ # @return [ConversationTenant]
180
+ describe 'get_demo_conversation test' do
181
+ it 'should work' do
182
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
183
+ end
184
+ end
185
+
186
+ # unit tests for get_file
187
+ # Get Conversations file
188
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>string</b><br/><br/>
189
+ # @param conversation_id
190
+ # @param id
191
+ # @param file_id
192
+ # @param region The data center region the data resides in
193
+ # @param [Hash] opts the optional parameters
194
+ # @option opts [String] :size
195
+ # @return [File]
196
+ describe 'get_file test' do
197
+ it 'should work' do
198
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
199
+ end
200
+ end
201
+
202
+ # unit tests for get_files
203
+ # Get Conversations files
204
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>Blob</b><br/><br/>
205
+ # @param conversation_id
206
+ # @param id
207
+ # @param region The data center region the data resides in
208
+ # @param [Hash] opts the optional parameters
209
+ # @option opts [String] :expand
210
+ # @option opts [String] :filter
211
+ # @option opts [String] :select
212
+ # @option opts [String] :orderby
213
+ # @option opts [Integer] :top
214
+ # @option opts [Integer] :skip
215
+ # @option opts [Boolean] :count
216
+ # @return [Array<Blob>]
217
+ describe 'get_files test' do
218
+ it 'should work' do
219
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
220
+ end
221
+ end
222
+
223
+ # unit tests for get_message_by_id
224
+ # Get Conversations message by id
225
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Message&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
226
+ # @param conversation_id
227
+ # @param id
228
+ # @param region The data center region the data resides in
229
+ # @param [Hash] opts the optional parameters
230
+ # @option opts [String] :expand
231
+ # @option opts [String] :select
232
+ # @return [Message]
233
+ describe 'get_message_by_id test' do
234
+ it 'should work' do
235
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
236
+ end
237
+ end
238
+
239
+ # unit tests for get_messages
240
+ # Get Conversations messages
241
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;MessageList&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
242
+ # @param conversation_id
243
+ # @param region The data center region the data resides in
244
+ # @param [Hash] opts the optional parameters
245
+ # @option opts [String] :expand
246
+ # @option opts [String] :filter
247
+ # @option opts [String] :select
248
+ # @option opts [String] :orderby
249
+ # @option opts [Integer] :top
250
+ # @option opts [Integer] :skip
251
+ # @option opts [Boolean] :count
252
+ # @return [MessageList]
253
+ describe 'get_messages test' do
254
+ it 'should work' do
255
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
256
+ end
257
+ end
258
+
259
+ # unit tests for get_participiants
260
+ # Get Conversations participiants
261
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ParticipantWithRoleList&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
262
+ # @param conversation_id
263
+ # @param region The data center region the data resides in
264
+ # @param [Hash] opts the optional parameters
265
+ # @option opts [String] :expand
266
+ # @option opts [String] :filter
267
+ # @option opts [String] :select
268
+ # @option opts [String] :orderby
269
+ # @option opts [Integer] :top
270
+ # @option opts [Integer] :skip
271
+ # @option opts [Boolean] :count
272
+ # @return [ParticipantWithRoleList]
273
+ describe 'get_participiants test' do
274
+ it 'should work' do
275
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
276
+ end
277
+ end
278
+
279
+ # unit tests for import_bcf_file
280
+ # Imports a BCF File&#39;s Topics and Markup as one or more Flex conversations
281
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Imports a BCF File&#39;s Topics and Markup as one or more Flex conversations.&lt;br/&gt;Return Type: &lt;b&gt;ConversationList&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
282
+ # @param region The data center region the data resides in
283
+ # @param file An arbitrary file which will get associated to the message.
284
+ # @param [Hash] opts the optional parameters
285
+ # @option opts [String] :tenant_id Either the tenant identifier string or GUID
286
+ # @option opts [Integer] :asset_id An optional AssetId to help identify the asset hosting the referenced model
287
+ # @option opts [Integer] :model_id An optional ModelId identifying the model to link the BCF to
288
+ # @option opts [String] :file_name The name of the file
289
+ # @return [ConversationList]
290
+ describe 'import_bcf_file test' do
291
+ it 'should work' do
292
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
293
+ end
294
+ end
295
+
296
+ # unit tests for insert_message_part
297
+ # Post Conversations insert message part
298
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
299
+ # @param conversation_id
300
+ # @param id
301
+ # @param region The data center region the data resides in
302
+ # @param [Hash] opts the optional parameters
303
+ # @option opts [Integer] :index
304
+ # @option opts [MessagePart] :part
305
+ # @return [nil]
306
+ describe 'insert_message_part test' do
307
+ it 'should work' do
308
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
309
+ end
310
+ end
311
+
312
+ # unit tests for mode_message_part
313
+ # Post Conversations mode message part
314
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
315
+ # @param conversation_id
316
+ # @param id
317
+ # @param region The data center region the data resides in
318
+ # @param [Hash] opts the optional parameters
319
+ # @option opts [Integer] :previous_index
320
+ # @option opts [Integer] :current_index
321
+ # @return [nil]
322
+ describe 'mode_message_part test' do
323
+ it 'should work' do
324
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
325
+ end
326
+ end
327
+
328
+ # unit tests for patch_conversation
329
+ # Patch Conversations conversation
330
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
331
+ # @param key
332
+ # @param region The data center region the data resides in
333
+ # @param [Hash] opts the optional parameters
334
+ # @option opts [ConversationUpdate] :conversation
335
+ # @return [nil]
336
+ describe 'patch_conversation test' do
337
+ it 'should work' do
338
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
339
+ end
340
+ end
341
+
342
+ # unit tests for patch_message
343
+ # Patch Conversations message
344
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Message&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
345
+ # @param conversation_id
346
+ # @param id
347
+ # @param region The data center region the data resides in
348
+ # @param [Hash] opts the optional parameters
349
+ # @option opts [MessageUpdate] :message
350
+ # @return [Message]
351
+ describe 'patch_message test' do
352
+ it 'should work' do
353
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
354
+ end
355
+ end
356
+
357
+ # unit tests for patch_participant
358
+ # Patch Conversations participant
359
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
360
+ # @param conversation_id
361
+ # @param id
362
+ # @param region The data center region the data resides in
363
+ # @param [Hash] opts the optional parameters
364
+ # @option opts [ParticipantWithRoleUpdate] :participant
365
+ # @return [nil]
366
+ describe 'patch_participant test' do
367
+ it 'should work' do
368
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
369
+ end
370
+ end
371
+
372
+ # unit tests for post_conversation
373
+ # Post Conversations conversation
374
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Conversation&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
375
+ # @param region The data center region the data resides in
376
+ # @param [Hash] opts the optional parameters
377
+ # @option opts [ConversationCreate] :conversation
378
+ # @return [Conversation]
379
+ describe 'post_conversation test' do
380
+ it 'should work' do
381
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
382
+ end
383
+ end
384
+
385
+ # unit tests for post_file
386
+ # Post Conversations file
387
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Blob&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
388
+ # @param conversation_id
389
+ # @param id
390
+ # @param region The data center region the data resides in
391
+ # @param file An arbitrary file which will get associated to the message.
392
+ # @param [Hash] opts the optional parameters
393
+ # @option opts [Integer] :part_index
394
+ # @option opts [String] :ref
395
+ # @option opts [String] :file_name The name of the file
396
+ # @return [Blob]
397
+ describe 'post_file test' do
398
+ it 'should work' do
399
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
400
+ end
401
+ end
402
+
403
+ # unit tests for post_message
404
+ # Post Conversations message
405
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Message&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
406
+ # @param conversation_id
407
+ # @param region The data center region the data resides in
408
+ # @param [Hash] opts the optional parameters
409
+ # @option opts [MessageCreate] :message
410
+ # @return [Message]
411
+ describe 'post_message test' do
412
+ it 'should work' do
413
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
414
+ end
415
+ end
416
+
417
+ # unit tests for post_participant
418
+ # Post Conversations participant
419
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ParticipantWithRole&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
420
+ # @param conversation_id
421
+ # @param region The data center region the data resides in
422
+ # @param [Hash] opts the optional parameters
423
+ # @option opts [ParticipantWithRoleCreate] :participant
424
+ # @return [ParticipantWithRole]
425
+ describe 'post_participant test' do
426
+ it 'should work' do
427
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
428
+ end
429
+ end
430
+
431
+ # unit tests for put_message_part
432
+ # Put Conversations message part
433
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
434
+ # @param conversation_id
435
+ # @param id
436
+ # @param region The data center region the data resides in
437
+ # @param [Hash] opts the optional parameters
438
+ # @option opts [Integer] :index
439
+ # @option opts [String] :ref
440
+ # @option opts [MessagePart] :part
441
+ # @return [nil]
442
+ describe 'put_message_part test' do
443
+ it 'should work' do
444
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
445
+ end
446
+ end
447
+
448
+ # unit tests for put_participants
449
+ # Put Conversations participants
450
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
451
+ # @param conversation_id
452
+ # @param region The data center region the data resides in
453
+ # @param [Hash] opts the optional parameters
454
+ # @option opts [Array<ParticipantWithRoleCreate>] :participants
455
+ # @return [nil]
456
+ describe 'put_participants test' do
457
+ it 'should work' do
458
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
459
+ end
460
+ end
461
+
462
+ # unit tests for send_clone_conversation
463
+ # Get Conversations send clone conversation
464
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;BooleanValue&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
465
+ # @param key
466
+ # @param region The data center region the data resides in
467
+ # @param [Hash] opts the optional parameters
468
+ # @option opts [String] :email
469
+ # @return [BooleanValue]
470
+ describe 'send_clone_conversation test' do
471
+ it 'should work' do
472
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
473
+ end
474
+ end
475
+
476
+ # unit tests for send_message
477
+ # Post Conversations send message
478
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
479
+ # @param conversation_id
480
+ # @param id
481
+ # @param region The data center region the data resides in
482
+ # @param [Hash] opts the optional parameters
483
+ # @return [nil]
484
+ describe 'send_message test' do
485
+ it 'should work' do
486
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
487
+ end
488
+ end
489
+
490
+ # unit tests for set_message_state
491
+ # Put Conversations set message state
492
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
493
+ # @param conversation_id
494
+ # @param id
495
+ # @param region The data center region the data resides in
496
+ # @param [Hash] opts the optional parameters
497
+ # @option opts [String] :state
498
+ # @return [nil]
499
+ describe 'set_message_state test' do
500
+ it 'should work' do
501
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
502
+ end
503
+ end
504
+
505
+ # unit tests for swap_message_parts
506
+ # Post Conversations swap message parts
507
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
508
+ # @param conversation_id
509
+ # @param id
510
+ # @param region The data center region the data resides in
511
+ # @param [Hash] opts the optional parameters
512
+ # @option opts [Integer] :index_a
513
+ # @option opts [Integer] :index_b
514
+ # @return [nil]
515
+ describe 'swap_message_parts test' do
516
+ it 'should work' do
517
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
518
+ end
519
+ end
520
+
521
+ end
@@ -0,0 +1,50 @@
1
+ =begin
2
+ #Flex Comms API 2.0
3
+
4
+ #Communication centralised around construction data
5
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: info@xbim.net
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for XbimComms::FilesApi
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'FilesApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = XbimComms::FilesApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of FilesApi' do
30
+ it 'should create an instance of FilesApi' do
31
+ expect(@api_instance).to be_instance_of(XbimComms::FilesApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for files_get_file
36
+ # Gets a File Blob from a Message
37
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets a File Blob from a Message.&lt;br/&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
38
+ # @param hash A hashId identifying the message
39
+ # @param file_id The Id of the file to download
40
+ # @param region The data center region the data resides in
41
+ # @param [Hash] opts the optional parameters
42
+ # @option opts [String] :size The size of thumbnail to download (where applicable)
43
+ # @return [nil]
44
+ describe 'files_get_file test' do
45
+ it 'should work' do
46
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
47
+ end
48
+ end
49
+
50
+ end