Skip to content

Commit 43da8ee

Browse files
KoditkarVedantKoditkarVedant
authored
Merge pull request #343 from notion-dotnet/342-follow-common-api-conventions
Add Async suffix
2 parents 6d97ad5 + 1182b70 commit 43da8ee

File tree

9 files changed

+27
-25
lines changed

9 files changed

+27
-25
lines changed

‎Src/Notion.Client/Api/Comments/Create/CommentsClient.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ namespace Notion.Client
44
{
55
public partial class CommentsClient
66
{
7-
public async Task<CreateCommentResponse> Create(CreateCommentParameters parameters)
7+
public async Task<CreateCommentResponse> CreateAsync(CreateCommentParameters parameters)
88
{
99
var body = (ICreateCommentsBodyParameters)parameters;
1010

‎Src/Notion.Client/Api/Comments/ICommentsClient.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
using System.Threading.Tasks;
1+
using System.Threading.Tasks;
22

33
namespace Notion.Client
44
{
55
public interface ICommentsClient
66
{
7-
Task<CreateCommentResponse> Create(CreateCommentParameters createCommentParameters);
7+
Task<CreateCommentResponse> CreateAsync(CreateCommentParameters createCommentParameters);
88

9-
Task<RetrieveCommentsResponse> Retrieve(RetrieveCommentsParameters parameters);
9+
Task<RetrieveCommentsResponse> RetrieveAsync(RetrieveCommentsParameters parameters);
1010
}
1111
}

‎Src/Notion.Client/Api/Comments/Retrieve/CommentsClient.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Notion.Client
77
public partial class CommentsClient
88
{
99
[SuppressMessage("ReSharper", "UnusedMember.Global")]
10-
public async Task<RetrieveCommentsResponse> Retrieve(RetrieveCommentsParameters parameters)
10+
public async Task<RetrieveCommentsResponse> RetrieveAsync(RetrieveCommentsParameters parameters)
1111
{
1212
var qp = (IRetrieveCommentsQueryParameters)parameters;
1313

‎Src/Notion.Client/Api/Pages/IPagesClient.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Task<Page> UpdatePropertiesAsync(
5757
/// <returns>
5858
/// <see cref="IPropertyItemObject" />
5959
/// </returns>
60-
Task<IPropertyItemObject> RetrievePagePropertyItem(
60+
Task<IPropertyItemObject> RetrievePagePropertyItemAsync(
6161
RetrievePropertyItemParameters retrievePropertyItemParameters);
6262
}
6363
}

‎Src/Notion.Client/Api/Pages/PagesClient.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public async Task<Page> RetrieveAsync(string pageId)
5454
return await _client.GetAsync<Page>(url);
5555
}
5656

57-
public async Task<IPropertyItemObject> RetrievePagePropertyItem(
57+
public async Task<IPropertyItemObject> RetrievePagePropertyItemAsync(
5858
RetrievePropertyItemParameters retrievePropertyItemParameters)
5959
{
6060
var pathParameters = (IRetrievePropertyItemPathParameters)retrievePropertyItemParameters;

‎Test/Notion.IntegrationTests/CommentsClientTests.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public async Task ShouldCreatePageComment()
4343
);
4444

4545
// Act
46-
var response = await _client.Comments.Create(parameters);
46+
var response = await _client.Comments.CreateAsync(parameters);
4747

4848
// Arrange
4949

@@ -64,7 +64,7 @@ public async Task ShouldCreatePageComment()
6464
public async Task ShouldCreateADiscussionComment()
6565
{
6666
// Arrange
67-
var comment = await _client.Comments.Create(
67+
var comment = await _client.Comments.CreateAsync(
6868
CreateCommentParameters.CreatePageComment(
6969
new ParentPageInput { PageId = _page.Id },
7070
new List<RichTextBaseInput>
@@ -75,7 +75,7 @@ public async Task ShouldCreateADiscussionComment()
7575
);
7676

7777
// Act
78-
var response = await _client.Comments.Create(
78+
var response = await _client.Comments.CreateAsync(
7979
CreateCommentParameters.CreateDiscussionComment(
8080
comment.DiscussionId,
8181
new List<RichTextBaseInput>

‎Test/Notion.IntegrationTests/IPageClientTests.cs‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public async Task CreateAsync_CreatesANewPage()
4747
var pageProperty = page.Properties["Name"].Should().BeOfType<PropertyValue>().Subject;
4848

4949
var titleProperty
50-
= (ListPropertyItem)await _client.Pages.RetrievePagePropertyItem(
50+
= (ListPropertyItem)await _client.Pages.RetrievePagePropertyItemAsync(
5151
new RetrievePropertyItemParameters
5252
{
5353
PageId = page.Id,
@@ -87,7 +87,7 @@ public async Task Bug_unable_to_create_page_with_select_property()
8787
var pageProperty = page.Properties["Name"].Should().BeOfType<PropertyValue>().Subject;
8888

8989
var titleProperty
90-
= (ListPropertyItem)await _client.Pages.RetrievePagePropertyItem(
90+
= (ListPropertyItem)await _client.Pages.RetrievePagePropertyItemAsync(
9191
new RetrievePropertyItemParameters
9292
{
9393
PageId = page.Id,
@@ -116,7 +116,7 @@ public async Task Test_RetrievePagePropertyItemAsync()
116116

117117
var page = await _client.Pages.CreateAsync(pagesCreateParameters);
118118

119-
var property = await _client.Pages.RetrievePagePropertyItem(new RetrievePropertyItemParameters
119+
var property = await _client.Pages.RetrievePagePropertyItemAsync(new RetrievePropertyItemParameters
120120
{
121121
PageId = page.Id,
122122
PropertyId = "title"
@@ -185,11 +185,13 @@ public async Task Test_UpdatePageProperty_with_date_as_null()
185185

186186
var page = await _client.Pages.CreateAsync(pagesCreateParameters);
187187

188-
var setDate = (DatePropertyItem)await _client.Pages.RetrievePagePropertyItem(new RetrievePropertyItemParameters
189-
{
190-
PageId = page.Id,
191-
PropertyId = page.Properties[DatePropertyName].Id
192-
});
188+
var setDate = (DatePropertyItem)await _client.Pages.RetrievePagePropertyItemAsync(
189+
new RetrievePropertyItemParameters
190+
{
191+
PageId = page.Id,
192+
PropertyId = page.Properties[DatePropertyName].Id
193+
}
194+
);
193195

194196
setDate?.Date?.Start.Should().Be(Convert.ToDateTime("2020-12-08T12:00:00Z"));
195197

@@ -201,7 +203,7 @@ public async Task Test_UpdatePageProperty_with_date_as_null()
201203
var updatedPage =
202204
await _client.Pages.UpdateAsync(page.Id, new PagesUpdateParameters { Properties = testProps });
203205

204-
var verifyDate = (DatePropertyItem)await _client.Pages.RetrievePagePropertyItem(
206+
var verifyDate = (DatePropertyItem)await _client.Pages.RetrievePagePropertyItemAsync(
205207
new RetrievePropertyItemParameters
206208
{
207209
PageId = page.Id,
@@ -236,7 +238,7 @@ public async Task Bug_Unable_To_Parse_NumberPropertyItem()
236238
var pageParent = Assert.IsType<DatabaseParent>(page.Parent);
237239
Assert.Equal(_databaseId, pageParent.DatabaseId);
238240

239-
var titleProperty = (ListPropertyItem)await _client.Pages.RetrievePagePropertyItem(
241+
var titleProperty = (ListPropertyItem)await _client.Pages.RetrievePagePropertyItemAsync(
240242
new RetrievePropertyItemParameters
241243
{
242244
PageId = page.Id,
@@ -245,7 +247,7 @@ public async Task Bug_Unable_To_Parse_NumberPropertyItem()
245247

246248
Assert.Equal("Test Page Title", titleProperty.Results.First().As<TitlePropertyItem>().Title.PlainText);
247249

248-
var numberProperty = (NumberPropertyItem)await _client.Pages.RetrievePagePropertyItem(
250+
var numberProperty = (NumberPropertyItem)await _client.Pages.RetrievePagePropertyItemAsync(
249251
new RetrievePropertyItemParameters
250252
{
251253
PageId = page.Id,

‎Test/Notion.UnitTests/DatabasesClientTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ var jsonData
490490
"{\"object\":\"property_item\",\"id\":\"JwY^\",\"type\":\"formula\",\"formula\":{\"type\":\"date\",\"date\":{\"start\":\"2021-06-28\",\"end\":null}}}")
491491
);
492492

493-
var formulaPropertyValue = (FormulaPropertyItem)await _pagesClient.RetrievePagePropertyItem(
493+
var formulaPropertyValue = (FormulaPropertyItem)await _pagesClient.RetrievePagePropertyItemAsync(
494494
new RetrievePropertyItemParameters
495495
{
496496
PageId = page.Id,

‎Test/Notion.UnitTests/PagesClientTests.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ public async Task UpdatePropertiesAsync()
110110
page.Properties.Should().HaveCount(2);
111111
var updatedProperty = page.Properties.First(x => x.Key == "In stock");
112112

113-
var checkboxPropertyValue = (CheckboxPropertyItem)await _client.RetrievePagePropertyItem(
113+
var checkboxPropertyValue = (CheckboxPropertyItem)await _client.RetrievePagePropertyItemAsync(
114114
new RetrievePropertyItemParameters
115115
{
116116
PageId = page.Id,
@@ -176,7 +176,7 @@ public async Task UpdatePageAsync()
176176
page.Properties.Should().HaveCount(2);
177177
var updatedProperty = page.Properties.First(x => x.Key == "In stock");
178178

179-
var checkboxPropertyValue = (CheckboxPropertyItem)await _client.RetrievePagePropertyItem(
179+
var checkboxPropertyValue = (CheckboxPropertyItem)await _client.RetrievePagePropertyItemAsync(
180180
new RetrievePropertyItemParameters
181181
{
182182
PageId = page.Id,
@@ -225,7 +225,7 @@ public async Task ArchivePageAsync()
225225
page.Properties.Should().HaveCount(2);
226226
var updatedProperty = page.Properties.First(x => x.Key == "In stock");
227227

228-
var checkboxPropertyValue = (CheckboxPropertyItem)await _client.RetrievePagePropertyItem(
228+
var checkboxPropertyValue = (CheckboxPropertyItem)await _client.RetrievePagePropertyItemAsync(
229229
new RetrievePropertyItemParameters
230230
{
231231
PageId = page.Id,

0 commit comments

Comments
 (0)