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'
@@ -58,6 +57,14 @@ module SignWell
58
57
  # @return [TextValidation]
59
58
  attr_accessor :validation
60
59
 
60
+ # Text fields with custom validation only: the regex pattern used to validate field values. Required when validation is set to custom.
61
+ # @return [String]
62
+ attr_accessor :validation_regex
63
+
64
+ # Text fields with custom validation only: the error message shown to the recipient when their input doesn't match the regex pattern. Required when validation is set to custom.
65
+ # @return [String]
66
+ attr_accessor :validation_regex_error_message
67
+
61
68
  # @return [DocumentResponseFieldsInnerInnerValue]
62
69
  attr_accessor :value
63
70
 
@@ -127,6 +134,8 @@ module SignWell
127
134
  :'required' => :'required',
128
135
  :'type' => :'type',
129
136
  :'validation' => :'validation',
137
+ :'validation_regex' => :'validation_regex',
138
+ :'validation_regex_error_message' => :'validation_regex_error_message',
130
139
  :'value' => :'value',
131
140
  :'height' => :'height',
132
141
  :'width' => :'width',
@@ -166,6 +175,8 @@ module SignWell
166
175
  :'required' => :'Boolean',
167
176
  :'type' => :'FieldType',
168
177
  :'validation' => :'TextValidation',
178
+ :'validation_regex' => :'String',
179
+ :'validation_regex_error_message' => :'String',
169
180
  :'value' => :'DocumentResponseFieldsInnerInnerValue',
170
181
  :'height' => :'String',
171
182
  :'width' => :'String',
@@ -265,6 +276,14 @@ module SignWell
265
276
  self.validation = attributes[:'validation']
266
277
  end
267
278
 
279
+ if attributes.key?(:'validation_regex')
280
+ self.validation_regex = attributes[:'validation_regex']
281
+ end
282
+
283
+ if attributes.key?(:'validation_regex_error_message')
284
+ self.validation_regex_error_message = attributes[:'validation_regex_error_message']
285
+ end
286
+
268
287
  if attributes.key?(:'value')
269
288
  self.value = attributes[:'value']
270
289
  end
@@ -408,6 +427,8 @@ module SignWell
408
427
  required == o.required &&
409
428
  type == o.type &&
410
429
  validation == o.validation &&
430
+ validation_regex == o.validation_regex &&
431
+ validation_regex_error_message == o.validation_regex_error_message &&
411
432
  value == o.value &&
412
433
  height == o.height &&
413
434
  width == o.width &&
@@ -428,7 +449,7 @@ module SignWell
428
449
  # Calculates hash code according to all attributes.
429
450
  # @return [Integer] Hash code
430
451
  def hash
431
- [x, y, page, recipient, api_id, name, date_format, fixed_width, formula, label, lock_sign_date, required, type, validation, value, height, width, recipient_id, signing_elements_group_id, placeholder_name, options, default_option, allow_other].hash
452
+ [x, y, page, recipient, api_id, name, date_format, fixed_width, formula, label, lock_sign_date, required, type, validation, validation_regex, validation_regex_error_message, value, height, width, recipient_id, signing_elements_group_id, placeholder_name, options, default_option, allow_other].hash
432
453
  end
433
454
 
434
455
  # Builds the object from hash
@@ -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'
@@ -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'
@@ -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'
@@ -41,7 +40,7 @@ module SignWell
41
40
  begin
42
41
  next if klass == :AnyType # "nullable: true"
43
42
  typed_data = find_and_cast_into_type(klass, data)
44
- return typed_data if typed_data
43
+ return typed_data unless typed_data.nil?
45
44
  rescue SchemaMismatchError
46
45
  next
47
46
  end
@@ -62,7 +61,7 @@ module SignWell
62
61
  when 'Boolean'
63
62
  return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
64
63
  when 'Float'
65
- return data if data.instance_of?(Float)
64
+ return data if data.instance_of?(Float) || data.instance_of?(Integer)
66
65
  when 'Integer'
67
66
  return data if data.instance_of?(Integer)
68
67
  when 'Time'
@@ -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'
@@ -40,6 +39,13 @@ module SignWell
40
39
  # @return [Integer]
41
40
  attr_accessor :send_email_delay
42
41
 
42
+ # How the recipient is notified: email (default), sms, or email_and_sms.
43
+ # @return [String]
44
+ attr_accessor :delivery_method
45
+
46
+ # @return [DocumentResponseRecipientsInnerSms]
47
+ attr_accessor :sms
48
+
43
49
  # @return [Integer]
44
50
  attr_accessor :signing_order
45
51
 
@@ -61,9 +67,34 @@ module SignWell
61
67
  # @return [String]
