signwell_sdk 0.1.2 → 0.2.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 (291) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +3 -3
  3. data/.github/workflows/generator-ownership.yml +1 -1
  4. data/.github/workflows/manual-release.yml +1 -1
  5. data/.github/workflows/release.yml +1 -1
  6. data/.release-please-manifest.json +1 -1
  7. data/CHANGELOG.md +20 -0
  8. data/Gemfile.lock +16 -12
  9. data/README.md +11 -0
  10. data/docs/AdditionalFieldsInnerInner.md +4 -0
  11. data/docs/BulkSendCsvRequest.md +1 -1
  12. data/docs/ConditionalLogicDecisionInfo.md +26 -0
  13. data/docs/ConditionalRuleInfo.md +26 -0
  14. data/docs/ConditionalRuleInfoConditionsInner.md +26 -0
  15. data/docs/ConditionalRuleRequest.md +28 -0
  16. data/docs/ConditionalRuleRequestConditionsInner.md +26 -0
  17. data/docs/CopiedPlaceholdersInner.md +1 -1
  18. data/docs/CreateBulkSendRequest.md +2 -2
  19. data/docs/DocumentApi.md +82 -8
  20. data/docs/DocumentFromTemplateRequest.md +11 -3
  21. data/docs/DocumentFromTemplateResponse.md +11 -1
  22. data/docs/DocumentFromTemplateResponseFieldsInnerInner.md +4 -0
  23. data/docs/DocumentFromTemplateResponseRecipientsInner.md +6 -0
  24. data/docs/DocumentRequest.md +10 -4
  25. data/docs/DocumentResponse.md +11 -1
  26. data/docs/DocumentResponseFieldsInnerInner.md +4 -0
  27. data/docs/DocumentResponseRecipientsInner.md +6 -0
  28. data/docs/DocumentResponseRecipientsInnerPasscodeDelivery.md +22 -0
  29. data/docs/DocumentResponseRecipientsInnerSms.md +30 -0
  30. data/docs/DocumentTemplateRequest.md +5 -3
  31. data/docs/DocumentTemplateResponse.md +3 -1
  32. data/docs/DocumentTemplateResponsePlaceholdersInner.md +3 -1
  33. data/docs/DocumentTemplateUpdateRequest.md +5 -3
  34. data/docs/EmbeddedBranding.md +18 -0
  35. data/docs/EmbeddedBrandingBranding.md +26 -0
  36. data/docs/EmbeddedBrandingRequest.md +26 -0
  37. data/docs/EmbeddedBrandingRequestCompanyLogo.md +20 -0
  38. data/docs/EmbeddedRequest.md +18 -0
  39. data/docs/FieldsInnerInner.md +4 -0
  40. data/docs/PlaceholdersInner.md +4 -2
  41. data/docs/PlaceholdersInnerPasscodeDelivery.md +22 -0
  42. data/docs/RecipientsInner.md +14 -4
  43. data/docs/RecipientsInnerPasscodeDelivery.md +22 -0
  44. data/docs/ReminderRecipientsInner.md +1 -1
  45. data/docs/SendReminderRequest.md +1 -1
  46. data/docs/TemplateFieldsInnerInner.md +4 -0
  47. data/docs/TemplateRecipientsInner.md +14 -4
  48. data/docs/UpdateAuthenticationRequest.md +18 -0
  49. data/docs/UpdateAuthenticationRequestRecipientsInner.md +22 -0
  50. data/docs/UpdateDocumentAndSendRequest.md +9 -3
  51. data/docs/UpdateRecipientsMapInner.md +4 -2
  52. data/docs/UpdateRecipientsMapInnerPasscodeDelivery.md +22 -0
  53. data/docs/WebhooksApi.md +1 -1
  54. data/lib/signwell_sdk/api/api_application_api.rb +1 -2
  55. data/lib/signwell_sdk/api/bulk_send_api.rb +1 -2
  56. data/lib/signwell_sdk/api/document_api.rb +87 -14
  57. data/lib/signwell_sdk/api/me_api.rb +1 -2
  58. data/lib/signwell_sdk/api/regional_api.rb +1 -2
  59. data/lib/signwell_sdk/api/template_api.rb +1 -2
  60. data/lib/signwell_sdk/api/webhooks_api.rb +3 -4
  61. data/lib/signwell_sdk/api_client.rb +26 -6
  62. data/lib/signwell_sdk/api_error.rb +1 -2
  63. data/lib/signwell_sdk/api_model_base.rb +88 -0
  64. data/lib/signwell_sdk/configuration.rb +1 -1
  65. data/lib/signwell_sdk/extras/rate_limit.rb +17 -0
  66. data/lib/signwell_sdk/models/account_info_response.rb +1 -2
  67. data/lib/signwell_sdk/models/account_info_response_active_users_inner.rb +1 -2
  68. data/lib/signwell_sdk/models/account_info_response_preferences.rb +1 -2
  69. data/lib/signwell_sdk/models/additional_fields_inner_inner.rb +24 -3
  70. data/lib/signwell_sdk/models/additional_fields_inner_inner_value.rb +3 -4
  71. data/lib/signwell_sdk/models/additional_files_inner.rb +1 -2
  72. data/lib/signwell_sdk/models/api_application_response.rb +1 -2
  73. data/lib/signwell_sdk/models/api_application_response_owner.rb +1 -2
  74. data/lib/signwell_sdk/models/api_application_response_preferences.rb +1 -2
  75. data/lib/signwell_sdk/models/attachment_request_info.rb +1 -2
  76. data/lib/signwell_sdk/models/attachment_requests_inner.rb +1 -2
  77. data/lib/signwell_sdk/models/bulk_send_create_response.rb +1 -2
  78. data/lib/signwell_sdk/models/bulk_send_csv_request.rb +2 -3
  79. data/lib/signwell_sdk/models/bulk_send_csv_template_response.rb +1 -2
  80. data/lib/signwell_sdk/models/bulk_send_documents_response.rb +1 -2
  81. data/lib/signwell_sdk/models/bulk_send_list_item.rb +1 -2
  82. data/lib/signwell_sdk/models/bulk_send_list_response.rb +1 -2
  83. data/lib/signwell_sdk/models/bulk_send_response.rb +1 -2
  84. data/lib/signwell_sdk/models/bulk_send_response_templates_inner.rb +1 -2
  85. data/lib/signwell_sdk/models/bulk_send_validate_csv_response.rb +1 -2
  86. data/lib/signwell_sdk/models/checkbox_group_info.rb +1 -2
  87. data/lib/signwell_sdk/models/checkbox_groups_inner.rb +1 -2
  88. data/lib/signwell_sdk/models/checkbox_validation.rb +4 -3
  89. data/lib/signwell_sdk/models/completed_pdf_response.rb +3 -4
  90. data/lib/signwell_sdk/models/completed_pdf_url_response.rb +1 -2
  91. data/lib/signwell_sdk/models/conditional_logic_decision_info.rb +365 -0
  92. data/lib/signwell_sdk/models/conditional_rule_info.rb +351 -0
  93. data/lib/signwell_sdk/models/conditional_rule_info_conditions_inner.rb +340 -0
  94. data/lib/signwell_sdk/models/conditional_rule_request.rb +322 -0
  95. data/lib/signwell_sdk/models/conditional_rule_request_conditions_inner.rb +371 -0
  96. data/lib/signwell_sdk/models/copied_contact_info.rb +1 -2
  97. data/lib/signwell_sdk/models/copied_contacts_inner.rb +1 -2
  98. data/lib/signwell_sdk/models/copied_placeholders_inner.rb +2 -3
  99. data/lib/signwell_sdk/models/create_bulk_send_request.rb +3 -4
  100. data/lib/signwell_sdk/models/create_webhook_request.rb +1 -2
  101. data/lib/signwell_sdk/models/date_format.rb +4 -3
  102. data/lib/signwell_sdk/models/detailed_option.rb +1 -2
  103. data/lib/signwell_sdk/models/document_from_template_request.rb +90 -6
  104. data/lib/signwell_sdk/models/document_from_template_response.rb +101 -6
  105. data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner.rb +24 -3
  106. data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner_recipient.rb +1 -2
  107. data/lib/signwell_sdk/models/document_from_template_response_recipients_inner.rb +71 -3
  108. data/lib/signwell_sdk/models/document_list_response.rb +1 -2
  109. data/lib/signwell_sdk/models/document_request.rb +42 -7
  110. data/lib/signwell_sdk/models/document_response.rb +101 -6
  111. data/lib/signwell_sdk/models/document_response_attachment_requests_inner.rb +1 -2
  112. data/lib/signwell_sdk/models/document_response_fields_inner_inner.rb +24 -3
  113. data/lib/signwell_sdk/models/document_response_fields_inner_inner_options_inner.rb +1 -2
  114. data/lib/signwell_sdk/models/document_response_fields_inner_inner_recipient.rb +1 -2
  115. data/lib/signwell_sdk/models/document_response_fields_inner_inner_value.rb +3 -4
  116. data/lib/signwell_sdk/models/document_response_recipients_inner.rb +71 -3
  117. data/lib/signwell_sdk/models/document_response_recipients_inner_passcode_delivery.rb +246 -0
  118. data/lib/signwell_sdk/models/document_response_recipients_inner_sms.rb +292 -0
  119. data/lib/signwell_sdk/models/document_template_list_response.rb +1 -2
  120. data/lib/signwell_sdk/models/document_template_request.rb +18 -6
  121. data/lib/signwell_sdk/models/document_template_response.rb +17 -6
  122. data/lib/signwell_sdk/models/document_template_response_copied_placeholders_inner.rb +1 -2
  123. data/lib/signwell_sdk/models/document_template_response_placeholders_inner.rb +15 -6
  124. data/lib/signwell_sdk/models/document_template_update_request.rb +18 -6
  125. data/lib/signwell_sdk/models/dropdown_option.rb +3 -4
  126. data/lib/signwell_sdk/models/embedded_branding.rb +241 -0
  127. data/lib/signwell_sdk/models/embedded_branding_branding.rb +307 -0
  128. data/lib/signwell_sdk/models/embedded_branding_request.rb +297 -0
  129. data/lib/signwell_sdk/models/embedded_branding_request_company_logo.rb +236 -0
  130. data/lib/signwell_sdk/models/embedded_request.rb +225 -0
  131. data/lib/signwell_sdk/models/error_response.rb +1 -2
  132. data/lib/signwell_sdk/models/error_response_meta.rb +1 -2
  133. data/lib/signwell_sdk/models/field_type.rb +4 -3
  134. data/lib/signwell_sdk/models/fields_inner_inner.rb +24 -3
  135. data/lib/signwell_sdk/models/file_format.rb +4 -3
  136. data/lib/signwell_sdk/models/file_info.rb +1 -2
  137. data/lib/signwell_sdk/models/files_inner.rb +1 -2
  138. data/lib/signwell_sdk/models/label_info.rb +1 -2
  139. data/lib/signwell_sdk/models/label_request.rb +1 -2
  140. data/lib/signwell_sdk/models/label_response.rb +1 -2
  141. data/lib/signwell_sdk/models/me_response.rb +1 -2
  142. data/lib/signwell_sdk/models/me_response_contact.rb +1 -2
  143. data/lib/signwell_sdk/models/me_response_user.rb +1 -2
  144. data/lib/signwell_sdk/models/me_response_user_preferences.rb +1 -2
  145. data/lib/signwell_sdk/models/nom151_certificate_response.rb +1 -2
  146. data/lib/signwell_sdk/models/nom151_certificate_response_nom151.rb +1 -2
  147. data/lib/signwell_sdk/models/nom151_url_response.rb +1 -2
  148. data/lib/signwell_sdk/models/pagination_meta.rb +1 -2
  149. data/lib/signwell_sdk/models/placeholders_inner.rb +16 -7
  150. data/lib/signwell_sdk/models/placeholders_inner_passcode_delivery.rb +271 -0
  151. data/lib/signwell_sdk/models/rate_limit_error_response.rb +1 -2
  152. data/lib/signwell_sdk/models/recipients_inner.rb +103 -23
  153. data/lib/signwell_sdk/models/recipients_inner_passcode_delivery.rb +271 -0
  154. data/lib/signwell_sdk/models/reminder_recipients_inner.rb +2 -3
  155. data/lib/signwell_sdk/models/send_reminder_request.rb +2 -3
  156. data/lib/signwell_sdk/models/template_attachment_requests_inner.rb +1 -2
  157. data/lib/signwell_sdk/models/template_checkbox_groups_inner.rb +1 -2
  158. data/lib/signwell_sdk/models/template_field_values_inner.rb +1 -2
  159. data/lib/signwell_sdk/models/template_field_values_inner_value.rb +3 -4
  160. data/lib/signwell_sdk/models/template_fields_inner_inner.rb +24 -3
  161. data/lib/signwell_sdk/models/template_recipients_inner.rb +103 -23
  162. data/lib/signwell_sdk/models/text_validation.rb +5 -3
  163. data/lib/signwell_sdk/models/update_authentication_request.rb +243 -0
  164. data/lib/signwell_sdk/models/update_authentication_request_recipients_inner.rb +262 -0
  165. data/lib/signwell_sdk/models/update_document_and_send_request.rb +41 -6
  166. data/lib/signwell_sdk/models/update_recipients_map_inner.rb +16 -7
  167. data/lib/signwell_sdk/models/update_recipients_map_inner_passcode_delivery.rb +271 -0
  168. data/lib/signwell_sdk/models/update_recipients_request.rb +1 -2
  169. data/lib/signwell_sdk/models/validation_error_response.rb +1 -2
  170. data/lib/signwell_sdk/models/webhook_response.rb +1 -2
  171. data/lib/signwell_sdk/version.rb +4 -4
  172. data/lib/signwell_sdk.rb +19 -2
  173. data/openapi.yaml +2231 -972
  174. data/package-lock.json +542 -136
  175. data/package.json +4 -1
  176. data/signwell_sdk.gemspec +1 -2
  177. data/spec/api/api_application_api_spec.rb +1 -2
  178. data/spec/api/bulk_send_api_spec.rb +1 -2
  179. data/spec/api/document_api_spec.rb +11 -4
  180. data/spec/api/me_api_spec.rb +1 -2
  181. data/spec/api/regional_api_spec.rb +1 -2
  182. data/spec/api/template_api_spec.rb +1 -2
  183. data/spec/api/webhooks_api_spec.rb +1 -2
  184. data/spec/models/account_info_response_active_users_inner_spec.rb +1 -2
  185. data/spec/models/account_info_response_preferences_spec.rb +1 -2
  186. data/spec/models/account_info_response_spec.rb +1 -2
  187. data/spec/models/additional_fields_inner_inner_spec.rb +13 -2
  188. data/spec/models/additional_fields_inner_inner_value_spec.rb +1 -2
  189. data/spec/models/additional_files_inner_spec.rb +1 -2
  190. data/spec/models/api_application_response_owner_spec.rb +1 -2
  191. data/spec/models/api_application_response_preferences_spec.rb +1 -2
  192. data/spec/models/api_application_response_spec.rb +1 -2
  193. data/spec/models/attachment_request_info_spec.rb +1 -2
  194. data/spec/models/attachment_requests_inner_spec.rb +1 -2
  195. data/spec/models/bulk_send_create_response_spec.rb +1 -2
  196. data/spec/models/bulk_send_csv_request_spec.rb +1 -2
  197. data/spec/models/bulk_send_csv_template_response_spec.rb +1 -2
  198. data/spec/models/bulk_send_documents_response_spec.rb +1 -2
  199. data/spec/models/bulk_send_list_item_spec.rb +1 -2
  200. data/spec/models/bulk_send_list_response_spec.rb +1 -2
  201. data/spec/models/bulk_send_response_spec.rb +1 -2
  202. data/spec/models/bulk_send_response_templates_inner_spec.rb +1 -2
  203. data/spec/models/bulk_send_validate_csv_response_spec.rb +1 -2
  204. data/spec/models/checkbox_group_info_spec.rb +1 -2
  205. data/spec/models/checkbox_groups_inner_spec.rb +1 -2
  206. data/spec/models/checkbox_validation_spec.rb +1 -2
  207. data/spec/models/completed_pdf_response_spec.rb +1 -2
  208. data/spec/models/completed_pdf_url_response_spec.rb +1 -2
  209. data/spec/models/conditional_logic_decision_info_spec.rb +58 -0
  210. data/spec/models/conditional_rule_info_conditions_inner_spec.rb +58 -0
  211. data/spec/models/conditional_rule_info_spec.rb +58 -0
  212. data/spec/models/conditional_rule_request_conditions_inner_spec.rb +58 -0
  213. data/spec/models/conditional_rule_request_spec.rb +64 -0
  214. data/spec/models/copied_contact_info_spec.rb +1 -2
  215. data/spec/models/copied_contacts_inner_spec.rb +1 -2
  216. data/spec/models/copied_placeholders_inner_spec.rb +1 -2
  217. data/spec/models/create_bulk_send_request_spec.rb +1 -2
  218. data/spec/models/create_webhook_request_spec.rb +1 -2
  219. data/spec/models/date_format_spec.rb +1 -2
  220. data/spec/models/detailed_option_spec.rb +1 -2
  221. data/spec/models/document_from_template_request_spec.rb +25 -2
  222. data/spec/models/document_from_template_response_fields_inner_inner_recipient_spec.rb +1 -2
  223. data/spec/models/document_from_template_response_fields_inner_inner_spec.rb +13 -2
  224. data/spec/models/document_from_template_response_recipients_inner_spec.rb +19 -2
  225. data/spec/models/document_from_template_response_spec.rb +31 -2
  226. data/spec/models/document_list_response_spec.rb +1 -2
  227. data/spec/models/document_request_spec.rb +19 -2
  228. data/spec/models/document_response_attachment_requests_inner_spec.rb +1 -2
  229. data/spec/models/document_response_fields_inner_inner_options_inner_spec.rb +1 -2
  230. data/spec/models/document_response_fields_inner_inner_recipient_spec.rb +1 -2
  231. data/spec/models/document_response_fields_inner_inner_spec.rb +13 -2
  232. data/spec/models/document_response_fields_inner_inner_value_spec.rb +1 -2
  233. data/spec/models/document_response_recipients_inner_passcode_delivery_spec.rb +46 -0
  234. data/spec/models/document_response_recipients_inner_sms_spec.rb +70 -0
  235. data/spec/models/document_response_recipients_inner_spec.rb +19 -2
  236. data/spec/models/document_response_spec.rb +31 -2
  237. data/spec/models/document_template_list_response_spec.rb +1 -2
  238. data/spec/models/document_template_request_spec.rb +7 -2
  239. data/spec/models/document_template_response_copied_placeholders_inner_spec.rb +1 -2
  240. data/spec/models/document_template_response_placeholders_inner_spec.rb +7 -2
  241. data/spec/models/document_template_response_spec.rb +7 -2
  242. data/spec/models/document_template_update_request_spec.rb +7 -2
  243. data/spec/models/dropdown_option_spec.rb +1 -2
  244. data/spec/models/embedded_branding_branding_spec.rb +58 -0
  245. data/spec/models/embedded_branding_request_company_logo_spec.rb +40 -0
  246. data/spec/models/embedded_branding_request_spec.rb +58 -0
  247. data/spec/models/embedded_branding_spec.rb +34 -0
  248. data/spec/models/embedded_request_spec.rb +34 -0
  249. data/spec/models/error_response_meta_spec.rb +1 -2
  250. data/spec/models/error_response_spec.rb +1 -2
  251. data/spec/models/field_type_spec.rb +1 -2
  252. data/spec/models/fields_inner_inner_spec.rb +13 -2
  253. data/spec/models/file_format_spec.rb +1 -2
  254. data/spec/models/file_info_spec.rb +1 -2
  255. data/spec/models/files_inner_spec.rb +1 -2
  256. data/spec/models/label_info_spec.rb +1 -2
  257. data/spec/models/label_request_spec.rb +1 -2
  258. data/spec/models/label_response_spec.rb +1 -2
  259. data/spec/models/me_response_contact_spec.rb +1 -2
  260. data/spec/models/me_response_spec.rb +1 -2
  261. data/spec/models/me_response_user_preferences_spec.rb +1 -2
  262. data/spec/models/me_response_user_spec.rb +1 -2
  263. data/spec/models/nom151_certificate_response_nom151_spec.rb +1 -2
  264. data/spec/models/nom151_certificate_response_spec.rb +1 -2
  265. data/spec/models/nom151_url_response_spec.rb +1 -2
  266. data/spec/models/pagination_meta_spec.rb +1 -2
  267. data/spec/models/placeholders_inner_passcode_delivery_spec.rb +46 -0
  268. data/spec/models/placeholders_inner_spec.rb +7 -2
  269. data/spec/models/rate_limit_error_response_spec.rb +1 -2
  270. data/spec/models/recipients_inner_passcode_delivery_spec.rb +46 -0
  271. data/spec/models/recipients_inner_spec.rb +31 -2
  272. data/spec/models/reminder_recipients_inner_spec.rb +1 -2
  273. data/spec/models/send_reminder_request_spec.rb +1 -2
  274. data/spec/models/template_attachment_requests_inner_spec.rb +1 -2
  275. data/spec/models/template_checkbox_groups_inner_spec.rb +1 -2
  276. data/spec/models/template_field_values_inner_spec.rb +1 -2
  277. data/spec/models/template_field_values_inner_value_spec.rb +1 -2
  278. data/spec/models/template_fields_inner_inner_spec.rb +13 -2
  279. data/spec/models/template_recipients_inner_spec.rb +31 -2
  280. data/spec/models/text_validation_spec.rb +1 -2
  281. data/spec/models/update_authentication_request_recipients_inner_spec.rb +46 -0
  282. data/spec/models/update_authentication_request_spec.rb +34 -0
  283. data/spec/models/update_document_and_send_request_spec.rb +19 -2
  284. data/spec/models/update_recipients_map_inner_passcode_delivery_spec.rb +46 -0
  285. data/spec/models/update_recipients_map_inner_spec.rb +7 -2
  286. data/spec/models/update_recipients_request_spec.rb +1 -2
  287. data/spec/models/validation_error_response_spec.rb +1 -2
  288. data/spec/models/webhook_response_spec.rb +1 -2
  289. data/spec/regressions/api_client_spec.rb +56 -1
  290. data/spec/spec_helper.rb +1 -2
  291. metadata +73 -3
