Skip to content

Commit d331f8a

Browse files
fix: update collaboration, metadata and collection resources (box/box-openapi#483) (#316)
1 parent 5f3c0e8 commit d331f8a

18 files changed

+202
-62
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "6ae899a", "specHash": "c2c76f3", "version": "1.4.0" }
1+
{ "engineHash": "6ae899a", "specHash": "6d5f53e", "version": "1.4.0" }

Box.Sdk.Gen.Tests.Integration/Test/Collections/CollectionsManagerTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ public async System.Threading.Tasks.Task TestCollections() {
2222
Collection favouriteCollection = await client.Collections.GetCollectionByIdAsync(collectionId: NullableUtils.Unwrap(NullableUtils.Unwrap(collections.Entries)[0].Id));
2323
Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(favouriteCollection.Type)) == "collection");
2424
Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(favouriteCollection.CollectionType)) == "favorites");
25-
Items collectionItems = await client.Collections.GetCollectionItemsAsync(collectionId: NullableUtils.Unwrap(favouriteCollection.Id));
25+
ItemsOffsetPaginated collectionItems = await client.Collections.GetCollectionItemsAsync(collectionId: NullableUtils.Unwrap(favouriteCollection.Id));
2626
FolderFull folder = await client.Folders.CreateFolderAsync(requestBody: new CreateFolderRequestBody(name: Utils.GetUUID(), parent: new CreateFolderRequestBodyParentField(id: "0")));
2727
await client.Folders.UpdateFolderByIdAsync(folderId: folder.Id, requestBody: new UpdateFolderByIdRequestBody() { Collections = Array.AsReadOnly(new [] {new UpdateFolderByIdRequestBodyCollectionsField() { Id = favouriteCollection.Id }}) });
28-
Items collectionItemsAfterUpdate = await client.Collections.GetCollectionItemsAsync(collectionId: NullableUtils.Unwrap(favouriteCollection.Id));
28+
ItemsOffsetPaginated collectionItemsAfterUpdate = await client.Collections.GetCollectionItemsAsync(collectionId: NullableUtils.Unwrap(favouriteCollection.Id));
2929
Assert.IsTrue(NullableUtils.Unwrap(collectionItemsAfterUpdate.Entries).Count == NullableUtils.Unwrap(collectionItems.Entries).Count + 1);
3030
await client.Folders.UpdateFolderByIdAsync(folderId: folder.Id, requestBody: new UpdateFolderByIdRequestBody() { Collections = Enumerable.Empty<UpdateFolderByIdRequestBodyCollectionsField>().ToList() });
31-
Items collectionItemsAfterRemove = await client.Collections.GetCollectionItemsAsync(collectionId: NullableUtils.Unwrap(favouriteCollection.Id));
31+
ItemsOffsetPaginated collectionItemsAfterRemove = await client.Collections.GetCollectionItemsAsync(collectionId: NullableUtils.Unwrap(favouriteCollection.Id));
3232
Assert.IsTrue(NullableUtils.Unwrap(collectionItemsAfterRemove.Entries).Count == NullableUtils.Unwrap(collectionItems.Entries).Count);
3333
await client.Folders.DeleteFolderByIdAsync(folderId: folder.Id);
3434
}

