Skip to content

Commit d32c7f8

Browse files
author
klim
committed
moved redundant ext classes methods & implemented client documentation generation
1 parent 2d61d1c commit d32c7f8

File tree

85 files changed

+1166
-1301
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+1166
-1301
lines changed

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Accounts/IAccountClient.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
using System;
22
using System.Threading.Tasks;
3+
using JetBrains.Annotations;
34
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Accounts;
45
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Certificates;
56
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Warrants;
7+
using Kontur.Extern.Api.Client.Attributes;
68
using Kontur.Extern.Api.Client.Http;
79
using Kontur.Extern.Api.Client.Models.Accounts;
810
using Kontur.Extern.Api.Client.Models.Numbers;
@@ -11,6 +13,8 @@
1113

1214
namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Accounts
1315
{
16+
[PublicAPI]
17+
[ClientDocumentationSection]
1418
public interface IAccountClient
1519
{
1620
IHttpRequestFactory HttpRequestFactory { get; }

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Contents/IContentsClient.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
using System;
22
using System.IO;
33
using System.Threading.Tasks;
4+
using JetBrains.Annotations;
45
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Contents;
6+
using Kontur.Extern.Api.Client.Attributes;
57

68
namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Contents
79
{
10+
[PublicAPI]
11+
[ClientDocumentationSection]
812
public interface IContentsClient
913
{
1014
Task<ContentResponse> StartUploadAsync(Guid accountId, byte[] content, long from, long to, long? contentLength, TimeSpan? timeout = null);

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Docflows/IDocflowsClient.cs‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
using JetBrains.Annotations;
66
using Kontur.Extern.Api.Client.ApiLevel.Models.Requests.Docflows;
77
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Docflows;
8+
using Kontur.Extern.Api.Client.Attributes;
89
using Kontur.Extern.Api.Client.Models.ApiTasks;
910
using Kontur.Extern.Api.Client.Models.Common;
1011
using Kontur.Extern.Api.Client.Models.Docflows;
@@ -16,6 +17,7 @@ namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Docflows
1617
{
1718
[PublicAPI]
1819
[SuppressMessage("ReSharper", "CommentTypo")]
20+
[ClientDocumentationSection]
1921
public interface IDocflowsClient
2022
{
2123
/// <summary>
@@ -138,7 +140,7 @@ Task<IDocflowWithDocuments> GetInventoryDocflowAsync(
138140
/// <returns>Документ из документооборота или null</returns>
139141
Task<Document?> TryGetDocumentAsync(Guid accountId, Guid docflowId, Guid documentId, TimeSpan? timeout = null);
140142

141-
143+
142144
/// <summary>
143145
/// Изменение реквизитов документа требования
144146
/// </summary>

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Drafts/DraftsClient.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ public Task<ApiTaskResult<PrintDocumentResult>> StartPrintDocumentAsync(Guid acc
105105
var url = new RequestUrlBuilder($"/v1/{accountId}/drafts/{draftId}/documents/{documentId}/print")
106106
.AppendToQuery("deferred", true)
107107
.Build();
108+
// todo (ks.savelev) Несуществующий метод/путь апи?
108109
return http.PostAsync<ApiTaskResult<PrintDocumentResult>>(url, timeout);
109110
}
110111

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Drafts/IDraftsClient.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.ApiTasks;
99
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Drafts.Check;
1010
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Drafts.Send;
11+
using Kontur.Extern.Api.Client.Attributes;
1112
using Kontur.Extern.Api.Client.Models.ApiTasks;
1213
using Kontur.Extern.Api.Client.Models.Common;
1314
using Kontur.Extern.Api.Client.Models.Docflows;
@@ -20,6 +21,7 @@ namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Drafts
2021
{
2122
[PublicAPI]
2223
[SuppressMessage("ReSharper", "CommentTypo")]
24+
[ClientDocumentationSection]
2325
public interface IDraftsClient
2426
{
2527
/// <summary>

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/DraftsBuilders/IDraftsBuilderClient.cs‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
using System;
22
using System.Collections.Generic;
33
using System.Threading.Tasks;
4+
using JetBrains.Annotations;
45
using Kontur.Extern.Api.Client.ApiLevel.Models.Requests.DraftBuilders.Builders;
56
using Kontur.Extern.Api.Client.ApiLevel.Models.Requests.DraftBuilders.DocumentFiles;
67
using Kontur.Extern.Api.Client.ApiLevel.Models.Requests.DraftBuilders.Documents;
78
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.DraftBuilders.Builders;
9+
using Kontur.Extern.Api.Client.Attributes;
810
using Kontur.Extern.Api.Client.Models.ApiTasks;
911
using Kontur.Extern.Api.Client.Models.DraftsBuilders.Builders;
1012
using Kontur.Extern.Api.Client.Models.DraftsBuilders.DocumentFiles;
@@ -14,6 +16,8 @@
1416

1517
namespace Kontur.Extern.Api.Client.ApiLevel.Clients.DraftsBuilders
1618
{
19+
[PublicAPI]
20+
[ClientDocumentationSection]
1721
public interface IDraftsBuilderClient
1822
{
1923
/// <summary>
@@ -33,7 +37,7 @@ public interface IDraftsBuilderClient
3337
/// <param name="timeout"></param>
3438
/// <returns>DraftsBuilder</returns>
3539
Task<DraftsBuilder> GetDraftsBuilderAsync(Guid accountId, Guid draftsBuilderId, TimeSpan? timeout = null);
36-
40+
3741
/// <summary>
3842
/// Получение DraftsBuilder по идентификатору
3943
/// </summary>
@@ -187,7 +191,7 @@ Task<DraftsBuilderDocumentMeta> GetDocumentMetaAsync(
187191
Guid draftsBuilderId,
188192
Guid documentId,
189193
TimeSpan? timeout = null);
190-
194+
191195
/// <summary>
192196
/// Получение метаинформации документа
193197
/// </summary>
@@ -329,7 +333,7 @@ Task<DraftsBuilderDocumentFileMeta> GetFileMetaAsync(
329333
Guid documentId,
330334
Guid fileId,
331335
TimeSpan? timeout = null);
332-
336+
333337
/// <summary>
334338
/// Получение метаинформации файла
335339
/// </summary>

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Events/IEventsClient.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
using System;
22
using System.Threading.Tasks;
3+
using JetBrains.Annotations;
34
using Kontur.Extern.Api.Client.ApiLevel.Models.Requests.Events;
45
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Events;
6+
using Kontur.Extern.Api.Client.Attributes;
57

68
namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Events
79
{
10+
[PublicAPI]
11+
[ClientDocumentationSection]
812
public interface IEventsClient
913
{
1014
Task<EventsPage> GetEventsAsync(int take, string fromId = "0_0", TimeSpan? timeout = null);

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Handbooks/IHandbooksClient.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
using System;
22
using System.Threading.Tasks;
3+
using JetBrains.Annotations;
34
using Kontur.Extern.Api.Client.ApiLevel.Models.Requests.Handbooks;
45
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Handbooks;
56
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Handbooks.UniqueHandbooks;
7+
using Kontur.Extern.Api.Client.Attributes;
68

79
namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Handbooks;
810

11+
[PublicAPI]
12+
[ClientDocumentationSection]
913
public interface IHandbooksClient
1014
{
1115
Task<ControlUnitsPage> GetControlUnits(ControlUnitsFilter? filter, TimeSpan? timeout = null);

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Organizations/IOrganizationsClient.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
using System;
22
using System.Diagnostics.CodeAnalysis;
33
using System.Threading.Tasks;
4+
using JetBrains.Annotations;
45
using Kontur.Extern.Api.Client.ApiLevel.Models.Requests.Organizations.ControlUnitSubscriptions;
56
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Organizations;
67
using Kontur.Extern.Api.Client.ApiLevel.Models.Responses.Organizations.ControlUnitSubscriptions;
8+
using Kontur.Extern.Api.Client.Attributes;
79
using Kontur.Extern.Api.Client.Models.Numbers;
810

911
namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Organizations
1012
{
13+
[PublicAPI]
1114
[SuppressMessage("ReSharper", "CommentTypo")]
15+
[ClientDocumentationSection]
1216
public interface IOrganizationsClient
1317
{
1418
Task<OrganizationBatch> GetAllOrganizationsAsync(

‎src/Kontur.Extern.Api.Client/ApiLevel/Clients/Replies/IRepliesClient.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
using System;
2+
using System.Diagnostics.CodeAnalysis;
23
using System.Net;
34
using System.Threading.Tasks;
5+
using JetBrains.Annotations;
6+
using Kontur.Extern.Api.Client.Attributes;
47
using Kontur.Extern.Api.Client.Models.Common;
58
using Kontur.Extern.Api.Client.Models.Docflows;
69
using Kontur.Extern.Api.Client.Models.Docflows.Documents.Replies;
@@ -9,6 +12,9 @@
912

1013
namespace Kontur.Extern.Api.Client.ApiLevel.Clients.Replies
1114
{
15+
[PublicAPI]
16+
[SuppressMessage("ReSharper", "CommentTypo")]
17+
[ClientDocumentationSection]
1218
public interface IRepliesClient
1319
{
1420
/// <summary>

0 commit comments

Comments
 (0)