docusign_rooms 1.1.0 → 1.2.0.rc1

data/lib/docusign_rooms/api/regions_api.rb

@@ -37,8 +37,8 @@ module DocuSign_Rooms
     end
 
     # Creates a new region for a company
-    # 
-    # @param account_id 
+    # Creates a new region for a company
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Region]
     def create_region(account_id, body)
@@ -47,8 +47,8 @@ module DocuSign_Rooms
     end
 
     # Creates a new region for a company
-    # 
-    # @param account_id 
+    # Creates a new region for a company
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Array<(Region, Fixnum, Hash)>] Region data, response status code and response headers
     def create_region_with_http_info(account_id, body)
@@ -90,9 +90,9 @@ module DocuSign_Rooms
     end
 
     # Delete a region.
-    # 
+    # Delete a region.
     # @param region_id Id of the desired region
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [nil]
     def delete_region(region_id, account_id)
       delete_region_with_http_info(region_id, account_id)
@@ -100,9 +100,9 @@ module DocuSign_Rooms
     end
 
     # Delete a region.
-    # 
+    # Delete a region.
     # @param region_id Id of the desired region
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def delete_region_with_http_info(region_id, account_id)
       if @api_client.config.debugging
@@ -122,6 +122,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}
@@ -142,9 +144,9 @@ module DocuSign_Rooms
     end
 
     # Get information about the region with the given regionId
-    # 
+    # Get information about the region with the given regionId
     # @param region_id Id of the desired region
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Region]
     def get_region(region_id, account_id)
       data, _status_code, _headers = get_region_with_http_info(region_id, account_id)
@@ -152,9 +154,9 @@ module DocuSign_Rooms
     end
 
     # Get information about the region with the given regionId
-    # 
+    # Get information about the region with the given regionId
     # @param region_id Id of the desired region
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(Region, Fixnum, Hash)>] Region data, response status code and response headers
     def get_region_with_http_info(region_id, account_id)
       if @api_client.config.debugging
@@ -174,6 +176,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}
@@ -195,9 +199,9 @@ module DocuSign_Rooms
     end
 
     # Get region reference counts.
-    # 
+    # This method returns a list of each type of object and the number of objects of that type referencing the specified region.
     # @param region_id Id of the desired region
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [RegionReferenceCountList]
     def get_region_reference_counts(region_id, account_id)
       data, _status_code, _headers = get_region_reference_counts_with_http_info(region_id, account_id)
@@ -205,9 +209,9 @@ module DocuSign_Rooms
     end
 
     # Get region reference counts.
-    # 
+    # This method returns a list of each type of object and the number of objects of that type referencing the specified region.
     # @param region_id Id of the desired region
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(RegionReferenceCountList, Fixnum, Hash)>] RegionReferenceCountList data, response status code and response headers
     def get_region_reference_counts_with_http_info(region_id, account_id)
       if @api_client.config.debugging
@@ -227,6 +231,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}
@@ -247,9 +253,9 @@ module DocuSign_Rooms
       return data, status_code, headers
     end
 
-    # Get account 
-    # 
-    # @param account_id 
+    # Get account regions.
+    # Returns a list of regions that are associated with a Rooms account.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRegionsOptions Options for modifying the behavior of the function.
     # @return [RegionSummaryList]
     def get_regions(account_id, options = DocuSign_Rooms::GetRegionsOptions.default)
@@ -257,9 +263,9 @@ module DocuSign_Rooms
       return data
     end
 
-    # Get account 
-    # 
-    # @param account_id 
+    # Get account regions.
+    # Returns a list of regions that are associated with a Rooms account.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRegionsOptions Options for modifying the behavior of the function.
     # @return [Array<(RegionSummaryList, Fixnum, Hash)>] RegionSummaryList data, response status code and response headers
     def get_regions_with_http_info(account_id, options = DocuSign_Rooms::GetRegionsOptions.default)
@@ -281,6 +287,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/roles_api.rb

@@ -14,7 +14,7 @@ require "uri"
 module DocuSign_Rooms
 
   class GetRoleOptions
-    # 
+    # When set to true, the response includes the `isAssigned` property, which specifies whether the role is currently assigned to any users. The default is false.
     attr_accessor :include_is_assigned
 
     def self.default
@@ -23,16 +23,19 @@ module DocuSign_Rooms
   end
 
   class GetRolesOptions
