docspring 3.3.0 → 3.5.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 (148) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +3 -0
  3. data/.travis.yml +1 -1
  4. data/AGENTS.md +33 -0
  5. data/CHANGELOG.md +19 -0
  6. data/Gemfile.lock +2 -2
  7. data/README.md +145 -178
  8. data/docs/BatchGeneratePdfs201Response.md +3 -1
  9. data/docs/Client.md +6 -6
  10. data/docs/CombinePdfsData.md +1 -1
  11. data/docs/CreateCombinedSubmissionResponse.md +5 -1
  12. data/docs/CreateCustomFileResponse.md +2 -0
  13. data/docs/CreatePdfSubmissionData.md +1 -1
  14. data/docs/CreateSubmissionDataRequestEventResponse.md +2 -0
  15. data/docs/CreateSubmissionDataRequestResponse.md +2 -0
  16. data/docs/CreateSubmissionDataRequestTokenResponse.md +2 -0
  17. data/docs/CreateSubmissionResponse.md +5 -1
  18. data/docs/ForbiddenErrorResponse.md +22 -0
  19. data/docs/SubmissionBatchData.md +1 -1
  20. data/docs/Template.md +2 -0
  21. data/docs/TemplatePreview.md +2 -0
  22. data/docspring.gemspec +1 -1
  23. data/lib/docspring/api/client.rb +13 -13
  24. data/lib/docspring/api_client.rb +2 -2
  25. data/lib/docspring/api_error.rb +1 -1
  26. data/lib/docspring/configuration.rb +1 -1
  27. data/lib/docspring/models/add_fields_data.rb +1 -1
  28. data/lib/docspring/models/batch_generate_pdfs201_response.rb +15 -5
  29. data/lib/docspring/models/combine_pdfs_data.rb +2 -2
  30. data/lib/docspring/models/combined_submission.rb +3 -3
  31. data/lib/docspring/models/combined_submission_action.rb +1 -1
  32. data/lib/docspring/models/copy_template_options.rb +1 -1
  33. data/lib/docspring/models/create_combined_submission_response.rb +24 -5
  34. data/lib/docspring/models/create_custom_file_data.rb +1 -1
  35. data/lib/docspring/models/create_custom_file_response.rb +11 -2
  36. data/lib/docspring/models/create_folder_data.rb +1 -1
  37. data/lib/docspring/models/create_html_template.rb +1 -1
  38. data/lib/docspring/models/create_pdf_submission_data.rb +2 -1
  39. data/lib/docspring/models/create_pdf_template.rb +1 -1
  40. data/lib/docspring/models/create_submission_data_request_data.rb +1 -1
  41. data/lib/docspring/models/create_submission_data_request_event_request.rb +1 -1
  42. data/lib/docspring/models/create_submission_data_request_event_response.rb +11 -2
  43. data/lib/docspring/models/create_submission_data_request_response.rb +11 -2
  44. data/lib/docspring/models/create_submission_data_request_token_response.rb +11 -2
  45. data/lib/docspring/models/create_submission_response.rb +24 -5
  46. data/lib/docspring/models/create_webhook_data.rb +1 -1
  47. data/lib/docspring/models/custom_file.rb +1 -1
  48. data/lib/docspring/models/error_or_multiple_errors_response.rb +1 -1
  49. data/lib/docspring/models/error_response.rb +1 -1
  50. data/lib/docspring/models/folder.rb +1 -1
  51. data/lib/docspring/models/forbidden_error_response.rb +323 -0
  52. data/lib/docspring/models/json_schema.rb +1 -1
  53. data/lib/docspring/models/list_submissions_response.rb +1 -1
  54. data/lib/docspring/models/move_folder_data.rb +1 -1
  55. data/lib/docspring/models/move_template_data.rb +1 -1
  56. data/lib/docspring/models/multiple_errors_response.rb +1 -1
  57. data/lib/docspring/models/publish_version_data.rb +1 -1
  58. data/lib/docspring/models/rename_folder_data.rb +1 -1
  59. data/lib/docspring/models/restore_version_data.rb +1 -1
  60. data/lib/docspring/models/submission.rb +3 -3
  61. data/lib/docspring/models/submission422_response.rb +1 -1
  62. data/lib/docspring/models/submission_action.rb +1 -1
  63. data/lib/docspring/models/submission_batch.rb +1 -1
  64. data/lib/docspring/models/submission_batch_data.rb +2 -1
  65. data/lib/docspring/models/submission_batch_with_submissions.rb +1 -1
  66. data/lib/docspring/models/submission_data_request.rb +1 -1
  67. data/lib/docspring/models/submission_data_request_event.rb +1 -1
  68. data/lib/docspring/models/submission_data_request_show.rb +1 -1
  69. data/lib/docspring/models/submission_data_request_token.rb +1 -1
  70. data/lib/docspring/models/submission_preview.rb +3 -3
  71. data/lib/docspring/models/success_error_response.rb +1 -1
  72. data/lib/docspring/models/success_multiple_errors_response.rb +1 -1
  73. data/lib/docspring/models/template.rb +28 -2
  74. data/lib/docspring/models/template_add_fields_response.rb +1 -1
  75. data/lib/docspring/models/template_delete_response.rb +1 -1
  76. data/lib/docspring/models/template_model_code_response.rb +1 -1
  77. data/lib/docspring/models/template_preview.rb +28 -2
  78. data/lib/docspring/models/template_publish_version_response.rb +1 -1
  79. data/lib/docspring/models/update_html_template.rb +1 -1
  80. data/lib/docspring/models/update_pdf_template.rb +1 -1
  81. data/lib/docspring/models/update_submission_data_request_data.rb +1 -1
  82. data/lib/docspring/models/update_webhook_data.rb +1 -1
  83. data/lib/docspring/models/upload_presign_response.rb +1 -1
  84. data/lib/docspring/models/webhook.rb +1 -1
  85. data/lib/docspring/version.rb +2 -2
  86. data/lib/docspring.rb +2 -1
  87. data/spec/api/client_spec.rb +7 -7
  88. data/spec/models/add_fields_data_spec.rb +1 -1
  89. data/spec/models/batch_generate_pdfs201_response_spec.rb +7 -1
  90. data/spec/models/combine_pdfs_data_spec.rb +1 -1
  91. data/spec/models/combined_submission_action_spec.rb +1 -1
  92. data/spec/models/combined_submission_spec.rb +2 -2
  93. data/spec/models/copy_template_options_spec.rb +1 -1
  94. data/spec/models/create_combined_submission_response_spec.rb +13 -1
  95. data/spec/models/create_custom_file_data_spec.rb +1 -1
  96. data/spec/models/create_custom_file_response_spec.rb +7 -1
  97. data/spec/models/create_folder_data_spec.rb +1 -1
  98. data/spec/models/create_html_template_spec.rb +1 -1
  99. data/spec/models/create_pdf_submission_data_spec.rb +1 -1
  100. data/spec/models/create_pdf_template_spec.rb +1 -1
  101. data/spec/models/create_submission_data_request_data_spec.rb +1 -1
  102. data/spec/models/create_submission_data_request_event_request_spec.rb +1 -1
  103. data/spec/models/create_submission_data_request_event_response_spec.rb +7 -1
  104. data/spec/models/create_submission_data_request_response_spec.rb +7 -1
  105. data/spec/models/create_submission_data_request_token_response_spec.rb +7 -1
  106. data/spec/models/create_submission_response_spec.rb +13 -1
  107. data/spec/models/create_webhook_data_spec.rb +1 -1
  108. data/spec/models/custom_file_spec.rb +1 -1
  109. data/spec/models/error_or_multiple_errors_response_spec.rb +1 -1
  110. data/spec/models/error_response_spec.rb +1 -1
  111. data/spec/models/folder_spec.rb +1 -1
  112. data/spec/models/forbidden_error_response_spec.rb +56 -0
  113. data/spec/models/json_schema_spec.rb +1 -1
  114. data/spec/models/list_submissions_response_spec.rb +1 -1
  115. data/spec/models/move_folder_data_spec.rb +1 -1
  116. data/spec/models/move_template_data_spec.rb +1 -1
  117. data/spec/models/multiple_errors_response_spec.rb +1 -1
  118. data/spec/models/publish_version_data_spec.rb +1 -1
  119. data/spec/models/rename_folder_data_spec.rb +1 -1
  120. data/spec/models/restore_version_data_spec.rb +1 -1
  121. data/spec/models/submission422_response_spec.rb +1 -1
  122. data/spec/models/submission_action_spec.rb +1 -1
  123. data/spec/models/submission_batch_data_spec.rb +1 -1
  124. data/spec/models/submission_batch_spec.rb +1 -1
  125. data/spec/models/submission_batch_with_submissions_spec.rb +1 -1
  126. data/spec/models/submission_data_request_event_spec.rb +1 -1
  127. data/spec/models/submission_data_request_show_spec.rb +1 -1
  128. data/spec/models/submission_data_request_spec.rb +1 -1
  129. data/spec/models/submission_data_request_token_spec.rb +1 -1
  130. data/spec/models/submission_preview_spec.rb +2 -2
  131. data/spec/models/submission_spec.rb +2 -2
  132. data/spec/models/success_error_response_spec.rb +1 -1
  133. data/spec/models/success_multiple_errors_response_spec.rb +1 -1
  134. data/spec/models/template_add_fields_response_spec.rb +1 -1
  135. data/spec/models/template_delete_response_spec.rb +1 -1
  136. data/spec/models/template_model_code_response_spec.rb +1 -1
  137. data/spec/models/template_preview_spec.rb +7 -1
  138. data/spec/models/template_publish_version_response_spec.rb +1 -1
  139. data/spec/models/template_spec.rb +7 -1
  140. data/spec/models/update_html_template_spec.rb +1 -1
  141. data/spec/models/update_pdf_template_spec.rb +1 -1
  142. data/spec/models/update_submission_data_request_data_spec.rb +1 -1
  143. data/spec/models/update_webhook_data_spec.rb +1 -1
  144. data/spec/models/upload_presign_response_spec.rb +1 -1
  145. data/spec/models/webhook_spec.rb +1 -1
  146. data/spec/spec_helper.rb +1 -1
  147. metadata +6 -2
  148. data/git_push.sh +0 -57
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -73,6 +73,8 @@ module DocSpring
73
73
 
