You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

4763 lines
136 KiB

1 year ago
  1. <<<<<<< Updated upstream
  2. # CircleSDK.Api.CircleApi
  3. All URIs are relative to *http://127.0.0.1:31415*
  4. Method | HTTP request | Description
  5. ------------- | ------------- | -------------
  6. [**AddMemberToTopic**](CircleApi.md#addmembertotopic) | **POST** /v1/addMemberToTopic | addMemberToTopic
  7. [**AddMessage**](CircleApi.md#addmessage) | **POST** /v1/addMessage | addMessage
  8. [**AddValue**](CircleApi.md#addvalue) | **POST** /v1/addValue | addValue
  9. [**ApproveCoTInvoke**](CircleApi.md#approvecotinvoke) | **POST** /v1/approveCoTInvoke | ApproveCoTInvoke
  10. [**Authorize**](CircleApi.md#authorize) | **POST** /v1/authorize | authorize
  11. [**Background**](CircleApi.md#background) | **POST** /v1/background | background
  12. [**ConfigureService**](CircleApi.md#configureservice) | **POST** /v1/configureService | configureService
  13. [**CreateCircle**](CircleApi.md#createcircle) | **POST** /v1/createCircle | createCircle
  14. [**CreateTopic**](CircleApi.md#createtopic) | **POST** /v1/createTopic | createTopic
  15. [**Decrypt**](CircleApi.md#decrypt) | **POST** /v1/decrypt | decrypt
  16. [**DefineCircleOfTrust**](CircleApi.md#definecircleoftrust) | **POST** /v1/defineCircleOfTrust | DefineCircleOfTrust
  17. [**DeleteCircle**](CircleApi.md#deletecircle) | **POST** /v1/deleteCircle | DeleteCircle
  18. [**DeleteFile**](CircleApi.md#deletefile) | **POST** /v1/deleteFile | deleteFile
  19. [**DeleteKey**](CircleApi.md#deletekey) | **POST** /v1/deleteKey | deleteKey
  20. [**DeleteMessage**](CircleApi.md#deletemessage) | **POST** /v1/deleteMessage | DeleteMessage
  21. [**DenyCoTInvoke**](CircleApi.md#denycotinvoke) | **POST** /v1/denyCoTInvoke | DenyCoTInvoke
  22. [**DownloadFile**](CircleApi.md#downloadfile) | **POST** /v1/downloadFile | downloadFile
  23. [**Encrypt**](CircleApi.md#encrypt) | **POST** /v1/encrypt | encrypt
  24. [**EnumCircleMembers**](CircleApi.md#enumcirclemembers) | **POST** /v1/enumCircleMembers | enumCircleMembers
  25. [**EnumCircles**](CircleApi.md#enumcircles) | **POST** /v1/enumCircles | enumCircles
  26. [**EnumDevices**](CircleApi.md#enumdevices) | **POST** /v1/enumDevices | enumDevices
  27. [**EnumFiles**](CircleApi.md#enumfiles) | **POST** /v1/enumFiles | enumFiles
  28. [**EnumInvites**](CircleApi.md#enuminvites) | **POST** /v1/enumInvites | enumInvites
  29. [**EnumKeys**](CircleApi.md#enumkeys) | **POST** /v1/enumKeys | enumKeys
  30. [**EnumRevisions**](CircleApi.md#enumrevisions) | **POST** /v1/enumRevisions | enumRevisions
  31. [**EnumTopicMembers**](CircleApi.md#enumtopicmembers) | **POST** /v1/enumTopicMembers | enumTopicMembers
  32. [**EnumTopics**](CircleApi.md#enumtopics) | **POST** /v1/enumTopics | enumTopics
  33. [**Foreground**](CircleApi.md#foreground) | **POST** /v1/foreground | foreground
  34. [**GenInvite**](CircleApi.md#geninvite) | **POST** /v1/genInvite | genInvite
  35. [**GetCircleOfTrust**](CircleApi.md#getcircleoftrust) | **POST** /v1/getCircleOfTrust | GetCircleOfTrust
  36. [**GetCirclePublicKey**](CircleApi.md#getcirclepublickey) | **POST** /v1/getCirclePublicKey | GetCirclePublicKey
  37. [**GetMessage**](CircleApi.md#getmessage) | **POST** /v1/getMessage | GetMessage
  38. [**GetMessages**](CircleApi.md#getmessages) | **POST** /v1/getMessages | getMessages
  39. [**GetRAVStatus**](CircleApi.md#getravstatus) | **POST** /v1/getRAVStatus | GetRAVStatus
  40. [**GetSecureFileContents**](CircleApi.md#getsecurefilecontents) | **POST** /v1/getSecureFileContents | GetSecureFileContents
  41. [**GetSyncStatus**](CircleApi.md#getsyncstatus) | **POST** /v1/getSyncStatus | getSyncStatus
  42. [**GetUserPublicKey**](CircleApi.md#getuserpublickey) | **POST** /v1/getUserPublicKey | GetUserPublicKey
  43. [**GetValue**](CircleApi.md#getvalue) | **POST** /v1/getValue | getValue
  44. [**JoinTopic**](CircleApi.md#jointopic) | **POST** /v1/joinTopic | joinTopic
  45. [**LeaveTopic**](CircleApi.md#leavetopic) | **POST** /v1/leaveTopic | leaveTopic
  46. [**LockUser**](CircleApi.md#lockuser) | **POST** /v1/lockUser | lockUser
  47. [**LoginWithCircle**](CircleApi.md#loginwithcircle) | **POST** /v1/loginWithCircle | LoginWithCircle
  48. [**LogintoService**](CircleApi.md#logintoservice) | **POST** /v1/logintoService | logintoService
  49. [**ProcessInvite**](CircleApi.md#processinvite) | **POST** /v1/processInvite | processInvite
  50. [**RemoveMember**](CircleApi.md#removemember) | **POST** /v1/removeMember | removeMember
  51. =======
  52. # IO.Swagger.Api.CircleApi
  53. All URIs are relative to *http://localhost:31415*
  54. Method | HTTP request | Description
  55. ------------- | ------------- | -------------
  56. [**AddFile**](CircleApi.md#addfile) | **POST** /v1/addFile | addFile
  57. [**AddMemberToTopic**](CircleApi.md#addmembertotopic) | **POST** /v1/addMemberToTopic | addMemberToTopic
  58. [**AddMessge**](CircleApi.md#addmessge) | **POST** /v1/addMessge | addMessge
  59. [**Authorize**](CircleApi.md#authorize) | **POST** /v1/authorize | authorize
  60. [**Background**](CircleApi.md#background) | **POST** /v1/background | background
  61. [**CreateCircle**](CircleApi.md#createcircle) | **POST** /v1/createCircle | createCircle
  62. [**CreateTopic**](CircleApi.md#createtopic) | **POST** /v1/createTopic | createTopic
  63. [**DecryptFile**](CircleApi.md#decryptfile) | **POST** /v1/decryptFile | decryptFile
  64. [**DeleteFile**](CircleApi.md#deletefile) | **POST** /v1/deleteFile | deleteFile
  65. [**EncryptFile**](CircleApi.md#encryptfile) | **POST** /v1/encryptFile | encryptFile
  66. [**EnumCircleMembers**](CircleApi.md#enumcirclemembers) | **GET** /v1/enumCircleMembers | enumCircleMembers
  67. [**EnumCircles**](CircleApi.md#enumcircles) | **GET** /v1/enumCircles | enumCircles
  68. [**EnumDevices**](CircleApi.md#enumdevices) | **GET** /v1/enumDevices | enumDevices
  69. [**EnumFiles**](CircleApi.md#enumfiles) | **GET** /v1/enumFiles | enumFiles
  70. [**EnumInvites**](CircleApi.md#enuminvites) | **GET** /v1/enumInvites | enumInvites
  71. [**EnumRevisions**](CircleApi.md#enumrevisions) | **GET** /v1/enumRevisions | enumRevisions
  72. [**EnumTopicMembers**](CircleApi.md#enumtopicmembers) | **GET** /v1/enumTopicMembers | enumTopicMembers
  73. [**EnumTopics**](CircleApi.md#enumtopics) | **GET** /v1/enumTopics | enumTopics
  74. [**Foreground**](CircleApi.md#foreground) | **POST** /v1/foreground | foreground
  75. [**GenInvite**](CircleApi.md#geninvite) | **POST** /v1/genInvite | genInvite
  76. [**GetFile**](CircleApi.md#getfile) | **GET** /v1/getFile | getFile
  77. [**GetMessges**](CircleApi.md#getmessges) | **GET** /v1/getMessges | getMessges
  78. [**GetTopicKey**](CircleApi.md#gettopickey) | **GET** /v1/getTopicKey | getTopicKey
  79. [**Invite**](CircleApi.md#invite) | **POST** /v1/invite | invite
  80. [**JoinTopic**](CircleApi.md#jointopic) | **POST** /v1/joinTopic | joinTopic
  81. [**LeaveTopic**](CircleApi.md#leavetopic) | **POST** /v1/leaveTopic | leaveTopic
  82. >>>>>>> Stashed changes
  83. [**RemoveMemberFromTopic**](CircleApi.md#removememberfromtopic) | **POST** /v1/removeMemberFromTopic | removeMemberFromTopic
  84. [**RenameFile**](CircleApi.md#renamefile) | **POST** /v1/renameFile | renameFile
  85. [**RevokeDevice**](CircleApi.md#revokedevice) | **POST** /v1/revokeDevice | revokeDevice
  86. [**RevokeInvite**](CircleApi.md#revokeinvite) | **POST** /v1/revokeInvite | revokeInvite
  87. <<<<<<< Updated upstream
  88. [**SecureContents**](CircleApi.md#securecontents) | **POST** /v1/secureContents | SecureContents
  89. [**SecureFile**](CircleApi.md#securefile) | **POST** /v1/secureFile | SecureFile
  90. [**ServiceStatus**](CircleApi.md#servicestatus) | **POST** /v1/serviceStatus | serviceStatus
  91. [**SetUserId**](CircleApi.md#setuserid) | **POST** /v1/setUserId | SetUserId
  92. [**SignDataWithCircleKey**](CircleApi.md#signdatawithcirclekey) | **POST** /v1/signDataWithCircleKey | SignDataWithCircleKey
  93. [**SignDataWithUserKey**](CircleApi.md#signdatawithuserkey) | **POST** /v1/signDataWithUserKey | SignDataWithUserKey
  94. [**StoreToken**](CircleApi.md#storetoken) | **POST** /v1/storeToken | storeToken
  95. [**UnlockUser**](CircleApi.md#unlockuser) | **POST** /v1/unlockUser | unlockUser
  96. [**UpdateTopic**](CircleApi.md#updatetopic) | **POST** /v1/updateTopic | updateTopic
  97. [**UploadFile**](CircleApi.md#uploadfile) | **POST** /v1/uploadFile | uploadFile
  98. [**WhoAmI**](CircleApi.md#whoami) | **POST** /v1/whoAmI | whoAmI
  99. <a name="addmembertotopic"></a>
  100. # **AddMemberToTopic**
  101. > AddMemberToTopicReply AddMemberToTopic (AddMemberToTopicRequest body, string authorization, string xCircleAppkey)
  102. addMemberToTopic
  103. Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
  104. =======
  105. [**WhoAmI**](CircleApi.md#whoami) | **GET** /v1/whoAmI | whoAmI
  106. <a name="addfile"></a>
  107. # **AddFile**
  108. > AddFileReply AddFile (AddFileRequest body, string xCircleAppkey)
  109. addFile
  110. >>>>>>> Stashed changes
  111. ### Example
  112. ```csharp
  113. using System;
  114. using System.Diagnostics;
  115. <<<<<<< Updated upstream
  116. using CircleSDK.Api;
  117. using CircleSDK.Client;
  118. using CircleSDK.Model;
  119. =======
  120. using IO.Swagger.Api;
  121. using IO.Swagger.Client;
  122. using IO.Swagger.Model;
  123. namespace Example
  124. {
  125. public class AddFileExample
  126. {
  127. public void main()
  128. {
  129. var apiInstance = new CircleApi();
  130. var body = new AddFileRequest(); // AddFileRequest |
  131. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  132. try
  133. {
  134. // addFile
  135. AddFileReply result = apiInstance.AddFile(body, xCircleAppkey);
  136. Debug.WriteLine(result);
  137. }
  138. catch (Exception e)
  139. {
  140. Debug.Print("Exception when calling CircleApi.AddFile: " + e.Message );
  141. }
  142. }
  143. }
  144. }
  145. ```
  146. ### Parameters
  147. Name | Type | Description | Notes
  148. ------------- | ------------- | ------------- | -------------
  149. **body** | [**AddFileRequest**](AddFileRequest.md)| |
  150. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  151. ### Return type
  152. [**AddFileReply**](AddFileReply.md)
  153. ### Authorization
  154. No authorization required
  155. ### HTTP request headers
  156. - **Content-Type**: application/json
  157. - **Accept**: application/json
  158. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  159. <a name="addmembertotopic"></a>
  160. # **AddMemberToTopic**
  161. > AddMemberToTopicReply AddMemberToTopic (AddMemberToTopicRequest body, string xCircleAppkey)
  162. addMemberToTopic
  163. ### Example
  164. ```csharp
  165. using System;
  166. using System.Diagnostics;
  167. using IO.Swagger.Api;
  168. using IO.Swagger.Client;
  169. using IO.Swagger.Model;
  170. >>>>>>> Stashed changes
  171. namespace Example
  172. {
  173. public class AddMemberToTopicExample
  174. {
  175. public void main()
  176. {
  177. var apiInstance = new CircleApi();
  178. var body = new AddMemberToTopicRequest(); // AddMemberToTopicRequest |
  179. <<<<<<< Updated upstream
  180. var authorization = authorization_example; // string | Authorization Bearer
  181. =======
  182. >>>>>>> Stashed changes
  183. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  184. try
  185. {
  186. // addMemberToTopic
  187. <<<<<<< Updated upstream
  188. AddMemberToTopicReply result = apiInstance.AddMemberToTopic(body, authorization, xCircleAppkey);
  189. =======
  190. AddMemberToTopicReply result = apiInstance.AddMemberToTopic(body, xCircleAppkey);
  191. >>>>>>> Stashed changes
  192. Debug.WriteLine(result);
  193. }
  194. catch (Exception e)
  195. {
  196. Debug.Print("Exception when calling CircleApi.AddMemberToTopic: " + e.Message );
  197. }
  198. }
  199. }
  200. }
  201. ```
  202. ### Parameters
  203. Name | Type | Description | Notes
  204. ------------- | ------------- | ------------- | -------------
  205. **body** | [**AddMemberToTopicRequest**](AddMemberToTopicRequest.md)| |
  206. <<<<<<< Updated upstream
  207. **authorization** | **string**| Authorization Bearer |
  208. =======
  209. >>>>>>> Stashed changes
  210. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  211. ### Return type
  212. [**AddMemberToTopicReply**](AddMemberToTopicReply.md)
  213. ### Authorization
  214. No authorization required
  215. ### HTTP request headers
  216. - **Content-Type**: application/json
  217. - **Accept**: application/json
  218. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  219. <<<<<<< Updated upstream
  220. <a name="addmessage"></a>
  221. # **AddMessage**
  222. > AddMessageReply AddMessage (AddMessageRequest body, string authorization, string xCircleAppkey)
  223. addMessage
  224. Adds a message to the desired topic.
  225. =======
  226. <a name="addmessge"></a>
  227. # **AddMessge**
  228. > AddMessgeReply AddMessge (AddMessgeRequest body, string xCircleAppkey)
  229. addMessge
  230. >>>>>>> Stashed changes
  231. ### Example
  232. ```csharp
  233. using System;
  234. using System.Diagnostics;
  235. <<<<<<< Updated upstream
  236. using CircleSDK.Api;
  237. using CircleSDK.Client;
  238. using CircleSDK.Model;
  239. namespace Example
  240. {
  241. public class AddMessageExample
  242. =======
  243. using IO.Swagger.Api;
  244. using IO.Swagger.Client;
  245. using IO.Swagger.Model;
  246. namespace Example
  247. {
  248. public class AddMessgeExample
  249. >>>>>>> Stashed changes
  250. {
  251. public void main()
  252. {
  253. var apiInstance = new CircleApi();
  254. <<<<<<< Updated upstream
  255. var body = new AddMessageRequest(); // AddMessageRequest |
  256. var authorization = authorization_example; // string | Authorization Bearer
  257. =======
  258. var body = new AddMessgeRequest(); // AddMessgeRequest |
  259. >>>>>>> Stashed changes
  260. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  261. try
  262. {
  263. <<<<<<< Updated upstream
  264. // addMessage
  265. AddMessageReply result = apiInstance.AddMessage(body, authorization, xCircleAppkey);
  266. =======
  267. // addMessge
  268. AddMessgeReply result = apiInstance.AddMessge(body, xCircleAppkey);
  269. >>>>>>> Stashed changes
  270. Debug.WriteLine(result);
  271. }
  272. catch (Exception e)
  273. {
  274. <<<<<<< Updated upstream
  275. Debug.Print("Exception when calling CircleApi.AddMessage: " + e.Message );
  276. =======
  277. Debug.Print("Exception when calling CircleApi.AddMessge: " + e.Message );
  278. >>>>>>> Stashed changes
  279. }
  280. }
  281. }
  282. }
  283. ```
  284. ### Parameters
  285. Name | Type | Description | Notes
  286. ------------- | ------------- | ------------- | -------------
  287. <<<<<<< Updated upstream
  288. **body** | [**AddMessageRequest**](AddMessageRequest.md)| |
  289. **authorization** | **string**| Authorization Bearer |
  290. =======
  291. **body** | [**AddMessgeRequest**](AddMessgeRequest.md)| |
  292. >>>>>>> Stashed changes
  293. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  294. ### Return type
  295. <<<<<<< Updated upstream
  296. [**AddMessageReply**](AddMessageReply.md)
  297. ### Authorization
  298. No authorization required
  299. ### HTTP request headers
  300. - **Content-Type**: application/json
  301. - **Accept**: application/json
  302. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  303. <a name="addvalue"></a>
  304. # **AddValue**
  305. > AddValueReply AddValue (AddValueRequest body, string authorization, string xCircleAppkey)
  306. addValue
  307. ### Example
  308. ```csharp
  309. using System;
  310. using System.Diagnostics;
  311. using CircleSDK.Api;
  312. using CircleSDK.Client;
  313. using CircleSDK.Model;
  314. namespace Example
  315. {
  316. public class AddValueExample
  317. {
  318. public void main()
  319. {
  320. var apiInstance = new CircleApi();
  321. var body = new AddValueRequest(); // AddValueRequest |
  322. var authorization = authorization_example; // string | Authorization Bearer
  323. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  324. try
  325. {
  326. // addValue
  327. AddValueReply result = apiInstance.AddValue(body, authorization, xCircleAppkey);
  328. Debug.WriteLine(result);
  329. }
  330. catch (Exception e)
  331. {
  332. Debug.Print("Exception when calling CircleApi.AddValue: " + e.Message );
  333. }
  334. }
  335. }
  336. }
  337. ```
  338. ### Parameters
  339. Name | Type | Description | Notes
  340. ------------- | ------------- | ------------- | -------------
  341. **body** | [**AddValueRequest**](AddValueRequest.md)| |
  342. **authorization** | **string**| Authorization Bearer |
  343. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  344. ### Return type
  345. [**AddValueReply**](AddValueReply.md)
  346. ### Authorization
  347. No authorization required
  348. ### HTTP request headers
  349. - **Content-Type**: application/json
  350. - **Accept**: application/json
  351. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  352. <a name="approvecotinvoke"></a>
  353. # **ApproveCoTInvoke**
  354. > ApproveCoTInvokeReply ApproveCoTInvoke (ApproveCoTInvokeRequest body, string authorization, string xCircleAppkey)
  355. ApproveCoTInvoke
  356. ### Example
  357. ```csharp
  358. using System;
  359. using System.Diagnostics;
  360. using CircleSDK.Api;
  361. using CircleSDK.Client;
  362. using CircleSDK.Model;
  363. namespace Example
  364. {
  365. public class ApproveCoTInvokeExample
  366. {
  367. public void main()
  368. {
  369. var apiInstance = new CircleApi();
  370. var body = new ApproveCoTInvokeRequest(); // ApproveCoTInvokeRequest |
  371. var authorization = authorization_example; // string | Authorization Bearer
  372. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  373. try
  374. {
  375. // ApproveCoTInvoke
  376. ApproveCoTInvokeReply result = apiInstance.ApproveCoTInvoke(body, authorization, xCircleAppkey);
  377. Debug.WriteLine(result);
  378. }
  379. catch (Exception e)
  380. {
  381. Debug.Print("Exception when calling CircleApi.ApproveCoTInvoke: " + e.Message );
  382. }
  383. }
  384. }
  385. }
  386. ```
  387. ### Parameters
  388. Name | Type | Description | Notes
  389. ------------- | ------------- | ------------- | -------------
  390. **body** | [**ApproveCoTInvokeRequest**](ApproveCoTInvokeRequest.md)| |
  391. **authorization** | **string**| Authorization Bearer |
  392. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  393. ### Return type
  394. [**ApproveCoTInvokeReply**](ApproveCoTInvokeReply.md)
  395. =======
  396. [**AddMessgeReply**](AddMessgeReply.md)
  397. >>>>>>> Stashed changes
  398. ### Authorization
  399. No authorization required
  400. ### HTTP request headers
  401. - **Content-Type**: application/json
  402. - **Accept**: application/json
  403. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  404. <a name="authorize"></a>
  405. # **Authorize**
  406. <<<<<<< Updated upstream
  407. > AppAuthorizationReply Authorize (AppAuthorizationRequest body, string xCircleAppkey)
  408. authorize
  409. Authorizes use of the CircleService
  410. =======
  411. > GenerateTokenReply Authorize (AppAuthorization body, string xCircleAppkey)
  412. authorize
  413. >>>>>>> Stashed changes
  414. ### Example
  415. ```csharp
  416. using System;
  417. using System.Diagnostics;
  418. <<<<<<< Updated upstream
  419. using CircleSDK.Api;
  420. using CircleSDK.Client;
  421. using CircleSDK.Model;
  422. =======
  423. using IO.Swagger.Api;
  424. using IO.Swagger.Client;
  425. using IO.Swagger.Model;
  426. >>>>>>> Stashed changes
  427. namespace Example
  428. {
  429. public class AuthorizeExample
  430. {
  431. public void main()
  432. {
  433. var apiInstance = new CircleApi();
  434. <<<<<<< Updated upstream
  435. var body = new AppAuthorizationRequest(); // AppAuthorizationRequest |
  436. =======
  437. var body = new AppAuthorization(); // AppAuthorization |
  438. >>>>>>> Stashed changes
  439. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  440. try
  441. {
  442. // authorize
  443. <<<<<<< Updated upstream
  444. AppAuthorizationReply result = apiInstance.Authorize(body, xCircleAppkey);
  445. =======
  446. GenerateTokenReply result = apiInstance.Authorize(body, xCircleAppkey);
  447. >>>>>>> Stashed changes
  448. Debug.WriteLine(result);
  449. }
  450. catch (Exception e)
  451. {
  452. Debug.Print("Exception when calling CircleApi.Authorize: " + e.Message );
  453. }
  454. }
  455. }
  456. }
  457. ```
  458. ### Parameters
  459. Name | Type | Description | Notes
  460. ------------- | ------------- | ------------- | -------------
  461. <<<<<<< Updated upstream
  462. **body** | [**AppAuthorizationRequest**](AppAuthorizationRequest.md)| |
  463. =======
  464. **body** | [**AppAuthorization**](AppAuthorization.md)| |
  465. >>>>>>> Stashed changes
  466. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  467. ### Return type
  468. <<<<<<< Updated upstream
  469. [**AppAuthorizationReply**](AppAuthorizationReply.md)
  470. =======
  471. [**GenerateTokenReply**](GenerateTokenReply.md)
  472. >>>>>>> Stashed changes
  473. ### Authorization
  474. No authorization required
  475. ### HTTP request headers
  476. - **Content-Type**: application/json
  477. - **Accept**: application/json
  478. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  479. <a name="background"></a>
  480. # **Background**
  481. <<<<<<< Updated upstream
  482. > BackgroundReply Background (BackgroundRequest body, string authorization, string xCircleAppkey)
  483. background
  484. Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
  485. =======
  486. > BackgroundReply Background (BackgroundRequest body, string xCircleAppkey)
  487. background
  488. >>>>>>> Stashed changes
  489. ### Example
  490. ```csharp
  491. using System;
  492. using System.Diagnostics;
  493. <<<<<<< Updated upstream
  494. using CircleSDK.Api;
  495. using CircleSDK.Client;
  496. using CircleSDK.Model;
  497. =======
  498. using IO.Swagger.Api;
  499. using IO.Swagger.Client;
  500. using IO.Swagger.Model;
  501. >>>>>>> Stashed changes
  502. namespace Example
  503. {
  504. public class BackgroundExample
  505. {
  506. public void main()
  507. {
  508. var apiInstance = new CircleApi();
  509. var body = new BackgroundRequest(); // BackgroundRequest |
  510. <<<<<<< Updated upstream
  511. var authorization = authorization_example; // string | Authorization Bearer
  512. =======
  513. >>>>>>> Stashed changes
  514. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  515. try
  516. {
  517. // background
  518. <<<<<<< Updated upstream
  519. BackgroundReply result = apiInstance.Background(body, authorization, xCircleAppkey);
  520. =======
  521. BackgroundReply result = apiInstance.Background(body, xCircleAppkey);
  522. >>>>>>> Stashed changes
  523. Debug.WriteLine(result);
  524. }
  525. catch (Exception e)
  526. {
  527. Debug.Print("Exception when calling CircleApi.Background: " + e.Message );
  528. }
  529. }
  530. }
  531. }
  532. ```
  533. ### Parameters
  534. Name | Type | Description | Notes
  535. ------------- | ------------- | ------------- | -------------
  536. **body** | [**BackgroundRequest**](BackgroundRequest.md)| |
  537. <<<<<<< Updated upstream
  538. **authorization** | **string**| Authorization Bearer |
  539. =======
  540. >>>>>>> Stashed changes
  541. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  542. ### Return type
  543. [**BackgroundReply**](BackgroundReply.md)
  544. ### Authorization
  545. No authorization required
  546. ### HTTP request headers
  547. - **Content-Type**: application/json
  548. - **Accept**: application/json
  549. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  550. <<<<<<< Updated upstream
  551. <a name="configureservice"></a>
  552. # **ConfigureService**
  553. > ConfigureServiceReply ConfigureService (ConfigureServiceRequest body = null, string authorization = null, string xCircleAppkey = null)
  554. configureService
  555. ### Example
  556. ```csharp
  557. using System;
  558. using System.Diagnostics;
  559. using CircleSDK.Api;
  560. using CircleSDK.Client;
  561. using CircleSDK.Model;
  562. namespace Example
  563. {
  564. public class ConfigureServiceExample
  565. {
  566. public void main()
  567. {
  568. var apiInstance = new CircleApi();
  569. var body = new ConfigureServiceRequest(); // ConfigureServiceRequest | (optional)
  570. var authorization = authorization_example; // string | Authorization Bearer (optional)
  571. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey` (optional)
  572. try
  573. {
  574. // configureService
  575. ConfigureServiceReply result = apiInstance.ConfigureService(body, authorization, xCircleAppkey);
  576. Debug.WriteLine(result);
  577. }
  578. catch (Exception e)
  579. {
  580. Debug.Print("Exception when calling CircleApi.ConfigureService: " + e.Message );
  581. }
  582. }
  583. }
  584. }
  585. ```
  586. ### Parameters
  587. Name | Type | Description | Notes
  588. ------------- | ------------- | ------------- | -------------
  589. **body** | [**ConfigureServiceRequest**](ConfigureServiceRequest.md)| | [optional]
  590. **authorization** | **string**| Authorization Bearer | [optional]
  591. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; | [optional]
  592. ### Return type
  593. [**ConfigureServiceReply**](ConfigureServiceReply.md)
  594. ### Authorization
  595. No authorization required
  596. ### HTTP request headers
  597. - **Content-Type**: application/json
  598. - **Accept**: application/json
  599. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  600. <a name="createcircle"></a>
  601. # **CreateCircle**
  602. > CreateCircleReply CreateCircle (CreateCircleRequest body, string authorization, string xCircleAppkey)
  603. createCircle
  604. Creates a Circle. Initially the current device is the only member of the new Circle.
  605. =======
  606. <a name="createcircle"></a>
  607. # **CreateCircle**
  608. > CreateCircleReply CreateCircle (CreateCircleRequest body, string xCircleAppkey)
  609. createCircle
  610. >>>>>>> Stashed changes
  611. ### Example
  612. ```csharp
  613. using System;
  614. using System.Diagnostics;
  615. <<<<<<< Updated upstream
  616. using CircleSDK.Api;
  617. using CircleSDK.Client;
  618. using CircleSDK.Model;
  619. =======
  620. using IO.Swagger.Api;
  621. using IO.Swagger.Client;
  622. using IO.Swagger.Model;
  623. >>>>>>> Stashed changes
  624. namespace Example
  625. {
  626. public class CreateCircleExample
  627. {
  628. public void main()
  629. {
  630. var apiInstance = new CircleApi();
  631. var body = new CreateCircleRequest(); // CreateCircleRequest |
  632. <<<<<<< Updated upstream
  633. var authorization = authorization_example; // string | Authorization Bearer
  634. =======
  635. >>>>>>> Stashed changes
  636. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  637. try
  638. {
  639. // createCircle
  640. <<<<<<< Updated upstream
  641. CreateCircleReply result = apiInstance.CreateCircle(body, authorization, xCircleAppkey);
  642. =======
  643. CreateCircleReply result = apiInstance.CreateCircle(body, xCircleAppkey);
  644. >>>>>>> Stashed changes
  645. Debug.WriteLine(result);
  646. }
  647. catch (Exception e)
  648. {
  649. Debug.Print("Exception when calling CircleApi.CreateCircle: " + e.Message );
  650. }
  651. }
  652. }
  653. }
  654. ```
  655. ### Parameters
  656. Name | Type | Description | Notes
  657. ------------- | ------------- | ------------- | -------------
  658. **body** | [**CreateCircleRequest**](CreateCircleRequest.md)| |
  659. <<<<<<< Updated upstream
  660. **authorization** | **string**| Authorization Bearer |
  661. =======
  662. >>>>>>> Stashed changes
  663. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  664. ### Return type
  665. [**CreateCircleReply**](CreateCircleReply.md)
  666. ### Authorization
  667. No authorization required
  668. ### HTTP request headers
  669. - **Content-Type**: application/json
  670. - **Accept**: application/json
  671. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  672. <a name="createtopic"></a>
  673. # **CreateTopic**
  674. <<<<<<< Updated upstream
  675. > CreateTopicReply CreateTopic (CreateTopicRequest body, string authorization, string xCircleAppkey)
  676. createTopic
  677. Create a new Topic in a Circle.
  678. =======
  679. > CreateTopicReply CreateTopic (CreateTopicRequest body, string xCircleAppkey)
  680. createTopic
  681. >>>>>>> Stashed changes
  682. ### Example
  683. ```csharp
  684. using System;
  685. using System.Diagnostics;
  686. <<<<<<< Updated upstream
  687. using CircleSDK.Api;
  688. using CircleSDK.Client;
  689. using CircleSDK.Model;
  690. =======
  691. using IO.Swagger.Api;
  692. using IO.Swagger.Client;
  693. using IO.Swagger.Model;
  694. >>>>>>> Stashed changes
  695. namespace Example
  696. {
  697. public class CreateTopicExample
  698. {
  699. public void main()
  700. {
  701. var apiInstance = new CircleApi();
  702. var body = new CreateTopicRequest(); // CreateTopicRequest |
  703. <<<<<<< Updated upstream
  704. var authorization = authorization_example; // string | Authorization Bearer
  705. =======
  706. >>>>>>> Stashed changes
  707. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  708. try
  709. {
  710. // createTopic
  711. <<<<<<< Updated upstream
  712. CreateTopicReply result = apiInstance.CreateTopic(body, authorization, xCircleAppkey);
  713. =======
  714. CreateTopicReply result = apiInstance.CreateTopic(body, xCircleAppkey);
  715. >>>>>>> Stashed changes
  716. Debug.WriteLine(result);
  717. }
  718. catch (Exception e)
  719. {
  720. Debug.Print("Exception when calling CircleApi.CreateTopic: " + e.Message );
  721. }
  722. }
  723. }
  724. }
  725. ```
  726. ### Parameters
  727. Name | Type | Description | Notes
  728. ------------- | ------------- | ------------- | -------------
  729. **body** | [**CreateTopicRequest**](CreateTopicRequest.md)| |
  730. <<<<<<< Updated upstream
  731. **authorization** | **string**| Authorization Bearer |
  732. =======
  733. >>>>>>> Stashed changes
  734. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  735. ### Return type
  736. [**CreateTopicReply**](CreateTopicReply.md)
  737. ### Authorization
  738. No authorization required
  739. ### HTTP request headers
  740. - **Content-Type**: application/json
  741. - **Accept**: application/json
  742. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  743. <<<<<<< Updated upstream
  744. <a name="decrypt"></a>
  745. # **Decrypt**
  746. > DecryptReply Decrypt (DecryptRequest body = null, string authorization = null, string xCircleAppkey = null)
  747. decrypt
  748. Decrypt base64 data using a Circle/Topic encryption key.
  749. =======
  750. <a name="decryptfile"></a>
  751. # **DecryptFile**
  752. > DecryptFileReply DecryptFile (DecryptFileRequest body, string xCircleAppkey)
  753. decryptFile
  754. >>>>>>> Stashed changes
  755. ### Example
  756. ```csharp
  757. using System;
  758. using System.Diagnostics;
  759. <<<<<<< Updated upstream
  760. using CircleSDK.Api;
  761. using CircleSDK.Client;
  762. using CircleSDK.Model;
  763. namespace Example
  764. {
  765. public class DecryptExample
  766. =======
  767. using IO.Swagger.Api;
  768. using IO.Swagger.Client;
  769. using IO.Swagger.Model;
  770. namespace Example
  771. {
  772. public class DecryptFileExample
  773. >>>>>>> Stashed changes
  774. {
  775. public void main()
  776. {
  777. var apiInstance = new CircleApi();
  778. <<<<<<< Updated upstream
  779. var body = new DecryptRequest(); // DecryptRequest | (optional)
  780. var authorization = authorization_example; // string | Authorization Bearer (optional)
  781. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey` (optional)
  782. try
  783. {
  784. // decrypt
  785. DecryptReply result = apiInstance.Decrypt(body, authorization, xCircleAppkey);
  786. Debug.WriteLine(result);
  787. }
  788. catch (Exception e)
  789. {
  790. Debug.Print("Exception when calling CircleApi.Decrypt: " + e.Message );
  791. }
  792. }
  793. }
  794. }
  795. ```
  796. ### Parameters
  797. Name | Type | Description | Notes
  798. ------------- | ------------- | ------------- | -------------
  799. **body** | [**DecryptRequest**](DecryptRequest.md)| | [optional]
  800. **authorization** | **string**| Authorization Bearer | [optional]
  801. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; | [optional]
  802. ### Return type
  803. [**DecryptReply**](DecryptReply.md)
  804. ### Authorization
  805. No authorization required
  806. ### HTTP request headers
  807. - **Content-Type**: application/json
  808. - **Accept**: application/json
  809. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  810. <a name="definecircleoftrust"></a>
  811. # **DefineCircleOfTrust**
  812. > DefineCircleOfTrustReply DefineCircleOfTrust (DefineCircleOfTrustRequest body, string authorization, string xCircleAppkey)
  813. DefineCircleOfTrust
  814. ### Example
  815. ```csharp
  816. using System;
  817. using System.Diagnostics;
  818. using CircleSDK.Api;
  819. using CircleSDK.Client;
  820. using CircleSDK.Model;
  821. namespace Example
  822. {
  823. public class DefineCircleOfTrustExample
  824. {
  825. public void main()
  826. {
  827. var apiInstance = new CircleApi();
  828. var body = new DefineCircleOfTrustRequest(); // DefineCircleOfTrustRequest |
  829. var authorization = authorization_example; // string | Authorization Bearer
  830. =======
  831. var body = new DecryptFileRequest(); // DecryptFileRequest |
  832. >>>>>>> Stashed changes
  833. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  834. try
  835. {
  836. <<<<<<< Updated upstream
  837. // DefineCircleOfTrust
  838. DefineCircleOfTrustReply result = apiInstance.DefineCircleOfTrust(body, authorization, xCircleAppkey);
  839. =======
  840. // decryptFile
  841. DecryptFileReply result = apiInstance.DecryptFile(body, xCircleAppkey);
  842. >>>>>>> Stashed changes
  843. Debug.WriteLine(result);
  844. }
  845. catch (Exception e)
  846. {
  847. <<<<<<< Updated upstream
  848. Debug.Print("Exception when calling CircleApi.DefineCircleOfTrust: " + e.Message );
  849. =======
  850. Debug.Print("Exception when calling CircleApi.DecryptFile: " + e.Message );
  851. >>>>>>> Stashed changes
  852. }
  853. }
  854. }
  855. }
  856. ```
  857. ### Parameters
  858. Name | Type | Description | Notes
  859. ------------- | ------------- | ------------- | -------------
  860. <<<<<<< Updated upstream
  861. **body** | [**DefineCircleOfTrustRequest**](DefineCircleOfTrustRequest.md)| |
  862. **authorization** | **string**| Authorization Bearer |
  863. =======
  864. **body** | [**DecryptFileRequest**](DecryptFileRequest.md)| |
  865. >>>>>>> Stashed changes
  866. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  867. ### Return type
  868. <<<<<<< Updated upstream
  869. [**DefineCircleOfTrustReply**](DefineCircleOfTrustReply.md)
  870. ### Authorization
  871. No authorization required
  872. ### HTTP request headers
  873. - **Content-Type**: application/json
  874. - **Accept**: application/json
  875. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  876. <a name="deletecircle"></a>
  877. # **DeleteCircle**
  878. > DeleteCircleReply DeleteCircle (DeleteCircleRequest body, string authorization, string xCircleAppkey)
  879. DeleteCircle
  880. ### Example
  881. ```csharp
  882. using System;
  883. using System.Diagnostics;
  884. using CircleSDK.Api;
  885. using CircleSDK.Client;
  886. using CircleSDK.Model;
  887. namespace Example
  888. {
  889. public class DeleteCircleExample
  890. {
  891. public void main()
  892. {
  893. var apiInstance = new CircleApi();
  894. var body = new DeleteCircleRequest(); // DeleteCircleRequest |
  895. var authorization = authorization_example; // string | Authorization Bearer
  896. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  897. try
  898. {
  899. // DeleteCircle
  900. DeleteCircleReply result = apiInstance.DeleteCircle(body, authorization, xCircleAppkey);
  901. Debug.WriteLine(result);
  902. }
  903. catch (Exception e)
  904. {
  905. Debug.Print("Exception when calling CircleApi.DeleteCircle: " + e.Message );
  906. }
  907. }
  908. }
  909. }
  910. ```
  911. ### Parameters
  912. Name | Type | Description | Notes
  913. ------------- | ------------- | ------------- | -------------
  914. **body** | [**DeleteCircleRequest**](DeleteCircleRequest.md)| |
  915. **authorization** | **string**| Authorization Bearer |
  916. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  917. ### Return type
  918. [**DeleteCircleReply**](DeleteCircleReply.md)
  919. =======
  920. [**DecryptFileReply**](DecryptFileReply.md)
  921. >>>>>>> Stashed changes
  922. ### Authorization
  923. No authorization required
  924. ### HTTP request headers
  925. - **Content-Type**: application/json
  926. - **Accept**: application/json
  927. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  928. <a name="deletefile"></a>
  929. # **DeleteFile**
  930. <<<<<<< Updated upstream
  931. > DeleteFileReply DeleteFile (DeleteFileRequest body, string authorization, string xCircleAppkey)
  932. deleteFile
  933. The Circle ID and the FileMap ID for the file you want to delete.
  934. =======
  935. > DeleteFileReply DeleteFile (DeleteFileRequest body, string xCircleAppkey)
  936. deleteFile
  937. >>>>>>> Stashed changes
  938. ### Example
  939. ```csharp
  940. using System;
  941. using System.Diagnostics;
  942. <<<<<<< Updated upstream
  943. using CircleSDK.Api;
  944. using CircleSDK.Client;
  945. using CircleSDK.Model;
  946. =======
  947. using IO.Swagger.Api;
  948. using IO.Swagger.Client;
  949. using IO.Swagger.Model;
  950. >>>>>>> Stashed changes
  951. namespace Example
  952. {
  953. public class DeleteFileExample
  954. {
  955. public void main()
  956. {
  957. var apiInstance = new CircleApi();
  958. var body = new DeleteFileRequest(); // DeleteFileRequest |
  959. <<<<<<< Updated upstream
  960. var authorization = authorization_example; // string | Authorization Bearer
  961. =======
  962. >>>>>>> Stashed changes
  963. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  964. try
  965. {
  966. // deleteFile
  967. <<<<<<< Updated upstream
  968. DeleteFileReply result = apiInstance.DeleteFile(body, authorization, xCircleAppkey);
  969. =======
  970. DeleteFileReply result = apiInstance.DeleteFile(body, xCircleAppkey);
  971. >>>>>>> Stashed changes
  972. Debug.WriteLine(result);
  973. }
  974. catch (Exception e)
  975. {
  976. Debug.Print("Exception when calling CircleApi.DeleteFile: " + e.Message );
  977. }
  978. }
  979. }
  980. }
  981. ```
  982. ### Parameters
  983. Name | Type | Description | Notes
  984. ------------- | ------------- | ------------- | -------------
  985. **body** | [**DeleteFileRequest**](DeleteFileRequest.md)| |
  986. <<<<<<< Updated upstream
  987. **authorization** | **string**| Authorization Bearer |
  988. =======
  989. >>>>>>> Stashed changes
  990. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  991. ### Return type
  992. [**DeleteFileReply**](DeleteFileReply.md)
  993. ### Authorization
  994. No authorization required
  995. ### HTTP request headers
  996. - **Content-Type**: application/json
  997. - **Accept**: application/json
  998. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  999. <<<<<<< Updated upstream
  1000. <a name="deletekey"></a>
  1001. # **DeleteKey**
  1002. > DeleteKeyReply DeleteKey (DeleteKeyRequest body, string authorization, string xCircleAppkey)
  1003. deleteKey
  1004. =======
  1005. <a name="encryptfile"></a>
  1006. # **EncryptFile**
  1007. > EncryptFileReply EncryptFile (EncryptFileRequest body, string xCircleAppkey)
  1008. encryptFile
  1009. >>>>>>> Stashed changes
  1010. ### Example
  1011. ```csharp
  1012. using System;
  1013. using System.Diagnostics;
  1014. <<<<<<< Updated upstream
  1015. using CircleSDK.Api;
  1016. using CircleSDK.Client;
  1017. using CircleSDK.Model;
  1018. namespace Example
  1019. {
  1020. public class DeleteKeyExample
  1021. =======
  1022. using IO.Swagger.Api;
  1023. using IO.Swagger.Client;
  1024. using IO.Swagger.Model;
  1025. namespace Example
  1026. {
  1027. public class EncryptFileExample
  1028. >>>>>>> Stashed changes
  1029. {
  1030. public void main()
  1031. {
  1032. var apiInstance = new CircleApi();
  1033. <<<<<<< Updated upstream
  1034. var body = new DeleteKeyRequest(); // DeleteKeyRequest |
  1035. var authorization = authorization_example; // string | Authorization Bearer
  1036. =======
  1037. var body = new EncryptFileRequest(); // EncryptFileRequest |
  1038. >>>>>>> Stashed changes
  1039. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1040. try
  1041. {
  1042. <<<<<<< Updated upstream
  1043. // deleteKey
  1044. DeleteKeyReply result = apiInstance.DeleteKey(body, authorization, xCircleAppkey);
  1045. =======
  1046. // encryptFile
  1047. EncryptFileReply result = apiInstance.EncryptFile(body, xCircleAppkey);
  1048. >>>>>>> Stashed changes
  1049. Debug.WriteLine(result);
  1050. }
  1051. catch (Exception e)
  1052. {
  1053. <<<<<<< Updated upstream
  1054. Debug.Print("Exception when calling CircleApi.DeleteKey: " + e.Message );
  1055. =======
  1056. Debug.Print("Exception when calling CircleApi.EncryptFile: " + e.Message );
  1057. >>>>>>> Stashed changes
  1058. }
  1059. }
  1060. }
  1061. }
  1062. ```
  1063. ### Parameters
  1064. Name | Type | Description | Notes
  1065. ------------- | ------------- | ------------- | -------------
  1066. <<<<<<< Updated upstream
  1067. **body** | [**DeleteKeyRequest**](DeleteKeyRequest.md)| |
  1068. **authorization** | **string**| Authorization Bearer |
  1069. =======
  1070. **body** | [**EncryptFileRequest**](EncryptFileRequest.md)| |
  1071. >>>>>>> Stashed changes
  1072. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1073. ### Return type
  1074. <<<<<<< Updated upstream
  1075. [**DeleteKeyReply**](DeleteKeyReply.md)
  1076. ### Authorization
  1077. No authorization required
  1078. ### HTTP request headers
  1079. - **Content-Type**: application/json
  1080. - **Accept**: application/json
  1081. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1082. <a name="deletemessage"></a>
  1083. # **DeleteMessage**
  1084. > DeleteMessageReply DeleteMessage (DeleteMessageRequest body, string authorization, string xCircleAppkey)
  1085. DeleteMessage
  1086. ### Example
  1087. ```csharp
  1088. using System;
  1089. using System.Diagnostics;
  1090. using CircleSDK.Api;
  1091. using CircleSDK.Client;
  1092. using CircleSDK.Model;
  1093. namespace Example
  1094. {
  1095. public class DeleteMessageExample
  1096. {
  1097. public void main()
  1098. {
  1099. var apiInstance = new CircleApi();
  1100. var body = new DeleteMessageRequest(); // DeleteMessageRequest |
  1101. var authorization = authorization_example; // string | Authorization Bearer
  1102. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1103. try
  1104. {
  1105. // DeleteMessage
  1106. DeleteMessageReply result = apiInstance.DeleteMessage(body, authorization, xCircleAppkey);
  1107. Debug.WriteLine(result);
  1108. }
  1109. catch (Exception e)
  1110. {
  1111. Debug.Print("Exception when calling CircleApi.DeleteMessage: " + e.Message );
  1112. }
  1113. }
  1114. }
  1115. }
  1116. ```
  1117. ### Parameters
  1118. Name | Type | Description | Notes
  1119. ------------- | ------------- | ------------- | -------------
  1120. **body** | [**DeleteMessageRequest**](DeleteMessageRequest.md)| |
  1121. **authorization** | **string**| Authorization Bearer |
  1122. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1123. ### Return type
  1124. [**DeleteMessageReply**](DeleteMessageReply.md)
  1125. ### Authorization
  1126. No authorization required
  1127. ### HTTP request headers
  1128. - **Content-Type**: application/json
  1129. - **Accept**: application/json
  1130. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1131. <a name="denycotinvoke"></a>
  1132. # **DenyCoTInvoke**
  1133. > DenyCoTInvokeReply DenyCoTInvoke (DenyCoTInvokeRequest body, string authorization, string xCircleAppkey)
  1134. DenyCoTInvoke
  1135. ### Example
  1136. ```csharp
  1137. using System;
  1138. using System.Diagnostics;
  1139. using CircleSDK.Api;
  1140. using CircleSDK.Client;
  1141. using CircleSDK.Model;
  1142. namespace Example
  1143. {
  1144. public class DenyCoTInvokeExample
  1145. {
  1146. public void main()
  1147. {
  1148. var apiInstance = new CircleApi();
  1149. var body = new DenyCoTInvokeRequest(); // DenyCoTInvokeRequest |
  1150. var authorization = authorization_example; // string | Authorization Bearer
  1151. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1152. try
  1153. {
  1154. // DenyCoTInvoke
  1155. DenyCoTInvokeReply result = apiInstance.DenyCoTInvoke(body, authorization, xCircleAppkey);
  1156. Debug.WriteLine(result);
  1157. }
  1158. catch (Exception e)
  1159. {
  1160. Debug.Print("Exception when calling CircleApi.DenyCoTInvoke: " + e.Message );
  1161. }
  1162. }
  1163. }
  1164. }
  1165. ```
  1166. ### Parameters
  1167. Name | Type | Description | Notes
  1168. ------------- | ------------- | ------------- | -------------
  1169. **body** | [**DenyCoTInvokeRequest**](DenyCoTInvokeRequest.md)| |
  1170. **authorization** | **string**| Authorization Bearer |
  1171. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1172. ### Return type
  1173. [**DenyCoTInvokeReply**](DenyCoTInvokeReply.md)
  1174. ### Authorization
  1175. No authorization required
  1176. ### HTTP request headers
  1177. - **Content-Type**: application/json
  1178. - **Accept**: application/json
  1179. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1180. <a name="downloadfile"></a>
  1181. # **DownloadFile**
  1182. > DownloadFileReply DownloadFile (DownloadFileRequest body, string authorization, string xCircleAppkey)
  1183. downloadFile
  1184. Upload a file with content. This method is available in the CircleService and not needed in CoreL2
  1185. ### Example
  1186. ```csharp
  1187. using System;
  1188. using System.Diagnostics;
  1189. using CircleSDK.Api;
  1190. using CircleSDK.Client;
  1191. using CircleSDK.Model;
  1192. namespace Example
  1193. {
  1194. public class DownloadFileExample
  1195. {
  1196. public void main()
  1197. {
  1198. var apiInstance = new CircleApi();
  1199. var body = new DownloadFileRequest(); // DownloadFileRequest |
  1200. var authorization = authorization_example; // string | Authorization Bearer
  1201. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1202. try
  1203. {
  1204. // downloadFile
  1205. DownloadFileReply result = apiInstance.DownloadFile(body, authorization, xCircleAppkey);
  1206. Debug.WriteLine(result);
  1207. }
  1208. catch (Exception e)
  1209. {
  1210. Debug.Print("Exception when calling CircleApi.DownloadFile: " + e.Message );
  1211. }
  1212. }
  1213. }
  1214. }
  1215. ```
  1216. ### Parameters
  1217. Name | Type | Description | Notes
  1218. ------------- | ------------- | ------------- | -------------
  1219. **body** | [**DownloadFileRequest**](DownloadFileRequest.md)| |
  1220. **authorization** | **string**| Authorization Bearer |
  1221. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1222. ### Return type
  1223. [**DownloadFileReply**](DownloadFileReply.md)
  1224. ### Authorization
  1225. No authorization required
  1226. ### HTTP request headers
  1227. - **Content-Type**: application/json
  1228. - **Accept**: application/json
  1229. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1230. <a name="encrypt"></a>
  1231. # **Encrypt**
  1232. > EncryptReply Encrypt (EncryptRequest body = null, string authorization = null, string xCircleAppkey = null)
  1233. encrypt
  1234. Encrypts base64 using a Circle/Topic encryption key.
  1235. ### Example
  1236. ```csharp
  1237. using System;
  1238. using System.Diagnostics;
  1239. using CircleSDK.Api;
  1240. using CircleSDK.Client;
  1241. using CircleSDK.Model;
  1242. namespace Example
  1243. {
  1244. public class EncryptExample
  1245. {
  1246. public void main()
  1247. {
  1248. var apiInstance = new CircleApi();
  1249. var body = new EncryptRequest(); // EncryptRequest | (optional)
  1250. var authorization = authorization_example; // string | Authorization Bearer (optional)
  1251. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey` (optional)
  1252. try
  1253. {
  1254. // encrypt
  1255. EncryptReply result = apiInstance.Encrypt(body, authorization, xCircleAppkey);
  1256. Debug.WriteLine(result);
  1257. }
  1258. catch (Exception e)
  1259. {
  1260. Debug.Print("Exception when calling CircleApi.Encrypt: " + e.Message );
  1261. }
  1262. }
  1263. }
  1264. }
  1265. ```
  1266. ### Parameters
  1267. Name | Type | Description | Notes
  1268. ------------- | ------------- | ------------- | -------------
  1269. **body** | [**EncryptRequest**](EncryptRequest.md)| | [optional]
  1270. **authorization** | **string**| Authorization Bearer | [optional]
  1271. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; | [optional]
  1272. ### Return type
  1273. [**EncryptReply**](EncryptReply.md)
  1274. =======
  1275. [**EncryptFileReply**](EncryptFileReply.md)
  1276. >>>>>>> Stashed changes
  1277. ### Authorization
  1278. No authorization required
  1279. ### HTTP request headers
  1280. - **Content-Type**: application/json
  1281. - **Accept**: application/json
  1282. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1283. <a name="enumcirclemembers"></a>
  1284. # **EnumCircleMembers**
  1285. <<<<<<< Updated upstream
  1286. > EnumCircleMembersReply EnumCircleMembers (EnumCircleMembersRequest body, string authorization, string xCircleAppkey)
  1287. enumCircleMembers
  1288. Enumerates all the members in a Circle.
  1289. =======
  1290. > EnumCircleMembersReply EnumCircleMembers (EnumCircleMembersRequest body, string xCircleAppkey)
  1291. enumCircleMembers
  1292. >>>>>>> Stashed changes
  1293. ### Example
  1294. ```csharp
  1295. using System;
  1296. using System.Diagnostics;
  1297. <<<<<<< Updated upstream
  1298. using CircleSDK.Api;
  1299. using CircleSDK.Client;
  1300. using CircleSDK.Model;
  1301. =======
  1302. using IO.Swagger.Api;
  1303. using IO.Swagger.Client;
  1304. using IO.Swagger.Model;
  1305. >>>>>>> Stashed changes
  1306. namespace Example
  1307. {
  1308. public class EnumCircleMembersExample
  1309. {
  1310. public void main()
  1311. {
  1312. var apiInstance = new CircleApi();
  1313. var body = new EnumCircleMembersRequest(); // EnumCircleMembersRequest |
  1314. <<<<<<< Updated upstream
  1315. var authorization = authorization_example; // string | Authorization Bearer
  1316. =======
  1317. >>>>>>> Stashed changes
  1318. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1319. try
  1320. {
  1321. // enumCircleMembers
  1322. <<<<<<< Updated upstream
  1323. EnumCircleMembersReply result = apiInstance.EnumCircleMembers(body, authorization, xCircleAppkey);
  1324. =======
  1325. EnumCircleMembersReply result = apiInstance.EnumCircleMembers(body, xCircleAppkey);
  1326. >>>>>>> Stashed changes
  1327. Debug.WriteLine(result);
  1328. }
  1329. catch (Exception e)
  1330. {
  1331. Debug.Print("Exception when calling CircleApi.EnumCircleMembers: " + e.Message );
  1332. }
  1333. }
  1334. }
  1335. }
  1336. ```
  1337. ### Parameters
  1338. Name | Type | Description | Notes
  1339. ------------- | ------------- | ------------- | -------------
  1340. **body** | [**EnumCircleMembersRequest**](EnumCircleMembersRequest.md)| |
  1341. <<<<<<< Updated upstream
  1342. **authorization** | **string**| Authorization Bearer |
  1343. =======
  1344. >>>>>>> Stashed changes
  1345. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1346. ### Return type
  1347. [**EnumCircleMembersReply**](EnumCircleMembersReply.md)
  1348. ### Authorization
  1349. No authorization required
  1350. ### HTTP request headers
  1351. - **Content-Type**: application/json
  1352. - **Accept**: application/json
  1353. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1354. <a name="enumcircles"></a>
  1355. # **EnumCircles**
  1356. <<<<<<< Updated upstream
  1357. > EnumCirclesReply EnumCircles (EnumCirclesRequest body, string authorization, string xCircleAppkey)
  1358. enumCircles
  1359. Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
  1360. =======
  1361. > EnumCirclesReply EnumCircles (EnumCirclesRequest body, string xCircleAppkey)
  1362. enumCircles
  1363. >>>>>>> Stashed changes
  1364. ### Example
  1365. ```csharp
  1366. using System;
  1367. using System.Diagnostics;
  1368. <<<<<<< Updated upstream
  1369. using CircleSDK.Api;
  1370. using CircleSDK.Client;
  1371. using CircleSDK.Model;
  1372. =======
  1373. using IO.Swagger.Api;
  1374. using IO.Swagger.Client;
  1375. using IO.Swagger.Model;
  1376. >>>>>>> Stashed changes
  1377. namespace Example
  1378. {
  1379. public class EnumCirclesExample
  1380. {
  1381. public void main()
  1382. {
  1383. var apiInstance = new CircleApi();
  1384. var body = new EnumCirclesRequest(); // EnumCirclesRequest |
  1385. <<<<<<< Updated upstream
  1386. var authorization = authorization_example; // string | Authorization Bearer
  1387. =======
  1388. >>>>>>> Stashed changes
  1389. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1390. try
  1391. {
  1392. // enumCircles
  1393. <<<<<<< Updated upstream
  1394. EnumCirclesReply result = apiInstance.EnumCircles(body, authorization, xCircleAppkey);
  1395. =======
  1396. EnumCirclesReply result = apiInstance.EnumCircles(body, xCircleAppkey);
  1397. >>>>>>> Stashed changes
  1398. Debug.WriteLine(result);
  1399. }
  1400. catch (Exception e)
  1401. {
  1402. Debug.Print("Exception when calling CircleApi.EnumCircles: " + e.Message );
  1403. }
  1404. }
  1405. }
  1406. }
  1407. ```
  1408. ### Parameters
  1409. Name | Type | Description | Notes
  1410. ------------- | ------------- | ------------- | -------------
  1411. **body** | [**EnumCirclesRequest**](EnumCirclesRequest.md)| |
  1412. <<<<<<< Updated upstream
  1413. **authorization** | **string**| Authorization Bearer |
  1414. =======
  1415. >>>>>>> Stashed changes
  1416. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1417. ### Return type
  1418. [**EnumCirclesReply**](EnumCirclesReply.md)
  1419. ### Authorization
  1420. No authorization required
  1421. ### HTTP request headers
  1422. - **Content-Type**: application/json
  1423. - **Accept**: application/json
  1424. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1425. <a name="enumdevices"></a>
  1426. # **EnumDevices**
  1427. <<<<<<< Updated upstream
  1428. > EnumDevicesReply EnumDevices (EnumDevicesRequest body, string authorization, string xCircleAppkey)
  1429. enumDevices
  1430. Enumerates all of the devices associated with a Member.
  1431. =======
  1432. > EnumDevicesReply EnumDevices (EnumDevicesRequest body, string xCircleAppkey)
  1433. enumDevices
  1434. >>>>>>> Stashed changes
  1435. ### Example
  1436. ```csharp
  1437. using System;
  1438. using System.Diagnostics;
  1439. <<<<<<< Updated upstream
  1440. using CircleSDK.Api;
  1441. using CircleSDK.Client;
  1442. using CircleSDK.Model;
  1443. =======
  1444. using IO.Swagger.Api;
  1445. using IO.Swagger.Client;
  1446. using IO.Swagger.Model;
  1447. >>>>>>> Stashed changes
  1448. namespace Example
  1449. {
  1450. public class EnumDevicesExample
  1451. {
  1452. public void main()
  1453. {
  1454. var apiInstance = new CircleApi();
  1455. var body = new EnumDevicesRequest(); // EnumDevicesRequest |
  1456. <<<<<<< Updated upstream
  1457. var authorization = authorization_example; // string | Authorization Bearer
  1458. =======
  1459. >>>>>>> Stashed changes
  1460. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1461. try
  1462. {
  1463. // enumDevices
  1464. <<<<<<< Updated upstream
  1465. EnumDevicesReply result = apiInstance.EnumDevices(body, authorization, xCircleAppkey);
  1466. =======
  1467. EnumDevicesReply result = apiInstance.EnumDevices(body, xCircleAppkey);
  1468. >>>>>>> Stashed changes
  1469. Debug.WriteLine(result);
  1470. }
  1471. catch (Exception e)
  1472. {
  1473. Debug.Print("Exception when calling CircleApi.EnumDevices: " + e.Message );
  1474. }
  1475. }
  1476. }
  1477. }
  1478. ```
  1479. ### Parameters
  1480. Name | Type | Description | Notes
  1481. ------------- | ------------- | ------------- | -------------
  1482. **body** | [**EnumDevicesRequest**](EnumDevicesRequest.md)| |
  1483. <<<<<<< Updated upstream
  1484. **authorization** | **string**| Authorization Bearer |
  1485. =======
  1486. >>>>>>> Stashed changes
  1487. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1488. ### Return type
  1489. [**EnumDevicesReply**](EnumDevicesReply.md)
  1490. ### Authorization
  1491. No authorization required
  1492. ### HTTP request headers
  1493. - **Content-Type**: application/json
  1494. - **Accept**: application/json
  1495. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1496. <a name="enumfiles"></a>
  1497. # **EnumFiles**
  1498. <<<<<<< Updated upstream
  1499. > EnumFilesReply EnumFiles (EnumFilesRequest body, string authorization, string xCircleAppkey)
  1500. enumFiles
  1501. Enumerates (lists) all the Files within a Topic.
  1502. =======
  1503. > EnumFilesReply EnumFiles (EnumFilesRequest body, string xCircleAppkey)
  1504. enumFiles
  1505. >>>>>>> Stashed changes
  1506. ### Example
  1507. ```csharp
  1508. using System;
  1509. using System.Diagnostics;
  1510. <<<<<<< Updated upstream
  1511. using CircleSDK.Api;
  1512. using CircleSDK.Client;
  1513. using CircleSDK.Model;
  1514. =======
  1515. using IO.Swagger.Api;
  1516. using IO.Swagger.Client;
  1517. using IO.Swagger.Model;
  1518. >>>>>>> Stashed changes
  1519. namespace Example
  1520. {
  1521. public class EnumFilesExample
  1522. {
  1523. public void main()
  1524. {
  1525. var apiInstance = new CircleApi();
  1526. var body = new EnumFilesRequest(); // EnumFilesRequest |
  1527. <<<<<<< Updated upstream
  1528. var authorization = authorization_example; // string | Authorization Bearer
  1529. =======
  1530. >>>>>>> Stashed changes
  1531. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1532. try
  1533. {
  1534. // enumFiles
  1535. <<<<<<< Updated upstream
  1536. EnumFilesReply result = apiInstance.EnumFiles(body, authorization, xCircleAppkey);
  1537. =======
  1538. EnumFilesReply result = apiInstance.EnumFiles(body, xCircleAppkey);
  1539. >>>>>>> Stashed changes
  1540. Debug.WriteLine(result);
  1541. }
  1542. catch (Exception e)
  1543. {
  1544. Debug.Print("Exception when calling CircleApi.EnumFiles: " + e.Message );
  1545. }
  1546. }
  1547. }
  1548. }
  1549. ```
  1550. ### Parameters
  1551. Name | Type | Description | Notes
  1552. ------------- | ------------- | ------------- | -------------
  1553. **body** | [**EnumFilesRequest**](EnumFilesRequest.md)| |
  1554. <<<<<<< Updated upstream
  1555. **authorization** | **string**| Authorization Bearer |
  1556. =======
  1557. >>>>>>> Stashed changes
  1558. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1559. ### Return type
  1560. [**EnumFilesReply**](EnumFilesReply.md)
  1561. ### Authorization
  1562. No authorization required
  1563. ### HTTP request headers
  1564. - **Content-Type**: application/json
  1565. - **Accept**: application/json
  1566. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1567. <a name="enuminvites"></a>
  1568. # **EnumInvites**
  1569. <<<<<<< Updated upstream
  1570. > EnumInvitesReply EnumInvites (EnumInvitesRequest body, string authorization, string xCircleAppkey)
  1571. enumInvites
  1572. Enumerates (lists) the invites currently pending for the Circle.
  1573. =======
  1574. > EnumInvitesReply EnumInvites (EnumInvitesRequest body, string xCircleAppkey)
  1575. enumInvites
  1576. >>>>>>> Stashed changes
  1577. ### Example
  1578. ```csharp
  1579. using System;
  1580. using System.Diagnostics;
  1581. <<<<<<< Updated upstream
  1582. using CircleSDK.Api;
  1583. using CircleSDK.Client;
  1584. using CircleSDK.Model;
  1585. =======
  1586. using IO.Swagger.Api;
  1587. using IO.Swagger.Client;
  1588. using IO.Swagger.Model;
  1589. >>>>>>> Stashed changes
  1590. namespace Example
  1591. {
  1592. public class EnumInvitesExample
  1593. {
  1594. public void main()
  1595. {
  1596. var apiInstance = new CircleApi();
  1597. var body = new EnumInvitesRequest(); // EnumInvitesRequest |
  1598. <<<<<<< Updated upstream
  1599. var authorization = authorization_example; // string | Authorization Bearer
  1600. =======
  1601. >>>>>>> Stashed changes
  1602. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1603. try
  1604. {
  1605. // enumInvites
  1606. <<<<<<< Updated upstream
  1607. EnumInvitesReply result = apiInstance.EnumInvites(body, authorization, xCircleAppkey);
  1608. =======
  1609. EnumInvitesReply result = apiInstance.EnumInvites(body, xCircleAppkey);
  1610. >>>>>>> Stashed changes
  1611. Debug.WriteLine(result);
  1612. }
  1613. catch (Exception e)
  1614. {
  1615. Debug.Print("Exception when calling CircleApi.EnumInvites: " + e.Message );
  1616. }
  1617. }
  1618. }
  1619. }
  1620. ```
  1621. ### Parameters
  1622. Name | Type | Description | Notes
  1623. ------------- | ------------- | ------------- | -------------
  1624. **body** | [**EnumInvitesRequest**](EnumInvitesRequest.md)| |
  1625. <<<<<<< Updated upstream
  1626. **authorization** | **string**| Authorization Bearer |
  1627. =======
  1628. >>>>>>> Stashed changes
  1629. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1630. ### Return type
  1631. [**EnumInvitesReply**](EnumInvitesReply.md)
  1632. ### Authorization
  1633. No authorization required
  1634. ### HTTP request headers
  1635. - **Content-Type**: application/json
  1636. - **Accept**: application/json
  1637. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1638. <<<<<<< Updated upstream
  1639. <a name="enumkeys"></a>
  1640. # **EnumKeys**
  1641. > EnumKeysReply EnumKeys (EnumKeysRequest body, string authorization, string xCircleAppkey)
  1642. enumKeys
  1643. ### Example
  1644. ```csharp
  1645. using System;
  1646. using System.Diagnostics;
  1647. using CircleSDK.Api;
  1648. using CircleSDK.Client;
  1649. using CircleSDK.Model;
  1650. namespace Example
  1651. {
  1652. public class EnumKeysExample
  1653. {
  1654. public void main()
  1655. {
  1656. var apiInstance = new CircleApi();
  1657. var body = new EnumKeysRequest(); // EnumKeysRequest |
  1658. var authorization = authorization_example; // string | Authorization Bearer
  1659. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1660. try
  1661. {
  1662. // enumKeys
  1663. EnumKeysReply result = apiInstance.EnumKeys(body, authorization, xCircleAppkey);
  1664. Debug.WriteLine(result);
  1665. }
  1666. catch (Exception e)
  1667. {
  1668. Debug.Print("Exception when calling CircleApi.EnumKeys: " + e.Message );
  1669. }
  1670. }
  1671. }
  1672. }
  1673. ```
  1674. ### Parameters
  1675. Name | Type | Description | Notes
  1676. ------------- | ------------- | ------------- | -------------
  1677. **body** | [**EnumKeysRequest**](EnumKeysRequest.md)| |
  1678. **authorization** | **string**| Authorization Bearer |
  1679. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1680. ### Return type
  1681. [**EnumKeysReply**](EnumKeysReply.md)
  1682. ### Authorization
  1683. No authorization required
  1684. ### HTTP request headers
  1685. - **Content-Type**: application/json
  1686. - **Accept**: application/json
  1687. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1688. <a name="enumrevisions"></a>
  1689. # **EnumRevisions**
  1690. > EnumRevisionsReply EnumRevisions (EnumRevisionsRequest body, string authorization, string xCircleAppkey)
  1691. enumRevisions
  1692. Enumerates (lists) all of the revisions of a file.
  1693. =======
  1694. <a name="enumrevisions"></a>
  1695. # **EnumRevisions**
  1696. > EnumRevisionsReply EnumRevisions (EnumRevisionsRequest body, string xCircleAppkey)
  1697. enumRevisions
  1698. >>>>>>> Stashed changes
  1699. ### Example
  1700. ```csharp
  1701. using System;
  1702. using System.Diagnostics;
  1703. <<<<<<< Updated upstream
  1704. using CircleSDK.Api;
  1705. using CircleSDK.Client;
  1706. using CircleSDK.Model;
  1707. =======
  1708. using IO.Swagger.Api;
  1709. using IO.Swagger.Client;
  1710. using IO.Swagger.Model;
  1711. >>>>>>> Stashed changes
  1712. namespace Example
  1713. {
  1714. public class EnumRevisionsExample
  1715. {
  1716. public void main()
  1717. {
  1718. var apiInstance = new CircleApi();
  1719. var body = new EnumRevisionsRequest(); // EnumRevisionsRequest |
  1720. <<<<<<< Updated upstream
  1721. var authorization = authorization_example; // string | Authorization Bearer
  1722. =======
  1723. >>>>>>> Stashed changes
  1724. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1725. try
  1726. {
  1727. // enumRevisions
  1728. <<<<<<< Updated upstream
  1729. EnumRevisionsReply result = apiInstance.EnumRevisions(body, authorization, xCircleAppkey);
  1730. =======
  1731. EnumRevisionsReply result = apiInstance.EnumRevisions(body, xCircleAppkey);
  1732. >>>>>>> Stashed changes
  1733. Debug.WriteLine(result);
  1734. }
  1735. catch (Exception e)
  1736. {
  1737. Debug.Print("Exception when calling CircleApi.EnumRevisions: " + e.Message );
  1738. }
  1739. }
  1740. }
  1741. }
  1742. ```
  1743. ### Parameters
  1744. Name | Type | Description | Notes
  1745. ------------- | ------------- | ------------- | -------------
  1746. **body** | [**EnumRevisionsRequest**](EnumRevisionsRequest.md)| |
  1747. <<<<<<< Updated upstream
  1748. **authorization** | **string**| Authorization Bearer |
  1749. =======
  1750. >>>>>>> Stashed changes
  1751. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1752. ### Return type
  1753. [**EnumRevisionsReply**](EnumRevisionsReply.md)
  1754. ### Authorization
  1755. No authorization required
  1756. ### HTTP request headers
  1757. - **Content-Type**: application/json
  1758. - **Accept**: application/json
  1759. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1760. <a name="enumtopicmembers"></a>
  1761. # **EnumTopicMembers**
  1762. <<<<<<< Updated upstream
  1763. > EnumTopicMembersReply EnumTopicMembers (EnumTopicMembersRequest body, string authorization, string xCircleAppkey)
  1764. enumTopicMembers
  1765. Enumerates the list of members in the specified topic.
  1766. =======
  1767. > EnumTopicMembersReply EnumTopicMembers (EnumTopicMembersRequest body, string xCircleAppkey)
  1768. enumTopicMembers
  1769. >>>>>>> Stashed changes
  1770. ### Example
  1771. ```csharp
  1772. using System;
  1773. using System.Diagnostics;
  1774. <<<<<<< Updated upstream
  1775. using CircleSDK.Api;
  1776. using CircleSDK.Client;
  1777. using CircleSDK.Model;
  1778. =======
  1779. using IO.Swagger.Api;
  1780. using IO.Swagger.Client;
  1781. using IO.Swagger.Model;
  1782. >>>>>>> Stashed changes
  1783. namespace Example
  1784. {
  1785. public class EnumTopicMembersExample
  1786. {
  1787. public void main()
  1788. {
  1789. var apiInstance = new CircleApi();
  1790. var body = new EnumTopicMembersRequest(); // EnumTopicMembersRequest |
  1791. <<<<<<< Updated upstream
  1792. var authorization = authorization_example; // string | Authorization Bearer
  1793. =======
  1794. >>>>>>> Stashed changes
  1795. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1796. try
  1797. {
  1798. // enumTopicMembers
  1799. <<<<<<< Updated upstream
  1800. EnumTopicMembersReply result = apiInstance.EnumTopicMembers(body, authorization, xCircleAppkey);
  1801. =======
  1802. EnumTopicMembersReply result = apiInstance.EnumTopicMembers(body, xCircleAppkey);
  1803. >>>>>>> Stashed changes
  1804. Debug.WriteLine(result);
  1805. }
  1806. catch (Exception e)
  1807. {
  1808. Debug.Print("Exception when calling CircleApi.EnumTopicMembers: " + e.Message );
  1809. }
  1810. }
  1811. }
  1812. }
  1813. ```
  1814. ### Parameters
  1815. Name | Type | Description | Notes
  1816. ------------- | ------------- | ------------- | -------------
  1817. **body** | [**EnumTopicMembersRequest**](EnumTopicMembersRequest.md)| |
  1818. <<<<<<< Updated upstream
  1819. **authorization** | **string**| Authorization Bearer |
  1820. =======
  1821. >>>>>>> Stashed changes
  1822. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1823. ### Return type
  1824. [**EnumTopicMembersReply**](EnumTopicMembersReply.md)
  1825. ### Authorization
  1826. No authorization required
  1827. ### HTTP request headers
  1828. - **Content-Type**: application/json
  1829. - **Accept**: application/json
  1830. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1831. <a name="enumtopics"></a>
  1832. # **EnumTopics**
  1833. <<<<<<< Updated upstream
  1834. > EnumTopicsReply EnumTopics (EnumTopicsRequest body, string authorization, string xCircleAppkey)
  1835. enumTopics
  1836. Enumerates (lists) the Topics in a Circle.
  1837. =======
  1838. > EnumTopicsReply EnumTopics (EnumTopicsRequest body, string xCircleAppkey)
  1839. enumTopics
  1840. >>>>>>> Stashed changes
  1841. ### Example
  1842. ```csharp
  1843. using System;
  1844. using System.Diagnostics;
  1845. <<<<<<< Updated upstream
  1846. using CircleSDK.Api;
  1847. using CircleSDK.Client;
  1848. using CircleSDK.Model;
  1849. =======
  1850. using IO.Swagger.Api;
  1851. using IO.Swagger.Client;
  1852. using IO.Swagger.Model;
  1853. >>>>>>> Stashed changes
  1854. namespace Example
  1855. {
  1856. public class EnumTopicsExample
  1857. {
  1858. public void main()
  1859. {
  1860. var apiInstance = new CircleApi();
  1861. var body = new EnumTopicsRequest(); // EnumTopicsRequest |
  1862. <<<<<<< Updated upstream
  1863. var authorization = authorization_example; // string | Authorization Bearer
  1864. =======
  1865. >>>>>>> Stashed changes
  1866. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1867. try
  1868. {
  1869. // enumTopics
  1870. <<<<<<< Updated upstream
  1871. EnumTopicsReply result = apiInstance.EnumTopics(body, authorization, xCircleAppkey);
  1872. =======
  1873. EnumTopicsReply result = apiInstance.EnumTopics(body, xCircleAppkey);
  1874. >>>>>>> Stashed changes
  1875. Debug.WriteLine(result);
  1876. }
  1877. catch (Exception e)
  1878. {
  1879. Debug.Print("Exception when calling CircleApi.EnumTopics: " + e.Message );
  1880. }
  1881. }
  1882. }
  1883. }
  1884. ```
  1885. ### Parameters
  1886. Name | Type | Description | Notes
  1887. ------------- | ------------- | ------------- | -------------
  1888. **body** | [**EnumTopicsRequest**](EnumTopicsRequest.md)| |
  1889. <<<<<<< Updated upstream
  1890. **authorization** | **string**| Authorization Bearer |
  1891. =======
  1892. >>>>>>> Stashed changes
  1893. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1894. ### Return type
  1895. [**EnumTopicsReply**](EnumTopicsReply.md)
  1896. ### Authorization
  1897. No authorization required
  1898. ### HTTP request headers
  1899. - **Content-Type**: application/json
  1900. - **Accept**: application/json
  1901. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1902. <a name="foreground"></a>
  1903. # **Foreground**
  1904. <<<<<<< Updated upstream
  1905. > ForegroundReply Foreground (ForegroundRequest body, string authorization, string xCircleAppkey)
  1906. foreground
  1907. Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
  1908. =======
  1909. > ForegroundReply Foreground (ForegroundRequest body, string xCircleAppkey)
  1910. foreground
  1911. >>>>>>> Stashed changes
  1912. ### Example
  1913. ```csharp
  1914. using System;
  1915. using System.Diagnostics;
  1916. <<<<<<< Updated upstream
  1917. using CircleSDK.Api;
  1918. using CircleSDK.Client;
  1919. using CircleSDK.Model;
  1920. =======
  1921. using IO.Swagger.Api;
  1922. using IO.Swagger.Client;
  1923. using IO.Swagger.Model;
  1924. >>>>>>> Stashed changes
  1925. namespace Example
  1926. {
  1927. public class ForegroundExample
  1928. {
  1929. public void main()
  1930. {
  1931. var apiInstance = new CircleApi();
  1932. var body = new ForegroundRequest(); // ForegroundRequest |
  1933. <<<<<<< Updated upstream
  1934. var authorization = authorization_example; // string | Authorization Bearer
  1935. =======
  1936. >>>>>>> Stashed changes
  1937. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  1938. try
  1939. {
  1940. // foreground
  1941. <<<<<<< Updated upstream
  1942. ForegroundReply result = apiInstance.Foreground(body, authorization, xCircleAppkey);
  1943. =======
  1944. ForegroundReply result = apiInstance.Foreground(body, xCircleAppkey);
  1945. >>>>>>> Stashed changes
  1946. Debug.WriteLine(result);
  1947. }
  1948. catch (Exception e)
  1949. {
  1950. Debug.Print("Exception when calling CircleApi.Foreground: " + e.Message );
  1951. }
  1952. }
  1953. }
  1954. }
  1955. ```
  1956. ### Parameters
  1957. Name | Type | Description | Notes
  1958. ------------- | ------------- | ------------- | -------------
  1959. **body** | [**ForegroundRequest**](ForegroundRequest.md)| |
  1960. <<<<<<< Updated upstream
  1961. **authorization** | **string**| Authorization Bearer |
  1962. =======
  1963. >>>>>>> Stashed changes
  1964. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  1965. ### Return type
  1966. [**ForegroundReply**](ForegroundReply.md)
  1967. ### Authorization
  1968. No authorization required
  1969. ### HTTP request headers
  1970. - **Content-Type**: application/json
  1971. - **Accept**: application/json
  1972. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  1973. <a name="geninvite"></a>
  1974. # **GenInvite**
  1975. <<<<<<< Updated upstream
  1976. > GenInviteReply GenInvite (GenInviteRequest body, string authorization, string xCircleAppkey)
  1977. genInvite
  1978. Generates the invitation ID and authorization code for a Circle invitation.
  1979. =======
  1980. > GenInviteReply GenInvite (GenInviteRequest body, string xCircleAppkey)
  1981. genInvite
  1982. >>>>>>> Stashed changes
  1983. ### Example
  1984. ```csharp
  1985. using System;
  1986. using System.Diagnostics;
  1987. <<<<<<< Updated upstream
  1988. using CircleSDK.Api;
  1989. using CircleSDK.Client;
  1990. using CircleSDK.Model;
  1991. =======
  1992. using IO.Swagger.Api;
  1993. using IO.Swagger.Client;
  1994. using IO.Swagger.Model;
  1995. >>>>>>> Stashed changes
  1996. namespace Example
  1997. {
  1998. public class GenInviteExample
  1999. {
  2000. public void main()
  2001. {
  2002. var apiInstance = new CircleApi();
  2003. var body = new GenInviteRequest(); // GenInviteRequest |
  2004. <<<<<<< Updated upstream
  2005. var authorization = authorization_example; // string | Authorization Bearer
  2006. =======
  2007. >>>>>>> Stashed changes
  2008. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2009. try
  2010. {
  2011. // genInvite
  2012. <<<<<<< Updated upstream
  2013. GenInviteReply result = apiInstance.GenInvite(body, authorization, xCircleAppkey);
  2014. =======
  2015. GenInviteReply result = apiInstance.GenInvite(body, xCircleAppkey);
  2016. >>>>>>> Stashed changes
  2017. Debug.WriteLine(result);
  2018. }
  2019. catch (Exception e)
  2020. {
  2021. Debug.Print("Exception when calling CircleApi.GenInvite: " + e.Message );
  2022. }
  2023. }
  2024. }
  2025. }
  2026. ```
  2027. ### Parameters
  2028. Name | Type | Description | Notes
  2029. ------------- | ------------- | ------------- | -------------
  2030. **body** | [**GenInviteRequest**](GenInviteRequest.md)| |
  2031. <<<<<<< Updated upstream
  2032. **authorization** | **string**| Authorization Bearer |
  2033. =======
  2034. >>>>>>> Stashed changes
  2035. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2036. ### Return type
  2037. [**GenInviteReply**](GenInviteReply.md)
  2038. ### Authorization
  2039. No authorization required
  2040. ### HTTP request headers
  2041. - **Content-Type**: application/json
  2042. - **Accept**: application/json
  2043. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2044. <<<<<<< Updated upstream
  2045. <a name="getcircleoftrust"></a>
  2046. # **GetCircleOfTrust**
  2047. > GetCircleOfTrustReply GetCircleOfTrust (GetCircleOfTrustRequest body, string authorization, string xCircleAppkey)
  2048. GetCircleOfTrust
  2049. =======
  2050. <a name="getfile"></a>
  2051. # **GetFile**
  2052. > GetFileReply GetFile (GetFileRequest body, string xCircleAppkey)
  2053. getFile
  2054. >>>>>>> Stashed changes
  2055. ### Example
  2056. ```csharp
  2057. using System;
  2058. using System.Diagnostics;
  2059. <<<<<<< Updated upstream
  2060. using CircleSDK.Api;
  2061. using CircleSDK.Client;
  2062. using CircleSDK.Model;
  2063. namespace Example
  2064. {
  2065. public class GetCircleOfTrustExample
  2066. =======
  2067. using IO.Swagger.Api;
  2068. using IO.Swagger.Client;
  2069. using IO.Swagger.Model;
  2070. namespace Example
  2071. {
  2072. public class GetFileExample
  2073. >>>>>>> Stashed changes
  2074. {
  2075. public void main()
  2076. {
  2077. var apiInstance = new CircleApi();
  2078. <<<<<<< Updated upstream
  2079. var body = new GetCircleOfTrustRequest(); // GetCircleOfTrustRequest |
  2080. var authorization = authorization_example; // string | Authorization Bearer
  2081. =======
  2082. var body = new GetFileRequest(); // GetFileRequest |
  2083. >>>>>>> Stashed changes
  2084. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2085. try
  2086. {
  2087. <<<<<<< Updated upstream
  2088. // GetCircleOfTrust
  2089. GetCircleOfTrustReply result = apiInstance.GetCircleOfTrust(body, authorization, xCircleAppkey);
  2090. =======
  2091. // getFile
  2092. GetFileReply result = apiInstance.GetFile(body, xCircleAppkey);
  2093. >>>>>>> Stashed changes
  2094. Debug.WriteLine(result);
  2095. }
  2096. catch (Exception e)
  2097. {
  2098. <<<<<<< Updated upstream
  2099. Debug.Print("Exception when calling CircleApi.GetCircleOfTrust: " + e.Message );
  2100. =======
  2101. Debug.Print("Exception when calling CircleApi.GetFile: " + e.Message );
  2102. >>>>>>> Stashed changes
  2103. }
  2104. }
  2105. }
  2106. }
  2107. ```
  2108. ### Parameters
  2109. Name | Type | Description | Notes
  2110. ------------- | ------------- | ------------- | -------------
  2111. <<<<<<< Updated upstream
  2112. **body** | [**GetCircleOfTrustRequest**](GetCircleOfTrustRequest.md)| |
  2113. **authorization** | **string**| Authorization Bearer |
  2114. =======
  2115. **body** | [**GetFileRequest**](GetFileRequest.md)| |
  2116. >>>>>>> Stashed changes
  2117. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2118. ### Return type
  2119. <<<<<<< Updated upstream
  2120. [**GetCircleOfTrustReply**](GetCircleOfTrustReply.md)
  2121. =======
  2122. [**GetFileReply**](GetFileReply.md)
  2123. >>>>>>> Stashed changes
  2124. ### Authorization
  2125. No authorization required
  2126. ### HTTP request headers
  2127. - **Content-Type**: application/json
  2128. - **Accept**: application/json
  2129. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2130. <<<<<<< Updated upstream
  2131. <a name="getcirclepublickey"></a>
  2132. # **GetCirclePublicKey**
  2133. > GetCirclePublicKeyReply GetCirclePublicKey (GetCirclePublicKeyRequest body, string authorization, string xCircleAppkey)
  2134. GetCirclePublicKey
  2135. =======
  2136. <a name="getmessges"></a>
  2137. # **GetMessges**
  2138. > GetMessgesReply GetMessges (GetMessgesRequest body, string xCircleAppkey)
  2139. getMessges
  2140. >>>>>>> Stashed changes
  2141. ### Example
  2142. ```csharp
  2143. using System;
  2144. using System.Diagnostics;
  2145. <<<<<<< Updated upstream
  2146. using CircleSDK.Api;
  2147. using CircleSDK.Client;
  2148. using CircleSDK.Model;
  2149. namespace Example
  2150. {
  2151. public class GetCirclePublicKeyExample
  2152. =======
  2153. using IO.Swagger.Api;
  2154. using IO.Swagger.Client;
  2155. using IO.Swagger.Model;
  2156. namespace Example
  2157. {
  2158. public class GetMessgesExample
  2159. >>>>>>> Stashed changes
  2160. {
  2161. public void main()
  2162. {
  2163. var apiInstance = new CircleApi();
  2164. <<<<<<< Updated upstream
  2165. var body = new GetCirclePublicKeyRequest(); // GetCirclePublicKeyRequest |
  2166. var authorization = authorization_example; // string | Authorization Bearer
  2167. =======
  2168. var body = new GetMessgesRequest(); // GetMessgesRequest |
  2169. >>>>>>> Stashed changes
  2170. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2171. try
  2172. {
  2173. <<<<<<< Updated upstream
  2174. // GetCirclePublicKey
  2175. GetCirclePublicKeyReply result = apiInstance.GetCirclePublicKey(body, authorization, xCircleAppkey);
  2176. =======
  2177. // getMessges
  2178. GetMessgesReply result = apiInstance.GetMessges(body, xCircleAppkey);
  2179. >>>>>>> Stashed changes
  2180. Debug.WriteLine(result);
  2181. }
  2182. catch (Exception e)
  2183. {
  2184. <<<<<<< Updated upstream
  2185. Debug.Print("Exception when calling CircleApi.GetCirclePublicKey: " + e.Message );
  2186. =======
  2187. Debug.Print("Exception when calling CircleApi.GetMessges: " + e.Message );
  2188. >>>>>>> Stashed changes
  2189. }
  2190. }
  2191. }
  2192. }
  2193. ```
  2194. ### Parameters
  2195. Name | Type | Description | Notes
  2196. ------------- | ------------- | ------------- | -------------
  2197. <<<<<<< Updated upstream
  2198. **body** | [**GetCirclePublicKeyRequest**](GetCirclePublicKeyRequest.md)| |
  2199. **authorization** | **string**| Authorization Bearer |
  2200. =======
  2201. **body** | [**GetMessgesRequest**](GetMessgesRequest.md)| |
  2202. >>>>>>> Stashed changes
  2203. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2204. ### Return type
  2205. <<<<<<< Updated upstream
  2206. [**GetCirclePublicKeyReply**](GetCirclePublicKeyReply.md)
  2207. =======
  2208. [**GetMessgesReply**](GetMessgesReply.md)
  2209. >>>>>>> Stashed changes
  2210. ### Authorization
  2211. No authorization required
  2212. ### HTTP request headers
  2213. - **Content-Type**: application/json
  2214. - **Accept**: application/json
  2215. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2216. <<<<<<< Updated upstream
  2217. <a name="getmessage"></a>
  2218. # **GetMessage**
  2219. > GetMessageReply GetMessage (GetMessageRequest body, string authorization, string xCircleAppkey)
  2220. GetMessage
  2221. =======
  2222. <a name="gettopickey"></a>
  2223. # **GetTopicKey**
  2224. > GetTopicKeyReply GetTopicKey (GetTopicKeyRequest body, string xCircleAppkey)
  2225. getTopicKey
  2226. >>>>>>> Stashed changes
  2227. ### Example
  2228. ```csharp
  2229. using System;
  2230. using System.Diagnostics;
  2231. <<<<<<< Updated upstream
  2232. using CircleSDK.Api;
  2233. using CircleSDK.Client;
  2234. using CircleSDK.Model;
  2235. namespace Example
  2236. {
  2237. public class GetMessageExample
  2238. =======
  2239. using IO.Swagger.Api;
  2240. using IO.Swagger.Client;
  2241. using IO.Swagger.Model;
  2242. namespace Example
  2243. {
  2244. public class GetTopicKeyExample
  2245. >>>>>>> Stashed changes
  2246. {
  2247. public void main()
  2248. {
  2249. var apiInstance = new CircleApi();
  2250. <<<<<<< Updated upstream
  2251. var body = new GetMessageRequest(); // GetMessageRequest |
  2252. var authorization = authorization_example; // string | Authorization Bearer
  2253. =======
  2254. var body = new GetTopicKeyRequest(); // GetTopicKeyRequest |
  2255. >>>>>>> Stashed changes
  2256. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2257. try
  2258. {
  2259. <<<<<<< Updated upstream
  2260. // GetMessage
  2261. GetMessageReply result = apiInstance.GetMessage(body, authorization, xCircleAppkey);
  2262. =======
  2263. // getTopicKey
  2264. GetTopicKeyReply result = apiInstance.GetTopicKey(body, xCircleAppkey);
  2265. >>>>>>> Stashed changes
  2266. Debug.WriteLine(result);
  2267. }
  2268. catch (Exception e)
  2269. {
  2270. <<<<<<< Updated upstream
  2271. Debug.Print("Exception when calling CircleApi.GetMessage: " + e.Message );
  2272. =======
  2273. Debug.Print("Exception when calling CircleApi.GetTopicKey: " + e.Message );
  2274. >>>>>>> Stashed changes
  2275. }
  2276. }
  2277. }
  2278. }
  2279. ```
  2280. ### Parameters
  2281. Name | Type | Description | Notes
  2282. ------------- | ------------- | ------------- | -------------
  2283. <<<<<<< Updated upstream
  2284. **body** | [**GetMessageRequest**](GetMessageRequest.md)| |
  2285. **authorization** | **string**| Authorization Bearer |
  2286. =======
  2287. **body** | [**GetTopicKeyRequest**](GetTopicKeyRequest.md)| |
  2288. >>>>>>> Stashed changes
  2289. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2290. ### Return type
  2291. <<<<<<< Updated upstream
  2292. [**GetMessageReply**](GetMessageReply.md)
  2293. =======
  2294. [**GetTopicKeyReply**](GetTopicKeyReply.md)
  2295. >>>>>>> Stashed changes
  2296. ### Authorization
  2297. No authorization required
  2298. ### HTTP request headers
  2299. - **Content-Type**: application/json
  2300. - **Accept**: application/json
  2301. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2302. <<<<<<< Updated upstream
  2303. <a name="getmessages"></a>
  2304. # **GetMessages**
  2305. > GetMessagesReply GetMessages (GetMessagesRequest body, string authorization, string xCircleAppkey)
  2306. getMessages
  2307. Gets the messages from the desired topic.
  2308. =======
  2309. <a name="invite"></a>
  2310. # **Invite**
  2311. > InviteReply Invite (InviteRequest body, string xCircleAppkey)
  2312. invite
  2313. >>>>>>> Stashed changes
  2314. ### Example
  2315. ```csharp
  2316. using System;
  2317. using System.Diagnostics;
  2318. <<<<<<< Updated upstream
  2319. using CircleSDK.Api;
  2320. using CircleSDK.Client;
  2321. using CircleSDK.Model;
  2322. namespace Example
  2323. {
  2324. public class GetMessagesExample
  2325. =======
  2326. using IO.Swagger.Api;
  2327. using IO.Swagger.Client;
  2328. using IO.Swagger.Model;
  2329. namespace Example
  2330. {
  2331. public class InviteExample
  2332. >>>>>>> Stashed changes
  2333. {
  2334. public void main()
  2335. {
  2336. var apiInstance = new CircleApi();
  2337. <<<<<<< Updated upstream
  2338. var body = new GetMessagesRequest(); // GetMessagesRequest |
  2339. var authorization = authorization_example; // string | Authorization Bearer
  2340. =======
  2341. var body = new InviteRequest(); // InviteRequest |
  2342. >>>>>>> Stashed changes
  2343. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2344. try
  2345. {
  2346. <<<<<<< Updated upstream
  2347. // getMessages
  2348. GetMessagesReply result = apiInstance.GetMessages(body, authorization, xCircleAppkey);
  2349. =======
  2350. // invite
  2351. InviteReply result = apiInstance.Invite(body, xCircleAppkey);
  2352. >>>>>>> Stashed changes
  2353. Debug.WriteLine(result);
  2354. }
  2355. catch (Exception e)
  2356. {
  2357. <<<<<<< Updated upstream
  2358. Debug.Print("Exception when calling CircleApi.GetMessages: " + e.Message );
  2359. =======
  2360. Debug.Print("Exception when calling CircleApi.Invite: " + e.Message );
  2361. >>>>>>> Stashed changes
  2362. }
  2363. }
  2364. }
  2365. }
  2366. ```
  2367. ### Parameters
  2368. Name | Type | Description | Notes
  2369. ------------- | ------------- | ------------- | -------------
  2370. <<<<<<< Updated upstream
  2371. **body** | [**GetMessagesRequest**](GetMessagesRequest.md)| |
  2372. **authorization** | **string**| Authorization Bearer |
  2373. =======
  2374. **body** | [**InviteRequest**](InviteRequest.md)| |
  2375. >>>>>>> Stashed changes
  2376. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2377. ### Return type
  2378. <<<<<<< Updated upstream
  2379. [**GetMessagesReply**](GetMessagesReply.md)
  2380. ### Authorization
  2381. No authorization required
  2382. ### HTTP request headers
  2383. - **Content-Type**: application/json
  2384. - **Accept**: application/json
  2385. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2386. <a name="getravstatus"></a>
  2387. # **GetRAVStatus**
  2388. > GetRAVStatusReply GetRAVStatus (GetRAVStatusRequest body, string authorization, string xCircleAppkey)
  2389. GetRAVStatus
  2390. ### Example
  2391. ```csharp
  2392. using System;
  2393. using System.Diagnostics;
  2394. using CircleSDK.Api;
  2395. using CircleSDK.Client;
  2396. using CircleSDK.Model;
  2397. namespace Example
  2398. {
  2399. public class GetRAVStatusExample
  2400. {
  2401. public void main()
  2402. {
  2403. var apiInstance = new CircleApi();
  2404. var body = new GetRAVStatusRequest(); // GetRAVStatusRequest |
  2405. var authorization = authorization_example; // string | Authorization Bearer
  2406. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2407. try
  2408. {
  2409. // GetRAVStatus
  2410. GetRAVStatusReply result = apiInstance.GetRAVStatus(body, authorization, xCircleAppkey);
  2411. Debug.WriteLine(result);
  2412. }
  2413. catch (Exception e)
  2414. {
  2415. Debug.Print("Exception when calling CircleApi.GetRAVStatus: " + e.Message );
  2416. }
  2417. }
  2418. }
  2419. }
  2420. ```
  2421. ### Parameters
  2422. Name | Type | Description | Notes
  2423. ------------- | ------------- | ------------- | -------------
  2424. **body** | [**GetRAVStatusRequest**](GetRAVStatusRequest.md)| |
  2425. **authorization** | **string**| Authorization Bearer |
  2426. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2427. ### Return type
  2428. [**GetRAVStatusReply**](GetRAVStatusReply.md)
  2429. ### Authorization
  2430. No authorization required
  2431. ### HTTP request headers
  2432. - **Content-Type**: application/json
  2433. - **Accept**: application/json
  2434. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2435. <a name="getsecurefilecontents"></a>
  2436. # **GetSecureFileContents**
  2437. > GetSecureFileContentsReply GetSecureFileContents (GetSecureFileContentsRequest body, string authorization, string xCircleAppkey)
  2438. GetSecureFileContents
  2439. ### Example
  2440. ```csharp
  2441. using System;
  2442. using System.Diagnostics;
  2443. using CircleSDK.Api;
  2444. using CircleSDK.Client;
  2445. using CircleSDK.Model;
  2446. namespace Example
  2447. {
  2448. public class GetSecureFileContentsExample
  2449. {
  2450. public void main()
  2451. {
  2452. var apiInstance = new CircleApi();
  2453. var body = new GetSecureFileContentsRequest(); // GetSecureFileContentsRequest |
  2454. var authorization = authorization_example; // string | Authorization Bearer
  2455. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2456. try
  2457. {
  2458. // GetSecureFileContents
  2459. GetSecureFileContentsReply result = apiInstance.GetSecureFileContents(body, authorization, xCircleAppkey);
  2460. Debug.WriteLine(result);
  2461. }
  2462. catch (Exception e)
  2463. {
  2464. Debug.Print("Exception when calling CircleApi.GetSecureFileContents: " + e.Message );
  2465. }
  2466. }
  2467. }
  2468. }
  2469. ```
  2470. ### Parameters
  2471. Name | Type | Description | Notes
  2472. ------------- | ------------- | ------------- | -------------
  2473. **body** | [**GetSecureFileContentsRequest**](GetSecureFileContentsRequest.md)| |
  2474. **authorization** | **string**| Authorization Bearer |
  2475. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2476. ### Return type
  2477. [**GetSecureFileContentsReply**](GetSecureFileContentsReply.md)
  2478. ### Authorization
  2479. No authorization required
  2480. ### HTTP request headers
  2481. - **Content-Type**: application/json
  2482. - **Accept**: application/json
  2483. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2484. <a name="getsyncstatus"></a>
  2485. # **GetSyncStatus**
  2486. > GetSyncStatusReply GetSyncStatus (GetSyncStatusRequest body, string authorization, string xCircleAppkey)
  2487. getSyncStatus
  2488. ### Example
  2489. ```csharp
  2490. using System;
  2491. using System.Diagnostics;
  2492. using CircleSDK.Api;
  2493. using CircleSDK.Client;
  2494. using CircleSDK.Model;
  2495. namespace Example
  2496. {
  2497. public class GetSyncStatusExample
  2498. {
  2499. public void main()
  2500. {
  2501. var apiInstance = new CircleApi();
  2502. var body = new GetSyncStatusRequest(); // GetSyncStatusRequest |
  2503. var authorization = authorization_example; // string | Authorization Bearer
  2504. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2505. try
  2506. {
  2507. // getSyncStatus
  2508. GetSyncStatusReply result = apiInstance.GetSyncStatus(body, authorization, xCircleAppkey);
  2509. Debug.WriteLine(result);
  2510. }
  2511. catch (Exception e)
  2512. {
  2513. Debug.Print("Exception when calling CircleApi.GetSyncStatus: " + e.Message );
  2514. }
  2515. }
  2516. }
  2517. }
  2518. ```
  2519. ### Parameters
  2520. Name | Type | Description | Notes
  2521. ------------- | ------------- | ------------- | -------------
  2522. **body** | [**GetSyncStatusRequest**](GetSyncStatusRequest.md)| |
  2523. **authorization** | **string**| Authorization Bearer |
  2524. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2525. ### Return type
  2526. [**GetSyncStatusReply**](GetSyncStatusReply.md)
  2527. ### Authorization
  2528. No authorization required
  2529. ### HTTP request headers
  2530. - **Content-Type**: application/json
  2531. - **Accept**: application/json
  2532. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2533. <a name="getuserpublickey"></a>
  2534. # **GetUserPublicKey**
  2535. > GetUserPublicKeyReply GetUserPublicKey (GetUserPublicKeyRequest body, string authorization, string xCircleAppkey)
  2536. GetUserPublicKey
  2537. ### Example
  2538. ```csharp
  2539. using System;
  2540. using System.Diagnostics;
  2541. using CircleSDK.Api;
  2542. using CircleSDK.Client;
  2543. using CircleSDK.Model;
  2544. namespace Example
  2545. {
  2546. public class GetUserPublicKeyExample
  2547. {
  2548. public void main()
  2549. {
  2550. var apiInstance = new CircleApi();
  2551. var body = new GetUserPublicKeyRequest(); // GetUserPublicKeyRequest |
  2552. var authorization = authorization_example; // string | Authorization Bearer
  2553. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2554. try
  2555. {
  2556. // GetUserPublicKey
  2557. GetUserPublicKeyReply result = apiInstance.GetUserPublicKey(body, authorization, xCircleAppkey);
  2558. Debug.WriteLine(result);
  2559. }
  2560. catch (Exception e)
  2561. {
  2562. Debug.Print("Exception when calling CircleApi.GetUserPublicKey: " + e.Message );
  2563. }
  2564. }
  2565. }
  2566. }
  2567. ```
  2568. ### Parameters
  2569. Name | Type | Description | Notes
  2570. ------------- | ------------- | ------------- | -------------
  2571. **body** | [**GetUserPublicKeyRequest**](GetUserPublicKeyRequest.md)| |
  2572. **authorization** | **string**| Authorization Bearer |
  2573. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2574. ### Return type
  2575. [**GetUserPublicKeyReply**](GetUserPublicKeyReply.md)
  2576. ### Authorization
  2577. No authorization required
  2578. ### HTTP request headers
  2579. - **Content-Type**: application/json
  2580. - **Accept**: application/json
  2581. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2582. <a name="getvalue"></a>
  2583. # **GetValue**
  2584. > GetValueReply GetValue (GetValueRequest body, string authorization, string xCircleAppkey)
  2585. getValue
  2586. ### Example
  2587. ```csharp
  2588. using System;
  2589. using System.Diagnostics;
  2590. using CircleSDK.Api;
  2591. using CircleSDK.Client;
  2592. using CircleSDK.Model;
  2593. namespace Example
  2594. {
  2595. public class GetValueExample
  2596. {
  2597. public void main()
  2598. {
  2599. var apiInstance = new CircleApi();
  2600. var body = new GetValueRequest(); // GetValueRequest |
  2601. var authorization = authorization_example; // string | Authorization Bearer
  2602. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2603. try
  2604. {
  2605. // getValue
  2606. GetValueReply result = apiInstance.GetValue(body, authorization, xCircleAppkey);
  2607. Debug.WriteLine(result);
  2608. }
  2609. catch (Exception e)
  2610. {
  2611. Debug.Print("Exception when calling CircleApi.GetValue: " + e.Message );
  2612. }
  2613. }
  2614. }
  2615. }
  2616. ```
  2617. ### Parameters
  2618. Name | Type | Description | Notes
  2619. ------------- | ------------- | ------------- | -------------
  2620. **body** | [**GetValueRequest**](GetValueRequest.md)| |
  2621. **authorization** | **string**| Authorization Bearer |
  2622. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2623. ### Return type
  2624. [**GetValueReply**](GetValueReply.md)
  2625. =======
  2626. [**InviteReply**](InviteReply.md)
  2627. >>>>>>> Stashed changes
  2628. ### Authorization
  2629. No authorization required
  2630. ### HTTP request headers
  2631. - **Content-Type**: application/json
  2632. - **Accept**: application/json
  2633. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2634. <a name="jointopic"></a>
  2635. # **JoinTopic**
  2636. <<<<<<< Updated upstream
  2637. > JoinTopicReply JoinTopic (JoinTopicRequest body, string authorization, string xCircleAppkey)
  2638. joinTopic
  2639. Joins an existing topic in a Circle.
  2640. =======
  2641. > JoinTopicReply JoinTopic (JoinTopicRequest body, string xCircleAppkey)
  2642. joinTopic
  2643. >>>>>>> Stashed changes
  2644. ### Example
  2645. ```csharp
  2646. using System;
  2647. using System.Diagnostics;
  2648. <<<<<<< Updated upstream
  2649. using CircleSDK.Api;
  2650. using CircleSDK.Client;
  2651. using CircleSDK.Model;
  2652. =======
  2653. using IO.Swagger.Api;
  2654. using IO.Swagger.Client;
  2655. using IO.Swagger.Model;
  2656. >>>>>>> Stashed changes
  2657. namespace Example
  2658. {
  2659. public class JoinTopicExample
  2660. {
  2661. public void main()
  2662. {
  2663. var apiInstance = new CircleApi();
  2664. var body = new JoinTopicRequest(); // JoinTopicRequest |
  2665. <<<<<<< Updated upstream
  2666. var authorization = authorization_example; // string | Authorization Bearer
  2667. =======
  2668. >>>>>>> Stashed changes
  2669. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2670. try
  2671. {
  2672. // joinTopic
  2673. <<<<<<< Updated upstream
  2674. JoinTopicReply result = apiInstance.JoinTopic(body, authorization, xCircleAppkey);
  2675. =======
  2676. JoinTopicReply result = apiInstance.JoinTopic(body, xCircleAppkey);
  2677. >>>>>>> Stashed changes
  2678. Debug.WriteLine(result);
  2679. }
  2680. catch (Exception e)
  2681. {
  2682. Debug.Print("Exception when calling CircleApi.JoinTopic: " + e.Message );
  2683. }
  2684. }
  2685. }
  2686. }
  2687. ```
  2688. ### Parameters
  2689. Name | Type | Description | Notes
  2690. ------------- | ------------- | ------------- | -------------
  2691. **body** | [**JoinTopicRequest**](JoinTopicRequest.md)| |
  2692. <<<<<<< Updated upstream
  2693. **authorization** | **string**| Authorization Bearer |
  2694. =======
  2695. >>>>>>> Stashed changes
  2696. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2697. ### Return type
  2698. [**JoinTopicReply**](JoinTopicReply.md)
  2699. ### Authorization
  2700. No authorization required
  2701. ### HTTP request headers
  2702. - **Content-Type**: application/json
  2703. - **Accept**: application/json
  2704. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2705. <a name="leavetopic"></a>
  2706. # **LeaveTopic**
  2707. <<<<<<< Updated upstream
  2708. > LeaveTopicReply LeaveTopic (LeaveTopicRequest body, string authorization, string xCircleAppkey)
  2709. leaveTopic
  2710. Leave ('unjoin') a Topic.
  2711. =======
  2712. > LeaveTopicReply LeaveTopic (LeaveTopicRequest body, string xCircleAppkey)
  2713. leaveTopic
  2714. >>>>>>> Stashed changes
  2715. ### Example
  2716. ```csharp
  2717. using System;
  2718. using System.Diagnostics;
  2719. <<<<<<< Updated upstream
  2720. using CircleSDK.Api;
  2721. using CircleSDK.Client;
  2722. using CircleSDK.Model;
  2723. =======
  2724. using IO.Swagger.Api;
  2725. using IO.Swagger.Client;
  2726. using IO.Swagger.Model;
  2727. >>>>>>> Stashed changes
  2728. namespace Example
  2729. {
  2730. public class LeaveTopicExample
  2731. {
  2732. public void main()
  2733. {
  2734. var apiInstance = new CircleApi();
  2735. var body = new LeaveTopicRequest(); // LeaveTopicRequest |
  2736. <<<<<<< Updated upstream
  2737. var authorization = authorization_example; // string | Authorization Bearer
  2738. =======
  2739. >>>>>>> Stashed changes
  2740. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2741. try
  2742. {
  2743. // leaveTopic
  2744. <<<<<<< Updated upstream
  2745. LeaveTopicReply result = apiInstance.LeaveTopic(body, authorization, xCircleAppkey);
  2746. =======
  2747. LeaveTopicReply result = apiInstance.LeaveTopic(body, xCircleAppkey);
  2748. >>>>>>> Stashed changes
  2749. Debug.WriteLine(result);
  2750. }
  2751. catch (Exception e)
  2752. {
  2753. Debug.Print("Exception when calling CircleApi.LeaveTopic: " + e.Message );
  2754. }
  2755. }
  2756. }
  2757. }
  2758. ```
  2759. ### Parameters
  2760. Name | Type | Description | Notes
  2761. ------------- | ------------- | ------------- | -------------
  2762. **body** | [**LeaveTopicRequest**](LeaveTopicRequest.md)| |
  2763. <<<<<<< Updated upstream
  2764. **authorization** | **string**| Authorization Bearer |
  2765. =======
  2766. >>>>>>> Stashed changes
  2767. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2768. ### Return type
  2769. [**LeaveTopicReply**](LeaveTopicReply.md)
  2770. ### Authorization
  2771. No authorization required
  2772. ### HTTP request headers
  2773. - **Content-Type**: application/json
  2774. - **Accept**: application/json
  2775. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2776. <<<<<<< Updated upstream
  2777. <a name="lockuser"></a>
  2778. # **LockUser**
  2779. > LockUserReply LockUser (LockUserRequest body, string authorization, string xCircleAppkey)
  2780. lockUser
  2781. Lock the member requesting this action.
  2782. ### Example
  2783. ```csharp
  2784. using System;
  2785. using System.Diagnostics;
  2786. using CircleSDK.Api;
  2787. using CircleSDK.Client;
  2788. using CircleSDK.Model;
  2789. namespace Example
  2790. {
  2791. public class LockUserExample
  2792. {
  2793. public void main()
  2794. {
  2795. var apiInstance = new CircleApi();
  2796. var body = new LockUserRequest(); // LockUserRequest |
  2797. var authorization = authorization_example; // string | Authorization Bearer
  2798. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2799. try
  2800. {
  2801. // lockUser
  2802. LockUserReply result = apiInstance.LockUser(body, authorization, xCircleAppkey);
  2803. Debug.WriteLine(result);
  2804. }
  2805. catch (Exception e)
  2806. {
  2807. Debug.Print("Exception when calling CircleApi.LockUser: " + e.Message );
  2808. }
  2809. }
  2810. }
  2811. }
  2812. ```
  2813. ### Parameters
  2814. Name | Type | Description | Notes
  2815. ------------- | ------------- | ------------- | -------------
  2816. **body** | [**LockUserRequest**](LockUserRequest.md)| |
  2817. **authorization** | **string**| Authorization Bearer |
  2818. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2819. ### Return type
  2820. [**LockUserReply**](LockUserReply.md)
  2821. ### Authorization
  2822. No authorization required
  2823. ### HTTP request headers
  2824. - **Content-Type**: application/json
  2825. - **Accept**: application/json
  2826. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2827. <a name="loginwithcircle"></a>
  2828. # **LoginWithCircle**
  2829. > LoginWithCircleReply LoginWithCircle (LoginWithCircleRequest body, string authorization, string xCircleAppkey)
  2830. LoginWithCircle
  2831. ### Example
  2832. ```csharp
  2833. using System;
  2834. using System.Diagnostics;
  2835. using CircleSDK.Api;
  2836. using CircleSDK.Client;
  2837. using CircleSDK.Model;
  2838. namespace Example
  2839. {
  2840. public class LoginWithCircleExample
  2841. {
  2842. public void main()
  2843. {
  2844. var apiInstance = new CircleApi();
  2845. var body = new LoginWithCircleRequest(); // LoginWithCircleRequest |
  2846. var authorization = authorization_example; // string | Authorization Bearer
  2847. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2848. try
  2849. {
  2850. // LoginWithCircle
  2851. LoginWithCircleReply result = apiInstance.LoginWithCircle(body, authorization, xCircleAppkey);
  2852. Debug.WriteLine(result);
  2853. }
  2854. catch (Exception e)
  2855. {
  2856. Debug.Print("Exception when calling CircleApi.LoginWithCircle: " + e.Message );
  2857. }
  2858. }
  2859. }
  2860. }
  2861. ```
  2862. ### Parameters
  2863. Name | Type | Description | Notes
  2864. ------------- | ------------- | ------------- | -------------
  2865. **body** | [**LoginWithCircleRequest**](LoginWithCircleRequest.md)| |
  2866. **authorization** | **string**| Authorization Bearer |
  2867. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2868. ### Return type
  2869. [**LoginWithCircleReply**](LoginWithCircleReply.md)
  2870. ### Authorization
  2871. No authorization required
  2872. ### HTTP request headers
  2873. - **Content-Type**: application/json
  2874. - **Accept**: application/json
  2875. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2876. <a name="logintoservice"></a>
  2877. # **LogintoService**
  2878. > LogintoServiceReply LogintoService (LogintoServiceRequest body = null, string authorization = null, string xCircleAppkey = null)
  2879. logintoService
  2880. ### Example
  2881. ```csharp
  2882. using System;
  2883. using System.Diagnostics;
  2884. using CircleSDK.Api;
  2885. using CircleSDK.Client;
  2886. using CircleSDK.Model;
  2887. namespace Example
  2888. {
  2889. public class LogintoServiceExample
  2890. {
  2891. public void main()
  2892. {
  2893. var apiInstance = new CircleApi();
  2894. var body = new LogintoServiceRequest(); // LogintoServiceRequest | (optional)
  2895. var authorization = authorization_example; // string | Authorization Bearer (optional)
  2896. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey` (optional)
  2897. try
  2898. {
  2899. // logintoService
  2900. LogintoServiceReply result = apiInstance.LogintoService(body, authorization, xCircleAppkey);
  2901. Debug.WriteLine(result);
  2902. }
  2903. catch (Exception e)
  2904. {
  2905. Debug.Print("Exception when calling CircleApi.LogintoService: " + e.Message );
  2906. }
  2907. }
  2908. }
  2909. }
  2910. ```
  2911. ### Parameters
  2912. Name | Type | Description | Notes
  2913. ------------- | ------------- | ------------- | -------------
  2914. **body** | [**LogintoServiceRequest**](LogintoServiceRequest.md)| | [optional]
  2915. **authorization** | **string**| Authorization Bearer | [optional]
  2916. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; | [optional]
  2917. ### Return type
  2918. [**LogintoServiceReply**](LogintoServiceReply.md)
  2919. ### Authorization
  2920. No authorization required
  2921. ### HTTP request headers
  2922. - **Content-Type**: application/json
  2923. - **Accept**: application/json
  2924. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2925. <a name="processinvite"></a>
  2926. # **ProcessInvite**
  2927. > ProcessInviteReply ProcessInvite (ProcessInviteRequest body, string authorization, string xCircleAppkey)
  2928. processInvite
  2929. Offer an Invite to a device.  Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
  2930. ### Example
  2931. ```csharp
  2932. using System;
  2933. using System.Diagnostics;
  2934. using CircleSDK.Api;
  2935. using CircleSDK.Client;
  2936. using CircleSDK.Model;
  2937. namespace Example
  2938. {
  2939. public class ProcessInviteExample
  2940. {
  2941. public void main()
  2942. {
  2943. var apiInstance = new CircleApi();
  2944. var body = new ProcessInviteRequest(); // ProcessInviteRequest |
  2945. var authorization = authorization_example; // string | Authorization Bearer
  2946. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2947. try
  2948. {
  2949. // processInvite
  2950. ProcessInviteReply result = apiInstance.ProcessInvite(body, authorization, xCircleAppkey);
  2951. Debug.WriteLine(result);
  2952. }
  2953. catch (Exception e)
  2954. {
  2955. Debug.Print("Exception when calling CircleApi.ProcessInvite: " + e.Message );
  2956. }
  2957. }
  2958. }
  2959. }
  2960. ```
  2961. ### Parameters
  2962. Name | Type | Description | Notes
  2963. ------------- | ------------- | ------------- | -------------
  2964. **body** | [**ProcessInviteRequest**](ProcessInviteRequest.md)| |
  2965. **authorization** | **string**| Authorization Bearer |
  2966. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  2967. ### Return type
  2968. [**ProcessInviteReply**](ProcessInviteReply.md)
  2969. ### Authorization
  2970. No authorization required
  2971. ### HTTP request headers
  2972. - **Content-Type**: application/json
  2973. - **Accept**: application/json
  2974. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  2975. <a name="removemember"></a>
  2976. # **RemoveMember**
  2977. > RemoveMemberReply RemoveMember (RemoveMemberRequest body, string authorization, string xCircleAppkey)
  2978. removeMember
  2979. Removes a member from a Circle. Can be used to remove yourself.
  2980. ### Example
  2981. ```csharp
  2982. using System;
  2983. using System.Diagnostics;
  2984. using CircleSDK.Api;
  2985. using CircleSDK.Client;
  2986. using CircleSDK.Model;
  2987. namespace Example
  2988. {
  2989. public class RemoveMemberExample
  2990. {
  2991. public void main()
  2992. {
  2993. var apiInstance = new CircleApi();
  2994. var body = new RemoveMemberRequest(); // RemoveMemberRequest |
  2995. var authorization = authorization_example; // string | Authorization Bearer
  2996. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  2997. try
  2998. {
  2999. // removeMember
  3000. RemoveMemberReply result = apiInstance.RemoveMember(body, authorization, xCircleAppkey);
  3001. Debug.WriteLine(result);
  3002. }
  3003. catch (Exception e)
  3004. {
  3005. Debug.Print("Exception when calling CircleApi.RemoveMember: " + e.Message );
  3006. }
  3007. }
  3008. }
  3009. }
  3010. ```
  3011. ### Parameters
  3012. Name | Type | Description | Notes
  3013. ------------- | ------------- | ------------- | -------------
  3014. **body** | [**RemoveMemberRequest**](RemoveMemberRequest.md)| |
  3015. **authorization** | **string**| Authorization Bearer |
  3016. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3017. ### Return type
  3018. [**RemoveMemberReply**](RemoveMemberReply.md)
  3019. ### Authorization
  3020. No authorization required
  3021. ### HTTP request headers
  3022. - **Content-Type**: application/json
  3023. - **Accept**: application/json
  3024. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3025. <a name="removememberfromtopic"></a>
  3026. # **RemoveMemberFromTopic**
  3027. > RemoveMemberFromTopicReply RemoveMemberFromTopic (RemoveMemberFromTopicRequest body, string authorization, string xCircleAppkey)
  3028. removeMemberFromTopic
  3029. Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
  3030. =======
  3031. <a name="removememberfromtopic"></a>
  3032. # **RemoveMemberFromTopic**
  3033. > RemoveMemberFromTopicReply RemoveMemberFromTopic (RemoveMemberFromTopicRequest body, string xCircleAppkey)
  3034. removeMemberFromTopic
  3035. >>>>>>> Stashed changes
  3036. ### Example
  3037. ```csharp
  3038. using System;
  3039. using System.Diagnostics;
  3040. <<<<<<< Updated upstream
  3041. using CircleSDK.Api;
  3042. using CircleSDK.Client;
  3043. using CircleSDK.Model;
  3044. =======
  3045. using IO.Swagger.Api;
  3046. using IO.Swagger.Client;
  3047. using IO.Swagger.Model;
  3048. >>>>>>> Stashed changes
  3049. namespace Example
  3050. {
  3051. public class RemoveMemberFromTopicExample
  3052. {
  3053. public void main()
  3054. {
  3055. var apiInstance = new CircleApi();
  3056. var body = new RemoveMemberFromTopicRequest(); // RemoveMemberFromTopicRequest |
  3057. <<<<<<< Updated upstream
  3058. var authorization = authorization_example; // string | Authorization Bearer
  3059. =======
  3060. >>>>>>> Stashed changes
  3061. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3062. try
  3063. {
  3064. // removeMemberFromTopic
  3065. <<<<<<< Updated upstream
  3066. RemoveMemberFromTopicReply result = apiInstance.RemoveMemberFromTopic(body, authorization, xCircleAppkey);
  3067. =======
  3068. RemoveMemberFromTopicReply result = apiInstance.RemoveMemberFromTopic(body, xCircleAppkey);
  3069. >>>>>>> Stashed changes
  3070. Debug.WriteLine(result);
  3071. }
  3072. catch (Exception e)
  3073. {
  3074. Debug.Print("Exception when calling CircleApi.RemoveMemberFromTopic: " + e.Message );
  3075. }
  3076. }
  3077. }
  3078. }
  3079. ```
  3080. ### Parameters
  3081. Name | Type | Description | Notes
  3082. ------------- | ------------- | ------------- | -------------
  3083. **body** | [**RemoveMemberFromTopicRequest**](RemoveMemberFromTopicRequest.md)| |
  3084. <<<<<<< Updated upstream
  3085. **authorization** | **string**| Authorization Bearer |
  3086. =======
  3087. >>>>>>> Stashed changes
  3088. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3089. ### Return type
  3090. [**RemoveMemberFromTopicReply**](RemoveMemberFromTopicReply.md)
  3091. ### Authorization
  3092. No authorization required
  3093. ### HTTP request headers
  3094. - **Content-Type**: application/json
  3095. - **Accept**: application/json
  3096. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3097. <a name="renamefile"></a>
  3098. # **RenameFile**
  3099. <<<<<<< Updated upstream
  3100. > RenameFileReply RenameFile (RenameFileRequest body, string authorization, string xCircleAppkey)
  3101. renameFile
  3102. Renames the desired file.
  3103. =======
  3104. > RenameFileReply RenameFile (RenameFileRequest body, string xCircleAppkey)
  3105. renameFile
  3106. >>>>>>> Stashed changes
  3107. ### Example
  3108. ```csharp
  3109. using System;
  3110. using System.Diagnostics;
  3111. <<<<<<< Updated upstream
  3112. using CircleSDK.Api;
  3113. using CircleSDK.Client;
  3114. using CircleSDK.Model;
  3115. =======
  3116. using IO.Swagger.Api;
  3117. using IO.Swagger.Client;
  3118. using IO.Swagger.Model;
  3119. >>>>>>> Stashed changes
  3120. namespace Example
  3121. {
  3122. public class RenameFileExample
  3123. {
  3124. public void main()
  3125. {
  3126. var apiInstance = new CircleApi();
  3127. var body = new RenameFileRequest(); // RenameFileRequest |
  3128. <<<<<<< Updated upstream
  3129. var authorization = authorization_example; // string | Authorization Bearer
  3130. =======
  3131. >>>>>>> Stashed changes
  3132. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3133. try
  3134. {
  3135. // renameFile
  3136. <<<<<<< Updated upstream
  3137. RenameFileReply result = apiInstance.RenameFile(body, authorization, xCircleAppkey);
  3138. =======
  3139. RenameFileReply result = apiInstance.RenameFile(body, xCircleAppkey);
  3140. >>>>>>> Stashed changes
  3141. Debug.WriteLine(result);
  3142. }
  3143. catch (Exception e)
  3144. {
  3145. Debug.Print("Exception when calling CircleApi.RenameFile: " + e.Message );
  3146. }
  3147. }
  3148. }
  3149. }
  3150. ```
  3151. ### Parameters
  3152. Name | Type | Description | Notes
  3153. ------------- | ------------- | ------------- | -------------
  3154. **body** | [**RenameFileRequest**](RenameFileRequest.md)| |
  3155. <<<<<<< Updated upstream
  3156. **authorization** | **string**| Authorization Bearer |
  3157. =======
  3158. >>>>>>> Stashed changes
  3159. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3160. ### Return type
  3161. [**RenameFileReply**](RenameFileReply.md)
  3162. ### Authorization
  3163. No authorization required
  3164. ### HTTP request headers
  3165. - **Content-Type**: application/json
  3166. - **Accept**: application/json
  3167. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3168. <a name="revokedevice"></a>
  3169. # **RevokeDevice**
  3170. <<<<<<< Updated upstream
  3171. > RevokeDeviceReply RevokeDevice (RevokeDeviceRequest body, string authorization, string xCircleAppkey)
  3172. revokeDevice
  3173. Removes and wipes a device from the intended Circle.
  3174. =======
  3175. > RevokeDeviceReply RevokeDevice (RevokeDeviceRequest body, string xCircleAppkey)
  3176. revokeDevice
  3177. >>>>>>> Stashed changes
  3178. ### Example
  3179. ```csharp
  3180. using System;
  3181. using System.Diagnostics;
  3182. <<<<<<< Updated upstream
  3183. using CircleSDK.Api;
  3184. using CircleSDK.Client;
  3185. using CircleSDK.Model;
  3186. =======
  3187. using IO.Swagger.Api;
  3188. using IO.Swagger.Client;
  3189. using IO.Swagger.Model;
  3190. >>>>>>> Stashed changes
  3191. namespace Example
  3192. {
  3193. public class RevokeDeviceExample
  3194. {
  3195. public void main()
  3196. {
  3197. var apiInstance = new CircleApi();
  3198. var body = new RevokeDeviceRequest(); // RevokeDeviceRequest |
  3199. <<<<<<< Updated upstream
  3200. var authorization = authorization_example; // string | Authorization Bearer
  3201. =======
  3202. >>>>>>> Stashed changes
  3203. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3204. try
  3205. {
  3206. // revokeDevice
  3207. <<<<<<< Updated upstream
  3208. RevokeDeviceReply result = apiInstance.RevokeDevice(body, authorization, xCircleAppkey);
  3209. =======
  3210. RevokeDeviceReply result = apiInstance.RevokeDevice(body, xCircleAppkey);
  3211. >>>>>>> Stashed changes
  3212. Debug.WriteLine(result);
  3213. }
  3214. catch (Exception e)
  3215. {
  3216. Debug.Print("Exception when calling CircleApi.RevokeDevice: " + e.Message );
  3217. }
  3218. }
  3219. }
  3220. }
  3221. ```
  3222. ### Parameters
  3223. Name | Type | Description | Notes
  3224. ------------- | ------------- | ------------- | -------------
  3225. **body** | [**RevokeDeviceRequest**](RevokeDeviceRequest.md)| |
  3226. <<<<<<< Updated upstream
  3227. **authorization** | **string**| Authorization Bearer |
  3228. =======
  3229. >>>>>>> Stashed changes
  3230. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3231. ### Return type
  3232. [**RevokeDeviceReply**](RevokeDeviceReply.md)
  3233. ### Authorization
  3234. No authorization required
  3235. ### HTTP request headers
  3236. - **Content-Type**: application/json
  3237. - **Accept**: application/json
  3238. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3239. <a name="revokeinvite"></a>
  3240. # **RevokeInvite**
  3241. <<<<<<< Updated upstream
  3242. > RevokeInviteReply RevokeInvite (RevokeInviteRequest body, string authorization, string xCircleAppkey)
  3243. revokeInvite
  3244. Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
  3245. =======
  3246. > RevokeInviteReply RevokeInvite (RevokeInviteRequest body, string xCircleAppkey)
  3247. revokeInvite
  3248. >>>>>>> Stashed changes
  3249. ### Example
  3250. ```csharp
  3251. using System;
  3252. using System.Diagnostics;
  3253. <<<<<<< Updated upstream
  3254. using CircleSDK.Api;
  3255. using CircleSDK.Client;
  3256. using CircleSDK.Model;
  3257. =======
  3258. using IO.Swagger.Api;
  3259. using IO.Swagger.Client;
  3260. using IO.Swagger.Model;
  3261. >>>>>>> Stashed changes
  3262. namespace Example
  3263. {
  3264. public class RevokeInviteExample
  3265. {
  3266. public void main()
  3267. {
  3268. var apiInstance = new CircleApi();
  3269. var body = new RevokeInviteRequest(); // RevokeInviteRequest |
  3270. <<<<<<< Updated upstream
  3271. var authorization = authorization_example; // string | Authorization Bearer
  3272. =======
  3273. >>>>>>> Stashed changes
  3274. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3275. try
  3276. {
  3277. // revokeInvite
  3278. <<<<<<< Updated upstream
  3279. RevokeInviteReply result = apiInstance.RevokeInvite(body, authorization, xCircleAppkey);
  3280. =======
  3281. RevokeInviteReply result = apiInstance.RevokeInvite(body, xCircleAppkey);
  3282. >>>>>>> Stashed changes
  3283. Debug.WriteLine(result);
  3284. }
  3285. catch (Exception e)
  3286. {
  3287. Debug.Print("Exception when calling CircleApi.RevokeInvite: " + e.Message );
  3288. }
  3289. }
  3290. }
  3291. }
  3292. ```
  3293. ### Parameters
  3294. Name | Type | Description | Notes
  3295. ------------- | ------------- | ------------- | -------------
  3296. **body** | [**RevokeInviteRequest**](RevokeInviteRequest.md)| |
  3297. <<<<<<< Updated upstream
  3298. **authorization** | **string**| Authorization Bearer |
  3299. =======
  3300. >>>>>>> Stashed changes
  3301. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3302. ### Return type
  3303. [**RevokeInviteReply**](RevokeInviteReply.md)
  3304. ### Authorization
  3305. No authorization required
  3306. ### HTTP request headers
  3307. - **Content-Type**: application/json
  3308. - **Accept**: application/json
  3309. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3310. <<<<<<< Updated upstream
  3311. <a name="securecontents"></a>
  3312. # **SecureContents**
  3313. > SecureContentsReply SecureContents (SecureContentsRequest body, string authorization, string xCircleAppkey)
  3314. SecureContents
  3315. ### Example
  3316. ```csharp
  3317. using System;
  3318. using System.Diagnostics;
  3319. using CircleSDK.Api;
  3320. using CircleSDK.Client;
  3321. using CircleSDK.Model;
  3322. namespace Example
  3323. {
  3324. public class SecureContentsExample
  3325. {
  3326. public void main()
  3327. {
  3328. var apiInstance = new CircleApi();
  3329. var body = new SecureContentsRequest(); // SecureContentsRequest |
  3330. var authorization = authorization_example; // string | Authorization Bearer
  3331. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3332. try
  3333. {
  3334. // SecureContents
  3335. SecureContentsReply result = apiInstance.SecureContents(body, authorization, xCircleAppkey);
  3336. Debug.WriteLine(result);
  3337. }
  3338. catch (Exception e)
  3339. {
  3340. Debug.Print("Exception when calling CircleApi.SecureContents: " + e.Message );
  3341. }
  3342. }
  3343. }
  3344. }
  3345. ```
  3346. ### Parameters
  3347. Name | Type | Description | Notes
  3348. ------------- | ------------- | ------------- | -------------
  3349. **body** | [**SecureContentsRequest**](SecureContentsRequest.md)| |
  3350. **authorization** | **string**| Authorization Bearer |
  3351. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3352. ### Return type
  3353. [**SecureContentsReply**](SecureContentsReply.md)
  3354. ### Authorization
  3355. No authorization required
  3356. ### HTTP request headers
  3357. - **Content-Type**: application/json
  3358. - **Accept**: application/json
  3359. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3360. <a name="securefile"></a>
  3361. # **SecureFile**
  3362. > SecureFileReply SecureFile (SecureFileRequest body, string authorization, string xCircleAppkey)
  3363. SecureFile
  3364. ### Example
  3365. ```csharp
  3366. using System;
  3367. using System.Diagnostics;
  3368. using CircleSDK.Api;
  3369. using CircleSDK.Client;
  3370. using CircleSDK.Model;
  3371. namespace Example
  3372. {
  3373. public class SecureFileExample
  3374. {
  3375. public void main()
  3376. {
  3377. var apiInstance = new CircleApi();
  3378. var body = new SecureFileRequest(); // SecureFileRequest |
  3379. var authorization = authorization_example; // string | Authorization Bearer
  3380. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3381. try
  3382. {
  3383. // SecureFile
  3384. SecureFileReply result = apiInstance.SecureFile(body, authorization, xCircleAppkey);
  3385. Debug.WriteLine(result);
  3386. }
  3387. catch (Exception e)
  3388. {
  3389. Debug.Print("Exception when calling CircleApi.SecureFile: " + e.Message );
  3390. }
  3391. }
  3392. }
  3393. }
  3394. ```
  3395. ### Parameters
  3396. Name | Type | Description | Notes
  3397. ------------- | ------------- | ------------- | -------------
  3398. **body** | [**SecureFileRequest**](SecureFileRequest.md)| |
  3399. **authorization** | **string**| Authorization Bearer |
  3400. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3401. ### Return type
  3402. [**SecureFileReply**](SecureFileReply.md)
  3403. ### Authorization
  3404. No authorization required
  3405. ### HTTP request headers
  3406. - **Content-Type**: application/json
  3407. - **Accept**: application/json
  3408. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3409. <a name="servicestatus"></a>
  3410. # **ServiceStatus**
  3411. > ServiceStatusReply ServiceStatus (ServiceStatusRequest body)
  3412. serviceStatus
  3413. ### Example
  3414. ```csharp
  3415. using System;
  3416. using System.Diagnostics;
  3417. using CircleSDK.Api;
  3418. using CircleSDK.Client;
  3419. using CircleSDK.Model;
  3420. namespace Example
  3421. {
  3422. public class ServiceStatusExample
  3423. {
  3424. public void main()
  3425. {
  3426. var apiInstance = new CircleApi();
  3427. var body = new ServiceStatusRequest(); // ServiceStatusRequest |
  3428. try
  3429. {
  3430. // serviceStatus
  3431. ServiceStatusReply result = apiInstance.ServiceStatus(body);
  3432. Debug.WriteLine(result);
  3433. }
  3434. catch (Exception e)
  3435. {
  3436. Debug.Print("Exception when calling CircleApi.ServiceStatus: " + e.Message );
  3437. }
  3438. }
  3439. }
  3440. }
  3441. ```
  3442. ### Parameters
  3443. Name | Type | Description | Notes
  3444. ------------- | ------------- | ------------- | -------------
  3445. **body** | [**ServiceStatusRequest**](ServiceStatusRequest.md)| |
  3446. ### Return type
  3447. [**ServiceStatusReply**](ServiceStatusReply.md)
  3448. ### Authorization
  3449. No authorization required
  3450. ### HTTP request headers
  3451. - **Content-Type**: application/json
  3452. - **Accept**: application/json
  3453. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3454. <a name="setuserid"></a>
  3455. # **SetUserId**
  3456. > SetUserIdReply SetUserId (SetUserIdRequest body, string authorization, string xCircleAppkey)
  3457. SetUserId
  3458. ### Example
  3459. ```csharp
  3460. using System;
  3461. using System.Diagnostics;
  3462. using CircleSDK.Api;
  3463. using CircleSDK.Client;
  3464. using CircleSDK.Model;
  3465. namespace Example
  3466. {
  3467. public class SetUserIdExample
  3468. {
  3469. public void main()
  3470. {
  3471. var apiInstance = new CircleApi();
  3472. var body = new SetUserIdRequest(); // SetUserIdRequest |
  3473. var authorization = authorization_example; // string | Authorization Bearer
  3474. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3475. try
  3476. {
  3477. // SetUserId
  3478. SetUserIdReply result = apiInstance.SetUserId(body, authorization, xCircleAppkey);
  3479. Debug.WriteLine(result);
  3480. }
  3481. catch (Exception e)
  3482. {
  3483. Debug.Print("Exception when calling CircleApi.SetUserId: " + e.Message );
  3484. }
  3485. }
  3486. }
  3487. }
  3488. ```
  3489. ### Parameters
  3490. Name | Type | Description | Notes
  3491. ------------- | ------------- | ------------- | -------------
  3492. **body** | [**SetUserIdRequest**](SetUserIdRequest.md)| |
  3493. **authorization** | **string**| Authorization Bearer |
  3494. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3495. ### Return type
  3496. [**SetUserIdReply**](SetUserIdReply.md)
  3497. ### Authorization
  3498. No authorization required
  3499. ### HTTP request headers
  3500. - **Content-Type**: application/json
  3501. - **Accept**: application/json
  3502. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3503. <a name="signdatawithcirclekey"></a>
  3504. # **SignDataWithCircleKey**
  3505. > SignDataWithCircleKeyReply SignDataWithCircleKey (SignDataWithCircleKeyRequest body, string authorization, string xCircleAppkey)
  3506. SignDataWithCircleKey
  3507. ### Example
  3508. ```csharp
  3509. using System;
  3510. using System.Diagnostics;
  3511. using CircleSDK.Api;
  3512. using CircleSDK.Client;
  3513. using CircleSDK.Model;
  3514. namespace Example
  3515. {
  3516. public class SignDataWithCircleKeyExample
  3517. {
  3518. public void main()
  3519. {
  3520. var apiInstance = new CircleApi();
  3521. var body = new SignDataWithCircleKeyRequest(); // SignDataWithCircleKeyRequest |
  3522. var authorization = authorization_example; // string | Authorization Bearer
  3523. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3524. try
  3525. {
  3526. // SignDataWithCircleKey
  3527. SignDataWithCircleKeyReply result = apiInstance.SignDataWithCircleKey(body, authorization, xCircleAppkey);
  3528. Debug.WriteLine(result);
  3529. }
  3530. catch (Exception e)
  3531. {
  3532. Debug.Print("Exception when calling CircleApi.SignDataWithCircleKey: " + e.Message );
  3533. }
  3534. }
  3535. }
  3536. }
  3537. ```
  3538. ### Parameters
  3539. Name | Type | Description | Notes
  3540. ------------- | ------------- | ------------- | -------------
  3541. **body** | [**SignDataWithCircleKeyRequest**](SignDataWithCircleKeyRequest.md)| |
  3542. **authorization** | **string**| Authorization Bearer |
  3543. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3544. ### Return type
  3545. [**SignDataWithCircleKeyReply**](SignDataWithCircleKeyReply.md)
  3546. ### Authorization
  3547. No authorization required
  3548. ### HTTP request headers
  3549. - **Content-Type**: application/json
  3550. - **Accept**: application/json
  3551. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3552. <a name="signdatawithuserkey"></a>
  3553. # **SignDataWithUserKey**
  3554. > SignDataWithUserKeyReply SignDataWithUserKey (SignDataWithUserKeyRequest body, string authorization, string xCircleAppkey)
  3555. SignDataWithUserKey
  3556. ### Example
  3557. ```csharp
  3558. using System;
  3559. using System.Diagnostics;
  3560. using CircleSDK.Api;
  3561. using CircleSDK.Client;
  3562. using CircleSDK.Model;
  3563. namespace Example
  3564. {
  3565. public class SignDataWithUserKeyExample
  3566. {
  3567. public void main()
  3568. {
  3569. var apiInstance = new CircleApi();
  3570. var body = new SignDataWithUserKeyRequest(); // SignDataWithUserKeyRequest |
  3571. var authorization = authorization_example; // string | Authorization Bearer
  3572. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3573. try
  3574. {
  3575. // SignDataWithUserKey
  3576. SignDataWithUserKeyReply result = apiInstance.SignDataWithUserKey(body, authorization, xCircleAppkey);
  3577. Debug.WriteLine(result);
  3578. }
  3579. catch (Exception e)
  3580. {
  3581. Debug.Print("Exception when calling CircleApi.SignDataWithUserKey: " + e.Message );
  3582. }
  3583. }
  3584. }
  3585. }
  3586. ```
  3587. ### Parameters
  3588. Name | Type | Description | Notes
  3589. ------------- | ------------- | ------------- | -------------
  3590. **body** | [**SignDataWithUserKeyRequest**](SignDataWithUserKeyRequest.md)| |
  3591. **authorization** | **string**| Authorization Bearer |
  3592. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3593. ### Return type
  3594. [**SignDataWithUserKeyReply**](SignDataWithUserKeyReply.md)
  3595. ### Authorization
  3596. No authorization required
  3597. ### HTTP request headers
  3598. - **Content-Type**: application/json
  3599. - **Accept**: application/json
  3600. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3601. <a name="storetoken"></a>
  3602. # **StoreToken**
  3603. > StoreTokenReply StoreToken (StoreTokenRequest body = null, string authorization = null, string xCircleAppkey = null)
  3604. storeToken
  3605. ### Example
  3606. ```csharp
  3607. using System;
  3608. using System.Diagnostics;
  3609. using CircleSDK.Api;
  3610. using CircleSDK.Client;
  3611. using CircleSDK.Model;
  3612. namespace Example
  3613. {
  3614. public class StoreTokenExample
  3615. {
  3616. public void main()
  3617. {
  3618. var apiInstance = new CircleApi();
  3619. var body = new StoreTokenRequest(); // StoreTokenRequest | (optional)
  3620. var authorization = authorization_example; // string | Authorization Bearer (optional)
  3621. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey` (optional)
  3622. try
  3623. {
  3624. // storeToken
  3625. StoreTokenReply result = apiInstance.StoreToken(body, authorization, xCircleAppkey);
  3626. Debug.WriteLine(result);
  3627. }
  3628. catch (Exception e)
  3629. {
  3630. Debug.Print("Exception when calling CircleApi.StoreToken: " + e.Message );
  3631. }
  3632. }
  3633. }
  3634. }
  3635. ```
  3636. ### Parameters
  3637. Name | Type | Description | Notes
  3638. ------------- | ------------- | ------------- | -------------
  3639. **body** | [**StoreTokenRequest**](StoreTokenRequest.md)| | [optional]
  3640. **authorization** | **string**| Authorization Bearer | [optional]
  3641. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; | [optional]
  3642. ### Return type
  3643. [**StoreTokenReply**](StoreTokenReply.md)
  3644. ### Authorization
  3645. No authorization required
  3646. ### HTTP request headers
  3647. - **Content-Type**: application/json
  3648. - **Accept**: application/json
  3649. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3650. <a name="unlockuser"></a>
  3651. # **UnlockUser**
  3652. > UnlockUserReply UnlockUser (UnlockUserRequest body, string authorization, string xCircleAppkey)
  3653. unlockUser
  3654. Unlock the member requesting this action.
  3655. ### Example
  3656. ```csharp
  3657. using System;
  3658. using System.Diagnostics;
  3659. using CircleSDK.Api;
  3660. using CircleSDK.Client;
  3661. using CircleSDK.Model;
  3662. namespace Example
  3663. {
  3664. public class UnlockUserExample
  3665. {
  3666. public void main()
  3667. {
  3668. var apiInstance = new CircleApi();
  3669. var body = new UnlockUserRequest(); // UnlockUserRequest |
  3670. var authorization = authorization_example; // string | Authorization Bearer
  3671. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3672. try
  3673. {
  3674. // unlockUser
  3675. UnlockUserReply result = apiInstance.UnlockUser(body, authorization, xCircleAppkey);
  3676. Debug.WriteLine(result);
  3677. }
  3678. catch (Exception e)
  3679. {
  3680. Debug.Print("Exception when calling CircleApi.UnlockUser: " + e.Message );
  3681. }
  3682. }
  3683. }
  3684. }
  3685. ```
  3686. ### Parameters
  3687. Name | Type | Description | Notes
  3688. ------------- | ------------- | ------------- | -------------
  3689. **body** | [**UnlockUserRequest**](UnlockUserRequest.md)| |
  3690. **authorization** | **string**| Authorization Bearer |
  3691. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3692. ### Return type
  3693. [**UnlockUserReply**](UnlockUserReply.md)
  3694. ### Authorization
  3695. No authorization required
  3696. ### HTTP request headers
  3697. - **Content-Type**: application/json
  3698. - **Accept**: application/json
  3699. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3700. <a name="updatetopic"></a>
  3701. # **UpdateTopic**
  3702. > UpdateTopicReply UpdateTopic (UpdateTopicRequest body, string authorization, string xCircleAppkey)
  3703. updateTopic
  3704. Updates the name and description of an existing topic.
  3705. ### Example
  3706. ```csharp
  3707. using System;
  3708. using System.Diagnostics;
  3709. using CircleSDK.Api;
  3710. using CircleSDK.Client;
  3711. using CircleSDK.Model;
  3712. namespace Example
  3713. {
  3714. public class UpdateTopicExample
  3715. {
  3716. public void main()
  3717. {
  3718. var apiInstance = new CircleApi();
  3719. var body = new UpdateTopicRequest(); // UpdateTopicRequest |
  3720. var authorization = authorization_example; // string | Authorization Bearer
  3721. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3722. try
  3723. {
  3724. // updateTopic
  3725. UpdateTopicReply result = apiInstance.UpdateTopic(body, authorization, xCircleAppkey);
  3726. Debug.WriteLine(result);
  3727. }
  3728. catch (Exception e)
  3729. {
  3730. Debug.Print("Exception when calling CircleApi.UpdateTopic: " + e.Message );
  3731. }
  3732. }
  3733. }
  3734. }
  3735. ```
  3736. ### Parameters
  3737. Name | Type | Description | Notes
  3738. ------------- | ------------- | ------------- | -------------
  3739. **body** | [**UpdateTopicRequest**](UpdateTopicRequest.md)| |
  3740. **authorization** | **string**| Authorization Bearer |
  3741. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3742. ### Return type
  3743. [**UpdateTopicReply**](UpdateTopicReply.md)
  3744. ### Authorization
  3745. No authorization required
  3746. ### HTTP request headers
  3747. - **Content-Type**: application/json
  3748. - **Accept**: application/json
  3749. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3750. <a name="uploadfile"></a>
  3751. # **UploadFile**
  3752. > UploadFileReply UploadFile (UploadFileRequest body, string authorization, string xCircleAppkey)
  3753. uploadFile
  3754. Upload a file with content. This method is available in the CircleService and not needed in CoreL2
  3755. ### Example
  3756. ```csharp
  3757. using System;
  3758. using System.Diagnostics;
  3759. using CircleSDK.Api;
  3760. using CircleSDK.Client;
  3761. using CircleSDK.Model;
  3762. namespace Example
  3763. {
  3764. public class UploadFileExample
  3765. {
  3766. public void main()
  3767. {
  3768. var apiInstance = new CircleApi();
  3769. var body = new UploadFileRequest(); // UploadFileRequest |
  3770. var authorization = authorization_example; // string | Authorization Bearer
  3771. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3772. try
  3773. {
  3774. // uploadFile
  3775. UploadFileReply result = apiInstance.UploadFile(body, authorization, xCircleAppkey);
  3776. Debug.WriteLine(result);
  3777. }
  3778. catch (Exception e)
  3779. {
  3780. Debug.Print("Exception when calling CircleApi.UploadFile: " + e.Message );
  3781. }
  3782. }
  3783. }
  3784. }
  3785. ```
  3786. ### Parameters
  3787. Name | Type | Description | Notes
  3788. ------------- | ------------- | ------------- | -------------
  3789. **body** | [**UploadFileRequest**](UploadFileRequest.md)| |
  3790. **authorization** | **string**| Authorization Bearer |
  3791. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3792. ### Return type
  3793. [**UploadFileReply**](UploadFileReply.md)
  3794. ### Authorization
  3795. No authorization required
  3796. ### HTTP request headers
  3797. - **Content-Type**: application/json
  3798. - **Accept**: application/json
  3799. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  3800. <a name="whoami"></a>
  3801. # **WhoAmI**
  3802. > WhoAmIReply WhoAmI (WhoAmIRequest body, string authorization, string xCircleAppkey)
  3803. whoAmI
  3804. Provides the member ID and the list of the member’s joined devices.
  3805. =======
  3806. <a name="whoami"></a>
  3807. # **WhoAmI**
  3808. > WhoAmIReply WhoAmI (WhoAmIRequest body, string xCircleAppkey)
  3809. whoAmI
  3810. >>>>>>> Stashed changes
  3811. ### Example
  3812. ```csharp
  3813. using System;
  3814. using System.Diagnostics;
  3815. <<<<<<< Updated upstream
  3816. using CircleSDK.Api;
  3817. using CircleSDK.Client;
  3818. using CircleSDK.Model;
  3819. =======
  3820. using IO.Swagger.Api;
  3821. using IO.Swagger.Client;
  3822. using IO.Swagger.Model;
  3823. >>>>>>> Stashed changes
  3824. namespace Example
  3825. {
  3826. public class WhoAmIExample
  3827. {
  3828. public void main()
  3829. {
  3830. var apiInstance = new CircleApi();
  3831. var body = new WhoAmIRequest(); // WhoAmIRequest |
  3832. <<<<<<< Updated upstream
  3833. var authorization = authorization_example; // string | Authorization Bearer
  3834. =======
  3835. >>>>>>> Stashed changes
  3836. var xCircleAppkey = xCircleAppkey_example; // string | Application `appKey`
  3837. try
  3838. {
  3839. // whoAmI
  3840. <<<<<<< Updated upstream
  3841. WhoAmIReply result = apiInstance.WhoAmI(body, authorization, xCircleAppkey);
  3842. =======
  3843. WhoAmIReply result = apiInstance.WhoAmI(body, xCircleAppkey);
  3844. >>>>>>> Stashed changes
  3845. Debug.WriteLine(result);
  3846. }
  3847. catch (Exception e)
  3848. {
  3849. Debug.Print("Exception when calling CircleApi.WhoAmI: " + e.Message );
  3850. }
  3851. }
  3852. }
  3853. }
  3854. ```
  3855. ### Parameters
  3856. Name | Type | Description | Notes
  3857. ------------- | ------------- | ------------- | -------------
  3858. **body** | [**WhoAmIRequest**](WhoAmIRequest.md)| |
  3859. <<<<<<< Updated upstream
  3860. **authorization** | **string**| Authorization Bearer |
  3861. =======
  3862. >>>>>>> Stashed changes
  3863. **xCircleAppkey** | **string**| Application &#x60;appKey&#x60; |
  3864. ### Return type
  3865. [**WhoAmIReply**](WhoAmIReply.md)
  3866. ### Authorization
  3867. No authorization required
  3868. ### HTTP request headers
  3869. - **Content-Type**: application/json
  3870. - **Accept**: application/json
  3871. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)