Skip to content

Commit

Permalink
docs: Update collaboration resource (box/box-openapi#483)
Browse files Browse the repository at this point in the history
  • Loading branch information
box-sdk-build committed Nov 18, 2024
1 parent b94c087 commit 6a67ba0
Show file tree
Hide file tree
Showing 13 changed files with 439 additions and 232 deletions.
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "6ae899a", "specHash": "c2c76f3", "version": "1.7.0" }
{ "engineHash": "6ae899a", "specHash": "6d5f53e", "version": "1.7.0" }
2 changes: 1 addition & 1 deletion docs/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ await client.collections.getCollectionItems(favouriteCollection.id!);

### Returns

This function returns a value of type `Items`.
This function returns a value of type `ItemsOffsetPaginated`.

Returns an array of items in the collection.

Expand Down
4 changes: 2 additions & 2 deletions docs/listCollaborations.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ await client.listCollaborations.getCollaborations({

### Returns

This function returns a value of type `Collaborations`.
This function returns a value of type `CollaborationsOffsetPaginated`.

Returns a collection of pending collaboration objects.

Expand Down Expand Up @@ -136,7 +136,7 @@ await client.listCollaborations.getGroupCollaborations(group.id);

### Returns

This function returns a value of type `Collaborations`.
This function returns a value of type `CollaborationsOffsetPaginated`.

Returns a collection of collaboration objects. If there are no
collaborations, an empty collection will be returned.
162 changes: 81 additions & 81 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions src/managers/collections.generated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ import { serializeCollections } from '../schemas/collections.generated.js';
import { deserializeCollections } from '../schemas/collections.generated.js';
import { serializeClientError } from '../schemas/clientError.generated.js';
import { deserializeClientError } from '../schemas/clientError.generated.js';
import { serializeItems } from '../schemas/items.generated.js';
import { deserializeItems } from '../schemas/items.generated.js';
import { serializeItemsOffsetPaginated } from '../schemas/itemsOffsetPaginated.generated.js';
import { deserializeItemsOffsetPaginated } from '../schemas/itemsOffsetPaginated.generated.js';
import { serializeCollection } from '../schemas/collection.generated.js';
import { deserializeCollection } from '../schemas/collection.generated.js';
import { Collections } from '../schemas/collections.generated.js';
import { ClientError } from '../schemas/clientError.generated.js';
import { Items } from '../schemas/items.generated.js';
import { ItemsOffsetPaginated } from '../schemas/itemsOffsetPaginated.generated.js';
import { Collection } from '../schemas/collection.generated.js';
import { Authentication } from '../networking/auth.generated.js';
import { NetworkSession } from '../networking/network.generated.js';
Expand Down Expand Up @@ -275,12 +275,12 @@ export class CollectionsManager {
* @param {string} collectionId The ID of the collection.
Example: "926489"
* @param {GetCollectionItemsOptionalsInput} optionalsInput
* @returns {Promise<Items>}
* @returns {Promise<ItemsOffsetPaginated>}
*/
async getCollectionItems(
collectionId: string,
optionalsInput: GetCollectionItemsOptionalsInput = {},
): Promise<Items> {
): Promise<ItemsOffsetPaginated> {
const optionals: GetCollectionItemsOptionals =
new GetCollectionItemsOptionals({
queryParams: optionalsInput.queryParams,
Expand Down Expand Up @@ -318,7 +318,7 @@ export class CollectionsManager {
cancellationToken: cancellationToken,
} satisfies FetchOptions)) as FetchResponse;
return {
...deserializeItems(response.data),
...deserializeItemsOffsetPaginated(response.data),
rawData: response.data,
};
}
Expand Down
Loading

0 comments on commit 6a67ba0

Please sign in to comment.