Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "3e11b6f", "specHash": "425a724", "version": "10.3.0" }
{ "engineHash": "3e11b6f", "specHash": "ad08e8c", "version": "10.3.0" }
2 changes: 1 addition & 1 deletion box_sdk_gen/managers/authorization.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/managers/folders.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
24 changes: 21 additions & 3 deletions box_sdk_gen/schemas/file_full.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
from typing import Optional

from box_sdk_gen.internal.base_object import BaseObject

from enum import Enum

from typing import Optional

from typing import List

from box_sdk_gen.schemas.file_base import FileBaseTypeField
Expand Down Expand Up @@ -50,6 +50,8 @@ def __init__(
can_upload: bool,
can_view_annotations_all: bool,
can_view_annotations_self: bool,
*,
can_apply_watermark: Optional[bool] = None,
**kwargs
):
"""
Expand Down Expand Up @@ -82,6 +84,8 @@ def __init__(
:param can_view_annotations_self: Specifies if the user view annotations placed by themselves
on this file.
:type can_view_annotations_self: bool
:param can_apply_watermark: Specifies if the user can apply a watermark to this file., defaults to None
:type can_apply_watermark: Optional[bool], optional
"""
super().__init__(**kwargs)
self.can_delete = can_delete
Expand All @@ -96,6 +100,7 @@ def __init__(
self.can_upload = can_upload
self.can_view_annotations_all = can_view_annotations_all
self.can_view_annotations_self = can_view_annotations_self
self.can_apply_watermark = can_apply_watermark


class FileFullLockTypeField(str, Enum):
Expand Down Expand Up @@ -190,13 +195,26 @@ def __init__(


class FileFullWatermarkInfoField(BaseObject):
def __init__(self, *, is_watermarked: Optional[bool] = None, **kwargs):
def __init__(
self,
*,
is_watermarked: Optional[bool] = None,
is_watermark_inherited: Optional[bool] = None,
is_watermarked_by_access_policy: Optional[bool] = None,
**kwargs
):
"""
:param is_watermarked: Specifies if this item has a watermark applied., defaults to None
:type is_watermarked: Optional[bool], optional
:param is_watermark_inherited: Specifies if the watermark is inherited from any parent folder in the hierarchy., defaults to None
:type is_watermark_inherited: Optional[bool], optional
:param is_watermarked_by_access_policy: Specifies if the watermark is enforced by an access policy., defaults to None
:type is_watermarked_by_access_policy: Optional[bool], optional
"""
super().__init__(**kwargs)
self.is_watermarked = is_watermarked
self.is_watermark_inherited = is_watermark_inherited
self.is_watermarked_by_access_policy = is_watermarked_by_access_policy


class FileFullAllowedInviteeRolesField(str, Enum):
Expand Down
24 changes: 21 additions & 3 deletions box_sdk_gen/schemas/folder_full.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
from enum import Enum

from box_sdk_gen.internal.base_object import BaseObject

from typing import Optional

from box_sdk_gen.internal.base_object import BaseObject

from typing import List

from box_sdk_gen.schemas.folder_base import FolderBaseTypeField
Expand Down Expand Up @@ -49,6 +49,8 @@ def __init__(
can_set_share_access: bool,
can_share: bool,
can_upload: bool,
*,
can_apply_watermark: Optional[bool] = None,
**kwargs
):
"""
Expand All @@ -70,6 +72,8 @@ def __init__(
:type can_share: bool
:param can_upload: Specifies if the user can upload into this folder.
:type can_upload: bool
:param can_apply_watermark: Specifies if the user can apply a watermark to this folder and its contents., defaults to None
:type can_apply_watermark: Optional[bool], optional
"""
super().__init__(**kwargs)
self.can_delete = can_delete
Expand All @@ -79,6 +83,7 @@ def __init__(
self.can_set_share_access = can_set_share_access
self.can_share = can_share
self.can_upload = can_upload
self.can_apply_watermark = can_apply_watermark


class FolderFullMetadataField(BaseObject):
Expand All @@ -104,13 +109,26 @@ class FolderFullAllowedInviteeRolesField(str, Enum):


class FolderFullWatermarkInfoField(BaseObject):
def __init__(self, *, is_watermarked: Optional[bool] = None, **kwargs):
def __init__(
self,
*,
is_watermarked: Optional[bool] = None,
is_watermark_inherited: Optional[bool] = None,
is_watermarked_by_access_policy: Optional[bool] = None,
**kwargs
):
"""
:param is_watermarked: Specifies if this item has a watermark applied., defaults to None
:type is_watermarked: Optional[bool], optional
:param is_watermark_inherited: Specifies if the watermark is inherited from any parent folder in the hierarchy., defaults to None
:type is_watermark_inherited: Optional[bool], optional
:param is_watermarked_by_access_policy: Specifies if the watermark is enforced by an access policy., defaults to None
:type is_watermarked_by_access_policy: Optional[bool], optional
"""
super().__init__(**kwargs)
self.is_watermarked = is_watermarked
self.is_watermark_inherited = is_watermark_inherited
self.is_watermarked_by_access_policy = is_watermarked_by_access_policy


class FolderFullClassificationField(BaseObject):
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/schemas/realtime_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/schemas/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/schemas/user_full.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/file_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/folders.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
8 changes: 4 additions & 4 deletions docs/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]`
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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]`
Expand Down