docusign_esign 3.11.0.rc1 → 3.13.0.rc1

data/lib/docusign_esign/models/connect_user_info.rb

@@ -0,0 +1,224 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class ConnectUserInfo
+    # 
+    attr_accessor :email
+
+    # 
+    attr_accessor :is_included
+
+    # 
+    attr_accessor :is_part_of_domain
+
+    # 
+    attr_accessor :user_id
+
+    # 
+    attr_accessor :user_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'is_included' => :'isIncluded',
+        :'is_part_of_domain' => :'isPartOfDomain',
+        :'user_id' => :'userId',
+        :'user_name' => :'userName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email' => :'String',
+        :'is_included' => :'String',
+        :'is_part_of_domain' => :'String',
+        :'user_id' => :'String',
+        :'user_name' => :'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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'isIncluded')
+        self.is_included = attributes[:'isIncluded']
+      end
+
+      if attributes.has_key?(:'isPartOfDomain')
+        self.is_part_of_domain = attributes[:'isPartOfDomain']
+      end
+
+      if attributes.has_key?(:'userId')
+        self.user_id = attributes[:'userId']
+      end
+
+      if attributes.has_key?(:'userName')
+        self.user_name = attributes[:'userName']
+      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?
+      true
+    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 &&
+          email == o.email &&
+          is_included == o.is_included &&
+          is_part_of_domain == o.is_part_of_domain &&
+          user_id == o.user_id &&
+          user_name == o.user_name
+    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
+      [email, is_included, is_part_of_domain, user_id, user_name].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_eSign.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_esign/models/credit_card_information.rb

@@ -15,6 +15,9 @@ module DocuSign_eSign
   class CreditCardInformation
     attr_accessor :address
 
+    # 
+    attr_accessor :card_last_digits
+
     # The number on the credit card.
     attr_accessor :card_number
 
@@ -33,16 +36,21 @@ module DocuSign_eSign
     # The exact name printed on the credit card.
     attr_accessor :name_on_card
 
+    # 
+    attr_accessor :tokenized_card
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'address' => :'address',
+        :'card_last_digits' => :'cardLastDigits',
         :'card_number' => :'cardNumber',
         :'card_type' => :'cardType',
         :'cv_number' => :'cvNumber',
         :'expiration_month' => :'expirationMonth',
         :'expiration_year' => :'expirationYear',
-        :'name_on_card' => :'nameOnCard'
+        :'name_on_card' => :'nameOnCard',
+        :'tokenized_card' => :'tokenizedCard'
       }
     end
 
@@ -50,12 +58,14 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'address' => :'AddressInformation',
+        :'card_last_digits' => :'String',
         :'card_number' => :'String',
         :'card_type' => :'String',
         :'cv_number' => :'String',
         :'expiration_month' => :'String',
         :'expiration_year' => :'String',
-        :'name_on_card' => :'String'
+        :'name_on_card' => :'String',
+        :'tokenized_card' => :'String'
       }
     end
 
@@ -71,6 +81,10 @@ module DocuSign_eSign
         self.address = attributes[:'address']
       end
 
+      if attributes.has_key?(:'cardLastDigits')
+        self.card_last_digits = attributes[:'cardLastDigits']
+      end
+
       if attributes.has_key?(:'cardNumber')
         self.card_number = attributes[:'cardNumber']
       end
@@ -94,6 +108,10 @@ module DocuSign_eSign
       if attributes.has_key?(:'nameOnCard')
         self.name_on_card = attributes[:'nameOnCard']
       end
+
+      if attributes.has_key?(:'tokenizedCard')
+        self.tokenized_card = attributes[:'tokenizedCard']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,12 +133,14 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           address == o.address &&
+          card_last_digits == o.card_last_digits &&
           card_number == o.card_number &&
           card_type == o.card_type &&
           cv_number == o.cv_number &&
           expiration_month == o.expiration_month &&
           expiration_year == o.expiration_year &&
-          name_on_card == o.name_on_card
+          name_on_card == o.name_on_card &&
+          tokenized_card == o.tokenized_card
     end
 
     # @see the `==` method
@@ -132,7 +152,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [address, card_number, card_type, cv_number, expiration_month, expiration_year, name_on_card].hash
+      [address, card_last_digits, card_number, card_type, cv_number, expiration_month, expiration_year, name_on_card, tokenized_card].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/date.rb

@@ -207,6 +207,11 @@ module DocuSign_eSign
 
     attr_accessor :shared_metadata
 
+    # 
+    attr_accessor :share_to_recipients
+
+    attr_accessor :share_to_recipients_metadata
+
     attr_accessor :smart_contract_information
 
     # 
