diff --git a/.codegen.json b/.codegen.json index 09a90978..66004b28 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "3e11b6f", "specHash": "4beaa19", "version": "10.3.0" } +{ "engineHash": "3e11b6f", "specHash": "ad08e8c", "version": "10.3.0" } diff --git a/box_sdk_gen/managers/authorization.py b/box_sdk_gen/managers/authorization.py index 7bcb2af9..e03ae65e 100644 --- a/box_sdk_gen/managers/authorization.py +++ b/box_sdk_gen/managers/authorization.py @@ -218,7 +218,7 @@ def request_access_token( operations you will begin by requesting authentication from the - [authorize](#get-authorize) endpoint and Box will send you an + [authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an authorization code. diff --git a/box_sdk_gen/managers/events.py b/box_sdk_gen/managers/events.py index 1ccd76a8..e929f8d8 100644 --- a/box_sdk_gen/managers/events.py +++ b/box_sdk_gen/managers/events.py @@ -420,7 +420,7 @@ def get_events_with_long_polling( """ Returns a list of real-time servers that can be used for long-polling updates - to the [event stream](#get-events). + to the [event stream](https://developer.box.com/reference/get-events). Long polling is the concept where a HTTP request is kept open until the @@ -453,7 +453,7 @@ def get_events_with_long_polling( it only serves as a prompt to take further action such as sending a - request to the [events endpoint](#get-events) with the last known + request to the [events endpoint](https://developer.box.com/reference/get-events) with the last known `stream_position`. diff --git a/box_sdk_gen/managers/folders.py b/box_sdk_gen/managers/folders.py index f7b3e2c3..3f6c67df 100644 --- a/box_sdk_gen/managers/folders.py +++ b/box_sdk_gen/managers/folders.py @@ -689,7 +689,7 @@ def get_folder_items( To request more information about the folder itself, like its size, - use the [Get a folder](#get-folders-id) endpoint instead. + use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead. :param folder_id: The unique identifier that represent a folder. diff --git a/box_sdk_gen/managers/users.py b/box_sdk_gen/managers/users.py index 0bc8a85d..69549f8c 100644 --- a/box_sdk_gen/managers/users.py +++ b/box_sdk_gen/managers/users.py @@ -262,7 +262,7 @@ def create_user( :param role: The user’s enterprise role., defaults to None :type role: Optional[CreateUserRole], optional :param language: The language of the user, formatted in modified version of the - [ISO 639-1](/guides/api-calls/language-codes) format., defaults to None + [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format., defaults to None :type language: Optional[str], optional :param is_sync_enabled: Whether the user can use Box Sync., defaults to None :type is_sync_enabled: Optional[bool], optional @@ -535,7 +535,7 @@ def update_user_by_id( :param role: The user’s enterprise role., defaults to None :type role: Optional[UpdateUserByIdRole], optional :param language: The language of the user, formatted in modified version of the - [ISO 639-1](/guides/api-calls/language-codes) format., defaults to None + [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format., defaults to None :type language: Optional[str], optional :param is_sync_enabled: Whether the user can use Box Sync., defaults to None :type is_sync_enabled: Optional[bool], optional diff --git a/box_sdk_gen/schemas/realtime_server.py b/box_sdk_gen/schemas/realtime_server.py index f8228268..b9198d27 100644 --- a/box_sdk_gen/schemas/realtime_server.py +++ b/box_sdk_gen/schemas/realtime_server.py @@ -25,7 +25,7 @@ def __init__( :type ttl: Optional[str], optional :param max_retries: The maximum number of retries this server will allow before a new long poll should be started by - getting a [new list of server](#options-events)., defaults to None + getting a [new list of server](https://developer.box.com/reference/options-events)., defaults to None :type max_retries: Optional[str], optional :param retry_timeout: The maximum number of seconds without a response after which you should retry the long poll connection. diff --git a/box_sdk_gen/schemas/user.py b/box_sdk_gen/schemas/user.py index 58eb548f..8e98fec9 100644 --- a/box_sdk_gen/schemas/user.py +++ b/box_sdk_gen/schemas/user.py @@ -72,7 +72,7 @@ def __init__( :param modified_at: When the user object was last modified., defaults to None :type modified_at: Optional[DateTime], optional :param language: The language of the user, formatted in modified version of the - [ISO 639-1](/guides/api-calls/language-codes) format., defaults to None + [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format., defaults to None :type language: Optional[str], optional :param timezone: The user's timezone., defaults to None :type timezone: Optional[str], optional diff --git a/box_sdk_gen/schemas/user_full.py b/box_sdk_gen/schemas/user_full.py index b35ae441..6ae220de 100644 --- a/box_sdk_gen/schemas/user_full.py +++ b/box_sdk_gen/schemas/user_full.py @@ -133,7 +133,7 @@ def __init__( :param modified_at: When the user object was last modified., defaults to None :type modified_at: Optional[DateTime], optional :param language: The language of the user, formatted in modified version of the - [ISO 639-1](/guides/api-calls/language-codes) format., defaults to None + [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format., defaults to None :type language: Optional[str], optional :param timezone: The user's timezone., defaults to None :type timezone: Optional[str], optional diff --git a/docs/authorization.md b/docs/authorization.md index 65da2275..2fb96136 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -51,7 +51,7 @@ authorization code or a server-side JWT assertion. An Access Token is a string that enables Box to verify that a request belongs to an authorized session. In the normal order of operations you will begin by requesting authentication from the -[authorize](#get-authorize) endpoint and Box will send you an +[authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an authorization code. You will then send this code to this endpoint to exchange it for diff --git a/docs/comments.md b/docs/comments.md index b5434eee..cddc33ac 100644 --- a/docs/comments.md +++ b/docs/comments.md @@ -170,5 +170,5 @@ This function returns a value of type `CommentFull`. Returns the newly created comment object. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. diff --git a/docs/events.md b/docs/events.md index 7e4e45cf..80a656e4 100644 --- a/docs/events.md +++ b/docs/events.md @@ -7,7 +7,7 @@ ## Get events long poll endpoint Returns a list of real-time servers that can be used for long-polling updates -to the [event stream](#get-events). +to the [event stream](https://developer.box.com/reference/get-events). Long polling is the concept where a HTTP request is kept open until the server sends a response, then repeating the process over and over to receive @@ -22,7 +22,7 @@ URLs. Next, make a long poll request to any of the provided URLs. When an event occurs in monitored account a response with the value `new_change` will be sent. The response contains no other details as it only serves as a prompt to take further action such as sending a -request to the [events endpoint](#get-events) with the last known +request to the [events endpoint](https://developer.box.com/reference/get-events) with the last known `stream_position`. After the server sends this response it closes the connection. You must now diff --git a/docs/file_versions.md b/docs/file_versions.md index b217d2af..f9c13063 100644 --- a/docs/file_versions.md +++ b/docs/file_versions.md @@ -78,7 +78,7 @@ This function returns a value of type `FileVersionFull`. Returns a specific version of a file. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. ## Remove file version diff --git a/docs/files.md b/docs/files.md index 664f051b..5698c052 100644 --- a/docs/files.md +++ b/docs/files.md @@ -46,7 +46,7 @@ This function returns a value of type `FileFull`. Returns a file object. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. ## Update file @@ -101,7 +101,7 @@ This function returns a value of type `FileFull`. Returns a file object. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. ## Delete file @@ -176,7 +176,7 @@ This function returns a value of type `FileFull`. Returns a new file object representing the copied file. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. ## Get file thumbnail URL diff --git a/docs/folders.md b/docs/folders.md index b7966441..7c210a50 100644 --- a/docs/folders.md +++ b/docs/folders.md @@ -65,7 +65,7 @@ To fetch more items within the folder, use the [Get items in a folder](https://developer.box.com/reference/get-folders-id-items)) endpoint. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. ## Update folder @@ -123,7 +123,7 @@ This function returns a value of type `FolderFull`. Returns a folder object for the updated folder Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. If the user is moving folders with a large number of items in all of @@ -171,7 +171,7 @@ Retrieves a page of items in a folder. These items can be files, folders, and web links. To request more information about the folder itself, like its size, -use the [Get a folder](#get-folders-id) endpoint instead. +use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead. This operation is performed by calling function `get_folder_items`. @@ -249,7 +249,7 @@ This function returns a value of type `FolderFull`. Returns a folder object. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. ## Copy folder @@ -291,5 +291,5 @@ This function returns a value of type `FolderFull`. Returns a new folder object representing the copied folder. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request +[fields](#parameter-fields) query parameter to explicitly request any specific fields. diff --git a/docs/users.md b/docs/users.md index 45eaa9eb..725d9d91 100644 --- a/docs/users.md +++ b/docs/users.md @@ -82,7 +82,7 @@ client.users.create_user(user_name, login=user_login, is_platform_access_only=Tr - role `Optional[CreateUserRole]` - The user’s enterprise role. - language `Optional[str]` - - The language of the user, formatted in modified version of the [ISO 639-1](/guides/api-calls/language-codes) format. + - The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format. - is_sync_enabled `Optional[bool]` - Whether the user can use Box Sync. - job_title `Optional[str]` @@ -198,8 +198,8 @@ This function returns a value of type `UserFull`. Returns a single user object. Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request -any specific fields using the [fields](#get-users-id--request--fields) +[fields](#parameter-fields) query parameter to explicitly request +any specific fields using the [fields](#parameter-fields) parameter. ## Update user @@ -234,7 +234,7 @@ client.users.update_user_by_id(user.id, name=updated_user_name) - role `Optional[UpdateUserByIdRole]` - The user’s enterprise role. - language `Optional[str]` - - The language of the user, formatted in modified version of the [ISO 639-1](/guides/api-calls/language-codes) format. + - The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format. - is_sync_enabled `Optional[bool]` - Whether the user can use Box Sync. - job_title `Optional[str]`