docusign_click 1.3.0 → 1.4.0

data/lib/docusign_click/models/header_styles.rb

@@ -0,0 +1,279 @@
+=begin
+#DocuSign Click API
+
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
+
+OpenAPI spec version: v1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_Click
+  # Control the display of the header.
+  class HeaderStyles
+    # Control the fore-ground color of the element.
+    attr_accessor :color
+
+    # Control the display of the header. Can only be set to 'none' over the default for hiding purposes.
+    attr_accessor :display
+
+    # Control the font family of the text.
+    attr_accessor :font_family
+
+    # Control the font size of the text.
+    attr_accessor :font_size
+
+    # Control the font style of the text.
+    attr_accessor :font_style
+
+    # Control the font weight of the text.
+    attr_accessor :font_weight
+
+    # Control the underline and other styles of the text.
+    attr_accessor :text_decoration
+
+    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
+      {
+        :'color' => :'color',
+        :'display' => :'display',
+        :'font_family' => :'fontFamily',
+        :'font_size' => :'fontSize',
+        :'font_style' => :'fontStyle',
+        :'font_weight' => :'fontWeight',
+        :'text_decoration' => :'textDecoration'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'color' => :'String',
+        :'display' => :'String',
+        :'font_family' => :'String',
+        :'font_size' => :'String',
+        :'font_style' => :'String',
+        :'font_weight' => :'Object',
+        :'text_decoration' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'color')
+        self.color = attributes[:'color']
+      end
+
+      if attributes.has_key?(:'display')
+        self.display = attributes[:'display']
+      end
+
+      if attributes.has_key?(:'fontFamily')
+        self.font_family = attributes[:'fontFamily']
+      end
+
+      if attributes.has_key?(:'fontSize')
+        self.font_size = attributes[:'fontSize']
+      end
+
+      if attributes.has_key?(:'fontStyle')
+        self.font_style = attributes[:'fontStyle']
+      end
+
+      if attributes.has_key?(:'fontWeight')
+        self.font_weight = attributes[:'fontWeight']
+      end
+
+      if attributes.has_key?(:'textDecoration')
+        self.text_decoration = attributes[:'textDecoration']
+      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
+      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?
+      display_validator = EnumAttributeValidator.new('String', ['none'])
+      return false unless display_validator.valid?(@display)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] display Object to be assigned
+    def display=(display)
+      validator = EnumAttributeValidator.new('String', ['none'])
+      unless validator.valid?(display)
+        fail ArgumentError, 'invalid value for "display", must be one of #{validator.allowable_values}.'
+      end
+      @display = display
+    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 &&
+          color == o.color &&
+          display == o.display &&
+          font_family == o.font_family &&
+          font_size == o.font_size &&
+          font_style == o.font_style &&
+          font_weight == o.font_weight &&
+          text_decoration == o.text_decoration
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [color, display, font_family, font_size, font_style, font_weight, text_decoration].hash
+    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)
+      self.class.swagger_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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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 :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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
+        temp_model = DocuSign_Click.const_get(type).new
+        temp_model.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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      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)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docusign_click/models/user_agreement_response.rb

@@ -64,7 +64,6 @@ module DocuSign_Click
     # User agreement status. One of:  - `created` - `agreed` - `declined`
     attr_accessor :status
 
-    # This property specifies the custom style provided when the agreement was created by [customizing the template appearance][].    [customizing the template appearance]: /docs/click-api/click101/customize-elastic-template-appearance/ 
     attr_accessor :style
 
     # The human-readable semver version string.
@@ -123,7 +122,7 @@ module DocuSign_Click
         :'return_url' => :'String',
         :'settings' => :'DisplaySettings',
         :'status' => :'String',
-        :'style' => :'Hash<String, String>',
+        :'style' => :'UserAgreementResponseStyle',
         :'version' => :'String',
         :'version_id' => :'String',
         :'version_number' => :'Integer'
