docusign_esign 0.0.1

data/spec/api/users_api_spec.rb

@@ -0,0 +1,442 @@
+=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::UsersApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UsersApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::UsersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsersApi' do
+    it 'should create an instact of UsersApi' do
+      expect(@instance).to be_instance_of(SwaggerClient::UsersApi)
+    end
+  end
+
+  # unit tests for create
+  # Adds news user to the specified account.
+  # Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [NewUsersDefinition] :new_users_definition 
+  # @return [NewUsersSummary]
+  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 create_signatures
+  # Adds user Signature and initials images to a Signature.
+  # Adds a user signature image and/or user initials image to the specified user.   The userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account.  The rules and processes associated with this are:  * If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used. * If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images.  For each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image.   For example:  `Content-Disposition: file; filename=\"Ron Test20121127083900\"`  If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.  The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.  If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserSignaturesInformation] :user_signatures_information 
+  # @return [UserSignaturesInformation]
+  describe 'create_signatures 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
+  # Removes users account privileges.
+  # This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.  The response returns whether the API execution was successful (200 - OK) or  if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserInfoList] :user_info_list 
+  # @return [UsersResponse]
+  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 delete_contact_with_id
+  # Replaces a particular contact associated with an account for the DocuSign service.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param contact_id The unique identifier of a person in the contacts address book.
+  # @param [Hash] opts the optional parameters
+  # @return [ContactUpdateResponse]
+  describe 'delete_contact_with_id 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_contacts
+  # Delete contacts associated with an account for the DocuSign service.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ContactModRequest] :contact_mod_request 
+  # @return [ContactUpdateResponse]
+  describe 'delete_contacts 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_custom_settings
+  # Deletes custom user settings for a specified user.
+  # Deletes the specified custom user settings for a single user.  ###Deleting Grouped Custom User Settings###  If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request:  `X-DocuSign-User-Settings-Key:group_name`  Where the `group_name` is your designated name for the group of customer user settings.  If the extra header information is not included, only the custom user settings that were added without a group are deleted.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [CustomSettingsInformation] :custom_settings_information 
+  # @return [CustomSettingsInformation]
+  describe 'delete_custom_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 delete_profile_image
+  # Deletes the user profile image for the specified user.
+  # Deletes the user profile image from the  specified user's profile.  The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_profile_image 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_signature
+  # Removes removes signature information for the specified user.
+  # Removes the signature information for the user.  The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.  The `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.   For example encode \"Bob Smith\" as \"Bob%20Smith\".
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param signature_id The ID of the signature being accessed.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_signature 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_signature_image
+  # Deletes the user initials image or the  user signature image for the specified user.
+  # Deletes the specified initials image or signature image for the specified user.  The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.  The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.  The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.   For example encode \"Bob Smith\" as \"Bob%20Smith\".
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param image_type One of **signature_image** or **initials_image**.
+  # @param signature_id The ID of the signature being accessed.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSignature]
+  describe 'delete_signature_image 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_contact_by_id
+  # Gets a particular contact associated with the user's account.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param contact_id The unique identifier of a person in the contacts address book.
+  # @param [Hash] opts the optional parameters
+  # @return [ContactGetResponse]
+  describe 'get_contact_by_id 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_information
+  # Gets the user information for a specified user.
+  # Retrieves the user information for the specified user.   To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :additional_info When set to **true**, the full list of user information is returned for each user in the account.
+  # @option opts [String] :email 
+  # @return [UserInformation]
+  describe 'get_information 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_profile
+  # Retrieves the user profile for a specified user.
+  # Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.  The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [UserProfile]
+  describe 'get_profile 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_profile_image
+  # Retrieves the user profile image for the specified user.
+  # Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.  The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.  If successful, the response returns a 200 - OK and the user profile image.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :encoding 
+  # @return [File]
+  describe 'get_profile_image 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_settings
+  # Gets the user account settings for a specified user.
+  # Retrieves a list of the account settings and email notification information for the specified user.  The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSettingsInformation]
+  describe 'get_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_signature
+  # Gets the user signature information for the specified user.
+  # Retrieves the structure of a single signature with a known signature name.  The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.  The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.   For example encode \"Bob Smith\" as \"Bob%20Smith\".
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param signature_id The ID of the signature being accessed.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSignature]
+  describe 'get_signature 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_signature_image
+  # Retrieves the user initials image or the  user signature image for the specified user.
+  # Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.  The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.  The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.   For example encode \"Bob Smith\" as \"Bob%20Smith\".  ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param image_type One of **signature_image** or **initials_image**.
+  # @param signature_id The ID of the signature being accessed.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :include_chrome 
+  # @return [File]
+  describe 'get_signature_image 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
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :additional_info When set to **true**, the full list of user information is returned for each user in the account.
+  # @option opts [String] :count Number of records to return. The number must be greater than 0 and less than or equal to 100. 
+  # @option opts [String] :email 
+  # @option opts [String] :email_substring Filters the returned user records by the email address or a sub-string of email address.
+  # @option opts [String] :group_id Filters user records returned by one or more group Id's.
+  # @option opts [String] :include_usersettings_for_csv 
+  # @option opts [String] :login_status 
+  # @option opts [String] :not_group_id 
+  # @option opts [String] :start_position Starting value for the list. 
+  # @option opts [String] :status 
+  # @option opts [String] :user_name_substring Filters the user records returned by the user name or a sub-string of user name.
+  # @return [UserInformationList]
+  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 list_custom_settings
+  # Retrieves the custom user settings for a specified user.
+  # Retrieves a list of custom user settings for a single user.  Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system.  ###### Note: Custom user settings are not the same as user account settings.  ###Getting Grouped Custom User Settings###  If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request:  `X-DocuSign-User-Settings-Key:group_name`  Where the `group_name` is your designated name for the group of customer user settings.  If the extra header information is not included, only the custom user settings that were added without a group are retrieved.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [CustomSettingsInformation]
+  describe 'list_custom_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 list_signatures
+  # Retrieves a list of user signature definitions for a specified user.
+  # Retrieves the signature definitions for the specified user.  The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.  The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.   For example encode \"Bob Smith\" as \"Bob%20Smith\".
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSignaturesInformation]
+  describe 'list_signatures 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 post_contacts
+  # Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ContactModRequest] :contact_mod_request 
+  # @return [ContactUpdateResponse]
+  describe 'post_contacts 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 put_contacts
+  # Replaces contacts associated with an account for the DocuSign service.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ContactModRequest] :contact_mod_request 
+  # @return [ContactUpdateResponse]
+  describe 'put_contacts 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_custom_settings
+  # Adds or updates custom user settings for the specified user.
+  # Adds or updates custom user settings for the specified user.  ###### Note: Custom user settings are not the same as user account settings.  Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.  **Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.  ### Grouping Custom User Settings ###  You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings.  To group custom user settings, add the following information in the header, after Content-Type:  `X-DocuSign-User-Settings-Key:group_name`  Where the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below.  When getting or deleting grouped custom user settings, you must include the extra header information.  Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [CustomSettingsInformation] :custom_settings_information 
+  # @return [CustomSettingsInformation]
+  describe 'update_custom_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 update_profile
+  # Updates the user profile information for the specified user.
+  # Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.  You can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserProfile] :user_profile 
+  # @return [nil]
+  describe 'update_profile 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_profile_image
+  # Updates the user profile image for a specified user.
+  # Updates the user profile image by uploading an image to the user profile.  The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_profile_image 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_settings
+  # Updates the user account settings for a specified user.
+  # Updates the account settings list and email notification types for the specified user.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserSettingsInformation] :user_settings_information 
+  # @return [nil]
+  describe 'update_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 update_signature
+  # Updates the user signature for a specified user.
+  # Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.  ###### Note: This will also create a default signature for the user when one does not exist.  The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.  The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.   For example encode \"Bob Smith\" as \"Bob%20Smith\".
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param signature_id The ID of the signature being accessed.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :close_existing_signature When set to **true**, closes the current signature.
+  # @option opts [UserSignatureDefinition] :user_signature_definition 
+  # @return [UserSignature]
+  describe 'update_signature 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_signature_image
+  # Updates the user signature image or user initials image for the specified user.
+  # Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.  The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.  The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.   For example encode \"Bob Smith\" as \"Bob%20Smith\". 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param image_type One of **signature_image** or **initials_image**.
+  # @param signature_id The ID of the signature being accessed.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSignature]
+  describe 'update_signature_image 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_user
+  # Updates the specified user information.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserInformation] :user_information 
+  # @return [UserInformation]
+  describe 'update_user 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_users
+  # Change one or more user in the specified account.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserInformationList] :user_information_list 
+  # @return [UserInformationList]
+  describe 'update_users 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/workspaces_api_spec.rb

