docusign_esign 0.0.1

data/spec/api/connect_api_spec.rb

@@ -0,0 +1,261 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::ConnectApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ConnectApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::ConnectApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ConnectApi' do
+    it 'should create an instact of ConnectApi' do
+      expect(@instance).to be_instance_of(SwaggerClient::ConnectApi)
+    end
+  end
+
+  # unit tests for create_configuration
+  # Creates a connect configuration for the specified account.
+  # Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide].  ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ConnectCustomConfiguration] :connect_custom_configuration 
+  # @return [ConnectCustomConfiguration]
+  describe 'create_configuration test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_configuration
+  # Deletes the specified connect configuration.
+  # Deletes the specified DocuSign Connect configuration.  ###### Note: Connect must be enabled for your account to use this function.    
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param connect_id The ID of the custom Connect configuration being accessed.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_configuration test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_event_failure_log
+  # Deletes a Connect failure log entry.
+  # Deletes the Connect failure log information for the specified entry.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param failure_id The ID of the failed connect log entry.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_event_failure_log test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_event_log
+  # Deletes a specified Connect log entry.
+  # Deletes a specified entry from the Connect Log. 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param log_id The ID of the connect log entry
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_event_log test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_event_logs
+  # Gets a list of Connect log entries.
+  # Retrieves a list of connect log entries for your account.  ###### Note: The `enableLog` property in the Connect configuration must be set to **true** to enable logging. If logging is not enabled, then no log entries are recorded.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_event_logs test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_mobile_notifiers
+  # Reserved
+  # Reserved:
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [MobileNotifierConfigurationInformation] :mobile_notifier_configuration_information 
+  # @return [MobileNotifierConfigurationInformation]
+  describe 'delete_mobile_notifiers test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_configuration
+  # Get a Connect Configuration Information
+  # Retrieves the information for the specified DocuSign Connect configuration.  ###### Note: Connect must be enabled for your account to use this function. 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param connect_id The ID of the custom Connect configuration being accessed.
+  # @param [Hash] opts the optional parameters
+  # @return [ConnectConfigResults]
+  describe 'get_configuration test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_event_log
+  # Get the specified Connect log entry.
+  # Retrieves the specified Connect log entry for your account.  ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param log_id The ID of the connect log entry
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :additional_info When true, the connectDebugLog information is included in the response.
+  # @return [ConnectLog]
+  describe 'get_event_log test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_configurations
+  # Get Connect Configuration Information
+  # Retrieves all the DocuSign Custom Connect definitions for the specified account.  ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @return [ConnectConfigResults]
+  describe 'list_configurations test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_event_failure_logs
+  # Gets the Connect failure log information.
+  # Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from_date 
+  # @option opts [String] :to_date 
+  # @return [ConnectLogs]
+  describe 'list_event_failure_logs test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_event_logs
+  # Gets the Connect log.
+  # Retrieves a list of connect log entries for your account.  ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from_date 
+  # @option opts [String] :to_date 
+  # @return [ConnectLogs]
+  describe 'list_event_logs test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_mobile_notifiers
+  # Reserved
+  # Reserved:
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @return [MobileNotifierConfigurationInformation]
+  describe 'list_mobile_notifiers test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_users
+  # Returns users from the configured Connect service.
+  # Returns users from the configured Connect service.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param connect_id The ID of the custom Connect configuration being accessed.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :count 
+  # @option opts [String] :email_substring 
+  # @option opts [String] :list_included_users 
+  # @option opts [String] :start_position 
+  # @option opts [String] :status 
+  # @option opts [String] :user_name_substring 
+  # @return [IntegratedUserInfoList]
+  describe 'list_users test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retry_event_for_envelope
+  # Republishes Connect information for the specified envelope.
+  # Republishes Connect information for the specified envelope.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param envelope_id The envelopeId Guid of the envelope being accessed.
+  # @param [Hash] opts the optional parameters
+  # @return [ConnectFailureResults]
+  describe 'retry_event_for_envelope test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retry_event_for_envelopes
+  # Republishes Connect information for multiple envelopes.
+  # Republishes Connect information for the  specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ConnectFailureFilter] :connect_failure_filter 
+  # @return [ConnectFailureResults]
+  describe 'retry_event_for_envelopes test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_configuration
+  # Updates a specified Connect configuration.
+  # Updates the specified DocuSign Connect configuration in your account.  ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ConnectCustomConfiguration] :connect_custom_configuration 
+  # @return [ConnectCustomConfiguration]
+  describe 'update_configuration test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_mobile_notifiers
+  # Reserved
+  # Reserved:
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [MobileNotifierConfigurationInformation] :mobile_notifier_configuration_information 
+  # @return [MobileNotifierConfigurationInformation]
+  describe 'update_mobile_notifiers test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/custom_tabs_api_spec.rb

