docusign_admin 1.0.0 → 1.2.0

data/lib/docusign_admin/api/users_api.rb

@@ -13,6 +13,27 @@ require "uri"
 
 module DocuSign_Admin
 
+  class GetUserDSProfileOptions
+    # Sorts user information by account name ascending
+    attr_accessor :sort
+
+    def self.default
+      @@default ||= GetUserDSProfileOptions.new
+    end
+  end
+
+  class GetUserDSProfilesByEmailOptions
+    # The email address of the user
+    attr_accessor :email
+
+    # Sorts user information by account name ascending
+    attr_accessor :sort
+
+    def self.default
+      @@default ||= GetUserDSProfilesByEmailOptions.new
+    end
+  end
+
   class GetUserProfilesOptions
     # The email address
     attr_accessor :email
@@ -420,6 +441,119 @@ module DocuSign_Admin
       return data, status_code, headers
     end
 
+    # Returns user information using the userId for lookup.
+    # Required scopes: user_read
+    # @param organization_id The organization ID Guid
+    # @param user_id The user ID Guid
+    # @param DocuSign_Admin::GetUserDSProfileOptions Options for modifying the behavior of the function.
+    # @return [UsersDrilldownResponse]
+    def get_user_ds_profile(organization_id, user_id, options = DocuSign_Admin::GetUserDSProfileOptions.default)
+      data, _status_code, _headers = get_user_ds_profile_with_http_info(organization_id, user_id, options)
+      return data
+    end
+
+    # Returns user information using the userId for lookup.
+    # Required scopes: user_read
+    # @param organization_id The organization ID Guid
+    # @param user_id The user ID Guid
+    # @param DocuSign_Admin::GetUserDSProfileOptions Options for modifying the behavior of the function.
+    # @return [Array<(UsersDrilldownResponse, Fixnum, Hash)>] UsersDrilldownResponse data, response status code and response headers
+    def get_user_ds_profile_with_http_info(organization_id, user_id, options = DocuSign_Admin::GetUserDSProfileOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.get_user_ds_profile ..."
+      end
+      # verify the required parameter 'organization_id' is set
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.get_user_ds_profile" if organization_id.nil?
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_ds_profile" if user_id.nil?
+      # resource path
+      local_var_path = "/v2.1/organizations/{organizationId}/users/{userId}/dsprofile".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'sort'] = options.sort if !options.sort.nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'UsersDrilldownResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_ds_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns DS user profile information.
+    # Required scopes: user_read
+    # @param organization_id The organization ID Guid
+    # @param DocuSign_Admin::GetUserDSProfilesByEmailOptions Options for modifying the behavior of the function.
+    # @return [UsersDrilldownResponse]
+    def get_user_ds_profiles_by_email(organization_id, options = DocuSign_Admin::GetUserDSProfilesByEmailOptions.default)
+      data, _status_code, _headers = get_user_ds_profiles_by_email_with_http_info(organization_id, options)
+      return data
+    end
+
+    # Returns DS user profile information.
+    # Required scopes: user_read
+    # @param organization_id The organization ID Guid
+    # @param DocuSign_Admin::GetUserDSProfilesByEmailOptions Options for modifying the behavior of the function.
+    # @return [Array<(UsersDrilldownResponse, Fixnum, Hash)>] UsersDrilldownResponse data, response status code and response headers
+    def get_user_ds_profiles_by_email_with_http_info(organization_id, options = DocuSign_Admin::GetUserDSProfilesByEmailOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.get_user_ds_profiles_by_email ..."
+      end
+      # verify the required parameter 'organization_id' is set
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.get_user_ds_profiles_by_email" if organization_id.nil?
+      # resource path
+      local_var_path = "/v2.1/organizations/{organizationId}/users/dsprofile".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'email'] = options.email if !options.email.nil?
+      query_params[:'sort'] = options.sort if !options.sort.nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'UsersDrilldownResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_ds_profiles_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Returns user information.
     # Required scopes: user_read
     # @param organization_id The organization ID Guid

data/lib/docusign_admin/client/api_client.rb

@@ -1,9 +1,9 @@
 =begin
-#DocuSign REST API
+#DocuSign Admin API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#An API for an organization administrator to manage organizations, accounts and users
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -16,6 +16,7 @@ require 'tempfile'
 require 'typhoeus'
 require 'uri'
 require 'jwt'
+require 'addressable/uri'
 
 module DocuSign_Admin
   class ApiClient
@@ -34,7 +35,7 @@ module DocuSign_Admin
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
+      @user_agent = "Swagger-Codegen/1.2.0/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
@@ -105,11 +106,7 @@ module DocuSign_Admin
 
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
       _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
