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'
@@ -51,10 +50,23 @@ module SignWell
51
50
  # the data deserialized from response body (could be nil), response status code and response headers.
52
51
  def call_api(http_method, path, opts = {})
53
52
  stream = nil
53
+ response = nil
54
54
  begin
55
- response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
56
- request = build_request(http_method, path, req, opts)
57
- stream = download_file(request) if streamed_response?(opts[:return_type])
55
+ attempt = 0
56
+ loop do
57
+ response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
58
+ request = build_request(http_method, path, req, opts)
59
+ stream = download_file(request) if streamed_response?(opts[:return_type])
60
+ end
61
+ break unless response.status == 429 && attempt < config.max_rate_limit_retries
62
+
63
+ delay = rate_limit_retry_delay(response.headers, attempt)
64
+ break if delay > 60
65
+
66
+ discard_download_stream(stream)
67
+ stream = nil
68
+ sleep(delay)
69
+ attempt += 1
58
70
  end
59
71
 
60
72
  if config.debugging
@@ -103,6 +115,15 @@ module SignWell
103
115
  raise
104
116
  end
105
117
 
118
+ def rate_limit_retry_delay(headers, attempt)
119
+ value = Errors::ApiError.first_header(headers, ['retry-after']).to_s.strip
120
+ return value.to_i if /\A\d+\z/.match?(value)
121
+
122
+ [Time.httpdate(value) - Time.now, 0].max
123
+ rescue ArgumentError
124
+ 2**[attempt, 5].min
125
+ end
126
+
106
127
  def discard_download_stream(stream)
107
128
  stream.close! if stream.is_a?(Tempfile)
108
129
  end
@@ -344,7 +365,6 @@ module SignWell
344
365
  end
345
366
  end
346
367
  end
347
-
348
368
  # Check if the given MIME is a JSON MIME.
349
369
  # JSON MIME examples:
350
370
  # application/json
@@ -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 'time'
@@ -0,0 +1,88 @@
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
+
11
+ =end
12
+
13
+ module SignWell
14
+ class ApiModelBase
15
+ # Deserializes the data based on type
16
+ # @param string type Data type
17
+ # @param string value Value to be deserialized
18
+ # @return [Object] Deserialized data
19
+ def self._deserialize(type, value)
20
+ case type.to_sym
21
+ when :Time
22
+ Time.parse(value)
23
+ when :Date
24
+ Date.parse(value)
25
+ when :String
26
+ value.to_s
27
+ when :Integer
28
+ value.to_i
29
+ when :Float
30
+ value.to_f
31
+ when :Boolean
32
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
33
+ true
34
+ else
35
+ false
36
+ end
37
+ when :Object
38
+ # generic object (usually a Hash), return directly
39
+ value
40
+ when /\AArray<(?<inner_type>.+)>\z/
41
+ inner_type = Regexp.last_match[:inner_type]
42
+ value.map { |v| _deserialize(inner_type, v) }
43
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
44
+ k_type = Regexp.last_match[:k_type]
45
+ v_type = Regexp.last_match[:v_type]
46
+ {}.tap do |hash|
47
+ value.each do |k, v|
48
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
49
+ end
50
+ end
51
+ else # model
52
+ # models (e.g. Pet) or oneOf
53
+ klass = SignWell.const_get(type)
54
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
55
+ end
56
+ end
57
+
58
+ # Returns the string representation of the object
59
+ # @return [String] String presentation of the object
60
+ def to_s
61
+ to_hash.to_s
62
+ end
63
+
64
+ # to_body is an alias to to_hash (backward compatibility)
65
+ # @return [Hash] Returns the object in the form of hash
66
+ def to_body
67
+ to_hash
68
+ end
69
+
70
+ # Outputs non-array value in the form of hash
71
+ # For object, use to_hash. Otherwise, just return the value
72
+ # @param [Object] value Any valid value
73
+ # @return [Hash] Returns the value in the form of hash
74
+ def _to_hash(value)
75
+ if value.is_a?(Array)
76
+ value.compact.map { |v| _to_hash(v) }
77
+ elsif value.is_a?(Hash)
78
+ {}.tap do |hash|
79
+ value.each { |k, v| hash[k] = _to_hash(v) }
80
+ end
81
+ elsif value.respond_to? :to_hash
82
+ value.to_hash
83
+ else
84
+ value
85
+ end
86
+ end
87
+ end
88
+ end
@@ -6,7 +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
9
+ Generator version: 7.26.0
10
10
 
11
11
  =end
12
12
 
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SignWell
4
+ class Configuration
5
+ def max_rate_limit_retries
6
+ @max_rate_limit_retries || 2
7
+ end
8
+
9
+ def max_rate_limit_retries=(value)
10
+ unless value.is_a?(Integer) && value.between?(0, 10)
11
+ raise ArgumentError, 'Rate limit retries must be an integer between zero and ten.'
12
+ end
13
+
14
+ @max_rate_limit_retries = value
15
+ end
16
+ end
17
+ 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'
@@ -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
@@ -128,6 +135,8 @@ module SignWell
128
135
  :'api_id' => :'api_id',
129
136
  :'name' => :'name',
130
137
  :'validation' => :'validation',
138
+ :'validation_regex' => :'validation_regex',
139
+ :'validation_regex_error_message' => :'validation_regex_error_message',
131
140
  :'fixed_width' => :'fixed_width',