62
68
  attr_accessor :passcode
63
69
 
70
+ # @return [DocumentResponseRecipientsInnerPasscodeDelivery]
71
+ attr_accessor :passcode_delivery
72
+
64
73
  # @return [String]
65
74
  attr_accessor :status
66
75
 
76
+ class EnumAttributeValidator
77
+ attr_reader :datatype
78
+ attr_reader :allowable_values
79
+
80
+ def initialize(datatype, allowable_values)
81
+ @allowable_values = allowable_values.map do |value|
82
+ case datatype.to_s
83
+ when /Integer/i
84
+ value.to_i
85
+ when /Float/i
86
+ value.to_f
87
+ else
88
+ value
89
+ end
90
+ end
91
+ end
92
+
93
+ def valid?(value)
94
+ !value || allowable_values.include?(value)
95
+ end
96
+ end
97
+
67
98
  # Attribute mapping from ruby-style variable name to JSON key.
68
99
  def self.attribute_map
69
100
  {
@@ -75,6 +106,8 @@ module SignWell
75
106
  :'subject' => :'subject',
76
107
  :'send_email' => :'send_email',
77
108
  :'send_email_delay' => :'send_email_delay',
109
+ :'delivery_method' => :'delivery_method',
110
+ :'sms' => :'sms',
78
111
  :'signing_order' => :'signing_order',
79
112
  :'signing_url' => :'signing_url',
80
113
  :'embedded_signing_url' => :'embedded_signing_url',
@@ -82,6 +115,7 @@ module SignWell
82
115
  :'bounced_details' => :'bounced_details',
83
116
  :'attachment_requests' => :'attachment_requests',
84
117
  :'passcode' => :'passcode',
118
+ :'passcode_delivery' => :'passcode_delivery',
85
119
  :'status' => :'status'
86
120
  }
87
121
  end
@@ -107,6 +141,8 @@ module SignWell
107
141
  :'subject' => :'String',
108
142
  :'send_email' => :'Boolean',
109
143
  :'send_email_delay' => :'Integer',
144
+ :'delivery_method' => :'String',
145
+ :'sms' => :'DocumentResponseRecipientsInnerSms',
110
146
  :'signing_order' => :'Integer',
111
147
  :'signing_url' => :'String',
112
148
  :'embedded_signing_url' => :'String',
@@ -114,6 +150,7 @@ module SignWell
114
150
  :'bounced_details' => :'String',
115
151
  :'attachment_requests' => :'Array<AttachmentRequestInfo>',
116
152
  :'passcode' => :'String',
153
+ :'passcode_delivery' => :'DocumentResponseRecipientsInnerPasscodeDelivery',
117
154
  :'status' => :'String'
118
155
  }
119
156
  end
@@ -186,6 +223,14 @@ module SignWell
186
223
  self.send_email_delay = attributes[:'send_email_delay']
187
224
  end
188
225
 
226
+ if attributes.key?(:'delivery_method')
227
+ self.delivery_method = attributes[:'delivery_method']
228
+ end
229
+
230
+ if attributes.key?(:'sms')
231
+ self.sms = attributes[:'sms']
232
+ end
233
+
189
234
  if attributes.key?(:'signing_order')
190
235
  self.signing_order = attributes[:'signing_order']
191
236
  end
@@ -216,6 +261,10 @@ module SignWell
216
261
  self.passcode = attributes[:'passcode']
217
262
  end
218
263
 
264
+ if attributes.key?(:'passcode_delivery')
265
+ self.passcode_delivery = attributes[:'passcode_delivery']
266
+ end
267
+
219
268
  if attributes.key?(:'status')
220
269
  self.status = attributes[:'status']
221
270
  end
@@ -244,6 +293,8 @@ module SignWell
244
293
  warn '[DEPRECATED] the `valid?` method is obsolete'
245
294
  return false if @name.nil?
246
295
  return false if @email.nil?
296
+ delivery_method_validator = EnumAttributeValidator.new('String', %w[email sms email_and_sms unknown_default_open_api])
297
+ return false unless delivery_method_validator.valid?(@delivery_method)
247
298
  true
248
299
  end
249
300
 
@@ -267,6 +318,20 @@ module SignWell
267
318
  @email = email
268
319
  end
269
320
 
