box · mhagmajer · Aug 5, 2023 · Jul 28, 2023 · Aug 3, 2023 · Aug 3, 2023
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,55 @@
+---
+name: Bug
+about: Report a bug found in the SDK
+title: ''
+labels: bug
+assignees: mwwoda, mhagmajer, antusus, arjankowski, lukaszsocha2, bartlomiejleszczynski
+---
+
+- [ ] I have checked that the [SDK documentation][sdk-docs] doesn't solve my issue.
+- [ ] I have checked that the [API documentation][api-docs] doesn't solve my issue.
+- [ ] I have searched the [Box Developer Forums][dev-forums] and my issue isn't already reported (or if it has been reported, I have attached a link to it, for reference).
+- [ ] I have searched [Issues in this repo][github-repo] and my issue isn't already reported.
+
+### Description of the Issue
+
+<!-- Replace this text with a description of what problem you're having. -->
+<!-- Please include as much detail as possible to help us troubleshoot! -->
+<!-- If it isn't obvious, please include how the behavior you expect differs from what actually happened. -->
+<!-- This is really important so we know how to start troubleshooting your issue. -->
+
+### Steps to Reproduce
+
+<!-- Please include detailed steps to reproduce the issue you're seeing, if possible. -->
+<!-- If you don't have a reproducible error, please make sure that you give us as much detail -->
+<!-- as you can about what your application was doing when the error occurred. -->
+<!-- Good steps to reproduce the problem help speed up debugging for us and gets your issue resolved sooner! -->
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected Behavior
+
+<!-- What did you expect to happen? -->
+
+### Error Message, Including Stack Trace
+
+<!-- Share the full error output you're seeing, if applicable. -->
+<!-- Please include the full stack trace to help us identify where the error is happening. -->
+
+### Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+### Versions Used
+
+Typescript SDK: <!-- Replace with the version of the Typescript SDK you're using. -->
+Platform: <!-- Replace with the platform you're using (e.g. Node.js, Javascript (Browser), etc.) -->
+Node.js (if applicabe): <!-- Replace with the version of Node.js your application is running on. -->
+
+[sdk-docs]: https://github.com/box/box-ts-sdk-generated/tree/main/docs
+[api-docs]: https://developer.box.com/docs
+[dev-forums]: https://community.box.com/t5/Platform-and-Development-Forum/bd-p/DeveloperForum
+[github-repo]: https://github.com/box/box-ts-sdk-generated/search?type=Issues
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: SDK documentation
+    url: https://github.com/box/box-ts-sdk-generated/tree/main/docs
+    about: Before creating an issue, I have checked that the SDK documentation doesn't solve my issue.
+  - name: API documentation
+    url: https://developer.box.com/docs
+    about: Before creating an issue, I have checked that the API documentation doesn't solve my issue.
+  - name: Box Developer Forums
+    url: https://community.box.com/t5/Platform-and-Development-Forum/bd-p/DeveloperForum
+    about: Before creating an issue, I have searched the Box Developer Forums and my issue isn't already reported there.
+  - name: Issues in this repo
+    url: https://github.com/box/box-ts-sdk-generated/search?type=Issues
+    about: Before creating an issue, I have searched Issues in this repo and my issue isn't already reported.
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -0,0 +1,23 @@
+---
+name: Enhancement
+about: Suggest a new feature or change
+title: ''
+labels: enhancement
+assignees: mwwoda, mhagmajer, antusus, arjankowski, lukaszsocha2, bartlomiejleszczynski
+---
+
+### Is your feature request related to a problem? Please describe.
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+### Describe the solution you'd like
+
+<!-- A clear and concise description of what you want to happen. -->
+
+### Describe alternatives you've considered
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+### Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,55 @@
+---
+name: Question
+about: Request for Assistance
+title: ''
+labels: question
+assignees: mwwoda, mhagmajer, antusus, arjankowski, lukaszsocha2, bartlomiejleszczynski
+---
+
+- [ ] I have checked that the [SDK documentation][sdk-docs] doesn't solve my issue.
+- [ ] I have checked that the [API documentation][api-docs] doesn't solve my issue.
+- [ ] I have searched the [Box Developer Forums][dev-forums] and my issue isn't already reported (or if it has been reported, I have attached a link to it, for reference).
+- [ ] I have searched [Issues in this repo][github-repo] and my issue isn't already reported.
+
+### Description of the Issue
+
+<!-- Replace this text with a description of what problem you're having. -->
+<!-- Please include as much detail as possible to help us troubleshoot! -->
+<!-- If it isn't obvious, please include how the behavior you expect differs from what actually happened. -->
+<!-- This is really important so we know how to start troubleshooting your issue. -->
+
+### Steps to Reproduce
+
+<!-- Please include detailed steps to reproduce the issue you're seeing, if possible. -->
+<!-- If you don't have a reproducible error, please make sure that you give us as much detail -->
+<!-- as you can about what your application was doing when the error occurred. -->
+<!-- Good steps to reproduce the problem help speed up debugging for us and gets your issue resolved sooner! -->
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected Behavior
+
+<!-- What did you expect to happen? -->
+
+### Error Message, Including Stack Trace
+
+<!-- Share the full error output you're seeing, if applicable. -->
+<!-- Please include the full stack trace to help us identify where the error is happening. -->
+
+### Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+### Versions Used
+
+Typescript SDK: <!-- Replace with the version of the Typescript SDK you're using. -->
+Platform: <!-- Replace with the platform you're using (e.g. Node.js, Javascript (Browser), etc.) -->
+Node.js (if applicabe): <!-- Replace with the version of Node.js your application is running on. -->
+
+[sdk-docs]: https://github.com/box/box-ts-sdk-generated/tree/main/docs
+[api-docs]: https://developer.box.com/docs
+[dev-forums]: https://community.box.com/t5/Platform-and-Development-Forum/bd-p/DeveloperForum
+[github-repo]: https://github.com/box/box-ts-sdk-generated/search?type=Issues
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+lib/
+coverage/
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@
 
 - [Installing](#installing)
 - [Getting Started](#getting-started)
+- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
+  - [Copyright and License](#copyright-and-license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -51,7 +53,7 @@ back to you. If you have general questions about the Box API, you can
 post to the [Box Developer
 Forum](https://community.box.com/t5/Developer-Forum/bd-p/DeveloperForum).
 
-## Copyright and License
+# Copyright and License
 
 Copyright 2023 Box, Inc. All rights reserved.
 

diff --git a/docs/authorization.md b/docs/authorization.md
@@ -1,12 +1,15 @@
 # AuthorizationManager
 
+
+- [Authorize user](#authorize-user)
+
 ## Authorize user
 
 Authorize a user by sending them through the [Box](https://box.com)
 website and request their permission to act on their behalf.
 
 This is the first step when authenticating a user using
-OAuth 2.0. To request a user&#x27;s authorization to use the Box APIs
+OAuth 2.0. To request a user's authorization to use the Box APIs
 on their behalf you will need to send a user to the URL with this
 format.
 
@@ -20,7 +23,9 @@ See the endpoint docs at
 ### Arguments
 
 - queryParams `GetAuthorizeQueryParamsArg`
-  - Used as queryParams for the API call
+  - Query parameters of getAuthorize method
+- headers `GetAuthorizeHeadersArg`
+  - Headers of getAuthorize method
 
 
 ### Returns

diff --git a/docs/avatars.md b/docs/avatars.md
@@ -1,8 +1,13 @@
 # AvatarsManager
 
+
+- [Get user avatar](#get-user-avatar)
+- [Add or update user avatar](#add-or-update-user-avatar)
+- [Delete user avatar](#delete-user-avatar)
+
 ## Get user avatar
 
-Retrieves an image of a the user&#x27;s avatar.
+Retrieves an image of a the user's avatar.
 
 This operation is performed by calling function `getUserAvatar`.
 
@@ -17,8 +22,18 @@ await client.avatars.getUserAvatar(user.id)
 ### Arguments
 
 - userId `string`
-  - The ID of the user.
-  - Used as `user_id` in path `path` of the API call
+  - The ID of the user. Example: "12345"
+- headers `GetUserAvatarHeadersArg`
+  - Headers of getUserAvatar method
+
+
+### Returns
+
+This function returns a value of type `ByteStream`.
+
+When an avatar can be found for the user the
+image data will be returned in the body of the
+response.
 
 
 ## Add or update user avatar
@@ -32,24 +47,25 @@ See the endpoint docs at
 
 <!-- sample post_users_id_avatar -->
 ```ts
-await client.avatars.createUserAvatar(user.id, { pic: decodeBase64ByteStream(&quot;iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg&#x3D;&#x3D;&quot;), picContentType: &quot;image/png&quot;, picFileName: &quot;avatar.png&quot; } satisfies CreateUserAvatarRequestBodyArg)
+await client.avatars.createUserAvatar(user.id, { pic: decodeBase64ByteStream("iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg=="), picContentType: "image/png", picFileName: "avatar.png" } satisfies CreateUserAvatarRequestBodyArg)
 ```
 
 ### Arguments
 
 - userId `string`
-  - The ID of the user.
-  - Used as `user_id` in path `path` of the API call
+  - The ID of the user. Example: "12345"
 - requestBody `CreateUserAvatarRequestBodyArg`
-  - Used as requestBody for the API call
+  - Request body of createUserAvatar method
+- headers `CreateUserAvatarHeadersArg`
+  - Headers of createUserAvatar method
 
 
 ### Returns
 
 This function returns a value of type `UserAvatar`.
 
-* &#x60;ok&#x60;: Returns the &#x60;pic_urls&#x60; object with URLs to existing
-user avatars that were updated.* &#x60;created&#x60;: Returns the &#x60;pic_urls&#x60; object with URLS to user avatars
+* `ok`: Returns the `pic_urls` object with URLs to existing
+user avatars that were updated.* `created`: Returns the `pic_urls` object with URLS to user avatars
 uploaded to Box with the request.
 
 
@@ -71,7 +87,15 @@ await client.avatars.deleteUserAvatar(user.id)
 ### Arguments
 
 - userId `string`
-  - The ID of the user.
-  - Used as `user_id` in path `path` of the API call
+  - The ID of the user. Example: "12345"
+- headers `DeleteUserAvatarHeadersArg`
+  - Headers of deleteUserAvatar method
+
+
+### Returns
+
+This function returns a value of type `undefined`.
+
+* `no_content`: Removes the avatar and returns an empty response.