@@ -6,8 +6,7 @@ API for creating, managing, and tracking electronic signature workflows.
6
6
  The version of the OpenAPI document: v1
7
7
  Contact: support@signwell.com
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.12.0
10
-
9
+ Generator version: 7.26.0
11
10
  =end
12
11
 
13
12
  require 'date'
@@ -27,9 +26,11 @@ module SignWell
27
26
  ALPHANUMERIC = "alphanumeric".freeze
28
27
  US_BANK_ROUTING_NUMBER = "us_bank_routing_number".freeze
29
28
  US_BANK_ACCOUNT_NUMBER = "us_bank_account_number".freeze
29
+ CUSTOM = "custom".freeze
30
+ UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
30
31
 
31
32
  def self.all_vars
32
- @all_vars ||= [NO_TEXT_VALIDATION, NUMBERS, LETTERS, EMAIL_ADDRESS, US_PHONE_NUMBER, US_ZIP_CODE, US_SSN, US_AGE, ALPHANUMERIC, US_BANK_ROUTING_NUMBER, US_BANK_ACCOUNT_NUMBER].freeze
33
+ @all_vars ||= [NO_TEXT_VALIDATION, NUMBERS, LETTERS, EMAIL_ADDRESS, US_PHONE_NUMBER, US_ZIP_CODE, US_SSN, US_AGE, ALPHANUMERIC, US_BANK_ROUTING_NUMBER, US_BANK_ACCOUNT_NUMBER, CUSTOM, UNKNOWN_DEFAULT_OPEN_API].freeze
33
34
  end