321
+ # Custom attribute writer method checking allowed values (enum).
322
+ # @param [Object] delivery_method Object to be assigned
323
+ def delivery_method=(delivery_method)
324
+ validator = EnumAttributeValidator.new('String', %w[email sms email_and_sms unknown_default_open_api])
325
+ unless validator.valid?(delivery_method)
326
+ if delivery_method.is_a?(String)
327
+ delivery_method = "unknown_default_open_api"
328
+ else
329
+ fail ArgumentError, "invalid value for \"delivery_method\", must be one of #{validator.allowable_values}."
330
+ end
331
+ end
332
+ @delivery_method = delivery_method
333
+ end
334
+
270
335
  # Checks equality by comparing each attribute.
271
336
  # @param [Object] other Object to be compared
272
337
  def ==(o)
@@ -280,6 +345,8 @@ module SignWell
280
345
  subject == o.subject &&
281
346
  send_email == o.send_email &&
282
347
  send_email_delay == o.send_email_delay &&
348
+ delivery_method == o.delivery_method &&
349
+ sms == o.sms &&
283
350
  signing_order == o.signing_order &&
284
351
  signing_url == o.signing_url &&
285
352
  embedded_signing_url == o.embedded_signing_url &&
@@ -287,6 +354,7 @@ module SignWell
287
354
  bounced_details == o.bounced_details &&
288
355
  attachment_requests == o.attachment_requests &&
289
356
  passcode == o.passcode &&
357
+ passcode_delivery == o.passcode_delivery &&
290
358
  status == o.status
291
359
  end
292
360
 
@@ -299,7 +367,7 @@ module SignWell
299
367
  # Calculates hash code according to all attributes.
300
368
  # @return [Integer] Hash code
301
369
  def hash
302
- [id, name, email, body, message, subject, send_email, send_email_delay, signing_order, signing_url, embedded_signing_url, bounced, bounced_details, attachment_requests, passcode, status].hash
370
+ [id, name, email, body, message, subject, send_email, send_email_delay, delivery_method, sms, signing_order, signing_url, embedded_signing_url, bounced, bounced_details, attachment_requests, passcode, passcode_delivery, status].hash
303
371
  end
304
372
 
305
373
  # Builds the object from hash
