docspring 3.4.0 → 3.5.0

data/lib/docspring/models/copy_template_options.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/create_combined_submission_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 
@@ -19,8 +19,13 @@ module DocSpring
 
     attr_accessor :combined_submission
 
+    attr_accessor :error
+
     attr_accessor :errors
 
+    # `insufficient_credits` when the response is a 402.
+    attr_accessor :code
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -48,7 +53,9 @@ module DocSpring
       {
         :'status' => :'status',
         :'combined_submission' => :'combined_submission',
-        :'errors' => :'errors'
+        :'error' => :'error',
+        :'errors' => :'errors',
+        :'code' => :'code'
       }
     end
 
@@ -67,7 +74,9 @@ module DocSpring
       {
         :'status' => :'String',
         :'combined_submission' => :'CombinedSubmission',
-        :'errors' => :'Array<String>'
+        :'error' => :'String',
+        :'errors' => :'Array<String>',
+        :'code' => :'String'
       }
     end
 
@@ -105,11 +114,19 @@ module DocSpring
         self.combined_submission = nil
       end
 
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
       if attributes.key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Array)
           self.errors = value
         end
       end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,7 +184,9 @@ module DocSpring
       self.class == o.class &&
           status == o.status &&
           combined_submission == o.combined_submission &&
-          errors == o.errors
+          error == o.error &&
+          errors == o.errors &&
+          code == o.code
     end
 
     # @see the `==` method
@@ -179,7 +198,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, combined_submission, errors].hash
+      [status, combined_submission, error, errors, code].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_custom_file_data.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/create_custom_file_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 
@@ -19,6 +19,8 @@ module DocSpring
 
     attr_accessor :custom_file
 
+    attr_accessor :error
+
     attr_accessor :errors
 
     class EnumAttributeValidator
@@ -48,6 +50,7 @@ module DocSpring
       {
         :'status' => :'status',
         :'custom_file' => :'custom_file',
+        :'error' => :'error',
         :'errors' => :'errors'
       }
     end
@@ -67,6 +70,7 @@ module DocSpring
       {
         :'status' => :'String',
         :'custom_file' => :'CustomFile',
+        :'error' => :'String',
         :'errors' => :'Array<String>'
       }
     end
@@ -105,6 +109,10 @@ module DocSpring
         self.custom_file = nil
       end
 
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
       if attributes.key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Array)
           self.errors = value
@@ -167,6 +175,7 @@ module DocSpring
       self.class == o.class &&
           status == o.status &&
           custom_file == o.custom_file &&
+          error == o.error &&
           errors == o.errors
     end
 
@@ -179,7 +188,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, custom_file, errors].hash
+      [status, custom_file, error, errors].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_folder_data.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/create_html_template.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/create_pdf_submission_data.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 
@@ -29,6 +29,7 @@ module DocSpring
 
     attr_accessor :password
 
+    # Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits.
     attr_accessor :test
 
     attr_accessor :version

data/lib/docspring/models/create_pdf_template.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/create_submission_data_request_data.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/create_submission_data_request_event_request.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/create_submission_data_request_event_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 
@@ -19,6 +19,8 @@ module DocSpring
 
     attr_accessor :event
 
+    attr_accessor :error
+
     attr_accessor :errors
 
     class EnumAttributeValidator
@@ -48,6 +50,7 @@ module DocSpring
       {
         :'status' => :'status',
         :'event' => :'event',
+        :'error' => :'error',
         :'errors' => :'errors'
       }
     end
@@ -67,6 +70,7 @@ module DocSpring
       {
         :'status' => :'String',
         :'event' => :'SubmissionDataRequestEvent',
+        :'error' => :'String',
         :'errors' => :'Array<String>'
       }
     end
@@ -105,6 +109,10 @@ module DocSpring
         self.event = nil
       end
 
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
       if attributes.key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Array)
           self.errors = value
