docusign_esign 2.9.0.rc1 → 2.11.0.rc1

data/lib/docusign_esign/api/trust_service_providers_api.rb

@@ -21,53 +21,6 @@ module DocuSign_eSign
       @api_client = api_client
     end
 
-    # Complete Sign Hash
-    # 
-    # @param complete_sign_request  (optional parameter)
-    # @return [CompleteSignHashResponse]
-    def complete_sign_hash(complete_sign_request)
-      data, _status_code, _headers = complete_sign_hash_with_http_info( complete_sign_request)
-      return data
-    end
-
-    # Complete Sign Hash
-    # 
-    # @param complete_sign_request  (optional parameter)
-    # @return [Array<(CompleteSignHashResponse, Fixnum, Hash)>] CompleteSignHashResponse data, response status code and response headers
-    def complete_sign_hash_with_http_info(complete_sign_request)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TrustServiceProvidersApi.complete_sign_hash ..."
-      end
-      # resource path
-      local_var_path = "/v2/signature/completesignhash".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(complete_sign_request)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'CompleteSignHashResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TrustServiceProvidersApi#complete_sign_hash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Returns Account available seals for specified account.
     # 
     # @param account_id The external account number (int) or account ID Guid.
@@ -116,190 +69,5 @@ module DocuSign_eSign
       end
       return data, status_code, headers
     end
-
-    # Get User Info To Sign Document
-    # 
-    # @return [UserInfoResponse]
-    def get_user_info()
-      data, _status_code, _headers = get_user_info_with_http_info()
-      return data
-    end
-
-    # Get User Info To Sign Document
-    # 
-    # @return [Array<(UserInfoResponse, Fixnum, Hash)>] UserInfoResponse data, response status code and response headers
-    def get_user_info_with_http_info()
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TrustServiceProvidersApi.get_user_info ..."
-      end
-      # resource path
-      local_var_path = "/v2/signature/userInfo".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'UserInfoResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TrustServiceProvidersApi#get_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Report status from the TSP to DocuSign
-    # 
-    # @param tsp_health_check_request  (optional parameter)
-    # @return [nil]
-    def health_check(tsp_health_check_request)
-      health_check_with_http_info( tsp_health_check_request)
-      return nil
-    end
-
-    # Report status from the TSP to DocuSign
-    # 
-    # @param tsp_health_check_request  (optional parameter)
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def health_check_with_http_info(tsp_health_check_request)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TrustServiceProvidersApi.health_check ..."
-      end
-      # resource path
-      local_var_path = "/v2/signature/healthcheck".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(tsp_health_check_request)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TrustServiceProvidersApi#health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get Signature Session Info To Sign Document Hash
-    # 
-    # @param sign_session_info_request  (optional parameter)
-    # @return [SignHashSessionInfoResponse]
-    def sign_hash_session_info(sign_session_info_request)
-      data, _status_code, _headers = sign_hash_session_info_with_http_info( sign_session_info_request)
-      return data
-    end
-
-    # Get Signature Session Info To Sign Document Hash
-    # 
-    # @param sign_session_info_request  (optional parameter)
-    # @return [Array<(SignHashSessionInfoResponse, Fixnum, Hash)>] SignHashSessionInfoResponse data, response status code and response headers
-    def sign_hash_session_info_with_http_info(sign_session_info_request)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TrustServiceProvidersApi.sign_hash_session_info ..."
-      end
-      # resource path
-      local_var_path = "/v2/signature/signhashsessioninfo".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(sign_session_info_request)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'SignHashSessionInfoResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TrustServiceProvidersApi#sign_hash_session_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Report an error from the tsp to docusign
-    # 
-    # @param update_transaction_request  (optional parameter)
-    # @return [UpdateTransactionResponse]
-    def update_transaction(update_transaction_request)
-      data, _status_code, _headers = update_transaction_with_http_info( update_transaction_request)
-      return data
-    end
-
-    # Report an error from the tsp to docusign
-    # 
-    # @param update_transaction_request  (optional parameter)
-    # @return [Array<(UpdateTransactionResponse, Fixnum, Hash)>] UpdateTransactionResponse data, response status code and response headers
-    def update_transaction_with_http_info(update_transaction_request)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TrustServiceProvidersApi.update_transaction ..."
-      end
-      # resource path
-      local_var_path = "/v2/signature/updatetransaction".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(update_transaction_request)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'UpdateTransactionResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TrustServiceProvidersApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end

data/lib/docusign_esign/api/users_api.rb

@@ -995,58 +995,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Retrieves UserList Export Results data.
-    # 
-    # @param organization_id 
-    # @param result_id 
-    # @return [nil]
-    def get_user_list_export(organization_id, result_id)
-      get_user_list_export_with_http_info(organization_id, result_id)
-      return nil
-    end
-
-    # Retrieves UserList Export Results data.
-    # 
-    # @param organization_id 
-    # @param result_id 
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def get_user_list_export_with_http_info(organization_id, result_id)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UsersApi.get_user_list_export ..."
-      end
-      # verify the required parameter 'organization_id' is set
-      fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.get_user_list_export" if organization_id.nil?
-      # verify the required parameter 'result_id' is set
-      fail ArgumentError, "Missing the required parameter 'result_id' when calling UsersApi.get_user_list_export" if result_id.nil?
-      # resource path
-      local_var_path = "/v2/organization_exports/{organizationId}/user_list/{resultId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'resultId' + '}', result_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UsersApi#get_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Retrieves the list of users for the specified account.
     # Retrieves the list of users for the specified account.  The response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user
     # @param account_id The external account number (int) or account ID Guid.