Box.Sdk.Gen.Tests.Integration/Test/ListCollaborations/ListCollaborationsManagerTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ public async System.Threading.Tasks.Task TestListCollaborations() {
2121
Assert.IsTrue(NullableUtils.Unwrap(fileCollaborations.Entries).Count > 0);
2222
Collaborations folderCollaborations = await client.ListCollaborations.GetFolderCollaborationsAsync(folderId: folder.Id);
2323
Assert.IsTrue(NullableUtils.Unwrap(folderCollaborations.Entries).Count > 0);
24-
Collaborations pendingCollaborations = await client.ListCollaborations.GetCollaborationsAsync(queryParams: new GetCollaborationsQueryParams(status: GetCollaborationsQueryParamsStatusField.Pending));
24+
CollaborationsOffsetPaginated pendingCollaborations = await client.ListCollaborations.GetCollaborationsAsync(queryParams: new GetCollaborationsQueryParams(status: GetCollaborationsQueryParamsStatusField.Pending));
2525
Assert.IsTrue(NullableUtils.Unwrap(pendingCollaborations.Entries).Count >= 0);
26-
Collaborations groupCollaborations = await client.ListCollaborations.GetGroupCollaborationsAsync(groupId: group.Id);
26+
CollaborationsOffsetPaginated groupCollaborations = await client.ListCollaborations.GetGroupCollaborationsAsync(groupId: group.Id);
2727
Assert.IsTrue(NullableUtils.Unwrap(groupCollaborations.Entries).Count > 0);
2828
await client.UserCollaborations.DeleteCollaborationByIdAsync(collaborationId: groupCollaboration.Id);
2929
await client.Files.DeleteFileByIdAsync(fileId: file.Id);

Box.Sdk.Gen/Managers/Collections/CollectionsManager.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ public async System.Threading.Tasks.Task<Collections> GetCollectionsAsync(GetCol
5555
/// <param name="cancellationToken">
5656
/// Token used for request cancellation.
5757
/// </param>
58-
public async System.Threading.Tasks.Task<Items> GetCollectionItemsAsync(string collectionId, GetCollectionItemsQueryParams? queryParams = default, GetCollectionItemsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
58+
public async System.Threading.Tasks.Task<ItemsOffsetPaginated> GetCollectionItemsAsync(string collectionId, GetCollectionItemsQueryParams? queryParams = default, GetCollectionItemsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
5959
queryParams = queryParams ?? new GetCollectionItemsQueryParams();
6060
headers = headers ?? new GetCollectionItemsHeaders();
6161
Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "fields", StringUtils.ToStringRepresentation(queryParams.Fields) }, { "offset", StringUtils.ToStringRepresentation(queryParams.Offset) }, { "limit", StringUtils.ToStringRepresentation(queryParams.Limit) } });
6262
Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { }, headers.ExtraHeaders));
6363
FetchResponse response = await HttpClientAdapter.FetchAsync(new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/collections/", StringUtils.ToStringRepresentation(collectionId), "/items"), networkSession: this.NetworkSession) { Method = "GET", Parameters = queryParamsMap, Headers = headersMap, ResponseFormat = "json", Auth = this.Auth, CancellationToken = cancellationToken }).ConfigureAwait(false);
64-
return SimpleJsonSerializer.Deserialize<Items>(response.Data);
64+
return SimpleJsonSerializer.Deserialize<ItemsOffsetPaginated>(response.Data);
6565
}
6666

6767
/// <summary>