34
35
 
35
36
  # Builds the enum from string
@@ -44,6 +45,7 @@ module SignWell
44
45
  # @return [String] The enum value
45
46
  def build_from_hash(value)
46
47
  return value if TextValidation.all_vars.include?(value)
48
+ return UNKNOWN_DEFAULT_OPEN_API if value.is_a?(String)
47
49
  raise "Invalid ENUM value #{value} for class #TextValidation"
48
50
  end
49
51
  end
@@ -0,0 +1,243 @@
1
+ =begin
2
+ SignWell Developer API
3
+
4
+ API for creating, managing, and tracking electronic signature workflows.
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: support@signwell.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.26.0
10
+ =end
11
+
12
+ require 'date'
13
+ require 'time'
14
+
15
+ module SignWell
16
+ module Models
17
+ class UpdateAuthenticationRequest
18
+ # Recipients whose authentication settings should be updated.
19
+ # @return [Array<UpdateAuthenticationRequestRecipientsInner>]
20
+ attr_accessor :recipients
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'recipients' => :'recipients'
26
+ }
27
+ end
28
+
29
+ # Returns attribute mapping this model knows about
30
+ def self.acceptable_attribute_map
31
+ attribute_map
32
+ end
33
+
34
+ # Returns all the JSON keys this model knows about
35
+ def self.acceptable_attributes
36
+ acceptable_attribute_map.values
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.openapi_types
41
+ {
42
+ :'recipients' => :'Array<UpdateAuthenticationRequestRecipientsInner>'
43
+ }
44
+ end
45
+
46
+ # List of attributes with nullable: true
47
+ def self.openapi_nullable
48
+ Set.new([
49
+ ])
50
+ end
51
+
52
+ # Initializes the object
53
+ # @param [Hash] attributes Model attributes in the form of hash
54
+ def initialize(attributes = {})
55
+ if (!attributes.is_a?(Hash))
56
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::UpdateAuthenticationRequest` initialize method"
57
+ end
58
+
59
+ # check to see if the attribute exists and convert string to symbol for hash key
60
+ acceptable_attribute_map = self.class.acceptable_attribute_map
61
+ attributes = attributes.each_with_object({}) { |(k, v), h|
62
+ if (!acceptable_attribute_map.key?(k.to_sym))
63
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::UpdateAuthenticationRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
64
+ end
65
+ h[k.to_sym] = v
66
+ }
67
+
68
+ if attributes.key?(:'recipients')
69
+ if (value = attributes[:'recipients']).is_a?(Array)
70
+ self.recipients = value
71
+ end
72
+ else
73
+ self.recipients = nil
74
+ end
75
+ end
76
+
77
+
78
+ # Show invalid properties with the reasons. Usually used together with valid?
79
+ # @return Array for valid properties with the reasons
80
+ def list_invalid_properties
81
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
82
+ invalid_properties = Array.new
83
+ if @recipients.nil?
84
+ invalid_properties.push('invalid value for "recipients", recipients cannot be nil.')
85
+ end
86
+
87
+ invalid_properties
88
+ end
89
+
90
+ # Check to see if the all the properties in the model are valid
91
+ # @return true if the model is valid
92
+ def valid?
93
+ warn '[DEPRECATED] the `valid?` method is obsolete'
94
+ return false if @recipients.nil?
95
+ true
96
+ end
97
+
98
+ # Custom attribute writer method with validation
99
+ # @param [Object] recipients Value to be assigned
100
+ def recipients=(recipients)
101
+ if recipients.nil?
102
+ fail ArgumentError, 'recipients cannot be nil'
103
+ end
104
+
105
+ @recipients = recipients
106
+ end
107
+
108
+ # Checks equality by comparing each attribute.
109
+ # @param [Object] other Object to be compared
110
+ def ==(o)
111
+ return true if self.equal?(o)
112
+ self.class == o.class &&
113
+ recipients == o.recipients
114
+ end
115
+
116
+ # @see the `==` method
117
+ # @param [Object] other Object to be compared
118
+ def eql?(o)
119
+ self == o
120
+ end
121
+
122
+ # Calculates hash code according to all attributes.
123
+ # @return [Integer] Hash code
124
+ def hash
125
+ [recipients].hash
126
+ end
127
+
128
+ # Builds the object from hash
129
+ # @param [Hash] attributes Model attributes in the form of hash
130
+ # @return [Object] Returns the model itself
131
+ def self.build_from_hash(attributes)
132
+ return nil unless attributes.is_a?(Hash)
133
+ attributes = attributes.transform_keys(&:to_sym)
134
+ transformed_hash = {}
135
+ openapi_types.each_pair do |key, type|
136
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
137
+ transformed_hash["#{key}"] = nil
138
+ elsif type =~ /\AArray<(.*)>/i
139
+ # check to ensure the input is an array given that the attribute
140
+ # is documented as an array but the input is not
141
+ if attributes[attribute_map[key]].is_a?(Array)
142
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
143
+ end
144
+ elsif !attributes[attribute_map[key]].nil?
145
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
146
+ end
147
+ end
148
+ new(transformed_hash)
149
+ end
150
+
151
+ # Deserializes the data based on type
152
+ # @param [String] type Data type
153
+ # @param [String] value Value to be deserialized
154
+ # @return [Object] Deserialized data
155
+ def self._deserialize(type, value)
156
+ case type.to_sym
157
+ when :Time
158
+ Time.parse(value)
159
+ when :Date
160
+ Date.parse(value)
161
+ when :String
162
+ value.to_s
163
+ when :Integer
164
+ value.to_i
165
+ when :Float
166
+ value.to_f
167
+ when :Boolean
168
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
169
+ true
170
+ else
171
+ false
172
+ end
173
+ when :Object
174
+ # generic object (usually a Hash), return directly
175
+ value
176
+ when /\AArray<(?<inner_type>.+)>\z/
177
+ inner_type = Regexp.last_match[:inner_type]
178
+ value.map { |v| _deserialize(inner_type, v) }
179
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
180
+ k_type = Regexp.last_match[:k_type]
181
+ v_type = Regexp.last_match[:v_type]
182
+ {}.tap do |hash|
183
+ value.each do |k, v|
184
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
185
+ end
186
+ end
187
+ else # model
188
+ # models (e.g. Pet) or oneOf
189
+ klass = SignWell::Models.const_get(type)
190
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
191
+ end
192
+ end
193
+
194
+ # Returns the string representation of the object
195
+ # @return [String] String presentation of the object
196
+ def to_s
197
+ to_hash.to_s
198
+ end
199
+
200
+ # to_body is an alias to to_hash (backward compatibility)
201
+ # @return [Hash] Returns the object in the form of hash
202
+ def to_body
203
+ to_hash
204
+ end
205
+
206
+ # Returns the object in the form of hash
207
+ # @return [Hash] Returns the object in the form of hash
208
+ def to_hash
209
+ normalize_for_serialization! if respond_to?(:normalize_for_serialization!, true)
210
+
211
+ hash = {}
212
+ self.class.attribute_map.each_pair do |attr, param|
213
+ value = self.send(attr)
214
+ if value.nil?
215
+ is_nullable = self.class.openapi_nullable.include?(attr)
216
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
217
+ end
218
+
219
+ hash[param] = _to_hash(value)
220
+ end
221
+ hash
222
+ end
223
+
224
+ # Outputs non-array value in the form of hash
225
+ # For object, use to_hash. Otherwise, just return the value
226
+ # @param [Object] value Any valid value
227
+ # @return [Hash] Returns the value in the form of hash
228
+ def _to_hash(value)
229
+ if value.is_a?(Array)
230
+ value.compact.map { |v| _to_hash(v) }
231
+ elsif value.is_a?(Hash)
232
+ {}.tap do |hash|
233
+ value.each { |k, v| hash[k] = _to_hash(v) }
234
+ end
235
+ elsif value.respond_to? :to_hash
236
+ value.to_hash
237
+ else
238
+ value
239
+ end
240
+ end
241
+ end
242
+ end
243
+ end
@@ -0,0 +1,262 @@
1
+ =begin
2
+ SignWell Developer API
3
+
4
+ API for creating, managing, and tracking electronic signature workflows.
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: support@signwell.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.26.0
10
+ =end
11
+
12
+ require 'date'
13
+ require 'time'
14
+
15
+ module SignWell
16
+ module Models
17
+ class UpdateAuthenticationRequestRecipientsInner
18
+ # A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more.
19
+ # @return [String]
20
+ attr_accessor :id
21
+
22
+ # Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422.
23
+ # @return [String]
24
+ attr_accessor :passcode
25
+
26
+ # @return [UpdateRecipientsMapInnerPasscodeDelivery]
27
+ attr_accessor :passcode_delivery
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'id' => :'id',
33
+ :'passcode' => :'passcode',
34
+ :'passcode_delivery' => :'passcode_delivery'
35
+ }
36
+ end
37
+
38
+ # Returns attribute mapping this model knows about
39
+ def self.acceptable_attribute_map
40
+ attribute_map
41
+ end
42
+
43
+ # Returns all the JSON keys this model knows about
44
+ def self.acceptable_attributes
45
+ acceptable_attribute_map.values
46
+ end
47
+
48
+ # Attribute type mapping.
49
+ def self.openapi_types
50
+ {
51
+ :'id' => :'String',
52
+ :'passcode' => :'String',
53
+ :'passcode_delivery' => :'UpdateRecipientsMapInnerPasscodeDelivery'
54
+ }
55
+ end
56
+
57
+ # List of attributes with nullable: true
58
+ def self.openapi_nullable
59
+ Set.new([
60
+ ])
61
+ end
62
+
63
+ # Initializes the object
64
+ # @param [Hash] attributes Model attributes in the form of hash
65
+ def initialize(attributes = {})
66
+ if (!attributes.is_a?(Hash))
67
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::UpdateAuthenticationRequestRecipientsInner` initialize method"
68
+ end
69
+
70
+ # check to see if the attribute exists and convert string to symbol for hash key
71
+ acceptable_attribute_map = self.class.acceptable_attribute_map
72
+ attributes = attributes.each_with_object({}) { |(k, v), h|
73
+ if (!acceptable_attribute_map.key?(k.to_sym))
74
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::UpdateAuthenticationRequestRecipientsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
75
+ end
76
+ h[k.to_sym] = v
77
+ }
78
+
79
+ if attributes.key?(:'id')
80
+ self.id = attributes[:'id']
81
+ else
82
+ self.id = nil
83
+ end
84
+
85
+ if attributes.key?(:'passcode')
86
+ self.passcode = attributes[:'passcode']
87
+ end
88
+
89
+ if attributes.key?(:'passcode_delivery')
90
+ self.passcode_delivery = attributes[:'passcode_delivery']
91
+ end
92
+ end
93
+
94
+
95
+ # Show invalid properties with the reasons. Usually used together with valid?
96
+ # @return Array for valid properties with the reasons
97
+ def list_invalid_properties
98
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
99
+ invalid_properties = Array.new
100
+ if @id.nil?
101
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
102
+ end
103
+
104
+ invalid_properties
105
+ end
106
+
107
+ # Check to see if the all the properties in the model are valid
108
+ # @return true if the model is valid
109
+ def valid?
110
+ warn '[DEPRECATED] the `valid?` method is obsolete'
111
+ return false if @id.nil?
112
+ true
113
+ end
114
+
115
+ # Custom attribute writer method with validation
116
+ # @param [Object] id Value to be assigned
117
+ def id=(id)
118
+ if id.nil?
119
+ fail ArgumentError, 'id cannot be nil'
120
+ end
121
+
122
+ @id = id
123
+ end
124
+
125
+ # Checks equality by comparing each attribute.
126
+ # @param [Object] other Object to be compared
127
+ def ==(o)
128
+ return true if self.equal?(o)
129
+ self.class == o.class &&
130
+ id == o.id &&
131
+ passcode == o.passcode &&
132
+ passcode_delivery == o.passcode_delivery
133
+ end
134
+
135
+ # @see the `==` method
136
+ # @param [Object] other Object to be compared
137
+ def eql?(o)
138
+ self == o
139
+ end
140
+
141
+ # Calculates hash code according to all attributes.
142
+ # @return [Integer] Hash code
143
+ def hash
144
+ [id, passcode, passcode_delivery].hash
145
+ end
146
+
147
+ # Builds the object from hash
148
+ # @param [Hash] attributes Model attributes in the form of hash
149
+ # @return [Object] Returns the model itself
150
+ def self.build_from_hash(attributes)
151
+ return nil unless attributes.is_a?(Hash)
152
+ attributes = attributes.transform_keys(&:to_sym)
153
+ transformed_hash = {}
154
+ openapi_types.each_pair do |key, type|
155
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
156
+ transformed_hash["#{key}"] = nil
157
+ elsif type =~ /\AArray<(.*)>/i
158
+ # check to ensure the input is an array given that the attribute
159
+ # is documented as an array but the input is not
160
+ if attributes[attribute_map[key]].is_a?(Array)
161
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
162
+ end
163
+ elsif !attributes[attribute_map[key]].nil?
164
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
165
+ end
166
+ end
167
+ new(transformed_hash)
168
+ end
169
+
170
+ # Deserializes the data based on type
171
+ # @param [String] type Data type
172
+ # @param [String] value Value to be deserialized
173
+ # @return [Object] Deserialized data
174
+ def self._deserialize(type, value)
175
+ case type.to_sym
176
+ when :Time
177
+ Time.parse(value)
178
+ when :Date
179
+ Date.parse(value)
180
+ when :String
181
+ value.to_s
182
+ when :Integer
183
+ value.to_i
184
+ when :Float
185
+ value.to_f
186
+ when :Boolean
187
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
188
+ true
189
+ else
190
+ false
191
+ end
192
+ when :Object
193
+ # generic object (usually a Hash), return directly
194
+ value
195
+ when /\AArray<(?<inner_type>.+)>\z/
196
+ inner_type = Regexp.last_match[:inner_type]
197
+ value.map { |v| _deserialize(inner_type, v) }
198
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
199
+ k_type = Regexp.last_match[:k_type]
200
+ v_type = Regexp.last_match[:v_type]
201
+ {}.tap do |hash|
202
+ value.each do |k, v|
203
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
204
+ end
205
+ end
206
+ else # model
207
+ # models (e.g. Pet) or oneOf
208
+ klass = SignWell::Models.const_get(type)
209
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
210
+ end
211
+ end
212
+
213
+ # Returns the string representation of the object
214
+ # @return [String] String presentation of the object
215
+ def to_s
216
+ to_hash.to_s
217
+ end
218
+
219
+ # to_body is an alias to to_hash (backward compatibility)
220
+ # @return [Hash] Returns the object in the form of hash
221
+ def to_body
222
+ to_hash
223
+ end
224
+
225
+ # Returns the object in the form of hash
226
+ # @return [Hash] Returns the object in the form of hash
227
+ def to_hash
228
+ normalize_for_serialization! if respond_to?(:normalize_for_serialization!, true)
229
+
230
+ hash = {}
231
+ self.class.attribute_map.each_pair do |attr, param|
232
+ value = self.send(attr)
233
+ if value.nil?
234
+ is_nullable = self.class.openapi_nullable.include?(attr)
235
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
236
+ end
237
+
238
+ hash[param] = _to_hash(value)
239
+ end
240
+ hash
241
+ end
242
+
243
+ # Outputs non-array value in the form of hash
244
+ # For object, use to_hash. Otherwise, just return the value
245
+ # @param [Object] value Any valid value
246
+ # @return [Hash] Returns the value in the form of hash
247
+ def _to_hash(value)
248
+ if value.is_a?(Array)
249
+ value.compact.map { |v| _to_hash(v) }
250
+ elsif value.is_a?(Hash)
251
+ {}.tap do |hash|
252
+ value.each { |k, v| hash[k] = _to_hash(v) }
253
+ end
254
+ elsif value.respond_to? :to_hash
255
+ value.to_hash
256
+ else
257
+ value
258
+ end
259
+ end
260
+ end
261
+ end
262
+ end