74
74
  attr_accessor :parent_folder_id
75
75
 
76
+ attr_accessor :parse_dates_using_template_date_format
77
+
76
78
  attr_accessor :path
77
79
 
78
80
  attr_accessor :permanent_document_url
@@ -193,6 +195,7 @@ module DocSpring
193
195
  :'page_count' => :'page_count',
194
196
  :'page_dimensions' => :'page_dimensions',
195
197
  :'parent_folder_id' => :'parent_folder_id',
198
+ :'parse_dates_using_template_date_format' => :'parse_dates_using_template_date_format',
196
199
  :'path' => :'path',
197
200
  :'permanent_document_url' => :'permanent_document_url',
198
201
  :'public_submissions' => :'public_submissions',
@@ -271,6 +274,7 @@ module DocSpring
271
274
  :'page_count' => :'Integer',
272
275
  :'page_dimensions' => :'Array<Array<Float>>',
273
276
  :'parent_folder_id' => :'String',
277
+ :'parse_dates_using_template_date_format' => :'Boolean',
274
278
  :'path' => :'String',
275
279
  :'permanent_document_url' => :'String',
276
280
  :'public_submissions' => :'Boolean',
@@ -536,6 +540,12 @@ module DocSpring
536
540
  self.parent_folder_id = nil
