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
@@ -0,0 +1,225 @@
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
+ # Optional container for embedded settings. Purely additive: requests that omit it behave exactly as before, and the existing top-level `api_application_id`, `embedded_signing` and `embedded_signing_notifications` parameters are unchanged. Not supported on template endpoints, which return a `422` if it is present.
18
+ class EmbeddedRequest
19
+ # @return [EmbeddedBrandingRequest]
20
+ attr_accessor :branding
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'branding' => :'branding'
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
+ :'branding' => :'EmbeddedBrandingRequest'
43
+ }
44
+ end
45
+
46
+ # List of attributes with nullable: true
47
+ def self.openapi_nullable
48
+ Set.new([
49
+ :'branding'
50
+ ])
51
+ end
52
+
53
+ # Initializes the object
54
+ # @param [Hash] attributes Model attributes in the form of hash
55
+ def initialize(attributes = {})
56
+ if (!attributes.is_a?(Hash))
57
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::EmbeddedRequest` initialize method"
58
+ end
59
+
60
+ # check to see if the attribute exists and convert string to symbol for hash key
61
+ acceptable_attribute_map = self.class.acceptable_attribute_map
62
+ attributes = attributes.each_with_object({}) { |(k, v), h|
63
+ if (!acceptable_attribute_map.key?(k.to_sym))
64
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::EmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
65
+ end
66
+ h[k.to_sym] = v
67
+ }
68
+
69
+ if attributes.key?(:'branding')
70
+ self.branding = attributes[:'branding']
71
+ end
72
+ end
73
+
74
+
75
+ # Show invalid properties with the reasons. Usually used together with valid?
76
+ # @return Array for valid properties with the reasons
77
+ def list_invalid_properties
78
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
79
+ invalid_properties = Array.new
80
+ invalid_properties
81
+ end
82
+
83
+ # Check to see if the all the properties in the model are valid
84
+ # @return true if the model is valid
85
+ def valid?
86
+ warn '[DEPRECATED] the `valid?` method is obsolete'
87
+ true
88
+ end
89
+
90
+ # Checks equality by comparing each attribute.
91
+ # @param [Object] other Object to be compared
92
+ def ==(o)
93
+ return true if self.equal?(o)
94
+ self.class == o.class &&
95
+ branding == o.branding
96
+ end
97
+
98
+ # @see the `==` method
99
+ # @param [Object] other Object to be compared
100
+ def eql?(o)
101
+ self == o
102
+ end
103
+
104
+ # Calculates hash code according to all attributes.
105
+ # @return [Integer] Hash code
106
+ def hash
107
+ [branding].hash
108
+ end
109
+
110
+ # Builds the object from hash
111
+ # @param [Hash] attributes Model attributes in the form of hash
112
+ # @return [Object] Returns the model itself
113
+ def self.build_from_hash(attributes)
114
+ return nil unless attributes.is_a?(Hash)
115
+ attributes = attributes.transform_keys(&:to_sym)
116
+ transformed_hash = {}
117
+ openapi_types.each_pair do |key, type|
118
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
119
+ transformed_hash["#{key}"] = nil
120
+ elsif type =~ /\AArray<(.*)>/i
121
+ # check to ensure the input is an array given that the attribute
122
+ # is documented as an array but the input is not
123
+ if attributes[attribute_map[key]].is_a?(Array)
124
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
125
+ end
126
+ elsif !attributes[attribute_map[key]].nil?
127
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
128
+ end
129
+ end
130
+ new(transformed_hash)
131
+ end
132
+
133
+ # Deserializes the data based on type
134
+ # @param [String] type Data type
135
+ # @param [String] value Value to be deserialized
136
+ # @return [Object] Deserialized data
137
+ def self._deserialize(type, value)
138
+ case type.to_sym
139
+ when :Time
140
+ Time.parse(value)
141
+ when :Date
142
+ Date.parse(value)
143
+ when :String
144
+ value.to_s
145
+ when :Integer
146
+ value.to_i
147
+ when :Float
148
+ value.to_f
149
+ when :Boolean
150
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
151
+ true
152
+ else
153
+ false
154
+ end
155
+ when :Object
156
+ # generic object (usually a Hash), return directly
157
+ value
158
+ when /\AArray<(?<inner_type>.+)>\z/
159
+ inner_type = Regexp.last_match[:inner_type]
160
+ value.map { |v| _deserialize(inner_type, v) }
161
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
162
+ k_type = Regexp.last_match[:k_type]
163
+ v_type = Regexp.last_match[:v_type]
164
+ {}.tap do |hash|
165
+ value.each do |k, v|
166
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
167
+ end
168
+ end
169
+ else # model
170
+ # models (e.g. Pet) or oneOf
171
+ klass = SignWell::Models.const_get(type)
172
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
173
+ end
174
+ end
175
+
176
+ # Returns the string representation of the object
177
+ # @return [String] String presentation of the object
178
+ def to_s
179
+ to_hash.to_s
180
+ end
181
+
182
+ # to_body is an alias to to_hash (backward compatibility)
183
+ # @return [Hash] Returns the object in the form of hash
184
+ def to_body
185
+ to_hash
186
+ end
187
+
188
+ # Returns the object in the form of hash
189
+ # @return [Hash] Returns the object in the form of hash
190
+ def to_hash
191
+ normalize_for_serialization! if respond_to?(:normalize_for_serialization!, true)
192
+
193
+ hash = {}
194
+ self.class.attribute_map.each_pair do |attr, param|
195
+ value = self.send(attr)
196
+ if value.nil?
197
+ is_nullable = self.class.openapi_nullable.include?(attr)
198
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
199
+ end
200
+
201
+ hash[param] = _to_hash(value)
202
+ end
203
+ hash
204
+ end
205
+
206
+ # Outputs non-array value in the form of hash
207
+ # For object, use to_hash. Otherwise, just return the value
208
+ # @param [Object] value Any valid value
209
+ # @return [Hash] Returns the value in the form of hash
210
+ def _to_hash(value)
211
+ if value.is_a?(Array)
212
+ value.compact.map { |v| _to_hash(v) }
213
+ elsif value.is_a?(Hash)
214
+ {}.tap do |hash|
215
+ value.each { |k, v| hash[k] = _to_hash(v) }
216
+ end
217
+ elsif value.respond_to? :to_hash
218
+ value.to_hash
219
+ else
220
+ value
221
+ end
222
+ end
223
+ end
224
+ end
225
+ end
@@ -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'
@@ -31,9 +30,10 @@ module SignWell
31
30
  AUTOFILL_PHONE = "autofill_phone".freeze
32
31
  AUTOFILL_TITLE = "autofill_title".freeze
33
32
  AUTOFILL_DATE_SIGNED = "autofill_date_signed".freeze
33
+ UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
34
34
 
35
35
  def self.all_vars
36
- @all_vars ||= [INITIALS, SIGNATURE, CHECKBOX, DATE, SELECT, TEXT, DROPDOWN, AUTOFILL_COMPANY, AUTOFILL_EMAIL, AUTOFILL_FIRST_NAME, AUTOFILL_LAST_NAME, AUTOFILL_NAME, AUTOFILL_PHONE, AUTOFILL_TITLE, AUTOFILL_DATE_SIGNED].freeze
36
+ @all_vars ||= [INITIALS, SIGNATURE, CHECKBOX, DATE, SELECT, TEXT, DROPDOWN, AUTOFILL_COMPANY, AUTOFILL_EMAIL, AUTOFILL_FIRST_NAME, AUTOFILL_LAST_NAME, AUTOFILL_NAME, AUTOFILL_PHONE, AUTOFILL_TITLE, AUTOFILL_DATE_SIGNED, UNKNOWN_DEFAULT_OPEN_API].freeze
37
37
  end
38
38
 
39
39
  # Builds the enum from string
@@ -48,6 +48,7 @@ module SignWell
48
48
  # @return [String] The enum value
49
49
  def build_from_hash(value)
50
50
  return value if FieldType.all_vars.include?(value)
51
+ return UNKNOWN_DEFAULT_OPEN_API if value.is_a?(String)
51
52
  raise "Invalid ENUM value #{value} for class #FieldType"
52
53
  end
53
54
  end
@@ -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'
@@ -57,6 +56,14 @@ module SignWell
57
56
  # @return [TextValidation]
58
57
  attr_accessor :validation
59
58
 
59
+ # Text fields with custom validation only: the regex pattern used to validate field values. Required when validation is set to custom.
60
+ # @return [String]
61
+ attr_accessor :validation_regex
62
+
63
+ # 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.
64
+ # @return [String]
65
+ attr_accessor :validation_regex_error_message
66
+
60
67
  # Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to `false` the field width will automatically grow horizontally to fit text on one line. Defaults to `false`.
61
68
  # @return [Boolean]
62
69
  attr_accessor :fixed_width
@@ -124,6 +131,8 @@ module SignWell
124
131
  :'api_id' => :'api_id',
125
132
  :'name' => :'name',
126
133
  :'validation' => :'validation',
134
+ :'validation_regex' => :'validation_regex',
135
+ :'validation_regex_error_message' => :'validation_regex_error_message',
127
136
  :'fixed_width' => :'fixed_width',
128
137
  :'lock_sign_date' => :'lock_sign_date',
129
138
  :'date_format' => :'date_format',
@@ -159,6 +168,8 @@ module SignWell
159
168
  :'api_id' => :'String',
160
169
  :'name' => :'String',
161
170
  :'validation' => :'TextValidation',
171
+ :'validation_regex' => :'String',
172
+ :'validation_regex_error_message' => :'String',
162
173
  :'fixed_width' => :'Boolean',
163
174
  :'lock_sign_date' => :'Boolean',
164
175
  :'date_format' => :'DateFormat',
@@ -248,6 +259,14 @@ module SignWell
248
259
  self.validation = attributes[:'validation']
249
260
  end
250
261
 
262
+ if attributes.key?(:'validation_regex')
263
+ self.validation_regex = attributes[:'validation_regex']
264
+ end
265
+
266
+ if attributes.key?(:'validation_regex_error_message')
267
+ self.validation_regex_error_message = attributes[:'validation_regex_error_message']
268
+ end
269
+
251
270
  if attributes.key?(:'fixed_width')
252
271
  self.fixed_width = attributes[:'fixed_width']
253
272
  else
@@ -420,6 +439,8 @@ module SignWell
420
439
  api_id == o.api_id &&
421
440
  name == o.name &&
422
441
  validation == o.validation &&
442
+ validation_regex == o.validation_regex &&
443
+ validation_regex_error_message == o.validation_regex_error_message &&
423
444
  fixed_width == o.fixed_width &&
424
445
  lock_sign_date == o.lock_sign_date &&
425
446
  date_format == o.date_format &&
@@ -439,7 +460,7 @@ module SignWell
439
460
  # Calculates hash code according to all attributes.
440
461
  # @return [Integer] Hash code
441
462
  def hash
442
- [x, y, page, recipient_id, type, required, label, value, api_id, name, validation, fixed_width, lock_sign_date, date_format, height, width, options, default_option, allow_other].hash
463
+ [x, y, page, recipient_id, type, required, label, value, api_id, name, validation, validation_regex, validation_regex_error_message, fixed_width, lock_sign_date, date_format, height, width, options, default_option, allow_other].hash
443
464
  end
444
465
 
445
466
  # 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'
@@ -18,9 +17,10 @@ module SignWell
18
17
  class FileFormat
19
18
  PDF = "pdf".freeze
20
19
  ZIP = "zip".freeze
20
+ UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
21
21
 
22
22
  def self.all_vars
23
- @all_vars ||= [PDF, ZIP].freeze
23
+ @all_vars ||= [PDF, ZIP, UNKNOWN_DEFAULT_OPEN_API].freeze
24
24
  end
25
25
 
26
26
  # Builds the enum from string
@@ -35,6 +35,7 @@ module SignWell
35
35
  # @return [String] The enum value
36
36
  def build_from_hash(value)
37
37
  return value if FileFormat.all_vars.include?(value)
38
+ return UNKNOWN_DEFAULT_OPEN_API if value.is_a?(String)
38
39
  raise "Invalid ENUM value #{value} for class #FileFormat"
39
40
  end
40
41
  end
@@ -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'
@@ -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'
@@ -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'
@@ -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'
@@ -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'
@@ -24,7 +23,7 @@ module SignWell
24
23
  # @return [String]
25
24
  attr_accessor :name
26
25
 
27
- # In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name.
26
+ # In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name. Every recipient on a 21 CFR Part 11 document needs a name, so leaving it unset means the name has to be supplied when the document is created.
28
27
  # @return [String]
29
28
  attr_accessor :preassigned_recipient_name
30
29
 
@@ -32,13 +31,17 @@ module SignWell
32
31
  # @return [String]
33
32
  attr_accessor :preassigned_recipient_email
34
33
 
34
+ # @return [PlaceholdersInnerPasscodeDelivery]
35
+ attr_accessor :passcode_delivery
36
+
35
37
  # Attribute mapping from ruby-style variable name to JSON key.
36
38
  def self.attribute_map
37
39
  {
38
40
  :'id' => :'id',
39
41
  :'name' => :'name',
40
42
  :'preassigned_recipient_name' => :'preassigned_recipient_name',
41
- :'preassigned_recipient_email' => :'preassigned_recipient_email'
43
+ :'preassigned_recipient_email' => :'preassigned_recipient_email',
44
+ :'passcode_delivery' => :'passcode_delivery'
42
45
  }
43
46
  end
44
47
 
@@ -58,7 +61,8 @@ module SignWell
58
61
  :'id' => :'String',
59
62
  :'name' => :'String',
60
63
  :'preassigned_recipient_name' => :'String',
61
- :'preassigned_recipient_email' => :'String'
64
+ :'preassigned_recipient_email' => :'String',
65
+ :'passcode_delivery' => :'PlaceholdersInnerPasscodeDelivery'
62
66
  }
63
67
  end
64
68
 
@@ -103,6 +107,10 @@ module SignWell
103
107
  if attributes.key?(:'preassigned_recipient_email')
104
108
  self.preassigned_recipient_email = attributes[:'preassigned_recipient_email']
105
109
  end
110
+
111
+ if attributes.key?(:'passcode_delivery')
112
+ self.passcode_delivery = attributes[:'passcode_delivery']
113
+ end
106
114
  end
107
115
 
108
116
 
@@ -159,7 +167,8 @@ module SignWell
159
167
  id == o.id &&
160
168
  name == o.name &&
161
169
  preassigned_recipient_name == o.preassigned_recipient_name &&
162
- preassigned_recipient_email == o.preassigned_recipient_email
170
+ preassigned_recipient_email == o.preassigned_recipient_email &&
171
+ passcode_delivery == o.passcode_delivery
163
172
  end
164
173
 
165
174
  # @see the `==` method
@@ -171,7 +180,7 @@ module SignWell
171
180
  # Calculates hash code according to all attributes.
172
181
  # @return [Integer] Hash code
173
182
  def hash
174
- [id, name, preassigned_recipient_name, preassigned_recipient_email].hash
183
+ [id, name, preassigned_recipient_name, preassigned_recipient_email, passcode_delivery].hash
175
184
  end
176
185
 
177
186
  # Builds the object from hash