@@ -0,0 +1,100 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::CustomTabsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CustomTabsApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::CustomTabsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CustomTabsApi' do
+    it 'should create an instact of CustomTabsApi' do
+      expect(@instance).to be_instance_of(SwaggerClient::CustomTabsApi)
+    end
+  end
+
+  # unit tests for create
+  # Creates a custom tab.
+  # Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.  Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [TabMetadata] :tab_metadata 
+  # @return [TabMetadata]
+  describe 'create test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete
+  # Deletes custom tab information.
+  # Deletes the custom from the specified account.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param custom_tab_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get
+  # Gets custom tab information.
+  # Retrieves information about the requested custom tab on the specified account.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param custom_tab_id 
+  # @param [Hash] opts the optional parameters
+  # @return [TabMetadata]
+  describe 'get test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list
+  # Gets a list of all account tabs.
+  # Retrieves a list of all tabs associated with the account.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :custom_tab_only When set to **true**, only custom tabs are returned in the response. 
+  # @return [TabMetadataList]
+  describe 'list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update
+  # Updates custom tab information.  
+  # Updates the information in a custom tab for the specified account.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param custom_tab_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [TabMetadata] :tab_metadata 
+  # @return [TabMetadata]
+  describe 'update test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/diagnostics_api_spec.rb

@@ -0,0 +1,114 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::DiagnosticsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DiagnosticsApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::DiagnosticsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DiagnosticsApi' do
+    it 'should create an instact of DiagnosticsApi' do
+      expect(@instance).to be_instance_of(SwaggerClient::DiagnosticsApi)
+    end
+  end
+
+  # unit tests for delete_request_logs
+  # Deletes the request log files.
+  # Deletes the request log files.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_request_logs test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_request_log
+  # Gets a request logging log file.
+  # Retrieves information for a single log entry.  **Request** The `requestLogfId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.  **Response** If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.
+  # @param request_log_id 
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_request_log test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_request_log_settings
+  # Gets the API request logging settings.
+  # Retrieves the current API request logging setting for the user and remaining log entries.  **Response** The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.
+  # @param [Hash] opts the optional parameters
+  # @return [DiagnosticsSettingsInformation]
+  describe 'get_request_log_settings test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_resources
+  # Lists resources for REST version specified
+  # Retrieves the base resources available for the DocuSign REST APIs.  You do not need an integrator key to view the REST API versions and resources.  Example: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system.  To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL.  Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.
+  # @param [Hash] opts the optional parameters
+  # @return [ResourceInformation]
+  describe 'get_resources test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_service
+  # Retrieves the available REST API versions.
+  # Retrieves the available REST API versions.  DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information  You do not need an integrator key to view the REST API versions and resources.
+  # @param [Hash] opts the optional parameters
+  # @return [ServiceInformation]
+  describe 'get_service test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_request_logs
+  # Gets the API request logging log files.
+  # Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.  If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.  If the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :encoding 
+  # @return [ApiRequestLogsResult]
+  describe 'list_request_logs test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_request_log_settings
+  # Enables or disables API request logging for troubleshooting.
+  # Enables or disables API request logging for troubleshooting.  When enabled (`apiRequestLogging` is set to true), REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached.  You can call [ML:GetRequestLog] or [ML:GetRequestLogs] to download the log files (individually or as a zip file). Call [ML:DeleteRequestLogs] to clear the log by deleting current entries.  Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log.  ###### Note: API request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId isn't logged. Meaning that login_information, NewAccounts, or other distributor-credential calls are not logged. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [DiagnosticsSettingsInformation] :diagnostics_settings_information 
+  # @return [DiagnosticsSettingsInformation]
+  describe 'update_request_log_settings test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end