docusign_esign 3.7.0.rc1 → 3.8.0.rc1

data/lib/docusign_esign/api/groups_api.rb

@@ -110,7 +110,7 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param group_id The ID of the group being accessed.
     # @param brands_request  (optional parameter)
-    # @return [BrandsResponse]
+    # @return [GroupBrands]
     def delete_brands(account_id, group_id, brands_request)
       data, _status_code, _headers = delete_brands_with_http_info(account_id, group_id,  brands_request)
       return data
@@ -121,7 +121,7 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param group_id The ID of the group being accessed.
     # @param brands_request  (optional parameter)
-    # @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
+    # @return [Array<(GroupBrands, Fixnum, Hash)>] GroupBrands data, response status code and response headers
     def delete_brands_with_http_info(account_id, group_id, brands_request)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.delete_brands ..."
@@ -153,7 +153,7 @@ module DocuSign_eSign
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'BrandsResponse')
+        :return_type => 'GroupBrands')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: GroupsApi#delete_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -270,7 +270,7 @@ module DocuSign_eSign
     # Retrieves information about the brands associated with the requested group.
     # @param account_id The external account number (int) or account ID Guid.
     # @param group_id The ID of the group being accessed.
-    # @return [BrandsResponse]
+    # @return [GroupBrands]
     def get_brands(account_id, group_id)
       data, _status_code, _headers = get_brands_with_http_info(account_id, group_id)
       return data
@@ -280,7 +280,7 @@ module DocuSign_eSign
     # Retrieves information about the brands associated with the requested group.
     # @param account_id The external account number (int) or account ID Guid.
     # @param group_id The ID of the group being accessed.
-    # @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
+    # @return [Array<(GroupBrands, Fixnum, Hash)>] GroupBrands data, response status code and response headers
     def get_brands_with_http_info(account_id, group_id)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.get_brands ..."
@@ -312,7 +312,7 @@ module DocuSign_eSign
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'BrandsResponse')
+        :return_type => 'GroupBrands')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: GroupsApi#get_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -437,7 +437,7 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param group_id The ID of the group being accessed.
     # @param brands_request  (optional parameter)
-    # @return [BrandsResponse]
+    # @return [GroupBrands]
     def update_brands(account_id, group_id, brands_request)
       data, _status_code, _headers = update_brands_with_http_info(account_id, group_id,  brands_request)
       return data
@@ -448,7 +448,7 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param group_id The ID of the group being accessed.
     # @param brands_request  (optional parameter)
-    # @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
+    # @return [Array<(GroupBrands, Fixnum, Hash)>] GroupBrands data, response status code and response headers
     def update_brands_with_http_info(account_id, group_id, brands_request)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.update_brands ..."
@@ -480,7 +480,7 @@ module DocuSign_eSign
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'BrandsResponse')
+        :return_type => 'GroupBrands')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: GroupsApi#update_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/docusign_esign/api/trust_service_providers_api.rb

@@ -21,6 +21,53 @@ 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.1/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.
@@ -69,5 +116,190 @@ 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.1/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.1/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.1/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.1/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

@@ -1019,6 +1019,58 @@ 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.1/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

@@ -40,6 +40,9 @@ module DocuSign_eSign
     # 
     attr_accessor :is_downgrade
 
+    # 
+    attr_accessor :notification_type
+
     #  Any other percentage discount for the plan. 
     attr_accessor :other_discount_percent
 
@@ -88,6 +91,7 @@ module DocuSign_eSign
         :'included_seats' => :'includedSeats',
         :'incremental_seats' => :'incrementalSeats',
         :'is_downgrade' => :'isDowngrade',
+        :'notification_type' => :'notificationType',
         :'other_discount_percent' => :'otherDiscountPercent',
         :'payment_cycle' => :'paymentCycle',
         :'payment_method' => :'paymentMethod',
@@ -115,6 +119,7 @@ module DocuSign_eSign
         :'included_seats' => :'String',
         :'incremental_seats' => :'String',
         :'is_downgrade' => :'String',
+        :'notification_type' => :'String',
         :'other_discount_percent' => :'String',
         :'payment_cycle' => :'String',
         :'payment_method' => :'String',
@@ -176,6 +181,10 @@ module DocuSign_eSign
         self.is_downgrade = attributes[:'isDowngrade']
       end
 
+      if attributes.has_key?(:'notificationType')
+        self.notification_type = attributes[:'notificationType']
+      end
+
       if attributes.has_key?(:'otherDiscountPercent')
         self.other_discount_percent = attributes[:'otherDiscountPercent']
       end
@@ -256,6 +265,7 @@ module DocuSign_eSign
           included_seats == o.included_seats &&
           incremental_seats == o.incremental_seats &&
           is_downgrade == o.is_downgrade &&
+          notification_type == o.notification_type &&
           other_discount_percent == o.other_discount_percent &&
           payment_cycle == o.payment_cycle &&
           payment_method == o.payment_method &&