@@ -167,6 +175,7 @@ module DocSpring
       self.class == o.class &&
           status == o.status &&
           event == o.event &&
+          error == o.error &&
           errors == o.errors
     end
 
@@ -179,7 +188,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, event, errors].hash
+      [status, event, error, errors].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_submission_data_request_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 
@@ -19,6 +19,8 @@ module DocSpring
 
     attr_accessor :data_request
 
+    attr_accessor :error
+
     attr_accessor :errors
 
     class EnumAttributeValidator
@@ -48,6 +50,7 @@ module DocSpring
       {
         :'status' => :'status',
         :'data_request' => :'data_request',
+        :'error' => :'error',
         :'errors' => :'errors'
       }
     end
@@ -67,6 +70,7 @@ module DocSpring
       {
         :'status' => :'String',
         :'data_request' => :'SubmissionDataRequestShow',
+        :'error' => :'String',
         :'errors' => :'Array<String>'
       }
     end
@@ -105,6 +109,10 @@ module DocSpring
         self.data_request = nil
       end
 
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
       if attributes.key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Array)
           self.errors = value
@@ -167,6 +175,7 @@ module DocSpring
       self.class == o.class &&
           status == o.status &&
           data_request == o.data_request &&
+          error == o.error &&
           errors == o.errors
     end
 
@@ -179,7 +188,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, data_request, errors].hash
+      [status, data_request, error, errors].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_submission_data_request_token_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 
@@ -19,6 +19,8 @@ module DocSpring
 
     attr_accessor :token
 
+    attr_accessor :error
+
     attr_accessor :errors
 
     class EnumAttributeValidator
@@ -48,6 +50,7 @@ module DocSpring
       {
         :'status' => :'status',
         :'token' => :'token',
+        :'error' => :'error',
         :'errors' => :'errors'
       }
     end
@@ -67,6 +70,7 @@ module DocSpring
       {
         :'status' => :'String',
         :'token' => :'SubmissionDataRequestToken',
+        :'error' => :'String',
         :'errors' => :'Array<String>'
       }
     end
@@ -105,6 +109,10 @@ module DocSpring
         self.token = nil
       end
 
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
       if attributes.key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Array)
           self.errors = value
@@ -167,6 +175,7 @@ module DocSpring
       self.class == o.class &&
           status == o.status &&
           token == o.token &&
+          error == o.error &&
           errors == o.errors
     end
 
@@ -179,7 +188,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, token, errors].hash
+      [status, token, error, errors].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_submission_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 
@@ -19,8 +19,13 @@ module DocSpring
 
     attr_accessor :submission
 
+    attr_accessor :error
+
     attr_accessor :errors
 
+    # `insufficient_credits` when the response is a 402.
+    attr_accessor :code
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -48,7 +53,9 @@ module DocSpring
       {
         :'status' => :'status',
         :'submission' => :'submission',
-        :'errors' => :'errors'
+        :'error' => :'error',
+        :'errors' => :'errors',
+        :'code' => :'code'
       }
     end
 
@@ -67,7 +74,9 @@ module DocSpring
       {
         :'status' => :'String',
         :'submission' => :'SubmissionPreview',
-        :'errors' => :'Array<String>'
+        :'error' => :'String',
+        :'errors' => :'Array<String>',
+        :'code' => :'String'
       }
     end
 
@@ -105,11 +114,19 @@ module DocSpring
         self.submission = nil
       end
 
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
       if attributes.key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Array)
           self.errors = value
         end
       end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,7 +184,9 @@ module DocSpring
       self.class == o.class &&
           status == o.status &&
           submission == o.submission &&
-          errors == o.errors
+          error == o.error &&
+          errors == o.errors &&
+          code == o.code
     end
 
     # @see the `==` method
@@ -179,7 +198,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, submission, errors].hash
+      [status, submission, error, errors, code].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_webhook_data.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/custom_file.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/error_or_multiple_errors_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/error_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/folder.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#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/).
 
 The version of the OpenAPI document: v1