yousign_client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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,8 @@
1
+ # YousignClient::Body
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **sign_image** | **String** | Image of signature (base 64) | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # YousignClient::Body1
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | Code sms received by user |
7
+ **sign_image** | **String** | Image of signature (base 64) | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # YousignClient::Body2
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | Code sms received by user |
7
+ **sign_image** | **String** | Image of signature (base 64) | [optional]
8
+
9
+
@@ -0,0 +1,13 @@
1
+ # YousignClient::CheckDocumentBankAccountsInput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **file** | **String** | Content in base 64 of the document to check |
7
+ **first_name** | **String** | Firstname to check on document | [optional]
8
+ **birth_name** | **String** | Birth name to check on document | [optional]
9
+ **last_name** | **String** | Lastname to check on document | [optional]
10
+ **company_name** | **String** | Company name to check on document | [optional]
11
+ **iban** | **String** | Iban text to check on document | [optional]
12
+
13
+
@@ -0,0 +1,24 @@
1
+ # YousignClient::CheckDocumentBankAccountsOutput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Id of the object | [optional]
7
+ **created_at** | **DateTime** | Created date of the object | [optional]
8
+ **updated_at** | **DateTime** | Updated date of the object | [optional]
9
+ **first_name** | **String** | Firstname to check on document | [optional]
10
+ **birth_name** | **String** | Birth name to check on document | [optional]
11
+ **last_name** | **String** | Lastname to check on document | [optional]
12
+ **iban** | **String** | Iban to check on document | [optional]
13
+ **company_name** | **String** | Company name to check on document | [optional]
14
+ **document_type** | **String** | Type of document | [optional]
15
+ **workspace** | **String** | Workspace creator of the object | [optional]
16
+ **creator** | **String** | Creator of the object | [optional]
17
+ **extracted_iban** | **String** | Extracted iban on the document | [optional]
18
+ **first_name_valid** | **BOOLEAN** | Defines if one firstname sent in the input is valid | [optional]
19
+ **birth_name_valid** | **BOOLEAN** | Defines if birth name sent in the input is valid | [optional]
20
+ **last_name_valid** | **BOOLEAN** | Defines if lastname sent in the input is valid | [optional]
21
+ **company_name_valid** | **BOOLEAN** | Defines if company name sent in the input is valid | [optional]
22
+ **iban_valid** | **BOOLEAN** | Defines if iban sent in the input is valid | [optional]
23
+
24
+
@@ -0,0 +1,11 @@
1
+ # YousignClient::CheckDocumentIdentitiesInput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **file** | **String** | Content in base 64 of the document to check |
7
+ **first_names** | **Array<String>** | List of firstnames to check on document | [optional]
8
+ **birth_name** | **String** | Birth name to check on document | [optional]
9
+ **birth_date** | **Date** | Birth date to check on document | [optional]
10
+
11
+
@@ -0,0 +1,28 @@
1
+ # YousignClient::CheckDocumentIdentitiesOutput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Id of the object | [optional]
7
+ **created_at** | **DateTime** | Created date of the object | [optional]
8
+ **updated_at** | **DateTime** | Updated date of the object | [optional]
9
+ **first_names** | **Array<String>** | List of firstnames to check on document | [optional]
10
+ **birth_name** | **String** | Birth name to check on document | [optional]
11
+ **birth_date** | **Date** | Birth date to check on document | [optional]
12
+ **workspace** | **String** | workspace creator of the object | [optional]
13
+ **creator** | **String** | Creator of the object | [optional]
14
+ **document_type** | **String** | Type of document | [optional]
15
+ **extracted_first_names** | **Array<String>** | Extracted firstnames on the document | [optional]
16
+ **extracted_birth_name** | **String** | Extracted birth name on the document | [optional]
17
+ **extracted_birth_date** | **Date** | Extracted birth date on the document | [optional]
18
+ **extracted_gender** | **String** | Extracted gender on the document | [optional]
19
+ **extracted_issuance_date** | **Date** | Extracted issuance date on the document | [optional]
20
+ **extracted_expiration_date** | **Date** | Extracted expiration date on the document | [optional]
21
+ **extracted_mrz** | **Array<String>** | Extracted MRZ on the document | [optional]
22
+ **first_name_valid** | **BOOLEAN** | Defines if one firstname sent in the input is valid | [optional]
23
+ **birth_name_valid** | **BOOLEAN** | Defines if birth name sent in the input is valid | [optional]
24
+ **mrz_valid** | **BOOLEAN** | Defines if MRZ sent in the input is valid | [optional]
25
+ **expired** | **BOOLEAN** | Defines if the document is expired | [optional]
26
+ **valid** | **BOOLEAN** | Defines if the document is valid | [optional]
27
+
28
+
@@ -0,0 +1,210 @@
1
+ # YousignClient::CheckDocumentsApi
2
+
3
+ All URIs are relative to *https://api.yousign.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**check_document_bank_accounts_id_get**](CheckDocumentsApi.md#check_document_bank_accounts_id_get) | **GET** /check-document/bank_accounts/{id} | Get informations about a bank document (RIB)
8
+ [**check_document_bank_accounts_post**](CheckDocumentsApi.md#check_document_bank_accounts_post) | **POST** /check-document/bank_accounts | Verify a bank document (RIB)
9
+ [**check_document_identities_id_get**](CheckDocumentsApi.md#check_document_identities_id_get) | **GET** /check-document/identities/{id} | Get informations about an identity document (passport, id cards)
10
+ [**check_document_identities_post**](CheckDocumentsApi.md#check_document_identities_post) | **POST** /check-document/identities | Verify an identity document (passport, id cards)
11
+
12
+
13
+ # **check_document_bank_accounts_id_get**
14
+ > CheckDocumentBankAccountsOutput check_document_bank_accounts_id_get(id, authorization)
15
+
16
+ Get informations about a bank document (RIB)
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'yousign_client'
22
+
23
+ api_instance = YousignClient::CheckDocumentsApi.new
24
+
25
+ id = 'id_example' # String |
26
+
27
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
28
+
29
+
30
+ begin
31
+ #Get informations about a bank document (RIB)
32
+ result = api_instance.check_document_bank_accounts_id_get(id, authorization)
33
+ p result
34
+ rescue YousignClient::ApiError => e
35
+ puts "Exception when calling CheckDocumentsApi->check_document_bank_accounts_id_get: #{e}"
36
+ end
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ Name | Type | Description | Notes
42
+ ------------- | ------------- | ------------- | -------------
43
+ **id** | **String**| |
44
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
45
+
46
+ ### Return type
47
+
48
+ [**CheckDocumentBankAccountsOutput**](CheckDocumentBankAccountsOutput.md)
49
+
50
+ ### Authorization
51
+
52
+ No authorization required
53
+
54
+ ### HTTP request headers
55
+
56
+ - **Content-Type**: application/json
57
+ - **Accept**: application/json
58
+
59
+
60
+
61
+ # **check_document_bank_accounts_post**
62
+ > CheckDocumentBankAccountsOutput check_document_bank_accounts_post(authorization, content_type, body)
63
+
64
+ Verify a bank document (RIB)
65
+
66
+ ### Example
67
+ ```ruby
68
+ # load the gem
69
+ require 'yousign_client'
70
+
71
+ api_instance = YousignClient::CheckDocumentsApi.new
72
+
73
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
74
+
75
+ content_type = 'application/json' # String | The MIME type of the body of the request
76
+
77
+ body = YousignClient::CheckDocumentBankAccountsInput.new # CheckDocumentBankAccountsInput |
78
+
79
+
80
+ begin
81
+ #Verify a bank document (RIB)
82
+ result = api_instance.check_document_bank_accounts_post(authorization, content_type, body)
83
+ p result
84
+ rescue YousignClient::ApiError => e
85
+ puts "Exception when calling CheckDocumentsApi->check_document_bank_accounts_post: #{e}"
86
+ end
87
+ ```
88
+
89
+ ### Parameters
90
+
91
+ Name | Type | Description | Notes
92
+ ------------- | ------------- | ------------- | -------------
93
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
94
+ **content_type** | **String**| The MIME type of the body of the request |
95
+ **body** | [**CheckDocumentBankAccountsInput**](CheckDocumentBankAccountsInput.md)| |
96
+
97
+ ### Return type
98
+
99
+ [**CheckDocumentBankAccountsOutput**](CheckDocumentBankAccountsOutput.md)
100
+
101
+ ### Authorization
102
+
103
+ No authorization required
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: Not defined
108
+ - **Accept**: application/json
109
+
110
+
111
+
112
+ # **check_document_identities_id_get**
113
+ > CheckDocumentIdentitiesOutput check_document_identities_id_get(id, authorization)
114
+
115
+ Get informations about an identity document (passport, id cards)
116
+
117
+ ### Example
118
+ ```ruby
119
+ # load the gem
120
+ require 'yousign_client'
121
+
122
+ api_instance = YousignClient::CheckDocumentsApi.new
123
+
124
+ id = 'id_example' # String |
125
+
126
+ authorization = 'authorization_example' # String | Authentication credentials for HTTP authentication
127
+
128
+
129
+ begin
130
+ #Get informations about an identity document (passport, id cards)
131
+ result = api_instance.check_document_identities_id_get(id, authorization)
132
+ p result
133
+ rescue YousignClient::ApiError => e
134
+ puts "Exception when calling CheckDocumentsApi->check_document_identities_id_get: #{e}"
135
+ end
136
+ ```
137
+
138
+ ### Parameters
139
+
140
+ Name | Type | Description | Notes
141
+ ------------- | ------------- | ------------- | -------------
142
+ **id** | **String**| |
143
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
144
+
145
+ ### Return type
146
+
147
+ [**CheckDocumentIdentitiesOutput**](CheckDocumentIdentitiesOutput.md)
148
+
149
+ ### Authorization
150
+
151
+ No authorization required
152
+
153
+ ### HTTP request headers
154
+
155
+ - **Content-Type**: application/json
156
+ - **Accept**: application/json
157
+
158
+
159
+
160
+ # **check_document_identities_post**
161
+ > CheckDocumentIdentitiesOutput check_document_identities_post(authorization, content_type, body)
162
+
163
+ Verify an identity document (passport, id cards)
164
+
165
+ ### Example
166
+ ```ruby
167
+ # load the gem
168
+ require 'yousign_client'
169
+
170
+ api_instance = YousignClient::CheckDocumentsApi.new
171
+
172
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
173
+
174
+ content_type = 'application/json' # String | The MIME type of the body of the request
175
+
176
+ body = YousignClient::CheckDocumentIdentitiesInput.new # CheckDocumentIdentitiesInput |
177
+
178
+
179
+ begin
180
+ #Verify an identity document (passport, id cards)
181
+ result = api_instance.check_document_identities_post(authorization, content_type, body)
182
+ p result
183
+ rescue YousignClient::ApiError => e
184
+ puts "Exception when calling CheckDocumentsApi->check_document_identities_post: #{e}"
185
+ end
186
+ ```
187
+
188
+ ### Parameters
189
+
190
+ Name | Type | Description | Notes
191
+ ------------- | ------------- | ------------- | -------------
192
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
193
+ **content_type** | **String**| The MIME type of the body of the request |
194
+ **body** | [**CheckDocumentIdentitiesInput**](CheckDocumentIdentitiesInput.md)| |
195
+
196
+ ### Return type
197
+
198
+ [**CheckDocumentIdentitiesOutput**](CheckDocumentIdentitiesOutput.md)
199
+
200
+ ### Authorization
201
+
202
+ No authorization required
203
+
204
+ ### HTTP request headers
205
+
206
+ - **Content-Type**: Not defined
207
+ - **Accept**: application/json
208
+
209
+
210
+
@@ -0,0 +1,11 @@
1
+ # YousignClient::ConfigEmailTemplate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **to** | **Array<String>** | Reference or email of recipients |
7
+ **subject** | **String** | Subject of the mail |
8
+ **message** | **String** | Object of the mail |
9
+ **from_name** | **String** | Modify the from name | [optional] [default to 'Yousign']
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # YousignClient::ConfigWebhookTemplate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | Url to call |
7
+ **method** | **String** | Http request type | [optional] [default to 'GET']
8
+ **headers** | **Object** | Http request headers | [optional]
9
+
10
+
@@ -0,0 +1,14 @@
1
+ # YousignClient::ConsentProcessInput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | Type of operation |
7
+ **description** | **String** | Description of consent Process | [optional]
8
+ **required** | **BOOLEAN** | Consent process is required | [optional] [default to true]
9
+ **position** | **Integer** | Position of consent process | [optional]
10
+ **expected_value** | **String** | Expected value for consent process value | [optional]
11
+ **members** | **Array<String>** | List of members attached to consent process |
12
+ **file** | **String** | File attached to consent process | [optional]
13
+
14
+
@@ -0,0 +1,15 @@
1
+ # YousignClient::ConsentProcessOutput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Id of object | [optional]
7
+ **type** | **String** | Type of operation | [optional]
8
+ **description** | **String** | Description of consent Process | [optional]
9
+ **required** | **BOOLEAN** | Consent process is required | [optional] [default to true]
10
+ **position** | **Integer** | Position of consent process | [optional]
11
+ **expected_value** | **String** | Expected value for consent process value | [optional]
12
+ **members** | **Array<String>** | List of members attached to consent process |
13
+ **file** | **String** | File attached to consent process | [optional]
14
+
15
+
@@ -0,0 +1,10 @@
1
+ # YousignClient::ConsentProcessValueInput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **consent_process** | **String** | Consent process attached to concent process value |
7
+ **member** | **String** | Member attached to concent process value |
8
+ **value** | **String** | Value of concent process value | [optional]
9
+
10
+
@@ -0,0 +1,12 @@
1
+ # YousignClient::ConsentProcessValueOutput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | id of object | [optional]
7
+ **consent_process** | **String** | Consent process attached to concent process value |
8
+ **member** | **String** | Member attached to concent process value |
9
+ **value** | **String** | Value of concent process value | [optional]
10
+ **created_at** | **DateTime** | Creation date | [optional]
11
+
12
+
@@ -0,0 +1,422 @@
1
+ # YousignClient::ConsentProcessesApi
2
+
3
+ All URIs are relative to *https://api.yousign.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**consent_process_values_get**](ConsentProcessesApi.md#consent_process_values_get) | **GET** /consent_process_values | Get list of Consent Process Value
8
+ [**consent_process_values_id_get**](ConsentProcessesApi.md#consent_process_values_id_get) | **GET** /consent_process_values/{id} | Get a Consent Process Value
9
+ [**consent_process_values_post**](ConsentProcessesApi.md#consent_process_values_post) | **POST** /consent_process_values | Create a new Consent Process Value
10
+ [**consent_processes_get**](ConsentProcessesApi.md#consent_processes_get) | **GET** /consent_processes | Get list of Consent Processes
11
+ [**consent_processes_id_delete**](ConsentProcessesApi.md#consent_processes_id_delete) | **DELETE** /consent_processes/{id} | Delete a Consent Process
12
+ [**consent_processes_id_get**](ConsentProcessesApi.md#consent_processes_id_get) | **GET** /consent_processes/{id} | Get a Consent Process
13
+ [**consent_processes_id_put**](ConsentProcessesApi.md#consent_processes_id_put) | **PUT** /consent_processes/{id} | Update a Consent Process
14
+ [**consent_processes_post**](ConsentProcessesApi.md#consent_processes_post) | **POST** /consent_processes | Create a new Consent Process
15
+
16
+
17
+ # **consent_process_values_get**
18
+ > ConsentProcessValueOutput consent_process_values_get(member, authorization)
19
+
20
+ Get list of Consent Process Value
21
+
22
+ ### Example
23
+ ```ruby
24
+ # load the gem
25
+ require 'yousign_client'
26
+
27
+ api_instance = YousignClient::ConsentProcessesApi.new
28
+
29
+ member = '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member
30
+
31
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
32
+
33
+
34
+ begin
35
+ #Get list of Consent Process Value
36
+ result = api_instance.consent_process_values_get(member, authorization)
37
+ p result
38
+ rescue YousignClient::ApiError => e
39
+ puts "Exception when calling ConsentProcessesApi->consent_process_values_get: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **member** | **String**| id of member |
48
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
49
+
50
+ ### Return type
51
+
52
+ [**ConsentProcessValueOutput**](ConsentProcessValueOutput.md)
53
+
54
+ ### Authorization
55
+
56
+ No authorization required
57
+
58
+ ### HTTP request headers
59
+
60
+ - **Content-Type**: application/json
61
+ - **Accept**: application/json
62
+
63
+
64
+
65
+ # **consent_process_values_id_get**
66
+ > ConsentProcessValueOutput consent_process_values_id_get(id, authorization, opts)
67
+
68
+ Get a Consent Process Value
69
+
70
+ ### Example
71
+ ```ruby
72
+ # load the gem
73
+ require 'yousign_client'
74
+
75
+ api_instance = YousignClient::ConsentProcessesApi.new
76
+
77
+ id = 'id_example' # String |
78
+
79
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
80
+
81
+ opts = {
82
+ member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member (required for anonymous)
83
+ }
84
+
85
+ begin
86
+ #Get a Consent Process Value
87
+ result = api_instance.consent_process_values_id_get(id, authorization, opts)
88
+ p result
89
+ rescue YousignClient::ApiError => e
90
+ puts "Exception when calling ConsentProcessesApi->consent_process_values_id_get: #{e}"
91
+ end
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ Name | Type | Description | Notes
97
+ ------------- | ------------- | ------------- | -------------
98
+ **id** | **String**| |
99
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
100
+ **member** | **String**| id of member (required for anonymous) | [optional]
101
+
102
+ ### Return type
103
+
104
+ [**ConsentProcessValueOutput**](ConsentProcessValueOutput.md)
105
+
106
+ ### Authorization
107
+
108
+ No authorization required
109
+
110
+ ### HTTP request headers
111
+
112
+ - **Content-Type**: application/json
113
+ - **Accept**: application/json
114
+
115
+
116
+
117
+ # **consent_process_values_post**
118
+ > ConsentProcessValueOutput consent_process_values_post(authorization, content_type, body)
119
+
120
+ Create a new Consent Process Value
121
+
122
+ ### Example
123
+ ```ruby
124
+ # load the gem
125
+ require 'yousign_client'
126
+
127
+ api_instance = YousignClient::ConsentProcessesApi.new
128
+
129
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
130
+
131
+ content_type = 'application/json' # String | The MIME type of the body of the request
132
+
133
+ body = YousignClient::ConsentProcessValueInput.new # ConsentProcessValueInput |
134
+
135
+
136
+ begin
137
+ #Create a new Consent Process Value
138
+ result = api_instance.consent_process_values_post(authorization, content_type, body)
139
+ p result
140
+ rescue YousignClient::ApiError => e
141
+ puts "Exception when calling ConsentProcessesApi->consent_process_values_post: #{e}"
142
+ end
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+ Name | Type | Description | Notes
148
+ ------------- | ------------- | ------------- | -------------
149
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
150
+ **content_type** | **String**| The MIME type of the body of the request |
151
+ **body** | [**ConsentProcessValueInput**](ConsentProcessValueInput.md)| |
152
+
153
+ ### Return type
154
+
155
+ [**ConsentProcessValueOutput**](ConsentProcessValueOutput.md)
156
+
157
+ ### Authorization
158
+
159
+ No authorization required
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: application/json
164
+ - **Accept**: application/json
165
+
166
+
167
+
168
+ # **consent_processes_get**
169
+ > Array<ConsentProcessOutput> consent_processes_get(authorization, opts)
170
+
171
+ Get list of Consent Processes
172
+
173
+ ### Example
174
+ ```ruby
175
+ # load the gem
176
+ require 'yousign_client'
177
+
178
+ api_instance = YousignClient::ConsentProcessesApi.new
179
+
180
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
181
+
182
+ opts = {
183
+ member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40', # String | id of member (required for anonymous)
184
+ procedure: '/procedures/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of procedure (required if the member attribut is not set)
185
+ }
186
+
187
+ begin
188
+ #Get list of Consent Processes
189
+ result = api_instance.consent_processes_get(authorization, opts)
190
+ p result
191
+ rescue YousignClient::ApiError => e
192
+ puts "Exception when calling ConsentProcessesApi->consent_processes_get: #{e}"
193
+ end
194
+ ```
195
+
196
+ ### Parameters
197
+
198
+ Name | Type | Description | Notes
199
+ ------------- | ------------- | ------------- | -------------
200
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
201
+ **member** | **String**| id of member (required for anonymous) | [optional]
202
+ **procedure** | **String**| id of procedure (required if the member attribut is not set) | [optional]
203
+
204
+ ### Return type
205
+
206
+ [**Array<ConsentProcessOutput>**](ConsentProcessOutput.md)
207
+
208
+ ### Authorization
209
+
210
+ No authorization required
211
+
212
+ ### HTTP request headers
213
+
214
+ - **Content-Type**: application/json
215
+ - **Accept**: application/json
216
+
217
+
218
+
219
+ # **consent_processes_id_delete**
220
+ > consent_processes_id_delete(id, authorization)
221
+
222
+ Delete a Consent Process
223
+
224
+ ### Example
225
+ ```ruby
226
+ # load the gem
227
+ require 'yousign_client'
228
+
229
+ api_instance = YousignClient::ConsentProcessesApi.new
230
+
231
+ id = 'id_example' # String |
232
+
233
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
234
+
235
+
236
+ begin
237
+ #Delete a Consent Process
238
+ api_instance.consent_processes_id_delete(id, authorization)
239
+ rescue YousignClient::ApiError => e
240
+ puts "Exception when calling ConsentProcessesApi->consent_processes_id_delete: #{e}"
241
+ end
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ Name | Type | Description | Notes
247
+ ------------- | ------------- | ------------- | -------------
248
+ **id** | **String**| |
249
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
250
+
251
+ ### Return type
252
+
253
+ nil (empty response body)
254
+
255
+ ### Authorization
256
+
257
+ No authorization required
258
+
259
+ ### HTTP request headers
260
+
261
+ - **Content-Type**: application/json
262
+ - **Accept**: application/json
263
+
264
+
265
+
266
+ # **consent_processes_id_get**
267
+ > ConsentProcessOutput consent_processes_id_get(id, authorization, opts)
268
+
269
+ Get a Consent Process
270
+
271
+ ### Example
272
+ ```ruby
273
+ # load the gem
274
+ require 'yousign_client'
275
+
276
+ api_instance = YousignClient::ConsentProcessesApi.new
277
+
278
+ id = 'id_example' # String |
279
+
280
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
281
+
282
+ opts = {
283
+ member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member (required for anonymous)
284
+ }
285
+
286
+ begin
287
+ #Get a Consent Process
288
+ result = api_instance.consent_processes_id_get(id, authorization, opts)
289
+ p result
290
+ rescue YousignClient::ApiError => e
291
+ puts "Exception when calling ConsentProcessesApi->consent_processes_id_get: #{e}"
292
+ end
293
+ ```
294
+
295
+ ### Parameters
296
+
297
+ Name | Type | Description | Notes
298
+ ------------- | ------------- | ------------- | -------------
299
+ **id** | **String**| |
300
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
301
+ **member** | **String**| id of member (required for anonymous) | [optional]
302
+
303
+ ### Return type
304
+
305
+ [**ConsentProcessOutput**](ConsentProcessOutput.md)
306
+
307
+ ### Authorization
308
+
309
+ No authorization required
310
+
311
+ ### HTTP request headers
312
+
313
+ - **Content-Type**: application/json
314
+ - **Accept**: application/json
315
+
316
+
317
+
318
+ # **consent_processes_id_put**
319
+ > ConsentProcessOutput consent_processes_id_put(id, authorization, content_type, body)
320
+
321
+ Update a Consent Process
322
+
323
+ ### Example
324
+ ```ruby
325
+ # load the gem
326
+ require 'yousign_client'
327
+
328
+ api_instance = YousignClient::ConsentProcessesApi.new
329
+
330
+ id = 'id_example' # String |
331
+
332
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
333
+
334
+ content_type = 'application/json' # String | The MIME type of the body of the request
335
+
336
+ body = YousignClient::ConsentProcessInput.new # ConsentProcessInput |
337
+
338
+
339
+ begin
340
+ #Update a Consent Process
341
+ result = api_instance.consent_processes_id_put(id, authorization, content_type, body)
342
+ p result
343
+ rescue YousignClient::ApiError => e
344
+ puts "Exception when calling ConsentProcessesApi->consent_processes_id_put: #{e}"
345
+ end
346
+ ```
347
+
348
+ ### Parameters
349
+
350
+ Name | Type | Description | Notes
351
+ ------------- | ------------- | ------------- | -------------
352
+ **id** | **String**| |
353
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
354
+ **content_type** | **String**| The MIME type of the body of the request |
355
+ **body** | [**ConsentProcessInput**](ConsentProcessInput.md)| |
356
+
357
+ ### Return type
358
+
359
+ [**ConsentProcessOutput**](ConsentProcessOutput.md)
360
+
361
+ ### Authorization
362
+
363
+ No authorization required
364
+
365
+ ### HTTP request headers
366
+
367
+ - **Content-Type**: application/json
368
+ - **Accept**: application/json
369
+
370
+
371
+
372
+ # **consent_processes_post**
373
+ > ConsentProcessOutput consent_processes_post(authorization, content_type, body)
374
+
375
+ Create a new Consent Process
376
+
377
+ ### Example
378
+ ```ruby
379
+ # load the gem
380
+ require 'yousign_client'
381
+
382
+ api_instance = YousignClient::ConsentProcessesApi.new
383
+
384
+ authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
385
+
386
+ content_type = 'application/json' # String | The MIME type of the body of the request
387
+
388
+ body = YousignClient::ConsentProcessInput.new # ConsentProcessInput |
389
+
390
+
391
+ begin
392
+ #Create a new Consent Process
393
+ result = api_instance.consent_processes_post(authorization, content_type, body)
394
+ p result
395
+ rescue YousignClient::ApiError => e
396
+ puts "Exception when calling ConsentProcessesApi->consent_processes_post: #{e}"
397
+ end
398
+ ```
399
+
400
+ ### Parameters
401
+
402
+ Name | Type | Description | Notes
403
+ ------------- | ------------- | ------------- | -------------
404
+ **authorization** | **String**| Authentication credentials for HTTP authentication |
405
+ **content_type** | **String**| The MIME type of the body of the request |
406
+ **body** | [**ConsentProcessInput**](ConsentProcessInput.md)| |
407
+
408
+ ### Return type
409
+
410
+ [**ConsentProcessOutput**](ConsentProcessOutput.md)
411
+
412
+ ### Authorization
413
+
414
+ No authorization required
415
+
416
+ ### HTTP request headers
417
+
418
+ - **Content-Type**: application/json
419
+ - **Accept**: application/json
420
+
421
+
422
+