@@ -279,7 +289,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [add_ons, can_cancel_renewal, can_upgrade, currency_code, downgrade_plan_information, enable_support, included_seats, incremental_seats, is_downgrade, 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, can_cancel_renewal, can_upgrade, currency_code, downgrade_plan_information, 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
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/account_information.rb

@@ -58,6 +58,12 @@ module DocuSign_eSign
     # Identifies the plan that was used create this account.
     attr_accessor :current_plan_id
 
+    # 
+    attr_accessor :display_appliance_start_url
+
+    # 
+    attr_accessor :display_appliance_url
+
     # The code that identifies the billing plan groups and plans for the new account.
     attr_accessor :distributor_code
 
@@ -115,6 +121,9 @@ module DocuSign_eSign
     # 
     attr_accessor :suspension_status
 
+    # 
+    attr_accessor :use_display_appliance
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -133,6 +142,8 @@ module DocuSign_eSign
         :'created_date' => :'createdDate',
         :'currency_code' => :'currencyCode',
         :'current_plan_id' => :'currentPlanId',
+        :'display_appliance_start_url' => :'displayApplianceStartUrl',
+        :'display_appliance_url' => :'displayApplianceUrl',
         :'distributor_code' => :'distributorCode',
         :'docu_sign_landing_url' => :'docuSignLandingUrl',
         :'dss_values' => :'dssValues',
@@ -151,7 +162,8 @@ module DocuSign_eSign
         :'seats_in_use' => :'seatsInUse',
         :'status21_cfr_part11' => :'status21CFRPart11',
         :'suspension_date' => :'suspensionDate',
-        :'suspension_status' => :'suspensionStatus'
+        :'suspension_status' => :'suspensionStatus',
+        :'use_display_appliance' => :'useDisplayAppliance'
       }
     end
 
@@ -173,6 +185,8 @@ module DocuSign_eSign
         :'created_date' => :'String',
         :'currency_code' => :'String',
         :'current_plan_id' => :'String',
+        :'display_appliance_start_url' => :'String',
+        :'display_appliance_url' => :'String',
         :'distributor_code' => :'String',
         :'docu_sign_landing_url' => :'String',
         :'dss_values' => :'Hash<String, String>',
@@ -191,7 +205,8 @@ module DocuSign_eSign
         :'seats_in_use' => :'String',
         :'status21_cfr_part11' => :'String',
         :'suspension_date' => :'String',
-        :'suspension_status' => :'String'
+        :'suspension_status' => :'String',
+        :'use_display_appliance' => :'BOOLEAN'
       }
     end
 
@@ -263,6 +278,14 @@ module DocuSign_eSign
         self.current_plan_id = attributes[:'currentPlanId']
       end
 
+      if attributes.has_key?(:'displayApplianceStartUrl')
+        self.display_appliance_start_url = attributes[:'displayApplianceStartUrl']
+      end
+
+      if attributes.has_key?(:'displayApplianceUrl')
+        self.display_appliance_url = attributes[:'displayApplianceUrl']
+      end
+
       if attributes.has_key?(:'distributorCode')
         self.distributor_code = attributes[:'distributorCode']
       end
@@ -342,6 +365,10 @@ module DocuSign_eSign
       if attributes.has_key?(:'suspensionStatus')
         self.suspension_status = attributes[:'suspensionStatus']
       end
+
+      if attributes.has_key?(:'useDisplayAppliance')
+        self.use_display_appliance = attributes[:'useDisplayAppliance']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -377,6 +404,8 @@ module DocuSign_eSign
           created_date == o.created_date &&
           currency_code == o.currency_code &&
           current_plan_id == o.current_plan_id &&
+          display_appliance_start_url == o.display_appliance_start_url &&
+          display_appliance_url == o.display_appliance_url &&
           distributor_code == o.distributor_code &&
           docu_sign_landing_url == o.docu_sign_landing_url &&
           dss_values == o.dss_values &&
@@ -395,7 +424,8 @@ module DocuSign_eSign
           seats_in_use == o.seats_in_use &&
           status21_cfr_part11 == o.status21_cfr_part11 &&
           suspension_date == o.suspension_date &&
-          suspension_status == o.suspension_status
+          suspension_status == o.suspension_status &&
+          use_display_appliance == o.use_display_appliance
     end
 
     # @see the `==` method
@@ -407,7 +437,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_id_guid, account_name, account_settings, allow_transaction_rooms, billing_period_days_remaining, billing_period_end_date, billing_period_envelopes_allowed, billing_period_envelopes_sent, billing_period_start_date, billing_profile, can_upgrade, connect_permission, created_date, currency_code, current_plan_id, distributor_code, docu_sign_landing_url, dss_values, envelope_sending_blocked, envelope_unit_price, external_account_id, forgotten_password_questions_count, is_downgrade, payment_method, plan_classification, plan_end_date, plan_name, plan_start_date, recipient_domains, seats_allowed, seats_in_use, status21_cfr_part11, suspension_date, suspension_status].hash
+      [account_id_guid, account_name, account_settings, allow_transaction_rooms, billing_period_days_remaining, billing_period_end_date, billing_period_envelopes_allowed, billing_period_envelopes_sent, billing_period_start_date, billing_profile, can_upgrade, connect_permission, created_date, currency_code, current_plan_id, display_appliance_start_url, display_appliance_url, distributor_code, docu_sign_landing_url, dss_values, envelope_sending_blocked, envelope_unit_price, external_account_id, forgotten_password_questions_count, is_downgrade, payment_method, plan_classification, plan_end_date, plan_name, plan_start_date, recipient_domains, seats_allowed, seats_in_use, status21_cfr_part11, suspension_date, suspension_status, use_display_appliance].hash
     end
 
     # Builds the object from hash