@@ -0,0 +1,201 @@
+=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::WorkspacesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'WorkspacesApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::WorkspacesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WorkspacesApi' do
+    it 'should create an instact of WorkspacesApi' do
+      expect(@instance).to be_instance_of(SwaggerClient::WorkspacesApi)
+    end
+  end
+
+  # unit tests for create_workspace
+  # Create a Workspace
+  # Creates a new workspace.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Workspace] :workspace 
+  # @return [Workspace]
+  describe 'create_workspace 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 create_workspace_file
+  # Creates a workspace file.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param folder_id The ID of the folder being accessed.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @return [WorkspaceItem]
+  describe 'create_workspace_file 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_workspace
+  # Delete Workspace
+  # Deletes an existing workspace (logically).
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @return [Workspace]
+  describe 'delete_workspace 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_workspace_folder_items
+  # Deletes workspace one or more specific files/folders from the given folder or root.
+  # 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param folder_id The ID of the folder being accessed.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [WorkspaceItemList] :workspace_item_list 
+  # @return [nil]
+  describe 'delete_workspace_folder_items 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_workspace
+  # Get Workspace
+  # Retrives properties about a workspace given a unique workspaceId. 
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @return [Workspace]
+  describe 'get_workspace 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_workspace_file
+  # Get Workspace File
+  # Retrieves a workspace file (the binary).
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param file_id Specifies the room file ID GUID.
+  # @param folder_id The ID of the folder being accessed.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :is_download When set to **true**, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is **false**.
+  # @option opts [String] :pdf_version When set to **true** the file returned as a PDF.
+  # @return [nil]
+  describe 'get_workspace_file 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_workspace_file_pages
+  # List File Pages
+  # Retrieves a workspace file as rasterized pages.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param file_id Specifies the room file ID GUID.
+  # @param folder_id The ID of the folder being accessed.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :count The maximum number of results to be returned by this request.
+  # @option opts [String] :dpi Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
+  # @option opts [String] :max_height Sets the maximum height (in pixels) of the returned image.
+  # @option opts [String] :max_width Sets the maximum width (in pixels) of the returned image.
+  # @option opts [String] :start_position The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
+  # @return [PageImages]
+  describe 'list_workspace_file_pages 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_workspace_folder_items
+  # List Workspace Folder Contents
+  # Retrieves workspace folder contents, which can include sub folders and files.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param folder_id The ID of the folder being accessed.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :count The maximum number of results to be returned by this request.
+  # @option opts [String] :include_files When set to **true**, file information is returned in the response along with folder information. The default is **false**.
+  # @option opts [String] :include_sub_folders When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**.
+  # @option opts [String] :include_thumbnails When set to **true**, thumbnails are returned as part of the response.  The default is **false**.
+  # @option opts [String] :include_user_detail Set to **true** to return extended details about the user. The default is **false**.
+  # @option opts [String] :start_position The position within the total result set from which to start returning values.
+  # @option opts [String] :workspace_user_id If set, then the results are filtered to those associated with the specified userId.
+  # @return [WorkspaceFolderContents]
+  describe 'list_workspace_folder_items 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_workspaces
+  # List Workspaces
+  # Gets information about the Workspaces that have been created.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param [Hash] opts the optional parameters
+  # @return [WorkspaceList]
+  describe 'list_workspaces 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_workspace
+  # Update Workspace
+  # Updates information about a specific workspace.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Workspace] :workspace 
+  # @return [Workspace]
+  describe 'update_workspace 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_workspace_file
+  # Update Workspace File Metadata
+  # Updates workspace item metadata for one or more specific files/folders.
+  # @param account_id The external account number (int) or account ID Guid.
+  # @param file_id Specifies the room file ID GUID.
+  # @param folder_id The ID of the folder being accessed.
+  # @param workspace_id Specifies the workspace ID GUID.
+  # @param [Hash] opts the optional parameters
+  # @return [WorkspaceItem]
+  describe 'update_workspace_file test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end