537
541
  end
538
542
 
543
+ if attributes.key?(:'parse_dates_using_template_date_format')
544
+ self.parse_dates_using_template_date_format = attributes[:'parse_dates_using_template_date_format']
545
+ else
546
+ self.parse_dates_using_template_date_format = nil
547
+ end
548
+
539
549
  if attributes.key?(:'path')
540
550
  self.path = attributes[:'path']
541
551
  else
@@ -814,6 +824,10 @@ module DocSpring
814
824
  invalid_properties.push('invalid value for "page_count", page_count cannot be nil.')
815
825
  end
816
826
 
827
+ if @parse_dates_using_template_date_format.nil?
828
+ invalid_properties.push('invalid value for "parse_dates_using_template_date_format", parse_dates_using_template_date_format cannot be nil.')
829
+ end
830
+
817
831
  if @path.nil?
818
832
  invalid_properties.push('invalid value for "path", path cannot be nil.')
819
833
  end
@@ -896,6 +910,7 @@ module DocSpring
896
910
  return false if @locked.nil?
897
911
  return false if @merge_audit_trail_pdf.nil?
898
912
  return false if @page_count.nil?
913
+ return false if @parse_dates_using_template_date_format.nil?
899
914
  return false if @path.nil?
900
915
  return false if @public_submissions.nil?
