docusign_admin 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72e8a3bb0982ac79a97d50a6d27942c31c41e019174b5cd9944179ab8ac7d082
-  data.tar.gz: fc2398f179d10060c8e1f2737accf37ff3d93d2345ed43380a7f4150fc70b669
+  metadata.gz: 6c062d94ed05bf441d92c28560111f91530e246efb42a032232152d1234f4afd
+  data.tar.gz: 76ce3cb71f7b81a786b8572ede1f476c547c4cb933d9f05eb57d5be73e1876a9
 SHA512:
-  metadata.gz: 733199c2ae62f4b164f5431bc353c2602572c8de730805ecfad1b05e63d2fdbc311c5abf55153a00b9af72cefebb93633a41aa2ef3793935599e94a6ce215fa9
-  data.tar.gz: 3cfb640a64e5946d54912cf956f87085f79929c950bfc9745b18d192ecdca257419ada473e6e11c7220b100987f58f20f4af322727fafc5c84d5f1bf279edf6f
+  metadata.gz: 7e3a312d159e247e9477ad8413f1e0e1205caeb38abd3d4d6f65506cc43f720ea4446875402b39ef430b7a92b95717d653d675346403ada36f41666b7b1084f4
+  data.tar.gz: 5e69fa3cdc7157565ff3e829dd52c587483986b054188f5d752cd9cccbd07e657da52841d68d465a3d32a372d2029bb46967cdf7c3058fd013d33bde727a13cf

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [v1.2.0] - Admin API v2.1-1.2.0 - 2023-05-21
+### Changed
+- Added support for version v2.1-1.2.0 of the DocuSign Admin API.
+- Updated the SDK release version.
+
 ## [v1.1.0] - Admin API v2.1-1.1.0 - 2022-04-26
 ### Changed
 - Added support for version v2.1-1.1.0 of the DocuSign Admin API.

data/lib/docusign_admin/api/accounts_api.rb

@@ -209,5 +209,60 @@ module DocuSign_Admin
       end
       return data, status_code, headers
     end