132
141
  :'lock_sign_date' => :'lock_sign_date',
133
142
  :'date_format' => :'date_format',
@@ -164,6 +173,8 @@ module SignWell
164
173
  :'api_id' => :'String',
165
174
  :'name' => :'String',
166
175
  :'validation' => :'TextValidation',
176
+ :'validation_regex' => :'String',
177
+ :'validation_regex_error_message' => :'String',
167
178
  :'fixed_width' => :'Boolean',
168
179
  :'lock_sign_date' => :'Boolean',
169
180
  :'date_format' => :'DateFormat',
@@ -254,6 +265,14 @@ module SignWell
254
265
  self.validation = attributes[:'validation']
255
266
  end
256
267
 
268
+ if attributes.key?(:'validation_regex')
269
+ self.validation_regex = attributes[:'validation_regex']
270
+ end
271
+
272
+ if attributes.key?(:'validation_regex_error_message')
273
+ self.validation_regex_error_message = attributes[:'validation_regex_error_message']
274
+ end
275
+
257
276
  if attributes.key?(:'fixed_width')
258
277
  self.fixed_width = attributes[:'fixed_width']
259
278
  else
@@ -430,6 +449,8 @@ module SignWell
430
449
  api_id == o.api_id &&
431
450
  name == o.name &&
432
451
  validation == o.validation &&
452
+ validation_regex == o.validation_regex &&
453
+ validation_regex_error_message == o.validation_regex_error_message &&
433
454
  fixed_width == o.fixed_width &&
434
455
  lock_sign_date == o.lock_sign_date &&
435
456
  date_format == o.date_format &&
@@ -450,7 +471,7 @@ module SignWell
450
471
  # Calculates hash code according to all attributes.
451
472
  # @return [Integer] Hash code
452
473
  def hash
453
- [x, y, page, recipient_id, type, required, label, value, api_id, name, validation, fixed_width, lock_sign_date, date_format, formula, height, width, options, default_option, allow_other].hash
474
+ [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, formula, height, width, options, default_option, allow_other].hash
454
475
  end
455
476
 
456
477
  # 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'
@@ -42,7 +41,7 @@ module SignWell
42
41
  begin
43
42
  next if klass == :AnyType # "nullable: true"
44
43
  typed_data = find_and_cast_into_type(klass, data)
45
- return typed_data if typed_data
44
+ return typed_data unless typed_data.nil?
46
45
  rescue SchemaMismatchError
47
46
  next
48
47
  end
@@ -63,7 +62,7 @@ module SignWell
63
62
  when 'Boolean'
64
63
  return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
65
64
  when 'Float'
66
- return data if data.instance_of?(Float)
65
+ return data if data.instance_of?(Float) || data.instance_of?(Integer)
67
66
  when 'Integer'
68
67
  return data if data.instance_of?(Integer)
69
68
  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'
@@ -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'
@@ -20,7 +19,7 @@ module SignWell
20
19
  # @return [Array<String>]
21
20
  attr_accessor :template_ids
22
21
 
23
- # A RFC 4648 base64 string of the template CSV file to be validated.
22
+ # A RFC 4648 base64 string of the template CSV file to be validated. While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must carry a name column next to each placeholder email column (for example `signer_name` alongside `signer_email`), and each row must fill that name in wherever it carries the matching email, otherwise it returns a 422. A row that leaves both the email and the name blank sends nothing to that placeholder, so no name is needed there.
24
23
  # @return [String]
25
24
  attr_accessor :bulk_send_csv
26
25
 
@@ -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'
@@ -20,9 +19,10 @@ module SignWell
20
19
  MAXIMUM = "maximum".freeze
21
20
  RANGE = "range".freeze
22
21
  EXACT = "exact".freeze
22
+ UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
23
23
 
24
24
  def self.all_vars
25
- @all_vars ||= [MINIMUM, MAXIMUM, RANGE, EXACT].freeze
25
+ @all_vars ||= [MINIMUM, MAXIMUM, RANGE, EXACT, UNKNOWN_DEFAULT_OPEN_API].freeze
26
26
  end
27
27
 
28
28
  # Builds the enum from string
@@ -37,6 +37,7 @@ module SignWell
37
37
  # @return [String] The enum value
38
38
  def build_from_hash(value)
39
39
  return value if CheckboxValidation.all_vars.include?(value)
40
+ return UNKNOWN_DEFAULT_OPEN_API if value.is_a?(String)
40
41
  raise "Invalid ENUM value #{value} for class #CheckboxValidation"
41
42
  end
42
43
  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'
@@ -40,7 +39,7 @@ module SignWell
40
39
  begin
41
40
  next if klass == :AnyType # "nullable: true"
42
41
  typed_data = find_and_cast_into_type(klass, data)
43
- return typed_data if typed_data
42
+ return typed_data unless typed_data.nil?
44
43
  rescue SchemaMismatchError
45
44
  next
46
45
  end
@@ -61,7 +60,7 @@ module SignWell
61
60
  when 'Boolean'
62
61
  return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
63
62
  when 'Float'
64
- return data if data.instance_of?(Float)
63
+ return data if data.instance_of?(Float) || data.instance_of?(Integer)
65
64
  when 'Integer'
66
65
  return data if data.instance_of?(Integer)
67
66
  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'