901
916
  return false if @public_web_form.nil?
@@ -1088,6 +1103,16 @@ module DocSpring
1088
1103
  @page_count = page_count
1089
1104
  end
1090
1105
 
1106
+ # Custom attribute writer method with validation
1107
+ # @param [Object] parse_dates_using_template_date_format Value to be assigned
1108
+ def parse_dates_using_template_date_format=(parse_dates_using_template_date_format)
1109
+ if parse_dates_using_template_date_format.nil?
1110
+ fail ArgumentError, 'parse_dates_using_template_date_format cannot be nil'
1111
+ end
1112
+
1113
+ @parse_dates_using_template_date_format = parse_dates_using_template_date_format
1114
+ end
1115
+
1091
1116
  # Custom attribute writer method with validation
1092
1117
  # @param [Object] path Value to be assigned
1093
1118
  def path=(path)
@@ -1274,6 +1299,7 @@ module DocSpring
1274
1299
  page_count == o.page_count &&
1275
1300
  page_dimensions == o.page_dimensions &&
1276
1301
  parent_folder_id == o.parent_folder_id &&
1302
+ parse_dates_using_template_date_format == o.parse_dates_using_template_date_format &&
1277
1303
  path == o.path &&
1278
1304
  permanent_document_url == o.permanent_document_url &&
1279
1305
  public_submissions == o.public_submissions &&
@@ -1318,7 +1344,7 @@ module DocSpring
1318
1344
  # Calculates hash code according to all attributes.
1319
1345
  # @return [Integer] Hash code
1320
1346
  def hash
1321
- [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, embed_edit_token, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id, defaults, field_dependencies, field_order, fields, footer_html, header_html, html_engine_options, html, predefined_fields, scss, shared_field_data, template_schema_version, versions].hash
1347
+ [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, parse_dates_using_template_date_format, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, embed_edit_token, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id, defaults, field_dependencies, field_order, fields, footer_html, header_html, html_engine_options, html, predefined_fields, scss, shared_field_data, template_schema_version, versions].hash
1322
1348
  end
1323
1349
 
1324
1350
  # Builds the object from hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -73,6 +73,8 @@ module DocSpring
73
73
 
74
74
  attr_accessor :parent_folder_id
75
75
 
76
+ attr_accessor :parse_dates_using_template_date_format
77
+
76
78
  attr_accessor :path
77
79
 
78
80
  attr_accessor :permanent_document_url
@@ -167,6 +169,7 @@ module DocSpring
167
169
  :'page_count' => :'page_count',
168
170
  :'page_dimensions' => :'page_dimensions',
169
171
  :'parent_folder_id' => :'parent_folder_id',
172
+ :'parse_dates_using_template_date_format' => :'parse_dates_using_template_date_format',
170
173
  :'path' => :'path',
171
174
  :'permanent_document_url' => :'permanent_document_url',
172
175
  :'public_submissions' => :'public_submissions',
@@ -232,6 +235,7 @@ module DocSpring
232
235
  :'page_count' => :'Integer',
233
236
  :'page_dimensions' => :'Array<Array<Float>>',
234
237
  :'parent_folder_id' => :'String',
238
+ :'parse_dates_using_template_date_format' => :'Boolean',
235
239
  :'path' => :'String',
236
240
  :'permanent_document_url' => :'String',
237
241
  :'public_submissions' => :'Boolean',
@@ -480,6 +484,12 @@ module DocSpring
480
484
  self.parent_folder_id = nil
481
485
  end
482
486
 
487
+ if attributes.key?(:'parse_dates_using_template_date_format')
488
+ self.parse_dates_using_template_date_format = attributes[:'parse_dates_using_template_date_format']
489
+ else
490
+ self.parse_dates_using_template_date_format = nil
491
+ end
492
+
483
493
  if attributes.key?(:'path')
484
494
  self.path = attributes[:'path']
485
495
  else
