{"id":20119579,"url":"https://github.com/box/box-dotnet-sdk-gen","last_synced_at":"2025-05-06T14:32:28.159Z","repository":{"id":216292447,"uuid":"676516510","full_name":"box/box-dotnet-sdk-gen","owner":"box","description":"Repository for Box .NET autogenerated SDK","archived":false,"fork":false,"pushed_at":"2025-04-22T16:02:04.000Z","size":4825,"stargazers_count":12,"open_issues_count":3,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-22T17:25:03.751Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/box.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-08-09T11:30:49.000Z","updated_at":"2025-04-22T16:02:08.000Z","dependencies_parsed_at":"2024-04-19T16:29:59.182Z","dependency_job_id":"7ae4e23c-ae1f-442f-ba26-9266f0de2c23","html_url":"https://github.com/box/box-dotnet-sdk-gen","commit_stats":null,"previous_names":["box/box-dotnet-sdk-gen"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-dotnet-sdk-gen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-dotnet-sdk-gen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-dotnet-sdk-gen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-dotnet-sdk-gen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/box","download_url":"https://codeload.github.com/box/box-dotnet-sdk-gen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252703454,"owners_count":21790887,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T19:16:09.908Z","updated_at":"2025-05-06T14:32:28.152Z","avatar_url":"https://github.com/box.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/box/sdks/blob/master/images/box-dev-logo.png\" alt= “box-dev-logo” width=\"30%\" height=\"50%\"\u003e\n\u003c/p\u003e\n\n# Box Dotnet SDK Gen\n\n[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)\n![build](https://github.com/box/box-dotnet-sdk-gen/actions/workflows/build.yml/badge.svg)\n[![nuget version](https://img.shields.io/nuget/v/box.sdk.gen.svg)](https://badge.fury.io/nu/box.sdk.gen)\n[![image](https://img.shields.io/nuget/dt/box.sdk.gen.svg)](https://badge.fury.io/nu/box.sdk.gen)\n![Platform](https://img.shields.io/badge/.NET-6%2B-brightgreen)\n[![Coverage](https://coveralls.io/repos/github/box/box-dotnet-sdk-gen/badge.svg?branch=main)](https://coveralls.io/github/box/box-dotnet-sdk-gen?branch=main)\n\nWe are excited to introduce the stable release of the latest generation of Box Dotnet SDK Gen, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.\n\nWith this SDK, you’ll have access to:\n\n1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.\n2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.\n3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.\n4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.\n5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.\n\nEmbrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.\n\n# Table of contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Box Dotnet SDK Gen](#box-dotnet-sdk-gen)\n- [Table of contents](#table-of-contents)\n- [Installing](#installing)\n  - [BouncyCastle runtime integrity check](#bouncycastle-runtime-integrity-check)\n- [Getting Started](#getting-started)\n- [Documentation](#documentation)\n- [Upgrades](#upgrades)\n- [Integration Tests](#integration-tests)\n  - [Running integration tests locally](#running-integration-tests-locally)\n    - [Create Platform Application](#create-platform-application)\n    - [Export configuration](#export-configuration)\n    - [Running tests](#running-tests)\n- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)\n- [Copyright and License](#copyright-and-license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n# Installing\n\nYou can install SDK using Nuget\n\n```pwsh\nInstall-Package Box.Sdk.Gen\n```\n\nAlternatively, you can find this package and it's latest version [on nuget](https://www.nuget.org/packages/Box.Sdk.Gen) and manually add it to the `.csproj` file as a reference:\n\n```xml\n\u003cItemGroup\u003e\n  \u003cPackageReference Include=\"Box.Sdk.Gen\" Version=\"X.Y.Z\" /\u003e\n\u003c/ItemGroup\u003e\n```\n\n## BouncyCastle runtime integrity check\n\nThe version of BouncyCastle included in the SDK performs a checksum validation at runtime. As a result, any modifications to the .dll file, such as those introduced by optimizations like [ReadyToRun (R2R)](https://learn.microsoft.com/en-us/dotnet/core/deploying/ready-to-run) compilation, can alter the checksum, causing the validation to fail. This can lead to issues with SDK functionalities that rely on BouncyCastle, such as JWT authentication unusable.\n\nYou can exclude BouncyCastle from ReadyToRun compilation by adding the following to your `.csproj` file:\n\n```xml\n\u003cItemGroup\u003e\n  \u003cPublishReadyToRunExclude Include=\"bc-fips-1.0.2.dll\" /\u003e\n  \u003cPublishReadyToRunExclude Include=\"bcpkix-fips-1.0.2.dll\" /\u003e\n\u003c/ItemGroup\u003e\n```\n\n# Getting Started\n\nTo get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer\nConsole](https://app.box.com/developers/console). You can use this token to make test calls for your own Box account.\n\nThe SDK provides a `BoxDeveloperTokenAuth` class, which allows you to authenticate using your Developer Token.\nUse instance of `BoxDeveloperTokenAuth` to initialize `BoxClient` object.\nUsing `BoxClient` object you can access managers, which allow you to perform some operations on your Box account.\n\nThe example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.\n\n```c#\nusing Box.Sdk.Gen;\n\nvar auth = new BoxDeveloperTokenAuth(token: \"DEVELOPER_TOKEN_GOES_HERE\");\nvar client = new BoxClient(auth: auth);\n\nvar items = await client.Folders.GetFolderItemsAsync(folderId: \"0\");\nif (items.Entries != null)\n{\n    foreach (var item in items.Entries)\n    {\n        if (item.FileFull != null)\n        {\n            Console.WriteLine(item.FileFull.Name);\n        }\n        else if (item.FolderMini != null)\n        {\n            Console.WriteLine(item.FolderMini.Name);\n        }\n        else if (item.WebLink != null)\n        {\n            Console.WriteLine(item.WebLink.Name);\n        }\n    }\n}\n```\n\nThe usage docs that show how to make calls to the Box API with the SDK can be found [here](https://github.com/box/box-Dotnet-sdk-gen/tree/main/docs).\n\nWe recommend, familiarizing yourself with the remaining [authentication methods](https://github.com/box/box-Dotnet-sdk-gen/tree/main/docs/Authentication.md), [uploading files](https://github.com/box/box-Dotnet-sdk-gen/tree/main/docs/Uploads.md) and [downloading files](https://github.com/box/box-Dotnet-sdk-gen/tree/main/docs/Downloads.md).\n\n# Documentation\n\nBrowse the [docs](docs/README.md) or see [API Reference](https://developer.box.com/reference/) for more information.\n\n# Upgrades\n\nUpgrading from our legacy SDKs to the new generation SDKs is a straightforward process. See our [migration guide](migration-guide.md) and [changelog](CHANGELOG.md) for more information.\n\n# Integration Tests\n\n## Running integration tests locally\n\n### Create Platform Application\n\nTo run integration tests locally you will need a `Custom App` created in the [Box Developer\nConsole](https://app.box.com/developers/console)\nwith `Server Authentication (with JWT)` selected as authentication method.\nOnce created you can edit properties of the application:\n\n- In section `App Access Level` select `App + Enterprise Access`. You can enable all `Application Scopes`.\n- In section `Advanced Features` enable `Make API calls using the as-user header` and `Generate user access tokens`.\n\nNow select `Authorization` and submit application to be reviewed by account admin.\n\n### Export configuration\n\n1. Select `Configuration` tab and in the bottom in the section `App Settings`\n   download your app configuration settings as JSON.\n2. Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`\n3. Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file\n4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account, `BOX_EXTERNAL_USER_EMAIL` with email of free external user which not belongs to any enterprise.\n5. Set environment variable: `WORKFLOW_FOLDER_ID` with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API.\n6. Set environment variable: `APP_ITEM_ASSOCIATION_FILE_ID` to the ID of the file with associated app item and `APP_ITEM_ASSOCIATION_FOLDER_ID` to the ID of the folder with associated app item.\n7. Set environment variable: `APP_ITEM_SHARED_LINK` to the shared link associated with app item.\n8. Set environment variable: `SLACK_AUTOMATION_USER_ID` to the ID of the user responsible for the Slack automation, `SLACK_ORG_ID` to the ID of the Slack organization and `SLACK_PARTNER_ITEM_ID` to the ID of the Slack partner item.\n\n### Running tests\n\nTo run integration tests locally:\n\n1. `dotnet test`\n\n# Questions, Bugs, and Feature Requests?\n\nNeed to contact us directly? [Browse the issues\ntickets](https://github.com/box/box-Dotnet-sdk-gen/issues)! Or, if that\ndoesn't work, [file a new\none](https://github.com/box/box-Dotnet-sdk-gen/issues/new) and we will get\nback to you. If you have general questions about the Box API, you can\npost to the [Box Developer Forum](https://forum.box.com/).\n\n# Copyright and License\n\nCopyright 2023 Box, Inc. All rights reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbox%2Fbox-dotnet-sdk-gen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbox%2Fbox-dotnet-sdk-gen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbox%2Fbox-dotnet-sdk-gen/lists"}