+
+    # Redacts membership data for users with memberships in an account.
+    # Required scopes: user_data_redact
+    # @param account_id The account ID Guid
+    # @param request_model The request body describing the membership to be redacted 
+    # @return [IndividualUserDataRedactionResponse]
+    def redact_individual_membership_data(account_id, request_model)
+      data, _status_code, _headers = redact_individual_membership_data_with_http_info(account_id,  request_model)
+      return data
+    end
+
+    # Redacts membership data for users with memberships in an account.
+    # Required scopes: user_data_redact
+    # @param account_id The account ID Guid
+    # @param request_model The request body describing the membership to be redacted 
+    # @return [Array<(IndividualUserDataRedactionResponse, Fixnum, Hash)>] IndividualUserDataRedactionResponse data, response status code and response headers
+    def redact_individual_membership_data_with_http_info(account_id, request_model)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.redact_individual_membership_data ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.redact_individual_membership_data" if account_id.nil?
+      # verify the required parameter 'request_model' is set
+      fail ArgumentError, "Missing the required parameter 'request_model' when calling AccountsApi.redact_individual_membership_data" if request_model.nil?
+      # resource path
+      local_var_path = "/v2/data_redaction/accounts/{accountId}/user".sub('{format}','json').sub('{' + 'accountId' + '}', account_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'])
+      # 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 = @api_client.object_to_http_body(request_model)
+      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 => 'IndividualUserDataRedactionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#redact_individual_membership_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/docusign_admin/api/bulk_imports_api.rb

@@ -24,7 +24,7 @@ module DocuSign_Admin
     # Creates a new account settings import request.
     # Required scopes: account_write
     # @param organization_id The organization ID Guid
-    # @param file_csv CSV file.
+    # @param file_csv CSV file. 
     # @return [OrganizationAccountSettingsImportResponse]
     def add_bulk_account_settings_import(organization_id, file_csv)
       data, _status_code, _headers = add_bulk_account_settings_import_with_http_info(organization_id, file_csv)
@@ -34,7 +34,7 @@ module DocuSign_Admin
     # Creates a new account settings import request.
     # Required scopes: account_write
     # @param organization_id The organization ID Guid
-    # @param file_csv CSV file.
+    # @param file_csv CSV file. 
     # @return [Array<(OrganizationAccountSettingsImportResponse, Fixnum, Hash)>] OrganizationAccountSettingsImportResponse data, response status code and response headers
     def add_bulk_account_settings_import_with_http_info(organization_id, file_csv)
       if @api_client.config.debugging
@@ -80,7 +80,7 @@ module DocuSign_Admin
     # Import request for adding users to accounts within the organization.
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
-    # @param file_csv CSV file.
+    # @param file_csv CSV file. 
     # @return [OrganizationImportResponse]
     def create_bulk_import_add_users_request(organization_id, file_csv)
       data, _status_code, _headers = create_bulk_import_add_users_request_with_http_info(organization_id, file_csv)
@@ -90,7 +90,7 @@ module DocuSign_Admin
     # Import request for adding users to accounts within the organization.
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
-    # @param file_csv CSV file.
+    # @param file_csv CSV file. 
     # @return [Array<(OrganizationImportResponse, Fixnum, Hash)>] OrganizationImportResponse data, response status code and response headers
     def create_bulk_import_add_users_request_with_http_info(organization_id, file_csv)
       if @api_client.config.debugging
@@ -136,22 +136,26 @@ module DocuSign_Admin
     # Closes the Bulk User Import request
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
+    # @param file_csv CSV file. 
     # @return [OrganizationImportResponse]
-    def create_bulk_import_close_users_request(organization_id)
-      data, _status_code, _headers = create_bulk_import_close_users_request_with_http_info(organization_id)
+    def create_bulk_import_close_users_request(organization_id, file_csv)
+      data, _status_code, _headers = create_bulk_import_close_users_request_with_http_info(organization_id, file_csv)
       return data
     end
 
     # Closes the Bulk User Import request
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
+    # @param file_csv CSV file. 
     # @return [Array<(OrganizationImportResponse, Fixnum, Hash)>] OrganizationImportResponse data, response status code and response headers
-    def create_bulk_import_close_users_request_with_http_info(organization_id)
+    def create_bulk_import_close_users_request_with_http_info(organization_id, file_csv)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_close_users_request ..."
       end
       # verify the required parameter 'organization_id' is set
       fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.create_bulk_import_close_users_request" if organization_id.nil?
+      # verify the required parameter 'file_csv' is set
+      fail ArgumentError, "Missing the required parameter 'file_csv' when calling BulkImportsApi.create_bulk_import_close_users_request" if file_csv.nil?
       # resource path
       local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/close".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
 
@@ -163,10 +167,11 @@ module DocuSign_Admin
       # 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'])
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
 
       # form parameters
       form_params = {}
+      form_params["file.csv"] = file_csv
 
       # http body (model)
       post_body = nil
@@ -239,9 +244,10 @@ module DocuSign_Admin
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
     # @param account_id The account ID Guid
+    # @param file_csv CSV file. 
     # @return [OrganizationImportResponse]
-    def create_bulk_import_single_account_add_users_request(organization_id, account_id)
-      data, _status_code, _headers = create_bulk_import_single_account_add_users_request_with_http_info(organization_id, account_id)
+    def create_bulk_import_single_account_add_users_request(organization_id, account_id, file_csv)
+      data, _status_code, _headers = create_bulk_import_single_account_add_users_request_with_http_info(organization_id, account_id, file_csv)
       return data
     end
 
@@ -249,8 +255,9 @@ module DocuSign_Admin
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
     # @param account_id The account ID Guid
+    # @param file_csv CSV file. 
     # @return [Array<(OrganizationImportResponse, Fixnum, Hash)>] OrganizationImportResponse data, response status code and response headers
-    def create_bulk_import_single_account_add_users_request_with_http_info(organization_id, account_id)
+    def create_bulk_import_single_account_add_users_request_with_http_info(organization_id, account_id, file_csv)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_single_account_add_users_request ..."
       end
@@ -297,9 +304,10 @@ module DocuSign_Admin
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
     # @param account_id The account ID Guid
+    # @param file_csv CSV file. 
     # @return [OrganizationImportResponse]
-    def create_bulk_import_single_account_update_users_request(organization_id, account_id)
-      data, _status_code, _headers = create_bulk_import_single_account_update_users_request_with_http_info(organization_id, account_id)
+    def create_bulk_import_single_account_update_users_request(organization_id, account_id, file_csv)
+      data, _status_code, _headers = create_bulk_import_single_account_update_users_request_with_http_info(organization_id, account_id, file_csv)
       return data
     end
 
@@ -307,8 +315,9 @@ module DocuSign_Admin
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
     # @param account_id The account ID Guid
+    # @param file_csv CSV file. 
     # @return [Array<(OrganizationImportResponse, Fixnum, Hash)>] OrganizationImportResponse data, response status code and response headers
-    def create_bulk_import_single_account_update_users_request_with_http_info(organization_id, account_id)
+    def create_bulk_import_single_account_update_users_request_with_http_info(organization_id, account_id, file_csv)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_single_account_update_users_request ..."
       end
@@ -354,17 +363,19 @@ module DocuSign_Admin
     # Import request for updating users to accounts within the organization.
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
+    # @param file_csv CSV file. 
     # @return [OrganizationImportResponse]
-    def create_bulk_import_update_users_request(organization_id)
-      data, _status_code, _headers = create_bulk_import_update_users_request_with_http_info(organization_id)
+    def create_bulk_import_update_users_request(organization_id, file_csv)
+      data, _status_code, _headers = create_bulk_import_update_users_request_with_http_info(organization_id, file_csv)
       return data
     end
 
     # Import request for updating users to accounts within the organization.
     # Required scopes: user_write
     # @param organization_id The organization ID Guid
+    # @param file_csv CSV file. 
     # @return [Array<(OrganizationImportResponse, Fixnum, Hash)>] OrganizationImportResponse data, response status code and response headers
-    def create_bulk_import_update_users_request_with_http_info(organization_id)
+    def create_bulk_import_update_users_request_with_http_info(organization_id, file_csv)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_update_users_request ..."
       end

data/lib/docusign_admin/api/organizations_api.rb

@@ -0,0 +1,79 @@
+=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 "uri"
+
+module DocuSign_Admin
+
+
+  class OrganizationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = OrganizationsApi.default)
+      @api_client = api_client
+    end
+
+    # Redacts membership and user data for users in an organization.
+    # Required scopes: user_data_redact
+    # @param organization_id The organization ID Guid
+    # @param request_model The request body describing the users and memberships to be redacted 
+    # @return [IndividualUserDataRedactionResponse]
+    def redact_individual_user_data(organization_id, request_model)
+      data, _status_code, _headers = redact_individual_user_data_with_http_info(organization_id,  request_model)
+      return data
+    end
+
+    # Redacts membership and user data for users in an organization.
+    # Required scopes: user_data_redact
+    # @param organization_id The organization ID Guid
+    # @param request_model The request body describing the users and memberships to be redacted 
+    # @return [Array<(IndividualUserDataRedactionResponse, Fixnum, Hash)>] IndividualUserDataRedactionResponse data, response status code and response headers
+    def redact_individual_user_data_with_http_info(organization_id, request_model)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OrganizationsApi.redact_individual_user_data ..."
+      end
+      # verify the required parameter 'organization_id' is set
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.redact_individual_user_data" if organization_id.nil?
+      # verify the required parameter 'request_model' is set
+      fail ArgumentError, "Missing the required parameter 'request_model' when calling OrganizationsApi.redact_individual_user_data" if request_model.nil?
+      # resource path
+      local_var_path = "/v2/data_redaction/organizations/{organizationId}/user".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_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'])
+      # 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 = @api_client.object_to_http_body(request_model)
+      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 => 'IndividualUserDataRedactionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationsApi#redact_individual_user_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/docusign_admin/client/api_client.rb

@@ -35,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/1.1.0/ruby"
+      @user_agent = "Swagger-Codegen/1.2.0/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
@@ -107,10 +107,6 @@ 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,
@@ -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

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