@@ -213,9 +212,7 @@ module DocuSign_Click
       end
 
       if attributes.has_key?(:'style')
-        if (value = attributes[:'style']).is_a?(Hash)
-          self.style = value
-        end
+        self.style = attributes[:'style']
       end
 
       if attributes.has_key?(:'version')

data/lib/docusign_click/models/user_agreement_response_style.rb

@@ -0,0 +1,279 @@
+=begin
+#DocuSign Click API
+
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
+
+OpenAPI spec version: v1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_Click
+  # This property specifies the custom style provided when the agreement was created by [customizing the template appearance][].    [customizing the template appearance]: /docs/click-api/click101/customize-elastic-template-appearance/ 
+  class UserAgreementResponseStyle
+    # Control the display of the Agree button.
+    attr_accessor :agree_button
+
+    # Control the display of the agreement statement.
+    attr_accessor :agreement_statement
+
+    # Control the overall clickwrap container and inherited styles such as font.
+    attr_accessor :container
+
+    # Control the display of the disclosure link.
+    attr_accessor :disclosure_link
+
+    # Control the display of the agreement statement.
+    attr_accessor :document_link
+
+    # Control the display of the header.
+    attr_accessor :header
+
+    # Control the scrolling of the document either by browser or by a scrollbar in the clickwrap shell. Can only be applied if the clickwrap `format` is `inline`.
+    attr_accessor :scroll_control
+
+    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
+      {
+        :'agree_button' => :'agreeButton',
+        :'agreement_statement' => :'agreementStatement',
+        :'container' => :'container',
+        :'disclosure_link' => :'disclosureLink',
+        :'document_link' => :'documentLink',
+        :'header' => :'header',
+        :'scroll_control' => :'scrollControl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'agree_button' => :'AgreeButtonStyles',
+        :'agreement_statement' => :'AgreementStatementStyles',
+        :'container' => :'ContainerStyles',
+        :'disclosure_link' => :'DisclosureLinkStyles',
+        :'document_link' => :'DocumentLinkStyles',
+        :'header' => :'HeaderStyles',
+        :'scroll_control' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'agreeButton')
+        self.agree_button = attributes[:'agreeButton']
+      end
+
+      if attributes.has_key?(:'agreementStatement')
+        self.agreement_statement = attributes[:'agreementStatement']
+      end
+
+      if attributes.has_key?(:'container')
+        self.container = attributes[:'container']
+      end
+
+      if attributes.has_key?(:'disclosureLink')
+        self.disclosure_link = attributes[:'disclosureLink']
+      end
+
+      if attributes.has_key?(:'documentLink')
+        self.document_link = attributes[:'documentLink']
+      end
+
+      if attributes.has_key?(:'header')
+        self.header = attributes[:'header']
+      end
+
+      if attributes.has_key?(:'scrollControl')
+        self.scroll_control = attributes[:'scrollControl']
+      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
+      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?
+      scroll_control_validator = EnumAttributeValidator.new('String', ['browser', 'fill_parent'])
+      return false unless scroll_control_validator.valid?(@scroll_control)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scroll_control Object to be assigned
+    def scroll_control=(scroll_control)
+      validator = EnumAttributeValidator.new('String', ['browser', 'fill_parent'])
+      unless validator.valid?(scroll_control)
+        fail ArgumentError, 'invalid value for "scroll_control", must be one of #{validator.allowable_values}.'
+      end
+      @scroll_control = scroll_control
+    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 &&
+          agree_button == o.agree_button &&
+          agreement_statement == o.agreement_statement &&
+          container == o.container &&
+          disclosure_link == o.disclosure_link &&
+          document_link == o.document_link &&
+          header == o.header &&
+          scroll_control == o.scroll_control
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [agree_button, agreement_statement, container, disclosure_link, document_link, header, scroll_control].hash
+    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)
+      self.class.swagger_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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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 :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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
+        temp_model = DocuSign_Click.const_get(type).new
+        temp_model.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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      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)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docusign_click/version.rb