@@ -0,0 +1,246 @@
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 DocumentResponseRecipientsInnerPasscodeDelivery
18
+ # @return [Boolean]
19
+ attr_accessor :enabled
20
+
21
+ # @return [Array<String>]
22
+ attr_accessor :methods
23
+
24
+ # @return [Boolean]
25
+ attr_accessor :expire_after_access
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+ :'enabled' => :'enabled',
31
+ :'methods' => :'methods',
32
+ :'expire_after_access' => :'expire_after_access'
33
+ }
34
+ end
35
+
36
+ # Returns attribute mapping this model knows about
37
+ def self.acceptable_attribute_map
38
+ attribute_map
39
+ end
40
+
41
+ # Returns all the JSON keys this model knows about
42
+ def self.acceptable_attributes
43
+ acceptable_attribute_map.values
44
+ end
45
+
46
+ # Attribute type mapping.
47
+ def self.openapi_types
48
+ {
49
+ :'enabled' => :'Boolean',
50
+ :'methods' => :'Array<String>',
51
+ :'expire_after_access' => :'Boolean'
52
+ }
53
+ end
54
+
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ :'methods',
59
+ ])
60
+ end
61
+
62
+ # Initializes the object
63
+ # @param [Hash] attributes Model attributes in the form of hash
64
+ def initialize(attributes = {})
65
+ if (!attributes.is_a?(Hash))
66
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::DocumentResponseRecipientsInnerPasscodeDelivery` initialize method"
67
+ end
68
+
69
+ # check to see if the attribute exists and convert string to symbol for hash key
70
+ acceptable_attribute_map = self.class.acceptable_attribute_map
71
+ attributes = attributes.each_with_object({}) { |(k, v), h|
72
+ if (!acceptable_attribute_map.key?(k.to_sym))
73
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::DocumentResponseRecipientsInnerPasscodeDelivery`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
74
+ end
75
+ h[k.to_sym] = v
76
+ }
77
+
78
+ if attributes.key?(:'enabled')
79
+ self.enabled = attributes[:'enabled']
80
+ end
81
+
82
+ if attributes.key?(:'methods')
83
+ if (value = attributes[:'methods']).is_a?(Array)
84
+ self.methods = value
85
+ end
86
+ end
87
+
88
+ if attributes.key?(:'expire_after_access')
89
+ self.expire_after_access = attributes[:'expire_after_access']
90
+ end
91
+ end
92
+
93
+
94
+ # Show invalid properties with the reasons. Usually used together with valid?
95
+ # @return Array for valid properties with the reasons
96
+ def list_invalid_properties
97
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
98
+ invalid_properties = Array.new
99
+ invalid_properties
100
+ end
101
+
102
+ # Check to see if the all the properties in the model are valid
103
+ # @return true if the model is valid
104
+ def valid?
105
+ warn '[DEPRECATED] the `valid?` method is obsolete'
106
+ true
107
+ end
108
+
109
+ # Checks equality by comparing each attribute.
110
+ # @param [Object] other Object to be compared
111
+ def ==(o)
112
+ return true if self.equal?(o)
113
+ self.class == o.class &&
114
+ enabled == o.enabled &&
115
+ methods == o.methods &&
116
+ expire_after_access == o.expire_after_access
117
+ end
118
+
119
+ # @see the `==` method
120
+ # @param [Object] other Object to be compared
121
+ def eql?(o)
122
+ self == o
123
+ end
124
+
125
+ # Calculates hash code according to all attributes.
126
+ # @return [Integer] Hash code
127
+ def hash
128
+ [enabled, methods, expire_after_access].hash
129
+ end
130
+
131
+ # Builds the object from hash
132
+ # @param [Hash] attributes Model attributes in the form of hash
133
+ # @return [Object] Returns the model itself
134
+ def self.build_from_hash(attributes)
135
+ return nil unless attributes.is_a?(Hash)
136
+ attributes = attributes.transform_keys(&:to_sym)
137
+ transformed_hash = {}
138
+ openapi_types.each_pair do |key, type|
139
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
140
+ transformed_hash["#{key}"] = nil
141
+ elsif type =~ /\AArray<(.*)>/i
142
+ # check to ensure the input is an array given that the attribute
143
+ # is documented as an array but the input is not
144
+ if attributes[attribute_map[key]].is_a?(Array)
145
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
146
+ end
147
+ elsif !attributes[attribute_map[key]].nil?
148
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
149
+ end
150
+ end
151
+ new(transformed_hash)
152
+ end
153
+
154
+ # Deserializes the data based on type
155
+ # @param [String] type Data type
156
+ # @param [String] value Value to be deserialized
157
+ # @return [Object] Deserialized data
158
+ def self._deserialize(type, value)
159
+ case type.to_sym
160
+ when :Time
161
+ Time.parse(value)
162
+ when :Date
163
+ Date.parse(value)
164
+ when :String
165
+ value.to_s
166
+ when :Integer
167
+ value.to_i
168
+ when :Float
169
+ value.to_f
170
+ when :Boolean
171
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
172
+ true
173
+ else
174
+ false
175
+ end
176
+ when :Object
177
+ # generic object (usually a Hash), return directly
178
+ value
179
+ when /\AArray<(?<inner_type>.+)>\z/
180
+ inner_type = Regexp.last_match[:inner_type]
181
+ value.map { |v| _deserialize(inner_type, v) }
182
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
183
+ k_type = Regexp.last_match[:k_type]
184
+ v_type = Regexp.last_match[:v_type]
185
+ {}.tap do |hash|
186
+ value.each do |k, v|
187
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
188
+ end
189
+ end
190
+ else # model
191
+ # models (e.g. Pet) or oneOf
192
+ klass = SignWell::Models.const_get(type)
193
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
194
+ end
195
+ end
196
+
197
+ # Returns the string representation of the object
198
+ # @return [String] String presentation of the object
199
+ def to_s
200
+ to_hash.to_s
201
+ end
202
+
203
+ # to_body is an alias to to_hash (backward compatibility)
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_body
206
+ to_hash
207
+ end
208
+
209
+ # Returns the object in the form of hash
210
+ # @return [Hash] Returns the object in the form of hash
211
+ def to_hash
212
+ normalize_for_serialization! if respond_to?(:normalize_for_serialization!, true)
213
+
214
+ hash = {}
215
+ self.class.attribute_map.each_pair do |attr, param|
216
+ value = self.send(attr)
217
+ if value.nil?
218
+ is_nullable = self.class.openapi_nullable.include?(attr)
219
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
220
+ end
221
+
222
+ hash[param] = _to_hash(value)
223
+ end
224
+ hash
225
+ end
226
+
227
+ # Outputs non-array value in the form of hash
228
+ # For object, use to_hash. Otherwise, just return the value
229
+ # @param [Object] value Any valid value
230
+ # @return [Hash] Returns the value in the form of hash
231
+ def _to_hash(value)
232
+ if value.is_a?(Array)
233
+ value.compact.map { |v| _to_hash(v) }
234
+ elsif value.is_a?(Hash)
235
+ {}.tap do |hash|
236
+ value.each { |k, v| hash[k] = _to_hash(v) }
237
+ end
238
+ elsif value.respond_to? :to_hash
239
+ value.to_hash
240
+ else
241
+ value
242
+ end
243
+ end
244
+ end
245
+ end
246
+ end