diff --git a/ProjectManagerClient.nuspec b/ProjectManagerClient.nuspec index 2f34756..d539c68 100644 --- a/ProjectManagerClient.nuspec +++ b/ProjectManagerClient.nuspec @@ -2,7 +2,7 @@ ProjectManager.SDK - 107.0.3368 + 110.0.3705 ProjectManager.SDK ProjectManager.com ProjectManager.com, Inc. @@ -14,12 +14,11 @@ docs/README.md ProjectManager API for DotNet - # Patch notes for 107.0.3368 + # Patch notes for 110.0.3705 - These patch notes summarize the changes from version 104.0.3086. + These patch notes summarize the changes from version 107.0.3368. - Deprecated 2 old APIs: - * Changeset.RetrieveProjectChangesByProjectID + Deprecated 1 old APIs: * TaskMetadata.GetTaskMetadata diff --git a/src/Clients/ApiKeyClient.cs b/src/Clients/ApiKeyClient.cs index 68e4d94..19c67f2 100644 --- a/src/Clients/ApiKeyClient.cs +++ b/src/Clients/ApiKeyClient.cs @@ -41,10 +41,16 @@ public ApiKeyClient(ProjectManagerClient client) /// /// Creates a new API key for the current user with the specified options. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// /// Options for the API key to create public async Task> CreateApiKey(ApiKeyCreateDto body) @@ -56,10 +62,16 @@ public async Task> CreateApiKey(ApiKeyCreateDto body) /// /// Returns a list of all API keys within the current workspace. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// public async Task> ListApiKeys() { @@ -68,12 +80,20 @@ public async Task> ListApiKeys() } /// - /// This API call revokes all existing API keys in given workspace. No existing keys will continue to work after this call completes. We strongly encourage you to revoke a single API key at a time; this method should only be used if you need to rapidly halt access to your product for automated systems. + /// This API call revokes all existing API keys in given workspace. No existing keys will continue to work + /// after this call completes. We strongly encourage you to revoke a single API key at a time; this method + /// should only be used if you need to rapidly halt access to your product for automated systems. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// public async Task> RevokeAllApiKeys() { @@ -84,10 +104,16 @@ public async Task> RevokeAllApiKeys() /// /// Revokes a single API key in the current workspace. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// /// The unique identifier of the API key to revoke public async Task> RevokeAPIKey(Guid id) diff --git a/src/Clients/ChangesetClient.cs b/src/Clients/ChangesetClient.cs index aad2892..dc7eba5 100644 --- a/src/Clients/ChangesetClient.cs +++ b/src/Clients/ChangesetClient.cs @@ -41,10 +41,15 @@ public ChangesetClient(ProjectManagerClient client) /// /// Retrieve a Changeset by its unique ID. /// - /// A Changeset is an individual edit that has been made to a project. Since multiple users can edit a project at the same time, individual Changesets are applied in a sequential fashion. If a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a Changeset to determine its conflict resolution status. - /// - /// When checking the status of a Changeset, you can call either RetrieveChangeset or RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has finished processing. + /// A Changeset is an individual edit that has been made to a project. Since multiple users can + /// edit a project at the same time, individual Changesets are applied in a sequential fashion. If + /// a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a + /// Changeset to determine its conflict resolution status. /// + /// When checking the status of a Changeset, you can call either RetrieveChangeset or + /// RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the + /// Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has + /// finished processing. /// /// The unique ID number of the Changeset to retrieve public async Task> RetrieveChangesetStatus(Guid changeSetId) @@ -54,14 +59,23 @@ public async Task> RetrieveChangesetStatus(G } /// - /// Retrieve a Changeset by its unique ID. This endpoint waits for the Changeset to complete its processing prior to returning a result. - /// - /// A Changeset is an individual edit that has been made to a project. Since multiple users can edit a project at the same time, individual Changesets are applied in a sequential fashion. If a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a Changeset to determine its conflict resolution status. + /// Retrieve a Changeset by its unique ID. This endpoint waits for the Changeset to complete its + /// processing prior to returning a result. /// - /// When checking the status of a Changeset, you can call either RetrieveChangeset or RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has finished processing. + /// A Changeset is an individual edit that has been made to a project. Since multiple users can + /// edit a project at the same time, individual Changesets are applied in a sequential fashion. If + /// a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a + /// Changeset to determine its conflict resolution status. /// - /// Although most Changesets complete instantly, some Changesets may need additional time to complete. If the Changeset cannot be processed within a reasonable length of time, this API call may fail. If this API fails, it will return a status error indicating the Changeset is still being processed. + /// When checking the status of a Changeset, you can call either RetrieveChangeset or + /// RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the + /// Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has + /// finished processing. /// + /// Although most Changesets complete instantly, some Changesets may need additional time to + /// complete. If the Changeset cannot be processed within a reasonable length of time, this API + /// call may fail. If this API fails, it will return a status error indicating the Changeset is + /// still being processed. /// /// The unique ID number of the Changeset to retrieve public async Task> RetrieveCompletedChangesetStatus(Guid changeSetId) diff --git a/src/Clients/DashboardClient.cs b/src/Clients/DashboardClient.cs index 19e8526..f0291f7 100644 --- a/src/Clients/DashboardClient.cs +++ b/src/Clients/DashboardClient.cs @@ -40,7 +40,6 @@ public DashboardClient(ProjectManagerClient client) /// /// Returns user dashboard settings - /// /// /// The dashboard type that is not custom. For a list of values, see `DashboardTypeValues`. public async Task> RetrieveDashboardUserSettings(string type) @@ -51,7 +50,6 @@ public async Task> RetrieveDashboardUserSetting /// /// Create or Update User Dashboard Settings - /// /// /// User dashboard settings object public async Task> CreateOrUpdateUserDashboardSettings(DashboardSettingCreateDto body) diff --git a/src/Clients/DiscussionClient.cs b/src/Clients/DiscussionClient.cs index e7dac50..92e1054 100644 --- a/src/Clients/DiscussionClient.cs +++ b/src/Clients/DiscussionClient.cs @@ -40,7 +40,6 @@ public DiscussionClient(ProjectManagerClient client) /// /// Retrieve all comments written about a task - /// /// /// The unique ID number of the task to retrieve comments public async Task> RetrieveTaskComments(Guid taskId) @@ -52,8 +51,10 @@ public async Task> RetrieveTaskComments(Guid /// /// Adds a Markdown-formatted comment to a task. /// - /// Tasks can have discussions attached to them. These discussions can include text with simple formatting. Discussion comments are formatted using [Markdown](https://www.markdownguide.org/) and users should be aware that HTML embedding is not permitted due to the risk of cross-site attacks and other embedding challenges. - /// + /// Tasks can have discussions attached to them. These discussions can include text with simple + /// formatting. Discussion comments are formatted using [Markdown](https://www.markdownguide.org/) + /// and users should be aware that HTML embedding is not permitted due to the risk of cross-site + /// attacks and other embedding challenges. /// /// The unique ID number of the task being commented upon /// The Markdown-formatted text of the comment diff --git a/src/Clients/FileClient.cs b/src/Clients/FileClient.cs index 57c1467..3bf19a8 100644 --- a/src/Clients/FileClient.cs +++ b/src/Clients/FileClient.cs @@ -85,12 +85,15 @@ public async Task> DownloadAThumbnailImage(Guid documentId) /// /// Updates information about a File uploaded to your Workspace. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The unique identifier of the File to update /// Information to change about the File and its location @@ -101,10 +104,10 @@ public async Task> UpdateFile(Guid fileId, UpdateRequestDto } /// - /// In case of soft delete moves file to trash folder. For hard delete completely deletes file's metadata from pm database as well as from amazon storage + /// In case of soft delete moves file to trash folder. For hard delete completely deletes + /// file's metadata from pm database as well as from amazon storage /// /// This API returns a JSON response indicating success or failure. - /// /// /// The unique identifier of the File to delete /// Param indicates that file should be hard deleted diff --git a/src/Clients/HolidayClient.cs b/src/Clients/HolidayClient.cs index b414927..b8ba2f5 100644 --- a/src/Clients/HolidayClient.cs +++ b/src/Clients/HolidayClient.cs @@ -40,7 +40,6 @@ public HolidayClient(ProjectManagerClient client) /// /// Retrieve a list of resource holidays that match an [OData formatted query](https://www.odata.org/). - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -61,7 +60,6 @@ public async Task> QueryResourceHolidays(int? /// /// Retrieve a list of country holidays that match an [OData formatted query](https://www.odata.org/). - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -82,7 +80,6 @@ public async Task> QueryCountryHolidays(int? to /// /// Retrieve a list of global holidays that match an [OData formatted query](https://www.odata.org/). - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records diff --git a/src/Clients/HomeFileClient.cs b/src/Clients/HomeFileClient.cs index 9a7bf8f..ee8a59c 100644 --- a/src/Clients/HomeFileClient.cs +++ b/src/Clients/HomeFileClient.cs @@ -41,12 +41,15 @@ public HomeFileClient(ProjectManagerClient client) /// /// Uploads a file to the My Files folder on your Home Files page. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The full path of a file to upload to the API public async Task> UploadHomeFile(string filename) @@ -58,14 +61,17 @@ public async Task> UploadHomeFile(string filename) /// /// Uploads a file to a specific folder on your Home Files page. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// /// You can organize your files in the Home Files and Project Files pages by adding folders. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the sub folder to put the file into /// The full path of a file to upload to the API diff --git a/src/Clients/IntegrationCategoryClient.cs b/src/Clients/IntegrationCategoryClient.cs index 79f673e..fe14d9a 100644 --- a/src/Clients/IntegrationCategoryClient.cs +++ b/src/Clients/IntegrationCategoryClient.cs @@ -41,8 +41,9 @@ public IntegrationCategoryClient(ProjectManagerClient client) /// /// Retrieves the list of available IntegrationProvider categories. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// public async Task> RetrieveProviderCategories() { diff --git a/src/Clients/IntegrationClient.cs b/src/Clients/IntegrationClient.cs index d1879c8..471a7d3 100644 --- a/src/Clients/IntegrationClient.cs +++ b/src/Clients/IntegrationClient.cs @@ -41,8 +41,8 @@ public IntegrationClient(ProjectManagerClient client) /// /// Retrieves an Integration specified by a unique identifier. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of this Integration public async Task> RetrieveIntegration(Guid integrationId) @@ -54,8 +54,8 @@ public async Task> RetrieveIntegration(Guid integrat /// /// Enable a specific Integration for the current Workspace. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the Integration to enable public async Task> EnableIntegration(Guid integrationId) @@ -67,8 +67,8 @@ public async Task> EnableIntegration(Guid integratio /// /// Disable a specific Integration for the current Workspace. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the Integration to disable public async Task> DisableIntegration(Guid integrationId) @@ -80,8 +80,8 @@ public async Task> DisableIntegration(Guid integrationId) /// /// Retrieves all Integrations for the current Workspace. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// public async Task> RetrieveAllIntegrations() { diff --git a/src/Clients/IntegrationProviderClient.cs b/src/Clients/IntegrationProviderClient.cs index 63c111f..d8b983d 100644 --- a/src/Clients/IntegrationProviderClient.cs +++ b/src/Clients/IntegrationProviderClient.cs @@ -41,8 +41,9 @@ public IntegrationProviderClient(ProjectManagerClient client) /// /// List all available IntegrationProviders that can be activated. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// public async Task> ListProviders() { @@ -53,8 +54,9 @@ public async Task> ListProviders() /// /// Activates an Integration Provider and retrieves authentication information about a specific IntegrationProvider. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the IntegrationProvider for which you are requesting authentication information public async Task> ActivateIntegrationProvider(Guid providerId) @@ -66,8 +68,9 @@ public async Task> ActivateIntegrationProvider( /// /// Allows you to update the auth status of the provider specific connection. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider /// Specify the auth status @@ -80,8 +83,9 @@ public async Task> UpdateIntegrationProvider(Guid providerId /// /// Allows you to deactivate an integration provider. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider public async Task> DeactivateIntegrationProvider(Guid providerId) @@ -95,8 +99,9 @@ public async Task> DeactivateIntegrationProvider(Guid provid /// /// This connection can be used for requests to Providers that require specific user data. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the IntegrationProvider for which you are requesting authentication information public async Task> CreateUserIntegrationProviderConnection(Guid providerId) @@ -108,8 +113,9 @@ public async Task> CreateUserIntegrationProviderConne /// /// Allows you to update the auth status of the provider specific user connection. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider /// Specify the auth status @@ -122,8 +128,9 @@ public async Task> UpdateUserIntegrationProviderConnection(G /// /// Allows you to disconnect the provider specific user connection. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider public async Task> DisconnectUserIntegrationProviderConnection(Guid providerId) diff --git a/src/Clients/LicenseClient.cs b/src/Clients/LicenseClient.cs index 4a55bba..e8d477b 100644 --- a/src/Clients/LicenseClient.cs +++ b/src/Clients/LicenseClient.cs @@ -41,8 +41,10 @@ public LicenseClient(ProjectManagerClient client) /// /// Retrieve information about the current licenses possessed by this Workspace. /// - /// Licenses contain information about your current subscription level and features that have been enabled on your Workspace. To modify the License information, please log on to the ProjectManager.com application and use the Account | Editions screen to review or update your Licenses. - /// + /// Licenses contain information about your current subscription level and features that have + /// been enabled on your Workspace. To modify the License information, please log on to the + /// ProjectManager.com application and use the Account | Editions screen to review or update + /// your Licenses. /// public async Task> RetrieveLicenses() { @@ -53,8 +55,10 @@ public async Task> RetrieveLicenses() /// /// Adds a new License to the current Workspace. /// - /// Licenses contain information about your current subscription level and features that have been enabled on your Workspace. To modify the License information, please log on to the ProjectManager.com application and use the Account | Editions screen to review or update your Licenses. - /// + /// Licenses contain information about your current subscription level and features that have + /// been enabled on your Workspace. To modify the License information, please log on to the + /// ProjectManager.com application and use the Account | Editions screen to review or update + /// your Licenses. /// /// Information about the SKU you wish to add to your Workspace public async Task> AddLicense(string bundleSku) diff --git a/src/Clients/MeClient.cs b/src/Clients/MeClient.cs index 3fd7c81..e30fcc4 100644 --- a/src/Clients/MeClient.cs +++ b/src/Clients/MeClient.cs @@ -41,8 +41,10 @@ public MeClient(ProjectManagerClient client) /// /// Retrieve information about the currently logged on user. /// - /// This API call will always succeed with a 200 OK if called with valid authentication information. If the authentication information provided is not valid, calling this API will return a 401 Authentication Failed error message. If successful, this API returns information about the user including its home URL, email address, user name, and workspace name. - /// + /// This API call will always succeed with a 200 OK if called with valid authentication information. + /// If the authentication information provided is not valid, calling this API will return a 401 + /// Authentication Failed error message. If successful, this API returns information about the user + /// including its home URL, email address, user name, and workspace name. /// public async Task> RetrieveMe() { diff --git a/src/Clients/NptFilesClient.cs b/src/Clients/NptFilesClient.cs index 71c159d..9fd066c 100644 --- a/src/Clients/NptFilesClient.cs +++ b/src/Clients/NptFilesClient.cs @@ -41,12 +41,15 @@ public NptFilesClient(ProjectManagerClient client) /// /// Uploads a file to a non-project task. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the task /// The full path of a file to upload to the API diff --git a/src/Clients/ProjectChargeCodeClient.cs b/src/Clients/ProjectChargeCodeClient.cs index 2489255..5562d70 100644 --- a/src/Clients/ProjectChargeCodeClient.cs +++ b/src/Clients/ProjectChargeCodeClient.cs @@ -41,8 +41,9 @@ public ProjectChargeCodeClient(ProjectManagerClient client) /// /// Retrieve all defined ChargeCodes that can be used when creating Projects. /// - /// A ChargeCode is a code used to identify costs within your Projects. Each ChargeCode has a name and a unique identifier. ChargeCodes are defined per Workspace and are shared among Projects. - /// + /// A ChargeCode is a code used to identify costs within your Projects. Each ChargeCode has + /// a name and a unique identifier. ChargeCodes are defined per Workspace and are shared + /// among Projects. /// public async Task> RetrieveChargeCodes() { diff --git a/src/Clients/ProjectClient.cs b/src/Clients/ProjectClient.cs index 4697a02..992cb67 100644 --- a/src/Clients/ProjectClient.cs +++ b/src/Clients/ProjectClient.cs @@ -41,8 +41,9 @@ public ProjectClient(ProjectManagerClient client) /// /// Retrieve a list of Projects that match an [OData formatted query](https://www.odata.org/). /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -64,8 +65,9 @@ public async Task> QueryProjects(int? top = null, int? /// /// Create a new project based on the details provided. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// Information about the Project you wish to create public async Task> CreateProject(ProjectCreateDto body) @@ -77,8 +79,9 @@ public async Task> CreateProject(ProjectCreateDto body) /// /// Retrieves a project based on its unique identifier. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// The unique identifier of the Project to retrieve. public async Task> RetrieveProject(string projectId) @@ -90,10 +93,13 @@ public async Task> RetrieveProject(string projectId) /// /// Update an existing Project and replace the values of fields specified. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// - /// Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset. + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// + /// Multiple users can be working on data at the same time. When you call an API to update an + /// object, this call is converted into a Changeset that is then applied sequentially. You can use + /// RetrieveChangeset to see the status of an individual Changeset. /// /// The unique identifier of the Project to update /// All non-null fields in this object will replace previous data within the Project @@ -106,8 +112,9 @@ public async Task> UpdateProject(Guid projectId, ProjectUpda /// /// Delete a project based on the details provided. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// The unique identifier of the Project to delete /// Hard delete project true or false diff --git a/src/Clients/ProjectCustomerClient.cs b/src/Clients/ProjectCustomerClient.cs index 29abb58..22a2196 100644 --- a/src/Clients/ProjectCustomerClient.cs +++ b/src/Clients/ProjectCustomerClient.cs @@ -41,8 +41,9 @@ public ProjectCustomerClient(ProjectManagerClient client) /// /// Retrieves all ProjectCustomers defined within your Workspace. /// - /// A ProjectCustomer is a code used to identify customers associated with your Projects. Each ProjectCustomer has a name and a unique identifier. ProjectCustomers are defined per Workspace and are shared among Projects. - /// + /// A ProjectCustomer is a code used to identify customers associated with your Projects. Each + /// ProjectCustomer has a name and a unique identifier. ProjectCustomers are defined per + /// Workspace and are shared among Projects. /// public async Task> RetrieveProjectCustomers() { diff --git a/src/Clients/ProjectFieldClient.cs b/src/Clients/ProjectFieldClient.cs index d7a6fda..2dd4811 100644 --- a/src/Clients/ProjectFieldClient.cs +++ b/src/Clients/ProjectFieldClient.cs @@ -41,8 +41,10 @@ public ProjectFieldClient(ProjectManagerClient client) /// /// Retrieves all ProjectFields defined within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// public async Task> RetrieveProjectFields() { @@ -53,8 +55,10 @@ public async Task> RetrieveProjectFie /// /// Creates a new ProjectField within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// Information about the ProjectField to create public async Task> CreateProjectField(CreateProjectFieldDto body) @@ -66,8 +70,10 @@ public async Task> CreateProjectField /// /// Deletes an existing ProjectField within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier or short ID of this ProjectField public async Task> DeleteProjectField(string fieldId) @@ -79,8 +85,10 @@ public async Task> DeleteProjectField(string fieldId) /// /// Replaces the current value of a ProjectField for a specific Project within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier of the Project that contains this ProjectField /// The unique identifier or short ID of this ProjectField @@ -94,8 +102,10 @@ public async Task> UpdateProjectFieldValue(Guid projectId, s /// /// Retrieves the current ProjectField value for a particular Project and ProjectField. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier of the Project of the value to retrieve /// The unique identifier or short ID of the ProjectField of the value to retrieve @@ -108,8 +118,10 @@ public async Task> RetrieveProjectFieldValue(G /// /// Retrieves all ProjectField values for a particular Project. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier of the Project for which we want ProjectField values public async Task> RetrieveAllProjectFieldValues(Guid projectId) diff --git a/src/Clients/ProjectFileClient.cs b/src/Clients/ProjectFileClient.cs index 9a1c7c6..8455857 100644 --- a/src/Clients/ProjectFileClient.cs +++ b/src/Clients/ProjectFileClient.cs @@ -41,12 +41,15 @@ public ProjectFileClient(ProjectManagerClient client) /// /// Uploads a file to the All Files folder on the Files page within the project that you specify. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the project /// The full path of a file to upload to the API @@ -59,14 +62,17 @@ public async Task> UploadProjectFile(Guid projectId, string /// /// Uploads a file to a specific folder on the Files page within the project that you specify. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// /// You can organize your files in the Home Files and Project Files pages by adding folders. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the project /// The reference to the sub folder to put the file into diff --git a/src/Clients/ProjectFolderClient.cs b/src/Clients/ProjectFolderClient.cs index 875b90b..b22fdf8 100644 --- a/src/Clients/ProjectFolderClient.cs +++ b/src/Clients/ProjectFolderClient.cs @@ -42,7 +42,6 @@ public ProjectFolderClient(ProjectManagerClient client) /// Retrieves all ProjectFolders defined within your Workspace. /// /// A ProjectFolder is a named storage location that can contain Projects. - /// /// public async Task> RetrieveProjectFolders() { diff --git a/src/Clients/ProjectMembersClient.cs b/src/Clients/ProjectMembersClient.cs index fd42fcb..e606f48 100644 --- a/src/Clients/ProjectMembersClient.cs +++ b/src/Clients/ProjectMembersClient.cs @@ -41,8 +41,8 @@ public ProjectMembersClient(ProjectManagerClient client) /// /// Returns a list of users that can be added as members of a new project, as well as their available project security roles. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// public async Task> RetrieveNewProjectMembers() { @@ -51,10 +51,11 @@ public async Task> RetrieveNewProjectMembers() } /// - /// Returns a list of users that are currently members of a specified project, as well as their current project security roles and available project security roles. Optionally include users who are not currently members of the project, but who are available to be added. - /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. + /// Returns a list of users that are currently members of a specified project, as well as their current project security roles and available project security roles. + /// Optionally include users who are not currently members of the project, but who are available to be added. /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to the project /// Set to true to include all users in the workspace @@ -69,8 +70,8 @@ public async Task> RetrieveProjectMembers(Guid p /// /// Returns the project security role in a specified project for a current project member. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference of Project /// Reference of User @@ -83,8 +84,8 @@ public async Task> RetrieveUserProjectMembership(G /// /// Creates a membership for a user in a specified project, and assigns the user the appropriate project access based on the specified project security role. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to Project /// Reference to User @@ -98,8 +99,8 @@ public async Task> CreateUserProjectMembership(Gui /// /// Updates the project access for a current member of a specified project by giving the user a new project security role. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to Project /// Reference to User @@ -113,8 +114,8 @@ public async Task> UpdateUserProjectMembership(Gui /// /// Removes a current project member from a specified project. This removes the user's access to that project. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to Project /// Reference to User diff --git a/src/Clients/ProjectPriorityClient.cs b/src/Clients/ProjectPriorityClient.cs index ce79cd4..a5d8312 100644 --- a/src/Clients/ProjectPriorityClient.cs +++ b/src/Clients/ProjectPriorityClient.cs @@ -41,10 +41,12 @@ public ProjectPriorityClient(ProjectManagerClient client) /// /// Retrieves all ProjectPriorities defined within your Workspace. /// - /// A ProjectPriority is a named priority level used by your business to determine how to decide which Projects are the most important. You can name your ProjectPriority levels anything you like and you can reorganize the order of the ProjectPriority levels at any time. - /// - /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even if they may have similar names, they are different objects and must be tracked separately. + /// A ProjectPriority is a named priority level used by your business to determine how to decide + /// which Projects are the most important. You can name your ProjectPriority levels anything you like + /// and you can reorganize the order of the ProjectPriority levels at any time. /// + /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even + /// if they may have similar names, they are different objects and must be tracked separately. /// public async Task> RetrieveProjectPriorities() { diff --git a/src/Clients/ProjectStatusClient.cs b/src/Clients/ProjectStatusClient.cs index f0b82ba..3ad27c1 100644 --- a/src/Clients/ProjectStatusClient.cs +++ b/src/Clients/ProjectStatusClient.cs @@ -41,8 +41,9 @@ public ProjectStatusClient(ProjectManagerClient client) /// /// Retrieves all ProjectStatuses defined within your Workspace. /// - /// A ProjectStatus is a named condition used by your business to categorize the completion level of Tasks and Projects within your Workspace. You can name your ProjectStatus levels anything you like and you can reorganize the order of the ProjectPriority levels at any time. - /// + /// A ProjectStatus is a named condition used by your business to categorize the completion level + /// of Tasks and Projects within your Workspace. You can name your ProjectStatus levels anything + /// you like and you can reorganize the order of the ProjectPriority levels at any time. /// public async Task> RetrieveProjectStatuses() { diff --git a/src/Clients/ProjectTemplateClient.cs b/src/Clients/ProjectTemplateClient.cs index 15ace0b..23221c4 100644 --- a/src/Clients/ProjectTemplateClient.cs +++ b/src/Clients/ProjectTemplateClient.cs @@ -41,8 +41,9 @@ public ProjectTemplateClient(ProjectManagerClient client) /// /// Retrieves all ProjectTemplates defined in the system. /// - /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory system. - /// + /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied + /// to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory + /// system. /// public async Task> RetrieveProjectTemplates() { @@ -53,8 +54,9 @@ public async Task> RetrieveProjectTemplates() /// /// Retrieves all ProjectTemplate Categories defined in the system. /// - /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory system. - /// + /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied + /// to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory + /// system. /// public async Task> RetrieveTemplateCategories() { diff --git a/src/Clients/ResourceClient.cs b/src/Clients/ResourceClient.cs index 0201c45..6d7f7cf 100644 --- a/src/Clients/ResourceClient.cs +++ b/src/Clients/ResourceClient.cs @@ -41,8 +41,11 @@ public ResourceClient(ProjectManagerClient client) /// /// Create a new Resource within your Workspace. /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The details for the new Resource to create public async Task> CreateResource(ResourceCreateDto body) @@ -54,8 +57,11 @@ public async Task> CreateResource(ResourceCreateDto bod /// /// Retrieve a list of Resources that match an [OData formatted query](https://www.odata.org/). /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -77,8 +83,11 @@ public async Task> QueryResources(int? top = null, in /// /// Updates an existing Resource based on information you provide. /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The id of the resource /// The information to update the resource @@ -91,8 +100,11 @@ public async Task> UpdateResource(Guid resourceId, Reso /// /// Retrieve the Resource matching the specified unique ID. /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The id of the Resource public async Task> RetrieveResource(Guid resourceId) diff --git a/src/Clients/ResourceSkillClient.cs b/src/Clients/ResourceSkillClient.cs index e820ed2..83e4ef3 100644 --- a/src/Clients/ResourceSkillClient.cs +++ b/src/Clients/ResourceSkillClient.cs @@ -41,8 +41,10 @@ public ResourceSkillClient(ProjectManagerClient client) /// /// Retrieves all ResourceSkills defined within your Workspace. /// - /// A ResourceSkill is a capability possessed by a Resource that can be used to distinguish different classes of Resources suitable for use by a Task. You can specify that a Task requires a Resource with a particular set of ResourceSkills and then allocate Resources based on whether or not they have the suitable ResourceSkills. - /// + /// A ResourceSkill is a capability possessed by a Resource that can be used to distinguish + /// different classes of Resources suitable for use by a Task. You can specify that a Task + /// requires a Resource with a particular set of ResourceSkills and then allocate Resources + /// based on whether or not they have the suitable ResourceSkills. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -63,7 +65,6 @@ public async Task> RetrieveResourceSkills(int? t /// /// Create a Resource Skill. - /// /// /// The name of the skill to create. public async Task> CreateResourceSkill(CreateResourceSkillDto body) @@ -74,7 +75,6 @@ public async Task> CreateResourceSkill(CreateResou /// /// Update a Resource Skill. - /// /// /// The id of the skill to update. /// The data of the skill to update. @@ -86,7 +86,6 @@ public async Task> UpdateResourceSkill(Guid skillI /// /// The endpoint is used to delete a resource skill. Users assigned to this skill will no longer be assigned thereafter. - /// /// /// The Id of the skill to be removed. public async Task> DeleteResourceSkill(Guid resourceSkillId) diff --git a/src/Clients/ResourceTeamClient.cs b/src/Clients/ResourceTeamClient.cs index 32549a5..6df44b4 100644 --- a/src/Clients/ResourceTeamClient.cs +++ b/src/Clients/ResourceTeamClient.cs @@ -41,8 +41,9 @@ public ResourceTeamClient(ProjectManagerClient client) /// /// Retrieves all ResourceTeams defined within your Workspace that match an [OData formatted query](https://www.odata.org/). /// - /// A ResourceTeam is a grouping of Resources that allows you to keep track of assignments in a manner consistent with your business needs. You can assign Resources to be members of zero, one, or many ResourceTeams. - /// + /// A ResourceTeam is a grouping of Resources that allows you to keep track of assignments + /// in a manner consistent with your business needs. You can assign Resources to be members + /// of zero, one, or many ResourceTeams. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -63,7 +64,6 @@ public async Task> RetrieveResourceTeams(int? top /// /// Create a Resource Team. - /// /// /// The name of the team to create. public async Task> CreateResourceTeam(CreateResourceTeamDto body) @@ -74,7 +74,6 @@ public async Task> CreateResourceTeam(CreateResourc /// /// The endpoint is used to delete a resource team. Users assigned to this team will no longer be assigned thereafter. - /// /// /// The Id of the team to be removed. public async Task> DeleteResourceTeam(Guid resourceTeamId) @@ -85,7 +84,6 @@ public async Task> DeleteResourceTeam(Guid resourceTeamId) /// /// Update a Resource Team. - /// /// /// The id of the resource team /// The name of the team to Update. diff --git a/src/Clients/TagClient.cs b/src/Clients/TagClient.cs index 72ed87e..c042a08 100644 --- a/src/Clients/TagClient.cs +++ b/src/Clients/TagClient.cs @@ -41,8 +41,8 @@ public TagClient(ProjectManagerClient client) /// /// Retrieve a list of Tags that match an [OData formatted query](https://www.odata.org/). /// - /// A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color. - /// + /// A Tag is a named categorization you can use to distinguish objects from each other. + /// Tags each have a unique identifier, a name, and a color. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -64,8 +64,8 @@ public async Task> QueryTags(int? top = null, int? skip = /// /// Creates a new Tag based on information you provide. /// - /// A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color. - /// + /// A Tag is a named categorization you can use to distinguish objects from each other. + /// Tags each have a unique identifier, a name, and a color. /// /// The information for the new Tag to create public async Task> CreateTag(TagCreateDto body) @@ -77,8 +77,8 @@ public async Task> CreateTag(TagCreateDto body) /// /// Updates an existing Tag based on information you provide. /// - /// A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color. - /// + /// A Tag is a named categorization you can use to distinguish objects from each other. + /// Tags each have a unique identifier, a name, and a color. /// /// The id of the tag /// The information to update the tag diff --git a/src/Clients/TaskAssigneeClient.cs b/src/Clients/TaskAssigneeClient.cs index 94b2e2b..24bdabd 100644 --- a/src/Clients/TaskAssigneeClient.cs +++ b/src/Clients/TaskAssigneeClient.cs @@ -41,10 +41,12 @@ public TaskAssigneeClient(ProjectManagerClient client) /// /// Replace all TaskAssignees on a Task with new TaskAssignees. /// - /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources to a Task and designate how much of their time will be allocated to this Task. - /// - /// In the request body, id is the id of the Resource you would like to assign to the Task, and assignedEffort is the amount of time that Resource is expected to spend on the task. assignedEffort should be entered in minutes. + /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources + /// to a Task and designate how much of their time will be allocated to this Task. /// + /// In the request body, id is the id of the Resource you would like to assign to the Task, and + /// assignedEffort is the amount of time that Resource is expected to spend on the task. assignedEffort + /// should be entered in minutes. /// /// The unique identifier of the Task whose TaskAssignees will be replaced /// The new list of TaskAssignees for this Task @@ -55,10 +57,12 @@ public async Task> ReplaceTaskAssignees(Guid tas } /// - /// Adds or updates a TaskAssignee to a Task. If the TaskAssignee is already assigned to the Task, update their allocation. If the TaskAssignee is not yet assigned to the Task, assign them and set their allocation level to the correct amount. - /// - /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources to a Task and designate what proportion of their time will be allocated to this Task. + /// Adds or updates a TaskAssignee to a Task. If the TaskAssignee is already assigned to the Task, update + /// their allocation. If the TaskAssignee is not yet assigned to the Task, assign them and set their + /// allocation level to the correct amount. /// + /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources + /// to a Task and designate what proportion of their time will be allocated to this Task. /// /// The unique identifier of the Task to add or update an assignment /// List of Assignee data @@ -71,8 +75,8 @@ public async Task> CreateOrUpdateTaskAssignee(Gu /// /// Remove one or more TaskAssignees from a Task. /// - /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources to a Task and designate what proportion of their time will be allocated to this Task. - /// + /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources + /// to a Task and designate what proportion of their time will be allocated to this Task. /// /// The unique identifier of the Task whose TaskAssignee will be removed /// List of TaskAssignee records to remove diff --git a/src/Clients/TaskClient.cs b/src/Clients/TaskClient.cs index 97070f8..62cc665 100644 --- a/src/Clients/TaskClient.cs +++ b/src/Clients/TaskClient.cs @@ -41,8 +41,9 @@ public TaskClient(ProjectManagerClient client) /// /// Retrieve a list of Tasks that match an [OData formatted query](https://www.odata.org/). /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -62,10 +63,13 @@ public async Task> QueryTasks(int? top = null, int? skip } /// - /// Retrieve a Task by its unique identifier or by its short ID. A Task has both a unique identifier, which is a GUID, and a short ID, which is a small text label that is unique only within your Workspace. - /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. + /// Retrieve a Task by its unique identifier or by its short ID. A Task has both a unique + /// identifier, which is a GUID, and a short ID, which is a small text label that is unique + /// only within your Workspace. /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The unique identifier or short ID of the Task to retrieve public async Task> RetrieveTask(string taskId) @@ -77,12 +81,17 @@ public async Task> RetrieveTask(string taskId) /// /// Update an existing Task and replace the values of fields specified. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// - /// Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset. + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// - /// Known Issues: This API returns an error if your Update call includes too many changes in a single API call. Please restrict usage to one change per API request. This API will be deprecated and replaced with an improved API call in a future release. + /// Multiple users can be working on data at the same time. When you call an API to update an + /// object, this call is converted into a Changeset that is then applied sequentially. You can use + /// RetrieveChangeset to see the status of an individual Changeset. /// + /// Known Issues: This API returns an error if your Update call includes too many changes in a + /// single API call. Please restrict usage to one change per API request. This API will be + /// deprecated and replaced with an improved API call in a future release. /// /// The unique identifier of the Task to update /// All non-null fields in this object will replace existing data in the Task @@ -95,10 +104,13 @@ public async Task> UpdateTask(Guid taskId, TaskU /// /// Delete an existing Task. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// - /// Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset. + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// + /// Multiple users can be working on data at the same time. When you call an API to update an + /// object, this call is converted into a Changeset that is then applied sequentially. You can use + /// RetrieveChangeset to see the status of an individual Changeset. /// /// Unique identifier of the Task to delete public async Task> DeleteTask(Guid taskId) @@ -110,8 +122,9 @@ public async Task> DeleteTask(Guid taskId) /// /// Create a new Task within a specified project. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The unique identifier of the Project that will contain this Task /// The new Task to create @@ -124,10 +137,12 @@ public async Task> CreateTask(Guid projectId, Ta /// /// Retrieves all TaskPriorities defined within your Workspace. /// - /// A TaskPriority is a named priority level used by your business to determine how to decide which Tasks are the most important. You can name your TaskPriority levels anything you like and you can reorganize the order of the TaskPriority levels at any time. - /// - /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even if they may have similar names, they are different objects and must be tracked separately. + /// A TaskPriority is a named priority level used by your business to determine how to decide + /// which Tasks are the most important. You can name your TaskPriority levels anything you like + /// and you can reorganize the order of the TaskPriority levels at any time. /// + /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even + /// if they may have similar names, they are different objects and must be tracked separately. /// public async Task> RetrieveTaskPriorities() { @@ -138,8 +153,9 @@ public async Task> RetrieveTaskPriorities() /// /// Create multiple new Tasks within a specified project with a single API call. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The unique identifier of the Project that will contain these Tasks /// The list of new Tasks to create @@ -151,7 +167,6 @@ public async Task> CreateManyTasks(Guid projec /// /// Adds a task parent relationship - /// /// /// The task that will become the child /// The parent task @@ -163,7 +178,6 @@ public async Task> AddParentTask(Guid taskId, Gu /// /// Updates a task parent relationship - /// /// /// The task that will become the child /// The parent task @@ -175,7 +189,6 @@ public async Task> UpdateParentTask(Guid taskId, /// /// Removes a task parent relationship completely - /// /// /// The child task public async Task> RemoveParentTask(Guid taskId) diff --git a/src/Clients/TaskFieldClient.cs b/src/Clients/TaskFieldClient.cs index 23b0b3e..a91ca52 100644 --- a/src/Clients/TaskFieldClient.cs +++ b/src/Clients/TaskFieldClient.cs @@ -41,8 +41,10 @@ public TaskFieldClient(ProjectManagerClient client) /// /// Retrieves all TaskFields defined for a specific Project within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Project to retrieve TaskFields public async Task> RetrieveTaskFields(Guid projectId) @@ -54,8 +56,10 @@ public async Task> RetrieveTaskFields(Guid projectId /// /// Creates a new TaskField for a specific Project within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Project within which to create this TaskField /// Information about the TaskField to create @@ -68,8 +72,10 @@ public async Task> CreateTaskField(Guid projectI /// /// Retrieve a list of TaskFields that match an [OData formatted query](https://www.odata.org/). /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside a Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside a Project. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -91,8 +97,10 @@ public async Task> QueryTaskFields(int? top = null, /// /// Deletes a TaskField for a specific Project within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Project that contains this TaskField /// The unique identifier of the TaskField to delete @@ -105,8 +113,10 @@ public async Task> DeleteTaskField(Guid projectId, Guid fiel /// /// Retrieves all TaskField values for a particular Task. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Task for which we want TaskField values public async Task> RetrieveAllTaskFieldValues(Guid taskId) @@ -118,8 +128,10 @@ public async Task> RetrieveAllTaskFieldValues(G /// /// Retrieve a list of TaskFieldValues that match an [OData formatted query](https://www.odata.org/). /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -141,8 +153,10 @@ public async Task> QueryTaskFieldValues(int? to /// /// Retrieves the current TaskField value for a particular Task and TaskField. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Task of the value to retrieve /// The unique identifier of the TaskField of the value to retrieve @@ -155,8 +169,10 @@ public async Task> RetrieveTaskFieldValue(Guid ta /// /// Replaces the current value of a TaskField for a specific Task within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Task whose value you wish to update /// The unique identifier of the TaskField whose value you wish to update diff --git a/src/Clients/TaskFileClient.cs b/src/Clients/TaskFileClient.cs index 7a4535e..569c204 100644 --- a/src/Clients/TaskFileClient.cs +++ b/src/Clients/TaskFileClient.cs @@ -41,12 +41,15 @@ public TaskFileClient(ProjectManagerClient client) /// /// Uploads a file to a task. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the task /// The full path of a file to upload to the API diff --git a/src/Clients/TaskMetadataClient.cs b/src/Clients/TaskMetadataClient.cs index cb8d864..9e52689 100644 --- a/src/Clients/TaskMetadataClient.cs +++ b/src/Clients/TaskMetadataClient.cs @@ -40,7 +40,6 @@ public TaskMetadataClient(ProjectManagerClient client) /// /// Adds a metadata to a task - /// /// /// Task ID /// If metadata is for system or customer, isSystem = true is only of ProjectManager diff --git a/src/Clients/TaskStatusClient.cs b/src/Clients/TaskStatusClient.cs index 695de17..cfc0675 100644 --- a/src/Clients/TaskStatusClient.cs +++ b/src/Clients/TaskStatusClient.cs @@ -41,8 +41,9 @@ public TaskStatusClient(ProjectManagerClient client) /// /// Retrieves the list of TaskStatus levels for a specific Project within your Workspace. /// - /// A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business and determine which status levels are considered done. - /// + /// A TaskStatus is a named status level used by your business to determine how to measure the + /// progress of Tasks. You can define your own named status levels that are appropriate for + /// your business and determine which status levels are considered done. /// /// The unique identifier of the Project to retrieve TaskStatuses public async Task> RetrieveTaskStatuses(Guid projectId) @@ -54,8 +55,9 @@ public async Task> RetrieveTaskStatuses(Guid projec /// /// Creates a new TaskStatus level for a specific Project within your Workspace. /// - /// A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business. - /// + /// A TaskStatus is a named status level used by your business to determine how to measure the + /// progress of Tasks. You can define your own named status levels that are appropriate for + /// your business. /// /// The unique identifier of the Project for the new TaskStatus /// Information about the new TaskStatus level to create within this Project @@ -68,8 +70,9 @@ public async Task> CreateTaskStatus(Guid projectId, T /// /// Updates an existing TaskStatus level for a specific Project within your Workspace. /// - /// A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business. - /// + /// A TaskStatus is a named status level used by your business to determine how to measure the + /// progress of Tasks. You can define your own named status levels that are appropriate for + /// your business. /// /// The unique identifier of the Project for the new TaskStatus /// Information about the existing TaskStatus level to update within this Project @@ -82,8 +85,8 @@ public async Task> UpdateTaskStatus(Guid projectId, T /// /// The endpoint is used to delete a TaskStatus. /// - /// You will not be able to delete a TaskStatus if there are tasks that have been assigned to this status level or if the TaskStatus is the default status level. - /// + /// You will not be able to delete a TaskStatus if there are tasks that have been assigned to this status level + /// or if the TaskStatus is the default status level. /// /// The unique identifier of the Project for the TaskStatus level to delete /// The Id of the TaskStatus level to be removed. diff --git a/src/Clients/TaskTagClient.cs b/src/Clients/TaskTagClient.cs index 3e2acd9..8af133d 100644 --- a/src/Clients/TaskTagClient.cs +++ b/src/Clients/TaskTagClient.cs @@ -41,8 +41,9 @@ public TaskTagClient(ProjectManagerClient client) /// /// Replaces the existing TaskTags on a Task with a newly provided list of TaskTags. /// - /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you classify your Tasks and prioritize work. - /// + /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many + /// TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you + /// classify your Tasks and prioritize work. /// /// The unique identifier of the Task for which we will replace TaskTags /// The replacement list of TaskTags for this Task @@ -55,8 +56,9 @@ public async Task> ReplaceTaskTags(Guid taskId, /// /// Add one or more new TaskTags to a Task. /// - /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you classify your Tasks and prioritize work. - /// + /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many + /// TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you + /// classify your Tasks and prioritize work. /// /// The unique identifier of the Task for which we will add TaskTags /// The new TaskTags to add to this Task @@ -69,8 +71,9 @@ public async Task> AddTaskTagToTask(Guid taskId, /// /// Removes one or more existing TaskTags from a Task. /// - /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you classify your Tasks and prioritize work. - /// + /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many + /// TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you + /// classify your Tasks and prioritize work. /// /// The unique identifier of the Task for which we will remove existing TaskTags /// The TaskTags to remove from this Task diff --git a/src/Clients/TimesheetClient.cs b/src/Clients/TimesheetClient.cs index 0f0a261..8d1f4ba 100644 --- a/src/Clients/TimesheetClient.cs +++ b/src/Clients/TimesheetClient.cs @@ -40,7 +40,6 @@ public TimesheetClient(ProjectManagerClient client) /// /// Creates new time entry for given resource on given day. - /// /// /// Payload public async Task> CreateTimeEntry(TimesheetCreateRequestDto body) @@ -53,7 +52,6 @@ public async Task> CreateTimeEntry(TimesheetCr /// Retrieve a list of TimeSheets that match an [OData formatted query](https://www.odata.org/). /// /// Time Sheets is a list of times per task - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -74,7 +72,6 @@ public async Task> QueryTimeSheets(int? top = null, /// /// Delete time entry by id. - /// /// /// time entry id public async Task> DeleteTimeEntry(Guid timesheetId) @@ -85,7 +82,6 @@ public async Task> DeleteTimeEntry(Guid timesheetId) /// /// Updates a time entry by its unique identifier. - /// /// /// time entry id /// payload @@ -97,7 +93,6 @@ public async Task> UpdateTimeEntry(Guid timesh /// /// Returns active admin tasks that are used to report time not related to work on projects. I.e. annual/sick leave etc - /// /// public async Task> ReturnsActiveAdminTasksThatAreUsedToReportTime() { diff --git a/src/Clients/UserRoleClient.cs b/src/Clients/UserRoleClient.cs index 3579592..ff5301c 100644 --- a/src/Clients/UserRoleClient.cs +++ b/src/Clients/UserRoleClient.cs @@ -41,8 +41,9 @@ public UserRoleClient(ProjectManagerClient client) /// /// Retrieves the list of UserRoles defined within this Workspace. /// - /// A UserRole is a name for a privilege level granted to a specific User. The 'Global Admin' UserRole is granted to the owner of the Workspace, and this UserRole cannot be changed. You can choose which UserRole applies to a User within your Workspace. - /// + /// A UserRole is a name for a privilege level granted to a specific User. The 'Global Admin' + /// UserRole is granted to the owner of the Workspace, and this UserRole cannot be changed. + /// You can choose which UserRole applies to a User within your Workspace. /// public async Task> RetrieveUserRoles() { diff --git a/src/Clients/WorkSpaceClient.cs b/src/Clients/WorkSpaceClient.cs index 6d37dcc..611dc5a 100644 --- a/src/Clients/WorkSpaceClient.cs +++ b/src/Clients/WorkSpaceClient.cs @@ -41,8 +41,10 @@ public WorkSpaceClient(ProjectManagerClient client) /// /// Retrieve the list of Workspaces to which the currently logged on user has access. /// - /// A single User may have access to multiple Workspaces, although they can only be logged on to one Workspace at a time. This API lists all Workspaces to which the currently logged on user is entitled to access. To determine which Workspace a user is currently logged on use the `/api/data/me` endpoint. - /// + /// A single User may have access to multiple Workspaces, although they can only be logged on + /// to one Workspace at a time. This API lists all Workspaces to which the currently logged on + /// user is entitled to access. To determine which Workspace a user is currently logged on + /// use the `/api/data/me` endpoint. /// public async Task> RetrieveWorkspaces() { @@ -53,10 +55,12 @@ public async Task> RetrieveWorkspaces() /// /// Invite a specific user to join a Workspace to which the current user has administrator rights. /// - /// A single User may have access to multiple Workspaces, although they can only be logged on to one Workspace at a time. This API lists all Workspaces to which the currently logged on user is entitled to access. To determine which Workspace a user is currently logged on use the `/api/data/me` endpoint. + /// A single User may have access to multiple Workspaces, although they can only be logged on + /// to one Workspace at a time. This API lists all Workspaces to which the currently logged on + /// user is entitled to access. To determine which Workspace a user is currently logged on + /// use the `/api/data/me` endpoint. /// /// This API allows you to invite a specific an invitation to join a specific Workspace. - /// /// /// The unique identifier of the Organization that you are inviting a User to joi /// Information about the user which will receive the invitation diff --git a/src/Enums.cs b/src/Enums.cs index bc3fe24..d18ccc3 100644 --- a/src/Enums.cs +++ b/src/Enums.cs @@ -44,6 +44,7 @@ public static class StateValues public const string NotStarted = "NotStarted"; public const string InProgress = "InProgress"; public const string Success = "Success"; + public const string Discard = "Discard"; public const string Fail = "Fail"; } } diff --git a/src/IProjectManagerClient.cs b/src/IProjectManagerClient.cs index 44e7075..bbfa83c 100644 --- a/src/IProjectManagerClient.cs +++ b/src/IProjectManagerClient.cs @@ -9,7 +9,7 @@ * @author ProjectManager.com * * @copyright 2023-2024 ProjectManager.com, Inc. - * @version 107.0.3368 + * @version 110.0.3705 * @link https://github.com/projectmgr/projectmanager-sdk-csharp */ diff --git a/src/Interfaces/IApiKeyClient.cs b/src/Interfaces/IApiKeyClient.cs index 80d7c99..0137dde 100644 --- a/src/Interfaces/IApiKeyClient.cs +++ b/src/Interfaces/IApiKeyClient.cs @@ -30,10 +30,16 @@ public interface IApiKeyClient /// /// Creates a new API key for the current user with the specified options. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// /// Options for the API key to create Task> CreateApiKey(ApiKeyCreateDto body); @@ -41,30 +47,50 @@ public interface IApiKeyClient /// /// Returns a list of all API keys within the current workspace. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// Task> ListApiKeys(); /// - /// This API call revokes all existing API keys in given workspace. No existing keys will continue to work after this call completes. We strongly encourage you to revoke a single API key at a time; this method should only be used if you need to rapidly halt access to your product for automated systems. + /// This API call revokes all existing API keys in given workspace. No existing keys will continue to work + /// after this call completes. We strongly encourage you to revoke a single API key at a time; this method + /// should only be used if you need to rapidly halt access to your product for automated systems. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// Task> RevokeAllApiKeys(); /// /// Revokes a single API key in the current workspace. /// - /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not preserve this information, it cannot be recreated. - /// - /// Some best practices for working with API keys: * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys regularly according to your company's security policies. * You should create separate API keys for each system that works with your API. If that API key is exposed or if that program needs to be shut down, you can revoke that one key and reissue it. * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. + /// An API key is a credential that you can use to make REST v4 API calls for ProjectManager.com. When you create + /// a new API key, that API key is only visible in the response JSON for the `CreateApiKey` method. If you do not + /// preserve this information, it cannot be recreated. /// + /// Some best practices for working with API keys: + /// * An API key is valid for a two year period after it is created. We encourage you to rotate your API keys + /// regularly according to your company's security policies. + /// * You should create separate API keys for each system that works with your API. If that API key is exposed + /// or if that program needs to be shut down, you can revoke that one key and reissue it. + /// * An API key is tied to the workspace that created it. A single API key can only interact with one workspace. /// /// The unique identifier of the API key to revoke Task> RevokeAPIKey(Guid id); diff --git a/src/Interfaces/IChangesetClient.cs b/src/Interfaces/IChangesetClient.cs index d10484c..3d9792a 100644 --- a/src/Interfaces/IChangesetClient.cs +++ b/src/Interfaces/IChangesetClient.cs @@ -30,23 +30,37 @@ public interface IChangesetClient /// /// Retrieve a Changeset by its unique ID. /// - /// A Changeset is an individual edit that has been made to a project. Since multiple users can edit a project at the same time, individual Changesets are applied in a sequential fashion. If a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a Changeset to determine its conflict resolution status. - /// - /// When checking the status of a Changeset, you can call either RetrieveChangeset or RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has finished processing. + /// A Changeset is an individual edit that has been made to a project. Since multiple users can + /// edit a project at the same time, individual Changesets are applied in a sequential fashion. If + /// a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a + /// Changeset to determine its conflict resolution status. /// + /// When checking the status of a Changeset, you can call either RetrieveChangeset or + /// RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the + /// Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has + /// finished processing. /// /// The unique ID number of the Changeset to retrieve Task> RetrieveChangesetStatus(Guid changeSetId); /// - /// Retrieve a Changeset by its unique ID. This endpoint waits for the Changeset to complete its processing prior to returning a result. - /// - /// A Changeset is an individual edit that has been made to a project. Since multiple users can edit a project at the same time, individual Changesets are applied in a sequential fashion. If a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a Changeset to determine its conflict resolution status. + /// Retrieve a Changeset by its unique ID. This endpoint waits for the Changeset to complete its + /// processing prior to returning a result. /// - /// When checking the status of a Changeset, you can call either RetrieveChangeset or RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has finished processing. + /// A Changeset is an individual edit that has been made to a project. Since multiple users can + /// edit a project at the same time, individual Changesets are applied in a sequential fashion. If + /// a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a + /// Changeset to determine its conflict resolution status. /// - /// Although most Changesets complete instantly, some Changesets may need additional time to complete. If the Changeset cannot be processed within a reasonable length of time, this API call may fail. If this API fails, it will return a status error indicating the Changeset is still being processed. + /// When checking the status of a Changeset, you can call either RetrieveChangeset or + /// RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the + /// Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has + /// finished processing. /// + /// Although most Changesets complete instantly, some Changesets may need additional time to + /// complete. If the Changeset cannot be processed within a reasonable length of time, this API + /// call may fail. If this API fails, it will return a status error indicating the Changeset is + /// still being processed. /// /// The unique ID number of the Changeset to retrieve Task> RetrieveCompletedChangesetStatus(Guid changeSetId); diff --git a/src/Interfaces/IDashboardClient.cs b/src/Interfaces/IDashboardClient.cs index e0afcea..b21f68b 100644 --- a/src/Interfaces/IDashboardClient.cs +++ b/src/Interfaces/IDashboardClient.cs @@ -29,14 +29,12 @@ public interface IDashboardClient /// /// Returns user dashboard settings - /// /// /// The dashboard type that is not custom. For a list of values, see `DashboardTypeValues`. Task> RetrieveDashboardUserSettings(string type); /// /// Create or Update User Dashboard Settings - /// /// /// User dashboard settings object Task> CreateOrUpdateUserDashboardSettings(DashboardSettingCreateDto body); diff --git a/src/Interfaces/IDiscussionClient.cs b/src/Interfaces/IDiscussionClient.cs index cad3f5c..c3eec44 100644 --- a/src/Interfaces/IDiscussionClient.cs +++ b/src/Interfaces/IDiscussionClient.cs @@ -29,7 +29,6 @@ public interface IDiscussionClient /// /// Retrieve all comments written about a task - /// /// /// The unique ID number of the task to retrieve comments Task> RetrieveTaskComments(Guid taskId); @@ -37,8 +36,10 @@ public interface IDiscussionClient /// /// Adds a Markdown-formatted comment to a task. /// - /// Tasks can have discussions attached to them. These discussions can include text with simple formatting. Discussion comments are formatted using [Markdown](https://www.markdownguide.org/) and users should be aware that HTML embedding is not permitted due to the risk of cross-site attacks and other embedding challenges. - /// + /// Tasks can have discussions attached to them. These discussions can include text with simple + /// formatting. Discussion comments are formatted using [Markdown](https://www.markdownguide.org/) + /// and users should be aware that HTML embedding is not permitted due to the risk of cross-site + /// attacks and other embedding challenges. /// /// The unique ID number of the task being commented upon /// The Markdown-formatted text of the comment diff --git a/src/Interfaces/IFileClient.cs b/src/Interfaces/IFileClient.cs index 2e86d70..bee8ab3 100644 --- a/src/Interfaces/IFileClient.cs +++ b/src/Interfaces/IFileClient.cs @@ -64,22 +64,25 @@ public interface IFileClient /// /// Updates information about a File uploaded to your Workspace. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The unique identifier of the File to update /// Information to change about the File and its location Task> UpdateFile(Guid fileId, UpdateRequestDto body); /// - /// In case of soft delete moves file to trash folder. For hard delete completely deletes file's metadata from pm database as well as from amazon storage + /// In case of soft delete moves file to trash folder. For hard delete completely deletes + /// file's metadata from pm database as well as from amazon storage /// /// This API returns a JSON response indicating success or failure. - /// /// /// The unique identifier of the File to delete /// Param indicates that file should be hard deleted diff --git a/src/Interfaces/IHolidayClient.cs b/src/Interfaces/IHolidayClient.cs index e3f1db8..c5791b3 100644 --- a/src/Interfaces/IHolidayClient.cs +++ b/src/Interfaces/IHolidayClient.cs @@ -29,7 +29,6 @@ public interface IHolidayClient /// /// Retrieve a list of resource holidays that match an [OData formatted query](https://www.odata.org/). - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -40,7 +39,6 @@ public interface IHolidayClient /// /// Retrieve a list of country holidays that match an [OData formatted query](https://www.odata.org/). - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -51,7 +49,6 @@ public interface IHolidayClient /// /// Retrieve a list of global holidays that match an [OData formatted query](https://www.odata.org/). - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records diff --git a/src/Interfaces/IHomeFileClient.cs b/src/Interfaces/IHomeFileClient.cs index d9db54a..fd18f9f 100644 --- a/src/Interfaces/IHomeFileClient.cs +++ b/src/Interfaces/IHomeFileClient.cs @@ -30,12 +30,15 @@ public interface IHomeFileClient /// /// Uploads a file to the My Files folder on your Home Files page. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The full path of a file to upload to the API Task> UploadHomeFile(string filename); @@ -43,14 +46,17 @@ public interface IHomeFileClient /// /// Uploads a file to a specific folder on your Home Files page. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// /// You can organize your files in the Home Files and Project Files pages by adding folders. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the sub folder to put the file into /// The full path of a file to upload to the API diff --git a/src/Interfaces/IIntegrationCategoryClient.cs b/src/Interfaces/IIntegrationCategoryClient.cs index f27d98b..ce138d1 100644 --- a/src/Interfaces/IIntegrationCategoryClient.cs +++ b/src/Interfaces/IIntegrationCategoryClient.cs @@ -30,8 +30,9 @@ public interface IIntegrationCategoryClient /// /// Retrieves the list of available IntegrationProvider categories. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// Task> RetrieveProviderCategories(); } diff --git a/src/Interfaces/IIntegrationClient.cs b/src/Interfaces/IIntegrationClient.cs index 6a12c09..61371dc 100644 --- a/src/Interfaces/IIntegrationClient.cs +++ b/src/Interfaces/IIntegrationClient.cs @@ -30,8 +30,8 @@ public interface IIntegrationClient /// /// Retrieves an Integration specified by a unique identifier. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of this Integration Task> RetrieveIntegration(Guid integrationId); @@ -39,8 +39,8 @@ public interface IIntegrationClient /// /// Enable a specific Integration for the current Workspace. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the Integration to enable Task> EnableIntegration(Guid integrationId); @@ -48,8 +48,8 @@ public interface IIntegrationClient /// /// Disable a specific Integration for the current Workspace. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the Integration to disable Task> DisableIntegration(Guid integrationId); @@ -57,8 +57,8 @@ public interface IIntegrationClient /// /// Retrieves all Integrations for the current Workspace. /// - /// The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// The Integrations API is intended for use by ProjectManager and its business development partners. Please + /// contact ProjectManager's sales team to request use of this API. /// Task> RetrieveAllIntegrations(); } diff --git a/src/Interfaces/IIntegrationProviderClient.cs b/src/Interfaces/IIntegrationProviderClient.cs index 1cad545..a76de74 100644 --- a/src/Interfaces/IIntegrationProviderClient.cs +++ b/src/Interfaces/IIntegrationProviderClient.cs @@ -30,16 +30,18 @@ public interface IIntegrationProviderClient /// /// List all available IntegrationProviders that can be activated. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// Task> ListProviders(); /// /// Activates an Integration Provider and retrieves authentication information about a specific IntegrationProvider. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the IntegrationProvider for which you are requesting authentication information Task> ActivateIntegrationProvider(Guid providerId); @@ -47,8 +49,9 @@ public interface IIntegrationProviderClient /// /// Allows you to update the auth status of the provider specific connection. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider /// Specify the auth status @@ -57,8 +60,9 @@ public interface IIntegrationProviderClient /// /// Allows you to deactivate an integration provider. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider Task> DeactivateIntegrationProvider(Guid providerId); @@ -68,8 +72,9 @@ public interface IIntegrationProviderClient /// /// This connection can be used for requests to Providers that require specific user data. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The unique identifier of the IntegrationProvider for which you are requesting authentication information Task> CreateUserIntegrationProviderConnection(Guid providerId); @@ -77,8 +82,9 @@ public interface IIntegrationProviderClient /// /// Allows you to update the auth status of the provider specific user connection. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider /// Specify the auth status @@ -87,8 +93,9 @@ public interface IIntegrationProviderClient /// /// Allows you to disconnect the provider specific user connection. /// - /// An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager's sales team to request use of this API. - /// + /// An IntegrationProvider is the name of an external application or service that can be connected to + /// ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business + /// development partners. Please contact ProjectManager's sales team to request use of this API. /// /// The identifier to the provider Task> DisconnectUserIntegrationProviderConnection(Guid providerId); diff --git a/src/Interfaces/ILicenseClient.cs b/src/Interfaces/ILicenseClient.cs index d9415bb..da53b38 100644 --- a/src/Interfaces/ILicenseClient.cs +++ b/src/Interfaces/ILicenseClient.cs @@ -30,16 +30,20 @@ public interface ILicenseClient /// /// Retrieve information about the current licenses possessed by this Workspace. /// - /// Licenses contain information about your current subscription level and features that have been enabled on your Workspace. To modify the License information, please log on to the ProjectManager.com application and use the Account | Editions screen to review or update your Licenses. - /// + /// Licenses contain information about your current subscription level and features that have + /// been enabled on your Workspace. To modify the License information, please log on to the + /// ProjectManager.com application and use the Account | Editions screen to review or update + /// your Licenses. /// Task> RetrieveLicenses(); /// /// Adds a new License to the current Workspace. /// - /// Licenses contain information about your current subscription level and features that have been enabled on your Workspace. To modify the License information, please log on to the ProjectManager.com application and use the Account | Editions screen to review or update your Licenses. - /// + /// Licenses contain information about your current subscription level and features that have + /// been enabled on your Workspace. To modify the License information, please log on to the + /// ProjectManager.com application and use the Account | Editions screen to review or update + /// your Licenses. /// /// Information about the SKU you wish to add to your Workspace Task> AddLicense(string bundleSku); diff --git a/src/Interfaces/IMeClient.cs b/src/Interfaces/IMeClient.cs index 1cb666c..97c657c 100644 --- a/src/Interfaces/IMeClient.cs +++ b/src/Interfaces/IMeClient.cs @@ -30,8 +30,10 @@ public interface IMeClient /// /// Retrieve information about the currently logged on user. /// - /// This API call will always succeed with a 200 OK if called with valid authentication information. If the authentication information provided is not valid, calling this API will return a 401 Authentication Failed error message. If successful, this API returns information about the user including its home URL, email address, user name, and workspace name. - /// + /// This API call will always succeed with a 200 OK if called with valid authentication information. + /// If the authentication information provided is not valid, calling this API will return a 401 + /// Authentication Failed error message. If successful, this API returns information about the user + /// including its home URL, email address, user name, and workspace name. /// Task> RetrieveMe(); } diff --git a/src/Interfaces/INptFilesClient.cs b/src/Interfaces/INptFilesClient.cs index bdce902..fb4c8bb 100644 --- a/src/Interfaces/INptFilesClient.cs +++ b/src/Interfaces/INptFilesClient.cs @@ -30,12 +30,15 @@ public interface INptFilesClient /// /// Uploads a file to a non-project task. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the task /// The full path of a file to upload to the API diff --git a/src/Interfaces/IProjectChargeCodeClient.cs b/src/Interfaces/IProjectChargeCodeClient.cs index 848abf4..d49a564 100644 --- a/src/Interfaces/IProjectChargeCodeClient.cs +++ b/src/Interfaces/IProjectChargeCodeClient.cs @@ -30,8 +30,9 @@ public interface IProjectChargeCodeClient /// /// Retrieve all defined ChargeCodes that can be used when creating Projects. /// - /// A ChargeCode is a code used to identify costs within your Projects. Each ChargeCode has a name and a unique identifier. ChargeCodes are defined per Workspace and are shared among Projects. - /// + /// A ChargeCode is a code used to identify costs within your Projects. Each ChargeCode has + /// a name and a unique identifier. ChargeCodes are defined per Workspace and are shared + /// among Projects. /// Task> RetrieveChargeCodes(); } diff --git a/src/Interfaces/IProjectClient.cs b/src/Interfaces/IProjectClient.cs index 5467ed1..c49586b 100644 --- a/src/Interfaces/IProjectClient.cs +++ b/src/Interfaces/IProjectClient.cs @@ -30,8 +30,9 @@ public interface IProjectClient /// /// Retrieve a list of Projects that match an [OData formatted query](https://www.odata.org/). /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -43,8 +44,9 @@ public interface IProjectClient /// /// Create a new project based on the details provided. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// Information about the Project you wish to create Task> CreateProject(ProjectCreateDto body); @@ -52,8 +54,9 @@ public interface IProjectClient /// /// Retrieves a project based on its unique identifier. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// The unique identifier of the Project to retrieve. Task> RetrieveProject(string projectId); @@ -61,10 +64,13 @@ public interface IProjectClient /// /// Update an existing Project and replace the values of fields specified. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// - /// Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset. + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// + /// Multiple users can be working on data at the same time. When you call an API to update an + /// object, this call is converted into a Changeset that is then applied sequentially. You can use + /// RetrieveChangeset to see the status of an individual Changeset. /// /// The unique identifier of the Project to update /// All non-null fields in this object will replace previous data within the Project @@ -73,8 +79,9 @@ public interface IProjectClient /// /// Delete a project based on the details provided. /// - /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project. - /// + /// A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks + /// represent individual items of work that team members must complete. The sum total of Tasks + /// within a Project represents the work to be completed for that Project. /// /// The unique identifier of the Project to delete /// Hard delete project true or false diff --git a/src/Interfaces/IProjectCustomerClient.cs b/src/Interfaces/IProjectCustomerClient.cs index 6513a9c..a69187e 100644 --- a/src/Interfaces/IProjectCustomerClient.cs +++ b/src/Interfaces/IProjectCustomerClient.cs @@ -30,8 +30,9 @@ public interface IProjectCustomerClient /// /// Retrieves all ProjectCustomers defined within your Workspace. /// - /// A ProjectCustomer is a code used to identify customers associated with your Projects. Each ProjectCustomer has a name and a unique identifier. ProjectCustomers are defined per Workspace and are shared among Projects. - /// + /// A ProjectCustomer is a code used to identify customers associated with your Projects. Each + /// ProjectCustomer has a name and a unique identifier. ProjectCustomers are defined per + /// Workspace and are shared among Projects. /// Task> RetrieveProjectCustomers(); } diff --git a/src/Interfaces/IProjectFieldClient.cs b/src/Interfaces/IProjectFieldClient.cs index 5c6631f..31e2564 100644 --- a/src/Interfaces/IProjectFieldClient.cs +++ b/src/Interfaces/IProjectFieldClient.cs @@ -30,16 +30,20 @@ public interface IProjectFieldClient /// /// Retrieves all ProjectFields defined within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// Task> RetrieveProjectFields(); /// /// Creates a new ProjectField within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// Information about the ProjectField to create Task> CreateProjectField(CreateProjectFieldDto body); @@ -47,8 +51,10 @@ public interface IProjectFieldClient /// /// Deletes an existing ProjectField within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier or short ID of this ProjectField Task> DeleteProjectField(string fieldId); @@ -56,8 +62,10 @@ public interface IProjectFieldClient /// /// Replaces the current value of a ProjectField for a specific Project within your Workspace. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier of the Project that contains this ProjectField /// The unique identifier or short ID of this ProjectField @@ -67,8 +75,10 @@ public interface IProjectFieldClient /// /// Retrieves the current ProjectField value for a particular Project and ProjectField. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier of the Project of the value to retrieve /// The unique identifier or short ID of the ProjectField of the value to retrieve @@ -77,8 +87,10 @@ public interface IProjectFieldClient /// /// Retrieves all ProjectField values for a particular Project. /// - /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace. - /// + /// A ProjectField is a custom field defined within your Workspace. You can define ProjectFields + /// for any integration purpose that is important to your business. Each ProjectField has a data + /// type as well as options in how it is handled. ProjectFields can be edited for each Project + /// within your Workspace. /// /// The unique identifier of the Project for which we want ProjectField values Task> RetrieveAllProjectFieldValues(Guid projectId); diff --git a/src/Interfaces/IProjectFileClient.cs b/src/Interfaces/IProjectFileClient.cs index 6b44e22..0305a1a 100644 --- a/src/Interfaces/IProjectFileClient.cs +++ b/src/Interfaces/IProjectFileClient.cs @@ -30,12 +30,15 @@ public interface IProjectFileClient /// /// Uploads a file to the All Files folder on the Files page within the project that you specify. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the project /// The full path of a file to upload to the API @@ -44,14 +47,17 @@ public interface IProjectFileClient /// /// Uploads a file to a specific folder on the Files page within the project that you specify. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// /// You can organize your files in the Home Files and Project Files pages by adding folders. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the project /// The reference to the sub folder to put the file into diff --git a/src/Interfaces/IProjectFolderClient.cs b/src/Interfaces/IProjectFolderClient.cs index 7fcfd97..14c443d 100644 --- a/src/Interfaces/IProjectFolderClient.cs +++ b/src/Interfaces/IProjectFolderClient.cs @@ -31,7 +31,6 @@ public interface IProjectFolderClient /// Retrieves all ProjectFolders defined within your Workspace. /// /// A ProjectFolder is a named storage location that can contain Projects. - /// /// Task> RetrieveProjectFolders(); } diff --git a/src/Interfaces/IProjectMembersClient.cs b/src/Interfaces/IProjectMembersClient.cs index fdcb010..d216a53 100644 --- a/src/Interfaces/IProjectMembersClient.cs +++ b/src/Interfaces/IProjectMembersClient.cs @@ -30,16 +30,17 @@ public interface IProjectMembersClient /// /// Returns a list of users that can be added as members of a new project, as well as their available project security roles. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// Task> RetrieveNewProjectMembers(); /// - /// Returns a list of users that are currently members of a specified project, as well as their current project security roles and available project security roles. Optionally include users who are not currently members of the project, but who are available to be added. - /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. + /// Returns a list of users that are currently members of a specified project, as well as their current project security roles and available project security roles. + /// Optionally include users who are not currently members of the project, but who are available to be added. /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to the project /// Set to true to include all users in the workspace @@ -48,8 +49,8 @@ public interface IProjectMembersClient /// /// Returns the project security role in a specified project for a current project member. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference of Project /// Reference of User @@ -58,8 +59,8 @@ public interface IProjectMembersClient /// /// Creates a membership for a user in a specified project, and assigns the user the appropriate project access based on the specified project security role. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to Project /// Reference to User @@ -69,8 +70,8 @@ public interface IProjectMembersClient /// /// Updates the project access for a current member of a specified project by giving the user a new project security role. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to Project /// Reference to User @@ -80,8 +81,8 @@ public interface IProjectMembersClient /// /// Removes a current project member from a specified project. This removes the user's access to that project. /// - /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest. - /// + /// A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to + /// the project. Possible project security roles include manage, edit, collaborate, creator, and guest. /// /// Reference to Project /// Reference to User diff --git a/src/Interfaces/IProjectPriorityClient.cs b/src/Interfaces/IProjectPriorityClient.cs index 3bfddda..471e1be 100644 --- a/src/Interfaces/IProjectPriorityClient.cs +++ b/src/Interfaces/IProjectPriorityClient.cs @@ -30,10 +30,12 @@ public interface IProjectPriorityClient /// /// Retrieves all ProjectPriorities defined within your Workspace. /// - /// A ProjectPriority is a named priority level used by your business to determine how to decide which Projects are the most important. You can name your ProjectPriority levels anything you like and you can reorganize the order of the ProjectPriority levels at any time. - /// - /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even if they may have similar names, they are different objects and must be tracked separately. + /// A ProjectPriority is a named priority level used by your business to determine how to decide + /// which Projects are the most important. You can name your ProjectPriority levels anything you like + /// and you can reorganize the order of the ProjectPriority levels at any time. /// + /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even + /// if they may have similar names, they are different objects and must be tracked separately. /// Task> RetrieveProjectPriorities(); } diff --git a/src/Interfaces/IProjectStatusClient.cs b/src/Interfaces/IProjectStatusClient.cs index 7d09edf..74682fc 100644 --- a/src/Interfaces/IProjectStatusClient.cs +++ b/src/Interfaces/IProjectStatusClient.cs @@ -30,8 +30,9 @@ public interface IProjectStatusClient /// /// Retrieves all ProjectStatuses defined within your Workspace. /// - /// A ProjectStatus is a named condition used by your business to categorize the completion level of Tasks and Projects within your Workspace. You can name your ProjectStatus levels anything you like and you can reorganize the order of the ProjectPriority levels at any time. - /// + /// A ProjectStatus is a named condition used by your business to categorize the completion level + /// of Tasks and Projects within your Workspace. You can name your ProjectStatus levels anything + /// you like and you can reorganize the order of the ProjectPriority levels at any time. /// Task> RetrieveProjectStatuses(); } diff --git a/src/Interfaces/IProjectTemplateClient.cs b/src/Interfaces/IProjectTemplateClient.cs index 61c6ac2..cee2c7f 100644 --- a/src/Interfaces/IProjectTemplateClient.cs +++ b/src/Interfaces/IProjectTemplateClient.cs @@ -30,16 +30,18 @@ public interface IProjectTemplateClient /// /// Retrieves all ProjectTemplates defined in the system. /// - /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory system. - /// + /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied + /// to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory + /// system. /// Task> RetrieveProjectTemplates(); /// /// Retrieves all ProjectTemplate Categories defined in the system. /// - /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory system. - /// + /// A ProjectTemplate is a definition of default project related data (eg. Tasks) that can be applied + /// to a new project when it is created. ProjectTemplates are categorized using the TemplateCategory + /// system. /// Task> RetrieveTemplateCategories(); } diff --git a/src/Interfaces/IResourceClient.cs b/src/Interfaces/IResourceClient.cs index 87e4781..79ab8f6 100644 --- a/src/Interfaces/IResourceClient.cs +++ b/src/Interfaces/IResourceClient.cs @@ -30,8 +30,11 @@ public interface IResourceClient /// /// Create a new Resource within your Workspace. /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The details for the new Resource to create Task> CreateResource(ResourceCreateDto body); @@ -39,8 +42,11 @@ public interface IResourceClient /// /// Retrieve a list of Resources that match an [OData formatted query](https://www.odata.org/). /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -52,8 +58,11 @@ public interface IResourceClient /// /// Updates an existing Resource based on information you provide. /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The id of the resource /// The information to update the resource @@ -62,8 +71,11 @@ public interface IResourceClient /// /// Retrieve the Resource matching the specified unique ID. /// - /// A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user. - /// + /// A Resource represents a person, material, or tool that is used within your Projects. + /// When you attach a Resources to more than one Task, the software will schedule the usage + /// of your Resource so that it is not allocated to more than one Task at the same time. + /// The users in your Workspace are also considered Resources. To invite a new User to your + /// Workspace, create a new Resource for that user. /// /// The id of the Resource Task> RetrieveResource(Guid resourceId); diff --git a/src/Interfaces/IResourceSkillClient.cs b/src/Interfaces/IResourceSkillClient.cs index a107b9f..9354771 100644 --- a/src/Interfaces/IResourceSkillClient.cs +++ b/src/Interfaces/IResourceSkillClient.cs @@ -30,8 +30,10 @@ public interface IResourceSkillClient /// /// Retrieves all ResourceSkills defined within your Workspace. /// - /// A ResourceSkill is a capability possessed by a Resource that can be used to distinguish different classes of Resources suitable for use by a Task. You can specify that a Task requires a Resource with a particular set of ResourceSkills and then allocate Resources based on whether or not they have the suitable ResourceSkills. - /// + /// A ResourceSkill is a capability possessed by a Resource that can be used to distinguish + /// different classes of Resources suitable for use by a Task. You can specify that a Task + /// requires a Resource with a particular set of ResourceSkills and then allocate Resources + /// based on whether or not they have the suitable ResourceSkills. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -42,14 +44,12 @@ public interface IResourceSkillClient /// /// Create a Resource Skill. - /// /// /// The name of the skill to create. Task> CreateResourceSkill(CreateResourceSkillDto body); /// /// Update a Resource Skill. - /// /// /// The id of the skill to update. /// The data of the skill to update. @@ -57,7 +57,6 @@ public interface IResourceSkillClient /// /// The endpoint is used to delete a resource skill. Users assigned to this skill will no longer be assigned thereafter. - /// /// /// The Id of the skill to be removed. Task> DeleteResourceSkill(Guid resourceSkillId); diff --git a/src/Interfaces/IResourceTeamClient.cs b/src/Interfaces/IResourceTeamClient.cs index 52c10cc..3954a8b 100644 --- a/src/Interfaces/IResourceTeamClient.cs +++ b/src/Interfaces/IResourceTeamClient.cs @@ -30,8 +30,9 @@ public interface IResourceTeamClient /// /// Retrieves all ResourceTeams defined within your Workspace that match an [OData formatted query](https://www.odata.org/). /// - /// A ResourceTeam is a grouping of Resources that allows you to keep track of assignments in a manner consistent with your business needs. You can assign Resources to be members of zero, one, or many ResourceTeams. - /// + /// A ResourceTeam is a grouping of Resources that allows you to keep track of assignments + /// in a manner consistent with your business needs. You can assign Resources to be members + /// of zero, one, or many ResourceTeams. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -42,21 +43,18 @@ public interface IResourceTeamClient /// /// Create a Resource Team. - /// /// /// The name of the team to create. Task> CreateResourceTeam(CreateResourceTeamDto body); /// /// The endpoint is used to delete a resource team. Users assigned to this team will no longer be assigned thereafter. - /// /// /// The Id of the team to be removed. Task> DeleteResourceTeam(Guid resourceTeamId); /// /// Update a Resource Team. - /// /// /// The id of the resource team /// The name of the team to Update. diff --git a/src/Interfaces/ITagClient.cs b/src/Interfaces/ITagClient.cs index f2a9e0b..f6d4880 100644 --- a/src/Interfaces/ITagClient.cs +++ b/src/Interfaces/ITagClient.cs @@ -30,8 +30,8 @@ public interface ITagClient /// /// Retrieve a list of Tags that match an [OData formatted query](https://www.odata.org/). /// - /// A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color. - /// + /// A Tag is a named categorization you can use to distinguish objects from each other. + /// Tags each have a unique identifier, a name, and a color. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -43,8 +43,8 @@ public interface ITagClient /// /// Creates a new Tag based on information you provide. /// - /// A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color. - /// + /// A Tag is a named categorization you can use to distinguish objects from each other. + /// Tags each have a unique identifier, a name, and a color. /// /// The information for the new Tag to create Task> CreateTag(TagCreateDto body); @@ -52,8 +52,8 @@ public interface ITagClient /// /// Updates an existing Tag based on information you provide. /// - /// A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color. - /// + /// A Tag is a named categorization you can use to distinguish objects from each other. + /// Tags each have a unique identifier, a name, and a color. /// /// The id of the tag /// The information to update the tag diff --git a/src/Interfaces/ITaskAssigneeClient.cs b/src/Interfaces/ITaskAssigneeClient.cs index 4e4bc9a..a9d3024 100644 --- a/src/Interfaces/ITaskAssigneeClient.cs +++ b/src/Interfaces/ITaskAssigneeClient.cs @@ -30,20 +30,24 @@ public interface ITaskAssigneeClient /// /// Replace all TaskAssignees on a Task with new TaskAssignees. /// - /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources to a Task and designate how much of their time will be allocated to this Task. - /// - /// In the request body, id is the id of the Resource you would like to assign to the Task, and assignedEffort is the amount of time that Resource is expected to spend on the task. assignedEffort should be entered in minutes. + /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources + /// to a Task and designate how much of their time will be allocated to this Task. /// + /// In the request body, id is the id of the Resource you would like to assign to the Task, and + /// assignedEffort is the amount of time that Resource is expected to spend on the task. assignedEffort + /// should be entered in minutes. /// /// The unique identifier of the Task whose TaskAssignees will be replaced /// The new list of TaskAssignees for this Task Task> ReplaceTaskAssignees(Guid taskId, AssigneeUpsertDto[] body); /// - /// Adds or updates a TaskAssignee to a Task. If the TaskAssignee is already assigned to the Task, update their allocation. If the TaskAssignee is not yet assigned to the Task, assign them and set their allocation level to the correct amount. - /// - /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources to a Task and designate what proportion of their time will be allocated to this Task. + /// Adds or updates a TaskAssignee to a Task. If the TaskAssignee is already assigned to the Task, update + /// their allocation. If the TaskAssignee is not yet assigned to the Task, assign them and set their + /// allocation level to the correct amount. /// + /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources + /// to a Task and designate what proportion of their time will be allocated to this Task. /// /// The unique identifier of the Task to add or update an assignment /// List of Assignee data @@ -52,8 +56,8 @@ public interface ITaskAssigneeClient /// /// Remove one or more TaskAssignees from a Task. /// - /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources to a Task and designate what proportion of their time will be allocated to this Task. - /// + /// A TaskAssignee is an assignment of a Resource to a Task. You can assign multiple Resources + /// to a Task and designate what proportion of their time will be allocated to this Task. /// /// The unique identifier of the Task whose TaskAssignee will be removed /// List of TaskAssignee records to remove diff --git a/src/Interfaces/ITaskClient.cs b/src/Interfaces/ITaskClient.cs index ae1263f..82725d9 100644 --- a/src/Interfaces/ITaskClient.cs +++ b/src/Interfaces/ITaskClient.cs @@ -30,8 +30,9 @@ public interface ITaskClient /// /// Retrieve a list of Tasks that match an [OData formatted query](https://www.odata.org/). /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -41,10 +42,13 @@ public interface ITaskClient Task> QueryTasks(int? top = null, int? skip = null, string filter = null, string orderby = null, string expand = null); /// - /// Retrieve a Task by its unique identifier or by its short ID. A Task has both a unique identifier, which is a GUID, and a short ID, which is a small text label that is unique only within your Workspace. - /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. + /// Retrieve a Task by its unique identifier or by its short ID. A Task has both a unique + /// identifier, which is a GUID, and a short ID, which is a small text label that is unique + /// only within your Workspace. /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The unique identifier or short ID of the Task to retrieve Task> RetrieveTask(string taskId); @@ -52,12 +56,17 @@ public interface ITaskClient /// /// Update an existing Task and replace the values of fields specified. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// - /// Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset. + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// - /// Known Issues: This API returns an error if your Update call includes too many changes in a single API call. Please restrict usage to one change per API request. This API will be deprecated and replaced with an improved API call in a future release. + /// Multiple users can be working on data at the same time. When you call an API to update an + /// object, this call is converted into a Changeset that is then applied sequentially. You can use + /// RetrieveChangeset to see the status of an individual Changeset. /// + /// Known Issues: This API returns an error if your Update call includes too many changes in a + /// single API call. Please restrict usage to one change per API request. This API will be + /// deprecated and replaced with an improved API call in a future release. /// /// The unique identifier of the Task to update /// All non-null fields in this object will replace existing data in the Task @@ -66,10 +75,13 @@ public interface ITaskClient /// /// Delete an existing Task. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// - /// Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset. + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// + /// Multiple users can be working on data at the same time. When you call an API to update an + /// object, this call is converted into a Changeset that is then applied sequentially. You can use + /// RetrieveChangeset to see the status of an individual Changeset. /// /// Unique identifier of the Task to delete Task> DeleteTask(Guid taskId); @@ -77,8 +89,9 @@ public interface ITaskClient /// /// Create a new Task within a specified project. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The unique identifier of the Project that will contain this Task /// The new Task to create @@ -87,18 +100,21 @@ public interface ITaskClient /// /// Retrieves all TaskPriorities defined within your Workspace. /// - /// A TaskPriority is a named priority level used by your business to determine how to decide which Tasks are the most important. You can name your TaskPriority levels anything you like and you can reorganize the order of the TaskPriority levels at any time. - /// - /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even if they may have similar names, they are different objects and must be tracked separately. + /// A TaskPriority is a named priority level used by your business to determine how to decide + /// which Tasks are the most important. You can name your TaskPriority levels anything you like + /// and you can reorganize the order of the TaskPriority levels at any time. /// + /// Note that TaskPriority and ProjectPriority are different classes of priority levels. Even + /// if they may have similar names, they are different objects and must be tracked separately. /// Task> RetrieveTaskPriorities(); /// /// Create multiple new Tasks within a specified project with a single API call. /// - /// A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection. - /// + /// A Task is an individual element of work that must be performed to complete a Project. A + /// Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to + /// indicate whether they have a dependency or a connection. /// /// The unique identifier of the Project that will contain these Tasks /// The list of new Tasks to create @@ -106,7 +122,6 @@ public interface ITaskClient /// /// Adds a task parent relationship - /// /// /// The task that will become the child /// The parent task @@ -114,7 +129,6 @@ public interface ITaskClient /// /// Updates a task parent relationship - /// /// /// The task that will become the child /// The parent task @@ -122,7 +136,6 @@ public interface ITaskClient /// /// Removes a task parent relationship completely - /// /// /// The child task Task> RemoveParentTask(Guid taskId); diff --git a/src/Interfaces/ITaskFieldClient.cs b/src/Interfaces/ITaskFieldClient.cs index cc550d6..a7ae514 100644 --- a/src/Interfaces/ITaskFieldClient.cs +++ b/src/Interfaces/ITaskFieldClient.cs @@ -30,8 +30,10 @@ public interface ITaskFieldClient /// /// Retrieves all TaskFields defined for a specific Project within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Project to retrieve TaskFields Task> RetrieveTaskFields(Guid projectId); @@ -39,8 +41,10 @@ public interface ITaskFieldClient /// /// Creates a new TaskField for a specific Project within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Project within which to create this TaskField /// Information about the TaskField to create @@ -49,8 +53,10 @@ public interface ITaskFieldClient /// /// Retrieve a list of TaskFields that match an [OData formatted query](https://www.odata.org/). /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside a Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside a Project. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -62,8 +68,10 @@ public interface ITaskFieldClient /// /// Deletes a TaskField for a specific Project within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Project that contains this TaskField /// The unique identifier of the TaskField to delete @@ -72,8 +80,10 @@ public interface ITaskFieldClient /// /// Retrieves all TaskField values for a particular Task. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Task for which we want TaskField values Task> RetrieveAllTaskFieldValues(Guid taskId); @@ -81,8 +91,10 @@ public interface ITaskFieldClient /// /// Retrieve a list of TaskFieldValues that match an [OData formatted query](https://www.odata.org/). /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -94,8 +106,10 @@ public interface ITaskFieldClient /// /// Retrieves the current TaskField value for a particular Task and TaskField. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Task of the value to retrieve /// The unique identifier of the TaskField of the value to retrieve @@ -104,8 +118,10 @@ public interface ITaskFieldClient /// /// Replaces the current value of a TaskField for a specific Task within your Workspace. /// - /// A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project. - /// + /// A TaskField is a custom field defined within your Workspace for a specific Project. You can + /// define TaskFields for any integration purpose that is important to your business. Each + /// TaskField has a data type as well as options in how it is handled. TaskFields can be edited + /// for each Task inside this Project. /// /// The unique identifier of the Task whose value you wish to update /// The unique identifier of the TaskField whose value you wish to update diff --git a/src/Interfaces/ITaskFileClient.cs b/src/Interfaces/ITaskFileClient.cs index 9d42610..526ffda 100644 --- a/src/Interfaces/ITaskFileClient.cs +++ b/src/Interfaces/ITaskFileClient.cs @@ -30,12 +30,15 @@ public interface ITaskFileClient /// /// Uploads a file to a task. /// - /// ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. + /// ProjectManager allows you to store Files connected to other elements of your Workspace + /// such as a Project, a Task, or Home. Files are maintained separately based on the location + /// where the file was stored. /// - /// When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. + /// When you upload a File, please allow a few moments for the File to be processed and verified. + /// ProjectManager may reject File uploads that contain problems such as malware. Once a File has + /// completed the upload the process, you may retrieve it using the DownloadFile API. /// /// This API returns a JSON response indicating success or failure. - /// /// /// The reference to the task /// The full path of a file to upload to the API diff --git a/src/Interfaces/ITaskMetadataClient.cs b/src/Interfaces/ITaskMetadataClient.cs index 138261a..268256a 100644 --- a/src/Interfaces/ITaskMetadataClient.cs +++ b/src/Interfaces/ITaskMetadataClient.cs @@ -29,7 +29,6 @@ public interface ITaskMetadataClient /// /// Adds a metadata to a task - /// /// /// Task ID /// If metadata is for system or customer, isSystem = true is only of ProjectManager diff --git a/src/Interfaces/ITaskStatusClient.cs b/src/Interfaces/ITaskStatusClient.cs index eb88b67..c7cf016 100644 --- a/src/Interfaces/ITaskStatusClient.cs +++ b/src/Interfaces/ITaskStatusClient.cs @@ -30,8 +30,9 @@ public interface ITaskStatusClient /// /// Retrieves the list of TaskStatus levels for a specific Project within your Workspace. /// - /// A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business and determine which status levels are considered done. - /// + /// A TaskStatus is a named status level used by your business to determine how to measure the + /// progress of Tasks. You can define your own named status levels that are appropriate for + /// your business and determine which status levels are considered done. /// /// The unique identifier of the Project to retrieve TaskStatuses Task> RetrieveTaskStatuses(Guid projectId); @@ -39,8 +40,9 @@ public interface ITaskStatusClient /// /// Creates a new TaskStatus level for a specific Project within your Workspace. /// - /// A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business. - /// + /// A TaskStatus is a named status level used by your business to determine how to measure the + /// progress of Tasks. You can define your own named status levels that are appropriate for + /// your business. /// /// The unique identifier of the Project for the new TaskStatus /// Information about the new TaskStatus level to create within this Project @@ -49,8 +51,9 @@ public interface ITaskStatusClient /// /// Updates an existing TaskStatus level for a specific Project within your Workspace. /// - /// A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business. - /// + /// A TaskStatus is a named status level used by your business to determine how to measure the + /// progress of Tasks. You can define your own named status levels that are appropriate for + /// your business. /// /// The unique identifier of the Project for the new TaskStatus /// Information about the existing TaskStatus level to update within this Project @@ -59,8 +62,8 @@ public interface ITaskStatusClient /// /// The endpoint is used to delete a TaskStatus. /// - /// You will not be able to delete a TaskStatus if there are tasks that have been assigned to this status level or if the TaskStatus is the default status level. - /// + /// You will not be able to delete a TaskStatus if there are tasks that have been assigned to this status level + /// or if the TaskStatus is the default status level. /// /// The unique identifier of the Project for the TaskStatus level to delete /// The Id of the TaskStatus level to be removed. diff --git a/src/Interfaces/ITaskTagClient.cs b/src/Interfaces/ITaskTagClient.cs index 4bf40a7..d97835b 100644 --- a/src/Interfaces/ITaskTagClient.cs +++ b/src/Interfaces/ITaskTagClient.cs @@ -30,8 +30,9 @@ public interface ITaskTagClient /// /// Replaces the existing TaskTags on a Task with a newly provided list of TaskTags. /// - /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you classify your Tasks and prioritize work. - /// + /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many + /// TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you + /// classify your Tasks and prioritize work. /// /// The unique identifier of the Task for which we will replace TaskTags /// The replacement list of TaskTags for this Task @@ -40,8 +41,9 @@ public interface ITaskTagClient /// /// Add one or more new TaskTags to a Task. /// - /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you classify your Tasks and prioritize work. - /// + /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many + /// TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you + /// classify your Tasks and prioritize work. /// /// The unique identifier of the Task for which we will add TaskTags /// The new TaskTags to add to this Task @@ -50,8 +52,9 @@ public interface ITaskTagClient /// /// Removes one or more existing TaskTags from a Task. /// - /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you classify your Tasks and prioritize work. - /// + /// A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many + /// TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you + /// classify your Tasks and prioritize work. /// /// The unique identifier of the Task for which we will remove existing TaskTags /// The TaskTags to remove from this Task diff --git a/src/Interfaces/ITimesheetClient.cs b/src/Interfaces/ITimesheetClient.cs index 9da1ccf..055578b 100644 --- a/src/Interfaces/ITimesheetClient.cs +++ b/src/Interfaces/ITimesheetClient.cs @@ -29,7 +29,6 @@ public interface ITimesheetClient /// /// Creates new time entry for given resource on given day. - /// /// /// Payload Task> CreateTimeEntry(TimesheetCreateRequestDto body); @@ -38,7 +37,6 @@ public interface ITimesheetClient /// Retrieve a list of TimeSheets that match an [OData formatted query](https://www.odata.org/). /// /// Time Sheets is a list of times per task - /// /// /// The number of records to return /// Skips the given number of records and then returns $top records @@ -49,14 +47,12 @@ public interface ITimesheetClient /// /// Delete time entry by id. - /// /// /// time entry id Task> DeleteTimeEntry(Guid timesheetId); /// /// Updates a time entry by its unique identifier. - /// /// /// time entry id /// payload @@ -64,7 +60,6 @@ public interface ITimesheetClient /// /// Returns active admin tasks that are used to report time not related to work on projects. I.e. annual/sick leave etc - /// /// Task> ReturnsActiveAdminTasksThatAreUsedToReportTime(); } diff --git a/src/Interfaces/IUserRoleClient.cs b/src/Interfaces/IUserRoleClient.cs index a78fc84..a73781a 100644 --- a/src/Interfaces/IUserRoleClient.cs +++ b/src/Interfaces/IUserRoleClient.cs @@ -30,8 +30,9 @@ public interface IUserRoleClient /// /// Retrieves the list of UserRoles defined within this Workspace. /// - /// A UserRole is a name for a privilege level granted to a specific User. The 'Global Admin' UserRole is granted to the owner of the Workspace, and this UserRole cannot be changed. You can choose which UserRole applies to a User within your Workspace. - /// + /// A UserRole is a name for a privilege level granted to a specific User. The 'Global Admin' + /// UserRole is granted to the owner of the Workspace, and this UserRole cannot be changed. + /// You can choose which UserRole applies to a User within your Workspace. /// Task> RetrieveUserRoles(); } diff --git a/src/Interfaces/IWorkSpaceClient.cs b/src/Interfaces/IWorkSpaceClient.cs index 9194a50..cf95541 100644 --- a/src/Interfaces/IWorkSpaceClient.cs +++ b/src/Interfaces/IWorkSpaceClient.cs @@ -30,18 +30,22 @@ public interface IWorkSpaceClient /// /// Retrieve the list of Workspaces to which the currently logged on user has access. /// - /// A single User may have access to multiple Workspaces, although they can only be logged on to one Workspace at a time. This API lists all Workspaces to which the currently logged on user is entitled to access. To determine which Workspace a user is currently logged on use the `/api/data/me` endpoint. - /// + /// A single User may have access to multiple Workspaces, although they can only be logged on + /// to one Workspace at a time. This API lists all Workspaces to which the currently logged on + /// user is entitled to access. To determine which Workspace a user is currently logged on + /// use the `/api/data/me` endpoint. /// Task> RetrieveWorkspaces(); /// /// Invite a specific user to join a Workspace to which the current user has administrator rights. /// - /// A single User may have access to multiple Workspaces, although they can only be logged on to one Workspace at a time. This API lists all Workspaces to which the currently logged on user is entitled to access. To determine which Workspace a user is currently logged on use the `/api/data/me` endpoint. + /// A single User may have access to multiple Workspaces, although they can only be logged on + /// to one Workspace at a time. This API lists all Workspaces to which the currently logged on + /// user is entitled to access. To determine which Workspace a user is currently logged on + /// use the `/api/data/me` endpoint. /// /// This API allows you to invite a specific an invitation to join a specific Workspace. - /// /// /// The unique identifier of the Organization that you are inviting a User to joi /// Information about the user which will receive the invitation diff --git a/src/Models/CountryHolidayDto.cs b/src/Models/CountryHolidayDto.cs index 835bef4..76d03d6 100644 --- a/src/Models/CountryHolidayDto.cs +++ b/src/Models/CountryHolidayDto.cs @@ -39,8 +39,13 @@ public class CountryHolidayDto : ApiModel public string Date { get; set; } /// - /// Country id holiday associated to + /// The Country Id the holiday is associated to /// public int? CountryId { get; set; } + + /// + /// The Country Name the holiday is associated to + /// + public string CountryName { get; set; } } } diff --git a/src/ProjectManagerClient.cs b/src/ProjectManagerClient.cs index 992fcbe..764e37a 100644 --- a/src/ProjectManagerClient.cs +++ b/src/ProjectManagerClient.cs @@ -9,7 +9,7 @@ * @author ProjectManager.com * * @copyright 2023-2024 ProjectManager.com, Inc. - * @version 107.0.3368 + * @version 110.0.3705 * @link https://github.com/projectmgr/projectmanager-sdk-csharp */ @@ -39,7 +39,7 @@ public class ProjectManagerClient : IProjectManagerClient /// /// The version of the SDK /// - public const string SdkVersion = "107.0.3368"; + public const string SdkVersion = "110.0.3705"; private readonly string _apiUrl; private readonly HttpClient _client;