@@ -373,6 +378,8 @@ module DocuSign_eSign
         :'sender_required_metadata' => :'senderRequiredMetadata',
         :'shared' => :'shared',
         :'shared_metadata' => :'sharedMetadata',
+        :'share_to_recipients' => :'shareToRecipients',
+        :'share_to_recipients_metadata' => :'shareToRecipientsMetadata',
         :'smart_contract_information' => :'smartContractInformation',
         :'source' => :'source',
         :'status' => :'status',
@@ -491,6 +498,8 @@ module DocuSign_eSign
         :'sender_required_metadata' => :'PropertyMetadata',
         :'shared' => :'String',
         :'shared_metadata' => :'PropertyMetadata',
+        :'share_to_recipients' => :'String',
+        :'share_to_recipients_metadata' => :'PropertyMetadata',
         :'smart_contract_information' => :'SmartContractInformation',
         :'source' => :'String',
         :'status' => :'String',
@@ -848,6 +857,14 @@ module DocuSign_eSign
         self.shared_metadata = attributes[:'sharedMetadata']
       end
 
+      if attributes.has_key?(:'shareToRecipients')
+        self.share_to_recipients = attributes[:'shareToRecipients']
+      end
+
+      if attributes.has_key?(:'shareToRecipientsMetadata')
+        self.share_to_recipients_metadata = attributes[:'shareToRecipientsMetadata']
+      end
+
       if attributes.has_key?(:'smartContractInformation')
         self.smart_contract_information = attributes[:'smartContractInformation']
       end
@@ -1083,6 +1100,8 @@ module DocuSign_eSign
           sender_required_metadata == o.sender_required_metadata &&
           shared == o.shared &&
           shared_metadata == o.shared_metadata &&
+          share_to_recipients == o.share_to_recipients &&
+          share_to_recipients_metadata == o.share_to_recipients_metadata &&
           smart_contract_information == o.smart_contract_information &&
           source == o.source &&
           status == o.status &&
@@ -1128,7 +1147,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, validation_message, validation_message_metadata, validation_pattern, validation_pattern_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
+      [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, validation_message, validation_message_metadata, validation_pattern, validation_pattern_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/downgrade_billing_plan_information.rb

@@ -18,11 +18,27 @@ module DocuSign_eSign
 
     attr_accessor :plan_information
 
+    # 
+    attr_accessor :promo_code
+
+    # 
+    attr_accessor :sale_discount
+
+    # 
+    attr_accessor :sale_discount_periods
+
+    # 
+    attr_accessor :sale_discount_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'downgrade_event_type' => :'downgradeEventType',
-        :'plan_information' => :'planInformation'
+        :'plan_information' => :'planInformation',
+        :'promo_code' => :'promoCode',
+        :'sale_discount' => :'saleDiscount',
+        :'sale_discount_periods' => :'saleDiscountPeriods',
+        :'sale_discount_type' => :'saleDiscountType'
       }
     end
 
@@ -30,7 +46,11 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'downgrade_event_type' => :'String',
-        :'plan_information' => :'PlanInformation'
+        :'plan_information' => :'PlanInformation',
+        :'promo_code' => :'String',
+        :'sale_discount' => :'String',
+        :'sale_discount_periods' => :'String',
+        :'sale_discount_type' => :'String'
       }
     end
 
@@ -49,6 +69,22 @@ module DocuSign_eSign
       if attributes.has_key?(:'planInformation')
         self.plan_information = attributes[:'planInformation']
       end
+
+      if attributes.has_key?(:'promoCode')
+        self.promo_code = attributes[:'promoCode']
+      end
+
+      if attributes.has_key?(:'saleDiscount')
+        self.sale_discount = attributes[:'saleDiscount']
+      end
+
+      if attributes.has_key?(:'saleDiscountPeriods')
+        self.sale_discount_periods = attributes[:'saleDiscountPeriods']
+      end
+
+      if attributes.has_key?(:'saleDiscountType')
+        self.sale_discount_type = attributes[:'saleDiscountType']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -70,7 +106,11 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           downgrade_event_type == o.downgrade_event_type &&
-          plan_information == o.plan_information
+          plan_information == o.plan_information &&
+          promo_code == o.promo_code &&
+          sale_discount == o.sale_discount &&
+          sale_discount_periods == o.sale_discount_periods &&
+          sale_discount_type == o.sale_discount_type
     end
 
     # @see the `==` method
@@ -82,7 +122,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [downgrade_event_type, plan_information].hash
+      [downgrade_event_type, plan_information, promo_code, sale_discount, sale_discount_periods, sale_discount_type].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/downgrade_plan_update_response.rb