Box.Sdk.Gen/Managers/Collections/ICollectionsManager.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public interface ICollectionsManager {
4141
/// <param name="cancellationToken">
4242
/// Token used for request cancellation.
4343
/// </param>
44-
public System.Threading.Tasks.Task<Items> GetCollectionItemsAsync(string collectionId, GetCollectionItemsQueryParams? queryParams = default, GetCollectionItemsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
44+
public System.Threading.Tasks.Task<ItemsOffsetPaginated> GetCollectionItemsAsync(string collectionId, GetCollectionItemsQueryParams? queryParams = default, GetCollectionItemsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
4545

4646
/// <summary>
4747
/// Retrieves a collection by its ID.

Box.Sdk.Gen/Managers/ListCollaborations/GetFolderCollaborationsQueryParams.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ public class GetFolderCollaborationsQueryParams {
2020
/// </summary>
2121
public IReadOnlyList<string>? Fields { get; init; }
2222

23+
/// <summary>
24+
/// The maximum number of items to return per page.
25+
/// </summary>
26+
public long? Limit { get; init; }
27+
28+
/// <summary>
29+
/// Defines the position marker at which to begin returning results. This is
30+
/// used when paginating using marker-based pagination.
31+
///
32+
/// This requires `usemarker` to be set to `true`.
33+
/// </summary>
34+
public string? Marker { get; init; }
35+
2336
public GetFolderCollaborationsQueryParams() {
2437

2538
}

Box.Sdk.Gen/Managers/ListCollaborations/IListCollaborationsManager.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public interface IListCollaborationsManager {
7171
/// <param name="cancellationToken">
7272
/// Token used for request cancellation.
7373
/// </param>
74-
public System.Threading.Tasks.Task<Collaborations> GetCollaborationsAsync(GetCollaborationsQueryParams queryParams, GetCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
74+
public System.Threading.Tasks.Task<CollaborationsOffsetPaginated> GetCollaborationsAsync(GetCollaborationsQueryParams queryParams, GetCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
7575

7676
/// <summary>
7777
/// Retrieves all the collaborations for a group. The user
@@ -93,7 +93,7 @@ public interface IListCollaborationsManager {
9393
/// <param name="cancellationToken">
9494
/// Token used for request cancellation.
9595
/// </param>
96-
public System.Threading.Tasks.Task<Collaborations> GetGroupCollaborationsAsync(string groupId, GetGroupCollaborationsQueryParams? queryParams = default, GetGroupCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
96+
public System.Threading.Tasks.Task<CollaborationsOffsetPaginated> GetGroupCollaborationsAsync(string groupId, GetGroupCollaborationsQueryParams? queryParams = default, GetGroupCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
9797

9898
}
9999
}

Box.Sdk.Gen/Managers/ListCollaborations/ListCollaborationsManager.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public async System.Threading.Tasks.Task<Collaborations> GetFileCollaborationsAs
7474
public async System.Threading.Tasks.Task<Collaborations> GetFolderCollaborationsAsync(string folderId, GetFolderCollaborationsQueryParams? queryParams = default, GetFolderCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
7575
queryParams = queryParams ?? new GetFolderCollaborationsQueryParams();
7676
headers = headers ?? new GetFolderCollaborationsHeaders();
77-
Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "fields", StringUtils.ToStringRepresentation(queryParams.Fields) } });
77+
Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "fields", StringUtils.ToStringRepresentation(queryParams.Fields) }, { "limit", StringUtils.ToStringRepresentation(queryParams.Limit) }, { "marker", StringUtils.ToStringRepresentation(queryParams.Marker) } });
7878
Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { }, headers.ExtraHeaders));
7979
FetchResponse response = await HttpClientAdapter.FetchAsync(new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/folders/", StringUtils.ToStringRepresentation(folderId), "/collaborations"), networkSession: this.NetworkSession) { Method = "GET", Parameters = queryParamsMap, Headers = headersMap, ResponseFormat = "json", Auth = this.Auth, CancellationToken = cancellationToken }).ConfigureAwait(false);
8080
return SimpleJsonSerializer.Deserialize<Collaborations>(response.Data);
@@ -92,12 +92,12 @@ public async System.Threading.Tasks.Task<Collaborations> GetFolderCollaborations
9292
/// <param name="cancellationToken">
9393
/// Token used for request cancellation.
9494
/// </param>
95-
public async System.Threading.Tasks.Task<Collaborations> GetCollaborationsAsync(GetCollaborationsQueryParams queryParams, GetCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
95+
public async System.Threading.Tasks.Task<CollaborationsOffsetPaginated> GetCollaborationsAsync(GetCollaborationsQueryParams queryParams, GetCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
9696
headers = headers ?? new GetCollaborationsHeaders();
9797
Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "status", StringUtils.ToStringRepresentation(queryParams.Status?.Value) }, { "fields", StringUtils.ToStringRepresentation(queryParams.Fields) }, { "offset", StringUtils.ToStringRepresentation(queryParams.Offset) }, { "limit", StringUtils.ToStringRepresentation(queryParams.Limit) } });
9898
Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { }, headers.ExtraHeaders));
9999
FetchResponse response = await HttpClientAdapter.FetchAsync(new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/collaborations"), networkSession: this.NetworkSession) { Method = "GET", Parameters = queryParamsMap, Headers = headersMap, ResponseFormat = "json", Auth = this.Auth, CancellationToken = cancellationToken }).ConfigureAwait(false);
100-
return SimpleJsonSerializer.Deserialize<Collaborations>(response.Data);
100+
return SimpleJsonSerializer.Deserialize<CollaborationsOffsetPaginated>(response.Data);
101101
}
102102