data/lib/docusign_esign/models/account_billing_plan.rb

@@ -71,6 +71,12 @@ module DocuSign_eSign
     # The name of the Billing Plan.
     attr_accessor :plan_name
 
+    # 
+    attr_accessor :plan_start_date
+
+    # 
+    attr_accessor :renewal_date
+
     # The renewal status for the account. The acceptable values are:  * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate.
     attr_accessor :renewal_status
 
@@ -105,6 +111,8 @@ module DocuSign_eSign
         :'plan_feature_sets' => :'planFeatureSets',
         :'plan_id' => :'planId',
         :'plan_name' => :'planName',
+        :'plan_start_date' => :'planStartDate',
+        :'renewal_date' => :'renewalDate',
         :'renewal_status' => :'renewalStatus',
         :'seat_discounts' => :'seatDiscounts',
         :'support_incident_fee' => :'supportIncidentFee',
@@ -134,6 +142,8 @@ module DocuSign_eSign
         :'plan_feature_sets' => :'Array<FeatureSet>',
         :'plan_id' => :'String',
         :'plan_name' => :'String',
+        :'plan_start_date' => :'String',
+        :'renewal_date' => :'String',
         :'renewal_status' => :'String',
         :'seat_discounts' => :'Array<SeatDiscount>',
         :'support_incident_fee' => :'String',
@@ -229,6 +239,14 @@ module DocuSign_eSign
         self.plan_name = attributes[:'planName']
       end
 
+      if attributes.has_key?(:'planStartDate')
+        self.plan_start_date = attributes[:'planStartDate']
+      end
+
+      if attributes.has_key?(:'renewalDate')
+        self.renewal_date = attributes[:'renewalDate']
+      end
+
       if attributes.has_key?(:'renewalStatus')
         self.renewal_status = attributes[:'renewalStatus']
       end
@@ -285,6 +303,8 @@ module DocuSign_eSign
           plan_feature_sets == o.plan_feature_sets &&
           plan_id == o.plan_id &&
           plan_name == o.plan_name &&
+          plan_start_date == o.plan_start_date &&
+          renewal_date == o.renewal_date &&
           renewal_status == o.renewal_status &&
           seat_discounts == o.seat_discounts &&
           support_incident_fee == o.support_incident_fee &&
@@ -300,7 +320,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [add_ons, app_store_receipt_expiration_date, app_store_receipt_purchase_date, can_cancel_renewal, can_upgrade, currency_code, enable_support, included_seats, incremental_seats, is_downgrade, notification_type, other_discount_percent, payment_cycle, payment_method, per_seat_price, plan_classification, plan_feature_sets, plan_id, plan_name, renewal_status, seat_discounts, support_incident_fee, support_plan_fee].hash
+      [add_ons, app_store_receipt_expiration_date, app_store_receipt_purchase_date, can_cancel_renewal, can_upgrade, currency_code, enable_support, included_seats, incremental_seats, is_downgrade, notification_type, other_discount_percent, payment_cycle, payment_method, per_seat_price, plan_classification, plan_feature_sets, plan_id, plan_name, plan_start_date, renewal_date, renewal_status, seat_discounts, support_incident_fee, support_plan_fee].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/envelope_form_data.rb

@@ -22,7 +22,6 @@ module DocuSign_eSign
     # 
     attr_accessor :form_data
 
-    # 
     attr_accessor :prefill_form_data
 
     # 
@@ -53,7 +52,7 @@ module DocuSign_eSign
         :'email_subject' => :'String',
         :'envelope_id' => :'String',
         :'form_data' => :'Array<NameValue>',
-        :'prefill_form_data' => :'Array<NameValue>',
+        :'prefill_form_data' => :'PrefillFormData',
         :'recipient_form_data' => :'Array<RecipientFormData>',
         :'sent_date_time' => :'String',
         :'status' => :'String'
@@ -83,9 +82,7 @@ module DocuSign_eSign
       end
 
       if attributes.has_key?(:'prefillFormData')
-        if (value = attributes[:'prefillFormData']).is_a?(Array)
-          self.prefill_form_data = value
-        end
+        self.prefill_form_data = attributes[:'prefillFormData']
       end
 
       if attributes.has_key?(:'recipientFormData')

data/lib/docusign_esign/models/envelope_form_data_prefill_form_data.rb

@@ -0,0 +1,186 @@
+=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
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class EnvelopeFormDataPrefillFormData
+    # 
+    attr_accessor :form_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'form_data' => :'formData'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'form_data' => :'Array<NameValue>'
+      }
+    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?(:'formData')
+        if (value = attributes[:'formData']).is_a?(Array)
+          self.form_data = value
+        end
+      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 &&
+          form_data == o.form_data
+    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
+      [form_data].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