@@ -16,6 +16,9 @@ module DocuSign_eSign
     # 
     attr_accessor :account_payment_method
 
+    # 
+    attr_accessor :discount_applied
+
     # 
     attr_accessor :downgrade_effective_date
 
@@ -34,16 +37,37 @@ module DocuSign_eSign
     # 
     attr_accessor :message
 
+    # 
+    attr_accessor :product_id
+
+    # 
+    attr_accessor :promo_code
+
+    # 
+    attr_accessor :sale_discount
+
+    # 
+    attr_accessor :sale_discount_periods
+
+    # 
+    attr_accessor :sale_discount_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'account_payment_method' => :'accountPaymentMethod',
+        :'discount_applied' => :'discountApplied',
         :'downgrade_effective_date' => :'downgradeEffectiveDate',
         :'downgrade_payment_cycle' => :'downgradePaymentCycle',
         :'downgrade_plan_id' => :'downgradePlanId',
         :'downgrade_plan_name' => :'downgradePlanName',
         :'downgrade_request_status' => :'downgradeRequestStatus',
-        :'message' => :'message'
+        :'message' => :'message',
+        :'product_id' => :'productId',
+        :'promo_code' => :'promoCode',
+        :'sale_discount' => :'saleDiscount',
+        :'sale_discount_periods' => :'saleDiscountPeriods',
+        :'sale_discount_type' => :'saleDiscountType'
       }
     end
 
@@ -51,12 +75,18 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'account_payment_method' => :'String',
+        :'discount_applied' => :'String',
         :'downgrade_effective_date' => :'String',
         :'downgrade_payment_cycle' => :'String',
         :'downgrade_plan_id' => :'String',
         :'downgrade_plan_name' => :'String',
         :'downgrade_request_status' => :'String',
-        :'message' => :'String'
+        :'message' => :'String',
+        :'product_id' => :'String',
+        :'promo_code' => :'String',
+        :'sale_discount' => :'String',
+        :'sale_discount_periods' => :'String',
+        :'sale_discount_type' => :'String'
       }
     end
 
@@ -72,6 +102,10 @@ module DocuSign_eSign
         self.account_payment_method = attributes[:'accountPaymentMethod']
       end
 
+      if attributes.has_key?(:'discountApplied')
+        self.discount_applied = attributes[:'discountApplied']
+      end
+
       if attributes.has_key?(:'downgradeEffectiveDate')
         self.downgrade_effective_date = attributes[:'downgradeEffectiveDate']
       end
@@ -95,6 +129,26 @@ module DocuSign_eSign
       if attributes.has_key?(:'message')
         self.message = attributes[:'message']
       end
+
+      if attributes.has_key?(:'productId')
+        self.product_id = attributes[:'productId']
+      end
+
+      if attributes.has_key?(:'promoCode')
+        self.promo_code = attributes[:'promoCode']
+      end
+
+      if attributes.has_key?(:'saleDiscount')
+        self.sale_discount = attributes[:'saleDiscount']
+      end
+
+      if attributes.has_key?(:'saleDiscountPeriods')
+        self.sale_discount_periods = attributes[:'saleDiscountPeriods']
+      end
+
+      if attributes.has_key?(:'saleDiscountType')
+        self.sale_discount_type = attributes[:'saleDiscountType']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -116,12 +170,18 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           account_payment_method == o.account_payment_method &&
+          discount_applied == o.discount_applied &&
           downgrade_effective_date == o.downgrade_effective_date &&
           downgrade_payment_cycle == o.downgrade_payment_cycle &&
           downgrade_plan_id == o.downgrade_plan_id &&
           downgrade_plan_name == o.downgrade_plan_name &&
           downgrade_request_status == o.downgrade_request_status &&
-          message == o.message
+          message == o.message &&
+          product_id == o.product_id &&
+          promo_code == o.promo_code &&
+          sale_discount == o.sale_discount &&
+          sale_discount_periods == o.sale_discount_periods &&
+          sale_discount_type == o.sale_discount_type
     end
 
     # @see the `==` method
@@ -133,7 +193,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_payment_method, downgrade_effective_date, downgrade_payment_cycle, downgrade_plan_id, downgrade_plan_name, downgrade_request_status, message].hash
+      [account_payment_method, discount_applied, downgrade_effective_date, downgrade_payment_cycle, downgrade_plan_id, downgrade_plan_name, downgrade_request_status, message, product_id, promo_code, sale_discount, sale_discount_periods, sale_discount_type].hash
     end
 
     # Builds the object from hash