@@ -672,6 +682,10 @@ module DocSpring
672
682
  invalid_properties.push('invalid value for "page_count", page_count cannot be nil.')
673
683
  end
674
684
 
685
+ if @parse_dates_using_template_date_format.nil?
686
+ invalid_properties.push('invalid value for "parse_dates_using_template_date_format", parse_dates_using_template_date_format cannot be nil.')
687
+ end
688
+
675
689
  if @path.nil?
676
690
  invalid_properties.push('invalid value for "path", path cannot be nil.')
677
691
  end
@@ -718,6 +732,7 @@ module DocSpring
718
732
  return false if @locked.nil?
719
733
  return false if @merge_audit_trail_pdf.nil?
720
734
  return false if @page_count.nil?
735
+ return false if @parse_dates_using_template_date_format.nil?
721
736
  return false if @path.nil?
722
737
  return false if @public_submissions.nil?
723
738
  return false if @public_web_form.nil?
@@ -901,6 +916,16 @@ module DocSpring
901
916
  @page_count = page_count
902
917
  end
903
918
 
919
+ # Custom attribute writer method with validation
920
+ # @param [Object] parse_dates_using_template_date_format Value to be assigned
921
+ def parse_dates_using_template_date_format=(parse_dates_using_template_date_format)
922
+ if parse_dates_using_template_date_format.nil?
923
+ fail ArgumentError, 'parse_dates_using_template_date_format cannot be nil'
924
+ end
925
+
926
+ @parse_dates_using_template_date_format = parse_dates_using_template_date_format
927
+ end
928
+
904
929
  # Custom attribute writer method with validation
905
930
  # @param [Object] path Value to be assigned
906
931
  def path=(path)
@@ -997,6 +1022,7 @@ module DocSpring
997
1022
  page_count == o.page_count &&
998
1023
  page_dimensions == o.page_dimensions &&
999
1024
  parent_folder_id == o.parent_folder_id &&
1025
+ parse_dates_using_template_date_format == o.parse_dates_using_template_date_format &&
1000
1026
  path == o.path &&
1001
1027
  permanent_document_url == o.permanent_document_url &&
1002
1028
  public_submissions == o.public_submissions &&
@@ -1028,7 +1054,7 @@ module DocSpring
1028
1054
  # Calculates hash code according to all attributes.
1029
1055
  # @return [Integer] Hash code
1030
1056
  def hash
1031
- [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, embed_edit_token, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id].hash
1057
+ [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, parse_dates_using_template_date_format, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, embed_edit_token, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id].hash
1032
1058
  end
1033
1059
 
1034
1060
  # Builds the object from hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -11,5 +11,5 @@ Generator version: 7.16.0-DOCSPRING
11
11
  =end
12
12
 
13
13
  module DocSpring
14
- VERSION = '3.3.0'
14
+ VERSION = '3.5.0'
15
15
  end
data/lib/docspring.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -41,6 +41,7 @@ require 'docspring/models/custom_file'
41
41
  require 'docspring/models/error_or_multiple_errors_response'
42
42
  require 'docspring/models/error_response'
43
43
  require 'docspring/models/folder'
44
+ require 'docspring/models/forbidden_error_response'
44
45
  require 'docspring/models/json_schema'
45
46
  require 'docspring/models/list_submissions_response'
46
47
  require 'docspring/models/move_folder_data'
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -47,7 +47,7 @@ describe 'Client' do
47
47
 
48
48
  # unit tests for batch_generate_pdfs
49
49
  # Generate multiple PDFs
50
- # Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs. See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits
50
+ # Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs. Live PDFs use credits. If any live submission is waiting for credits, the API returns 402 and the others are still processed: check each submission&#39;s &#x60;state&#x60;. See [Credits &amp; Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/). See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits
51
51
  # @param data
52
52
  # @param [Hash] opts the optional parameters
53
53
  # @option opts [Boolean] :wait Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
@@ -60,7 +60,7 @@ describe 'Client' do
60
60
 
61
61
  # unit tests for combine_pdfs
62
62
  # Merge submission PDFs, template PDFs, or custom files