-
-      if header_params['Content-Type'] == 'multipart/form-data'
-        header_params['Content-Disposition'] = 'form-data; name=file; filename=file.csv'
-      end
-
+      
       req_opts = {
         :method => http_method,
         :headers => header_params,
@@ -263,8 +260,8 @@ module DocuSign_Admin
     def build_request_url(path, opts)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      return URI.encode("https://" + self.get_oauth_base_path + path) if opts[:oauth]
-      URI.encode(@config.base_url + path)
+      return Addressable::URI.encode("https://" + self.get_oauth_base_path + path) if opts[:oauth]
+      Addressable::URI.encode(@config.base_url + path)
     end
 
     # Builds the HTTP request body
@@ -277,7 +274,6 @@ module DocuSign_Admin
       # http form
       if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
           header_params['Content-Type'] == 'multipart/form-data'
-
         data = {}
         form_params.each do |key, value|
           case value
@@ -285,7 +281,8 @@ module DocuSign_Admin
             # let typhoeus handle File, Array and nil parameters
             data[key] = value
           else
-            if key == 'file.csv'
+            if header_params['Content-Type'] == 'multipart/form-data'
+              header_params['Content-Disposition'] = 'form-data; name=file; filename=' + key
               data = value
             else
               data[key] = value.to_s
@@ -400,8 +397,11 @@ module DocuSign_Admin
     # Helper method to set oauth base path
     # @param [String] oauth_base_path if passed nil it will determined from base_path
     def set_oauth_base_path(oauth_base_path=nil)
-      self.oauth_base_path = oauth_base_path if oauth_base_path
-      return if self.oauth_base_path
+      if oauth_base_path
+        raise ArgumentError.new('OAuth base path should only include domain name (without https://)')  if oauth_base_path.include? "//"
+        self.oauth_base_path = oauth_base_path
+        return
+      end
 
       # did we need this check as we can determine it from base path
       #raise ArgumentError.new('oAuthBasePath cannot be empty')  unless oauth_base_path
@@ -421,6 +421,7 @@ module DocuSign_Admin
       if !self.oauth_base_path
         self.set_oauth_base_path()
       end
+
       self.oauth_base_path
     end
 
@@ -488,6 +489,7 @@ module DocuSign_Admin
       }
       data, status_code, headers = self.call_api("POST", "/oauth/token", params)
 
+
       raise ApiError.new('Some error accrued during process') if data.nil?
 
       self.set_default_header('Authorization', data.token_type + ' ' + data.access_token)
@@ -578,13 +580,14 @@ module DocuSign_Admin
           :return_type => 'OAuth::OAuthToken',
           :oauth => true
       }
-      data, status_code, headers = self.call_api("POST", '/oauth/token', params)
-      abort(data.inspect)
+      
+      token, status_code, headers = self.call_api("POST", '/oauth/token', params)
 
-    end
+      if status_code == 200
+        self.default_headers.store('Authorization', "#{token.token_type} #{token.access_token}")
 
-    def set_access_token(token_obj)
-      self.default_headers['Authorization'] = token_obj.access_token
+        token
+      end
     end
 
     # Helper method to add default header params

data/lib/docusign_admin/client/api_error.rb

@@ -1,9 +1,9 @@
 =begin
-#DocuSign Organization Administration API
+#DocuSign Admin API
 
 #An API for an organization administrator to manage organizations, accounts and users
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 

data/lib/docusign_admin/client/auth/oauth.rb

@@ -1058,4 +1058,4 @@ module DocuSign_Admin
 
     end
   end
-end
+end

data/lib/docusign_admin/models/ds_group_users_remove_request.rb

@@ -15,17 +15,21 @@ module DocuSign_Admin
   class DSGroupUsersRemoveRequest
     attr_accessor :user_ids
 
+    attr_accessor :user_emails
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'user_ids' => :'user_ids'
+        :'user_ids' => :'user_ids',
+        :'user_emails' => :'user_emails'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'user_ids' => :'Array<String>'
+        :'user_ids' => :'Array<String>',
+        :'user_emails' => :'Array<String>'
       }
     end
 
@@ -42,23 +46,24 @@ module DocuSign_Admin
           self.user_ids = value
         end
       end
+
+      if attributes.has_key?(:'user_emails')
+        if (value = attributes[:'user_emails']).is_a?(Array)
+          self.user_emails = 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
-      if @user_ids.nil?
-        invalid_properties.push('invalid value for "user_ids", user_ids cannot be nil.')
-      end
-
       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?
-      return false if @user_ids.nil?
       true
     end
 
@@ -67,7 +72,8 @@ module DocuSign_Admin
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          user_ids == o.user_ids
+          user_ids == o.user_ids &&
+          user_emails == o.user_emails
     end
 
     # @see the `==` method
@@ -79,7 +85,7 @@ module DocuSign_Admin
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [user_ids].hash
+      [user_ids, user_emails].hash
     end
 
     # Builds the object from hash

data/lib/docusign_admin/models/individual_membership_data_redaction_request.rb

@@ -0,0 +1,183 @@
+=begin
+#DocuSign Admin API
+
+#An API for an organization administrator to manage organizations, accounts and users
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_Admin
+  class IndividualMembershipDataRedactionRequest
+    attr_accessor :user_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_id' => :'user_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'user_id' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      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 &&
+          user_id == o.user_id
+    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
+      [user_id].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_Admin.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