yousign_client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (279) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +230 -0
  4. data/Rakefile +8 -0
  5. data/config.json +11 -0
  6. data/docs/AuthenticationEmailOutput.md +10 -0
  7. data/docs/AuthenticationInweboOutput.md +10 -0
  8. data/docs/AuthenticationSmsOutput.md +10 -0
  9. data/docs/AuthenticationsApi.md +320 -0
  10. data/docs/Body.md +8 -0
  11. data/docs/Body1.md +9 -0
  12. data/docs/Body2.md +9 -0
  13. data/docs/CheckDocumentBankAccountsInput.md +13 -0
  14. data/docs/CheckDocumentBankAccountsOutput.md +24 -0
  15. data/docs/CheckDocumentIdentitiesInput.md +11 -0
  16. data/docs/CheckDocumentIdentitiesOutput.md +28 -0
  17. data/docs/CheckDocumentsApi.md +210 -0
  18. data/docs/ConfigEmailTemplate.md +11 -0
  19. data/docs/ConfigWebhookTemplate.md +10 -0
  20. data/docs/ConsentProcessInput.md +14 -0
  21. data/docs/ConsentProcessOutput.md +15 -0
  22. data/docs/ConsentProcessValueInput.md +10 -0
  23. data/docs/ConsentProcessValueOutput.md +12 -0
  24. data/docs/ConsentProcessesApi.md +422 -0
  25. data/docs/FileInput.md +15 -0
  26. data/docs/FileInputMetadata.md +9 -0
  27. data/docs/FileObjectInput.md +21 -0
  28. data/docs/FileObjectInputWithoutFileReference.md +13 -0
  29. data/docs/FileObjectOutput.md +24 -0
  30. data/docs/FileObjectOutputWithoutFileReference.md +17 -0
  31. data/docs/FileObjectsApi.md +220 -0
  32. data/docs/FileOutput.md +19 -0
  33. data/docs/FilesApi.md +218 -0
  34. data/docs/InlineResponse400.md +8 -0
  35. data/docs/InweboUserRequest.md +8 -0
  36. data/docs/MemberInput.md +19 -0
  37. data/docs/MemberOutput.md +24 -0
  38. data/docs/MembersApi.md +272 -0
  39. data/docs/ModeSmsConfiguration.md +8 -0
  40. data/docs/OperationInput.md +14 -0
  41. data/docs/OperationOutput.md +15 -0
  42. data/docs/OperationOutputMetadata.md +9 -0
  43. data/docs/OperationsApi.md +109 -0
  44. data/docs/OrganizationBillingAddress.md +16 -0
  45. data/docs/OrganizationOutput.md +41 -0
  46. data/docs/OrganizationsApi.md +54 -0
  47. data/docs/ProcedureConfig.md +10 -0
  48. data/docs/ProcedureConfigEmail.md +15 -0
  49. data/docs/ProcedureConfigReminder.md +10 -0
  50. data/docs/ProcedureConfigReminderConfig.md +8 -0
  51. data/docs/ProcedureConfigReminderConfigEmail.md +8 -0
  52. data/docs/ProcedureConfigWebhook.md +15 -0
  53. data/docs/ProcedureDuplicateInput.md +9 -0
  54. data/docs/ProcedureInput.md +18 -0
  55. data/docs/ProcedureInputMetadata.md +9 -0
  56. data/docs/ProcedureOutput.md +27 -0
  57. data/docs/ProcedureOutputMetadata.md +9 -0
  58. data/docs/ProcedureRemindConfig.md +8 -0
  59. data/docs/ProcedureRemindConfigEmail.md +8 -0
  60. data/docs/ProcedureRemindInput.md +8 -0
  61. data/docs/ProceduresApi.md +527 -0
  62. data/docs/ServerStampConfig.md +8 -0
  63. data/docs/ServerStampConfigWebhook.md +8 -0
  64. data/docs/ServerStampInput.md +12 -0
  65. data/docs/ServerStampOutput.md +17 -0
  66. data/docs/ServerStampsApi.md +109 -0
  67. data/docs/SignatureUIsApi.md +545 -0
  68. data/docs/SignatureUiInput.md +28 -0
  69. data/docs/SignatureUiInputRedirectCancel.md +10 -0
  70. data/docs/SignatureUiInputRedirectError.md +10 -0
  71. data/docs/SignatureUiInputRedirectSuccess.md +10 -0
  72. data/docs/SignatureUiInputUpdate.md +27 -0
  73. data/docs/SignatureUiLabelInput.md +10 -0
  74. data/docs/SignatureUiLabelInputIncluded.md +9 -0
  75. data/docs/SignatureUiLabelOutput.md +14 -0
  76. data/docs/SignatureUiOutput.md +33 -0
  77. data/docs/SignatureUiOutputRedirectCancel.md +10 -0
  78. data/docs/SignatureUiOutputRedirectError.md +10 -0
  79. data/docs/SignatureUiOutputRedirectSuccess.md +10 -0
  80. data/docs/UserGroup.md +10 -0
  81. data/docs/UserGroupsApi.md +103 -0
  82. data/docs/UserInput.md +17 -0
  83. data/docs/UserInputNotifications.md +8 -0
  84. data/docs/UserOutput.md +29 -0
  85. data/docs/UserOutputNotifications.md +8 -0
  86. data/docs/UserWorkspaceOutput.md +9 -0
  87. data/docs/UsersApi.md +258 -0
  88. data/docs/WorkspaceConfig.md +10 -0
  89. data/docs/WorkspaceConfigEmail.md +15 -0
  90. data/docs/WorkspaceConfigProcedure.md +8 -0
  91. data/docs/WorkspaceOutput.md +16 -0
  92. data/docs/WorkspacesApi.md +54 -0
  93. data/git_push.sh +55 -0
  94. data/lib/yousign_client.rb +126 -0
  95. data/lib/yousign_client/api/authentications_api.rb +410 -0
  96. data/lib/yousign_client/api/check_documents_api.rb +269 -0
  97. data/lib/yousign_client/api/consent_processes_api.rb +528 -0
  98. data/lib/yousign_client/api/file_objects_api.rb +282 -0
  99. data/lib/yousign_client/api/files_api.rb +279 -0
  100. data/lib/yousign_client/api/members_api.rb +340 -0
  101. data/lib/yousign_client/api/operations_api.rb +148 -0
  102. data/lib/yousign_client/api/organizations_api.rb +76 -0
  103. data/lib/yousign_client/api/procedures_api.rb +680 -0
  104. data/lib/yousign_client/api/server_stamps_api.rb +146 -0
  105. data/lib/yousign_client/api/signature_u_is_api.rb +669 -0
  106. data/lib/yousign_client/api/user_groups_api.rb +135 -0
  107. data/lib/yousign_client/api/users_api.rb +327 -0
  108. data/lib/yousign_client/api/workspaces_api.rb +76 -0
  109. data/lib/yousign_client/api_client.rb +391 -0
  110. data/lib/yousign_client/api_error.rb +38 -0
  111. data/lib/yousign_client/configuration.rb +209 -0
  112. data/lib/yousign_client/models/authentication_email_output.rb +239 -0
  113. data/lib/yousign_client/models/authentication_inwebo_output.rb +239 -0
  114. data/lib/yousign_client/models/authentication_sms_output.rb +239 -0
  115. data/lib/yousign_client/models/body.rb +185 -0
  116. data/lib/yousign_client/models/body_1.rb +200 -0
  117. data/lib/yousign_client/models/body_2.rb +200 -0
  118. data/lib/yousign_client/models/check_document_bank_accounts_input.rb +240 -0
  119. data/lib/yousign_client/models/check_document_bank_accounts_output.rb +394 -0
  120. data/lib/yousign_client/models/check_document_identities_input.rb +222 -0
  121. data/lib/yousign_client/models/check_document_identities_output.rb +440 -0
  122. data/lib/yousign_client/models/config_email_template.rb +256 -0
  123. data/lib/yousign_client/models/config_webhook_template.rb +246 -0
  124. data/lib/yousign_client/models/consent_process_input.rb +293 -0
  125. data/lib/yousign_client/models/consent_process_output.rb +298 -0
  126. data/lib/yousign_client/models/consent_process_value_input.rb +215 -0
  127. data/lib/yousign_client/models/consent_process_value_output.rb +235 -0
  128. data/lib/yousign_client/models/file_input.rb +304 -0
  129. data/lib/yousign_client/models/file_input_metadata.rb +194 -0
  130. data/lib/yousign_client/models/file_object_input.rb +445 -0
  131. data/lib/yousign_client/models/file_object_input_without_file_reference.rb +252 -0
  132. data/lib/yousign_client/models/file_object_output.rb +489 -0
  133. data/lib/yousign_client/models/file_object_output_without_file_reference.rb +307 -0
  134. data/lib/yousign_client/models/file_output.rb +374 -0
  135. data/lib/yousign_client/models/inline_response_400.rb +185 -0
  136. data/lib/yousign_client/models/inwebo_user_request.rb +200 -0
  137. data/lib/yousign_client/models/member_input.rb +343 -0
  138. data/lib/yousign_client/models/member_output.rb +432 -0
  139. data/lib/yousign_client/models/mode_sms_configuration.rb +190 -0
  140. data/lib/yousign_client/models/operation_input.rb +313 -0
  141. data/lib/yousign_client/models/operation_output.rb +311 -0
  142. data/lib/yousign_client/models/operation_output_metadata.rb +194 -0
  143. data/lib/yousign_client/models/organization_billing_address.rb +256 -0
  144. data/lib/yousign_client/models/organization_output.rb +530 -0
  145. data/lib/yousign_client/models/procedure_config.rb +204 -0
  146. data/lib/yousign_client/models/procedure_config_email.rb +263 -0
  147. data/lib/yousign_client/models/procedure_config_reminder.rb +256 -0
  148. data/lib/yousign_client/models/procedure_config_reminder_config.rb +184 -0
  149. data/lib/yousign_client/models/procedure_config_reminder_config_email.rb +186 -0
  150. data/lib/yousign_client/models/procedure_config_webhook.rb +263 -0
  151. data/lib/yousign_client/models/procedure_duplicate_input.rb +197 -0
  152. data/lib/yousign_client/models/procedure_input.rb +289 -0
  153. data/lib/yousign_client/models/procedure_input_metadata.rb +194 -0
  154. data/lib/yousign_client/models/procedure_output.rb +457 -0
  155. data/lib/yousign_client/models/procedure_output_metadata.rb +194 -0
  156. data/lib/yousign_client/models/procedure_remind_config.rb +184 -0
  157. data/lib/yousign_client/models/procedure_remind_config_email.rb +186 -0
  158. data/lib/yousign_client/models/procedure_remind_input.rb +184 -0
  159. data/lib/yousign_client/models/server_stamp_config.rb +184 -0
  160. data/lib/yousign_client/models/server_stamp_config_webhook.rb +186 -0
  161. data/lib/yousign_client/models/server_stamp_input.rb +242 -0
  162. data/lib/yousign_client/models/server_stamp_output.rb +352 -0
  163. data/lib/yousign_client/models/signature_ui_input.rb +456 -0
  164. data/lib/yousign_client/models/signature_ui_input_redirect_cancel.rb +244 -0
  165. data/lib/yousign_client/models/signature_ui_input_redirect_error.rb +247 -0
  166. data/lib/yousign_client/models/signature_ui_input_redirect_success.rb +242 -0
  167. data/lib/yousign_client/models/signature_ui_input_update.rb +421 -0
  168. data/lib/yousign_client/models/signature_ui_label_input.rb +210 -0
  169. data/lib/yousign_client/models/signature_ui_label_input_included.rb +200 -0
  170. data/lib/yousign_client/models/signature_ui_label_output.rb +245 -0
  171. data/lib/yousign_client/models/signature_ui_output.rb +481 -0
  172. data/lib/yousign_client/models/signature_ui_output_redirect_cancel.rb +242 -0
  173. data/lib/yousign_client/models/signature_ui_output_redirect_error.rb +247 -0
  174. data/lib/yousign_client/models/signature_ui_output_redirect_success.rb +242 -0
  175. data/lib/yousign_client/models/user_group.rb +249 -0
  176. data/lib/yousign_client/models/user_input.rb +341 -0
  177. data/lib/yousign_client/models/user_input_notifications.rb +185 -0
  178. data/lib/yousign_client/models/user_output.rb +457 -0
  179. data/lib/yousign_client/models/user_output_notifications.rb +185 -0
  180. data/lib/yousign_client/models/user_workspace_output.rb +210 -0
  181. data/lib/yousign_client/models/workspace_config.rb +226 -0
  182. data/lib/yousign_client/models/workspace_config_email.rb +263 -0
  183. data/lib/yousign_client/models/workspace_config_procedure.rb +208 -0
  184. data/lib/yousign_client/models/workspace_output.rb +275 -0
  185. data/lib/yousign_client/version.rb +15 -0
  186. data/spec/api/authentications_api_spec.rb +113 -0
  187. data/spec/api/check_documents_api_spec.rb +85 -0
  188. data/spec/api/consent_processes_api_spec.rb +138 -0
  189. data/spec/api/file_objects_api_spec.rb +90 -0
  190. data/spec/api/files_api_spec.rb +89 -0
  191. data/spec/api/members_api_spec.rb +103 -0
  192. data/spec/api/operations_api_spec.rb +60 -0
  193. data/spec/api/organizations_api_spec.rb +46 -0
  194. data/spec/api/procedures_api_spec.rb +178 -0
  195. data/spec/api/server_stamps_api_spec.rb +60 -0
  196. data/spec/api/signature_u_is_api_spec.rb +170 -0
  197. data/spec/api/user_groups_api_spec.rb +58 -0
  198. data/spec/api/users_api_spec.rb +97 -0
  199. data/spec/api/workspaces_api_spec.rb +46 -0
  200. data/spec/api_client_spec.rb +243 -0
  201. data/spec/configuration_spec.rb +42 -0
  202. data/spec/models/authentication_email_output_spec.rb +57 -0
  203. data/spec/models/authentication_inwebo_output_spec.rb +57 -0
  204. data/spec/models/authentication_sms_output_spec.rb +57 -0
  205. data/spec/models/body_1_spec.rb +47 -0
  206. data/spec/models/body_2_spec.rb +47 -0
  207. data/spec/models/body_spec.rb +41 -0
  208. data/spec/models/check_document_bank_accounts_input_spec.rb +71 -0
  209. data/spec/models/check_document_bank_accounts_output_spec.rb +141 -0
  210. data/spec/models/check_document_identities_input_spec.rb +59 -0
  211. data/spec/models/check_document_identities_output_spec.rb +165 -0
  212. data/spec/models/config_email_template_spec.rb +63 -0
  213. data/spec/models/config_webhook_template_spec.rb +57 -0
  214. data/spec/models/consent_process_input_spec.rb +81 -0
  215. data/spec/models/consent_process_output_spec.rb +87 -0
  216. data/spec/models/consent_process_value_input_spec.rb +53 -0
  217. data/spec/models/consent_process_value_output_spec.rb +65 -0
  218. data/spec/models/file_input_metadata_spec.rb +47 -0
  219. data/spec/models/file_input_spec.rb +87 -0
  220. data/spec/models/file_object_input_spec.rb +127 -0
  221. data/spec/models/file_object_input_without_file_reference_spec.rb +71 -0
  222. data/spec/models/file_object_output_spec.rb +145 -0
  223. data/spec/models/file_object_output_without_file_reference_spec.rb +95 -0
  224. data/spec/models/file_output_spec.rb +111 -0
  225. data/spec/models/inline_response_400_spec.rb +41 -0
  226. data/spec/models/inwebo_user_request_spec.rb +41 -0
  227. data/spec/models/member_input_spec.rb +119 -0
  228. data/spec/models/member_output_spec.rb +153 -0
  229. data/spec/models/mode_sms_configuration_spec.rb +41 -0
  230. data/spec/models/operation_input_spec.rb +89 -0
  231. data/spec/models/operation_output_metadata_spec.rb +47 -0
  232. data/spec/models/operation_output_spec.rb +95 -0
  233. data/spec/models/organization_billing_address_spec.rb +89 -0
  234. data/spec/models/organization_output_spec.rb +239 -0
  235. data/spec/models/procedure_config_email_spec.rb +83 -0
  236. data/spec/models/procedure_config_reminder_config_email_spec.rb +41 -0
  237. data/spec/models/procedure_config_reminder_config_spec.rb +41 -0
  238. data/spec/models/procedure_config_reminder_spec.rb +53 -0
  239. data/spec/models/procedure_config_spec.rb +53 -0
  240. data/spec/models/procedure_config_webhook_spec.rb +83 -0
  241. data/spec/models/procedure_duplicate_input_spec.rb +47 -0
  242. data/spec/models/procedure_input_metadata_spec.rb +47 -0
  243. data/spec/models/procedure_input_spec.rb +101 -0
  244. data/spec/models/procedure_output_metadata_spec.rb +47 -0
  245. data/spec/models/procedure_output_spec.rb +159 -0
  246. data/spec/models/procedure_remind_config_email_spec.rb +41 -0
  247. data/spec/models/procedure_remind_config_spec.rb +41 -0
  248. data/spec/models/procedure_remind_input_spec.rb +41 -0
  249. data/spec/models/server_stamp_config_spec.rb +41 -0
  250. data/spec/models/server_stamp_config_webhook_spec.rb +41 -0
  251. data/spec/models/server_stamp_input_spec.rb +65 -0
  252. data/spec/models/server_stamp_output_spec.rb +99 -0
  253. data/spec/models/signature_ui_input_redirect_cancel_spec.rb +57 -0
  254. data/spec/models/signature_ui_input_redirect_error_spec.rb +57 -0
  255. data/spec/models/signature_ui_input_redirect_success_spec.rb +57 -0
  256. data/spec/models/signature_ui_input_spec.rb +165 -0
  257. data/spec/models/signature_ui_input_update_spec.rb +159 -0
  258. data/spec/models/signature_ui_label_input_included_spec.rb +47 -0
  259. data/spec/models/signature_ui_label_input_spec.rb +53 -0
  260. data/spec/models/signature_ui_label_output_spec.rb +77 -0
  261. data/spec/models/signature_ui_output_redirect_cancel_spec.rb +57 -0
  262. data/spec/models/signature_ui_output_redirect_error_spec.rb +57 -0
  263. data/spec/models/signature_ui_output_redirect_success_spec.rb +57 -0
  264. data/spec/models/signature_ui_output_spec.rb +195 -0
  265. data/spec/models/user_group_spec.rb +57 -0
  266. data/spec/models/user_input_notifications_spec.rb +41 -0
  267. data/spec/models/user_input_spec.rb +99 -0
  268. data/spec/models/user_output_notifications_spec.rb +41 -0
  269. data/spec/models/user_output_spec.rb +171 -0
  270. data/spec/models/user_workspace_output_spec.rb +47 -0
  271. data/spec/models/workspace_config_email_spec.rb +83 -0
  272. data/spec/models/workspace_config_procedure_spec.rb +45 -0
  273. data/spec/models/workspace_config_spec.rb +57 -0
  274. data/spec/models/workspace_output_spec.rb +89 -0
  275. data/spec/spec_helper.rb +111 -0
  276. data/update_client.sh +11 -0
  277. data/yousign_client.gemspec +45 -0
  278. data/yousign_openapi.json +5417 -0
  279. metadata +590 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: b655e4e6d416e0ec0a70783c1d2b619763281a7a90b3029d75fc95fa835717a9