@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 module DocuSign_Click
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/lib/docusign_click.rb

@@ -19,6 +19,9 @@ require 'docusign_click/configuration'
 require 'docusign_click/client/auth/oauth'
 
 # Models
+require 'docusign_click/models/agree_button_styles'
+require 'docusign_click/models/agreement_statement_styles'
+require 'docusign_click/models/base_agree_button_styles'
 require 'docusign_click/models/bulk_clickwrap_request'
 require 'docusign_click/models/clickwrap_agreements_response'
 require 'docusign_click/models/clickwrap_delete_response'
@@ -33,14 +36,20 @@ require 'docusign_click/models/clickwrap_versions_delete_response'
 require 'docusign_click/models/clickwrap_versions_paged_response'
 require 'docusign_click/models/clickwrap_versions_response'
 require 'docusign_click/models/clickwraps_delete_response'
+require 'docusign_click/models/container_styles'
 require 'docusign_click/models/data_field'
+require 'docusign_click/models/disclosure_link_styles'
 require 'docusign_click/models/display_settings'
 require 'docusign_click/models/document'
+require 'docusign_click/models/document_link_styles'
+require 'docusign_click/models/document_link_styles_focus'
 require 'docusign_click/models/error_details'
+require 'docusign_click/models/header_styles'
 require 'docusign_click/models/service_information'
 require 'docusign_click/models/service_version'
 require 'docusign_click/models/user_agreement_request'
 require 'docusign_click/models/user_agreement_response'
+require 'docusign_click/models/user_agreement_response_style'
 
 # APIs
 require 'docusign_click/api/accounts_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docusign_click
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - DocuSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -294,6 +294,9 @@ files:
 - lib/docusign_click/client/api_error.rb
 - lib/docusign_click/client/auth/oauth.rb
 - lib/docusign_click/configuration.rb
+- lib/docusign_click/models/agree_button_styles.rb
+- lib/docusign_click/models/agreement_statement_styles.rb
+- lib/docusign_click/models/base_agree_button_styles.rb
 - lib/docusign_click/models/bulk_clickwrap_request.rb
 - lib/docusign_click/models/clickwrap_agreements_response.rb
 - lib/docusign_click/models/clickwrap_delete_response.rb
@@ -308,14 +311,19 @@ files:
 - lib/docusign_click/models/clickwrap_versions_paged_response.rb
 - lib/docusign_click/models/clickwrap_versions_response.rb
 - lib/docusign_click/models/clickwraps_delete_response.rb
+- lib/docusign_click/models/container_styles.rb
 - lib/docusign_click/models/conversion_document.rb
 - lib/docusign_click/models/data_field.rb
+- lib/docusign_click/models/disclosure_link_styles.rb
 - lib/docusign_click/models/display_settings.rb
 - lib/docusign_click/models/document.rb
 - lib/docusign_click/models/document_conversion_request.rb
 - lib/docusign_click/models/document_conversion_response.rb
 - lib/docusign_click/models/document_data.rb
+- lib/docusign_click/models/document_link_styles.rb
+- lib/docusign_click/models/document_link_styles_focus.rb
 - lib/docusign_click/models/error_details.rb
+- lib/docusign_click/models/header_styles.rb
 - lib/docusign_click/models/html_result.rb
 - lib/docusign_click/models/recipient_copy_request.rb
 - lib/docusign_click/models/service_information.rb
@@ -323,6 +331,7 @@ files:
 - lib/docusign_click/models/update_agreement_request.rb
 - lib/docusign_click/models/user_agreement_request.rb
 - lib/docusign_click/models/user_agreement_response.rb
+- lib/docusign_click/models/user_agreement_response_style.rb
 - lib/docusign_click/version.rb
 - runLinter.sh
 - tests/Gemfile