103103
/// <summary>
@@ -120,13 +120,13 @@ public async System.Threading.Tasks.Task<Collaborations> GetCollaborationsAsync(
120120
/// <param name="cancellationToken">
121121
/// Token used for request cancellation.
122122
/// </param>
123-
public async System.Threading.Tasks.Task<Collaborations> GetGroupCollaborationsAsync(string groupId, GetGroupCollaborationsQueryParams? queryParams = default, GetGroupCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
123+
public async System.Threading.Tasks.Task<CollaborationsOffsetPaginated> GetGroupCollaborationsAsync(string groupId, GetGroupCollaborationsQueryParams? queryParams = default, GetGroupCollaborationsHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
124124
queryParams = queryParams ?? new GetGroupCollaborationsQueryParams();
125125
headers = headers ?? new GetGroupCollaborationsHeaders();
126126
Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "limit", StringUtils.ToStringRepresentation(queryParams.Limit) }, { "offset", StringUtils.ToStringRepresentation(queryParams.Offset) } });
127127
Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { }, headers.ExtraHeaders));
128128
FetchResponse response = await HttpClientAdapter.FetchAsync(new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/groups/", StringUtils.ToStringRepresentation(groupId), "/collaborations"), networkSession: this.NetworkSession) { Method = "GET", Parameters = queryParamsMap, Headers = headersMap, ResponseFormat = "json", Auth = this.Auth, CancellationToken = cancellationToken }).ConfigureAwait(false);
129-
return SimpleJsonSerializer.Deserialize<Collaborations>(response.Data);
129+
return SimpleJsonSerializer.Deserialize<CollaborationsOffsetPaginated>(response.Data);
130130
}
131131

132132
}

Box.Sdk.Gen/Managers/MetadataTemplates/GetMetadataTemplatesByInstanceIdQueryParams.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,19 @@ public class GetMetadataTemplatesByInstanceIdQueryParams {
1313
/// </summary>
1414
public string MetadataInstanceId { get; }
1515

16+
/// <summary>
17+
/// Defines the position marker at which to begin returning results. This is
18+
/// used when paginating using marker-based pagination.
19+
///
20+
/// This requires `usemarker` to be set to `true`.
21+
/// </summary>
22+
public string? Marker { get; init; }
23+
24+
/// <summary>
25+
/// The maximum number of items to return per page.
26+
/// </summary>
27+
public long? Limit { get; init; }
28+
1629
public GetMetadataTemplatesByInstanceIdQueryParams(string metadataInstanceId) {
1730
MetadataInstanceId = metadataInstanceId;
1831
}

Box.Sdk.Gen/Managers/MetadataTemplates/MetadataTemplatesManager.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public MetadataTemplatesManager(NetworkSession? networkSession = default) {
3030
/// </param>
3131
public async System.Threading.Tasks.Task<MetadataTemplates> GetMetadataTemplatesByInstanceIdAsync(GetMetadataTemplatesByInstanceIdQueryParams queryParams, GetMetadataTemplatesByInstanceIdHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
3232
headers = headers ?? new GetMetadataTemplatesByInstanceIdHeaders();
33-
Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "metadata_instance_id", StringUtils.ToStringRepresentation(queryParams.MetadataInstanceId) } });
33+
Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "metadata_instance_id", StringUtils.ToStringRepresentation(queryParams.MetadataInstanceId) }, { "marker", StringUtils.ToStringRepresentation(queryParams.Marker) }, { "limit", StringUtils.ToStringRepresentation(queryParams.Limit) } });
3434
Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { }, headers.ExtraHeaders));
3535
FetchResponse response = await HttpClientAdapter.FetchAsync(new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/metadata_templates"), networkSession: this.NetworkSession) { Method = "GET", Parameters = queryParamsMap, Headers = headersMap, ResponseFormat = "json", Auth = this.Auth, CancellationToken = cancellationToken }).ConfigureAwait(false);
3636
return SimpleJsonSerializer.Deserialize<MetadataTemplates>(response.Data);

0 commit comments

Comments
 (0)