-    # 
+    # Returns assignable roles based on calling user's company permissions.               DEPRECATED: Please use filterContext parameter to get the assignable roles. AssignableRolesBasedOnCompanyPermissions returns same results as onlyAssignable=true
     attr_accessor :only_assignable
 
-    # 
+    # Attribute establishing filter context for roles being returned - AllRoles, AssignableRolesBasedOnCompanyPermissions, AssignableRolesBasedOnAllPermissions
+    attr_accessor :filter_context
+
+    # A search filter that returns roles by the beginning of the role name. You can enter the beginning of the role name only to return all of the roles that begin with the text that you entered.
     attr_accessor :filter
 
-    # 
+    # The starting zero-based index position of the result set. The default value is 0.
     attr_accessor :start_position
 
-    # 
+    # The number of results to return. This value must be a number between `1` and `100` (default).
     attr_accessor :count
 
     def self.default
@@ -49,8 +52,8 @@ module DocuSign_Rooms
     end
 
     # Creates a role.
-    # 
-    # @param account_id 
+    # Creates a new company role in Rooms
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Role]
     def create_role(account_id, body)
@@ -59,8 +62,8 @@ module DocuSign_Rooms
     end
 
     # Creates a role.
-    # 
-    # @param account_id 
+    # Creates a new company role in Rooms
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Array<(Role, Fixnum, Hash)>] Role data, response status code and response headers
     def create_role_with_http_info(account_id, body)
@@ -102,9 +105,9 @@ module DocuSign_Rooms
     end
 
     # Deletes the role with the given roleId.
-    # 
-    # @param role_id 
-    # @param account_id 
+    # Deletes a role from a company account in Rooms
+    # @param role_id The id of the role.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [nil]
     def delete_role(role_id, account_id)
       delete_role_with_http_info(role_id, account_id)
@@ -112,9 +115,9 @@ module DocuSign_Rooms
     end
 
     # Deletes the role with the given roleId.
-    # 
-    # @param role_id 
-    # @param account_id 
+    # Deletes a role from a company account in Rooms
+    # @param role_id The id of the role.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def delete_role_with_http_info(role_id, account_id)
       if @api_client.config.debugging
@@ -134,6 +137,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}
@@ -154,9 +159,9 @@ module DocuSign_Rooms
     end
 
     # Get information about the role with the given roleId.
-    # 
-    # @param role_id 
-    # @param account_id 
+    # Get information about the role with the given roleId.
+    # @param role_id The id of the role.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRoleOptions Options for modifying the behavior of the function.
     # @return [Role]
     def get_role(role_id, account_id, options = DocuSign_Rooms::GetRoleOptions.default)
@@ -165,9 +170,9 @@ module DocuSign_Rooms
     end
 
     # Get information about the role with the given roleId.
-    # 
-    # @param role_id 
-    # @param account_id 
+    # Get information about the role with the given roleId.
+    # @param role_id The id of the role.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRoleOptions Options for modifying the behavior of the function.
     # @return [Array<(Role, Fixnum, Hash)>] Role data, response status code and response headers
     def get_role_with_http_info(role_id, account_id, options = DocuSign_Rooms::GetRoleOptions.default)
@@ -189,6 +194,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}
@@ -210,8 +217,8 @@ module DocuSign_Rooms
     end
 
     # Gets a paged-list of roles in your company
-    # 
-    # @param account_id 
+    # Returns a list of roles associated with a company account
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRolesOptions Options for modifying the behavior of the function.
     # @return [RoleSummaryList]
     def get_roles(account_id, options = DocuSign_Rooms::GetRolesOptions.default)
@@ -220,8 +227,8 @@ module DocuSign_Rooms
     end
 
     # Gets a paged-list of roles in your company
-    # 
-    # @param account_id 
+    # Returns a list of roles associated with a company account
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRolesOptions Options for modifying the behavior of the function.
     # @return [Array<(RoleSummaryList, Fixnum, Hash)>] RoleSummaryList data, response status code and response headers
     def get_roles_with_http_info(account_id, options = DocuSign_Rooms::GetRolesOptions.default)
@@ -230,12 +237,16 @@ module DocuSign_Rooms
       end
       # verify the required parameter 'account_id' is set
       fail ArgumentError, "Missing the required parameter 'account_id' when calling RolesApi.get_roles" if account_id.nil?
