Merge pull request #4 from docusign/1.2.0-v2.1-1.2.0

Version 1.2.0 release

Author: InbarGazit

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.

lib/docusign_admin.rb

@@ -46,9 +46,14 @@
 require 'docusign_admin/models/group_request'
 require 'docusign_admin/models/identity_provider_response'
 require 'docusign_admin/models/identity_providers_response'
+require 'docusign_admin/models/individual_membership_data_redaction_request'
+require 'docusign_admin/models/individual_user_data_redaction_request'
+require 'docusign_admin/models/individual_user_data_redaction_response'
 require 'docusign_admin/models/link_response'
 require 'docusign_admin/models/member_group_response'
 require 'docusign_admin/models/member_groups_response'
+require 'docusign_admin/models/membership_data_redaction_request'
+require 'docusign_admin/models/membership_data_redaction_response'
 require 'docusign_admin/models/membership_response'
 require 'docusign_admin/models/new_account_user_request'
 require 'docusign_admin/models/new_multi_product_user_add_request'
@@ -128,6 +133,7 @@
 require 'docusign_admin/api/bulk_imports_api'
 require 'docusign_admin/api/ds_groups_api'
 require 'docusign_admin/api/identity_providers_api'
+require 'docusign_admin/api/organizations_api'
 require 'docusign_admin/api/product_permission_profiles_api'
 require 'docusign_admin/api/reserved_domains_api'
 require 'docusign_admin/api/users_api'

lib/docusign_admin/api/accounts_api.rb

@@ -209,5 +209,60 @@ def get_permissions_with_http_info(organization_id, account_id)
       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

lib/docusign_admin/api/bulk_imports_api.rb

@@ -24,7 +24,7 @@ def initialize(api_client = BulkImportsApi.default)
     # 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 @@ def add_bulk_account_settings_import(organization_id, file_csv)
     # 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 @@ def add_bulk_account_settings_import_with_http_info(organization_id, file_csv)
     # 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 @@ def create_bulk_import_add_users_request(organization_id, file_csv)
     # 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 @@ def create_bulk_import_add_users_request_with_http_info(organization_id, file_cs
     # 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 @@ def create_bulk_import_close_users_request_with_http_info(organization_id)
       # 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,18 +244,20 @@ def create_bulk_import_external_close_users_request_with_http_info(organization_
     # 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
 
     # Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column
     # 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,18 +304,20 @@ def create_bulk_import_single_account_add_users_request_with_http_info(organizat
     # 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
 
     # Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column
     # 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 @@ def create_bulk_import_single_account_update_users_request_with_http_info(organi
     # 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

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

lib/docusign_admin/client/api_client.rb

@@ -35,7 +35,7 @@ class ApiClient
     # @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 @@ def build_request(http_method, path, opts = {})
       # 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 @@ def build_request_body(header_params, form_params, body)
             # 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