63
- # Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided.
63
+ # Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided. Combining uses credits (4 per source PDF, plus 4 per unit of the combined PDF), even with a test API token or watermarked source PDFs. If your balance can&#39;t cover it, the API returns 402 and the combined submission waits in the &#x60;insufficient_credits&#x60; state until you add credits. See [Credits &amp; Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
64
64
  # @param data
65
65
  # @param [Hash] opts the optional parameters
66
66
  # @return [CreateCombinedSubmissionResponse]
@@ -248,7 +248,7 @@ describe 'Client' do
248
248
 
249
249
  # unit tests for generate_pdf
250
250
  # Generate a PDF
251
- # Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the &#x60;wait&#x3D;false&#x60; query parameter to return immediately. See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn&#39;t fit in fields
251
+ # Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the &#x60;wait&#x3D;false&#x60; query parameter to return immediately. Live PDFs use credits; test PDFs (&#x60;test: true&#x60;) are free and watermarked. If your balance can&#39;t cover a live PDF, the API returns 402 and the submission waits in the &#x60;insufficient_credits&#x60; state until you add credits. See [Credits &amp; Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/). See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn&#39;t fit in fields
252
252
  # @param template_id
253
253
  # @param submission
254
254
  # @param [Hash] opts the optional parameters
@@ -274,7 +274,7 @@ describe 'Client' do
274
274
 
275
275
  # unit tests for get_combined_submission
276
276
  # Check the status of a combined submission (merged PDFs)
277
- # Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads).
277
+ # Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads). &#x60;insufficient_credits&#x60; means the combined submission is waiting for credits and is processed once you add them. If it&#39;s still waiting after 30 days, it moves to &#x60;error&#x60;.
278
278
  # @param combined_submission_id
279
279
  # @param [Hash] opts the optional parameters
280
280
  # @return [CombinedSubmission]
@@ -321,7 +321,7 @@ describe 'Client' do
321
321
 
322
322
  # unit tests for get_submission
323
323
  # Check the status of a PDF
324
- # Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing.
324
+ # Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing. &#x60;insufficient_credits&#x60; means the submission is waiting for credits and is processed once you add them. If it&#39;s still waiting after 30 days, it moves to &#x60;error&#x60;.
325
325
  # @param submission_id
326
326
  # @param [Hash] opts the optional parameters
327
327
  # @option opts [Boolean] :include_data
@@ -334,7 +334,7 @@ describe 'Client' do
334
334
 
335
335
  # unit tests for get_submission_batch
336
336
  # Check the status of a submission batch job
337
- # Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing.
337
+ # Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing. Submissions waiting for credits are in the &#x60;insufficient_credits&#x60; state and count as pending, so the batch stays &#x60;pending&#x60; until you add credits or they stop waiting after 30 days.
338
338
  # @param submission_batch_id
339
339
  # @param [Hash] opts the optional parameters
340
340
  # @option opts [Boolean] :include_submissions
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -61,4 +61,10 @@ describe DocSpring::BatchGeneratePdfs201Response do
61
61
  end
62
62
  end
63
63
 
64
+ describe 'test attribute "code"' do
65
+ it 'should work' do
66
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
67
+ end
68
+ end
69
+
64
70
  end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -36,7 +36,7 @@ describe DocSpring::CombinedSubmission do
36
36
  describe 'test attribute "state"' do
37
37
  it 'should work' do
38
38
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pending", "processed", "error"])
39
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pending", "processed", "error", "insufficient_credits"])
40
40
  # validator.allowable_values.each do |value|
41
41
  # expect { instance.state = value }.not_to raise_error
42
42
  # end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -43,10 +43,22 @@ describe DocSpring::CreateCombinedSubmissionResponse do
43
43
  end
44
44
  end
45
45
 
46
+ describe 'test attribute "error"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
+ end
50
+ end
51
+
46
52
  describe 'test attribute "errors"' do
47
53
  it 'should work' do
48
54
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
55
  end
50
56
  end
51
57
 
58
+ describe 'test attribute "code"' do
59
+ it 'should work' do
60
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
61
+ end
62
+ end
63
+
52
64
  end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -43,6 +43,12 @@ describe DocSpring::CreateCustomFileResponse do
43
43
  end
44
44
  end
45
45
 
46
+ describe 'test attribute "error"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
+ end
50
+ end
51
+
46
52
  describe 'test attribute "errors"' do
47
53
  it 'should work' do
48
54
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7