+      if options.filter_context && !['AllRoles', 'AssignableRolesBasedOnCompanyPermissions', 'AssignableRolesBasedOnAllPermissions'].include?(options.filter_context)
+        fail ArgumentError, 'invalid value for "filter_context", must be one of AllRoles, AssignableRolesBasedOnCompanyPermissions, AssignableRolesBasedOnAllPermissions'
+      end
       # resource path
       local_var_path = "/v2/accounts/{accountId}/roles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
 
       # query parameters
       query_params = {}
       query_params[:'onlyAssignable'] = options.only_assignable if !options.only_assignable.nil?
+      query_params[:'filterContext'] = options.filter_context if !options.filter_context.nil?
       query_params[:'filter'] = options.filter if !options.filter.nil?
       query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
       query_params[:'count'] = options.count if !options.count.nil?
@@ -244,6 +255,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}
@@ -265,9 +278,9 @@ module DocuSign_Rooms
     end
 
     # Updates the role with the given roleId.
-    # 
-    # @param role_id 
-    # @param account_id 
+    # Updates the role with the given roleId.
+    # @param role_id The id of the role.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Role]
     def update_role(role_id, account_id, body)
@@ -276,9 +289,9 @@ module DocuSign_Rooms
     end
 
     # Updates the role with the given roleId.
-    # 
-    # @param role_id 
-    # @param account_id 
+    # Updates the role with the given roleId.
+    # @param role_id The id of the role.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Array<(Role, Fixnum, Hash)>] Role data, response status code and response headers
     def update_role_with_http_info(role_id, account_id, body)

data/lib/docusign_rooms/api/room_contact_types_api.rb

@@ -22,7 +22,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid room contact types.
-    # 
+    # Returns a list of room contact types, such as Buyer, Seller, and Listing Agent.
     # @return [GlobalRoomContactTypes]
     def get_room_contact_types()
       data, _status_code, _headers = get_room_contact_types_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid room contact types.
-    # 
+    # Returns a list of room contact types, such as Buyer, Seller, and Listing Agent.
     # @return [Array<(GlobalRoomContactTypes, Fixnum, Hash)>] GlobalRoomContactTypes data, response status code and response headers
     def get_room_contact_types_with_http_info()
       if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/room_folders_api.rb

@@ -34,9 +34,9 @@ module DocuSign_Rooms
     end
 
     # Gets room folders accessible to the calling user.
-    # 
+    # Gets a list of room folders in the specified room that are accessible to the current user.
     # @param room_id The room id from which to retrieve folders.
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRoomFoldersOptions Options for modifying the behavior of the function.
     # @return [RoomFolderList]
     def get_room_folders(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default)
@@ -45,9 +45,9 @@ module DocuSign_Rooms
     end
 
     # Gets room folders accessible to the calling user.
-    # 
+    # Gets a list of room folders in the specified room that are accessible to the current user.
     # @param room_id The room id from which to retrieve folders.
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRoomFoldersOptions Options for modifying the behavior of the function.
     # @return [Array<(RoomFolderList, Fixnum, Hash)>] RoomFolderList data, response status code and response headers
     def get_room_folders_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default)
@@ -70,6 +70,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/room_templates_api.rb

@@ -14,7 +14,7 @@ require "uri"
 module DocuSign_Rooms
 
   class GetRoomTemplatesOptions
-    # Get all room templates you have access to for this office. Response includes Company and Region level  If onlyAssignable is true, and no officeId is provided, user's default office is assumed.
+    # Get all room templates you have access to for this office. Response includes Company and Region level templates. If onlyAssignable is true, and no officeId is provided, user's default office is assumed.
     attr_accessor :office_id
 
     # Get list of templates you have access to. Default value false.
@@ -43,8 +43,8 @@ module DocuSign_Rooms
     end
 
     # Returns all room templates that the active user has access to
-    # 
-    # @param account_id 
+    # This method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRoomTemplatesOptions Options for modifying the behavior of the function.
     # @return [RoomTemplatesSummaryList]
     def get_room_templates(account_id, options = DocuSign_Rooms::GetRoomTemplatesOptions.default)
@@ -53,8 +53,8 @@ module DocuSign_Rooms
     end
 
     # Returns all room templates that the active user has access to
-    # 
-    # @param account_id 
+    # This method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetRoomTemplatesOptions Options for modifying the behavior of the function.
     # @return [Array<(RoomTemplatesSummaryList, Fixnum, Hash)>] RoomTemplatesSummaryList data, response status code and response headers
     def get_room_templates_with_http_info(account_id, options = DocuSign_Rooms::GetRoomTemplatesOptions.default)
@@ -78,6 +78,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}