=begin #Dropbox Sign API #Dropbox Sign v3 API The version of the OpenAPI document: 3.0.0 Contact: apisupport@hellosign.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 5.3.0 =end require 'date' require 'time' module Dropbox end module Dropbox::Sign class UnclaimedDraftCreateEmbeddedRequest # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. # @return [String] attr_accessor :client_id # The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. # @return [String] attr_accessor :requester_email_address # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :files # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :file_urls # This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. # @return [Boolean] attr_accessor :allow_ccs # Allows signers to decline to sign a document if `true`. Defaults to `false`. # @return [Boolean] attr_accessor :allow_decline # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. # @return [Boolean] attr_accessor :allow_reassign # A list describing the attachments # @return [Array] attr_accessor :attachments # The email addresses that should be CCed. # @return [Array] attr_accessor :cc_email_addresses # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. # @return [Array] attr_accessor :custom_fields # @return [SubEditorOptions] attr_accessor :editor_options # @return [SubFieldOptions] attr_accessor :field_options # Provide users the ability to review/edit the signers. # @return [Boolean] attr_accessor :force_signer_page # Provide users the ability to review/edit the subject and message. # @return [Boolean] attr_accessor :force_subject_message # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. # @return [Array] attr_accessor :form_field_groups # Conditional Logic rules for fields defined in `form_fields_per_document`. # @return [Array] attr_accessor :form_field_rules # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` # @return [Array] attr_accessor :form_fields_per_document # Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. # @return [Boolean] attr_accessor :hide_text_tags # The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. # @return [Boolean] attr_accessor :hold_request # The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. # @return [Boolean] attr_accessor :is_for_embedded_signing # The custom message in the email that will be sent to the signers. # @return [String] attr_accessor :message # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. # @return [Hash] attr_accessor :metadata # The URL you want signers redirected to after they successfully request a signature. # @return [String] attr_accessor :requesting_redirect_url # This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. # @return [Boolean] attr_accessor :show_preview # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. # @return [Boolean] attr_accessor :show_progress_stepper # Add Signers to your Unclaimed Draft Signature Request. # @return [Array] attr_accessor :signers # @return [SubSigningOptions] attr_accessor :signing_options # The URL you want signers redirected to after they successfully sign. # @return [String] attr_accessor :signing_redirect_url # Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. # @return [Boolean] attr_accessor :skip_me_now # The subject in the email that will be sent to the signers. # @return [String] attr_accessor :subject # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. # @return [Boolean] attr_accessor :test_mode # The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. # @return [String] attr_accessor :type # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. # @return [Boolean] attr_accessor :use_preexisting_fields # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. # @return [Boolean] attr_accessor :use_text_tags # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. # @return [Boolean] attr_accessor :populate_auto_fill_fields # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. # @return [Integer, nil] attr_accessor :expires_at class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values def initialize(datatype, allowable_values) @allowable_values = allowable_values.map do |value| case datatype.to_s when /Integer/i value.to_i when /Float/i value.to_f else value end end end def valid?(value) !value || allowable_values.include?(value) end end # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'client_id' => :'client_id', :'requester_email_address' => :'requester_email_address', :'files' => :'files', :'file_urls' => :'file_urls', :'allow_ccs' => :'allow_ccs', :'allow_decline' => :'allow_decline', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', :'custom_fields' => :'custom_fields', :'editor_options' => :'editor_options', :'field_options' => :'field_options', :'force_signer_page' => :'force_signer_page', :'force_subject_message' => :'force_subject_message', :'form_field_groups' => :'form_field_groups', :'form_field_rules' => :'form_field_rules', :'form_fields_per_document' => :'form_fields_per_document', :'hide_text_tags' => :'hide_text_tags', :'hold_request' => :'hold_request', :'is_for_embedded_signing' => :'is_for_embedded_signing', :'message' => :'message', :'metadata' => :'metadata', :'requesting_redirect_url' => :'requesting_redirect_url', :'show_preview' => :'show_preview', :'show_progress_stepper' => :'show_progress_stepper', :'signers' => :'signers', :'signing_options' => :'signing_options', :'signing_redirect_url' => :'signing_redirect_url', :'skip_me_now' => :'skip_me_now', :'subject' => :'subject', :'test_mode' => :'test_mode', :'type' => :'type', :'use_preexisting_fields' => :'use_preexisting_fields', :'use_text_tags' => :'use_text_tags', :'populate_auto_fill_fields' => :'populate_auto_fill_fields', :'expires_at' => :'expires_at' } end # Returns all the JSON keys this model knows about def self.acceptable_attributes attribute_map.values end # Returns attribute map of this model + parent def self.merged_attributes self.attribute_map end # Attribute type mapping. def self.openapi_types { :'client_id' => :'String', :'requester_email_address' => :'String', :'files' => :'Array', :'file_urls' => :'Array', :'allow_ccs' => :'Boolean', :'allow_decline' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', :'custom_fields' => :'Array', :'editor_options' => :'SubEditorOptions', :'field_options' => :'SubFieldOptions', :'force_signer_page' => :'Boolean', :'force_subject_message' => :'Boolean', :'form_field_groups' => :'Array', :'form_field_rules' => :'Array', :'form_fields_per_document' => :'Array', :'hide_text_tags' => :'Boolean', :'hold_request' => :'Boolean', :'is_for_embedded_signing' => :'Boolean', :'message' => :'String', :'metadata' => :'Hash', :'requesting_redirect_url' => :'String', :'show_preview' => :'Boolean', :'show_progress_stepper' => :'Boolean', :'signers' => :'Array', :'signing_options' => :'SubSigningOptions', :'signing_redirect_url' => :'String', :'skip_me_now' => :'Boolean', :'subject' => :'String', :'test_mode' => :'Boolean', :'type' => :'String', :'use_preexisting_fields' => :'Boolean', :'use_text_tags' => :'Boolean', :'populate_auto_fill_fields' => :'Boolean', :'expires_at' => :'Integer' } end # Attribute type mapping of this model + parent def self.merged_types self.openapi_types end # List of attributes with nullable: true def self.openapi_nullable Set.new([ :'expires_at' ]) end # Returns list of attributes with nullable: true of this model + parent def self.merged_nullable self.openapi_nullable end # Attempt to instantiate and hydrate a new instance of this class # @param [Object] data Data to be converted # @return [UnclaimedDraftCreateEmbeddedRequest] def self.init(data) return ApiClient.default.convert_to_type( data, "UnclaimedDraftCreateEmbeddedRequest" ) || UnclaimedDraftCreateEmbeddedRequest.new end # Initializes the object # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'requester_email_address') self.requester_email_address = attributes[:'requester_email_address'] end if attributes.key?(:'files') if (value = attributes[:'files']).is_a?(Array) self.files = value end end if attributes.key?(:'file_urls') if (value = attributes[:'file_urls']).is_a?(Array) self.file_urls = value end end if attributes.key?(:'allow_ccs') self.allow_ccs = attributes[:'allow_ccs'] else self.allow_ccs = true end if attributes.key?(:'allow_decline') self.allow_decline = attributes[:'allow_decline'] else self.allow_decline = false end if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else self.allow_reassign = false end if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value end end if attributes.key?(:'cc_email_addresses') if (value = attributes[:'cc_email_addresses']).is_a?(Array) self.cc_email_addresses = value end end if attributes.key?(:'custom_fields') if (value = attributes[:'custom_fields']).is_a?(Array) self.custom_fields = value end end if attributes.key?(:'editor_options') self.editor_options = attributes[:'editor_options'] end if attributes.key?(:'field_options') self.field_options = attributes[:'field_options'] end if attributes.key?(:'force_signer_page') self.force_signer_page = attributes[:'force_signer_page'] else self.force_signer_page = false end if attributes.key?(:'force_subject_message') self.force_subject_message = attributes[:'force_subject_message'] else self.force_subject_message = false end if attributes.key?(:'form_field_groups') if (value = attributes[:'form_field_groups']).is_a?(Array) self.form_field_groups = value end end if attributes.key?(:'form_field_rules') if (value = attributes[:'form_field_rules']).is_a?(Array) self.form_field_rules = value end end if attributes.key?(:'form_fields_per_document') if (value = attributes[:'form_fields_per_document']).is_a?(Array) self.form_fields_per_document = value end end if attributes.key?(:'hide_text_tags') self.hide_text_tags = attributes[:'hide_text_tags'] else self.hide_text_tags = false end if attributes.key?(:'hold_request') self.hold_request = attributes[:'hold_request'] else self.hold_request = false end if attributes.key?(:'is_for_embedded_signing') self.is_for_embedded_signing = attributes[:'is_for_embedded_signing'] else self.is_for_embedded_signing = false end if attributes.key?(:'message') self.message = attributes[:'message'] end if attributes.key?(:'metadata') if (value = attributes[:'metadata']).is_a?(Hash) self.metadata = value end end if attributes.key?(:'requesting_redirect_url') self.requesting_redirect_url = attributes[:'requesting_redirect_url'] end if attributes.key?(:'show_preview') self.show_preview = attributes[:'show_preview'] end if attributes.key?(:'show_progress_stepper') self.show_progress_stepper = attributes[:'show_progress_stepper'] else self.show_progress_stepper = true end if attributes.key?(:'signers') if (value = attributes[:'signers']).is_a?(Array) self.signers = value end end if attributes.key?(:'signing_options') self.signing_options = attributes[:'signing_options'] end if attributes.key?(:'signing_redirect_url') self.signing_redirect_url = attributes[:'signing_redirect_url'] end if attributes.key?(:'skip_me_now') self.skip_me_now = attributes[:'skip_me_now'] else self.skip_me_now = false end if attributes.key?(:'subject') self.subject = attributes[:'subject'] end if attributes.key?(:'test_mode') self.test_mode = attributes[:'test_mode'] else self.test_mode = false end if attributes.key?(:'type') self.type = attributes[:'type'] else self.type = 'request_signature' end if attributes.key?(:'use_preexisting_fields') self.use_preexisting_fields = attributes[:'use_preexisting_fields'] else self.use_preexisting_fields = false end if attributes.key?(:'use_text_tags') self.use_text_tags = attributes[:'use_text_tags'] else self.use_text_tags = false end if attributes.key?(:'populate_auto_fill_fields') self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] else self.populate_auto_fill_fields = false end if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new if @client_id.nil? invalid_properties.push('invalid value for "client_id", client_id cannot be nil.') end if @requester_email_address.nil? invalid_properties.push('invalid value for "requester_email_address", requester_email_address cannot be nil.') end if !@message.nil? && @message.to_s.length > 5000 invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') end if !@subject.nil? && @subject.to_s.length > 200 invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 200.') end invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? return false if @client_id.nil? return false if @requester_email_address.nil? return false if !@message.nil? && @message.to_s.length > 5000 return false if !@subject.nil? && @subject.to_s.length > 200 type_validator = EnumAttributeValidator.new('String', ["send_document", "request_signature"]) return false unless type_validator.valid?(@type) true end # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) if !message.nil? && message.to_s.length > 5000 fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' end @message = message end # Custom attribute writer method with validation # @param [Object] metadata Value to be assigned def metadata=(metadata) @metadata = metadata end # Custom attribute writer method with validation # @param [Object] subject Value to be assigned def subject=(subject) if !subject.nil? && subject.to_s.length > 200 fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 200.' end @subject = subject end # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) validator = EnumAttributeValidator.new('String', ["send_document", "request_signature"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && requester_email_address == o.requester_email_address && files == o.files && file_urls == o.file_urls && allow_ccs == o.allow_ccs && allow_decline == o.allow_decline && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && custom_fields == o.custom_fields && editor_options == o.editor_options && field_options == o.field_options && force_signer_page == o.force_signer_page && force_subject_message == o.force_subject_message && form_field_groups == o.form_field_groups && form_field_rules == o.form_field_rules && form_fields_per_document == o.form_fields_per_document && hide_text_tags == o.hide_text_tags && hold_request == o.hold_request && is_for_embedded_signing == o.is_for_embedded_signing && message == o.message && metadata == o.metadata && requesting_redirect_url == o.requesting_redirect_url && show_preview == o.show_preview && show_progress_stepper == o.show_progress_stepper && signers == o.signers && signing_options == o.signing_options && signing_redirect_url == o.signing_redirect_url && skip_me_now == o.skip_me_now && subject == o.subject && test_mode == o.test_mode && type == o.type && use_preexisting_fields == o.use_preexisting_fields && use_text_tags == o.use_text_tags && populate_auto_fill_fields == o.populate_auto_fill_fields && expires_at == o.expires_at end # @see the `==` method # @param [Object] Object to be compared def eql?(o) self == o end # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) new.build_from_hash(attributes) end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attribute_map = self.class.merged_attributes self.class.merged_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) end end self end # Deserializes the data based on type # @param string type Data type # @param string value Value to be deserialized # @return [Object] Deserialized data def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :File value when :Object # generic object (usually a Hash), return directly value when /\AArray<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) klass = Dropbox::Sign.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end # Returns the string representation of the object # @return [String] String presentation of the object def to_s to_hash.to_s end # to_body is an alias to to_hash (backward compatibility) # @return [Hash] Returns the object in the form of hash def to_body to_hash end # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash(include_nil = true) hash = {} self.class.merged_attributes.each_pair do |attr, param| value = self.send(attr) if value.nil? next unless include_nil is_nullable = self.class.merged_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value, include_nil) end hash end # Outputs non-array value in the form of hash # For object, use to_hash. Otherwise, just return the value # @param [Object] value Any valid value # @return [Hash] Returns the value in the form of hash def _to_hash(value, include_nil = true) if value.is_a?(Array) value.compact.map { |v| _to_hash(v, include_nil) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v, include_nil) } end elsif value.respond_to? :to_hash value.to_hash(include_nil) else value end end end end