4
+ data.tar.gz: 69bf335ece5e389c5553690ecb8491966c9c3a9a0b80f8bfa320d806119a496d
5
+ SHA512:
6
+ metadata.gz: f62aaf807236dd05d15612df271a0e915abbccc47c935cdad53920f936b6ae4d3579dd226b86ba115bfb281d7d20711fddb14ccbbee1c030366dafc5fc2c8f51
7
+ data.tar.gz: fc02056d58441287b275b5764bef4152045f0ed5848f39e57859b4c743ec7f521e1e282178209d0a73cc48de496e0fbe785836422e76eb742ee60dfdbeed1e24
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.3.3'
7
+ end
@@ -0,0 +1,230 @@
1
+ # yousign_client
2
+
3
+ YousignClient - the Ruby gem for the Yousign API Swagger
4
+
5
+ For your information, the Yousign API documentation is available at https://dev.yousign.com/
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: 2.1
10
+ - Package version: 1.0.0
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build yousign_client.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./yousign_client-1.0.0.gem
27
+ ```
28
+ (for development, run `gem install --dev ./yousign_client-1.0.0.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'yousign_client', '~> 1.0.0'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
39
+
40
+ gem 'yousign_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'yousign_client'
56
+
57
+ api_instance = YousignClient::AuthenticationsApi.new
58
+
59
+ id = 'id_example' # String |
60
+
61
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
62
+
63
+
64
+ begin
65
+ #Find an Authentication by ID
66
+ result = api_instance.authentications_email_id_get(id, authorization)
67
+ p result
68
+ rescue YousignClient::ApiError => e
69
+ puts "Exception when calling AuthenticationsApi->authentications_email_id_get: #{e}"
70
+ end
71
+
72
+ ```
73
+
74
+ ## Documentation for API Endpoints
75
+
76
+ All URIs are relative to *https://api.yousign.com*
77
+
78
+ Class | Method | HTTP request | Description
79
+ ------------ | ------------- | ------------- | -------------
80
+ *YousignClient::AuthenticationsApi* | [**authentications_email_id_get**](docs/AuthenticationsApi.md#authentications_email_id_get) | **GET** /authentications/email/{id} | Find an Authentication by ID
81
+ *YousignClient::AuthenticationsApi* | [**authentications_email_id_put**](docs/AuthenticationsApi.md#authentications_email_id_put) | **PUT** /authentications/email/{id} | Update an Email Authentication
82
+ *YousignClient::AuthenticationsApi* | [**authentications_inwebo_id_get**](docs/AuthenticationsApi.md#authentications_inwebo_id_get) | **GET** /authentications/inwebo/{id} | Get an Authentication
83
+ *YousignClient::AuthenticationsApi* | [**authentications_inwebo_id_put**](docs/AuthenticationsApi.md#authentications_inwebo_id_put) | **PUT** /authentications/inwebo/{id} | Update an inwebo Authentication
84
+ *YousignClient::AuthenticationsApi* | [**authentications_sms_id_get**](docs/AuthenticationsApi.md#authentications_sms_id_get) | **GET** /authentications/sms/{id} | Find an Authentication by ID
85
+ *YousignClient::AuthenticationsApi* | [**authentications_sms_id_put**](docs/AuthenticationsApi.md#authentications_sms_id_put) | **PUT** /authentications/sms/{id} | Update an SMS Authentication
86
+ *YousignClient::CheckDocumentsApi* | [**check_document_bank_accounts_id_get**](docs/CheckDocumentsApi.md#check_document_bank_accounts_id_get) | **GET** /check-document/bank_accounts/{id} | Get informations about a bank document (RIB)
87
+ *YousignClient::CheckDocumentsApi* | [**check_document_bank_accounts_post**](docs/CheckDocumentsApi.md#check_document_bank_accounts_post) | **POST** /check-document/bank_accounts | Verify a bank document (RIB)
88
+ *YousignClient::CheckDocumentsApi* | [**check_document_identities_id_get**](docs/CheckDocumentsApi.md#check_document_identities_id_get) | **GET** /check-document/identities/{id} | Get informations about an identity document (passport, id cards)
89
+ *YousignClient::CheckDocumentsApi* | [**check_document_identities_post**](docs/CheckDocumentsApi.md#check_document_identities_post) | **POST** /check-document/identities | Verify an identity document (passport, id cards)
90
+ *YousignClient::ConsentProcessesApi* | [**consent_process_values_get**](docs/ConsentProcessesApi.md#consent_process_values_get) | **GET** /consent_process_values | Get list of Consent Process Value
91
+ *YousignClient::ConsentProcessesApi* | [**consent_process_values_id_get**](docs/ConsentProcessesApi.md#consent_process_values_id_get) | **GET** /consent_process_values/{id} | Get a Consent Process Value
92
+ *YousignClient::ConsentProcessesApi* | [**consent_process_values_post**](docs/ConsentProcessesApi.md#consent_process_values_post) | **POST** /consent_process_values | Create a new Consent Process Value
93
+ *YousignClient::ConsentProcessesApi* | [**consent_processes_get**](docs/ConsentProcessesApi.md#consent_processes_get) | **GET** /consent_processes | Get list of Consent Processes
94
+ *YousignClient::ConsentProcessesApi* | [**consent_processes_id_delete**](docs/ConsentProcessesApi.md#consent_processes_id_delete) | **DELETE** /consent_processes/{id} | Delete a Consent Process
95
+ *YousignClient::ConsentProcessesApi* | [**consent_processes_id_get**](docs/ConsentProcessesApi.md#consent_processes_id_get) | **GET** /consent_processes/{id} | Get a Consent Process
96
+ *YousignClient::ConsentProcessesApi* | [**consent_processes_id_put**](docs/ConsentProcessesApi.md#consent_processes_id_put) | **PUT** /consent_processes/{id} | Update a Consent Process
97
+ *YousignClient::ConsentProcessesApi* | [**consent_processes_post**](docs/ConsentProcessesApi.md#consent_processes_post) | **POST** /consent_processes | Create a new Consent Process
98
+ *YousignClient::FileObjectsApi* | [**file_objects_id_delete**](docs/FileObjectsApi.md#file_objects_id_delete) | **DELETE** /file_objects/{id} | Delete a File Object
99
+ *YousignClient::FileObjectsApi* | [**file_objects_id_get**](docs/FileObjectsApi.md#file_objects_id_get) | **GET** /file_objects/{id} | Find a File Object by ID
100
+ *YousignClient::FileObjectsApi* | [**file_objects_id_put**](docs/FileObjectsApi.md#file_objects_id_put) | **PUT** /file_objects/{id} | Update a File Object
101
+ *YousignClient::FileObjectsApi* | [**file_objects_post**](docs/FileObjectsApi.md#file_objects_post) | **POST** /file_objects | Create a new File Object
102
+ *YousignClient::FilesApi* | [**files_id_download_get**](docs/FilesApi.md#files_id_download_get) | **GET** /files/{id}/download | Download a File
103
+ *YousignClient::FilesApi* | [**files_id_duplicate_post**](docs/FilesApi.md#files_id_duplicate_post) | **POST** /files/{id}/duplicate | Duplicate a File
104
+ *YousignClient::FilesApi* | [**files_id_get**](docs/FilesApi.md#files_id_get) | **GET** /files/{id} | Find a File by ID
105
+ *YousignClient::FilesApi* | [**files_post**](docs/FilesApi.md#files_post) | **POST** /files | Create a new File
106
+ *YousignClient::MembersApi* | [**members_get**](docs/MembersApi.md#members_get) | **GET** /members | Get all Members
107
+ *YousignClient::MembersApi* | [**members_id_delete**](docs/MembersApi.md#members_id_delete) | **DELETE** /members/{id} | Delete a Member
108
+ *YousignClient::MembersApi* | [**members_id_proof_get**](docs/MembersApi.md#members_id_proof_get) | **GET** /members/{id}/proof | Get a proof file of a Member
109
+ *YousignClient::MembersApi* | [**members_id_put**](docs/MembersApi.md#members_id_put) | **PUT** /members/{id} | Edit a Member
110
+ *YousignClient::MembersApi* | [**members_post**](docs/MembersApi.md#members_post) | **POST** /members | Create a new Member
111
+ *YousignClient::OperationsApi* | [**operations_id_get**](docs/OperationsApi.md#operations_id_get) | **GET** /operations/{id} | Find an Operation by ID
112
+ *YousignClient::OperationsApi* | [**operations_post**](docs/OperationsApi.md#operations_post) | **POST** /operations | Create a new Operation
113
+ *YousignClient::OrganizationsApi* | [**organizations_get**](docs/OrganizationsApi.md#organizations_get) | **GET** /organizations | List all Organizations
114
+ *YousignClient::ProceduresApi* | [**export_procedures_get**](docs/ProceduresApi.md#export_procedures_get) | **GET** /export/procedures | Export Procedure list
115
+ *YousignClient::ProceduresApi* | [**procedures_get**](docs/ProceduresApi.md#procedures_get) | **GET** /procedures | Get Procedure list
116
+ *YousignClient::ProceduresApi* | [**procedures_id_delete**](docs/ProceduresApi.md#procedures_id_delete) | **DELETE** /procedures/{id} | Delete a Procedure
117
+ *YousignClient::ProceduresApi* | [**procedures_id_duplicate_post**](docs/ProceduresApi.md#procedures_id_duplicate_post) | **POST** /procedures/{id}/duplicate | Duplicate a Procedure
118
+ *YousignClient::ProceduresApi* | [**procedures_id_get**](docs/ProceduresApi.md#procedures_id_get) | **GET** /procedures/{id} | Find a Procedure by ID
119
+ *YousignClient::ProceduresApi* | [**procedures_id_proof_get**](docs/ProceduresApi.md#procedures_id_proof_get) | **GET** /procedures/{id}/proof | Get a Procedure proof file
120
+ *YousignClient::ProceduresApi* | [**procedures_id_put**](docs/ProceduresApi.md#procedures_id_put) | **PUT** /procedures/{id} | Update a Procedure
121
+ *YousignClient::ProceduresApi* | [**procedures_id_remind_post**](docs/ProceduresApi.md#procedures_id_remind_post) | **POST** /procedures/{id}/remind | Remind a Procedure
122
+ *YousignClient::ProceduresApi* | [**procedures_post**](docs/ProceduresApi.md#procedures_post) | **POST** /procedures | Create a new Procedure
123
+ *YousignClient::ServerStampsApi* | [**server_stamps_id_get**](docs/ServerStampsApi.md#server_stamps_id_get) | **GET** /server_stamps/{id} | Find a Server Stamp by ID
124
+ *YousignClient::ServerStampsApi* | [**server_stamps_post**](docs/ServerStampsApi.md#server_stamps_post) | **POST** /server_stamps | Create a Server Stamp
125
+ *YousignClient::SignatureUIsApi* | [**signature_ui_labels_get**](docs/SignatureUIsApi.md#signature_ui_labels_get) | **GET** /signature_ui_labels | Get Signature UI Labels
126
+ *YousignClient::SignatureUIsApi* | [**signature_ui_labels_id_delete**](docs/SignatureUIsApi.md#signature_ui_labels_id_delete) | **DELETE** /signature_ui_labels/{id} | Delete a Signature UI Label
127
+ *YousignClient::SignatureUIsApi* | [**signature_ui_labels_id_get**](docs/SignatureUIsApi.md#signature_ui_labels_id_get) | **GET** /signature_ui_labels/{id} | Find a Signature UI Label by ID
128
+ *YousignClient::SignatureUIsApi* | [**signature_ui_labels_id_put**](docs/SignatureUIsApi.md#signature_ui_labels_id_put) | **PUT** /signature_ui_labels/{id} | Update a Signature UI Label
129
+ *YousignClient::SignatureUIsApi* | [**signature_ui_labels_post**](docs/SignatureUIsApi.md#signature_ui_labels_post) | **POST** /signature_ui_labels | Create a new Signature UI Label
130
+ *YousignClient::SignatureUIsApi* | [**signature_uis_get**](docs/SignatureUIsApi.md#signature_uis_get) | **GET** /signature_uis | Get Signature UI list
131
+ *YousignClient::SignatureUIsApi* | [**signature_uis_id_delete**](docs/SignatureUIsApi.md#signature_uis_id_delete) | **DELETE** /signature_uis/{id} | Delete a Signature UI
132
+ *YousignClient::SignatureUIsApi* | [**signature_uis_id_get**](docs/SignatureUIsApi.md#signature_uis_id_get) | **GET** /signature_uis/{id} | Find a Signature UI by ID
133
+ *YousignClient::SignatureUIsApi* | [**signature_uis_id_put**](docs/SignatureUIsApi.md#signature_uis_id_put) | **PUT** /signature_uis/{id} | Update a Signature UI
134
+ *YousignClient::SignatureUIsApi* | [**signature_uis_post**](docs/SignatureUIsApi.md#signature_uis_post) | **POST** /signature_uis | Create a new Signature UI
135
+ *YousignClient::UserGroupsApi* | [**user_groups_get**](docs/UserGroupsApi.md#user_groups_get) | **GET** /user_groups | Get User Group list
136
+ *YousignClient::UserGroupsApi* | [**user_groups_id_get**](docs/UserGroupsApi.md#user_groups_id_get) | **GET** /user_groups/{id} | Find a User Group by ID
137
+ *YousignClient::UsersApi* | [**users_get**](docs/UsersApi.md#users_get) | **GET** /users | List all Users
138
+ *YousignClient::UsersApi* | [**users_id_delete**](docs/UsersApi.md#users_id_delete) | **DELETE** /users/{id} | Delete a User
139
+ *YousignClient::UsersApi* | [**users_id_get**](docs/UsersApi.md#users_id_get) | **GET** /users/{id} | Find a User by ID
140
+ *YousignClient::UsersApi* | [**users_id_put**](docs/UsersApi.md#users_id_put) | **PUT** /users/{id} | Update a User
141
+ *YousignClient::UsersApi* | [**users_post**](docs/UsersApi.md#users_post) | **POST** /users | Create a new User on Yousign application
142
+ *YousignClient::WorkspacesApi* | [**workspaces_get**](docs/WorkspacesApi.md#workspaces_get) | **GET** /workspaces | List all Workspaces
143
+
144
+
145
+ ## Documentation for Models
146
+
147
+ - [YousignClient::AuthenticationEmailOutput](docs/AuthenticationEmailOutput.md)
148
+ - [YousignClient::AuthenticationInweboOutput](docs/AuthenticationInweboOutput.md)
149
+ - [YousignClient::AuthenticationSmsOutput](docs/AuthenticationSmsOutput.md)
150
+ - [YousignClient::Body](docs/Body.md)
151
+ - [YousignClient::Body1](docs/Body1.md)
152
+ - [YousignClient::Body2](docs/Body2.md)
153
+ - [YousignClient::CheckDocumentBankAccountsInput](docs/CheckDocumentBankAccountsInput.md)
154
+ - [YousignClient::CheckDocumentBankAccountsOutput](docs/CheckDocumentBankAccountsOutput.md)
155
+ - [YousignClient::CheckDocumentIdentitiesInput](docs/CheckDocumentIdentitiesInput.md)
156
+ - [YousignClient::CheckDocumentIdentitiesOutput](docs/CheckDocumentIdentitiesOutput.md)
157
+ - [YousignClient::ConfigEmailTemplate](docs/ConfigEmailTemplate.md)
158
+ - [YousignClient::ConfigWebhookTemplate](docs/ConfigWebhookTemplate.md)
159
+ - [YousignClient::ConsentProcessInput](docs/ConsentProcessInput.md)
160
+ - [YousignClient::ConsentProcessOutput](docs/ConsentProcessOutput.md)
161
+ - [YousignClient::ConsentProcessValueInput](docs/ConsentProcessValueInput.md)
162
+ - [YousignClient::ConsentProcessValueOutput](docs/ConsentProcessValueOutput.md)
163
+ - [YousignClient::FileInput](docs/FileInput.md)
164
+ - [YousignClient::FileInputMetadata](docs/FileInputMetadata.md)
165
+ - [YousignClient::FileObjectInput](docs/FileObjectInput.md)
166
+ - [YousignClient::FileObjectInputWithoutFileReference](docs/FileObjectInputWithoutFileReference.md)
167
+ - [YousignClient::FileObjectOutput](docs/FileObjectOutput.md)
168
+ - [YousignClient::FileObjectOutputWithoutFileReference](docs/FileObjectOutputWithoutFileReference.md)
169
+ - [YousignClient::FileOutput](docs/FileOutput.md)
170
+ - [YousignClient::InlineResponse400](docs/InlineResponse400.md)
171
+ - [YousignClient::InweboUserRequest](docs/InweboUserRequest.md)
172
+ - [YousignClient::MemberInput](docs/MemberInput.md)
173
+ - [YousignClient::MemberOutput](docs/MemberOutput.md)
174
+ - [YousignClient::ModeSmsConfiguration](docs/ModeSmsConfiguration.md)
175
+ - [YousignClient::OperationInput](docs/OperationInput.md)
176
+ - [YousignClient::OperationOutput](docs/OperationOutput.md)
177
+ - [YousignClient::OperationOutputMetadata](docs/OperationOutputMetadata.md)
178
+ - [YousignClient::OrganizationBillingAddress](docs/OrganizationBillingAddress.md)
179
+ - [YousignClient::OrganizationOutput](docs/OrganizationOutput.md)
180
+ - [YousignClient::ProcedureConfig](docs/ProcedureConfig.md)
181
+ - [YousignClient::ProcedureConfigEmail](docs/ProcedureConfigEmail.md)
182
+ - [YousignClient::ProcedureConfigReminder](docs/ProcedureConfigReminder.md)
183
+ - [YousignClient::ProcedureConfigReminderConfig](docs/ProcedureConfigReminderConfig.md)
184
+ - [YousignClient::ProcedureConfigReminderConfigEmail](docs/ProcedureConfigReminderConfigEmail.md)
185
+ - [YousignClient::ProcedureConfigWebhook](docs/ProcedureConfigWebhook.md)
186
+ - [YousignClient::ProcedureDuplicateInput](docs/ProcedureDuplicateInput.md)
187
+ - [YousignClient::ProcedureInput](docs/ProcedureInput.md)
188
+ - [YousignClient::ProcedureInputMetadata](docs/ProcedureInputMetadata.md)
189
+ - [YousignClient::ProcedureOutput](docs/ProcedureOutput.md)
190
+ - [YousignClient::ProcedureOutputMetadata](docs/ProcedureOutputMetadata.md)
191
+ - [YousignClient::ProcedureRemindConfig](docs/ProcedureRemindConfig.md)
192
+ - [YousignClient::ProcedureRemindConfigEmail](docs/ProcedureRemindConfigEmail.md)
193
+ - [YousignClient::ProcedureRemindInput](docs/ProcedureRemindInput.md)
194
+ - [YousignClient::ServerStampConfig](docs/ServerStampConfig.md)
195
+ - [YousignClient::ServerStampConfigWebhook](docs/ServerStampConfigWebhook.md)
196
+ - [YousignClient::ServerStampInput](docs/ServerStampInput.md)
197
+ - [YousignClient::ServerStampOutput](docs/ServerStampOutput.md)
198
+ - [YousignClient::SignatureUiInput](docs/SignatureUiInput.md)
199
+ - [YousignClient::SignatureUiInputRedirectCancel](docs/SignatureUiInputRedirectCancel.md)
200
+ - [YousignClient::SignatureUiInputRedirectError](docs/SignatureUiInputRedirectError.md)
201
+ - [YousignClient::SignatureUiInputRedirectSuccess](docs/SignatureUiInputRedirectSuccess.md)
202
+ - [YousignClient::SignatureUiInputUpdate](docs/SignatureUiInputUpdate.md)
203
+ - [YousignClient::SignatureUiLabelInput](docs/SignatureUiLabelInput.md)
204
+ - [YousignClient::SignatureUiLabelInputIncluded](docs/SignatureUiLabelInputIncluded.md)
205
+ - [YousignClient::SignatureUiLabelOutput](docs/SignatureUiLabelOutput.md)
206
+ - [YousignClient::SignatureUiOutput](docs/SignatureUiOutput.md)
207
+ - [YousignClient::SignatureUiOutputRedirectCancel](docs/SignatureUiOutputRedirectCancel.md)
208
+ - [YousignClient::SignatureUiOutputRedirectError](docs/SignatureUiOutputRedirectError.md)
209
+ - [YousignClient::SignatureUiOutputRedirectSuccess](docs/SignatureUiOutputRedirectSuccess.md)
210
+ - [YousignClient::UserGroup](docs/UserGroup.md)
211
+ - [YousignClient::UserInput](docs/UserInput.md)
212
+ - [YousignClient::UserInputNotifications](docs/UserInputNotifications.md)
213
+ - [YousignClient::UserOutput](docs/UserOutput.md)
214
+ - [YousignClient::UserOutputNotifications](docs/UserOutputNotifications.md)
215
+ - [YousignClient::UserWorkspaceOutput](docs/UserWorkspaceOutput.md)
216
+ - [YousignClient::WorkspaceConfig](docs/WorkspaceConfig.md)
217
+ - [YousignClient::WorkspaceConfigEmail](docs/WorkspaceConfigEmail.md)
218
+ - [YousignClient::WorkspaceConfigProcedure](docs/WorkspaceConfigProcedure.md)
219
+ - [YousignClient::WorkspaceOutput](docs/WorkspaceOutput.md)
220
+
221
+
222
+ ## Documentation for Authorization
223
+
224
+
225
+ ### ApiKey
226
+
227
+ - **Type**: API key
228
+ - **API key parameter name**: Authorization
229
+ - **Location**: HTTP header
230
+
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,11 @@
1
+ {
2
+ "gemName": "yousign_client",
3
+ "gemAuthor": "Thomas Burgaud",
4
+ "gemAuthorEmail": "thomas.burgaud@cashbee.fr",
5
+ "gemSummary": "Yousign API Documentation Ruby Gem",
6
+ "gemDescription": "Yousign API Documentation Ruby Gem",
7
+ "gemHomepage": "https://github.com/cashbee-team/yousign_client",
8
+ "moduleName": "YousignClient",
9
+ "gemLicense": "Apache 2.0",
10
+ "gemVersion": "1.0.0"
11
+ }
@@ -0,0 +1,10 @@
1
+ # YousignClient::AuthenticationEmailOutput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | id of authentication | [optional]
7
+ **status** | **String** | Status of authentication | [optional]
8
+ **type** | **String** | Type of authentication | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # YousignClient::AuthenticationInweboOutput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | id of authentication | [optional]
7
+ **status** | **String** | Status of authentication | [optional]
8
+ **type** | **String** | Type of authentication | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # YousignClient::AuthenticationSmsOutput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | id of authentication | [optional]
7
+ **status** | **String** | Status of authentication | [optional]
8
+ **type** | **String** | Type of authentication | [optional]
9
+
10
+
@@ -0,0 +1,320 @@
1
+ # YousignClient::AuthenticationsApi
2
+
3
+ All URIs are relative to *https://api.yousign.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**authentications_email_id_get**](AuthenticationsApi.md#authentications_email_id_get) | **GET** /authentications/email/{id} | Find an Authentication by ID
8
+ [**authentications_email_id_put**](AuthenticationsApi.md#authentications_email_id_put) | **PUT** /authentications/email/{id} | Update an Email Authentication
9
+ [**authentications_inwebo_id_get**](AuthenticationsApi.md#authentications_inwebo_id_get) | **GET** /authentications/inwebo/{id} | Get an Authentication
10
+ [**authentications_inwebo_id_put**](AuthenticationsApi.md#authentications_inwebo_id_put) | **PUT** /authentications/inwebo/{id} | Update an inwebo Authentication
11
+ [**authentications_sms_id_get**](AuthenticationsApi.md#authentications_sms_id_get) | **GET** /authentications/sms/{id} | Find an Authentication by ID
12
+ [**authentications_sms_id_put**](AuthenticationsApi.md#authentications_sms_id_put) | **PUT** /authentications/sms/{id} | Update an SMS Authentication
13
+
14
+
15
+ # **authentications_email_id_get**
16
+ > AuthenticationEmailOutput authentications_email_id_get(id, authorization)
17
+
18
+ Find an Authentication by ID
19
+
20
+ ### Example
21
+ ```ruby
22
+ # load the gem
23
+ require 'yousign_client'
24
+
25
+ api_instance = YousignClient::AuthenticationsApi.new
26
+
27
+ id = 'id_example' # String |
28
+
29
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
30
+
31
+
32
+ begin
33
+ #Find an Authentication by ID
34
+ result = api_instance.authentications_email_id_get(id, authorization)
35
+ p result
36
+ rescue YousignClient::ApiError => e
37
+ puts "Exception when calling AuthenticationsApi->authentications_email_id_get: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **id** | **String**| |
46
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
47
+
48
+ ### Return type
49
+
50
+ [**AuthenticationEmailOutput**](AuthenticationEmailOutput.md)
51
+
52
+ ### Authorization
53
+
54
+ No authorization required
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: application/json
59
+ - **Accept**: application/json
60
+
61
+
62
+
63
+ # **authentications_email_id_put**
64
+ > AuthenticationEmailOutput authentications_email_id_put(id, authorization, content_type, body)
65
+
66
+ Update an Email Authentication
67
+
68
+ ### Example
69
+ ```ruby
70
+ # load the gem
71
+ require 'yousign_client'
72
+
73
+ api_instance = YousignClient::AuthenticationsApi.new
74
+
75
+ id = 'id_example' # String |
76
+
77
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
78
+
79
+ content_type = 'application/json' # String | The MIME type of the body of the request
80
+
81
+ body = YousignClient::Body2.new # Body2 |
82
+
83
+
84
+ begin
85
+ #Update an Email Authentication
86
+ result = api_instance.authentications_email_id_put(id, authorization, content_type, body)
87
+ p result
88
+ rescue YousignClient::ApiError => e
89
+ puts "Exception when calling AuthenticationsApi->authentications_email_id_put: #{e}"
90
+ end
91
+ ```
92
+
93
+ ### Parameters
94
+
95
+ Name | Type | Description | Notes
96
+ ------------- | ------------- | ------------- | -------------
97
+ **id** | **String**| |
98
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
99
+ **content_type** | **String**| The MIME type of the body of the request |
100
+ **body** | [**Body2**](Body2.md)| |
101
+
102
+ ### Return type
103
+
104
+ [**AuthenticationEmailOutput**](AuthenticationEmailOutput.md)
105
+
106
+ ### Authorization
107
+
108
+ No authorization required
109
+
110
+ ### HTTP request headers
111
+
112
+ - **Content-Type**: Not defined
113
+ - **Accept**: application/json
114
+
115
+
116
+
117
+ # **authentications_inwebo_id_get**
118
+ > AuthenticationInweboOutput authentications_inwebo_id_get(id, authorization)
119
+
120
+ Get an Authentication
121
+
122
+ ### Example
123
+ ```ruby
124
+ # load the gem
125
+ require 'yousign_client'
126
+
127
+ api_instance = YousignClient::AuthenticationsApi.new
128
+
129
+ id = 'id_example' # String |
130
+
131
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
132
+
133
+
134
+ begin
135
+ #Get an Authentication
136
+ result = api_instance.authentications_inwebo_id_get(id, authorization)
137
+ p result
138
+ rescue YousignClient::ApiError => e
139
+ puts "Exception when calling AuthenticationsApi->authentications_inwebo_id_get: #{e}"
140
+ end
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+ Name | Type | Description | Notes
146
+ ------------- | ------------- | ------------- | -------------
147
+ **id** | **String**| |
148
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
149
+
150
+ ### Return type
151
+
152
+ [**AuthenticationInweboOutput**](AuthenticationInweboOutput.md)
153
+
154
+ ### Authorization
155
+
156
+ No authorization required
157
+
158
+ ### HTTP request headers
159
+
160
+ - **Content-Type**: application/json
161
+ - **Accept**: application/json
162
+
163
+
164
+
165
+ # **authentications_inwebo_id_put**
166
+ > AuthenticationInweboOutput authentications_inwebo_id_put(id, authorization, content_type, body)
167
+
168
+ Update an inwebo Authentication
169
+
170
+ ### Example
171
+ ```ruby
172
+ # load the gem
173
+ require 'yousign_client'
174
+
175
+ api_instance = YousignClient::AuthenticationsApi.new
176
+
177
+ id = 'id_example' # String |
178
+
179
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
180
+
181
+ content_type = 'application/json' # String | The MIME type of the body of the request
182
+
183
+ body = YousignClient::Body.new # Body |
184
+
185
+
186
+ begin
187
+ #Update an inwebo Authentication
188
+ result = api_instance.authentications_inwebo_id_put(id, authorization, content_type, body)
189
+ p result
190
+ rescue YousignClient::ApiError => e
191
+ puts "Exception when calling AuthenticationsApi->authentications_inwebo_id_put: #{e}"
192
+ end
193
+ ```
194
+
195
+ ### Parameters
196
+
197
+ Name | Type | Description | Notes
198
+ ------------- | ------------- | ------------- | -------------
199
+ **id** | **String**| |
200
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
201
+ **content_type** | **String**| The MIME type of the body of the request |
202
+ **body** | [**Body**](Body.md)| |
203
+
204
+ ### Return type
205
+
206
+ [**AuthenticationInweboOutput**](AuthenticationInweboOutput.md)
207
+
208
+ ### Authorization
209
+
210
+ No authorization required
211
+
212
+ ### HTTP request headers
213
+
214
+ - **Content-Type**: Not defined
215
+ - **Accept**: application/json
216
+
217
+
218
+
219
+ # **authentications_sms_id_get**
220
+ > AuthenticationSmsOutput authentications_sms_id_get(id, authorization)
221
+
222
+ Find an Authentication by ID
223
+
224
+ ### Example
225
+ ```ruby
226
+ # load the gem
227
+ require 'yousign_client'
228
+
229
+ api_instance = YousignClient::AuthenticationsApi.new
230
+
231
+ id = 'id_example' # String |
232
+
233
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
234
+
235
+
236
+ begin
237
+ #Find an Authentication by ID
238
+ result = api_instance.authentications_sms_id_get(id, authorization)
239
+ p result
240
+ rescue YousignClient::ApiError => e
241
+ puts "Exception when calling AuthenticationsApi->authentications_sms_id_get: #{e}"
242
+ end
243
+ ```
244
+
245
+ ### Parameters
246
+
247
+ Name | Type | Description | Notes
248
+ ------------- | ------------- | ------------- | -------------
249
+ **id** | **String**| |
250
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
251
+
252
+ ### Return type
253
+
254
+ [**AuthenticationSmsOutput**](AuthenticationSmsOutput.md)
255
+
256
+ ### Authorization
257
+
258
+ No authorization required
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: application/json
263
+ - **Accept**: application/json
264
+
265
+
266
+
267
+ # **authentications_sms_id_put**
268
+ > AuthenticationSmsOutput authentications_sms_id_put(id, authorization, content_type, body)
269
+
270
+ Update an SMS Authentication
271
+
272
+ ### Example
273
+ ```ruby
274
+ # load the gem
275
+ require 'yousign_client'
276
+
277
+ api_instance = YousignClient::AuthenticationsApi.new
278
+
279
+ id = 'id_example' # String |
280
+
281
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
282
+
283
+ content_type = 'application/json' # String | The MIME type of the body of the request
284
+
285
+ body = YousignClient::Body1.new # Body1 |
286
+
287
+
288
+ begin
289
+ #Update an SMS Authentication
290
+ result = api_instance.authentications_sms_id_put(id, authorization, content_type, body)
291
+ p result
292
+ rescue YousignClient::ApiError => e
293
+ puts "Exception when calling AuthenticationsApi->authentications_sms_id_put: #{e}"
294
+ end
295
+ ```
296
+
297
+ ### Parameters
298
+
299
+ Name | Type | Description | Notes
300
+ ------------- | ------------- | ------------- | -------------
301
+ **id** | **String**| |
302
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
303
+ **content_type** | **String**| The MIME type of the body of the request |
304
+ **body** | [**Body1**](Body1.md)| |
305
+
306
+ ### Return type
307
+
308
+ [**AuthenticationSmsOutput**](AuthenticationSmsOutput.md)
309
+
310
+ ### Authorization
311
+
312
+ No authorization required
313
+
314
+ ### HTTP request headers
315
+
316
+ - **Content-Type**: Not defined
317
+ - **Accept**: application/json
318
+
319
+
320
+