From f526a4fcfaddc5e0c6d3bf7e74ae98326bb2f0d4 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Fri, 25 Oct 2024 04:01:17 +0530 Subject: [PATCH 01/15] Create OpenAPI yaml from the Postman collection at https://www.postman.com/dropbox-api/dropbox-s-public-workspace/collection/q1zdtug/dropbox-api-reference --- docs/spec/openapi.yaml | 13237 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 13237 insertions(+) create mode 100644 docs/spec/openapi.yaml diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml new file mode 100644 index 0000000..d1ea536 --- /dev/null +++ b/docs/spec/openapi.yaml @@ -0,0 +1,13237 @@ +openapi: 3.0.0 +info: + title: Dropbox API Reference + description: >+ + The powerful, yet simple, Dropbox API allows you to manage and control + content and team settings programmatically and extend Dropbox capabilities + in new and powerful ways. This is a collection that includes requests to all + endpoints in the Dropbox API. + + + The Dropbox API is divided in two groups of endpoints: User Endpoints and + Business Endpoints. Operations that would most likely be executed by a user, + such as file operations, are in the User Endpoints folder. Operations that + would most likely be executed by a team administrator, such as adding users + to groups, live in the Business Endpoints folder. + + + If you are new to Dropbox Business and Team Administration, please have a + look at the [Dropobox Admin + Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). + + + If you want more information on how to use our API please refer to our + [Developer Portal](https://www.dropbox.com/developers). + + + # What's in the collection? + + + The endpoints are organized in the following folders: + + * account + + * auth + + * check + + * contacts + + * file_properties + + * file_requests + + * files + + * sharing + + * team + + * team_log + + * users + + + # Authorization + + + ## OAuth 2.0 for API Access + + Dropbox uses OAuth 2.0, an open specification, to authorize access to data. + To get an OAuth token from Dropbox to enable Postman to access your Dropbox + account via the API you’ll need to create a new app on the DBX Platform. + + + ## Creating an App on the DBX Platform + + Navigate to https://www.dropbox.com/developers/apps and select “Create app” + + 1. Choose an API + + 2. Choose the type of access you need + + 3. Give your app a name + + 4. Choose the Dropbox account that will own your app + + + For reference, please use the [Dropbox OAuth + guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) + + + ## Generating an Access Token + + Once you select “Create app” a page will load that displays information + about your newly created app. To generate an access token scroll down to + “OAuth 2” and click “Generate” beneath “Generated access token.” The token + will display as a long string of characters. Copy this token for use with + the Postman Collection. + + + ## Adding an Access Token to the requests + + In the Postman client, click on the three dots to the right of the + collection name to "View more actions." + + + ![Screenshot of adding access + token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1) + + + Then, click "Edit." + + + Click on the "Variables" tab and, in the row for the `access_token` + variable, paste your access token in the `CURRENT VALUE` column. The default + value is `your-access-token-here`. + + + ![Screenshot of adding access + token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1) + + + For information on sessions and variables in Postman see the blog post at + https://blog.postman.com/sessions-faq/. + + + # Notes + + * Dropbox also has a Postman Collection in the API Network to help + administrators with team management workflows. It is called [Dropbox Team + Admin Workflows](). + + version: 1.0.0 +servers: + - url: https://api.dropboxapi.com + - url: https://content.dropboxapi.com + - url: https://notify.dropboxapi.com +components: + securitySchemes: + bearerAuth: + type: http + scheme: bearer +security: + - bearerAuth: [] +tags: + - name: account + - name: auth + - name: check + - name: contacts + - name: file_properties + description: > + This namespace contains helpers for property and template metadata + endpoints. + + + These endpoints enable you to tag arbitrary key/value data to Dropbox + files. + + + The most basic unit in this namespace is the :type:`PropertyField`. These + fields encapsulate the actual key/value data. + + + Fields are added to a Dropbox file using a :type:`PropertyGroup`. Property + groups contain a reference to a Dropbox file and a + :type:`PropertyGroupTemplate`. Property groups are uniquely identified by + the combination of their associated Dropbox file and template. + + + The :type:`PropertyGroupTemplate` is a way of restricting the possible key + names and value types of the data within a property group. The possible + key names and value types are explicitly enumerated using + :type:`PropertyFieldTemplate` objects. + + + You can think of a property group template as a class definition for a + particular key/value metadata object, and the property groups themselves + as the instantiations of these objects. + + + Templates are owned either by a user/app pair or team/app pair. Templates + and their associated properties can't be accessed by any app other than + the app that created them, and even then, only when the app is linked with + the owner of the template (either a user or team). + + + User-owned templates are accessed via the user-auth + file_properties/templates/*_for_user endpoints, while team-owned templates + are accessed via the team-auth file_properties/templates/*_for_team + endpoints. Properties associated with either type of template can be + accessed via the user-auth properties/* endpoints. + + + Finally, properties can be accessed from a number of endpoints that return + metadata, including `files/get_metadata`, and `files/list_folder`. + Properties can also be added during upload, using `files/upload`. + - name: file_requests + description: > + This namespace contains endpoints and data types for file request + operations. + - name: files + description: > + This namespace contains endpoints and data types for basic file + operations. + - name: sharing + description: > + This namespace contains endpoints and data types for creating and managing + shared links and shared folders. + - name: team + - name: team > devices + - name: team > groups + - name: team > legal_holds + - name: team > linked_apps + - name: team > member_space_limits + - name: team > members + - name: team > namespaces + - name: team > reports + - name: team > team_folder + - name: team_log + - name: users + description: | + This namespace contains endpoints and data types for user management. +paths: + /2/account/set_profile_photo: + post: + tags: + - account + summary: set_profile_photo + description: >- + [set_profile_photo](https://www.dropbox.com/developers/documentation/http/documentation#account-set_profile_photo) + + + scope: `account_info.write` + + + Sets a user's profile photo. + requestBody: + content: + application/json: + schema: + type: object + example: + photo: + .tag: base64_data + base64_data: >- + SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /2/auth/token/from_oauth1: + post: + tags: + - auth + summary: token/from_oauth1 + description: >- + [token/from_oauth1](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-from_oauth1) + + + scope: `None` + + + Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access + token. + requestBody: + content: + application/json: + schema: + type: object + example: + oauth1_token: qievr8hamyg6ndck + oauth1_token_secret: qomoftv0472git7 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + oauth2_token: >- + 9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn + /2/auth/token/revoke: + post: + tags: + - auth + summary: token/revoke + description: >- + [token/revoke](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke) + + + scope: `None` + + + Disables the access token used to authenticate the call. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/check/app: + post: + tags: + - check + summary: app + description: >- + [app](https://www.dropbox.com/developers/documentation/http/documentation#check-app) + + + scope: `None` + + + This endpoint performs App Authentication, validating the supplied app + key and secret, and returns the supplied string, to allow you to test + your code and connection to the Dropbox API. It has no other effect. If + you receive an HTTP 200 response with the supplied query, it indicates + at least part of the Dropbox API infrastructure is working and that the + app key and secret valid. + requestBody: + content: + application/json: + schema: + type: object + example: + query: foo + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + result: foo + /2/check/user: + post: + tags: + - check + summary: user + description: >- + [user](https://www.dropbox.com/developers/documentation/http/documentation#check-user) + + + scope: `None` + + + This endpoint performs User Authentication, validating the supplied + access token, and returns the supplied string, to allow you to test your + code and connection to the Dropbox API. It has no other effect. If you + receive an HTTP 200 response with the supplied query, it indicates at + least part of the Dropbox API infrastructure is working and that the + access token is valid. + requestBody: + content: + application/json: + schema: + type: object + example: + query: foo + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + result: foo + /2/contacts/delete_manual_contacts: + post: + tags: + - contacts + summary: delete_manual_contacts + description: >- + [delete_manual_contacts](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts) + + + scope: `contacts.write` + + + Removes all manually added contacts. You'll still keep contacts who are + on your team or who you imported. New contacts will be added when you + share. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/contacts/delete_manual_contacts_batch: + post: + tags: + - contacts + summary: delete_manual_contacts_batch + description: >- + [delete_manual_contacts_batch](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts_batch) + + + scope: `contacts.write` + + + Removes manually added contacts from the given list. + requestBody: + content: + application/json: + schema: + type: object + example: + email_addresses: + - contactemailaddress1@domain.com + - contactemailaddress2@domain.com + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/file_properties/properties/add: + post: + tags: + - file_properties + summary: properties/add + description: >- + [properties/add](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add) + + + scope: `files.metadata.write` + + + Add property groups to a Dropbox file. See `templates/add_for_user` or + `templates/add_for_team` to create new templates. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /my_awesome/word.docx + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/file_properties/properties/overwrite: + post: + tags: + - file_properties + summary: properties/overwrite + description: >- + [properties/overwrite](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite) + + + scope: `files.metadata.write` + + + Overwrite property groups associated with a file. This endpoint should + be used instead of `properties/update` when property groups are being + updated via a "snapshot" instead of via a "delta". In other words, this + endpoint will delete all omitted fields from a property group, whereas + `properties/update` will only delete fields that are explicitly marked + for deletion. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /my_awesome/word.docx + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/file_properties/properties/remove: + post: + tags: + - file_properties + summary: properties/remove + description: >- + [properties/remove](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove) + + + scope: `files.metadata.write` + + + Permanently removes the specified property group from the file. To + remove specific property field key value pairs, see `properties/update`. + To update a template, see `templates/update_for_user` or + `templates/update_for_team`. To remove a template, see + `templates/remove_for_user` or `templates/remove_for_team`. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /my_awesome/word.docx + property_template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/file_properties/properties/search: + post: + tags: + - file_properties + summary: properties/search + description: >- + [properties/search](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search) + + + scope: `files.metadata.read` + + + Search across property templates for particular property field values. + requestBody: + content: + application/json: + schema: + type: object + example: + queries: + - query: Compliance Bot - Beta + mode: + .tag: field_name + field_name: Security + logical_operator: or_operator + template_filter: filter_none + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Authorization + in: header + schema: + type: string + example: ' Bearer IU571Pc9cGAAAAAAAAAAAQh57r-VTd7qBjZBUsVHLR6NRVTcd0FOThotVQmF9q9F' + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + matches: + - id: id:a4ayc_80_OEAAAAAAAAAXz + path: /my_awesome/word.docx + is_deleted: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + /2/file_properties/properties/search/continue: + post: + tags: + - file_properties + summary: properties/search/continue + description: >- + [properties/search/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue) + + + scope: `files.metadata.read` + + + Once a cursor has been retrieved from `properties/search`, use this to + paginate through all search results. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + matches: + - id: id:a4ayc_80_OEAAAAAAAAAXz + path: /my_awesome/word.docx + is_deleted: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + /2/file_properties/properties/update: + post: + tags: + - file_properties + summary: properties/update + description: >- + [properties/update](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update) + + + scope: `files.metadata.write` + + + Add, update or remove properties associated with the supplied file and + templates. This endpoint should be used instead of + `properties/overwrite` when property groups are being updated via a + "delta" instead of via a "snapshot" . In other words, this endpoint will + not delete any omitted fields from a property group, whereas + `properties/overwrite` will delete any fields that are omitted from a + property group. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /my_awesome/word.docx + update_property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + add_or_update_fields: + - name: Security Policy + value: Confidential + remove_fields: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/file_properties/templates/add_for_team: + post: + tags: + - file_properties + summary: templates/add_for_team + description: >- + [templates/add_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-add_for_team) + + + scope: `files.team_metadata.write` + + + Add a template associated with a team. See `properties/add` to add + properties to a file or folder. + + Note: this endpoint will create team-owned templates. + requestBody: + content: + application/json: + schema: + type: object + example: + name: Security + description: >- + These properties describe how confidential this file or folder + is. + fields: + - name: Security Policy + description: >- + This is the security policy of the file or folder + described. + + Policies can be Confidential, Public or Internal. + type: string + security: + - bearerAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /2/file_properties/templates/add_for_user: + post: + tags: + - file_properties + summary: templates/add_for_user + description: >- + [templates/add_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user) + + + scope: `files.metadata.write` + + + Add a template associated with a user. See `properties/add` to add + properties to a file. This endpoint can't be called on a team member or + admin's behalf. + requestBody: + content: + application/json: + schema: + type: object + example: + name: Security + description: >- + These properties describe how confidential this file or folder + is. + fields: + - name: Security Policy + description: >- + This is the security policy of the file or folder + described. + + Policies can be Confidential, Public or Internal. + type: string + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /2/file_properties/templates/get_for_team: + post: + tags: + - file_properties + summary: templates/get_for_team + description: >- + [templates/get_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-get_for_team) + + + scope: `files.team_metadata.write` + + + Get the schema for a specified template. + requestBody: + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Security + description: >- + These properties describe how confidential this file or folder + is. + fields: + - name: Security Policy + description: >- + This is the security policy of the file or folder + described. + + Policies can be Confidential, Public or Internal. + type: + .tag: string + /2/file_properties/templates/get_for_user: + post: + tags: + - file_properties + summary: templates/get_for_user + description: >- + [templates/get_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user) + + + scope: `files.metadata.read` + + + Get the schema for a specified template. This endpoint can't be called + on a team member or admin's behalf. + requestBody: + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Security + description: >- + These properties describe how confidential this file or folder + is. + fields: + - name: Security Policy + description: >- + This is the security policy of the file or folder + described. + + Policies can be Confidential, Public or Internal. + type: + .tag: string + /2/file_properties/templates/list_for_team: + post: + tags: + - file_properties + summary: templates/list_for_team + description: >- + [templates/list_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-list_for_team) + + + scope: `files.team_metadata.write` + + + Get the template identifiers for a team. To get the schema of each + template use `templates/get_for_team`. + requestBody: + content: {} + security: + - bearerAuth: [] + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + /2/file_properties/templates/list_for_user: + post: + tags: + - file_properties + summary: templates/list_for_user + description: >- + [templates/list_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user) + + + scope: `files.metadata.read` + + + Get the template identifiers for a team. To get the schema of each + template use `templates/get_for_user`. This endpoint can't be called on + a team member or admin's behalf. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + /2/file_properties/templates/remove_for_team: + post: + tags: + - file_properties + summary: templates/remove_for_team + description: >- + [templates/remove_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-remove_for_team) + + + scope: `files.team_metadata.write` + + + Permanently removes the specified template created from + `templates/add_for_user`. All properties associated with the template + will also be removed. This action cannot be undone. + requestBody: + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/file_properties/templates/remove_for_user: + post: + tags: + - file_properties + summary: templates/remove_for_user + description: >- + [templates/remove_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user) + + + scope: `files.metadata.write` + + + Permanently removes the specified template created from + `templates/add_for_user`. All properties associated with the template + will also be removed. This action cannot be undone. + requestBody: + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/file_properties/templates/update_for_team: + post: + tags: + - file_properties + summary: templates/update_for_team + description: >- + [templates/update_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-update_for_team) + + + scope: `files.team_metadata.write` + + + Update a template associated with a team. This route can update the + template name, the template description and add optional properties to + templates. + requestBody: + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + name: New Security Template Name + description: >- + These properties will describe how confidential this file or + folder is. + add_fields: + - name: Security Policy + description: >- + This is the security policy of the file or folder + described. + + Policies can be Confidential, Public or Internal. + type: string + security: + - bearerAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /2/file_properties/templates/update_for_user: + post: + tags: + - file_properties + summary: templates/update_for_user + description: >- + [templates/update_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user) + + + scope: `files.metadata.write` + + + Update a template associated with a user. This route can update the + template name, the template description and add optional properties to + templates. This endpoint can't be called on a team member or admin's + behalf. + requestBody: + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + name: New Security Template Name + description: >- + These properties will describe how confidential this file or + folder is. + add_fields: + - name: Security Policy + description: >- + This is the security policy of the file or folder + described. + + Policies can be Confidential, Public or Internal. + type: string + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /2/file_requests/count: + post: + tags: + - file_requests + summary: count + description: >- + [count](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-count) + + + scope: `file_requests.read` + + + Returns the total number of file requests owned by this user. Includes + both open and closed file requests. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + file_request_count: 15 + /2/file_requests/create: + post: + tags: + - file_requests + summary: create + description: >- + [create](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create) + + + scope: `file_requests.write` + + + Creates a file request for this user. + requestBody: + content: + application/json: + schema: + type: object + example: + title: Homework submission + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: seven_days + open: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: oaCAVmEyrqYnkZX9955Y + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + title: Homework submission + created: '2015-10-05T17:00:00Z' + is_open: true + file_count: 3 + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: + .tag: seven_days + /2/file_requests/delete: + post: + tags: + - file_requests + summary: delete + description: >- + [delete](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete) + + + scope: `file_requests.write` + + + Delete a batch of closed file requests. + requestBody: + content: + application/json: + schema: + type: object + example: + ids: + - oaCAVmEyrqYnkZX9955Y + - BaZmehYoXMPtaRmfTbSG + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + file_requests: + - id: oaCAVmEyrqYnkZX9955Y + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + title: Homework submission + created: '2015-10-05T17:00:00Z' + is_open: true + file_count: 3 + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: + .tag: seven_days + - id: BAJ7IrRGicQKGToykQdB + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + title: Photo contest submission + created: '2015-11-02T04:00:00Z' + is_open: true + file_count: 105 + destination: /Photo contest entries + deadline: + deadline: '2020-10-12T17:00:00Z' + - id: rxwMPvK3ATTa0VxOJu5T + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + title: Wedding photo submission + created: '2015-12-15T13:02:00Z' + is_open: true + file_count: 37 + destination: /Wedding photos + /2/file_requests/delete_all_closed: + post: + tags: + - file_requests + summary: delete_all_closed + description: >- + [delete_all_closed](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete_all_closed) + + + scope: `file_requests.write` + + + Delete all closed file requests owned by this user. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + file_requests: + - id: oaCAVmEyrqYnkZX9955Y + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + title: Homework submission + created: '2015-10-05T17:00:00Z' + is_open: true + file_count: 3 + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: + .tag: seven_days + - id: BAJ7IrRGicQKGToykQdB + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + title: Photo contest submission + created: '2015-11-02T04:00:00Z' + is_open: true + file_count: 105 + destination: /Photo contest entries + deadline: + deadline: '2020-10-12T17:00:00Z' + - id: rxwMPvK3ATTa0VxOJu5T + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + title: Wedding photo submission + created: '2015-12-15T13:02:00Z' + is_open: true + file_count: 37 + destination: /Wedding photos + /2/file_requests/get: + post: + tags: + - file_requests + summary: get + description: >- + [get](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get) + + + scope: `file_requests.read` + + + Returns the specified file request. + requestBody: + content: + application/json: + schema: + type: object + example: + id: oaCAVmEyrqYnkZX9955Y + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: oaCAVmEyrqYnkZX9955Y + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + title: Homework submission + created: '2015-10-05T17:00:00Z' + is_open: true + file_count: 3 + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: + .tag: seven_days + /2/file_requests/list_v2: + post: + tags: + - file_requests + summary: list + description: >- + [list](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list) + + + scope: `file_requests.read` + + + Returns a list of file requests owned by this user. For apps with the + app folder permission, this will only return file requests with + destinations in the app folder. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 1000 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + file_requests: + - id: oaCAVmEyrqYnkZX9955Y + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + title: Homework submission + created: '2015-10-05T17:00:00Z' + is_open: true + file_count: 3 + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: + .tag: seven_days + - id: BAJ7IrRGicQKGToykQdB + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + title: Photo contest submission + created: '2015-11-02T04:00:00Z' + is_open: true + file_count: 105 + destination: /Photo contest entries + deadline: + deadline: '2020-10-12T17:00:00Z' + - id: rxwMPvK3ATTa0VxOJu5T + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + title: Wedding photo submission + created: '2015-12-15T13:02:00Z' + is_open: true + file_count: 37 + destination: /Wedding photos + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + /2/file_requests/list/continue: + post: + tags: + - file_requests + summary: list/continue + description: >- + [list/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list-continue) + + + scope: `file_requests.read` + + + Once a cursor has been retrieved from `list:2`, use this to paginate + through all file requests. The cursor must come from a previous call to + `list:2` or `list/continue`. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + file_requests: + - id: oaCAVmEyrqYnkZX9955Y + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + title: Homework submission + created: '2015-10-05T17:00:00Z' + is_open: true + file_count: 3 + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: + .tag: seven_days + - id: BAJ7IrRGicQKGToykQdB + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + title: Photo contest submission + created: '2015-11-02T04:00:00Z' + is_open: true + file_count: 105 + destination: /Photo contest entries + deadline: + deadline: '2020-10-12T17:00:00Z' + - id: rxwMPvK3ATTa0VxOJu5T + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + title: Wedding photo submission + created: '2015-12-15T13:02:00Z' + is_open: true + file_count: 37 + destination: /Wedding photos + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + /2/file_requests/update: + post: + tags: + - file_requests + summary: update + description: >- + [update](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-update) + + + scope: `file_requests.write` + + + Update a file request. + requestBody: + content: + application/json: + schema: + type: object + example: + id: oaCAVmEyrqYnkZX9955Y + title: Homework submission + destination: /File Requests/Homework + deadline: + .tag: update + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: seven_days + open: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: oaCAVmEyrqYnkZX9955Y + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + title: Homework submission + created: '2015-10-05T17:00:00Z' + is_open: true + file_count: 3 + destination: /File Requests/Homework + deadline: + deadline: '2020-10-12T17:00:00Z' + allow_late_uploads: + .tag: seven_days + /2/files/copy_v2: + post: + tags: + - files + summary: copy + description: >- + [copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy) + + + scope: `files.content.write` + + + Copy a file or folder to a different location in the user's Dropbox. + + If the source path is a folder all its contents will be copied. + requestBody: + content: + application/json: + schema: + type: object + example: + from_path: /Homework/math + to_path: /Homework/algebra + allow_shared_folder: false + autorename: false + allow_ownership_transfer: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/copy_batch_v2: + post: + tags: + - files + summary: copy_batch + description: >- + [copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch) + + + scope: `files.content.write` + + + Copy multiple files or folders to different locations at once in the + user's Dropbox. + + This route will replace `copy_batch:1`. The main difference is this + route will return status for each entry, while `copy_batch:1` raises + failure if any entry fails. + + This route will either finish synchronously, or return a job ID and do + the async copy job in background. Please use `copy_batch/check:2` to + check the job status. + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - from_path: /Homework/math + to_path: /Homework/algebra + autorename: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + success: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/copy_batch/check_v2: + post: + tags: + - files + summary: copy_batch/check + description: >- + [copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check) + + + scope: `files.content.write` + + + Returns the status of an asynchronous job for `copy_batch:2`. It returns + list of results for each entry. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + success: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/copy_reference/get: + post: + tags: + - files + summary: copy_reference/get + description: >- + [copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get) + + + scope: `files.content.write` + + + Get a copy reference to a file or folder. This reference string can be + used to save that file or folder to another user's Dropbox by passing it + to `copy_reference/save`. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /video.mp4 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + copy_reference: z1X6ATl6aWtzOGq0c3g5Ng + expires: '2045-05-12T15:50:38Z' + /2/files/copy_reference/save: + post: + tags: + - files + summary: copy_reference/save + description: >- + [copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save) + + + scope: `files.content.write` + + + Save a copy reference returned by `copy_reference/get` to the user's + Dropbox. + requestBody: + content: + application/json: + schema: + type: object + example: + copy_reference: z1X6ATl6aWtzOGq0c3g5Ng + path: /video.mp4 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/create_folder_v2: + post: + tags: + - files + summary: create_folder + description: >- + [create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder) + + + scope: `files.content.write` + + + Create a folder at a given path. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /Homework/math + autorename: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + name: math + id: id:a4ayc_80_OEAAAAAAAAAXz + path_lower: /homework/math + path_display: /Homework/math + sharing_info: + read_only: false + parent_shared_folder_id: '84528192421' + traverse_only: false + no_access: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + /2/files/create_folder_batch: + post: + tags: + - files + summary: create_folder_batch + description: >- + [create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch) + + + scope: `files.content.write` + + + Create multiple folders at once. + + This route is asynchronous for large batches, which returns a job ID + immediately and runs the create folder batch asynchronously. Otherwise, + creates the folders and returns the result synchronously for smaller + inputs. You can force asynchronous behaviour by using the + `CreateFolderBatchArg.force_async` flag. Use + `create_folder_batch/check` to check the job status. + requestBody: + content: + application/json: + schema: + type: object + example: + paths: + - /Homework/math + autorename: false + force_async: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + metadata: + name: math + id: id:a4ayc_80_OEAAAAAAAAAXz + path_lower: /homework/math + path_display: /Homework/math + sharing_info: + read_only: false + parent_shared_folder_id: '84528192421' + traverse_only: false + no_access: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + /2/files/create_folder_batch/check: + post: + tags: + - files + summary: create_folder_batch/check + description: >- + [create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check) + + + scope: `files.content.write` + + + Returns the status of an asynchronous job for `create_folder_batch`. If + success, it returns list of result for each entry. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + metadata: + name: math + id: id:a4ayc_80_OEAAAAAAAAAXz + path_lower: /homework/math + path_display: /Homework/math + sharing_info: + read_only: false + parent_shared_folder_id: '84528192421' + traverse_only: false + no_access: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + /2/files/delete_v2: + post: + tags: + - files + summary: delete + description: >- + [delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete) + + + scope: `files.content.write` + + + Delete the file or folder at a given path. + + If the path is a folder, all its contents will be deleted too. + + A successful response indicates that the file or folder was deleted. The + returned metadata will be the corresponding `FileMetadata` or + `FolderMetadata` for the item at time of deletion, and not a + `DeletedMetadata` object. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /Homework/math/Prime_Numbers.txt + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/delete_batch: + post: + tags: + - files + summary: delete_batch + description: >- + [delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch) + + + scope: `files.content.write` + + + Delete multiple files/folders at once. + + This route is asynchronous, which returns a job ID immediately and runs + the delete batch asynchronously. Use `delete_batch/check` to check the + job status. + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - path: /Homework/math/Prime_Numbers.txt + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/delete_batch/check: + post: + tags: + - files + summary: delete_batch/check + description: >- + [delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check) + + + scope: `files.content.write` + + + Returns the status of an asynchronous job for `delete_batch`. If + success, it returns list of result for each entry. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/download: + post: + tags: + - files + summary: download + description: >- + [download](https://www.dropbox.com/developers/documentation/http/documentation#files-download) + + + scope: `files.content.read` + + + Download a file from a user's Dropbox. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "path": "/Homework/math/Prime_Numbers.txt" + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/download_zip: + post: + tags: + - files + summary: download_zip + description: >- + [download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip) + + + scope: `files.content.read` + + + Download a folder from the user's Dropbox, as a zip file. The folder + must be less than 20 GB in size and have fewer than 10,000 total files. + The input cannot be a single file. Any single file must be less than 4GB + in size. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "path": "/Homework/math" + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + name: math + id: id:a4ayc_80_OEAAAAAAAAAXz + path_lower: /homework/math + path_display: /Homework/math + sharing_info: + read_only: false + parent_shared_folder_id: '84528192421' + traverse_only: false + no_access: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + /2/files/export: + post: + tags: + - files + summary: export + description: >- + [export](https://www.dropbox.com/developers/documentation/http/documentation#files-export) + + + scope: `files.content.read` + + + Export a file from a user's Dropbox. This route only supports exporting + files that cannot be downloaded directly and whose + `ExportResult.file_metadata` has `ExportInfo.export_as` populated. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "path": "/Homework/math/Prime_Numbers.gsheet" + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + export_metadata: + name: Prime_Numbers.xlsx + size: 7189 + export_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_metadata: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/get_file_lock_batch: + post: + tags: + - files + summary: get_file_lock_batch + description: >- + [get_file_lock_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_file_lock_batch) + + + scope: `files.content.read` + + + Return the lock metadata for the given list of paths. + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - path: /John Doe/sample/test.pdf + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - .tag: success + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + lock: + content: + .tag: single_user + created: '2015-05-12T15:50:38Z' + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + /2/files/get_metadata: + post: + tags: + - files + summary: get_metadata + description: >- + [get_metadata](https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata) + + + scope: `files.metadata.read` + + + Returns the metadata for a file or folder. + + Note: Metadata for the root folder is unsupported. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /Homework/math + include_media_info: false + include_deleted: false + include_has_explicit_shared_members: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/get_preview: + post: + tags: + - files + summary: get_preview + description: >- + [get_preview](https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview) + + + scope: `files.content.read` + + + Get a preview for a file. + + Currently, PDF previews are generated for files with the following + extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, + .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. + + HTML previews are generated for files with the following extensions: + .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. + + Other formats will return an unsupported extension error. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "path": "/word.docx" + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/get_temporary_link: + post: + tags: + - files + summary: get_temporary_link + description: >- + [get_temporary_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link) + + + scope: `files.content.read` + + + Get a temporary link to stream content of a file. This link will expire + in four hours and afterwards you will get 410 Gone. This URL should not + be used to display content directly in the browser. The Content-Type of + the link is determined automatically by the file's mime type. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /video.mp4 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + link: >- + https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 + /2/files/get_temporary_upload_link: + post: + tags: + - files + summary: get_temporary_upload_link + description: >- + [get_temporary_upload_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_upload_link) + + + scope: `files.content.write` + + + Get a one-time use temporary upload link to upload a file to a Dropbox + location. + + + This endpoint acts as a delayed `upload`. The returned temporary upload + link may be used to make a POST request with the data to be uploaded. + The upload will then be perfomed with the `CommitInfo` previously + provided to `get_temporary_upload_link` but evaluated only upon + consumption. Hence, errors stemming from invalid `CommitInfo` with + respect to the state of the user's Dropbox will only be communicated at + consumption time. Additionally, these errors are surfaced as generic + HTTP 409 Conflict responses, potentially hiding issue details. The + maximum temporary upload link duration is 4 hours. Upon consumption or + expiration, a new link will have to be generated. Multiple links may + exist for a specific upload path at any given time. + + + The POST request on the temporary upload link must have its Content-Type + set to "application/octet-stream". + + + Example temporary upload link consumption request: + + + curl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + + --header "Content-Type: application/octet-stream" + + --data-binary @local_file.txt + + + A successful temporary upload link consumption request returns the + content hash of the uploaded data in JSON format. + + + Example succesful temporary upload link consumption response: + + {"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"} + + + An unsuccessful temporary upload link consumption request returns any of + the following status codes: + + + HTTP 400 Bad Request: Content-Type is not one of + application/octet-stream and text/plain or request is invalid. + + HTTP 409 Conflict: The temporary upload link does not exist or is + currently unavailable, the upload failed, or another error happened. + + HTTP 410 Gone: The temporary upload link is expired or consumed. + + + Example unsuccessful temporary upload link consumption response: + + Temporary upload link has been recently consumed. + requestBody: + content: + application/json: + schema: + type: object + example: + commit_info: + path: /Homework/math/Matrices.txt + mode: add + autorename: true + mute: false + strict_conflict: false + duration: 3600 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + link: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + /2/files/get_thumbnail_v2: + post: + tags: + - files + summary: get_thumbnail + description: >- + [get_thumbnail](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail) + + + scope: `files.content.read` + + + Get a thumbnail for a file. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "resource": { + ".tag": "path", + "path": "/a.docx" + }, + "format": "jpeg", + "size": "w64h64", + "mode": "strict" + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + file_metadata: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/get_thumbnail_batch: + post: + tags: + - files + summary: get_thumbnail_batch + description: >- + [get_thumbnail_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch) + + + scope: `files.content.read` + + + Get thumbnails for a list of images. We allow up to 25 thumbnails in a + single batch. + + This method currently supports files with the following file extensions: + jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB + in size won't be converted to a thumbnail. + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - path: /image.jpg + format: jpeg + size: w64h64 + mode: strict + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - .tag: success + metadata: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= + /2/files/list_folder: + post: + tags: + - files + summary: list_folder + description: >- + [list_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder) + + + scope: `files.metadata.read` + + + Starts returning the contents of a folder. If the result's + `ListFolderResult.has_more` field is `true`, call `list_folder/continue` + with the returned `ListFolderResult.cursor` to retrieve more entries. + + If you're using `ListFolderArg.recursive` set to `true` to keep a local + cache of the contents of a Dropbox account, iterate through each entry + in order and process them as follows to keep your local state in sync: + + For each `FileMetadata`, store the new entry at the given path in your + local state. If the required parent folders don't exist yet, create + them. If there's already something else at the given path, replace it + and remove all its children. + + For each `FolderMetadata`, store the new entry at the given path in your + local state. If the required parent folders don't exist yet, create + them. If there's already something else at the given path, replace it + but leave the children as they are. Check the new entry's + `FolderSharingInfo.read_only` and set all its children's read-only + statuses to match. + + For each `DeletedMetadata`, if your local state has something at the + given path, remove it and all its children. If there's nothing at the + given path, ignore this entry. + + Note: `auth.RateLimitError` may be returned if multiple `list_folder` or + `list_folder/continue` calls with same parameters are made + simultaneously by same API app for same user. If your app implements + retry logic, please hold off the retry until the previous request + finishes. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /Homework/math + recursive: false + include_media_info: false + include_deleted: false + include_has_explicit_shared_members: false + include_mounted_folders: true + include_non_downloadable_files: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + - .tag: folder + name: math + id: id:a4ayc_80_OEAAAAAAAAAXz + path_lower: /homework/math + path_display: /Homework/math + sharing_info: + read_only: false + parent_shared_folder_id: '84528192421' + traverse_only: false + no_access: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/files/list_folder/continue: + post: + tags: + - files + summary: list_folder/continue + description: >- + [list_folder/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue) + + + scope: `files.metadata.read` + + + Once a cursor has been retrieved from `list_folder`, use this to + paginate through all files and retrieve updates to the folder, following + the same rules as documented for `list_folder`. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + - .tag: folder + name: math + id: id:a4ayc_80_OEAAAAAAAAAXz + path_lower: /homework/math + path_display: /Homework/math + sharing_info: + read_only: false + parent_shared_folder_id: '84528192421' + traverse_only: false + no_access: false + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/files/list_folder/get_latest_cursor: + post: + tags: + - files + summary: list_folder/get_latest_cursor + description: >- + [list_folder/get_latest_cursor](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-get_latest_cursor) + + + scope: `files.metadata.read` + + + A way to quickly get a cursor for the folder's state. Unlike + `list_folder`, `list_folder/get_latest_cursor` doesn't return any + entries. This endpoint is for app which only needs to know about new + files and modifications and doesn't need to know about files that + already exist in Dropbox. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /Homework/math + recursive: false + include_media_info: false + include_deleted: false + include_has_explicit_shared_members: false + include_mounted_folders: true + include_non_downloadable_files: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/files/list_folder/longpoll: + post: + tags: + - files + summary: list_folder/longpoll + description: >- + [list_folder/longpoll](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-longpoll) + + + scope: `files.metadata.read` + + + A longpoll endpoint to wait for changes on an account. In conjunction + with `list_folder/continue`, this call gives you a low-latency way to + monitor an account for file changes. The connection will block until + there are changes available or a timeout occurs. This endpoint is useful + mostly for client-side apps. If you're looking for server-side + notifications, check out our [webhooks + documentation](https://www.dropbox.com/developers/reference/webhooks). + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + timeout: 30 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + changes: true + /2/files/list_revisions: + post: + tags: + - files + summary: list_revisions + description: >- + [list_revisions](https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions) + + + scope: `files.metadata.read` + + + Returns revisions for files based on a file path or a file id. The file + path or file id is identified from the latest file entry at the given + file path or id. This end point allows your app to query either by file + path or file id by setting the mode parameter appropriately. + + In the `ListRevisionsMode.path` (default) mode, all revisions at the + same file path as the latest file entry are returned. If revisions with + the same file id are desired, then mode must be set to + `ListRevisionsMode.id`. The `ListRevisionsMode.id` mode is useful to + retrieve revisions for a given file across moves or renames. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /root/word.docx + mode: path + limit: 10 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + is_deleted: false + entries: + - name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/lock_file_batch: + post: + tags: + - files + summary: lock_file_batch + description: >- + [lock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-lock_file_batch) + + + scope: `files.content.write` + + + Lock the files at the given paths. A locked file will be writable only + by the lock holder. A successful response indicates that the file has + been locked. Returns a list of the locked file paths and their metadata + after this operation. + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - path: /John Doe/sample/test.pdf + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - .tag: success + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + lock: + content: + .tag: single_user + created: '2015-05-12T15:50:38Z' + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + /2/files/move_v2: + post: + tags: + - files + summary: move + description: >- + [move](https://www.dropbox.com/developers/documentation/http/documentation#files-move) + + + scope: `files.content.write` + + + Move a file or folder to a different location in the user's Dropbox. + + If the source path is a folder all its contents will be moved. + + Note that we do not currently support case-only renaming. + requestBody: + content: + application/json: + schema: + type: object + example: + from_path: /Homework/math + to_path: /Homework/algebra + allow_shared_folder: false + autorename: false + allow_ownership_transfer: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/move_batch_v2: + post: + tags: + - files + summary: move_batch + description: >- + [move_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch) + + + scope: `files.content.write` + + + Move multiple files or folders to different locations at once in the + user's Dropbox. Note that we do not currently support case-only + renaming. + + This route will replace `move_batch:1`. The main difference is this + route will return status for each entry, while `move_batch:1` raises + failure if any entry fails. + + This route will either finish synchronously, or return a job ID and do + the async move job in background. Please use `move_batch/check:2` to + check the job status. + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - from_path: /Homework/math + to_path: /Homework/algebra + autorename: false + allow_ownership_transfer: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + success: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/move_batch/check_v2: + post: + tags: + - files + summary: move_batch/check + description: >- + [move_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch-check) + + + scope: `files.content.write` + + + Returns the status of an asynchronous job for `move_batch:2`. It returns + list of results for each entry. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + success: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/permanently_delete: + post: + tags: + - files + summary: permanently_delete + description: >- + [permanently_delete](https://www.dropbox.com/developers/documentation/http/documentation#files-permanently_delete) + + + scope: `files.permanent_delete` + + + Permanently delete the file or folder at a given path (see + https://www.dropbox.com/en/help/40). + + Note: This endpoint is only available for Dropbox Business apps. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /Homework/math/Prime_Numbers.txt + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/files/restore: + post: + tags: + - files + summary: restore + description: >- + [restore](https://www.dropbox.com/developers/documentation/http/documentation#files-restore) + + + scope: `files.content.write` + + + Restore a specific revision of a file to the given path. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /root/word.docx + rev: a1c10ce0dd78 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/save_url: + post: + tags: + - files + summary: save_url + description: >- + [save_url](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url) + + + scope: `files.content.write` + + + Save the data from a specified URL into a file in user's Dropbox. + + Note that the transfer from the URL must complete within 5 minutes, or + the operation will time out and the job will fail. + + If the given path already exists, the file will be renamed to avoid the + conflict (e.g. myfile (1).txt). + requestBody: + content: + application/json: + schema: + type: object + example: + path: /a.txt + url: http://example.com/a.txt + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/save_url/check_job_status: + post: + tags: + - files + summary: save_url/check_job_status + description: >- + [save_url/check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url-check_job_status) + + + scope: `files.content.write` + + + Check the status of a `save_url` job. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: in_progress + /2/files/search_v2: + post: + tags: + - files + summary: search + description: >- + [search](https://www.dropbox.com/developers/documentation/http/documentation#files-search) + + + scope: `files.metadata.read` + + + Searches for files and folders. + + Note: `search:2` along with `search/continue:2` can only be used to + retrieve a maximum of 10,000 matches. + + Recent changes may not immediately be reflected in search results due to + a short delay in indexing. Duplicate results may be returned across + pages. Some results may not be returned. + requestBody: + content: + application/json: + schema: + type: object + example: + query: cat + include_highlights: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + matches: + - metadata: + .tag: metadata + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + has_more: false + /2/files/search/continue_v2: + post: + tags: + - files + summary: search/continue + description: >- + [search/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-search-continue) + + + scope: `files.metadata.read` + + + Fetches the next page of search results returned from `search:2`. + + Note: `search:2` along with `search/continue:2` can only be used to + retrieve a maximum of 10,000 matches. + + Recent changes may not immediately be reflected in search results due to + a short delay in indexing. Duplicate results may be returned across + pages. Some results may not be returned. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + matches: + - metadata: + .tag: metadata + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + has_more: false + /2/files/unlock_file_batch: + post: + tags: + - files + summary: unlock_file_batch + description: >- + [unlock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-unlock_file_batch) + + + scope: `files.content.write` + + + Unlock the files at the given paths. A locked file can only be unlocked + by the lock holder or, if a business account, a team admin. A successful + response indicates that the file has been unlocked. Returns a list of + the unlocked file paths and their metadata after this operation. + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - path: /John Doe/sample/test.pdf + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - .tag: success + metadata: + .tag: file + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + lock: + content: + .tag: single_user + created: '2015-05-12T15:50:38Z' + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + /2/files/upload: + post: + tags: + - files + summary: upload + description: >- + [upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload) + + + scope: `files.content.write` + + + Create a new file with the contents provided in the request. + + Do not use this to upload a file larger than 150 MB. Instead, create an + upload session with `upload_session/start`. + + Calls to this endpoint will count as data transport calls for any + Dropbox Business teams with a limit on the number of data transport + calls allowed per month. For more information, see the [Data transport + limit + page](https://www.dropbox.com/developers/reference/data-transport-limit). + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "path": "/Homework/math/Matrices.txt", + "mode": "add", + "autorename": true, + "mute": false, + "strict_conflict": false + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/upload_session/append_v2: + post: + tags: + - files + summary: upload_session/append + description: >- + [upload_session/append](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append) + + + scope: `files.content.write` + + + Append more data to an upload session. + + When the parameter close is set, this call will close the session. + + A single request should not upload more than 150 MB. The maximum size of + a file one can upload to an upload session is 350 GB. + + Calls to this endpoint will count as data transport calls for any + Dropbox Business teams with a limit on the number of data transport + calls allowed per month. For more information, see the [Data transport + limit + page](https://www.dropbox.com/developers/reference/data-transport-limit). + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "cursor": { + "session_id": "1234faaf0678bcde", + "offset": 0 + }, + "close": false + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/files/upload_session/finish: + post: + tags: + - files + summary: upload_session/finish + description: >- + [upload_session/finish](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish) + + + scope: `files.content.write` + + + Finish an upload session and save the uploaded data to the given file + path. + + A single request should not upload more than 150 MB. The maximum size of + a file one can upload to an upload session is 350 GB. + + Calls to this endpoint will count as data transport calls for any + Dropbox Business teams with a limit on the number of data transport + calls allowed per month. For more information, see the [Data transport + limit + page](https://www.dropbox.com/developers/reference/data-transport-limit). + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "cursor": { + "session_id": "1234faaf0678bcde", + "offset": 0 + }, + "commit": { + "path": "/Homework/math/Matrices.txt", + "mode": "add", + "autorename": true, + "mute": false, + "strict_conflict": false + } + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/upload_session/finish_batch: + post: + tags: + - files + summary: upload_session/finish_batch + description: >- + [upload_session/finish_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch) + + + scope: `files.content.write` + + + This route helps you commit many files at once into a user's Dropbox. + Use `upload_session/start` and `upload_session/append:2` to upload file + contents. We recommend uploading many files in parallel to increase + throughput. Once the file contents have been uploaded, rather than + calling `upload_session/finish`, use this route to finish all your + upload sessions in a single request. + + `UploadSessionStartArg.close` or `UploadSessionAppendArg.close` needs to + be true for the last `upload_session/start` or `upload_session/append:2` + call. The maximum size of a file one can upload to an upload session is + 350 GB. + + This route will return a job_id immediately and do the async commit job + in background. Use `upload_session/finish_batch/check` to check the job + status. + + For the same account, this route should be executed serially. That means + you should not start the next job before current job finishes. We allow + up to 1000 entries in a single request. + + Calls to this endpoint will count as data transport calls for any + Dropbox Business teams with a limit on the number of data transport + calls allowed per month. For more information, see the [Data transport + limit + page](https://www.dropbox.com/developers/reference/data-transport-limit). + requestBody: + content: + application/json: + schema: + type: object + example: + entries: + - cursor: + session_id: 1234faaf0678bcde + offset: 0 + commit: + path: /Homework/math/Matrices.txt + mode: add + autorename: true + mute: false + strict_conflict: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/upload_session/finish_batch/check: + post: + tags: + - files + summary: upload_session/finish_batch/check + description: >- + [upload_session/finish_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch-check) + + + scope: `files.content.write` + + + Returns the status of an asynchronous job for + `upload_session/finish_batch`. If success, it returns list of result for + each entry. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + entries: + - .tag: success + name: Prime_Numbers.txt + id: id:a4ayc_80_OEAAAAAAAAAXw + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + path_lower: /homework/math/prime_numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + sharing_info: + read_only: true + parent_shared_folder_id: '84528192421' + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + is_downloadable: true + property_groups: + - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + fields: + - name: Security Policy + value: Confidential + has_explicit_shared_members: false + content_hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + is_lockholder: true + lockholder_name: Imaginary User + created: '2015-05-12T15:50:38Z' + /2/files/upload_session/start: + post: + tags: + - files + summary: upload_session/start + description: >- + [upload_session/start](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start) + + + scope: `files.content.write` + + + Upload sessions allow you to upload a single file in one or more + requests, for example where the size of the file is greater than 150 + MB. This call starts a new upload session with the given data. You can + then use `upload_session/append:2` to add more data and + `upload_session/finish` to save all the data to a file in Dropbox. + + A single request should not upload more than 150 MB. The maximum size of + a file one can upload to an upload session is 350 GB. + + An upload session can be used for a maximum of 48 hours. Attempting to + use an `UploadSessionStartResult.session_id` with + `upload_session/append:2` or `upload_session/finish` more than 48 hours + after its creation will return a `UploadSessionLookupError.not_found`. + + Calls to this endpoint will count as data transport calls for any + Dropbox Business teams with a limit on the number of data transport + calls allowed per month. For more information, see the [Data transport + limit + page](https://www.dropbox.com/developers/reference/data-transport-limit). + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "close": false + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + session_id: 1234faaf0678bcde + /2/sharing/add_file_member: + post: + tags: + - sharing + summary: add_file_member + description: >- + [add_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member) + + + scope: `sharing.write` + + + Adds specified members to a file. + requestBody: + content: + application/json: + schema: + type: object + example: + file: id:3kmLmQFnf1AAAAAAAAAAAw + members: + - .tag: email + email: justin@example.com + custom_message: This is a custom message about ACME.doc + quiet: false + access_level: viewer + add_message_as_comment: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - member: + .tag: email + email: justin@example.com + result: + .tag: success + /2/sharing/add_folder_member: + post: + tags: + - sharing + summary: add_folder_member + description: >- + [add_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member) + + + scope: `sharing.write` + + + Allows an owner or editor (if the ACL update policy allows) of a shared + folder to add another member. + + For the new member to get access to all the functionality for this + folder, you will need to call `mount_folder` on their behalf. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + members: + - member: + .tag: email + email: justin@example.com + access_level: editor + - member: + .tag: dropbox_id + dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + access_level: viewer + quiet: false + custom_message: Documentation for launch day + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/sharing/check_job_status: + post: + tags: + - sharing + summary: check_job_status + description: >- + [check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status) + + + scope: `sharing.write` + + + Returns the status of an asynchronous job. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: in_progress + /2/sharing/check_remove_member_job_status: + post: + tags: + - sharing + summary: check_remove_member_job_status + description: >- + [check_remove_member_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status) + + + scope: `sharing.write` + + + Returns the status of an asynchronous job for sharing a folder. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/sharing/check_share_job_status: + post: + tags: + - sharing + summary: check_share_job_status + description: >- + [check_share_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_share_job_status) + + + scope: `sharing.write` + + + Returns the status of an asynchronous job for sharing a folder. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + /2/sharing/get_file_metadata: + post: + tags: + - sharing + summary: get_file_metadata + description: >- + [get_file_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata) + + + scope: `sharing.read` + + + Returns shared file metadata. + requestBody: + content: + application/json: + schema: + type: object + example: + file: id:3kmLmQFnf1AAAAAAAAAAAw + actions: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + access_type: + .tag: viewer + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + time_invited: '2016-01-20T00:00:00Z' + /2/sharing/get_file_metadata/batch: + post: + tags: + - sharing + summary: get_file_metadata/batch + description: >- + [get_file_metadata/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch) + + + scope: `sharing.read` + + + Returns shared file metadata. + requestBody: + content: + application/json: + schema: + type: object + example: + files: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + actions: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + .tag: metadata + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + access_type: + .tag: viewer + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + time_invited: '2016-01-20T00:00:00Z' + /2/sharing/get_folder_metadata: + post: + tags: + - sharing + summary: get_folder_metadata + description: >- + [get_folder_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata) + + + scope: `sharing.read` + + + Returns shared folder metadata by its folder ID. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + actions: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + /2/sharing/get_shared_link_file: + post: + tags: + - sharing + summary: get_shared_link_file + description: >- + [get_shared_link_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file) + + + scope: `sharing.read` + + + Download the shared link's file from a user's Dropbox. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Arg + in: header + schema: + type: string + example: |- + { + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", + "path": "/Prime_Numbers.txt" + } + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: file + url: >- + https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + name: Prime_Numbers.txt + link_permissions: + can_revoke: false + resolved_visibility: + .tag: public + revoke_failure_reason: + .tag: owner_only + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + id: id:a4ayc_80_OEAAAAAAAAAXw + path_lower: /homework/math/prime_numbers.txt + team_member_info: + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + /2/sharing/get_shared_link_metadata: + post: + tags: + - sharing + summary: get_shared_link_metadata + description: >- + [get_shared_link_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_metadata) + + + scope: `sharing.read` + + + Get the shared link's metadata. + requestBody: + content: + application/json: + schema: + type: object + example: + url: >- + https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + path: /Prime_Numbers.txt + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: file + url: >- + https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + name: Prime_Numbers.txt + link_permissions: + can_revoke: false + resolved_visibility: + .tag: public + revoke_failure_reason: + .tag: owner_only + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + id: id:a4ayc_80_OEAAAAAAAAAXw + path_lower: /homework/math/prime_numbers.txt + team_member_info: + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + /2/sharing/list_file_members: + post: + tags: + - sharing + summary: list_file_members + description: >- + [list_file_members](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members) + + + scope: `sharing.read` + + + Use to obtain the members who have been invited to a file, both + inherited and uninherited members. + requestBody: + content: + application/json: + schema: + type: object + example: + file: id:3kmLmQFnf1AAAAAAAAAAAw + include_inherited: true + limit: 100 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + users: + - access_type: + .tag: owner + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: bob@example.com + display_name: Robert Smith + same_team: true + team_member_id: dbmid:abcd1234 + permissions: [] + is_inherited: false + time_last_seen: '2016-01-20T00:00:00Z' + platform_type: + .tag: unknown + groups: + - access_type: + .tag: editor + group: + group_name: Test group + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + group_type: + .tag: user_managed + is_member: false + is_owner: false + same_team: true + member_count: 10 + permissions: [] + is_inherited: false + invitees: + - access_type: + .tag: viewer + invitee: + .tag: email + email: jessica@example.com + permissions: [] + is_inherited: false + /2/sharing/list_file_members/batch: + post: + tags: + - sharing + summary: list_file_members/batch + description: >- + [list_file_members/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch) + + + scope: `sharing.read` + + + Get members of multiple files at once. The arguments to this route are + more limited, and the limit on query result size per file is more + strict. To customize the results more, use the individual file endpoint. + + Inherited users and groups are not included in the result, and + permissions are not returned for this endpoint. + requestBody: + content: + application/json: + schema: + type: object + example: + files: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + limit: 10 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + .tag: result + members: + users: + - access_type: + .tag: owner + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: bob@example.com + display_name: Robert Smith + same_team: true + team_member_id: dbmid:abcd1234 + permissions: [] + is_inherited: false + time_last_seen: '2016-01-20T00:00:00Z' + platform_type: + .tag: unknown + groups: + - access_type: + .tag: editor + group: + group_name: Test group + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + group_type: + .tag: user_managed + is_member: false + is_owner: false + same_team: true + member_count: 10 + permissions: [] + is_inherited: false + invitees: + - access_type: + .tag: viewer + invitee: + .tag: email + email: jessica@example.com + permissions: [] + is_inherited: false + member_count: 3 + /2/sharing/list_file_members/continue: + post: + tags: + - sharing + summary: list_file_members/continue + description: >- + [list_file_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue) + + + scope: `sharing.read` + + + Once a cursor has been retrieved from `list_file_members` or + `list_file_members/batch`, use this to paginate through all shared file + members. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + users: + - access_type: + .tag: owner + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: bob@example.com + display_name: Robert Smith + same_team: true + team_member_id: dbmid:abcd1234 + permissions: [] + is_inherited: false + time_last_seen: '2016-01-20T00:00:00Z' + platform_type: + .tag: unknown + groups: + - access_type: + .tag: editor + group: + group_name: Test group + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + group_type: + .tag: user_managed + is_member: false + is_owner: false + same_team: true + member_count: 10 + permissions: [] + is_inherited: false + invitees: + - access_type: + .tag: viewer + invitee: + .tag: email + email: jessica@example.com + permissions: [] + is_inherited: false + /2/sharing/list_folder_members/continue: + post: + tags: + - sharing + summary: list_folder_members/continue + description: >- + [list_folder_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue) + + + scope: `sharing.read` + + + Once a cursor has been retrieved from `list_folder_members`, use this to + paginate through all shared folder members. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + users: + - access_type: + .tag: owner + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: bob@example.com + display_name: Robert Smith + same_team: true + team_member_id: dbmid:abcd1234 + permissions: [] + is_inherited: false + groups: + - access_type: + .tag: editor + group: + group_name: Test group + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + group_type: + .tag: user_managed + is_member: false + is_owner: false + same_team: true + member_count: 10 + permissions: [] + is_inherited: false + invitees: + - access_type: + .tag: viewer + invitee: + .tag: email + email: jessica@example.com + permissions: [] + is_inherited: false + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/sharing/list_folders: + post: + tags: + - sharing + summary: list_folders + description: >- + [list_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders) + + + scope: `sharing.read` + + + Return the list of all shared folders the current user has access to. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 100 + actions: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/sharing/list_folders/continue: + post: + tags: + - sharing + summary: list_folders/continue + description: >- + [list_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue) + + + scope: `sharing.read` + + + Once a cursor has been retrieved from `list_folders`, use this to + paginate through all shared folders. The cursor must come from a + previous call to `list_folders` or `list_folders/continue`. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/sharing/list_mountable_folders: + post: + tags: + - sharing + summary: list_mountable_folders + description: >- + [list_mountable_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders) + + + scope: `sharing.read` + + + Return the list of all shared folders the current user can mount or + unmount. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 100 + actions: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/sharing/list_mountable_folders/continue: + post: + tags: + - sharing + summary: list_mountable_folders/continue + description: >- + [list_mountable_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue) + + + scope: `sharing.read` + + + Once a cursor has been retrieved from `list_mountable_folders`, use this + to paginate through all mountable shared folders. The cursor must come + from a previous call to `list_mountable_folders` or + `list_mountable_folders/continue`. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/sharing/list_received_files: + post: + tags: + - sharing + summary: list_received_files + description: >- + [list_received_files](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files) + + + scope: `sharing.read` + + + Returns a list of all files shared with current user. + Does not include files the user has received via shared folders, and does not include unclaimed invitations. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 100 + actions: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + access_type: + .tag: viewer + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + time_invited: '2016-01-20T00:00:00Z' + cursor: >- + AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + /2/sharing/list_received_files/continue: + post: + tags: + - sharing + summary: list_received_files/continue + description: >- + [list_received_files/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue) + + + scope: `sharing.read` + + + Get more results with a cursor from `list_received_files`. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: >- + AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + access_type: + .tag: viewer + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + time_invited: '2016-01-20T00:00:00Z' + cursor: >- + AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + /2/sharing/list_shared_links: + post: + tags: + - sharing + summary: list_shared_links + description: >- + [list_shared_links](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links) + + + scope: `sharing.read` + + + List shared links of this user. + + If no path is given, returns a list of all shared links for the current + user. + + If a non-empty path is given, returns a list of all shared links that + allow access to the given path - direct links to the given path and + links to parent folders of the given path. Links to parent folders can + be suppressed by setting direct_only to true. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + links: + - .tag: file + url: >- + https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + name: Prime_Numbers.txt + link_permissions: + can_revoke: false + resolved_visibility: + .tag: public + revoke_failure_reason: + .tag: owner_only + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + id: id:a4ayc_80_OEAAAAAAAAAXw + path_lower: /homework/math/prime_numbers.txt + team_member_info: + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + has_more: true + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/sharing/modify_shared_link_settings: + post: + tags: + - sharing + summary: modify_shared_link_settings + description: >- + [modify_shared_link_settings](https://www.dropbox.com/developers/documentation/http/documentation#sharing-modify_shared_link_settings) + + + scope: `sharing.write` + + + Modify the shared link's settings. + + If the requested visibility conflict with the shared links policy of the + team or the shared folder (in case the linked file is part of a shared + folder) then the `LinkPermissions.resolved_visibility` of the returned + `SharedLinkMetadata` will reflect the actual visibility of the shared + link and the `LinkPermissions.requested_visibility` will reflect the + requested visibility. + requestBody: + content: + application/json: + schema: + type: object + example: + url: >- + https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + settings: + requested_visibility: public + audience: public + access: viewer + remove_expiration: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: file + url: >- + https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + name: Prime_Numbers.txt + link_permissions: + can_revoke: false + resolved_visibility: + .tag: public + revoke_failure_reason: + .tag: owner_only + client_modified: '2015-05-12T15:50:38Z' + server_modified: '2015-05-12T15:50:38Z' + rev: a1c10ce0dd78 + size: 7212 + id: id:a4ayc_80_OEAAAAAAAAAXw + path_lower: /homework/math/prime_numbers.txt + team_member_info: + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + /2/sharing/mount_folder: + post: + tags: + - sharing + summary: mount_folder + description: >- + [mount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder) + + + scope: `sharing.write` + + + The current user mounts the designated folder. + + Mount a shared folder for a user after they have been added as a member. + Once mounted, the shared folder will appear in their Dropbox. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + /2/sharing/relinquish_file_membership: + post: + tags: + - sharing + summary: relinquish_file_membership + description: >- + [relinquish_file_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership) + + + scope: `sharing.write` + + + The current user relinquishes their membership in the designated file. + Note that the current user may still have inherited access to this file + through the parent folder. + requestBody: + content: + application/json: + schema: + type: object + example: + file: id:3kmLmQFnf1AAAAAAAAAAAw + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/sharing/relinquish_folder_membership: + post: + tags: + - sharing + summary: relinquish_folder_membership + description: >- + [relinquish_folder_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership) + + + scope: `sharing.write` + + + The current user relinquishes their membership in the designated shared + folder and will no longer have access to the folder. A folder owner + cannot relinquish membership in their own folder. + + This will run synchronously if leave_a_copy is false, and asynchronously + if leave_a_copy is true. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + leave_a_copy: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/sharing/remove_file_member_2: + post: + tags: + - sharing + summary: remove_file_member_2 + description: >- + [remove_file_member_2](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2) + + + scope: `sharing.write` + + + Removes a specified member from the file. + requestBody: + content: + application/json: + schema: + type: object + example: + file: id:3kmLmQFnf1AAAAAAAAAAAw + member: + .tag: email + email: justin@example.com + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: other + /2/sharing/remove_folder_member: + post: + tags: + - sharing + summary: remove_folder_member + description: >- + [remove_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member) + + + scope: `sharing.write` + + + Allows an owner or editor (if the ACL update policy allows) of a shared + folder to remove another member. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + member: + .tag: email + email: justin@example.com + leave_a_copy: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: async_job_id + async_job_id: 34g93hh34h04y384084 + /2/sharing/revoke_shared_link: + post: + tags: + - sharing + summary: revoke_shared_link + description: >- + [revoke_shared_link](https://www.dropbox.com/developers/documentation/http/documentation#sharing-revoke_shared_link) + + + scope: `sharing.write` + + + Revoke a shared link. + + Note that even after revoking a shared link to a file, the file may be + accessible if there are shared links leading to any of the file parent + folders. To list all shared links that enable access to a specific file, + you can use the `list_shared_links` with the file as the + `ListSharedLinksArg.path` argument. + requestBody: + content: + application/json: + schema: + type: object + example: + url: >- + https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/sharing/set_access_inheritance: + post: + tags: + - sharing + summary: set_access_inheritance + description: >- + [set_access_inheritance](https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance) + + + scope: `sharing.write` + + + Change the inheritance policy of an existing Shared Folder. Only + permitted for shared folders in a shared team root. + + If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call + `check_share_job_status` until the action completes to get the metadata + for the folder. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + access_inheritance: inherit + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + /2/sharing/share_folder: + post: + tags: + - sharing + summary: share_folder + description: >- + [share_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-share_folder) + + + scope: `sharing.write` + + + Share a folder with collaborators. + + Most sharing will be completed synchronously. Large folders will be + completed asynchronously. To make testing the async case repeatable, set + `ShareFolderArg.force_async`. + + If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call + `check_share_job_status` until the action completes to get the metadata + for the folder. + requestBody: + content: + application/json: + schema: + type: object + example: + path: /example/workspace + acl_update_policy: editors + force_async: false + member_policy: team + shared_link_policy: members + access_inheritance: inherit + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + /2/sharing/transfer_folder: + post: + tags: + - sharing + summary: transfer_folder + description: >- + [transfer_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder) + + + scope: `sharing.write` + + + Transfer ownership of a shared folder to a member of the shared folder. + + User must have `AccessLevel.owner` access to the shared folder to + perform a transfer. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + to_dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/sharing/unmount_folder: + post: + tags: + - sharing + summary: unmount_folder + description: >- + [unmount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder) + + + scope: `sharing.write` + + + The current user unmounts the designated folder. They can re-mount the + folder at a later time using `mount_folder`. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/sharing/unshare_file: + post: + tags: + - sharing + summary: unshare_file + description: >- + [unshare_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_file) + + + scope: `sharing.write` + + + Remove all members from this file. Does not remove inherited members. + requestBody: + content: + application/json: + schema: + type: object + example: + file: id:3kmLmQFnf1AAAAAAAAAAAw + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: Successful response + content: + application/json: {} + /2/sharing/unshare_folder: + post: + tags: + - sharing + summary: unshare_folder + description: >- + [unshare_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_folder) + + + scope: `sharing.write` + + + Allows a shared folder owner to unshare the folder. + + You'll need to call `check_job_status` to determine if the action has + completed successfully. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + leave_a_copy: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/sharing/update_file_member: + post: + tags: + - sharing + summary: update_file_member + description: >- + [update_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member) + + + scope: `sharing.write` + + + Changes a member's access on a shared file. + requestBody: + content: + application/json: + schema: + type: object + example: + file: id:3kmLmQFnf1AAAAAAAAAAAw + member: + .tag: email + email: justin@example.com + access_level: viewer + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: {} + /2/sharing/update_folder_member: + post: + tags: + - sharing + summary: update_folder_member + description: >- + [update_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member) + + + scope: `sharing.write` + + + Allows an owner or editor of a shared folder to update another member's + permissions. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + member: + .tag: email + email: justin@example.com + access_level: editor + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: {} + /2/sharing/update_folder_policy: + post: + tags: + - sharing + summary: update_folder_policy + description: >- + [update_folder_policy](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy) + + + scope: `sharing.write` + + + Update the sharing policies for a shared folder. + + User must have `AccessLevel.owner` access to the shared folder to update + its policies. + requestBody: + content: + application/json: + schema: + type: object + example: + shared_folder_id: '84528192421' + member_policy: team + acl_update_policy: owner + shared_link_policy: members + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + access_type: + .tag: owner + is_inside_team_folder: false + is_team_folder: false + name: dir + policy: + acl_update_policy: + .tag: owner + shared_link_policy: + .tag: anyone + member_policy: + .tag: anyone + resolved_member_policy: + .tag: team + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: '84528192421' + time_invited: '2016-01-20T00:00:00Z' + path_lower: /dir + link_metadata: + audience_options: + - .tag: public + - .tag: team + - .tag: members + current_audience: + .tag: public + link_permissions: + - action: + .tag: change_audience + allow: true + password_protected: false + url: '' + permissions: [] + access_inheritance: + .tag: inherit + /2/team/devices/list_member_devices: + post: + tags: + - team > devices + summary: devices/list_member_devices + description: >- + [devices/list_member_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_member_devices) + + + scope: `sessions.list` + + + List all device sessions of a team's member. + requestBody: + content: + application/json: + schema: + type: object + example: + team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + include_web_sessions: true + include_desktop_clients: true + include_mobile_clients: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/devices/list_members_devices: + post: + tags: + - team > devices + summary: devices/list_members_devices + description: >- + [devices/list_members_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_members_devices) + + + scope: `sessions.list` + + + List all device sessions of a team. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/devices/revoke_device_session: + post: + tags: + - team > devices + summary: devices/revoke_device_session + description: >- + [devices/revoke_device_session](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session) + + + scope: `sessions.modify` + + + Revoke a device session of a team's member. + requestBody: + content: + application/json: + schema: + type: object + example: + .tag: web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/devices/revoke_device_session_batch: + post: + tags: + - team > devices + summary: devices/revoke_device_session_batch + description: >- + [devices/revoke_device_session_batch](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session_batch) + + + scope: `sessions.modify` + + + Revoke a list of device sessions of team members. + requestBody: + content: + application/json: + schema: + type: object + example: + revoke_devices: + - .tag: web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/groups/create: + post: + tags: + - team > groups + summary: groups/create + description: >- + [groups/create](https://www.dropbox.com/developers/documentation/http/teams#team-groups-create) + + + scope: `groups.write` + + + Creates a new, empty group, with a requested name. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + group_name: Europe sales + add_creator_as_owner: false + group_external_id: group-134 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + group_name: project launch + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + created: 1447255518000 + member_count: 5 + members: + - profile: + team_member_id: dbmid:1234567 + email: mary@lamb.com + email_verified: true + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + access_type: + .tag: member + /2/team/groups/delete: + post: + tags: + - team > groups + summary: groups/delete + description: >- + [groups/delete](https://www.dropbox.com/developers/documentation/http/teams#team-groups-delete) + + + scope: `groups.write` + + + Deletes a group. + + The group is deleted immediately. However the revoking of group-owned + resources may take additional time. Use the `groups/job_status/get` to + determine whether this process has completed. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + .tag: group_id + group_id: g:e2db7665347abcd600000000001a2b3c + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/team/groups/get_info: + post: + tags: + - team > groups + summary: groups/get_info + description: >- + [groups/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-groups-get_info) + + + scope: `groups.read` + + + Retrieves information about one or more groups. Note that the optional + field `GroupFullInfo.members` is not returned for system-managed + groups. + + Permission : Team Information. + requestBody: + content: + application/json: + schema: + type: object + example: + .tag: group_ids + group_ids: + - g:e2db7665347abcd600000000001a2b3c + - g:111111147abcd6000000000222222c + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - .tag: group_info + group_name: project launch + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + created: 1447255518000 + member_count: 5 + members: + - profile: + team_member_id: dbmid:1234567 + email: mary@lamb.com + email_verified: true + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + access_type: + .tag: member + /2/team/groups/job_status/get: + post: + tags: + - team > groups + summary: groups/job_status/get + description: >- + [groups/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-groups-job_status-get) + + + scope: `groups.write` + + + Once an async_job_id is returned from `groups/delete`, + `groups/members/add` , or `groups/members/remove` use this method to + poll the status of granting/revoking group members' access to + group-owned resources. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/team/groups/list: + post: + tags: + - team > groups + summary: groups/list + description: >- + [groups/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list) + + + scope: `groups.read` + + + Lists groups on a team. + + Permission : Team Information. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 100 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + groups: + - group_name: Test group + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + member_count: 10 + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/groups/list/continue: + post: + tags: + - team > groups + summary: groups/list/continue + description: >- + [groups/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list-continue) + + + scope: `groups.read` + + + Once a cursor has been retrieved from `groups/list`, use this to + paginate through all groups. + + Permission : Team Information. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + groups: + - group_name: Test group + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + member_count: 10 + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/groups/members/add: + post: + tags: + - team > groups + summary: groups/members/add + description: >- + [groups/members/add](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-add) + + + scope: `groups.write` + + + Adds members to a group. + + The members are added immediately. However the granting of group-owned + resources may take additional time. Use the `groups/job_status/get` to + determine whether this process has completed. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + group: + .tag: group_id + group_id: g:e2db7665347abcd600000000001a2b3c + members: + - user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + access_type: member + return_members: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + group_info: + group_name: project launch + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + created: 1447255518000 + member_count: 5 + members: + - profile: + team_member_id: dbmid:1234567 + email: mary@lamb.com + email_verified: true + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + access_type: + .tag: member + async_job_id: '99988877733388' + /2/team/groups/members/list: + post: + tags: + - team > groups + summary: groups/members/list + description: >- + [groups/members/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list) + + + scope: `groups.read` + + + Lists members of a group. + + Permission : Team Information. + requestBody: + content: + application/json: + schema: + type: object + example: + group: + .tag: group_id + group_id: g:e2db7665347abcd600000000001a2b3c + limit: 100 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + members: [] + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/groups/members/list/continue: + post: + tags: + - team > groups + summary: groups/members/list/continue + description: >- + [groups/members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list-continue) + + + scope: `groups.read` + + + Once a cursor has been retrieved from `groups/members/list`, use this to + paginate through all members of the group. + + Permission : Team information. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + members: [] + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/groups/members/remove: + post: + tags: + - team > groups + summary: groups/members/remove + description: >- + [groups/members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-remove) + + + scope: `groups.write` + + + Removes members from a group. + + The members are removed immediately. However the revoking of group-owned + resources may take additional time. Use the `groups/job_status/get` to + determine whether this process has completed. + + This method permits removing the only owner of a group, even in cases + where this is not possible via the web client. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + group: + .tag: group_id + group_id: g:e2db7665347abcd600000000001a2b3c + users: + - .tag: team_member_id + team_member_id: dbmid:efgh5678 + return_members: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + group_info: + group_name: project launch + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + created: 1447255518000 + member_count: 5 + members: + - profile: + team_member_id: dbmid:1234567 + email: mary@lamb.com + email_verified: true + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + access_type: + .tag: member + async_job_id: '99988877733388' + /2/team/groups/members/set_access_type: + post: + tags: + - team > groups + summary: groups/members/set_access_type + description: >- + [groups/members/set_access_type](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-set_access_type) + + + scope: `groups.write` + + + Sets a member's access type in a group. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + group: + .tag: group_id + group_id: g:e2db7665347abcd600000000001a2b3c + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + access_type: member + return_members: true + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - .tag: group_info + group_name: project launch + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + created: 1447255518000 + member_count: 5 + members: + - profile: + team_member_id: dbmid:1234567 + email: mary@lamb.com + email_verified: true + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + access_type: + .tag: member + /2/team/groups/update: + post: + tags: + - team > groups + summary: groups/update + description: >- + [groups/update](https://www.dropbox.com/developers/documentation/http/teams#team-groups-update) + + + scope: `groups.write` + + + Updates a group's name and/or external ID. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + group: + .tag: group_id + group_id: g:e2db7665347abcd600000000001a2b3c + return_members: true + new_group_name: Europe west sales + new_group_external_id: sales-234 + new_group_management_type: company_managed + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + group_name: project launch + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + .tag: user_managed + created: 1447255518000 + member_count: 5 + members: + - profile: + team_member_id: dbmid:1234567 + email: mary@lamb.com + email_verified: true + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + access_type: + .tag: member + /2/team/legal_holds/create_policy: + post: + tags: + - team > legal_holds + summary: legal_holds/create_policy + description: >- + [legal_holds/create_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-create_policy) + + + scope: `team_data.member` + + + Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not + all teams have the feature. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + name: acme cfo policy + members: + - dbmid:FDFSVF-DFSDF + start_date: '2016-01-01T00:00:00Z' + end_date: '2017-12-31T00:00:00Z' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + name: acme cfo policy + members: + team_member_ids: + - dbmid:efgh5678 + permanently_deleted_users: 2 + status: + .tag: active + start_date: '2016-01-01T00:00:00Z' + activation_time: '2016-01-20T00:00:10Z' + end_date: '2017-12-31T00:00:00Z' + /2/team/legal_holds/get_policy: + post: + tags: + - team > legal_holds + summary: legal_holds/get_policy + description: >- + [legal_holds/get_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-get_policy) + + + scope: `team_data.member` + + + Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all + teams have the feature. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + name: acme cfo policy + members: + team_member_ids: + - dbmid:efgh5678 + permanently_deleted_users: 2 + status: + .tag: active + start_date: '2016-01-01T00:00:00Z' + activation_time: '2016-01-20T00:00:10Z' + end_date: '2017-12-31T00:00:00Z' + /2/team/legal_holds/list_held_revisions: + post: + tags: + - team > legal_holds + summary: legal_holds/list_held_revisions + description: >- + [legal_holds/list_held_revisions](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions) + + + scope: `team_data.member` + + + List the file metadata that's under the hold. Note: Legal Holds is a + paid add-on. Not all teams have the feature. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - new_filename: 111_222.pdf + original_revision_id: ab2rij4i5ojgfd + original_file_path: /a.pdf + server_modified: '2019-08-12T12:08:52Z' + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + .tag: active + author_email: a@a.com + file_type: Document + size: 3 + content_hash: >- + abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + has_more: false + /2/team/legal_holds/list_held_revisions_continue: + post: + tags: + - team > legal_holds + summary: legal_holds/list_held_revisions_continue + description: >- + [legal_holds/list_held_revisions_continue](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions_continue) + + + scope: `team_data.member` + + + Continue listing the file metadata that's under the hold. Note: Legal + Holds is a paid add-on. Not all teams have the feature. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + entries: + - new_filename: 111_222.pdf + original_revision_id: ab2rij4i5ojgfd + original_file_path: /a.pdf + server_modified: '2019-08-12T12:08:52Z' + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + .tag: active + author_email: a@a.com + file_type: Document + size: 3 + content_hash: >- + abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + has_more: false + /2/team/legal_holds/list_policies: + post: + tags: + - team > legal_holds + summary: legal_holds/list_policies + description: >- + [legal_holds/list_policies](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_policies) + + + scope: `team_data.member` + + + Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all + teams have the feature. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + include_released: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + policies: + - id: pid_dbhid:abcd1234 + name: acme cfo policy + members: + team_member_ids: + - dbmid:efgh5678 + permanently_deleted_users: 2 + status: + .tag: active + start_date: '2016-01-01T00:00:00Z' + activation_time: '2016-01-20T00:00:10Z' + end_date: '2017-12-31T00:00:00Z' + /2/team/legal_holds/release_policy: + post: + tags: + - team > legal_holds + summary: legal_holds/release_policy + description: >- + [legal_holds/release_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-release_policy) + + + scope: `team_data.member` + + + Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all + teams have the feature. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/legal_holds/update_policy: + post: + tags: + - team > legal_holds + summary: legal_holds/update_policy + description: >- + [legal_holds/update_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-update_policy) + + + scope: `team_data.member` + + + Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams + have the feature. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + members: + - dbmid:FDFSVF-DFSDF + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: pid_dbhid:abcd1234 + name: acme cfo policy + members: + team_member_ids: + - dbmid:efgh5678 + permanently_deleted_users: 2 + status: + .tag: active + start_date: '2016-01-01T00:00:00Z' + activation_time: '2016-01-20T00:00:10Z' + end_date: '2017-12-31T00:00:00Z' + /2/team/linked_apps/list_member_linked_apps: + post: + tags: + - team > linked_apps + summary: linked_apps/list_member_linked_apps + description: >- + [linked_apps/list_member_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_member_linked_apps) + + + scope: `sessions.list` + + + List all linked applications of the team member. + + Note, this endpoint does not list any team-linked applications. + requestBody: + content: + application/json: + schema: + type: object + example: + team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/linked_apps/list_members_linked_apps: + post: + tags: + - team > linked_apps + summary: linked_apps/list_members_linked_apps + description: >- + [linked_apps/list_members_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_members_linked_apps) + + + scope: `sessions.list` + + + List all applications linked to the team members' accounts. + + Note, this endpoint does not list any team-linked applications. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/linked_apps/revoke_linked_app: + post: + tags: + - team > linked_apps + summary: linked_apps/revoke_linked_app + description: >- + [linked_apps/revoke_linked_app](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app) + + + scope: `sessions.modify` + + + Revoke a linked application of the team member. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/linked_apps/revoke_linked_app_batch: + post: + tags: + - team > linked_apps + summary: linked_apps/revoke_linked_app_batch + description: >- + [linked_apps/revoke_linked_app_batch](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app_batch) + + + scope: `sessions.modify` + + + Revoke a list of linked applications of the team members. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/member_space_limits/excluded_users/add: + post: + tags: + - team > member_space_limits + summary: member_space_limits/excluded_users/add + description: >- + [member_space_limits/excluded_users/add](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-add) + + + scope: `members.write` + + + Add users to member space limits excluded users list. + requestBody: + content: + application/json: + schema: + type: object + example: + users: + - .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: + .tag: success + /2/team/member_space_limits/excluded_users/list: + post: + tags: + - team > member_space_limits + summary: member_space_limits/excluded_users/list + description: >- + [member_space_limits/excluded_users/list](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list) + + + scope: `members.read` + + + List member space limits excluded users. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 100 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + users: [] + has_more: false + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/team/member_space_limits/excluded_users/list/continue: + post: + tags: + - team > member_space_limits + summary: member_space_limits/excluded_users/list/continue + description: >- + [member_space_limits/excluded_users/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list-continue) + + + scope: `members.read` + + + Continue listing member space limits excluded users. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + users: [] + has_more: false + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /2/team/member_space_limits/excluded_users/remove: + post: + tags: + - team > member_space_limits + summary: member_space_limits/excluded_users/remove + description: >- + [member_space_limits/excluded_users/remove](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-remove) + + + scope: `members.write` + + + Remove users from member space limits excluded users list. + requestBody: + content: + application/json: + schema: + type: object + example: + users: + - .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: + .tag: success + /2/team/member_space_limits/get_custom_quota: + post: + tags: + - team > member_space_limits + summary: member_space_limits/get_custom_quota + description: >- + [member_space_limits/get_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-get_custom_quota) + + + scope: `members.read` + + + Get users custom quota. Returns none as the custom quota if none was + set. A maximum of 1000 members can be specified in a single call. + requestBody: + content: + application/json: + schema: + type: object + example: + users: + - .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - .tag: other + /2/team/member_space_limits/remove_custom_quota: + post: + tags: + - team > member_space_limits + summary: member_space_limits/remove_custom_quota + description: >- + [member_space_limits/remove_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-remove_custom_quota) + + + scope: `members.write` + + + Remove users custom quota. A maximum of 1000 members can be specified in + a single call. + requestBody: + content: + application/json: + schema: + type: object + example: + users: + - .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - .tag: other + /2/team/member_space_limits/set_custom_quota: + post: + tags: + - team > member_space_limits + summary: member_space_limits/set_custom_quota + description: >- + [member_space_limits/set_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-set_custom_quota) + + + scope: `members.read` + + + Set users custom quota. Custom quota has to be at least 15GB. A maximum + of 1000 members can be specified in a single call. + requestBody: + content: + application/json: + schema: + type: object + example: + users_and_quotas: + - user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + quota_gb: 30 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - .tag: other + /2/team/members/add: + post: + tags: + - team > members + summary: members/add + description: >- + [members/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-add) + + + scope: `members.write` + + + Adds members to a team. + + Permission : Team member management + + A maximum of 20 members can be specified in a single call. + + If no Dropbox account exists with the email address specified, a new + Dropbox account will be created with the given email address, and that + account will be invited to the team. + + If a personal Dropbox account exists with the email address specified in + the call, this call will create a placeholder Dropbox account for the + user on the team and send an email inviting the user to migrate their + existing personal account onto the team. + + Team member management apps are required to set an initial given_name + and surname for a user to use in the team invitation and for 'Perform as + team member' actions taken on the user before they become 'active'. + requestBody: + content: + application/json: + schema: + type: object + example: + new_members: + - member_email: tom.s@company.com + member_given_name: Tom + member_surname: Silverstone + member_external_id: company_id:342432 + send_welcome_email: true + role: member_only + force_async: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + complete: + - .tag: success + profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + /2/team/members/add/job_status/get: + post: + tags: + - team > members + summary: members/add/job_status/get + description: >- + [members/add/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-add-job_status-get) + + + scope: `members.write` + + + Once an async_job_id is returned from `members/add` , use this to poll + the status of the asynchronous request. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + complete: + - .tag: success + profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + /2/team/members/delete_profile_photo: + post: + tags: + - team > members + summary: members/delete_profile_photo + description: >- + [members/delete_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-delete_profile_photo) + + + scope: `members.write` + + + Deletes a team member's profile photo. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + /2/team/members/get_info: + post: + tags: + - team > members + summary: members/get_info + description: >- + [members/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-members-get_info) + + + scope: `members.read` + + + Returns information about multiple team members. + + Permission : Team information + + This endpoint will return `MembersGetInfoItem.id_not_found`, for IDs (or + emails) that cannot be matched to a valid team member. + requestBody: + content: + application/json: + schema: + type: object + example: + members: + - .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - .tag: member_info + profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + /2/team/members/list: + post: + tags: + - team > members + summary: members/list + description: >- + [members/list](https://www.dropbox.com/developers/documentation/http/teams#team-members-list) + + + scope: `members.read` + + + Lists members of a team. + + Permission : Team information. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 100 + include_removed: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + members: + - profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + /2/team/members/list/continue: + post: + tags: + - team > members + summary: members/list/continue + description: >- + [members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-members-list-continue) + + + scope: `members.read` + + + Once a cursor has been retrieved from `members/list`, use this to + paginate through all team members. + + Permission : Team information. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + members: + - profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + /2/team/members/move_former_member_files: + post: + tags: + - team > members + summary: members/move_former_member_files + description: >- + [members/move_former_member_files](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files) + + + scope: `members.write` + + + Moves removed member's files to a different member. This endpoint + initiates an asynchronous job. To obtain the final result of the job, + the client should periodically poll + `members/move_former_member_files/job_status/check`. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + transfer_dest_id: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + transfer_admin_id: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/team/members/move_former_member_files/job_status/check: + post: + tags: + - team > members + summary: members/move_former_member_files/job_status/check + description: >- + [members/move_former_member_files/job_status/check](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files-job_status-check) + + + scope: `members.write` + + + Once an async_job_id is returned from `members/move_former_member_files` + , use this to poll the status of the asynchronous request. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/team/members/recover: + post: + tags: + - team > members + summary: members/recover + description: >- + [members/recover](https://www.dropbox.com/developers/documentation/http/teams#team-members-recover) + + + scope: `members.delete` + + + Recover a deleted member. + + Permission : Team member management + + Exactly one of team_member_id, email, or external_id must be provided to + identify the user account. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/members/remove: + post: + tags: + - team > members + summary: members/remove + description: >- + [members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove) + + + scope: `members.delete` + + + Removes a member from a team. + + Permission : Team member management + + Exactly one of team_member_id, email, or external_id must be provided to + identify the user account. + + Accounts can be recovered via `members/recover` for a 7 day period or + until the account has been permanently deleted or transferred to another + account (whichever comes first). Calling `members/add` while a user is + still recoverable on your team will return with + `MemberAddResult.user_already_on_team`. + + Accounts can have their files transferred via the admin console for a + limited time, based on the version history length associated with the + team (180 days for most teams). + + This endpoint may initiate an asynchronous job. To obtain the final + result of the job, the client should periodically poll + `members/remove/job_status/get`. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + wipe_data: true + transfer_dest_id: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + transfer_admin_id: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + keep_account: false + retain_team_shares: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/team/members/remove/job_status/get: + post: + tags: + - team > members + summary: members/remove/job_status/get + description: >- + [members/remove/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove-job_status-get) + + + scope: `members.delete` + + + Once an async_job_id is returned from `members/remove` , use this to + poll the status of the asynchronous request. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + /2/team/members/secondary_emails/add: + post: + tags: + - team > members + summary: members/secondary_emails/add + description: >- + [members/secondary_emails/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-add) + + + scope: `members.write` + + + Add secondary emails to users. + + Permission : Team member management. + + Emails that are on verified domains will be verified automatically. For + each email address not on a verified domain a verification email will be + sent. + requestBody: + content: + application/json: + schema: + type: object + example: + new_secondary_emails: + - user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - .tag: success + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + results: + - .tag: success + success: + email: apple@orange.com + is_verified: true + - .tag: unavailable + unavailable: alice@example.com + - .tag: invalid_user + invalid_user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + /2/team/members/secondary_emails/delete: + post: + tags: + - team > members + summary: members/secondary_emails/delete + description: >- + [members/secondary_emails/delete](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-delete) + + + scope: `members.write` + + + Delete secondary emails from users + + Permission : Team member management. + + Users will be notified of deletions of verified secondary emails at both + the secondary email and their primary email. + requestBody: + content: + application/json: + schema: + type: object + example: + emails_to_delete: + - user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - .tag: success + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + results: + - .tag: success + success: alice@example.com + - .tag: not_found + not_found: alic@example.com + /2/team/members/secondary_emails/resend_verification_emails: + post: + tags: + - team > members + summary: members/secondary_emails/resend_verification_emails + description: >- + [members/secondary_emails/resend_verification_emails](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-resend_verification_emails) + + + scope: `members.write` + + + Resend secondary email verification emails. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + emails_to_resend: + - user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - .tag: success + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + results: + - .tag: success + success: alice@example.com + /2/team/members/send_welcome_email: + post: + tags: + - team > members + summary: members/send_welcome_email + description: >- + [members/send_welcome_email](https://www.dropbox.com/developers/documentation/http/teams#team-members-send_welcome_email) + + + scope: `members.write` + + + Sends welcome email to pending team member. + + Permission : Team member management + + Exactly one of team_member_id, email, or external_id must be provided to + identify the user account. + + No-op if team member is not pending. + requestBody: + content: + application/json: + schema: + type: object + example: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/members/set_admin_permissions: + post: + tags: + - team > members + summary: members/set_admin_permissions + description: >- + [members/set_admin_permissions](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_admin_permissions) + + + scope: `members.write` + + + Updates a team member's permissions. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + new_role: member_only + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + team_member_id: dbmid:9978889 + role: + .tag: member_only + /2/team/members/set_profile: + post: + tags: + - team > members + summary: members/set_profile + description: >- + [members/set_profile](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile) + + + scope: `members.write` + + + Updates a team member's profile. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + new_email: t.smith@domain.com + new_surname: Smith + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + /2/team/members/set_profile_photo: + post: + tags: + - team > members + summary: members/set_profile_photo + description: >- + [members/set_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile_photo) + + + scope: `members.write` + + + Updates a team member's profile photo. + + Permission : Team member management. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + photo: + .tag: base64_data + base64_data: >- + SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + role: + .tag: member_only + /2/team/members/suspend: + post: + tags: + - team > members + summary: members/suspend + description: >- + [members/suspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-suspend) + + + scope: `members.write` + + + Suspend a member from a team. + + Permission : Team member management + + Exactly one of team_member_id, email, or external_id must be provided to + identify the user account. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + wipe_data: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/members/unsuspend: + post: + tags: + - team > members + summary: members/unsuspend + description: >- + [members/unsuspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-unsuspend) + + + scope: `members.write` + + + Unsuspend a member from a team. + + Permission : Team member management + + Exactly one of team_member_id, email, or external_id must be provided to + identify the user account. + requestBody: + content: + application/json: + schema: + type: object + example: + user: + .tag: team_member_id + team_member_id: dbmid:efgh5678 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/namespaces/list: + post: + tags: + - team > namespaces + summary: namespaces/list + description: >- + [namespaces/list](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list) + + + scope: `team_data.member` + + + Returns a list of all team-accessible namespaces. This list includes + team folders, shared folders containing team members, team members' home + namespaces, and team members' app folders. Home namespaces and app + folders are always owned by this team or members of the team, but shared + folders may be owned by other users or other teams. Duplicates may occur + in the list. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 1 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + namespaces: + - name: Marketing + namespace_id: '123456789' + namespace_type: + .tag: shared_folder + - name: Franz Ferdinand + namespace_id: '123456789' + namespace_type: + .tag: team_member_folder + team_member_id: dbmid:1234567 + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/namespaces/list/continue: + post: + tags: + - team > namespaces + summary: namespaces/list/continue + description: >- + [namespaces/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list-continue) + + + scope: `team_data.member` + + + Once a cursor has been retrieved from `namespaces/list`, use this to + paginate through all team-accessible namespaces. Duplicates may occur in + the list. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + namespaces: + - name: Marketing + namespace_id: '123456789' + namespace_type: + .tag: shared_folder + - name: Franz Ferdinand + namespace_id: '123456789' + namespace_type: + .tag: team_member_folder + team_member_id: dbmid:1234567 + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/reports/get_activity: + post: + tags: + - team > reports + summary: reports/get_activity + description: >- + [reports/get_activity](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_activity) + + + scope: `team_info.read` + + + Retrieves reporting data about a team's user activity. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/reports/get_devices: + post: + tags: + - team > reports + summary: reports/get_devices + description: >- + [reports/get_devices](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_devices) + + + scope: `team_info.read` + + + Retrieves reporting data about a team's linked devices. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/reports/get_membership: + post: + tags: + - team > reports + summary: reports/get_membership + description: >- + [reports/get_membership](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_membership) + + + scope: `team_info.read` + + + Retrieves reporting data about a team's membership. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/reports/get_storage: + post: + tags: + - team > reports + summary: reports/get_storage + description: >- + [reports/get_storage](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_storage) + + + scope: `team_info.read` + + + Retrieves reporting data about a team's storage usage. + requestBody: + content: + application/json: + schema: + type: object + example: '' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/team_folder/activate: + post: + tags: + - team > team_folder + summary: team_folder/activate + description: >- + [team_folder/activate](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-activate) + + + scope: `team_data.team_space` + + + Sets an archived team folder's status to active. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + /2/team/team_folder/archive: + post: + tags: + - team > team_folder + summary: team_folder/archive + description: >- + [team_folder/archive](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive) + + + scope: `team_data.team_space` + + + Sets an active team folder's status to archived and removes all folder + and file members. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + force_async_off: false + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + /2/team/team_folder/archive/check: + post: + tags: + - team > team_folder + summary: team_folder/archive/check + description: >- + [team_folder/archive/check](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive-check) + + + scope: `team_data.team_space` + + + Returns the status of an asynchronous job for archiving a team folder. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + async_job_id: 34g93hh34h04y384084 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + .tag: complete + team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + /2/team/team_folder/create: + post: + tags: + - team > team_folder + summary: team_folder/create + description: >- + [team_folder/create](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-create) + + + scope: `team_data.team_space` + + + Creates a new, active, team folder with no members. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + name: Marketing + sync_setting: not_synced + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + /2/team/team_folder/get_info: + post: + tags: + - team > team_folder + summary: team_folder/get_info + description: >- + [team_folder/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-get_info) + + + scope: `team_data.team_space` + + + Retrieves metadata for team folders. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + team_folder_ids: + - '947182' + - '5819424' + - '852307532' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/team_folder/list: + post: + tags: + - team > team_folder + summary: team_folder/list + description: >- + [team_folder/list](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list) + + + scope: `team_data.team_space` + + + Lists all team folders. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 100 + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + team_folders: + - team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/team_folder/list/continue: + post: + tags: + - team > team_folder + summary: team_folder/list/continue + description: >- + [team_folder/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list-continue) + + + scope: `team_data.team_space` + + + Once a cursor has been retrieved from `team_folder/list`, use this to + paginate through all team folders. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + team_folders: + - team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team/team_folder/permanently_delete: + post: + tags: + - team > team_folder + summary: team_folder/permanently_delete + description: >- + [team_folder/permanently_delete](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-permanently_delete) + + + scope: `team_data.team_space` + + + Permanently deletes an archived team folder. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: Successful response + content: + application/json: {} + /2/team/team_folder/rename: + post: + tags: + - team > team_folder + summary: team_folder/rename + description: >- + [team_folder/rename](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-rename) + + + scope: `team_data.team_space` + + + Changes an active team folder's name. + + Permission : Team member file access. + requestBody: + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + name: Sales + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + /2/team/team_folder/update_sync_settings: + post: + tags: + - team > team_folder + summary: team_folder/update_sync_settings + description: >- + [team_folder/update_sync_settings](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-update_sync_settings) + + + scope: `team_data.team_space` + + + Updates the sync settings on a team folder or its contents. Use of this + endpoint requires that the team has team selective sync enabled. + requestBody: + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + sync_setting: not_synced + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: not_synced + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + team_folder_id: '123456789' + name: Marketing + status: + .tag: active + is_team_shared_dropbox: false + sync_setting: + .tag: default + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + .tag: default + /2/team/features/get_values: + post: + tags: + - team + summary: features/get_values + description: >- + [features/get_values](https://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) + + + scope: `team_info.read` + + + Get the values for one or more featues. This route allows you to check + your account's capability for what feature you can access or what value + you have for certain features. + + Permission : Team information. + requestBody: + content: + application/json: + schema: + type: object + example: + features: + - .tag: upload_api_rate_limit + - .tag: has_team_shared_dropbox + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + - .tag: upload_api_rate_limit + upload_api_rate_limit: + .tag: limit + limit: 25000 + - .tag: has_team_shared_dropbox + has_team_shared_dropbox: + .tag: has_team_shared_dropbox + has_team_shared_dropbox: false + /2/team/get_info: + post: + tags: + - team + summary: get_info + description: >- + [get_info](https://www.dropbox.com/developers/documentation/http/teams#team-get_info) + + + scope: `team_info.read` + + + Retrieves information about a team. + requestBody: + content: {} + security: + - bearerAuth: [] + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + name: Dropbox Inc. + team_id: dbtid:1234abcd + num_licensed_users: 5 + num_provisioned_users: 2 + policies: + sharing: + shared_folder_member_policy: + .tag: team + shared_folder_join_policy: + .tag: from_anyone + shared_link_create_policy: + .tag: team_only + emm_state: + .tag: disabled + office_addin: + .tag: disabled + /2/team/token/get_authenticated_admin: + post: + tags: + - team + summary: token/get_authenticated_admin + description: >- + [token/get_authenticated_admin](https://www.dropbox.com/developers/documentation/http/teams#team-token-get_authenticated_admin) + + + scope: `team_info.read` + + + Returns the member profile of the admin who generated the team access + token used to make the call. + requestBody: + content: {} + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + admin_profile: + team_member_id: dbmid:FDFSVF-DFSDF + email: tami@seagull.com + email_verified: false + status: + .tag: active + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + membership_type: + .tag: full + groups: + - g:e2db7665347abcd600000000001a2b3c + member_folder_id: '20' + external_id: '244423' + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + joined_on: '2015-05-12T15:50:38Z' + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /2/team_log/get_events: + post: + tags: + - team_log + summary: get_events + description: >- + [get_events](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events) + + + scope: `events.read` + + + Retrieves team events. If the result's `GetTeamEventsResult.has_more` + field is `true`, call `get_events/continue` with the returned cursor to + retrieve more entries. If end_time is not specified in your request, you + may use the returned cursor to poll `get_events/continue` for new + events. + + Many attributes note 'may be missing due to historical data gap'. + + Note that the file_operations category and & analogous paper events are + not available on all Dropbox Business + [plans](http://www.dropbox.com/business/plans-comparison). Use + [features/get_values](http://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) + to check for this feature. + + Permission : Team Auditing. + requestBody: + content: + application/json: + schema: + type: object + example: + limit: 50 + category: groups + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + events: + - timestamp: '2017-01-25T15:51:30Z' + event_category: + .tag: tfa + event_type: + .tag: shared_content_download + description: (sharing) Downloaded shared file/folder + details: + .tag: shared_content_download_details + shared_content_link: abc + shared_content_access_level: + .tag: viewer_no_comment + shared_content_owner: + .tag: team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + actor: + .tag: user + user: + .tag: team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + origin: + access_method: + .tag: end_user + end_user: + .tag: web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + ip_address: 45.56.78.100 + city: San Francisco + region: California + country: US + involve_non_team_member: true + context: + .tag: team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + participants: + - .tag: user + user: + .tag: team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + assets: + - .tag: file + path: + namespace_relative: + ns_id: '1234' + relative_path: /Contract Work/Draft + is_shared_namespace: false + contextual: /Contract Work/Draft + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/team_log/get_events/continue: + post: + tags: + - team_log + summary: get_events/continue + description: >- + [get_events/continue](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events-continue) + + + scope: `events.read` + + + Once a cursor has been retrieved from `get_events`, use this to paginate + through all events. + + Permission : Team Auditing. + requestBody: + content: + application/json: + schema: + type: object + example: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + events: + - timestamp: '2017-01-25T15:51:30Z' + event_category: + .tag: tfa + event_type: + .tag: shared_content_download + description: (sharing) Downloaded shared file/folder + details: + .tag: shared_content_download_details + shared_content_link: abc + shared_content_access_level: + .tag: viewer_no_comment + shared_content_owner: + .tag: team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + actor: + .tag: user + user: + .tag: team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + origin: + access_method: + .tag: end_user + end_user: + .tag: web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + ip_address: 45.56.78.100 + city: San Francisco + region: California + country: US + involve_non_team_member: true + context: + .tag: team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + participants: + - .tag: user + user: + .tag: team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + assets: + - .tag: file + path: + namespace_relative: + ns_id: '1234' + relative_path: /Contract Work/Draft + is_shared_namespace: false + contextual: /Contract Work/Draft + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + /2/users/features/get_values: + post: + tags: + - users + summary: features/get_values + description: >- + [features/get_values](https://www.dropbox.com/developers/documentation/http/documentation#users-features-get_values) + + + scope: `account_info.read` + + + Get a list of feature values that may be configured for the current + account. + requestBody: + content: + application/json: + schema: + type: object + example: + features: + - .tag: paper_as_files + - .tag: file_locking + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + - .tag: paper_as_files + paper_as_files: + .tag: enabled + enabled: true + /2/users/get_account: + post: + tags: + - users + summary: get_account + description: >- + [get_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account) + + + scope: `sharing.read` + + + Get information about a user's account. + requestBody: + content: + application/json: + schema: + type: object + example: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + email: franz@dropbox.com + email_verified: true + disabled: false + is_teammate: false + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /2/users/get_account_batch: + post: + tags: + - users + summary: get_account_batch + description: >- + [get_account_batch](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account_batch) + + + scope: `sharing.read` + + + Get information about multiple user accounts. At most 300 accounts may + be queried per request. + requestBody: + content: + application/json: + schema: + type: object + example: + account_ids: + - dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + - dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + email: franz@dropbox.com + email_verified: true + disabled: false + is_teammate: false + profile_photo_url: >- + https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /2/users/get_current_account: + post: + tags: + - users + summary: get_current_account + description: >- + [get_current_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account) + + + scope: `account_info.read` + + + Get information about the current user's account. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + - name: Dropbox-API-Select-Admin + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + name: + given_name: Franz + surname: Ferdinand + familiar_name: Franz + display_name: Franz Ferdinand (Personal) + abbreviated_name: FF + email: franz@dropbox.com + email_verified: true + disabled: false + locale: en + referral_link: https://db.tt/ZITNuhtI + is_paired: true + account_type: + .tag: business + root_info: + .tag: user + root_namespace_id: '3235641' + home_namespace_id: '3235641' + country: US + team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: Acme, Inc. + sharing_policies: + shared_folder_member_policy: + .tag: team + shared_folder_join_policy: + .tag: from_anyone + shared_link_create_policy: + .tag: team_only + office_addin_policy: + .tag: disabled + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + /2/users/get_space_usage: + post: + tags: + - users + summary: get_space_usage + description: >- + [get_space_usage](https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage) + + + scope: `account_info.read` + + + Get the space usage information for the current user's account. + requestBody: + content: {} + parameters: + - name: Dropbox-API-Path-Root + in: header + schema: + type: string + example: '{".tag": "namespace_id", "namespace_id": "2"}' + - name: Dropbox-API-Select-User + in: header + schema: + type: string + example: dbmid:FDFSVF-DFSDF + responses: + '200': + description: OK + headers: + X-Dropbox-Request-Id: + schema: + type: integer + example: '1234' + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + used: 314159265 + allocation: + .tag: individual + allocated: 10000000000 From 0730dce113300d013b05a5a3fd22ab0b01510ff6 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Fri, 25 Oct 2024 04:08:52 +0530 Subject: [PATCH 02/15] Sanitize OpenAPI spec by adding content type and schema to every content --- docs/spec/openapi.yaml | 120 ++++++++++++++++++++++++++++++++------- docs/spec/sanitations.md | 10 ++-- 2 files changed, 105 insertions(+), 25 deletions(-) diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml index d1ea536..fb69833 100644 --- a/docs/spec/openapi.yaml +++ b/docs/spec/openapi.yaml @@ -340,7 +340,11 @@ paths: Disables the access token used to authenticate the call. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Path-Root in: header @@ -491,7 +495,11 @@ paths: on your team or who you imported. New contacts will be added when you share. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Path-Root in: header @@ -1152,7 +1160,11 @@ paths: Get the template identifiers for a team. To get the schema of each template use `templates/get_for_team`. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} security: - bearerAuth: [] responses: @@ -1190,7 +1202,11 @@ paths: template use `templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Path-Root in: header @@ -1443,7 +1459,11 @@ paths: Returns the total number of file requests owned by this user. Includes both open and closed file requests. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Path-Root in: header @@ -1639,7 +1659,11 @@ paths: Delete all closed file requests owned by this user. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Path-Root in: header @@ -2972,7 +2996,11 @@ paths: Download a file from a user's Dropbox. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -3056,7 +3084,11 @@ paths: The input cannot be a single file. Any single file must be less than 4GB in size. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -3124,7 +3156,11 @@ paths: files that cannot be downloaded directly and whose `ExportResult.file_metadata` has `ExportInfo.export_as` populated. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -3398,7 +3434,11 @@ paths: Other formats will return an unsupported extension error. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -3678,7 +3718,11 @@ paths: Get a thumbnail for a file. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -5271,7 +5315,11 @@ paths: limit page](https://www.dropbox.com/developers/reference/data-transport-limit). requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -5367,7 +5415,11 @@ paths: limit page](https://www.dropbox.com/developers/reference/data-transport-limit). requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -5425,7 +5477,11 @@ paths: limit page](https://www.dropbox.com/developers/reference/data-transport-limit). requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -5741,7 +5797,11 @@ paths: limit page](https://www.dropbox.com/developers/reference/data-transport-limit). requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -6397,7 +6457,11 @@ paths: Download the shared link's file from a user's Dropbox. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Arg in: header @@ -12557,7 +12621,11 @@ paths: Retrieves information about a team. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} security: - bearerAuth: [] responses: @@ -12608,7 +12676,11 @@ paths: Returns the member profile of the admin who generated the team access token used to make the call. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} responses: '200': description: OK @@ -13121,7 +13193,11 @@ paths: Get information about the current user's account. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Path-Root in: header @@ -13202,7 +13278,11 @@ paths: Get the space usage information for the current user's account. requestBody: - content: {} + content: + application/json: + schema: + type: object + properties: {} parameters: - name: Dropbox-API-Path-Root in: header diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 2be12ad..f350ef7 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -1,16 +1,16 @@ -_Author_: \ -_Created_: \ -_Updated_: \ +_Author_: @rahul1995 \ +_Created_: 2024/10/25 \ +_Updated_: 2024/10/25 \ _Edition_: Swan Lake # Sanitation for OpenAPI specification This document records the sanitation done on top of the official OpenAPI specification from Dropbox. -The OpenAPI specification is obtained from (TODO: Add source link). +The OpenAPI specification is obtained from https://www.postman.com/dropbox-api/dropbox-s-public-workspace/collection/q1zdtug/dropbox-api-reference. These changes are done in order to improve the overall usability, and as workarounds for some known language limitations. [//]: # (TODO: Add sanitation details) -1. +1. Add content-type and schema to each empty content 2. 3. From dc12d704a26413772fe319ddbc992169a9d1270a Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Fri, 25 Oct 2024 04:35:42 +0530 Subject: [PATCH 03/15] Generate client with required sanitization from OpenAPI spec --- ballerina/client.bal | 1826 +++++++++++++++++++++++++++++++++++++- ballerina/types.bal | 1273 ++++++++++++++++++++++++++ ballerina/utils.bal | 36 + docs/spec/sanitations.md | 2 +- 4 files changed, 3121 insertions(+), 16 deletions(-) create mode 100644 ballerina/types.bal create mode 100644 ballerina/utils.bal diff --git a/ballerina/client.bal b/ballerina/client.bal index 66cdc3f..a7ea31a 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -1,15 +1,1811 @@ -// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com). -// -// WSO2 LLC. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + +import ballerina/http; + +# The powerful, yet simple, Dropbox API allows you to manage and control content and team settings programmatically and extend Dropbox capabilities in new and powerful ways. This is a collection that includes requests to all endpoints in the Dropbox API. +# +# The Dropbox API is divided in two groups of endpoints: User Endpoints and Business Endpoints. Operations that would most likely be executed by a user, such as file operations, are in the User Endpoints folder. Operations that would most likely be executed by a team administrator, such as adding users to groups, live in the Business Endpoints folder. +# +# If you are new to Dropbox Business and Team Administration, please have a look at the [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). +# +# If you want more information on how to use our API please refer to our [Developer Portal](https://www.dropbox.com/developers). +# +# # What's in the collection? +# +# The endpoints are organized in the following folders: +# * account +# * auth +# * check +# * contacts +# * file_properties +# * file_requests +# * files +# * sharing +# * team +# * team_log +# * users +# +# # Authorization +# +# ## OAuth 2.0 for API Access +# Dropbox uses OAuth 2.0, an open specification, to authorize access to data. To get an OAuth token from Dropbox to enable Postman to access your Dropbox account via the API you’ll need to create a new app on the DBX Platform. +# +# ## Creating an App on the DBX Platform +# Navigate to https://www.dropbox.com/developers/apps and select “Create app” +# 1. Choose an API +# 2. Choose the type of access you need +# 3. Give your app a name +# 4. Choose the Dropbox account that will own your app +# +# For reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) +# +# ## Generating an Access Token +# Once you select “Create app” a page will load that displays information about your newly created app. To generate an access token scroll down to “OAuth 2” and click “Generate” beneath “Generated access token.” The token will display as a long string of characters. Copy this token for use with the Postman Collection. +# +# ## Adding an Access Token to the requests +# In the Postman client, click on the three dots to the right of the collection name to "View more actions." +# +# ![Screenshot of adding access token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1) +# +# Then, click "Edit." +# +# Click on the "Variables" tab and, in the row for the `access_token` variable, paste your access token in the `CURRENT VALUE` column. The default value is `your-access-token-here`. +# +# ![Screenshot of adding access token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1) +# +# For information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/. +# +# # Notes +# * Dropbox also has a Postman Collection in the API Network to help administrators with team management workflows. It is called [Dropbox Team Admin Workflows](). +public isolated client class Client { + final http:Client clientEp; + # Gets invoked to initialize the `connector`. + # + # + config - The configurations to be used when initializing the `connector` + # + serviceUrl - URL of the target service + # + return - An error if connector initialization failed + public isolated function init(ConnectionConfig config, string serviceUrl = "https://api.dropboxapi.com") returns error? { + http:ClientConfiguration httpClientConfig = {auth: config.auth, httpVersion: config.httpVersion, timeout: config.timeout, forwarded: config.forwarded, poolConfig: config.poolConfig, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, validation: config.validation}; + do { + if config.http1Settings is ClientHttp1Settings { + ClientHttp1Settings settings = check config.http1Settings.ensureType(ClientHttp1Settings); + httpClientConfig.http1Settings = {...settings}; + } + if config.http2Settings is http:ClientHttp2Settings { + httpClientConfig.http2Settings = check config.http2Settings.ensureType(http:ClientHttp2Settings); + } + if config.cache is http:CacheConfig { + httpClientConfig.cache = check config.cache.ensureType(http:CacheConfig); + } + if config.responseLimits is http:ResponseLimitConfigs { + httpClientConfig.responseLimits = check config.responseLimits.ensureType(http:ResponseLimitConfigs); + } + if config.secureSocket is http:ClientSecureSocket { + httpClientConfig.secureSocket = check config.secureSocket.ensureType(http:ClientSecureSocket); + } + if config.proxy is http:ProxyConfig { + httpClientConfig.proxy = check config.proxy.ensureType(http:ProxyConfig); + } + } + http:Client httpEp = check new (serviceUrl, httpClientConfig); + self.clientEp = httpEp; + return; + } + + resource isolated function post '2/'check/app(record {} payload, Post2CheckAppHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/check/app`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/'check/user(record {} payload, Post2CheckUserHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/check/user`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/account/set_profile_photo(record {} payload, Post2AccountSet_profile_photoHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/account/set_profile_photo`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/auth/token/from_oauth1(record {} payload, Post2AuthTokenFrom_oauth1Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/auth/token/from_oauth1`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/auth/token/revoke(record {} payload, Post2AuthTokenRevokeHeaders headers = {}) returns json|error { + string resourcePath = string `/2/auth/token/revoke`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/contacts/delete_manual_contacts(record {} payload, Post2ContactsDelete_manual_contactsHeaders headers = {}) returns json|error { + string resourcePath = string `/2/contacts/delete_manual_contacts`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/contacts/delete_manual_contacts_batch(record {} payload, Post2ContactsDelete_manual_contacts_batchHeaders headers = {}) returns json|error { + string resourcePath = string `/2/contacts/delete_manual_contacts_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/properties/add(record {} payload, Post2File_propertiesPropertiesAddHeaders headers = {}) returns json|error { + string resourcePath = string `/2/file_properties/properties/add`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/properties/overwrite(record {} payload, Post2File_propertiesPropertiesOverwriteHeaders headers = {}) returns json|error { + string resourcePath = string `/2/file_properties/properties/overwrite`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/properties/remove(record {} payload, Post2File_propertiesPropertiesRemoveHeaders headers = {}) returns json|error { + string resourcePath = string `/2/file_properties/properties/remove`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/properties/search(record {} payload, Post2File_propertiesPropertiesSearchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/properties/search`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/properties/search/'continue(record {} payload, Post2File_propertiesPropertiesSearchContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/properties/search/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/properties/update(record {} payload, Post2File_propertiesPropertiesUpdateHeaders headers = {}) returns json|error { + string resourcePath = string `/2/file_properties/properties/update`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/add_for_team(record {} payload, Post2File_propertiesTemplatesAdd_for_teamHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/add_for_team`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/add_for_user(record {} payload, Post2File_propertiesTemplatesAdd_for_userHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/add_for_user`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/get_for_team(record {} payload, Post2File_propertiesTemplatesGet_for_teamHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/get_for_team`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/get_for_user(record {} payload, Post2File_propertiesTemplatesGet_for_userHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/get_for_user`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/list_for_team(record {} payload, map headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/list_for_team`; + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, headers); + } + + resource isolated function post '2/file_properties/templates/list_for_user(record {} payload, Post2File_propertiesTemplatesList_for_userHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/list_for_user`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/remove_for_team(record {} payload, Post2File_propertiesTemplatesRemove_for_teamHeaders headers = {}) returns json|error { + string resourcePath = string `/2/file_properties/templates/remove_for_team`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/remove_for_user(record {} payload, Post2File_propertiesTemplatesRemove_for_userHeaders headers = {}) returns json|error { + string resourcePath = string `/2/file_properties/templates/remove_for_user`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/update_for_team(record {} payload, Post2File_propertiesTemplatesUpdate_for_teamHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/update_for_team`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_properties/templates/update_for_user(record {} payload, Post2File_propertiesTemplatesUpdate_for_userHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_properties/templates/update_for_user`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/count(record {} payload, Post2File_requestsCountHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/count`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/create(record {} payload, Post2File_requestsCreateHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/create`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/delete(record {} payload, Post2File_requestsDeleteHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/delete`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/delete_all_closed(record {} payload, Post2File_requestsDelete_all_closedHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/delete_all_closed`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/get(record {} payload, Post2File_requestsGetHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/get`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/list/'continue(record {} payload, Post2File_requestsListContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/list/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/list_v2(record {} payload, Post2File_requestsList_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/list_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/file_requests/update(record {} payload, Post2File_requestsUpdateHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/file_requests/update`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/copy_batch/check_v2(record {} payload, Post2FilesCopy_batchCheck_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/copy_batch/check_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/copy_batch_v2(record {} payload, Post2FilesCopy_batch_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/copy_batch_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/copy_reference/get(record {} payload, Post2FilesCopy_referenceGetHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/copy_reference/get`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/copy_reference/save(record {} payload, Post2FilesCopy_referenceSaveHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/copy_reference/save`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/copy_v2(record {} payload, Post2FilesCopy_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/copy_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/create_folder_batch(record {} payload, Post2FilesCreate_folder_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/create_folder_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/create_folder_batch/'check(record {} payload, Post2FilesCreate_folder_batchCheckHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/create_folder_batch/check`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/create_folder_v2(record {} payload, Post2FilesCreate_folder_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/create_folder_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/delete_batch(record {} payload, Post2FilesDelete_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/delete_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/delete_batch/'check(record {} payload, Post2FilesDelete_batchCheckHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/delete_batch/check`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/delete_v2(record {} payload, Post2FilesDelete_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/delete_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/download(record {} payload, Post2FilesDownloadHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/download`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/download_zip(record {} payload, Post2FilesDownload_zipHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/download_zip`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/export(record {} payload, Post2FilesExportHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/export`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/get_file_lock_batch(record {} payload, Post2FilesGet_file_lock_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/get_file_lock_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/get_metadata(record {} payload, Post2FilesGet_metadataHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/get_metadata`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/get_preview(record {} payload, Post2FilesGet_previewHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/get_preview`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/get_temporary_link(record {} payload, Post2FilesGet_temporary_linkHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/get_temporary_link`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/get_temporary_upload_link(record {} payload, Post2FilesGet_temporary_upload_linkHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/get_temporary_upload_link`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/get_thumbnail_batch(record {} payload, Post2FilesGet_thumbnail_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/get_thumbnail_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/get_thumbnail_v2(record {} payload, Post2FilesGet_thumbnail_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/get_thumbnail_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/list_folder(record {} payload, Post2FilesList_folderHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/list_folder`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/list_folder/'continue(record {} payload, Post2FilesList_folderContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/list_folder/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/list_folder/get_latest_cursor(record {} payload, Post2FilesList_folderGet_latest_cursorHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/list_folder/get_latest_cursor`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/list_folder/longpoll(record {} payload, Post2FilesList_folderLongpollHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/list_folder/longpoll`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/list_revisions(record {} payload, Post2FilesList_revisionsHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/list_revisions`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/lock_file_batch(record {} payload, Post2FilesLock_file_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/lock_file_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/move_batch/check_v2(record {} payload, Post2FilesMove_batchCheck_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/move_batch/check_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/move_batch_v2(record {} payload, Post2FilesMove_batch_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/move_batch_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/move_v2(record {} payload, Post2FilesMove_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/move_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/permanently_delete(record {} payload, Post2FilesPermanently_deleteHeaders headers = {}) returns json|error { + string resourcePath = string `/2/files/permanently_delete`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/restore(record {} payload, Post2FilesRestoreHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/restore`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/save_url(record {} payload, Post2FilesSave_urlHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/save_url`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/save_url/check_job_status(record {} payload, Post2FilesSave_urlCheck_job_statusHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/save_url/check_job_status`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/search/continue_v2(record {} payload, Post2FilesSearchContinue_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/search/continue_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/search_v2(record {} payload, Post2FilesSearch_v2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/files/search_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/unlock_file_batch(record {} payload, Post2FilesUnlock_file_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/unlock_file_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/upload(record {} payload, Post2FilesUploadHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/upload`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/upload_session/'start(record {} payload, Post2FilesUpload_sessionStartHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/upload_session/start`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/upload_session/append_v2(record {} payload, Post2FilesUpload_sessionAppend_v2Headers headers = {}) returns json|error { + string resourcePath = string `/2/files/upload_session/append_v2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/upload_session/finish(record {} payload, Post2FilesUpload_sessionFinishHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/upload_session/finish`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/upload_session/finish_batch(record {} payload, Post2FilesUpload_sessionFinish_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/upload_session/finish_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/files/upload_session/finish_batch/'check(record {} payload, Post2FilesUpload_sessionFinish_batchCheckHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/files/upload_session/finish_batch/check`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/add_file_member(record {} payload, Post2SharingAdd_file_memberHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/add_file_member`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/add_folder_member(record {} payload, Post2SharingAdd_folder_memberHeaders headers = {}) returns json|error { + string resourcePath = string `/2/sharing/add_folder_member`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/check_job_status(record {} payload, Post2SharingCheck_job_statusHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/check_job_status`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/check_remove_member_job_status(record {} payload, Post2SharingCheck_remove_member_job_statusHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/check_remove_member_job_status`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/check_share_job_status(record {} payload, Post2SharingCheck_share_job_statusHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/check_share_job_status`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/get_file_metadata(record {} payload, Post2SharingGet_file_metadataHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/get_file_metadata`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/get_file_metadata/batch(record {} payload, Post2SharingGet_file_metadataBatchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/get_file_metadata/batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/get_folder_metadata(record {} payload, Post2SharingGet_folder_metadataHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/get_folder_metadata`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/get_shared_link_file(record {} payload, Post2SharingGet_shared_link_fileHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/get_shared_link_file`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/get_shared_link_metadata(record {} payload, Post2SharingGet_shared_link_metadataHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/get_shared_link_metadata`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_file_members(record {} payload, Post2SharingList_file_membersHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_file_members`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_file_members/'continue(record {} payload, Post2SharingList_file_membersContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_file_members/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_file_members/batch(record {} payload, Post2SharingList_file_membersBatchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_file_members/batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_folder_members/'continue(record {} payload, Post2SharingList_folder_membersContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_folder_members/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_folders(record {} payload, Post2SharingList_foldersHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_folders`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_folders/'continue(record {} payload, Post2SharingList_foldersContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_folders/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_mountable_folders(record {} payload, Post2SharingList_mountable_foldersHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_mountable_folders`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_mountable_folders/'continue(record {} payload, Post2SharingList_mountable_foldersContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_mountable_folders/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_received_files(record {} payload, Post2SharingList_received_filesHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_received_files`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_received_files/'continue(record {} payload, Post2SharingList_received_filesContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_received_files/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/list_shared_links(record {} payload, Post2SharingList_shared_linksHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/list_shared_links`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/modify_shared_link_settings(record {} payload, Post2SharingModify_shared_link_settingsHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/modify_shared_link_settings`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/mount_folder(record {} payload, Post2SharingMount_folderHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/mount_folder`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/relinquish_file_membership(record {} payload, Post2SharingRelinquish_file_membershipHeaders headers = {}) returns json|error { + string resourcePath = string `/2/sharing/relinquish_file_membership`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/relinquish_folder_membership(record {} payload, Post2SharingRelinquish_folder_membershipHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/relinquish_folder_membership`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/remove_file_member_2(record {} payload, Post2SharingRemove_file_member_2Headers headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/remove_file_member_2`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/remove_folder_member(record {} payload, Post2SharingRemove_folder_memberHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/remove_folder_member`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/revoke_shared_link(record {} payload, Post2SharingRevoke_shared_linkHeaders headers = {}) returns json|error { + string resourcePath = string `/2/sharing/revoke_shared_link`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/set_access_inheritance(record {} payload, Post2SharingSet_access_inheritanceHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/set_access_inheritance`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/share_folder(record {} payload, Post2SharingShare_folderHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/share_folder`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/transfer_folder(record {} payload, Post2SharingTransfer_folderHeaders headers = {}) returns json|error { + string resourcePath = string `/2/sharing/transfer_folder`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/unmount_folder(record {} payload, Post2SharingUnmount_folderHeaders headers = {}) returns json|error { + string resourcePath = string `/2/sharing/unmount_folder`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/unshare_file(record {} payload, Post2SharingUnshare_fileHeaders headers = {}) returns json|error { + string resourcePath = string `/2/sharing/unshare_file`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/unshare_folder(record {} payload, Post2SharingUnshare_folderHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/unshare_folder`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/update_file_member(record {} payload, Post2SharingUpdate_file_memberHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/update_file_member`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/update_folder_member(record {} payload, Post2SharingUpdate_folder_memberHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/update_folder_member`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/sharing/update_folder_policy(record {} payload, Post2SharingUpdate_folder_policyHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/sharing/update_folder_policy`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/devices/list_member_devices(record {} payload, Post2TeamDevicesList_member_devicesHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/devices/list_member_devices`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/devices/list_members_devices(record {} payload, Post2TeamDevicesList_members_devicesHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/devices/list_members_devices`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/devices/revoke_device_session(record {} payload, Post2TeamDevicesRevoke_device_sessionHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/devices/revoke_device_session`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/devices/revoke_device_session_batch(record {} payload, Post2TeamDevicesRevoke_device_session_batchHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/devices/revoke_device_session_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/features/get_values(record {} payload, Post2TeamFeaturesGet_valuesHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/features/get_values`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/get_info(record {} payload, map headers = {}) returns record {}|error { + string resourcePath = string `/2/team/get_info`; + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, headers); + } + + resource isolated function post '2/team/groups/create(record {} payload, Post2TeamGroupsCreateHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/create`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/delete(record {} payload, Post2TeamGroupsDeleteHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/delete`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/get_info(record {} payload, Post2TeamGroupsGet_infoHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/get_info`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/job_status/get(record {} payload, Post2TeamGroupsJob_statusGetHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/job_status/get`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/list(record {} payload, Post2TeamGroupsListHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/list`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/list/'continue(record {} payload, Post2TeamGroupsListContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/list/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/members/add(record {} payload, Post2TeamGroupsMembersAddHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/members/add`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/members/list(record {} payload, Post2TeamGroupsMembersListHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/members/list`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/members/list/'continue(record {} payload, Post2TeamGroupsMembersListContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/members/list/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/members/remove(record {} payload, Post2TeamGroupsMembersRemoveHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/members/remove`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/members/set_access_type(record {} payload, Post2TeamGroupsMembersSet_access_typeHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/members/set_access_type`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/groups/update(record {} payload, Post2TeamGroupsUpdateHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/groups/update`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/legal_holds/create_policy(record {} payload, Post2TeamLegal_holdsCreate_policyHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/legal_holds/create_policy`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/legal_holds/get_policy(record {} payload, Post2TeamLegal_holdsGet_policyHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/legal_holds/get_policy`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/legal_holds/list_held_revisions(record {} payload, Post2TeamLegal_holdsList_held_revisionsHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/legal_holds/list_held_revisions`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/legal_holds/list_held_revisions_continue(record {} payload, Post2TeamLegal_holdsList_held_revisions_continueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/legal_holds/list_held_revisions_continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/legal_holds/list_policies(record {} payload, Post2TeamLegal_holdsList_policiesHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/legal_holds/list_policies`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/legal_holds/release_policy(record {} payload, Post2TeamLegal_holdsRelease_policyHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/legal_holds/release_policy`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/legal_holds/update_policy(record {} payload, Post2TeamLegal_holdsUpdate_policyHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/legal_holds/update_policy`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/linked_apps/list_member_linked_apps(record {} payload, Post2TeamLinked_appsList_member_linked_appsHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/linked_apps/list_member_linked_apps`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/linked_apps/list_members_linked_apps(record {} payload, Post2TeamLinked_appsList_members_linked_appsHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/linked_apps/list_members_linked_apps`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/linked_apps/revoke_linked_app(record {} payload, Post2TeamLinked_appsRevoke_linked_appHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/linked_apps/revoke_linked_app`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/linked_apps/revoke_linked_app_batch(record {} payload, Post2TeamLinked_appsRevoke_linked_app_batchHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/linked_apps/revoke_linked_app_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/member_space_limits/excluded_users/add(record {} payload, Post2TeamMember_space_limitsExcluded_usersAddHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/member_space_limits/excluded_users/add`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/member_space_limits/excluded_users/list(record {} payload, Post2TeamMember_space_limitsExcluded_usersListHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/member_space_limits/excluded_users/list`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/member_space_limits/excluded_users/list/'continue(record {} payload, Post2TeamMember_space_limitsExcluded_usersListContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/member_space_limits/excluded_users/list/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/member_space_limits/excluded_users/remove(record {} payload, Post2TeamMember_space_limitsExcluded_usersRemoveHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/member_space_limits/excluded_users/remove`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/member_space_limits/get_custom_quota(record {} payload, Post2TeamMember_space_limitsGet_custom_quotaHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/member_space_limits/get_custom_quota`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/member_space_limits/remove_custom_quota(record {} payload, Post2TeamMember_space_limitsRemove_custom_quotaHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/member_space_limits/remove_custom_quota`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/member_space_limits/set_custom_quota(record {} payload, Post2TeamMember_space_limitsSet_custom_quotaHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/member_space_limits/set_custom_quota`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/add(record {} payload, Post2TeamMembersAddHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/add`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/add/job_status/get(record {} payload, Post2TeamMembersAddJob_statusGetHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/add/job_status/get`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/delete_profile_photo(record {} payload, Post2TeamMembersDelete_profile_photoHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/delete_profile_photo`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/get_info(record {} payload, Post2TeamMembersGet_infoHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/get_info`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/list(record {} payload, Post2TeamMembersListHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/list`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/list/'continue(record {} payload, Post2TeamMembersListContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/list/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/move_former_member_files(record {} payload, Post2TeamMembersMove_former_member_filesHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/move_former_member_files`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/move_former_member_files/job_status/'check(record {} payload, Post2TeamMembersMove_former_member_filesJob_statusCheckHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/move_former_member_files/job_status/check`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/recover(record {} payload, Post2TeamMembersRecoverHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/members/recover`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/remove(record {} payload, Post2TeamMembersRemoveHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/remove`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/remove/job_status/get(record {} payload, Post2TeamMembersRemoveJob_statusGetHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/remove/job_status/get`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/secondary_emails/add(record {} payload, Post2TeamMembersSecondary_emailsAddHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/secondary_emails/add`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/secondary_emails/delete(record {} payload, Post2TeamMembersSecondary_emailsDeleteHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/secondary_emails/delete`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/secondary_emails/resend_verification_emails(record {} payload, Post2TeamMembersSecondary_emailsResend_verification_emailsHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/secondary_emails/resend_verification_emails`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/send_welcome_email(record {} payload, Post2TeamMembersSend_welcome_emailHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/members/send_welcome_email`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/set_admin_permissions(record {} payload, Post2TeamMembersSet_admin_permissionsHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/set_admin_permissions`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/set_profile(record {} payload, Post2TeamMembersSet_profileHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/set_profile`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/set_profile_photo(record {} payload, Post2TeamMembersSet_profile_photoHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/members/set_profile_photo`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/suspend(record {} payload, Post2TeamMembersSuspendHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/members/suspend`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/members/unsuspend(record {} payload, Post2TeamMembersUnsuspendHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/members/unsuspend`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/namespaces/list(record {} payload, Post2TeamNamespacesListHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/namespaces/list`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/namespaces/list/'continue(record {} payload, Post2TeamNamespacesListContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/namespaces/list/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/reports/get_activity(record {} payload, Post2TeamReportsGet_activityHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/reports/get_activity`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/reports/get_devices(record {} payload, Post2TeamReportsGet_devicesHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/reports/get_devices`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/reports/get_membership(record {} payload, Post2TeamReportsGet_membershipHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/reports/get_membership`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/reports/get_storage(record {} payload, Post2TeamReportsGet_storageHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/reports/get_storage`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/activate(record {} payload, Post2TeamTeam_folderActivateHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/activate`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/archive(record {} payload, Post2TeamTeam_folderArchiveHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/archive`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/archive/'check(record {} payload, Post2TeamTeam_folderArchiveCheckHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/archive/check`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/create(record {} payload, Post2TeamTeam_folderCreateHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/create`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/get_info(record {} payload, Post2TeamTeam_folderGet_infoHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/team_folder/get_info`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/list(record {} payload, Post2TeamTeam_folderListHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/list`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/list/'continue(record {} payload, Post2TeamTeam_folderListContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/list/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/permanently_delete(record {} payload, Post2TeamTeam_folderPermanently_deleteHeaders headers = {}) returns json|error { + string resourcePath = string `/2/team/team_folder/permanently_delete`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/rename(record {} payload, Post2TeamTeam_folderRenameHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/rename`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/team_folder/update_sync_settings(record {} payload, Post2TeamTeam_folderUpdate_sync_settingsHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team/team_folder/update_sync_settings`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team/token/get_authenticated_admin(record {} payload, map headers = {}) returns record {}|error { + string resourcePath = string `/2/team/token/get_authenticated_admin`; + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, headers); + } + + resource isolated function post '2/team_log/get_events(record {} payload, Post2Team_logGet_eventsHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team_log/get_events`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/team_log/get_events/'continue(record {} payload, Post2Team_logGet_eventsContinueHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/team_log/get_events/continue`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/users/features/get_values(record {} payload, Post2UsersFeaturesGet_valuesHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/users/features/get_values`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/users/get_account(record {} payload, Post2UsersGet_accountHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/users/get_account`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/users/get_account_batch(record {} payload, Post2UsersGet_account_batchHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/users/get_account_batch`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/users/get_current_account(record {} payload, Post2UsersGet_current_accountHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/users/get_current_account`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } + + resource isolated function post '2/users/get_space_usage(record {} payload, Post2UsersGet_space_usageHeaders headers = {}) returns record {}|error { + string resourcePath = string `/2/users/get_space_usage`; + map httpHeaders = getMapForHeaders(headers); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); + } +} diff --git a/ballerina/types.bal b/ballerina/types.bal new file mode 100644 index 0000000..aab2c7e --- /dev/null +++ b/ballerina/types.bal @@ -0,0 +1,1273 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + +import ballerina/http; + +# Represents the Headers record for the operation: post2FilesCopy_referenceGet +public type Post2FilesCopy_referenceGetHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesRemove_for_team +public type Post2File_propertiesTemplatesRemove_for_teamHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2UsersGet_account +public type Post2UsersGet_accountHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersRemoveJob_statusGet +public type Post2TeamMembersRemoveJob_statusGetHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingUnshare_folder +public type Post2SharingUnshare_folderHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamLegal_holdsRelease_policy +public type Post2TeamLegal_holdsRelease_policyHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingRelinquish_file_membership +public type Post2SharingRelinquish_file_membershipHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingList_file_membersContinue +public type Post2SharingList_file_membersContinueHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingList_file_members +public type Post2SharingList_file_membersHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderActivate +public type Post2TeamTeam_folderActivateHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamLegal_holdsList_held_revisions +public type Post2TeamLegal_holdsList_held_revisionsHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingRevoke_shared_link +public type Post2SharingRevoke_shared_linkHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesUpload +public type Post2FilesUploadHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingRemove_file_member_2 +public type Post2SharingRemove_file_member_2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2UsersFeaturesGet_values +public type Post2UsersFeaturesGet_valuesHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesPropertiesAdd +public type Post2File_propertiesPropertiesAddHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingShare_folder +public type Post2SharingShare_folderHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersGet_info +public type Post2TeamMembersGet_infoHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamLinked_appsList_member_linked_apps +public type Post2TeamLinked_appsList_member_linked_appsHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingGet_folder_metadata +public type Post2SharingGet_folder_metadataHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingGet_file_metadataBatch +public type Post2SharingGet_file_metadataBatchHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesCreate_folder_batch +public type Post2FilesCreate_folder_batchHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamDevicesList_members_devices +public type Post2TeamDevicesList_members_devicesHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2UsersGet_space_usage +public type Post2UsersGet_space_usageHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamNamespacesList +public type Post2TeamNamespacesListHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersRemove +public type Post2TeamMember_space_limitsExcluded_usersRemoveHeaders record { + string? Content\-Type?; +}; + +# Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. +@display {label: "Connection Config"} +public type ConnectionConfig record {| + # Configurations related to client authentication + http:BearerTokenConfig auth; + # The HTTP version understood by the client + http:HttpVersion httpVersion = http:HTTP_2_0; + # Configurations related to HTTP/1.x protocol + ClientHttp1Settings http1Settings?; + # Configurations related to HTTP/2 protocol + http:ClientHttp2Settings http2Settings?; + # The maximum time to wait (in seconds) for a response before closing the connection + decimal timeout = 60; + # The choice of setting `forwarded`/`x-forwarded` header + string forwarded = "disable"; + # Configurations associated with request pooling + http:PoolConfiguration poolConfig?; + # HTTP caching related configurations + http:CacheConfig cache?; + # Specifies the way of handling compression (`accept-encoding`) header + http:Compression compression = http:COMPRESSION_AUTO; + # Configurations associated with the behaviour of the Circuit Breaker + http:CircuitBreakerConfig circuitBreaker?; + # Configurations associated with retrying + http:RetryConfig retryConfig?; + # Configurations associated with inbound response size limits + http:ResponseLimitConfigs responseLimits?; + # SSL/TLS-related options + http:ClientSecureSocket secureSocket?; + # Proxy server related options + http:ProxyConfig proxy?; + # Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default + boolean validation = true; +|}; + +# Represents the Headers record for the operation: post2FilesUnlock_file_batch +public type Post2FilesUnlock_file_batchHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_requestsDelete_all_closed +public type Post2File_requestsDelete_all_closedHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesDelete_batchCheck +public type Post2FilesDelete_batchCheckHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersList +public type Post2TeamMember_space_limitsExcluded_usersListHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsGet_info +public type Post2TeamGroupsGet_infoHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersMove_former_member_filesJob_statusCheck +public type Post2TeamMembersMove_former_member_filesJob_statusCheckHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamReportsGet_activity +public type Post2TeamReportsGet_activityHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingList_shared_links +public type Post2SharingList_shared_linksHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2UsersGet_current_account +public type Post2UsersGet_current_accountHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2AuthTokenFrom_oauth1 +public type Post2AuthTokenFrom_oauth1Headers record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesGet_temporary_upload_link +public type Post2FilesGet_temporary_upload_linkHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamLegal_holdsList_policies +public type Post2TeamLegal_holdsList_policiesHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSuspend +public type Post2TeamMembersSuspendHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2AccountSet_profile_photo +public type Post2AccountSet_profile_photoHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSecondary_emailsResend_verification_emails +public type Post2TeamMembersSecondary_emailsResend_verification_emailsHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingList_folders +public type Post2SharingList_foldersHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingSet_access_inheritance +public type Post2SharingSet_access_inheritanceHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesGet_temporary_link +public type Post2FilesGet_temporary_linkHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsMembersAdd +public type Post2TeamGroupsMembersAddHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesCreate_folder_v2 +public type Post2FilesCreate_folder_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesMove_v2 +public type Post2FilesMove_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersAdd +public type Post2TeamMembersAddHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMember_space_limitsGet_custom_quota +public type Post2TeamMember_space_limitsGet_custom_quotaHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingTransfer_folder +public type Post2SharingTransfer_folderHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamReportsGet_storage +public type Post2TeamReportsGet_storageHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsMembersList +public type Post2TeamGroupsMembersListHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsMembersRemove +public type Post2TeamGroupsMembersRemoveHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamReportsGet_membership +public type Post2TeamReportsGet_membershipHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsCreate +public type Post2TeamGroupsCreateHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesGet_preview +public type Post2FilesGet_previewHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderListContinue +public type Post2TeamTeam_folderListContinueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersAdd +public type Post2TeamMember_space_limitsExcluded_usersAddHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsMembersSet_access_type +public type Post2TeamGroupsMembersSet_access_typeHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2File_propertiesPropertiesOverwrite +public type Post2File_propertiesPropertiesOverwriteHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2AuthTokenRevoke +public type Post2AuthTokenRevokeHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingUnshare_file +public type Post2SharingUnshare_fileHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_requestsList_v2 +public type Post2File_requestsList_v2Headers record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersListContinue +public type Post2TeamMembersListContinueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersRecover +public type Post2TeamMembersRecoverHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamDevicesRevoke_device_session +public type Post2TeamDevicesRevoke_device_sessionHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersListContinue +public type Post2TeamMember_space_limitsExcluded_usersListContinueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderPermanently_delete +public type Post2TeamTeam_folderPermanently_deleteHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsDelete +public type Post2TeamGroupsDeleteHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesPermanently_delete +public type Post2FilesPermanently_deleteHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsListContinue +public type Post2TeamGroupsListContinueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesList_for_user +public type Post2File_propertiesTemplatesList_for_userHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesCreate_folder_batchCheck +public type Post2FilesCreate_folder_batchCheckHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesUpdate_for_team +public type Post2File_propertiesTemplatesUpdate_for_teamHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingModify_shared_link_settings +public type Post2SharingModify_shared_link_settingsHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingGet_file_metadata +public type Post2SharingGet_file_metadataHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersRemove +public type Post2TeamMembersRemoveHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSecondary_emailsDelete +public type Post2TeamMembersSecondary_emailsDeleteHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2File_propertiesPropertiesUpdate +public type Post2File_propertiesPropertiesUpdateHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamLegal_holdsUpdate_policy +public type Post2TeamLegal_holdsUpdate_policyHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesCopy_referenceSave +public type Post2FilesCopy_referenceSaveHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesList_folderContinue +public type Post2FilesList_folderContinueHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSet_profile +public type Post2TeamMembersSet_profileHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesGet_file_lock_batch +public type Post2FilesGet_file_lock_batchHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesGet_for_team +public type Post2File_propertiesTemplatesGet_for_teamHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesList_folderLongpoll +public type Post2FilesList_folderLongpollHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesCopy_batch_v2 +public type Post2FilesCopy_batch_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingUpdate_folder_policy +public type Post2SharingUpdate_folder_policyHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesRemove_for_user +public type Post2File_propertiesTemplatesRemove_for_userHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2Team_logGet_events +public type Post2Team_logGet_eventsHeaders record { + string? Content\-Type?; +}; + +# Provides settings related to HTTP/1.x protocol. +public type ClientHttp1Settings record {| + # Specifies whether to reuse a connection for multiple requests + http:KeepAlive keepAlive = http:KEEPALIVE_AUTO; + # The chunking behaviour of the request + http:Chunking chunking = http:CHUNKING_AUTO; + # Proxy server related options + ProxyConfig proxy?; +|}; + +# Represents the Headers record for the operation: post2FilesList_folder +public type Post2FilesList_folderHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderArchiveCheck +public type Post2TeamTeam_folderArchiveCheckHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2File_propertiesPropertiesSearch +public type Post2File_propertiesPropertiesSearchHeaders record { + string? Authorization?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_requestsListContinue +public type Post2File_requestsListContinueHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMember_space_limitsRemove_custom_quota +public type Post2TeamMember_space_limitsRemove_custom_quotaHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderCreate +public type Post2TeamTeam_folderCreateHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingMount_folder +public type Post2SharingMount_folderHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesUpload_sessionAppend_v2 +public type Post2FilesUpload_sessionAppend_v2Headers record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesSearch_v2 +public type Post2FilesSearch_v2Headers record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesUpload_sessionStart +public type Post2FilesUpload_sessionStartHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingCheck_job_status +public type Post2SharingCheck_job_statusHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderUpdate_sync_settings +public type Post2TeamTeam_folderUpdate_sync_settingsHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamDevicesRevoke_device_session_batch +public type Post2TeamDevicesRevoke_device_session_batchHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingAdd_folder_member +public type Post2SharingAdd_folder_memberHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingRelinquish_folder_membership +public type Post2SharingRelinquish_folder_membershipHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersAddJob_statusGet +public type Post2TeamMembersAddJob_statusGetHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamLinked_appsRevoke_linked_app +public type Post2TeamLinked_appsRevoke_linked_appHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingList_mountable_folders +public type Post2SharingList_mountable_foldersHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2ContactsDelete_manual_contacts +public type Post2ContactsDelete_manual_contactsHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderList +public type Post2TeamTeam_folderListHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingList_file_membersBatch +public type Post2SharingList_file_membersBatchHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_requestsCreate +public type Post2File_requestsCreateHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_requestsGet +public type Post2File_requestsGetHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesLock_file_batch +public type Post2FilesLock_file_batchHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsMembersListContinue +public type Post2TeamGroupsMembersListContinueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2Team_logGet_eventsContinue +public type Post2Team_logGet_eventsContinueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMember_space_limitsSet_custom_quota +public type Post2TeamMember_space_limitsSet_custom_quotaHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsList +public type Post2TeamGroupsListHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSet_admin_permissions +public type Post2TeamMembersSet_admin_permissionsHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingGet_shared_link_file +public type Post2SharingGet_shared_link_fileHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingList_mountable_foldersContinue +public type Post2SharingList_mountable_foldersContinueHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingAdd_file_member +public type Post2SharingAdd_file_memberHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesDelete_batch +public type Post2FilesDelete_batchHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamLegal_holdsList_held_revisions_continue +public type Post2TeamLegal_holdsList_held_revisions_continueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingList_received_files +public type Post2SharingList_received_filesHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesPropertiesSearchContinue +public type Post2File_propertiesPropertiesSearchContinueHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2UsersGet_account_batch +public type Post2UsersGet_account_batchHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesAdd_for_team +public type Post2File_propertiesTemplatesAdd_for_teamHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersList +public type Post2TeamMembersListHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsUpdate +public type Post2TeamGroupsUpdateHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamGroupsJob_statusGet +public type Post2TeamGroupsJob_statusGetHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesExport +public type Post2FilesExportHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesGet_for_user +public type Post2File_propertiesTemplatesGet_for_userHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingList_received_filesContinue +public type Post2SharingList_received_filesContinueHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesMove_batch_v2 +public type Post2FilesMove_batch_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesDownload +public type Post2FilesDownloadHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamLinked_appsList_members_linked_apps +public type Post2TeamLinked_appsList_members_linked_appsHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesRestore +public type Post2FilesRestoreHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesGet_metadata +public type Post2FilesGet_metadataHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesCopy_batchCheck_v2 +public type Post2FilesCopy_batchCheck_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderArchive +public type Post2TeamTeam_folderArchiveHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingCheck_share_job_status +public type Post2SharingCheck_share_job_statusHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSecondary_emailsAdd +public type Post2TeamMembersSecondary_emailsAddHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesSave_urlCheck_job_status +public type Post2FilesSave_urlCheck_job_statusHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamDevicesList_member_devices +public type Post2TeamDevicesList_member_devicesHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamFeaturesGet_values +public type Post2TeamFeaturesGet_valuesHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingUpdate_file_member +public type Post2SharingUpdate_file_memberHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesUpdate_for_user +public type Post2File_propertiesTemplatesUpdate_for_userHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderRename +public type Post2TeamTeam_folderRenameHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingGet_shared_link_metadata +public type Post2SharingGet_shared_link_metadataHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesDelete_v2 +public type Post2FilesDelete_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSend_welcome_email +public type Post2TeamMembersSend_welcome_emailHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2CheckApp +public type Post2CheckAppHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesGet_thumbnail_batch +public type Post2FilesGet_thumbnail_batchHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamLegal_holdsCreate_policy +public type Post2TeamLegal_holdsCreate_policyHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2File_requestsUpdate +public type Post2File_requestsUpdateHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesSave_url +public type Post2FilesSave_urlHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamReportsGet_devices +public type Post2TeamReportsGet_devicesHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2File_propertiesTemplatesAdd_for_user +public type Post2File_propertiesTemplatesAdd_for_userHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesUpload_sessionFinish_batch +public type Post2FilesUpload_sessionFinish_batchHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingList_folder_membersContinue +public type Post2SharingList_folder_membersContinueHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_requestsDelete +public type Post2File_requestsDeleteHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesSearchContinue_v2 +public type Post2FilesSearchContinue_v2Headers record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamLinked_appsRevoke_linked_app_batch +public type Post2TeamLinked_appsRevoke_linked_app_batchHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingCheck_remove_member_job_status +public type Post2SharingCheck_remove_member_job_statusHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamNamespacesListContinue +public type Post2TeamNamespacesListContinueHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2FilesCopy_v2 +public type Post2FilesCopy_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_requestsCount +public type Post2File_requestsCountHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingUnmount_folder +public type Post2SharingUnmount_folderHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingRemove_folder_member +public type Post2SharingRemove_folder_memberHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesList_revisions +public type Post2FilesList_revisionsHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesGet_thumbnail_v2 +public type Post2FilesGet_thumbnail_v2Headers record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Proxy server configurations to be used with the HTTP client endpoint. +public type ProxyConfig record {| + # Host name of the proxy server + string host = ""; + # Proxy server port + int port = 0; + # Proxy server username + string userName = ""; + # Proxy server password + @display {label: "", kind: "password"} + string password = ""; +|}; + +# Represents the Headers record for the operation: post2FilesUpload_sessionFinish +public type Post2FilesUpload_sessionFinishHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2File_propertiesPropertiesRemove +public type Post2File_propertiesPropertiesRemoveHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2SharingUpdate_folder_member +public type Post2SharingUpdate_folder_memberHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesDownload_zip +public type Post2FilesDownload_zipHeaders record { + string? Dropbox\-API\-Arg?; + string? Dropbox\-API\-Path\-Root?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesList_folderGet_latest_cursor +public type Post2FilesList_folderGet_latest_cursorHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesMove_batchCheck_v2 +public type Post2FilesMove_batchCheck_v2Headers record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2FilesUpload_sessionFinish_batchCheck +public type Post2FilesUpload_sessionFinish_batchCheckHeaders record { + string? Dropbox\-API\-Select\-Admin?; + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2ContactsDelete_manual_contacts_batch +public type Post2ContactsDelete_manual_contacts_batchHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersMove_former_member_files +public type Post2TeamMembersMove_former_member_filesHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersUnsuspend +public type Post2TeamMembersUnsuspendHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2SharingList_foldersContinue +public type Post2SharingList_foldersContinueHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; + +# Represents the Headers record for the operation: post2TeamMembersSet_profile_photo +public type Post2TeamMembersSet_profile_photoHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamLegal_holdsGet_policy +public type Post2TeamLegal_holdsGet_policyHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamTeam_folderGet_info +public type Post2TeamTeam_folderGet_infoHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2TeamMembersDelete_profile_photo +public type Post2TeamMembersDelete_profile_photoHeaders record { + string? Content\-Type?; +}; + +# Represents the Headers record for the operation: post2CheckUser +public type Post2CheckUserHeaders record { + string? Dropbox\-API\-Path\-Root?; + string? Content\-Type?; + string? Dropbox\-API\-Select\-User?; +}; diff --git a/ballerina/utils.bal b/ballerina/utils.bal new file mode 100644 index 0000000..99e37b0 --- /dev/null +++ b/ballerina/utils.bal @@ -0,0 +1,36 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + +import ballerina/url; + +type SimpleBasicType string|boolean|int|float|decimal; + +# Get Encoded URI for a given value. +# +# + value - Value to be encoded +# + return - Encoded string +isolated function getEncodedUri(anydata value) returns string { + string|error encoded = url:encode(value.toString(), "UTF8"); + if encoded is string { + return encoded; + } else { + return value.toString(); + } +} + +# Generate header map for given header values. +# +# + headerParam - Headers map +# + return - Returns generated map or error at failure of client initialization +isolated function getMapForHeaders(map headerParam) returns map { + map headerMap = {}; + foreach var [key, value] in headerParam.entries() { + if value is SimpleBasicType[] { + headerMap[key] = from SimpleBasicType data in value + select data.toString(); + } else { + headerMap[key] = value.toString(); + } + } + return headerMap; +} diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index f350ef7..18b95af 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -19,6 +19,6 @@ These changes are done in order to improve the overall usability, and as workaro The following command was used to generate the Ballerina client from the OpenAPI specification. The command should be executed from the repository root directory. ```bash -# TODO: Add OpenAPI CLI command used to generate the client +bal openapi -i docs/spec/openapi.yaml --mode client -o ballerina ``` Note: The license year is hardcoded to 2024, change if necessary. From a20a2c47eb4768da85f162a709a2a95ae11714f5 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Fri, 25 Oct 2024 18:12:22 +0530 Subject: [PATCH 04/15] Update docs/spec/sanitations.md Co-authored-by: Sumudu Nissanka --- docs/spec/sanitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 18b95af..8b01425 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -10,7 +10,7 @@ The OpenAPI specification is obtained from https://www.postman.com/dropbox-api/d These changes are done in order to improve the overall usability, and as workarounds for some known language limitations. [//]: # (TODO: Add sanitation details) -1. Add content-type and schema to each empty content +1. Add a content type and schema to each empty content in the request body. 2. 3. From fe83931c26789905a496c304a1424235c6531788 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Sat, 26 Oct 2024 00:00:02 +0530 Subject: [PATCH 05/15] Add icon, license, and create reusable ref in openapi yaml for requests with empty body --- ballerina/Ballerina.toml | 2 +- ballerina/client.bal | 16 +++++ ballerina/icon.png | Bin 0 -> 3650 bytes ballerina/types.bal | 16 +++++ ballerina/utils.bal | 16 +++++ docs/spec/openapi.yaml | 127 +++++++++------------------------------ 6 files changed, 76 insertions(+), 101 deletions(-) create mode 100644 ballerina/icon.png diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index 3d39602..25293e8 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -6,7 +6,7 @@ version = "0.1.0" license = ["Apache-2.0"] authors = ["Ballerina"] keywords = [] -# icon = "icon.png" # TODO: update icon.png +icon = "icon.png" repository = "https://github.com/ballerina-platform/module-ballerinax-dropbox" [build-options] diff --git a/ballerina/client.bal b/ballerina/client.bal index a7ea31a..587c676 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -1,6 +1,22 @@ // AUTO-GENERATED FILE. DO NOT MODIFY. // This file is auto-generated by the Ballerina OpenAPI tool. +// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com). +// +// WSO2 LLC. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + import ballerina/http; # The powerful, yet simple, Dropbox API allows you to manage and control content and team settings programmatically and extend Dropbox capabilities in new and powerful ways. This is a collection that includes requests to all endpoints in the Dropbox API. diff --git a/ballerina/icon.png b/ballerina/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..d4ef6c6adc02466ac20958d799c4d1a9d80aa62c GIT binary patch literal 3650 zcmeHKiC5EC7ET~mVvr?l+A`peVNqli!aa+} zb*k7vWRoT!#9>Pd1gn)L5EjM6@?()Dgb)l9=bZT~X3lxreeb;ceeb?=?)P5FH#pCO z2fjQ2fj|y=dwKXnAW+)ps-moz>4+MTD>_)5yRSP0(p-VqjoPQMp+tXAEToC2|Choz z67A*h3xQlQg+M4&2xLbwMfm`MkZd53#YhOmxdsB!OQW;TqZJF~-}nTcfkep_e9MrytC8@jtWA=1Un&AOB;xh)w;Q1~(y$uo;N)iZFWaJ}jV~4Fg*ZgIhVjY^U6lmbOWLeJSQnZVJJT zaU7t*g;_+z>6;+(J%aEpIu3OiuABR8yYEPZ*dK6|x$nC=A5X30~lKh*x>R25|B zmr+n+=GU@^=z}A%MN}F9#CWM3{{Qg5aroi}t!#+NJi&V|Hx-3y83BHK8N`jHkX=@X zw}}5zh4pKfRF#cqcGG2<*NdqhT=7PovURuYDbJ7hlZlx6gb`+hHWWuA_jhEB|6~glgKasz}LKO4}{Lo!e9Uab6Jtm`Bg? zWFEPEhj7^Bp&7_;(@FFjYloUdUZwFATdz~d1{IhZn5yQhJEY`JSgz_OaD7u0Kj872xOJzEFDV#Uw@_;`+qkMa5 ztUcY2BgaODiK*3@d)`hG;q#3ly^mF-eMyY{r*=308ht?}=H|+*ZOkZb?PXqtxdj3N?W7s zeSbvE59okb0?NPUXa;v2*}Z-`P-*6O`uP!zF{le^f}S}kdCfqe9d^$idwZXr*F1*$ zc8~a=B?T%pZ%Az(i^I*r^s7k-x9Y~fX?^rp99C5)Kez+3MT9Y7U35}%7c%YpF-wR% za_|8@`_>arB{d#`P;o9Qg+#gEbx_pb;yhonE+>85|p{{Mq>j zt0SN;XaD|9UGRJ1k}rqG2%#7@u4Vfvr6|H4c2DUB32~xmw9PE?&d>aM%6SF-ICMZr z^A76GGuYK3_C9ar;S0#8al)kd6%HeWX8)G?jO7aQ*wG?vYl{1f#xR>8PJKcW5fqlN zW@4F8{u_M?e&{v{;lKY_s&QlmBe7M}d`{sv>(A{AO4pK}B*Gm5P&Z~YH^O4zOsAr4W|M}q4?FE*Eg<;FJ~*@;rU zMOLSc7HTMe_==g|RMwIZc&h&OqumWFqa!2ieQ4}T8R}7keErtlTEj?WOZH9=o!Ik! z;+XWX5g>6rIXa<{?rLC??J%Wj0LYwFw-0J6vX2$VXu+`<8p0SPdOy=5syNk>il%X) z*F5JZa6Z67&SPXk`R{c@bmI6C4Z^VgkJ`VWK#M$=^lptr2U~(mGX}JH&Wb|>cjqFf zrmH=nreNhf{(z7w!xg&n=&)l)xSRyab^U zd&U!(UWgge5M5^bQ-)qXQ!rBTK|flMo+ZAsau z`frg^v@Qc=B6+Z^J+;ZYi}j%J((2Pg0^GFA)|a;_FR*7b@K?1#t{P$~gYcO4A`B_$ zcV_o0O-@&02Qu-SCUa|l)8z=SX}xXjz5g7K$rizKTA7hA8NL~3PK z1o3oKzBfk$;K}%lT2EI?^}LkMs;te92Ytto%lHtuW4IT0rmb|j&sN6&S6%k6w8!M+ zkP%EmM93v2HC-f&ncRpcx1`8e@A?ju2Q1^JOLwcx^8nR$YGv^j1U-Sh^atPoG`YsYZS4`E;aWt_nJ4@92 zOJ{ub*J&`77pp2WdWi!p`FF=Z6}n}*7-ZeKw6b4RJsP2sF(uSniMxGIuRC{uEI;j` zo~1mC?3#_rpT+6h>;a}1qsqjN#q(fEG86Mqs1d{^;-iBA@5t&otx@jr9 zWPk3+nN>pjt;K+ML-19iri+DJW;Ukm&F^%Hh^nZOcS7o3^Le9@IP zr)%y;Bicqn zgy^2}NCEm#@(MS7YA#~_+R4o0-~|Ol-Tu=e>|pqVyhk$;jMy>MDr)urKQ7BRcyv+VIVjpv5R$*dcV-)W^06?i@II8K9%|0=G>TKBW^#edEDO~!92w9rXR z9cyp!<4kszz^OH1_gq2#pZ1bXL7yttz+Q2{a8-GDqbbymVfRquhakoS1r-?(HR0=H z^w1*cbMmUEIAv(PR&g?pY;CwQ5{v(uW87JiMP0h_IMdEG?ilp-l4&e*y#XKA+EiXk zf!~rs&4DlEt%qMpo;LPc#+(HCACrvi@9H8^b@@^N&_y~GTkKh{n_MpJ;{op`Jd!x( z#b-g$o?NQ&rbdh3`3dTrDQ$WF3OeH|_HOjf z(G?Wk?I=t_qfI9|=KFh%GH0A4S>tI+k2LyJ!|SsTnms*Gg5z8o*@ZAQ$kANSK;k1Z zI%5G_fV8=2=gP4(ehWkmv-d4wGkRPcG8YG<9r871VO{oM^^b7swn?NgHaGGB&{^h+ z&iNQCC~%@)J}If_nA|HekJUUur%cvK^W&*kF~$qQ9g#+WGW>Ft!bLT01~z<$gb*TM z-JryA+51}Iit7xB5fuDIZ9_@CTT)(7v0oxTdW`IHu3|GfBftS=oI)pr+Wv2*&2rEg z8wVzRH~|+01@VQ9RHJ$eP}j#I=AW$5DiR`Ax8)`U%=oqPM2E%(P}^E-SQEImfY!6BKy Date: Sat, 26 Oct 2024 00:09:43 +0530 Subject: [PATCH 06/15] Update the ballerina command used in the Sanitation doc --- docs/spec/sanitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 8b01425..192f179 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -19,6 +19,6 @@ These changes are done in order to improve the overall usability, and as workaro The following command was used to generate the Ballerina client from the OpenAPI specification. The command should be executed from the repository root directory. ```bash -bal openapi -i docs/spec/openapi.yaml --mode client -o ballerina +bal openapi -i docs/spec/openapi.yaml --mode client --license docs/license.txt -o ballerina ``` Note: The license year is hardcoded to 2024, change if necessary. From 3fb4ac64c142bd92db3e07faa30bfcfa92e3c3e7 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Sat, 26 Oct 2024 02:12:25 +0530 Subject: [PATCH 07/15] Use OAS JSON generated using https://blog.postman.com/creating-an-openapi-definition-from-a-collection-with-the-postman-api/ and removing the OAS YAML generated using https://p2o.defcon007.com/, and re-generated the client --- ballerina/client.bal | 677 +- ballerina/types.bal | 3464 +++- docs/spec/openapi.json | 35354 +++++++++++++++++++++++++++++++++++++ docs/spec/openapi.yaml | 13244 -------------- docs/spec/sanitations.md | 2 +- 5 files changed, 38239 insertions(+), 14502 deletions(-) create mode 100644 docs/spec/openapi.json delete mode 100644 docs/spec/openapi.yaml diff --git a/ballerina/client.bal b/ballerina/client.bal index 587c676..4c516b4 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -109,7 +109,7 @@ public isolated client class Client { return; } - resource isolated function post '2/'check/app(record {} payload, Post2CheckAppHeaders headers = {}) returns record {}|error { + resource isolated function post '2/'check/app(check_app_body payload, AppHeaders headers = {}) returns inline_response_200_2|error { string resourcePath = string `/2/check/app`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -118,7 +118,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/'check/user(record {} payload, Post2CheckUserHeaders headers = {}) returns record {}|error { + resource isolated function post '2/'check/user(check_user_body payload, UserHeaders headers = {}) returns inline_response_200_2|error { string resourcePath = string `/2/check/user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -127,7 +127,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/account/set_profile_photo(record {} payload, Post2AccountSet_profile_photoHeaders headers = {}) returns record {}|error { + resource isolated function post '2/account/set_profile_photo(account_set_profile_photo_body payload, SetProfilePhotoHeaders headers = {}) returns inline_response_200|error { string resourcePath = string `/2/account/set_profile_photo`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -136,7 +136,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/auth/token/from_oauth1(record {} payload, Post2AuthTokenFrom_oauth1Headers headers = {}) returns record {}|error { + resource isolated function post '2/auth/token/from_oauth1(token_from_oauth1_body payload, TokenFromOauth1Headers headers = {}) returns inline_response_200_1|error { string resourcePath = string `/2/auth/token/from_oauth1`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -145,25 +145,21 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/auth/token/revoke(record {} payload, Post2AuthTokenRevokeHeaders headers = {}) returns json|error { + resource isolated function post '2/auth/token/revoke(TokenRevokeHeaders headers = {}) returns error? { string resourcePath = string `/2/auth/token/revoke`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/contacts/delete_manual_contacts(record {} payload, Post2ContactsDelete_manual_contactsHeaders headers = {}) returns json|error { + resource isolated function post '2/contacts/delete_manual_contacts(DeleteManualContactsHeaders headers = {}) returns error? { string resourcePath = string `/2/contacts/delete_manual_contacts`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/contacts/delete_manual_contacts_batch(record {} payload, Post2ContactsDelete_manual_contacts_batchHeaders headers = {}) returns json|error { + resource isolated function post '2/contacts/delete_manual_contacts_batch(contacts_delete_manual_contacts_batch_body payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { string resourcePath = string `/2/contacts/delete_manual_contacts_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -172,7 +168,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/add(record {} payload, Post2File_propertiesPropertiesAddHeaders headers = {}) returns json|error { + resource isolated function post '2/file_properties/properties/add(properties_add_body payload, PropertiesAddHeaders headers = {}) returns error? { string resourcePath = string `/2/file_properties/properties/add`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -181,7 +177,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/overwrite(record {} payload, Post2File_propertiesPropertiesOverwriteHeaders headers = {}) returns json|error { + resource isolated function post '2/file_properties/properties/overwrite(properties_overwrite_body payload, PropertiesOverwriteHeaders headers = {}) returns error? { string resourcePath = string `/2/file_properties/properties/overwrite`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -190,7 +186,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/remove(record {} payload, Post2File_propertiesPropertiesRemoveHeaders headers = {}) returns json|error { + resource isolated function post '2/file_properties/properties/remove(properties_remove_body payload, PropertiesRemoveHeaders headers = {}) returns error? { string resourcePath = string `/2/file_properties/properties/remove`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -199,7 +195,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/search(record {} payload, Post2File_propertiesPropertiesSearchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/properties/search(properties_search_body payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_3|error { string resourcePath = string `/2/file_properties/properties/search`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -208,7 +204,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/search/'continue(record {} payload, Post2File_propertiesPropertiesSearchContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/properties/search/'continue(search_continue_body payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_3|error { string resourcePath = string `/2/file_properties/properties/search/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -217,7 +213,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/update(record {} payload, Post2File_propertiesPropertiesUpdateHeaders headers = {}) returns json|error { + resource isolated function post '2/file_properties/properties/update(properties_update_body payload, PropertiesUpdateHeaders headers = {}) returns error? { string resourcePath = string `/2/file_properties/properties/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -226,16 +222,15 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/add_for_team(record {} payload, Post2File_propertiesTemplatesAdd_for_teamHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/add_for_team(templates_add_for_team_body payload, map headers = {}) returns inline_response_200_4|error { string resourcePath = string `/2/file_properties/templates/add_for_team`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/add_for_user(record {} payload, Post2File_propertiesTemplatesAdd_for_userHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/add_for_user(templates_add_for_user_body payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_4|error { string resourcePath = string `/2/file_properties/templates/add_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -244,16 +239,15 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/get_for_team(record {} payload, Post2File_propertiesTemplatesGet_for_teamHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/get_for_team(templates_get_for_team_body payload, map headers = {}) returns inline_response_200_5|error { string resourcePath = string `/2/file_properties/templates/get_for_team`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/get_for_user(record {} payload, Post2File_propertiesTemplatesGet_for_userHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/get_for_user(templates_get_for_user_body payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_5|error { string resourcePath = string `/2/file_properties/templates/get_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -262,33 +256,28 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/list_for_team(record {} payload, map headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_6|error { string resourcePath = string `/2/file_properties/templates/list_for_team`; http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/list_for_user(record {} payload, Post2File_propertiesTemplatesList_for_userHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_6|error { string resourcePath = string `/2/file_properties/templates/list_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/remove_for_team(record {} payload, Post2File_propertiesTemplatesRemove_for_teamHeaders headers = {}) returns json|error { + resource isolated function post '2/file_properties/templates/remove_for_team(templates_remove_for_team_body payload, map headers = {}) returns error? { string resourcePath = string `/2/file_properties/templates/remove_for_team`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/remove_for_user(record {} payload, Post2File_propertiesTemplatesRemove_for_userHeaders headers = {}) returns json|error { + resource isolated function post '2/file_properties/templates/remove_for_user(templates_remove_for_user_body payload, TemplatesRemoveForUserHeaders headers = {}) returns error? { string resourcePath = string `/2/file_properties/templates/remove_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -297,16 +286,15 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/update_for_team(record {} payload, Post2File_propertiesTemplatesUpdate_for_teamHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns templates_remove_for_user_body|error { string resourcePath = string `/2/file_properties/templates/update_for_team`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/update_for_user(record {} payload, Post2File_propertiesTemplatesUpdate_for_userHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns templates_remove_for_user_body|error { string resourcePath = string `/2/file_properties/templates/update_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -315,16 +303,14 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/count(record {} payload, Post2File_requestsCountHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/count(CountHeaders headers = {}) returns inline_response_200_7|error { string resourcePath = string `/2/file_requests/count`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/create(record {} payload, Post2File_requestsCreateHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_8|error { string resourcePath = string `/2/file_requests/create`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -333,7 +319,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/delete(record {} payload, Post2File_requestsDeleteHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/2/file_requests/delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -342,16 +328,14 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/delete_all_closed(record {} payload, Post2File_requestsDelete_all_closedHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/2/file_requests/delete_all_closed`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/get(record {} payload, Post2File_requestsGetHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_8|error { string resourcePath = string `/2/file_requests/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -360,7 +344,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/list/'continue(record {} payload, Post2File_requestsListContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/2/file_requests/list/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -369,7 +353,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/list_v2(record {} payload, Post2File_requestsList_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/2/file_requests/list_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -378,7 +362,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/update(record {} payload, Post2File_requestsUpdateHeaders headers = {}) returns record {}|error { + resource isolated function post '2/file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_8|error { string resourcePath = string `/2/file_requests/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -387,7 +371,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_batch/check_v2(record {} payload, Post2FilesCopy_batchCheck_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/2/files/copy_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -396,7 +380,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_batch_v2(record {} payload, Post2FilesCopy_batch_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/2/files/copy_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -405,7 +389,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_reference/get(record {} payload, Post2FilesCopy_referenceGetHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_13|error { string resourcePath = string `/2/files/copy_reference/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -414,7 +398,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_reference/save(record {} payload, Post2FilesCopy_referenceSaveHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_11|error { string resourcePath = string `/2/files/copy_reference/save`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -423,7 +407,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_v2(record {} payload, Post2FilesCopy_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_11|error { string resourcePath = string `/2/files/copy_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -432,7 +416,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/create_folder_batch(record {} payload, Post2FilesCreate_folder_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/2/files/create_folder_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -441,7 +425,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/create_folder_batch/'check(record {} payload, Post2FilesCreate_folder_batchCheckHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/2/files/create_folder_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -450,7 +434,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/create_folder_v2(record {} payload, Post2FilesCreate_folder_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_14|error { string resourcePath = string `/2/files/create_folder_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -459,7 +443,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/delete_batch(record {} payload, Post2FilesDelete_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_16|error { string resourcePath = string `/2/files/delete_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -468,7 +452,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/delete_batch/'check(record {} payload, Post2FilesDelete_batchCheckHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_16|error { string resourcePath = string `/2/files/delete_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -477,7 +461,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/delete_v2(record {} payload, Post2FilesDelete_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_11|error { string resourcePath = string `/2/files/delete_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -486,34 +470,28 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/download(record {} payload, Post2FilesDownloadHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/download(DownloadHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/2/files/download`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/download_zip(record {} payload, Post2FilesDownload_zipHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_14|error { string resourcePath = string `/2/files/download_zip`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/export(record {} payload, Post2FilesExportHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/export(ExportHeaders headers = {}) returns inline_response_200_18|error { string resourcePath = string `/2/files/export`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_file_lock_batch(record {} payload, Post2FilesGet_file_lock_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_19|error { string resourcePath = string `/2/files/get_file_lock_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -522,7 +500,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_metadata(record {} payload, Post2FilesGet_metadataHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_20|error { string resourcePath = string `/2/files/get_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -531,16 +509,14 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_preview(record {} payload, Post2FilesGet_previewHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/2/files/get_preview`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_temporary_link(record {} payload, Post2FilesGet_temporary_linkHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_21|error { string resourcePath = string `/2/files/get_temporary_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -549,7 +525,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_temporary_upload_link(record {} payload, Post2FilesGet_temporary_upload_linkHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_22|error { string resourcePath = string `/2/files/get_temporary_upload_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -558,7 +534,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_thumbnail_batch(record {} payload, Post2FilesGet_thumbnail_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_24|error { string resourcePath = string `/2/files/get_thumbnail_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -567,16 +543,14 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_thumbnail_v2(record {} payload, Post2FilesGet_thumbnail_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_23|error { string resourcePath = string `/2/files/get_thumbnail_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder(record {} payload, Post2FilesList_folderHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_25|error { string resourcePath = string `/2/files/list_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -585,7 +559,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder/'continue(record {} payload, Post2FilesList_folderContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_25|error { string resourcePath = string `/2/files/list_folder/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -594,7 +568,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder/get_latest_cursor(record {} payload, Post2FilesList_folderGet_latest_cursorHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/list_folder/get_latest_cursor(list_folder_get_latest_cursor_body payload, ListFolderGetLatestCursorHeaders headers = {}) returns list_folder_continue_body|error { string resourcePath = string `/2/files/list_folder/get_latest_cursor`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -603,7 +577,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder/longpoll(record {} payload, Post2FilesList_folderLongpollHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_26|error { string resourcePath = string `/2/files/list_folder/longpoll`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -612,7 +586,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_revisions(record {} payload, Post2FilesList_revisionsHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_27|error { string resourcePath = string `/2/files/list_revisions`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -621,7 +595,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/lock_file_batch(record {} payload, Post2FilesLock_file_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_19|error { string resourcePath = string `/2/files/lock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -630,7 +604,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/move_batch/check_v2(record {} payload, Post2FilesMove_batchCheck_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/2/files/move_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -639,7 +613,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/move_batch_v2(record {} payload, Post2FilesMove_batch_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/2/files/move_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -648,7 +622,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/move_v2(record {} payload, Post2FilesMove_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_11|error { string resourcePath = string `/2/files/move_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -657,7 +631,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/permanently_delete(record {} payload, Post2FilesPermanently_deleteHeaders headers = {}) returns json|error { + resource isolated function post '2/files/permanently_delete(files_permanently_delete_body payload, PermanentlyDeleteHeaders headers = {}) returns error? { string resourcePath = string `/2/files/permanently_delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -666,7 +640,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/restore(record {} payload, Post2FilesRestoreHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/2/files/restore`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -675,7 +649,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/save_url(record {} payload, Post2FilesSave_urlHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_28|error { string resourcePath = string `/2/files/save_url`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -684,7 +658,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/save_url/check_job_status(record {} payload, Post2FilesSave_urlCheck_job_statusHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { string resourcePath = string `/2/files/save_url/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -693,7 +667,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/search/continue_v2(record {} payload, Post2FilesSearchContinue_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_30|error { string resourcePath = string `/2/files/search/continue_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -702,7 +676,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/search_v2(record {} payload, Post2FilesSearch_v2Headers headers = {}) returns record {}|error { + resource isolated function post '2/files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_30|error { string resourcePath = string `/2/files/search_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -711,7 +685,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/unlock_file_batch(record {} payload, Post2FilesUnlock_file_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_19|error { string resourcePath = string `/2/files/unlock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -720,43 +694,35 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload(record {} payload, Post2FilesUploadHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/upload(UploadHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/2/files/upload`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/'start(record {} payload, Post2FilesUpload_sessionStartHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_32|error { string resourcePath = string `/2/files/upload_session/start`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/append_v2(record {} payload, Post2FilesUpload_sessionAppend_v2Headers headers = {}) returns json|error { + resource isolated function post '2/files/upload_session/append_v2(UploadSessionAppendHeaders headers = {}) returns error? { string resourcePath = string `/2/files/upload_session/append_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/finish(record {} payload, Post2FilesUpload_sessionFinishHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/2/files/upload_session/finish`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/finish_batch(record {} payload, Post2FilesUpload_sessionFinish_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_31|error { string resourcePath = string `/2/files/upload_session/finish_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -765,7 +731,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/finish_batch/'check(record {} payload, Post2FilesUpload_sessionFinish_batchCheckHeaders headers = {}) returns record {}|error { + resource isolated function post '2/files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_31|error { string resourcePath = string `/2/files/upload_session/finish_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -774,7 +740,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/add_file_member(record {} payload, Post2SharingAdd_file_memberHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_33[]|error { string resourcePath = string `/2/sharing/add_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -783,7 +749,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/add_folder_member(record {} payload, Post2SharingAdd_folder_memberHeaders headers = {}) returns json|error { + resource isolated function post '2/sharing/add_folder_member(sharing_add_folder_member_body payload, AddFolderMemberHeaders headers = {}) returns error? { string resourcePath = string `/2/sharing/add_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -792,7 +758,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/check_job_status(record {} payload, Post2SharingCheck_job_statusHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { string resourcePath = string `/2/sharing/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -801,7 +767,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/check_remove_member_job_status(record {} payload, Post2SharingCheck_remove_member_job_statusHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/sharing/check_remove_member_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -810,7 +776,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/check_share_job_status(record {} payload, Post2SharingCheck_share_job_statusHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_35|error { string resourcePath = string `/2/sharing/check_share_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -819,7 +785,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_file_metadata(record {} payload, Post2SharingGet_file_metadataHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_36|error { string resourcePath = string `/2/sharing/get_file_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -828,7 +794,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_file_metadata/batch(record {} payload, Post2SharingGet_file_metadataBatchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_37[]|error { string resourcePath = string `/2/sharing/get_file_metadata/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -837,7 +803,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_folder_metadata(record {} payload, Post2SharingGet_folder_metadataHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_38|error { string resourcePath = string `/2/sharing/get_folder_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -846,16 +812,14 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_shared_link_file(record {} payload, Post2SharingGet_shared_link_fileHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_39|error { string resourcePath = string `/2/sharing/get_shared_link_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_shared_link_metadata(record {} payload, Post2SharingGet_shared_link_metadataHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_39|error { string resourcePath = string `/2/sharing/get_shared_link_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -864,7 +828,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_file_members(record {} payload, Post2SharingList_file_membersHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_40|error { string resourcePath = string `/2/sharing/list_file_members`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -873,7 +837,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_file_members/'continue(record {} payload, Post2SharingList_file_membersContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_40|error { string resourcePath = string `/2/sharing/list_file_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -882,7 +846,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_file_members/batch(record {} payload, Post2SharingList_file_membersBatchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_41[]|error { string resourcePath = string `/2/sharing/list_file_members/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -891,7 +855,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_folder_members/'continue(record {} payload, Post2SharingList_folder_membersContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_42|error { string resourcePath = string `/2/sharing/list_folder_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -900,7 +864,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_folders(record {} payload, Post2SharingList_foldersHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_43|error { string resourcePath = string `/2/sharing/list_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -909,7 +873,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_folders/'continue(record {} payload, Post2SharingList_foldersContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { string resourcePath = string `/2/sharing/list_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -918,7 +882,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_mountable_folders(record {} payload, Post2SharingList_mountable_foldersHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_43|error { string resourcePath = string `/2/sharing/list_mountable_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -927,7 +891,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_mountable_folders/'continue(record {} payload, Post2SharingList_mountable_foldersContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { string resourcePath = string `/2/sharing/list_mountable_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -936,7 +900,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_received_files(record {} payload, Post2SharingList_received_filesHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_44|error { string resourcePath = string `/2/sharing/list_received_files`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -945,7 +909,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_received_files/'continue(record {} payload, Post2SharingList_received_filesContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_44|error { string resourcePath = string `/2/sharing/list_received_files/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -954,7 +918,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_shared_links(record {} payload, Post2SharingList_shared_linksHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_45|error { string resourcePath = string `/2/sharing/list_shared_links`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -963,7 +927,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/modify_shared_link_settings(record {} payload, Post2SharingModify_shared_link_settingsHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_39|error { string resourcePath = string `/2/sharing/modify_shared_link_settings`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -972,7 +936,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/mount_folder(record {} payload, Post2SharingMount_folderHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_38|error { string resourcePath = string `/2/sharing/mount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -981,7 +945,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/relinquish_file_membership(record {} payload, Post2SharingRelinquish_file_membershipHeaders headers = {}) returns json|error { + resource isolated function post '2/sharing/relinquish_file_membership(sharing_relinquish_file_membership_body payload, RelinquishFileMembershipHeaders headers = {}) returns error? { string resourcePath = string `/2/sharing/relinquish_file_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -990,7 +954,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/relinquish_folder_membership(record {} payload, Post2SharingRelinquish_folder_membershipHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/sharing/relinquish_folder_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -999,7 +963,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/remove_file_member_2(record {} payload, Post2SharingRemove_file_member_2Headers headers = {}) returns record {}|error { + resource isolated function post '2/sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_46|error { string resourcePath = string `/2/sharing/remove_file_member_2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1008,7 +972,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/remove_folder_member(record {} payload, Post2SharingRemove_folder_memberHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_47|error { string resourcePath = string `/2/sharing/remove_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1017,7 +981,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/revoke_shared_link(record {} payload, Post2SharingRevoke_shared_linkHeaders headers = {}) returns json|error { + resource isolated function post '2/sharing/revoke_shared_link(sharing_revoke_shared_link_body payload, RevokeSharedLinkHeaders headers = {}) returns error? { string resourcePath = string `/2/sharing/revoke_shared_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1026,7 +990,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/set_access_inheritance(record {} payload, Post2SharingSet_access_inheritanceHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_35|error { string resourcePath = string `/2/sharing/set_access_inheritance`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1035,7 +999,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/share_folder(record {} payload, Post2SharingShare_folderHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_35|error { string resourcePath = string `/2/sharing/share_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1044,7 +1008,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/transfer_folder(record {} payload, Post2SharingTransfer_folderHeaders headers = {}) returns json|error { + resource isolated function post '2/sharing/transfer_folder(sharing_transfer_folder_body payload, TransferFolderHeaders headers = {}) returns error? { string resourcePath = string `/2/sharing/transfer_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1053,7 +1017,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/unmount_folder(record {} payload, Post2SharingUnmount_folderHeaders headers = {}) returns json|error { + resource isolated function post '2/sharing/unmount_folder(sharing_unmount_folder_body payload, UnmountFolderHeaders headers = {}) returns error? { string resourcePath = string `/2/sharing/unmount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1062,7 +1026,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/unshare_file(record {} payload, Post2SharingUnshare_fileHeaders headers = {}) returns json|error { + resource isolated function post '2/sharing/unshare_file(sharing_unshare_file_body payload, UnshareFileHeaders headers = {}) returns error? { string resourcePath = string `/2/sharing/unshare_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1071,7 +1035,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/unshare_folder(record {} payload, Post2SharingUnshare_folderHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/sharing/unshare_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1080,7 +1044,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/update_file_member(record {} payload, Post2SharingUpdate_file_memberHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/update_file_member(sharing_update_file_member_body payload, UpdateFileMemberHeaders headers = {}) returns record {}|error { string resourcePath = string `/2/sharing/update_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1089,7 +1053,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/update_folder_member(record {} payload, Post2SharingUpdate_folder_memberHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/update_folder_member(sharing_update_folder_member_body payload, UpdateFolderMemberHeaders headers = {}) returns record {}|error { string resourcePath = string `/2/sharing/update_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1098,7 +1062,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/update_folder_policy(record {} payload, Post2SharingUpdate_folder_policyHeaders headers = {}) returns record {}|error { + resource isolated function post '2/sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_38|error { string resourcePath = string `/2/sharing/update_folder_policy`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1107,680 +1071,595 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/team/devices/list_member_devices(record {} payload, Post2TeamDevicesList_member_devicesHeaders headers = {}) returns json|error { + resource isolated function post '2/team/devices/list_member_devices(devices_list_member_devices_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/devices/list_member_devices`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/devices/list_members_devices(record {} payload, Post2TeamDevicesList_members_devicesHeaders headers = {}) returns json|error { + resource isolated function post '2/team/devices/list_members_devices(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/devices/list_members_devices`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/devices/revoke_device_session(record {} payload, Post2TeamDevicesRevoke_device_sessionHeaders headers = {}) returns json|error { + resource isolated function post '2/team/devices/revoke_device_session(devices_revoke_device_session_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/devices/revoke_device_session`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/devices/revoke_device_session_batch(record {} payload, Post2TeamDevicesRevoke_device_session_batchHeaders headers = {}) returns json|error { + resource isolated function post '2/team/devices/revoke_device_session_batch(devices_revoke_device_session_batch_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/devices/revoke_device_session_batch`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/features/get_values(record {} payload, Post2TeamFeaturesGet_valuesHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_70|error { string resourcePath = string `/2/team/features/get_values`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/get_info(record {} payload, map headers = {}) returns record {}|error { + resource isolated function post '2/team/get_info(map headers = {}) returns inline_response_200_71|error { string resourcePath = string `/2/team/get_info`; http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/create(record {} payload, Post2TeamGroupsCreateHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_48|error { string resourcePath = string `/2/team/groups/create`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/delete(record {} payload, Post2TeamGroupsDeleteHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/team/groups/delete`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/get_info(record {} payload, Post2TeamGroupsGet_infoHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_49[]|error { string resourcePath = string `/2/team/groups/get_info`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/job_status/get(record {} payload, Post2TeamGroupsJob_statusGetHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/team/groups/job_status/get`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/list(record {} payload, Post2TeamGroupsListHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_50|error { string resourcePath = string `/2/team/groups/list`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/list/'continue(record {} payload, Post2TeamGroupsListContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_50|error { string resourcePath = string `/2/team/groups/list/continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/add(record {} payload, Post2TeamGroupsMembersAddHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/2/team/groups/members/add`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/list(record {} payload, Post2TeamGroupsMembersListHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_52|error { string resourcePath = string `/2/team/groups/members/list`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/list/'continue(record {} payload, Post2TeamGroupsMembersListContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_52|error { string resourcePath = string `/2/team/groups/members/list/continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/remove(record {} payload, Post2TeamGroupsMembersRemoveHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/2/team/groups/members/remove`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/set_access_type(record {} payload, Post2TeamGroupsMembersSet_access_typeHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_49[]|error { string resourcePath = string `/2/team/groups/members/set_access_type`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/update(record {} payload, Post2TeamGroupsUpdateHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_48|error { string resourcePath = string `/2/team/groups/update`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/create_policy(record {} payload, Post2TeamLegal_holdsCreate_policyHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_53|error { string resourcePath = string `/2/team/legal_holds/create_policy`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/get_policy(record {} payload, Post2TeamLegal_holdsGet_policyHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_53|error { string resourcePath = string `/2/team/legal_holds/get_policy`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/list_held_revisions(record {} payload, Post2TeamLegal_holdsList_held_revisionsHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_54|error { string resourcePath = string `/2/team/legal_holds/list_held_revisions`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/list_held_revisions_continue(record {} payload, Post2TeamLegal_holdsList_held_revisions_continueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_54|error { string resourcePath = string `/2/team/legal_holds/list_held_revisions_continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/list_policies(record {} payload, Post2TeamLegal_holdsList_policiesHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_55|error { string resourcePath = string `/2/team/legal_holds/list_policies`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/release_policy(record {} payload, Post2TeamLegal_holdsRelease_policyHeaders headers = {}) returns json|error { + resource isolated function post '2/team/legal_holds/release_policy(legal_holds_release_policy_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/legal_holds/release_policy`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/update_policy(record {} payload, Post2TeamLegal_holdsUpdate_policyHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_53|error { string resourcePath = string `/2/team/legal_holds/update_policy`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/list_member_linked_apps(record {} payload, Post2TeamLinked_appsList_member_linked_appsHeaders headers = {}) returns json|error { + resource isolated function post '2/team/linked_apps/list_member_linked_apps(linked_apps_list_member_linked_apps_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/linked_apps/list_member_linked_apps`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/list_members_linked_apps(record {} payload, Post2TeamLinked_appsList_members_linked_appsHeaders headers = {}) returns json|error { + resource isolated function post '2/team/linked_apps/list_members_linked_apps(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/linked_apps/list_members_linked_apps`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/revoke_linked_app(record {} payload, Post2TeamLinked_appsRevoke_linked_appHeaders headers = {}) returns json|error { + resource isolated function post '2/team/linked_apps/revoke_linked_app(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/linked_apps/revoke_linked_app`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/revoke_linked_app_batch(record {} payload, Post2TeamLinked_appsRevoke_linked_app_batchHeaders headers = {}) returns json|error { + resource isolated function post '2/team/linked_apps/revoke_linked_app_batch(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/linked_apps/revoke_linked_app_batch`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/add(record {} payload, Post2TeamMember_space_limitsExcluded_usersAddHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_56|error { string resourcePath = string `/2/team/member_space_limits/excluded_users/add`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/list(record {} payload, Post2TeamMember_space_limitsExcluded_usersListHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/2/team/member_space_limits/excluded_users/list`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/list/'continue(record {} payload, Post2TeamMember_space_limitsExcluded_usersListContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/2/team/member_space_limits/excluded_users/list/continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/remove(record {} payload, Post2TeamMember_space_limitsExcluded_usersRemoveHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_56|error { string resourcePath = string `/2/team/member_space_limits/excluded_users/remove`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/get_custom_quota(record {} payload, Post2TeamMember_space_limitsGet_custom_quotaHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { string resourcePath = string `/2/team/member_space_limits/get_custom_quota`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/remove_custom_quota(record {} payload, Post2TeamMember_space_limitsRemove_custom_quotaHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { string resourcePath = string `/2/team/member_space_limits/remove_custom_quota`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/set_custom_quota(record {} payload, Post2TeamMember_space_limitsSet_custom_quotaHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { string resourcePath = string `/2/team/member_space_limits/set_custom_quota`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/add(record {} payload, Post2TeamMembersAddHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_58|error { string resourcePath = string `/2/team/members/add`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/add/job_status/get(record {} payload, Post2TeamMembersAddJob_statusGetHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_58|error { string resourcePath = string `/2/team/members/add/job_status/get`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/delete_profile_photo(record {} payload, Post2TeamMembersDelete_profile_photoHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { string resourcePath = string `/2/team/members/delete_profile_photo`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/get_info(record {} payload, Post2TeamMembersGet_infoHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_60[]|error { string resourcePath = string `/2/team/members/get_info`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/list(record {} payload, Post2TeamMembersListHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_61|error { string resourcePath = string `/2/team/members/list`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/list/'continue(record {} payload, Post2TeamMembersListContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_61|error { string resourcePath = string `/2/team/members/list/continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/move_former_member_files(record {} payload, Post2TeamMembersMove_former_member_filesHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/team/members/move_former_member_files`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/move_former_member_files/job_status/'check(record {} payload, Post2TeamMembersMove_former_member_filesJob_statusCheckHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/team/members/move_former_member_files/job_status/check`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/recover(record {} payload, Post2TeamMembersRecoverHeaders headers = {}) returns json|error { + resource isolated function post '2/team/members/recover(members_recover_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/members/recover`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/remove(record {} payload, Post2TeamMembersRemoveHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/team/members/remove`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/remove/job_status/get(record {} payload, Post2TeamMembersRemoveJob_statusGetHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_34|error { string resourcePath = string `/2/team/members/remove/job_status/get`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/secondary_emails/add(record {} payload, Post2TeamMembersSecondary_emailsAddHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_62|error { string resourcePath = string `/2/team/members/secondary_emails/add`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/secondary_emails/delete(record {} payload, Post2TeamMembersSecondary_emailsDeleteHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_63|error { string resourcePath = string `/2/team/members/secondary_emails/delete`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/secondary_emails/resend_verification_emails(record {} payload, Post2TeamMembersSecondary_emailsResend_verification_emailsHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_64|error { string resourcePath = string `/2/team/members/secondary_emails/resend_verification_emails`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/send_welcome_email(record {} payload, Post2TeamMembersSend_welcome_emailHeaders headers = {}) returns json|error { + resource isolated function post '2/team/members/send_welcome_email(members_send_welcome_email_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/members/send_welcome_email`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/set_admin_permissions(record {} payload, Post2TeamMembersSet_admin_permissionsHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/2/team/members/set_admin_permissions`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/set_profile(record {} payload, Post2TeamMembersSet_profileHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_59|error { string resourcePath = string `/2/team/members/set_profile`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/set_profile_photo(record {} payload, Post2TeamMembersSet_profile_photoHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { string resourcePath = string `/2/team/members/set_profile_photo`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/suspend(record {} payload, Post2TeamMembersSuspendHeaders headers = {}) returns json|error { + resource isolated function post '2/team/members/suspend(members_suspend_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/members/suspend`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/unsuspend(record {} payload, Post2TeamMembersUnsuspendHeaders headers = {}) returns json|error { + resource isolated function post '2/team/members/unsuspend(members_unsuspend_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/members/unsuspend`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/namespaces/list(record {} payload, Post2TeamNamespacesListHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_66|error { string resourcePath = string `/2/team/namespaces/list`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/namespaces/list/'continue(record {} payload, Post2TeamNamespacesListContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_66|error { string resourcePath = string `/2/team/namespaces/list/continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_activity(record {} payload, Post2TeamReportsGet_activityHeaders headers = {}) returns json|error { + resource isolated function post '2/team/reports/get_activity(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/reports/get_activity`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_devices(record {} payload, Post2TeamReportsGet_devicesHeaders headers = {}) returns json|error { + resource isolated function post '2/team/reports/get_devices(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/reports/get_devices`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_membership(record {} payload, Post2TeamReportsGet_membershipHeaders headers = {}) returns json|error { + resource isolated function post '2/team/reports/get_membership(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/reports/get_membership`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_storage(record {} payload, Post2TeamReportsGet_storageHeaders headers = {}) returns json|error { + resource isolated function post '2/team/reports/get_storage(string payload, map headers = {}) returns error? { string resourcePath = string `/2/team/reports/get_storage`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + request.setPayload(payload, "text/plain"); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/activate(record {} payload, Post2TeamTeam_folderActivateHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/2/team/team_folder/activate`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/archive(record {} payload, Post2TeamTeam_folderArchiveHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_68|error { string resourcePath = string `/2/team/team_folder/archive`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/archive/'check(record {} payload, Post2TeamTeam_folderArchiveCheckHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_68|error { string resourcePath = string `/2/team/team_folder/archive/check`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/create(record {} payload, Post2TeamTeam_folderCreateHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/2/team/team_folder/create`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/get_info(record {} payload, Post2TeamTeam_folderGet_infoHeaders headers = {}) returns json|error { + resource isolated function post '2/team/team_folder/get_info(team_folder_get_info_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/team_folder/get_info`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/list(record {} payload, Post2TeamTeam_folderListHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_69|error { string resourcePath = string `/2/team/team_folder/list`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/list/'continue(record {} payload, Post2TeamTeam_folderListContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_69|error { string resourcePath = string `/2/team/team_folder/list/continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/permanently_delete(record {} payload, Post2TeamTeam_folderPermanently_deleteHeaders headers = {}) returns json|error { + resource isolated function post '2/team/team_folder/permanently_delete(team_folder_permanently_delete_body payload, map headers = {}) returns error? { string resourcePath = string `/2/team/team_folder/permanently_delete`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/rename(record {} payload, Post2TeamTeam_folderRenameHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/2/team/team_folder/rename`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/update_sync_settings(record {} payload, Post2TeamTeam_folderUpdate_sync_settingsHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/2/team/team_folder/update_sync_settings`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/token/get_authenticated_admin(record {} payload, map headers = {}) returns record {}|error { + resource isolated function post '2/team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_72|error { string resourcePath = string `/2/team/token/get_authenticated_admin`; http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team_log/get_events(record {} payload, Post2Team_logGet_eventsHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_73|error { string resourcePath = string `/2/team_log/get_events`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team_log/get_events/'continue(record {} payload, Post2Team_logGet_eventsContinueHeaders headers = {}) returns record {}|error { + resource isolated function post '2/team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_73|error { string resourcePath = string `/2/team_log/get_events/continue`; - map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/users/features/get_values(record {} payload, Post2UsersFeaturesGet_valuesHeaders headers = {}) returns record {}|error { + resource isolated function post '2/users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_74|error { string resourcePath = string `/2/users/features/get_values`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1789,7 +1668,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_account(record {} payload, Post2UsersGet_accountHeaders headers = {}) returns record {}|error { + resource isolated function post '2/users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_75|error { string resourcePath = string `/2/users/get_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1798,7 +1677,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_account_batch(record {} payload, Post2UsersGet_account_batchHeaders headers = {}) returns record {}|error { + resource isolated function post '2/users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_76[]|error { string resourcePath = string `/2/users/get_account_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1807,21 +1686,17 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_current_account(record {} payload, Post2UsersGet_current_accountHeaders headers = {}) returns record {}|error { + resource isolated function post '2/users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_77|error { string resourcePath = string `/2/users/get_current_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_space_usage(record {} payload, Post2UsersGet_space_usageHeaders headers = {}) returns record {}|error { + resource isolated function post '2/users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_78|error { string resourcePath = string `/2/users/get_space_usage`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } } diff --git a/ballerina/types.bal b/ballerina/types.bal index c6ecda8..71e06e7 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -19,174 +19,1507 @@ import ballerina/http; -# Represents the Headers record for the operation: post2FilesCopy_referenceGet -public type Post2FilesCopy_referenceGetHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: createFolderBatch +public type CreateFolderBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesRemove_for_team -public type Post2File_propertiesTemplatesRemove_for_teamHeaders record { - string? Content\-Type?; +public type finish_batch_check_body record { + string async_job_id?; }; -# Represents the Headers record for the operation: post2UsersGet_account -public type Post2UsersGet_accountHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_31_file_lock_info record { + string created?; + boolean is_lockholder?; + string lockholder_name?; }; -# Represents the Headers record for the operation: post2TeamMembersRemoveJob_statusGet -public type Post2TeamMembersRemoveJob_statusGetHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: checkRemoveMemberJobStatus +public type CheckRemoveMemberJobStatusHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2SharingUnshare_folder -public type Post2SharingUnshare_folderHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: listContinue +public type ListContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2TeamLegal_holdsRelease_policy -public type Post2TeamLegal_holdsRelease_policyHeaders record { - string? Content\-Type?; +public type '2sharinglist_file_membersbatch_result_members_platform_type record { + string \.tag?; }; -# Represents the Headers record for the operation: post2SharingRelinquish_file_membership -public type Post2SharingRelinquish_file_membershipHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_15_metadata_sharing_info record { + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; }; -# Represents the Headers record for the operation: post2SharingList_file_membersContinue -public type Post2SharingList_file_membersContinueHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_30_matches record { + inline_response_200_30_metadata metadata?; }; -# Represents the Headers record for the operation: post2SharingList_file_members -public type Post2SharingList_file_membersHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type list_folder_longpoll_body record { + string cursor?; + decimal timeout?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderActivate -public type Post2TeamTeam_folderActivateHeaders record { - string? Content\-Type?; +public type inline_response_200_73_event_category record { + string \.tag?; }; -# Represents the Headers record for the operation: post2TeamLegal_holdsList_held_revisions -public type Post2TeamLegal_holdsList_held_revisionsHeaders record { - string? Content\-Type?; +public type '2sharinglist_file_membersbatch_result_members_invitee record { + string \.tag?; + string email?; }; -# Represents the Headers record for the operation: post2SharingRevoke_shared_link -public type Post2SharingRevoke_shared_linkHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_39_team_member_info record { + string display_name?; + string member_id?; + '2sharingget_file_metadatabatch_result_owner_team team_info?; }; -# Represents the Headers record for the operation: post2FilesUpload -public type Post2FilesUploadHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type groups_create_body record { + boolean add_creator_as_owner?; + string group_external_id?; + string group_name?; }; -# Represents the Headers record for the operation: post2SharingRemove_file_member_2 -public type Post2SharingRemove_file_member_2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type legal_holds_update_policy_body record { + string id?; + string[] members?; }; -# Represents the Headers record for the operation: post2UsersFeaturesGet_values -public type Post2UsersFeaturesGet_valuesHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_21_metadata record { + string client_modified?; + string content_hash?; + inline_response_200_31_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_31_sharing_info sharing_info?; + decimal size?; }; -# Represents the Headers record for the operation: post2File_propertiesPropertiesAdd -public type Post2File_propertiesPropertiesAddHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type delete_batch_check_body record { + string async_job_id?; }; -# Represents the Headers record for the operation: post2SharingShare_folder -public type Post2SharingShare_folderHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_path record { + string contextual?; + inline_response_200_73_path_namespace_relative namespace_relative?; }; -# Represents the Headers record for the operation: post2TeamMembersGet_info -public type Post2TeamMembersGet_infoHeaders record { - string? Content\-Type?; +public type '2teamgroupsget_info_profile_secondary_emails record { + string email?; + boolean is_verified?; }; -# Represents the Headers record for the operation: post2TeamLinked_appsList_member_linked_apps -public type Post2TeamLinked_appsList_member_linked_appsHeaders record { - string? Content\-Type?; +public type '2filesupload_sessionfinish_batch_cursor record { + decimal offset?; + string session_id?; }; -# Represents the Headers record for the operation: post2SharingGet_folder_metadata -public type Post2SharingGet_folder_metadataHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type member_space_limits_set_custom_quota_body record { + '2teammember_space_limitsset_custom_quota_users_and_quotas[] users_and_quotas?; }; -# Represents the Headers record for the operation: post2SharingGet_file_metadataBatch -public type Post2SharingGet_file_metadataBatchHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: moveBatch +public type MoveBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2FilesCreate_folder_batch -public type Post2FilesCreate_folder_batchHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type sharing_list_folders_body record { + anydata[] actions?; + decimal 'limit?; }; -# Represents the Headers record for the operation: post2TeamDevicesList_members_devices -public type Post2TeamDevicesList_members_devicesHeaders record { - string? Content\-Type?; +public type job_status_get_body_1 record { + string async_job_id?; }; -# Represents the Headers record for the operation: post2UsersGet_space_usage -public type Post2UsersGet_space_usageHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type job_status_get_body_2 record { + string async_job_id?; }; -# Represents the Headers record for the operation: post2TeamNamespacesList -public type Post2TeamNamespacesListHeaders record { - string? Content\-Type?; +public type sharing_remove_folder_member_body record { + boolean leave_a_copy?; + '2sharingadd_file_member_members member?; + string shared_folder_id?; }; -# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersRemove -public type Post2TeamMember_space_limitsExcluded_usersRemoveHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: getSharedLinkFile +public type GetSharedLinkFileHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-user?; +}; + +public type files_search_v2_body record { + boolean include_highlights?; + string query?; +}; + +# Represents the Headers record for the operation: setProfilePhoto +public type SetProfilePhotoHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type templates_remove_for_team_body record { + string template_id?; +}; + +public type '2file_requestsupdate_deadline record { + string \.tag?; + string allow_late_uploads?; + string deadline?; +}; + +public type file_requests_get_body record { + string id?; +}; + +public type templates_update_for_user_body record { + '2file_propertiestemplatesadd_for_team_fields[] add_fields?; + string description?; + string name?; + string template_id?; +}; + +public type inline_response_200_77_team_sharing_policies_shared_link_create_policy record { + string \.tag?; +}; + +public type team_folder_permanently_delete_body record { + string team_folder_id?; +}; + +public type files_list_folder_body record { + boolean include_deleted?; + boolean include_has_explicit_shared_members?; + boolean include_media_info?; + boolean include_mounted_folders?; + boolean include_non_downloadable_files?; + string path?; + boolean recursive?; +}; + +public type sharing_list_shared_links_body record { + string cursor?; +}; + +public type templates_update_for_team_body record { + '2file_propertiestemplatesadd_for_team_fields[] add_fields?; + string description?; + string name?; + string template_id?; +}; + +# Represents the Headers record for the operation: propertiesRemove +public type PropertiesRemoveHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type '2sharinglist_file_membersbatch_result_members_invitees record { + '2sharingget_file_metadatabatch_result_access_type access_type?; + '2sharinglist_file_membersbatch_result_members_invitee invitee?; + boolean is_inherited?; + anydata[] permissions?; +}; + +public type templates_remove_for_user_body record { + string template_id?; +}; + +public type list_folders_continue_body record { + string cursor?; +}; + +# Provides settings related to HTTP/1.x protocol. +public type ClientHttp1Settings record {| + # Specifies whether to reuse a connection for multiple requests + http:KeepAlive keepAlive = http:KEEPALIVE_AUTO; + # The chunking behaviour of the request + http:Chunking chunking = http:CHUNKING_AUTO; + # Proxy server related options + ProxyConfig proxy?; +|}; + +public type '2teammembersadd_new_members record { + string member_email?; + string member_external_id?; + string member_given_name?; + string member_surname?; + string role?; + boolean send_welcome_email?; +}; + +public type inline_response_200_42_users record { + '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inherited?; + anydata[] permissions?; + '2sharinglist_file_membersbatch_result_members_user user?; +}; + +# Represents the Headers record for the operation: getTemporaryLink +public type GetTemporaryLinkHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type sharing_update_folder_member_body record { + string access_level?; + '2sharingadd_file_member_members member?; + string shared_folder_id?; +}; + +public type '2file_propertiespropertiesadd_property_groups record { + '2file_propertiespropertiesadd_fields[] fields?; + string template_id?; +}; + +# Represents the Headers record for the operation: getThumbnailBatch +public type GetThumbnailBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: listFileMembersContinue +public type ListFileMembersContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_62_results record { + string \.tag?; + '2teamgroupsget_info_profile_secondary_emails success?; + string unavailable?; +}; + +# Represents the Headers record for the operation: getTemporaryUploadLink +public type GetTemporaryUploadLinkHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type '2sharingget_file_metadatabatch_result_policy_acl_update_policy record { + string \.tag?; +}; + +public type file_requests_update_body record { + '2file_requestsupdate_deadline deadline?; + string destination?; + string id?; + boolean open?; + string title?; +}; + +public type secondary_emails_add_body record { + '2teammemberssecondary_emailsadd_new_secondary_emails[] new_secondary_emails?; +}; + +public type sharing_add_folder_member_body record { + string custom_message?; + '2sharingadd_folder_member_members[] members?; + boolean quiet?; + string shared_folder_id?; +}; + +# Represents the Headers record for the operation: listMountableFoldersContinue +public type ListMountableFoldersContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: permanentlyDelete +public type PermanentlyDeleteHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type get_events_continue_body record { + string cursor?; +}; + +public type team_folder_list_body record { + decimal 'limit?; +}; + +public type list_folder_continue_body record { + string cursor?; +}; + +# Represents the Headers record for the operation: listMountableFolders +public type ListMountableFoldersHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type sharing_get_file_metadata_body record { + anydata[] actions?; + string file?; +}; + +# Represents the Headers record for the operation: listFolders +public type ListFoldersHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type file_requests_delete_body record { + string[] ids?; +}; + +public type members_set_profile_body record { + string new_email?; + string new_surname?; + members_send_welcome_email_body user?; +}; + +public type inline_response_200_73_origin_geo_location record { + string city?; + string country?; + string ip_address?; + string region?; +}; + +# Represents the Headers record for the operation: transferFolder +public type TransferFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type contacts_delete_manual_contacts_batch_body record { + string[] email_addresses?; +}; + +public type '2sharingget_file_metadatabatch_result_policy_resolved_member_policy record { + string \.tag?; +}; + +public type files_get_temporary_link_body record { + string path?; +}; + +public type '2teamteam_folderupdate_sync_settings_content_sync_settings record { + string id?; + string sync_setting?; +}; + +public type inline_response_200_74_paper_as_files record { + string \.tag?; + boolean enabled?; +}; + +public type '2sharingmodify_shared_link_settings_settings record { + string access?; + string audience?; + string requested_visibility?; +}; + +public type files_save_url_body record { + string path?; + string url?; +}; + +public type archive_check_body record { + string async_job_id?; +}; + +public type '2teamgroupsmembersadd_members record { + string access_type?; + '2teamgroupsmembersadd_user user?; +}; + +public type '2teammembersget_info_role record { + string \.tag?; +}; + +# Represents the Headers record for the operation: listFoldersContinue +public type ListFoldersContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type excluded_users_list_body record { + decimal 'limit?; +}; + +# Represents the Headers record for the operation: getCurrentAccount +public type GetCurrentAccountHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type member_space_limits_remove_custom_quota_body record { + '2teamgroupsmembersadd_user[] users?; +}; + +# Represents the Headers record for the operation: propertiesUpdate +public type PropertiesUpdateHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type list_continue_body record { + string cursor?; +}; + +public type sharing_get_folder_metadata_body record { + anydata[] actions?; + string shared_folder_id?; +}; + +public type files_get_thumbnail_batch_body record { + '2filesget_thumbnail_batch_entries[] entries?; +}; + +public type files_create_folder_v2_body record { + boolean autorename?; + string path?; +}; + +# Represents the Headers record for the operation: addFolderMember +public type AddFolderMemberHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_77_account_type record { + string \.tag?; +}; + +public type inline_response_200_19_entries record { + string \.tag?; + inline_response_200_19_lock 'lock?; + inline_response_200_30_metadata_metadata metadata?; +}; + +# Represents the Headers record for the operation: checkJobStatus +public type CheckJobStatusHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_66_namespace_type record { + string \.tag?; +}; + +public type members_suspend_body record { + members_send_welcome_email_body user?; + boolean wipe_data?; +}; + +public type '2usersfeaturesget_values_features record { + string \.tag?; +}; + +# Represents the Headers record for the operation: propertiesSearch +public type PropertiesSearchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type legal_holds_create_policy_body record { + string end_date?; + string[] members?; + string name?; + string start_date?; +}; + +public type '2filesupload_sessionfinish_batch_entries record { + '2filesget_temporary_upload_link_commit_info 'commit?; + '2filesupload_sessionfinish_batch_cursor cursor?; +}; + +# Represents the Headers record for the operation: move +public type MoveHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_44_entries record { + '2sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + '2sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + '2sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; +}; + +public type sharing_relinquish_folder_membership_body record { + boolean leave_a_copy?; + string shared_folder_id?; +}; + +public type '2filesget_thumbnail_batch_entries record { + string format?; + string mode?; + string path?; + string size?; +}; + +# Represents the Headers record for the operation: getAccountBatch +public type GetAccountBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type members_add_body record { + groups_delete_body group?; + '2teamgroupsmembersadd_members[] members?; + boolean return_members?; +}; + +public type inline_response_200_73_actor_user_team record { + string display_name?; +}; + +public type templates_get_for_team_body record { + string template_id?; +}; + +# Represents the Headers record for the operation: deleteBatch +public type DeleteBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: unmountFolder +public type UnmountFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_5_type record { + string \.tag?; +}; + +public type files_get_file_lock_batch_body record { + '2filesget_file_lock_batch_entries[] entries?; +}; + +public type files_restore_body record { + string path?; + string rev?; +}; + +# Represents the Headers record for the operation: propertiesAdd +public type PropertiesAddHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: revokeSharedLink +public type RevokeSharedLinkHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: copyReferenceGet +public type CopyReferenceGetHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type namespaces_list_body record { + decimal 'limit?; +}; + +# Represents the Headers record for the operation: listReceivedFiles +public type ListReceivedFilesHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type groups_update_body record { + groups_delete_body group?; + string new_group_external_id?; + string new_group_management_type?; + string new_group_name?; + boolean return_members?; +}; + +public type inline_response_200_54_entries record { + string author_email?; + string author_member_id?; + '2teamgroupsget_info_profile_status author_member_status?; + string content_hash?; + string file_type?; + string new_filename?; + string original_file_path?; + string original_revision_id?; + string server_modified?; + decimal size?; +}; + +public type team_folder_activate_body record { + string team_folder_id?; +}; + +public type members_add_body_1 record { + boolean force_async?; + '2teammembersadd_new_members[] new_members?; +}; + +# Represents the Headers record for the operation: templatesGetForUser +public type TemplatesGetForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type '2teammemberssecondary_emailsadd_new_secondary_emails record { + string[] secondary_emails?; + '2teamgroupsmembersadd_user user?; +}; + +public type sharing_list_received_files_body record { + anydata[] actions?; + decimal 'limit?; +}; + +public type legal_holds_get_policy_body record { + string id?; +}; + +# Represents the Headers record for the operation: lockFileBatch +public type LockFileBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_68_sync_setting record { + string \.tag?; +}; + +public type '2sharingadd_folder_member_member record { + string \.tag?; + string dropbox_id?; + string email?; +}; + +public type inline_response_200_64_results_1 record { + string \.tag?; + inline_response_200_64_results[] results?; + members_send_welcome_email_body user?; +}; + +public type inline_response_200_31_entries record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_31_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_31_sharing_info sharing_info?; + decimal size?; +}; + +# Represents the Headers record for the operation: getFileMetadataBatch +public type GetFileMetadataBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: featuresGetValues1 +public type FeaturesGetValues1Headers record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: copyReferenceSave +public type CopyReferenceSaveHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: templatesUpdateForUser +public type TemplatesUpdateForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_25_entries record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_31_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_25_sharing_info sharing_info?; + decimal size?; +}; + +public type list_mountable_folders_continue_body record { + string cursor?; +}; + +public type search_continue_body record { + string cursor?; +}; + +public type member_space_limits_get_custom_quota_body record { + '2teamgroupsmembersadd_user[] users?; +}; + +public type legal_holds_list_policies_body record { + boolean include_released?; +}; + +public type '2filesget_temporary_upload_link_commit_info record { + boolean autorename?; + string mode?; + boolean mute?; + string path?; + boolean strict_conflict?; +}; + +public type '2teamgroupsmembersadd_user record { + string \.tag?; + string team_member_id?; +}; + +public type inline_response_200_55_members record { + decimal permanently_deleted_users?; + string[] team_member_ids?; +}; + +public type inline_response_200_62_results_1 record { + string \.tag?; + members_send_welcome_email_body invalid_user?; + inline_response_200_62_results[] results?; + members_send_welcome_email_body user?; +}; + +# Represents the Headers record for the operation: getFileLockBatch +public type GetFileLockBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: downloadZip +public type DownloadZipHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: relinquishFolderMembership +public type RelinquishFolderMembershipHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_9_deadline_allow_late_uploads record { + string \.tag?; +}; + +# Represents the Headers record for the operation: listFolderLongpoll +public type ListFolderLongpollHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type '2accountset_profile_photo_photo record { + string \.tag?; + string base64_data?; +}; + +public type team_folder_create_body record { + string name?; + string sync_setting?; +}; + +# Represents the Headers record for the operation: tokenRevoke +public type TokenRevokeHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type members_remove_body_1 record { + boolean keep_account?; + boolean retain_team_shares?; + '2teamgroupsmembersadd_user transfer_admin_id?; + '2teamgroupsmembersadd_user transfer_dest_id?; + '2teamgroupsmembersadd_user user?; + boolean wipe_data?; +}; + +public type '2teamgroupsget_info_access_type record { + string \.tag?; +}; + +public type secondary_emails_delete_body record { + '2teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_delete?; +}; + +public type inline_response_200_73_user record { + string \.tag?; + string account_id?; + string display_name?; + string email?; + string member_external_id?; + inline_response_200_73_actor_user_team team?; + string team_member_id?; +}; + +# Represents the Headers record for the operation: list +public type ListHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_35_link_metadata_action record { + string \.tag?; +}; + +public type inline_response_200_43_entries record { + inline_response_200_35_access_inheritance access_inheritance?; + '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inside_team_folder?; + boolean is_team_folder?; + inline_response_200_35_link_metadata link_metadata?; + string name?; + string path_lower?; + anydata[] permissions?; + '2sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string shared_folder_id?; + string time_invited?; +}; + +# Represents the Headers record for the operation: uploadSessionStart +public type UploadSessionStartHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_73_origin_access_method record { + string \.tag?; + inline_response_200_73_origin_access_method_end_user end_user?; +}; + +public type '2teammember_space_limitsset_custom_quota_users_and_quotas record { + decimal quota_gb?; + '2teamgroupsmembersadd_user user?; +}; + +public type members_remove_body record { + groups_delete_body group?; + boolean return_members?; + '2teamgroupsmembersadd_user[] users?; +}; + +# Represents the Headers record for the operation: updateFileMember +public type UpdateFileMemberHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_73_actor_user record { + string \.tag?; + string account_id?; + string display_name?; + string email?; + string member_external_id?; + inline_response_200_73_actor_user_team team?; + string team_member_id?; +}; + +# Represents the Headers record for the operation: listReceivedFilesContinue +public type ListReceivedFilesContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type sharing_unshare_file_body record { + string file?; +}; + +public type '2sharingget_file_metadatabatch_result_owner_team record { + string id?; + string name?; +}; + +public type inline_response_200_24_entries record { + string \.tag?; + inline_response_200_21_metadata metadata?; + string thumbnail?; +}; + +public type sharing_add_file_member_body record { + string access_level?; + boolean add_message_as_comment?; + string custom_message?; + string file?; + '2sharingadd_file_member_members[] members?; + boolean quiet?; +}; + +# Represents the Headers record for the operation: removeFileMember2 +public type RemoveFileMember2Headers record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type move_batch_check_v2_body record { + string async_job_id?; +}; + +public type sharing_modify_shared_link_settings_body record { + boolean remove_expiration?; + '2sharingmodify_shared_link_settings_settings settings?; + string url?; +}; + +public type inline_response_200_9 record { + inline_response_200_9_file_requests[] file_requests?; +}; + +public type inline_response_200_5 record { + string description?; + inline_response_200_5_fields[] fields?; + string name?; +}; + +public type inline_response_200_6 record { + string[] template_ids?; +}; + +public type inline_response_200_7 record { + decimal file_request_count?; +}; + +public type inline_response_200_8 record { + string created?; + inline_response_200_9_deadline deadline?; + string destination?; + decimal file_count?; + string id?; + boolean is_open?; + string title?; + string url?; +}; + +# Represents the Headers record for the operation: updateFolderPolicy +public type UpdateFolderPolicyHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_77_root_info record { + string \.tag?; + string home_namespace_id?; + string root_namespace_id?; +}; + +public type inline_response_200_39_link_permissions record { + boolean can_revoke?; + inline_response_200_35_link_metadata_audience_options resolved_visibility?; + inline_response_200_39_link_permissions_revoke_failure_reason revoke_failure_reason?; +}; + +public type inline_response_200_68_content_sync_settings record { + string id?; + inline_response_200_68_sync_setting sync_setting?; +}; + +public type sharing_update_folder_policy_body record { + string acl_update_policy?; + string member_policy?; + string shared_folder_id?; + string shared_link_policy?; +}; + +public type properties_overwrite_body record { + string path?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; +}; + +# Represents the Headers record for the operation: modifySharedLinkSettings +public type ModifySharedLinkSettingsHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type sharing_list_file_members_body record { + string file?; + boolean include_inherited?; + decimal 'limit?; +}; + +# Represents the Headers record for the operation: saveUrl +public type SaveUrlHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type account_set_profile_photo_body record { + '2accountset_profile_photo_photo photo?; +}; + +public type sharing_update_file_member_body record { + string access_level?; + string file?; + '2sharingadd_file_member_members member?; +}; + +public type inline_response_200_1 record { + string oauth2_token?; +}; + +public type inline_response_200_2 record { + string result?; +}; + +public type inline_response_200_3 record { + inline_response_200_3_matches[] matches?; +}; + +public type files_copy_batch_v2_body record { + boolean autorename?; + '2filescopy_batch_v2_entries[] entries?; +}; + +public type inline_response_200_4 record { + string template_id?; +}; + +public type '2file_propertiespropertiesupdate_update_property_groups record { + '2file_propertiespropertiesadd_fields[] add_or_update_fields?; + anydata[] remove_fields?; + string template_id?; +}; + +public type members_set_profile_photo_body record { + '2accountset_profile_photo_photo photo?; + members_send_welcome_email_body user?; +}; + +public type inline_response_200_11 record { + inline_response_200_30_metadata_metadata metadata?; +}; + +public type inline_response_200_10 record { + string cursor?; + inline_response_200_9_file_requests[] file_requests?; + boolean has_more?; +}; + +public type members_recover_body record { + '2teamgroupsmembersadd_user user?; +}; + +public type inline_response_200_13 record { + string copy_reference?; + string expires?; + inline_response_200_30_metadata_metadata metadata?; +}; + +public type inline_response_200_12 record { + string \.tag?; + inline_response_200_12_entries[] entries?; +}; + +public type inline_response_200_19 record { + inline_response_200_19_entries[] entries?; +}; + +# Represents the Headers record for the operation: user +public type UserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_18 record { + inline_response_200_18_export_metadata export_metadata?; + inline_response_200_21_metadata file_metadata?; +}; + +public type inline_response_200_61_members record { + '2teammembersget_info_profile profile?; + '2teammembersget_info_role role?; +}; + +public type files_list_revisions_body record { + decimal 'limit?; + string mode?; + string path?; +}; + +public type inline_response_200_12_entries record { + string \.tag?; + inline_response_200_30_metadata_metadata success?; +}; + +public type inline_response_200_15 record { + string \.tag?; + inline_response_200_15_entries[] entries?; +}; + +# Represents the Headers record for the operation: createFolder +public type CreateFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_14 record { + inline_response_200_15_metadata metadata?; +}; + +public type inline_response_200_17 record { + string client_modified?; + string content_hash?; + inline_response_200_31_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_31_sharing_info sharing_info?; + decimal size?; +}; + +public type inline_response_200_16 record { + string \.tag?; + inline_response_200_16_entries[] entries?; +}; + +public type inline_response_200_35_access_inheritance record { + string \.tag?; +}; + +public type inline_response_200_63_results_1 record { + string \.tag?; + inline_response_200_63_results[] results?; + members_send_welcome_email_body user?; +}; + +# Represents the Headers record for the operation: deleteManualContacts +public type DeleteManualContactsHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: count +public type CountHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: search +public type SearchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_78_allocation record { + string \.tag?; + decimal allocated?; +}; + +public type inline_response_200_25_sharing_info record { + string modified_by?; + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; +}; + +public type sharing_check_remove_member_job_status_body record { + string async_job_id?; +}; + +public type files_move_v2_body record { + boolean allow_ownership_transfer?; + boolean allow_shared_folder?; + boolean autorename?; + string from_path?; + string to_path?; +}; + +# Represents the Headers record for the operation: delete +public type DeleteHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type '2teamgroupsget_info_profile_membership_type record { + string \.tag?; +}; + +# Represents the Headers record for the operation: unshareFolder +public type UnshareFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type '2sharingadd_file_member_members record { + string \.tag?; + string email?; +}; + +# Represents the Headers record for the operation: listFileMembers +public type ListFileMembersHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_71_policies record { + inline_response_200_77_team_office_addin_policy emm_state?; + inline_response_200_77_team_office_addin_policy office_addin?; + inline_response_200_77_team_sharing_policies sharing?; +}; + +public type '2teamgroupsget_info_members record { + '2teamgroupsget_info_access_type access_type?; + '2teamgroupsget_info_profile profile?; +}; + +public type inline_response_200_33 record { + '2sharingadd_file_member_members member?; + '2sharingadd_file_member_result result?; +}; + +public type inline_response_200_32 record { + string session_id?; +}; + +public type inline_response_200_35 record { + string \.tag?; + inline_response_200_35_access_inheritance access_inheritance?; + '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inside_team_folder?; + boolean is_team_folder?; + inline_response_200_35_link_metadata link_metadata?; + string name?; + string path_lower?; + anydata[] permissions?; + '2sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string shared_folder_id?; + string time_invited?; +}; + +public type groups_delete_body record { + string \.tag?; + string group_id?; +}; + +public type inline_response_200_34 record { + string \.tag?; +}; + +public type members_get_info_body record { + '2teamgroupsmembersadd_user[] members?; +}; + +public type secondary_emails_resend_verification_emails_body record { + '2teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_resend?; +}; + +public type inline_response_200_31 record { + string \.tag?; + inline_response_200_31_entries[] entries?; +}; + +public type inline_response_200_50_groups record { + string group_id?; + '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; +}; + +public type inline_response_200_30 record { + boolean has_more?; + inline_response_200_30_matches[] matches?; +}; + +# Represents the Headers record for the operation: deleteBatchCheck +public type DeleteBatchCheckHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type '2teammembersget_info_profile_secondary_emails record { + string email?; + boolean is_verified?; +}; + +public type sharing_check_job_status_body record { + string async_job_id?; +}; + +public type inline_response_200_73_details record { + string \.tag?; + inline_response_200_73_details_shared_content_access_level shared_content_access_level?; + string shared_content_link?; + inline_response_200_73_actor_user shared_content_owner?; +}; + +# Represents the Headers record for the operation: getSpaceUsage +public type GetSpaceUsageHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_37 record { + string file?; + '2sharingget_file_metadatabatch_result result?; +}; + +public type team_folder_update_sync_settings_body record { + '2teamteam_folderupdate_sync_settings_content_sync_settings[] content_sync_settings?; + string sync_setting?; + string team_folder_id?; +}; + +# Represents the Headers record for the operation: shareFolder +public type ShareFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_36 record { + '2sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + '2sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + '2sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; +}; + +public type inline_response_200_39 record { + string \.tag?; + string client_modified?; + string id?; + inline_response_200_39_link_permissions link_permissions?; + string name?; + string path_lower?; + string rev?; + string server_modified?; + decimal size?; + inline_response_200_39_team_member_info team_member_info?; + string url?; +}; + +public type inline_response_200_38 record { + inline_response_200_35_access_inheritance access_inheritance?; + '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inside_team_folder?; + boolean is_team_folder?; + inline_response_200_35_link_metadata link_metadata?; + string name?; + string path_lower?; + anydata[] permissions?; + '2sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string shared_folder_id?; + string time_invited?; +}; + +public type properties_remove_body record { + string path?; + string[] property_template_ids?; +}; + +public type inline_response_200_74_values record { + string \.tag?; + inline_response_200_74_paper_as_files paper_as_files?; +}; + +public type legal_holds_list_held_revisions_body record { + string id?; +}; + +public type files_create_folder_batch_body record { + boolean autorename?; + boolean force_async?; + string[] paths?; +}; + +# Represents the Headers record for the operation: setAccessInheritance +public type SetAccessInheritanceHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type files_lock_file_batch_body record { + '2filesget_file_lock_batch_entries[] entries?; +}; + +public type '2sharinglist_file_membersbatch_result_members_access_type record { + string \.tag?; +}; + +public type groups_get_info_body record { + string \.tag?; + string[] group_ids?; }; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. @@ -224,1066 +1557,1485 @@ public type ConnectionConfig record {| boolean validation = true; |}; -# Represents the Headers record for the operation: post2FilesUnlock_file_batch -public type Post2FilesUnlock_file_batchHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_22 record { + string link?; }; -# Represents the Headers record for the operation: post2File_requestsDelete_all_closed -public type Post2File_requestsDelete_all_closedHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_21 record { + string link?; + inline_response_200_21_metadata metadata?; }; -# Represents the Headers record for the operation: post2FilesDelete_batchCheck -public type Post2FilesDelete_batchCheckHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_24 record { + inline_response_200_24_entries[] entries?; }; -# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersList -public type Post2TeamMember_space_limitsExcluded_usersListHeaders record { - string? Content\-Type?; +public type inline_response_200_23 record { + inline_response_200_21_metadata file_metadata?; }; -# Represents the Headers record for the operation: post2TeamGroupsGet_info -public type Post2TeamGroupsGet_infoHeaders record { - string? Content\-Type?; +public type inline_response_200_20 record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_31_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_31_sharing_info sharing_info?; + decimal size?; }; -# Represents the Headers record for the operation: post2TeamMembersMove_former_member_filesJob_statusCheck -public type Post2TeamMembersMove_former_member_filesJob_statusCheckHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: create +public type CreateHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2TeamReportsGet_activity -public type Post2TeamReportsGet_activityHeaders record { - string? Content\-Type?; +public type files_delete_batch_body record { + files_delete_v2_body[] entries?; }; -# Represents the Headers record for the operation: post2SharingList_shared_links -public type Post2SharingList_shared_linksHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_70_values record { + string \.tag?; + inline_response_200_70_has_team_shared_dropbox has_team_shared_dropbox?; + inline_response_200_70_upload_api_rate_limit upload_api_rate_limit?; }; -# Represents the Headers record for the operation: post2UsersGet_current_account -public type Post2UsersGet_current_accountHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: delete1 +public type Delete1Headers record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2AuthTokenFrom_oauth1 -public type Post2AuthTokenFrom_oauth1Headers record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type '2sharinglist_file_membersbatch_result_members_group_group_management_type record { + string \.tag?; }; -# Represents the Headers record for the operation: post2FilesGet_temporary_upload_link -public type Post2FilesGet_temporary_upload_linkHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_29 record { + string \.tag?; }; -# Represents the Headers record for the operation: post2TeamLegal_holdsList_policies -public type Post2TeamLegal_holdsList_policiesHeaders record { - string? Content\-Type?; +public type files_get_metadata_body record { + boolean include_deleted?; + boolean include_has_explicit_shared_members?; + boolean include_media_info?; + string path?; }; -# Represents the Headers record for the operation: post2TeamMembersSuspend -public type Post2TeamMembersSuspendHeaders record { - string? Content\-Type?; +public type inline_response_200_26 record { + boolean changes?; }; -# Represents the Headers record for the operation: post2AccountSet_profile_photo -public type Post2AccountSet_profile_photoHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_25 record { + string cursor?; + inline_response_200_25_entries[] entries?; + boolean has_more?; }; -# Represents the Headers record for the operation: post2TeamMembersSecondary_emailsResend_verification_emails -public type Post2TeamMembersSecondary_emailsResend_verification_emailsHeaders record { - string? Content\-Type?; +public type inline_response_200_28 record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_31_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_31_sharing_info sharing_info?; + decimal size?; }; -# Represents the Headers record for the operation: post2SharingList_folders -public type Post2SharingList_foldersHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_27 record { + inline_response_200_21_metadata[] entries?; + boolean is_deleted?; }; -# Represents the Headers record for the operation: post2SharingSet_access_inheritance -public type Post2SharingSet_access_inheritanceHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_event_type record { + string \.tag?; + string description?; }; -# Represents the Headers record for the operation: post2FilesGet_temporary_link -public type Post2FilesGet_temporary_linkHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type files_get_temporary_upload_link_body record { + '2filesget_temporary_upload_link_commit_info commit_info?; + decimal duration?; }; -# Represents the Headers record for the operation: post2TeamGroupsMembersAdd -public type Post2TeamGroupsMembersAddHeaders record { - string? Content\-Type?; +public type '2teamfeaturesget_values_features record { + string \.tag?; }; -# Represents the Headers record for the operation: post2FilesCreate_folder_v2 -public type Post2FilesCreate_folder_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type members_delete_profile_photo_body record { + '2teamgroupsmembersadd_user user?; }; -# Represents the Headers record for the operation: post2FilesMove_v2 -public type Post2FilesMove_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_actor record { + string \.tag?; + inline_response_200_73_actor_user user?; }; -# Represents the Headers record for the operation: post2TeamMembersAdd -public type Post2TeamMembersAddHeaders record { - string? Content\-Type?; +public type sharing_get_shared_link_metadata_body record { + string path?; + string url?; }; -# Represents the Headers record for the operation: post2TeamMember_space_limitsGet_custom_quota -public type Post2TeamMember_space_limitsGet_custom_quotaHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: upload +public type UploadHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2SharingTransfer_folder -public type Post2SharingTransfer_folderHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: download +public type DownloadHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2TeamReportsGet_storage -public type Post2TeamReportsGet_storageHeaders record { - string? Content\-Type?; +public type inline_response_200_55 record { + inline_response_200_55_policies[] policies?; }; -# Represents the Headers record for the operation: post2TeamGroupsMembersList -public type Post2TeamGroupsMembersListHeaders record { - string? Content\-Type?; +public type inline_response_200_54 record { + inline_response_200_54_entries[] entries?; + boolean has_more?; }; -# Represents the Headers record for the operation: post2TeamGroupsMembersRemove -public type Post2TeamGroupsMembersRemoveHeaders record { - string? Content\-Type?; +public type inline_response_200_57 record { + string cursor?; + boolean has_more?; + anydata[] users?; }; -# Represents the Headers record for the operation: post2TeamReportsGet_membership -public type Post2TeamReportsGet_membershipHeaders record { - string? Content\-Type?; +public type inline_response_200_56 record { + '2sharingadd_file_member_result status?; }; -# Represents the Headers record for the operation: post2TeamGroupsCreate -public type Post2TeamGroupsCreateHeaders record { - string? Content\-Type?; +public type inline_response_200_51 record { + string async_job_id?; + inline_response_200_51_group_info group_info?; }; -# Represents the Headers record for the operation: post2FilesGet_preview -public type Post2FilesGet_previewHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_50 record { + string cursor?; + inline_response_200_50_groups[] groups?; + boolean has_more?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderListContinue -public type Post2TeamTeam_folderListContinueHeaders record { - string? Content\-Type?; +public type inline_response_200_53 record { + string activation_time?; + string end_date?; + string id?; + inline_response_200_55_members members?; + string name?; + string start_date?; + '2teamgroupsget_info_profile_status status?; }; -# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersAdd -public type Post2TeamMember_space_limitsExcluded_usersAddHeaders record { - string? Content\-Type?; +public type inline_response_200_52 record { + string cursor?; + boolean has_more?; + anydata[] members?; }; -# Represents the Headers record for the operation: post2TeamGroupsMembersSet_access_type -public type Post2TeamGroupsMembersSet_access_typeHeaders record { - string? Content\-Type?; +public type sharing_revoke_shared_link_body record { + string url?; }; -# Represents the Headers record for the operation: post2File_propertiesPropertiesOverwrite -public type Post2File_propertiesPropertiesOverwriteHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: unshareFile +public type UnshareFileHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2AuthTokenRevoke -public type Post2AuthTokenRevokeHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_77_team record { + string id?; + string name?; + inline_response_200_77_team_office_addin_policy office_addin_policy?; + inline_response_200_77_team_sharing_policies sharing_policies?; }; -# Represents the Headers record for the operation: post2SharingUnshare_file -public type Post2SharingUnshare_fileHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_59 record { + '2teammembersget_info_profile profile?; + '2teammembersget_info_role role?; }; -# Represents the Headers record for the operation: post2File_requestsList_v2 -public type Post2File_requestsList_v2Headers record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_58 record { + string \.tag?; + inline_response_200_58_complete[] complete?; }; -# Represents the Headers record for the operation: post2TeamMembersListContinue -public type Post2TeamMembersListContinueHeaders record { - string? Content\-Type?; +public type files_permanently_delete_body record { + string path?; }; -# Represents the Headers record for the operation: post2TeamMembersRecover -public type Post2TeamMembersRecoverHeaders record { - string? Content\-Type?; +public type '2sharingadd_file_member_result record { + string \.tag?; }; -# Represents the Headers record for the operation: post2TeamDevicesRevoke_device_session -public type Post2TeamDevicesRevoke_device_sessionHeaders record { - string? Content\-Type?; +public type list_folder_members_continue_body record { + string cursor?; }; -# Represents the Headers record for the operation: post2TeamMember_space_limitsExcluded_usersListContinue -public type Post2TeamMember_space_limitsExcluded_usersListContinueHeaders record { - string? Content\-Type?; +public type inline_response_200_9_file_requests record { + string created?; + inline_response_200_9_deadline deadline?; + string destination?; + decimal file_count?; + string id?; + boolean is_open?; + string title?; + string url?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderPermanently_delete -public type Post2TeamTeam_folderPermanently_deleteHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: checkShareJobStatus +public type CheckShareJobStatusHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2TeamGroupsDelete -public type Post2TeamGroupsDeleteHeaders record { - string? Content\-Type?; +public type '2file_propertiespropertiessearch_queries record { + string logical_operator?; + '2file_propertiespropertiessearch_mode mode?; + string query?; }; -# Represents the Headers record for the operation: post2FilesPermanently_delete -public type Post2FilesPermanently_deleteHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_60 record { + string \.tag?; + '2teammembersget_info_profile profile?; + '2teammembersget_info_role role?; }; -# Represents the Headers record for the operation: post2TeamGroupsListContinue -public type Post2TeamGroupsListContinueHeaders record { - string? Content\-Type?; +public type team_log_get_events_body record { + string category?; + decimal 'limit?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesList_for_user -public type Post2File_propertiesTemplatesList_for_userHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_44 record { + string cursor?; + inline_response_200_44_entries[] entries?; }; -# Represents the Headers record for the operation: post2FilesCreate_folder_batchCheck -public type Post2FilesCreate_folder_batchCheckHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_43 record { + string cursor?; + inline_response_200_43_entries[] entries?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesUpdate_for_team -public type Post2File_propertiesTemplatesUpdate_for_teamHeaders record { - string? Content\-Type?; +public type inline_response_200_46 record { + string \.tag?; }; -# Represents the Headers record for the operation: post2SharingModify_shared_link_settings -public type Post2SharingModify_shared_link_settingsHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_45 record { + string cursor?; + boolean has_more?; + inline_response_200_45_links[] links?; }; -# Represents the Headers record for the operation: post2SharingGet_file_metadata -public type Post2SharingGet_file_metadataHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type members_send_welcome_email_body record { + string \.tag?; + string team_member_id?; }; -# Represents the Headers record for the operation: post2TeamMembersRemove -public type Post2TeamMembersRemoveHeaders record { - string? Content\-Type?; +public type inline_response_200_40 record { + '2sharinglist_file_membersbatch_result_members_groups[] groups?; + '2sharinglist_file_membersbatch_result_members_invitees[] invitees?; + '2sharinglist_file_membersbatch_result_members_users[] users?; }; -# Represents the Headers record for the operation: post2TeamMembersSecondary_emailsDelete -public type Post2TeamMembersSecondary_emailsDeleteHeaders record { - string? Content\-Type?; +public type inline_response_200_42 record { + string cursor?; + '2sharinglist_file_membersbatch_result_members_groups[] groups?; + '2sharinglist_file_membersbatch_result_members_invitees[] invitees?; + inline_response_200_42_users[] users?; }; -# Represents the Headers record for the operation: post2File_propertiesPropertiesUpdate -public type Post2File_propertiesPropertiesUpdateHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_41 record { + string file?; + '2sharinglist_file_membersbatch_result result?; }; -# Represents the Headers record for the operation: post2TeamLegal_holdsUpdate_policy -public type Post2TeamLegal_holdsUpdate_policyHeaders record { - string? Content\-Type?; +public type '2teamgroupsget_info_profile record { + string account_id?; + string email?; + boolean email_verified?; + string joined_on?; + '2teamgroupsget_info_profile_membership_type membership_type?; + '2teamgroupsget_info_profile_name name?; + string profile_photo_url?; + '2teamgroupsget_info_profile_secondary_emails[] secondary_emails?; + '2teamgroupsget_info_profile_status status?; + string team_member_id?; }; -# Represents the Headers record for the operation: post2FilesCopy_referenceSave -public type Post2FilesCopy_referenceSaveHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_48 record { + decimal created?; + string group_id?; + '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + '2teamgroupsget_info_members[] members?; }; -# Represents the Headers record for the operation: post2FilesList_folderContinue -public type Post2FilesList_folderContinueHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_47 record { + string \.tag?; + string async_job_id?; }; -# Represents the Headers record for the operation: post2TeamMembersSet_profile -public type Post2TeamMembersSet_profileHeaders record { - string? Content\-Type?; +public type inline_response_200_49 record { + string \.tag?; + decimal created?; + string group_id?; + '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + '2teamgroupsget_info_members[] members?; }; -# Represents the Headers record for the operation: post2FilesGet_file_lock_batch -public type Post2FilesGet_file_lock_batchHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type properties_search_body record { + '2file_propertiespropertiessearch_queries[] queries?; + string template_filter?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesGet_for_team -public type Post2File_propertiesTemplatesGet_for_teamHeaders record { - string? Content\-Type?; +public type inline_response_200_73_assets record { + string \.tag?; + string display_name?; + string file_id?; + decimal file_size?; + inline_response_200_73_path path?; }; -# Represents the Headers record for the operation: post2FilesList_folderLongpoll -public type Post2FilesList_folderLongpollHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type file_requests_create_body record { + '2file_requestscreate_deadline deadline?; + string destination?; + boolean open?; + string title?; }; -# Represents the Headers record for the operation: post2FilesCopy_batch_v2 -public type Post2FilesCopy_batch_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_participants record { + string \.tag?; + inline_response_200_73_user user?; }; -# Represents the Headers record for the operation: post2SharingUpdate_folder_policy -public type Post2SharingUpdate_folder_policyHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_77 record { + string account_id?; + inline_response_200_77_account_type account_type?; + string country?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_paired?; + string locale?; + '2teamgroupsget_info_profile_name name?; + string referral_link?; + inline_response_200_77_root_info root_info?; + inline_response_200_77_team team?; + string team_member_id?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesRemove_for_user -public type Post2File_propertiesTemplatesRemove_for_userHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_76 record { + string account_id?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_teammate?; + '2teamgroupsget_info_profile_name name?; + string profile_photo_url?; }; -# Represents the Headers record for the operation: post2Team_logGet_events -public type Post2Team_logGet_eventsHeaders record { - string? Content\-Type?; +public type '2sharinglist_file_membersbatch_result_members_users record { + '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inherited?; + anydata[] permissions?; + '2sharinglist_file_membersbatch_result_members_platform_type platform_type?; + string time_last_seen?; + '2sharinglist_file_membersbatch_result_members_user user?; }; -# Provides settings related to HTTP/1.x protocol. -public type ClientHttp1Settings record {| - # Specifies whether to reuse a connection for multiple requests - http:KeepAlive keepAlive = http:KEEPALIVE_AUTO; - # The chunking behaviour of the request - http:Chunking chunking = http:CHUNKING_AUTO; - # Proxy server related options - ProxyConfig proxy?; -|}; +# Represents the Headers record for the operation: tokenFromOauth1 +public type TokenFromOauth1Headers record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; -# Represents the Headers record for the operation: post2FilesList_folder -public type Post2FilesList_folderHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_78 record { + inline_response_200_78_allocation allocation?; + decimal used?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderArchiveCheck -public type Post2TeamTeam_folderArchiveCheckHeaders record { - string? Content\-Type?; +public type inline_response_200_73 record { + string cursor?; + inline_response_200_73_events[] events?; + boolean has_more?; }; -# Represents the Headers record for the operation: post2File_propertiesPropertiesSearch -public type Post2File_propertiesPropertiesSearchHeaders record { - string? Authorization?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_72 record { + '2teammembersget_info_profile admin_profile?; }; -# Represents the Headers record for the operation: post2File_requestsListContinue -public type Post2File_requestsListContinueHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type file_requests_list_v2_body record { + decimal 'limit?; }; -# Represents the Headers record for the operation: post2TeamMember_space_limitsRemove_custom_quota -public type Post2TeamMember_space_limitsRemove_custom_quotaHeaders record { - string? Content\-Type?; +public type inline_response_200_75 record { + string account_id?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_teammate?; + '2teamgroupsget_info_profile_name name?; + string profile_photo_url?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderCreate -public type Post2TeamTeam_folderCreateHeaders record { - string? Content\-Type?; +public type inline_response_200_74 record { + inline_response_200_74_values[] values?; }; -# Represents the Headers record for the operation: post2SharingMount_folder -public type Post2SharingMount_folderHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_details_shared_content_access_level record { + string \.tag?; }; -# Represents the Headers record for the operation: post2FilesUpload_sessionAppend_v2 -public type Post2FilesUpload_sessionAppend_v2Headers record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: propertiesSearchContinue +public type PropertiesSearchContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2FilesSearch_v2 -public type Post2FilesSearch_v2Headers record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type members_unsuspend_body record { + members_send_welcome_email_body user?; }; -# Represents the Headers record for the operation: post2FilesUpload_sessionStart -public type Post2FilesUpload_sessionStartHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: export +public type ExportHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2SharingCheck_job_status -public type Post2SharingCheck_job_statusHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_51_group_info record { + decimal created?; + string group_id?; + '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + '2teamgroupsget_info_members[] members?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderUpdate_sync_settings -public type Post2TeamTeam_folderUpdate_sync_settingsHeaders record { - string? Content\-Type?; +public type users_get_account_body record { + string account_id?; }; -# Represents the Headers record for the operation: post2TeamDevicesRevoke_device_session_batch -public type Post2TeamDevicesRevoke_device_session_batchHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: searchContinue +public type SearchContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2SharingAdd_folder_member -public type Post2SharingAdd_folder_memberHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: getFileMetadata +public type GetFileMetadataHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2SharingRelinquish_folder_membership -public type Post2SharingRelinquish_folder_membershipHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type team_folder_get_info_body record { + string[] team_folder_ids?; }; -# Represents the Headers record for the operation: post2TeamMembersAddJob_statusGet -public type Post2TeamMembersAddJob_statusGetHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: getMetadata +public type GetMetadataHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2TeamLinked_appsRevoke_linked_app -public type Post2TeamLinked_appsRevoke_linked_appHeaders record { - string? Content\-Type?; +public type team_folder_rename_body record { + string name?; + string team_folder_id?; }; -# Represents the Headers record for the operation: post2SharingList_mountable_folders -public type Post2SharingList_mountable_foldersHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_66 record { + string cursor?; + boolean has_more?; + inline_response_200_66_namespaces[] namespaces?; }; -# Represents the Headers record for the operation: post2ContactsDelete_manual_contacts -public type Post2ContactsDelete_manual_contactsHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_65 record { + '2teammembersget_info_role role?; + string team_member_id?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderList -public type Post2TeamTeam_folderListHeaders record { - string? Content\-Type?; +public type inline_response_200_68 record { + string \.tag?; + inline_response_200_68_content_sync_settings[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + '2teamgroupsget_info_profile_status status?; + inline_response_200_68_sync_setting sync_setting?; + string team_folder_id?; }; -# Represents the Headers record for the operation: post2SharingList_file_membersBatch -public type Post2SharingList_file_membersBatchHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_67 record { + inline_response_200_68_content_sync_settings[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + '2teamgroupsget_info_profile_status status?; + inline_response_200_68_sync_setting sync_setting?; + string team_folder_id?; }; -# Represents the Headers record for the operation: post2File_requestsCreate -public type Post2File_requestsCreateHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_62 record { + inline_response_200_62_results_1[] results?; }; -# Represents the Headers record for the operation: post2File_requestsGet -public type Post2File_requestsGetHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_61 record { + string cursor?; + boolean has_more?; + inline_response_200_61_members[] members?; }; -# Represents the Headers record for the operation: post2FilesLock_file_batch -public type Post2FilesLock_file_batchHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type sharing_list_mountable_folders_body record { + anydata[] actions?; + decimal 'limit?; }; -# Represents the Headers record for the operation: post2TeamGroupsMembersListContinue -public type Post2TeamGroupsMembersListContinueHeaders record { - string? Content\-Type?; +public type inline_response_200_64 record { + inline_response_200_64_results_1[] results?; }; -# Represents the Headers record for the operation: post2Team_logGet_eventsContinue -public type Post2Team_logGet_eventsContinueHeaders record { - string? Content\-Type?; +public type inline_response_200_63 record { + inline_response_200_63_results_1[] results?; }; -# Represents the Headers record for the operation: post2TeamMember_space_limitsSet_custom_quota -public type Post2TeamMember_space_limitsSet_custom_quotaHeaders record { - string? Content\-Type?; +public type inline_response_200_70_upload_api_rate_limit record { + string \.tag?; + decimal 'limit?; }; -# Represents the Headers record for the operation: post2TeamGroupsList -public type Post2TeamGroupsListHeaders record { - string? Content\-Type?; +public type inline_response_200_69 record { + string cursor?; + boolean has_more?; + inline_response_200_69_team_folders[] team_folders?; }; -# Represents the Headers record for the operation: post2TeamMembersSet_admin_permissions -public type Post2TeamMembersSet_admin_permissionsHeaders record { - string? Content\-Type?; +public type '2sharingget_file_metadatabatch_result_access_type record { + string \.tag?; }; -# Represents the Headers record for the operation: post2SharingGet_shared_link_file -public type Post2SharingGet_shared_link_fileHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type '2sharingget_file_metadatabatch_result_policy record { + '2sharingget_file_metadatabatch_result_policy_acl_update_policy acl_update_policy?; + '2sharingget_file_metadatabatch_result_policy_member_policy member_policy?; + '2sharingget_file_metadatabatch_result_policy_resolved_member_policy resolved_member_policy?; + '2sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; }; -# Represents the Headers record for the operation: post2SharingList_mountable_foldersContinue -public type Post2SharingList_mountable_foldersContinueHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type copy_reference_get_body record { + string path?; }; -# Represents the Headers record for the operation: post2SharingAdd_file_member -public type Post2SharingAdd_file_memberHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_77_team_sharing_policies_shared_folder_join_policy record { + string \.tag?; }; -# Represents the Headers record for the operation: post2FilesDelete_batch -public type Post2FilesDelete_batchHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type token_from_oauth1_body record { + string oauth1_token?; + string oauth1_token_secret?; }; -# Represents the Headers record for the operation: post2TeamLegal_holdsList_held_revisions_continue -public type Post2TeamLegal_holdsList_held_revisions_continueHeaders record { - string? Content\-Type?; +public type inline_response_200_71 record { + string name?; + decimal num_licensed_users?; + decimal num_provisioned_users?; + inline_response_200_71_policies policies?; + string team_id?; }; -# Represents the Headers record for the operation: post2SharingList_received_files -public type Post2SharingList_received_filesHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_70 record { + inline_response_200_70_values[] values?; }; -# Represents the Headers record for the operation: post2File_propertiesPropertiesSearchContinue -public type Post2File_propertiesPropertiesSearchContinueHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type save_url_check_job_status_body record { + string async_job_id?; }; -# Represents the Headers record for the operation: post2UsersGet_account_batch -public type Post2UsersGet_account_batchHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type list_folder_get_latest_cursor_body record { + boolean include_deleted?; + boolean include_has_explicit_shared_members?; + boolean include_media_info?; + boolean include_mounted_folders?; + boolean include_non_downloadable_files?; + string path?; + boolean recursive?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesAdd_for_team -public type Post2File_propertiesTemplatesAdd_for_teamHeaders record { - string? Content\-Type?; +public type '2file_propertiestemplatesadd_for_team_fields record { + string description?; + string name?; + string 'type?; }; -# Represents the Headers record for the operation: post2TeamMembersList -public type Post2TeamMembersListHeaders record { - string? Content\-Type?; +public type '2filescopy_batch_v2_entries record { + string from_path?; + string to_path?; }; -# Represents the Headers record for the operation: post2TeamGroupsUpdate -public type Post2TeamGroupsUpdateHeaders record { - string? Content\-Type?; +public type job_status_get_body record { + string async_job_id?; }; -# Represents the Headers record for the operation: post2TeamGroupsJob_statusGet -public type Post2TeamGroupsJob_statusGetHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: restore +public type RestoreHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2FilesExport -public type Post2FilesExportHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type groups_list_body record { + decimal 'limit?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesGet_for_user -public type Post2File_propertiesTemplatesGet_for_userHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type members_list_body_1 record { + boolean include_removed?; + decimal 'limit?; }; -# Represents the Headers record for the operation: post2SharingList_received_filesContinue -public type Post2SharingList_received_filesContinueHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_origin record { + inline_response_200_73_origin_access_method access_method?; + inline_response_200_73_origin_geo_location geo_location?; }; -# Represents the Headers record for the operation: post2FilesMove_batch_v2 -public type Post2FilesMove_batch_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: getAccount +public type GetAccountHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2FilesDownload -public type Post2FilesDownloadHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: deleteAllClosed +public type DeleteAllClosedHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2TeamLinked_appsList_members_linked_apps -public type Post2TeamLinked_appsList_members_linked_appsHeaders record { - string? Content\-Type?; +public type '2sharinglist_file_membersbatch_result_members_groups record { + '2sharinglist_file_membersbatch_result_members_access_type access_type?; + '2sharinglist_file_membersbatch_result_members_group group?; + boolean is_inherited?; + anydata[] permissions?; }; -# Represents the Headers record for the operation: post2FilesRestore -public type Post2FilesRestoreHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type members_set_access_type_body record { + string access_type?; + groups_delete_body group?; + boolean return_members?; + '2teamgroupsmembersadd_user user?; }; -# Represents the Headers record for the operation: post2FilesGet_metadata -public type Post2FilesGet_metadataHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type users_get_account_batch_body record { + string[] account_ids?; }; -# Represents the Headers record for the operation: post2FilesCopy_batchCheck_v2 -public type Post2FilesCopy_batchCheck_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type legal_holds_release_policy_body record { + string id?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderArchive -public type Post2TeamTeam_folderArchiveHeaders record { - string? Content\-Type?; +public type templates_add_for_user_body record { + string description?; + '2file_propertiestemplatesadd_for_team_fields[] fields?; + string name?; }; -# Represents the Headers record for the operation: post2SharingCheck_share_job_status -public type Post2SharingCheck_share_job_statusHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type members_move_former_member_files_body record { + '2teamgroupsmembersadd_user transfer_admin_id?; + '2teamgroupsmembersadd_user transfer_dest_id?; + '2teamgroupsmembersadd_user user?; }; -# Represents the Headers record for the operation: post2TeamMembersSecondary_emailsAdd -public type Post2TeamMembersSecondary_emailsAddHeaders record { - string? Content\-Type?; +public type '2sharinglist_file_membersbatch_result record { + string \.tag?; + decimal member_count?; + '2sharinglist_file_membersbatch_result_members members?; }; -# Represents the Headers record for the operation: post2FilesSave_urlCheck_job_status -public type Post2FilesSave_urlCheck_job_statusHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type sharing_unmount_folder_body record { + string shared_folder_id?; }; -# Represents the Headers record for the operation: post2TeamDevicesList_member_devices -public type Post2TeamDevicesList_member_devicesHeaders record { - string? Content\-Type?; +public type properties_update_body record { + string path?; + '2file_propertiespropertiesupdate_update_property_groups[] update_property_groups?; }; -# Represents the Headers record for the operation: post2TeamFeaturesGet_values -public type Post2TeamFeaturesGet_valuesHeaders record { - string? Content\-Type?; +public type templates_add_for_team_body record { + string description?; + '2file_propertiestemplatesadd_for_team_fields[] fields?; + string name?; }; -# Represents the Headers record for the operation: post2SharingUpdate_file_member -public type Post2SharingUpdate_file_memberHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: templatesAddForUser +public type TemplatesAddForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesUpdate_for_user -public type Post2File_propertiesTemplatesUpdate_for_userHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type sharing_set_access_inheritance_body record { + string access_inheritance?; + string shared_folder_id?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderRename -public type Post2TeamTeam_folderRenameHeaders record { - string? Content\-Type?; +public type members_list_body record { + groups_delete_body group?; + decimal 'limit?; }; -# Represents the Headers record for the operation: post2SharingGet_shared_link_metadata -public type Post2SharingGet_shared_link_metadataHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_35_link_metadata_link_permissions record { + inline_response_200_35_link_metadata_action action?; + boolean allow?; }; -# Represents the Headers record for the operation: post2FilesDelete_v2 -public type Post2FilesDelete_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_19_lock_content record { + string \.tag?; + string created?; + string lock_holder_account_id?; + string lock_holder_team_id?; }; -# Represents the Headers record for the operation: post2TeamMembersSend_welcome_email -public type Post2TeamMembersSend_welcome_emailHeaders record { - string? Content\-Type?; +public type inline_response_200_64_results record { + string \.tag?; + string success?; }; -# Represents the Headers record for the operation: post2CheckApp -public type Post2CheckAppHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_35_link_metadata_audience_options record { + string \.tag?; }; -# Represents the Headers record for the operation: post2FilesGet_thumbnail_batch -public type Post2FilesGet_thumbnail_batchHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_77_team_sharing_policies record { + inline_response_200_77_team_sharing_policies_shared_folder_join_policy shared_folder_join_policy?; + '2sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; + inline_response_200_77_team_sharing_policies_shared_link_create_policy shared_link_create_policy?; }; -# Represents the Headers record for the operation: post2TeamLegal_holdsCreate_policy -public type Post2TeamLegal_holdsCreate_policyHeaders record { - string? Content\-Type?; +public type sharing_remove_file_member_2_body record { + string file?; + '2sharingadd_file_member_members member?; }; -# Represents the Headers record for the operation: post2File_requestsUpdate -public type Post2File_requestsUpdateHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_5_fields record { + string description?; + string name?; + inline_response_200_5_type 'type?; }; -# Represents the Headers record for the operation: post2FilesSave_url -public type Post2FilesSave_urlHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_3_matches record { + string id?; + boolean is_deleted?; + string path?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; }; -# Represents the Headers record for the operation: post2TeamReportsGet_devices -public type Post2TeamReportsGet_devicesHeaders record { - string? Content\-Type?; +public type features_get_values_body_1 record { + '2usersfeaturesget_values_features[] features?; }; -# Represents the Headers record for the operation: post2File_propertiesTemplatesAdd_for_user -public type Post2File_propertiesTemplatesAdd_for_userHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type list_file_members_batch_body record { + string[] files?; + decimal 'limit?; }; -# Represents the Headers record for the operation: post2FilesUpload_sessionFinish_batch -public type Post2FilesUpload_sessionFinish_batchHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type '2file_propertiespropertiessearch_mode record { + string \.tag?; + string field_name?; }; -# Represents the Headers record for the operation: post2SharingList_folder_membersContinue -public type Post2SharingList_folder_membersContinueHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: listRevisions +public type ListRevisionsHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2File_requestsDelete -public type Post2File_requestsDeleteHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type excluded_users_add_body record { + '2teamgroupsmembersadd_user[] users?; }; -# Represents the Headers record for the operation: post2FilesSearchContinue_v2 -public type Post2FilesSearchContinue_v2Headers record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_origin_access_method_end_user record { + string \.tag?; + string session_id?; }; -# Represents the Headers record for the operation: post2TeamLinked_appsRevoke_linked_app_batch -public type Post2TeamLinked_appsRevoke_linked_app_batchHeaders record { - string? Content\-Type?; +public type copy_reference_save_body record { + string copy_reference?; + string path?; }; -# Represents the Headers record for the operation: post2SharingCheck_remove_member_job_status -public type Post2SharingCheck_remove_member_job_statusHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_path_namespace_relative record { + boolean is_shared_namespace?; + string ns_id?; + string relative_path?; }; -# Represents the Headers record for the operation: post2TeamNamespacesListContinue -public type Post2TeamNamespacesListContinueHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: listFolder +public type ListFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2FilesCopy_v2 -public type Post2FilesCopy_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: propertiesOverwrite +public type PropertiesOverwriteHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2File_requestsCount -public type Post2File_requestsCountHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_45_links record { + string \.tag?; + string client_modified?; + string id?; + inline_response_200_39_link_permissions link_permissions?; + string name?; + string path_lower?; + string rev?; + string server_modified?; + decimal size?; + inline_response_200_39_team_member_info team_member_info?; + string url?; }; -# Represents the Headers record for the operation: post2SharingUnmount_folder -public type Post2SharingUnmount_folderHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: unlockFileBatch +public type UnlockFileBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2SharingRemove_folder_member -public type Post2SharingRemove_folder_memberHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: listFileMembersBatch +public type ListFileMembersBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2FilesList_revisions -public type Post2FilesList_revisionsHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type search_continue_v2_body record { + string cursor?; }; -# Represents the Headers record for the operation: post2FilesGet_thumbnail_v2 -public type Post2FilesGet_thumbnail_v2Headers record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: addFileMember +public type AddFileMemberHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Proxy server configurations to be used with the HTTP client endpoint. -public type ProxyConfig record {| - # Host name of the proxy server - string host = ""; - # Proxy server port - int port = 0; - # Proxy server username - string userName = ""; - # Proxy server password - @display {label: "", kind: "password"} - string password = ""; -|}; +public type inline_response_200_16_entries record { + string \.tag?; + inline_response_200_30_metadata_metadata metadata?; +}; + +# Represents the Headers record for the operation: listSharedLinks +public type ListSharedLinksHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: templatesRemoveForUser +public type TemplatesRemoveForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type team_folder_archive_body record { + boolean force_async_off?; + string team_folder_id?; +}; + +public type inline_response_200_39_link_permissions_revoke_failure_reason record { + string \.tag?; +}; + +# Represents the Headers record for the operation: removeFolderMember +public type RemoveFolderMemberHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type '2sharinglist_file_membersbatch_result_members_group record { + string group_id?; + '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + '2sharinglist_file_membersbatch_result_members_group_group_management_type group_type?; + boolean is_member?; + boolean is_owner?; + decimal member_count?; + boolean same_team?; +}; + +public type sharing_unshare_folder_body record { + boolean leave_a_copy?; + string shared_folder_id?; +}; + +public type inline_response_200_35_link_metadata record { + inline_response_200_35_link_metadata_audience_options[] audience_options?; + inline_response_200_35_link_metadata_audience_options current_audience?; + inline_response_200_35_link_metadata_link_permissions[] link_permissions?; + boolean password_protected?; + string url?; +}; + +public type legal_holds_list_held_revisions_continue_body record { + string id?; +}; + +public type list_received_files_continue_body record { + string cursor?; +}; + +public type members_set_admin_permissions_body record { + string new_role?; + members_send_welcome_email_body user?; +}; + +public type inline_response_200_30_metadata_metadata record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_31_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_31_sharing_info sharing_info?; + decimal size?; +}; + +# Represents the Headers record for the operation: mountFolder +public type MountFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: listFolderContinue +public type ListFolderContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type '2sharinglist_file_membersbatch_result_members_user record { + string account_id?; + string display_name?; + string email?; + boolean same_team?; + string team_member_id?; +}; + +public type '2file_requestscreate_deadline record { + string allow_late_uploads?; + string deadline?; +}; + +public type devices_list_member_devices_body record { + boolean include_desktop_clients?; + boolean include_mobile_clients?; + boolean include_web_sessions?; + string team_member_id?; +}; + +public type files_move_batch_v2_body record { + boolean allow_ownership_transfer?; + boolean autorename?; + '2filescopy_batch_v2_entries[] entries?; +}; + +public type check_app_body record { + string query?; +}; + +# Represents the Headers record for the operation: deleteManualContactsBatch +public type DeleteManualContactsBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: copyBatchCheck +public type CopyBatchCheckHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type list_file_members_continue_body record { + string cursor?; +}; + +public type files_copy_v2_body record { + boolean allow_ownership_transfer?; + boolean allow_shared_folder?; + boolean autorename?; + string from_path?; + string to_path?; +}; + +public type job_status_check_body record { + string async_job_id?; +}; + +public type inline_response_200_30_metadata record { + string \.tag?; + inline_response_200_30_metadata_metadata metadata?; +}; + +# Represents the Headers record for the operation: createFolderBatchCheck +public type CreateFolderBatchCheckHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: get +public type GetHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: listFolderMembersContinue +public type ListFolderMembersContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: uploadSessionAppend +public type UploadSessionAppendHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type properties_add_body record { + string path?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; +}; + +public type sharing_relinquish_file_membership_body record { + string file?; +}; + +public type check_user_body record { + string query?; +}; + +public type devices_revoke_device_session_body record { + string \.tag?; + string session_id?; + string team_member_id?; +}; + +public type files_unlock_file_batch_body record { + '2filesget_file_lock_batch_entries[] entries?; +}; + +# Represents the Headers record for the operation: saveUrlCheckJobStatus +public type SaveUrlCheckJobStatusHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: copy +public type CopyHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type excluded_users_remove_body record { + '2teamgroupsmembersadd_user[] users?; +}; + +# Represents the Headers record for the operation: update +public type UpdateHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: listFolderGetLatestCursor +public type ListFolderGetLatestCursorHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: updateFolderMember +public type UpdateFolderMemberHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +# Represents the Headers record for the operation: getSharedLinkMetadata +public type GetSharedLinkMetadataHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_55_policies record { + string activation_time?; + string end_date?; + string id?; + inline_response_200_55_members members?; + string name?; + string start_date?; + '2teamgroupsget_info_profile_status status?; +}; + +public type sharing_check_share_job_status_body record { + string async_job_id?; +}; + +# Represents the Headers record for the operation: moveBatchCheck +public type MoveBatchCheckHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type create_folder_batch_check_body record { + string async_job_id?; +}; + +public type sharing_share_folder_body record { + string access_inheritance?; + string acl_update_policy?; + boolean force_async?; + string member_policy?; + string path?; + string shared_link_policy?; +}; + +public type inline_response_200_31_sharing_info record { + string modified_by?; + string parent_shared_folder_id?; + boolean read_only?; +}; + +# Represents the Headers record for the operation: uploadSessionFinishBatchCheck +public type UploadSessionFinishBatchCheckHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type features_get_values_body record { + '2teamfeaturesget_values_features[] features?; +}; + +public type sharing_mount_folder_body record { + string shared_folder_id?; +}; + +# Represents the Headers record for the operation: uploadSessionFinish +public type UploadSessionFinishHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_66_namespaces record { + string name?; + string namespace_id?; + inline_response_200_66_namespace_type namespace_type?; + string team_member_id?; +}; + +public type '2teamgroupsget_info_profile_status record { + string \.tag?; +}; + +public type files_delete_v2_body record { + string path?; +}; + +public type inline_response_200_15_metadata record { + string id?; + string name?; + string path_display?; + string path_lower?; + '2file_propertiespropertiesadd_property_groups[] property_groups?; + inline_response_200_15_metadata_sharing_info sharing_info?; +}; + +public type '2sharingadd_folder_member_members record { + string access_level?; + '2sharingadd_folder_member_member member?; +}; + +# Represents the Headers record for the operation: copyBatch +public type CopyBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type '2teamgroupsget_info_profile_name record { + string abbreviated_name?; + string display_name?; + string familiar_name?; + string given_name?; + string surname?; +}; + +public type '2sharingget_file_metadatabatch_result record { + string \.tag?; + '2sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + '2sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + '2sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; +}; + +# Represents the Headers record for the operation: relinquishFileMembership +public type RelinquishFileMembershipHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type templates_get_for_user_body record { + string template_id?; +}; + +public type '2teammembersget_info_profile record { + string account_id?; + string email?; + boolean email_verified?; + string external_id?; + string[] groups?; + string joined_on?; + string member_folder_id?; + '2teamgroupsget_info_profile_membership_type membership_type?; + '2teamgroupsget_info_profile_name name?; + string profile_photo_url?; + '2teammembersget_info_profile_secondary_emails[] secondary_emails?; + '2teamgroupsget_info_profile_status status?; + string team_member_id?; +}; + +public type list_continue_body_1 record { + string cursor?; +}; + +public type inline_response_200_19_lock record { + inline_response_200_19_lock_content content?; +}; + +public type inline_response_200_9_deadline record { + inline_response_200_9_deadline_allow_late_uploads allow_late_uploads?; + string deadline?; +}; + +public type inline_response_200_63_results record { + string \.tag?; + string not_found?; + string success?; +}; + +public type inline_response_200_77_team_office_addin_policy record { + string \.tag?; +}; + +public type inline_response_200_18_export_metadata record { + string export_hash?; + string name?; + decimal size?; +}; + +public type list_continue_body_5 record { + string cursor?; +}; + +public type list_continue_body_4 record { + string cursor?; +}; + +public type list_continue_body_3 record { + string cursor?; +}; + +public type list_continue_body_2 record { + string cursor?; +}; + +# Represents the Headers record for the operation: getFolderMetadata +public type GetFolderMetadataHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type '2sharingget_file_metadatabatch_result_policy_member_policy record { + string \.tag?; +}; + +public type '2sharinglist_file_membersbatch_result_members record { + '2sharinglist_file_membersbatch_result_members_groups[] groups?; + '2sharinglist_file_membersbatch_result_members_invitees[] invitees?; + '2sharinglist_file_membersbatch_result_members_users[] users?; +}; + +public type linked_apps_list_member_linked_apps_body record { + string team_member_id?; +}; + +public type '2file_propertiespropertiesadd_fields record { + string name?; + string value?; +}; + +# Represents the Headers record for the operation: uploadSessionFinishBatch +public type UploadSessionFinishBatchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200 record { + string profile_photo_url?; +}; -# Represents the Headers record for the operation: post2FilesUpload_sessionFinish -public type Post2FilesUpload_sessionFinishHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: templatesListForUser +public type TemplatesListForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2File_propertiesPropertiesRemove -public type Post2File_propertiesPropertiesRemoveHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type list_continue_body_6 record { + string cursor?; }; -# Represents the Headers record for the operation: post2SharingUpdate_folder_member -public type Post2SharingUpdate_folder_memberHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type '2filesget_file_lock_batch_entries record { + string path?; }; -# Represents the Headers record for the operation: post2FilesDownload_zip -public type Post2FilesDownload_zipHeaders record { - string? Dropbox\-API\-Arg?; - string? Dropbox\-API\-Path\-Root?; - string? Dropbox\-API\-Select\-User?; +# Represents the Headers record for the operation: getPreview +public type GetPreviewHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2FilesList_folderGet_latest_cursor -public type Post2FilesList_folderGet_latest_cursorHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type devices_revoke_device_session_batch_body record { + devices_revoke_device_session_body[] revoke_devices?; }; -# Represents the Headers record for the operation: post2FilesMove_batchCheck_v2 -public type Post2FilesMove_batchCheck_v2Headers record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_58_complete record { + string \.tag?; + '2teammembersget_info_profile profile?; + '2teammembersget_info_role role?; }; -# Represents the Headers record for the operation: post2FilesUpload_sessionFinish_batchCheck -public type Post2FilesUpload_sessionFinish_batchCheckHeaders record { - string? Dropbox\-API\-Select\-Admin?; - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_70_has_team_shared_dropbox record { + string \.tag?; + boolean has_team_shared_dropbox?; }; -# Represents the Headers record for the operation: post2ContactsDelete_manual_contacts_batch -public type Post2ContactsDelete_manual_contacts_batchHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_69_team_folders record { + inline_response_200_68_content_sync_settings[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + '2teamgroupsget_info_profile_status status?; + inline_response_200_68_sync_setting sync_setting?; + string team_folder_id?; }; -# Represents the Headers record for the operation: post2TeamMembersMove_former_member_files -public type Post2TeamMembersMove_former_member_filesHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: getThumbnail +public type GetThumbnailHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2TeamMembersUnsuspend -public type Post2TeamMembersUnsuspendHeaders record { - string? Content\-Type?; +# Proxy server configurations to be used with the HTTP client endpoint. +public type ProxyConfig record {| + # Host name of the proxy server + string host = ""; + # Proxy server port + int port = 0; + # Proxy server username + string userName = ""; + # Proxy server password + @display {label: "", kind: "password"} + string password = ""; +|}; + +public type inline_response_200_15_entries record { + string \.tag?; + inline_response_200_15_metadata metadata?; }; -# Represents the Headers record for the operation: post2SharingList_foldersContinue -public type Post2SharingList_foldersContinueHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type get_file_metadata_batch_body record { + anydata[] actions?; + string[] files?; }; -# Represents the Headers record for the operation: post2TeamMembersSet_profile_photo -public type Post2TeamMembersSet_profile_photoHeaders record { - string? Content\-Type?; +public type copy_batch_check_v2_body record { + string async_job_id?; }; -# Represents the Headers record for the operation: post2TeamLegal_holdsGet_policy -public type Post2TeamLegal_holdsGet_policyHeaders record { - string? Content\-Type?; +public type upload_session_finish_batch_body record { + '2filesupload_sessionfinish_batch_entries[] entries?; }; -# Represents the Headers record for the operation: post2TeamTeam_folderGet_info -public type Post2TeamTeam_folderGet_infoHeaders record { - string? Content\-Type?; +public type sharing_transfer_folder_body record { + string shared_folder_id?; + string to_dropbox_id?; }; -# Represents the Headers record for the operation: post2TeamMembersDelete_profile_photo -public type Post2TeamMembersDelete_profile_photoHeaders record { - string? Content\-Type?; +# Represents the Headers record for the operation: app +public type AppHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: post2CheckUser -public type Post2CheckUserHeaders record { - string? Dropbox\-API\-Path\-Root?; - string? Content\-Type?; - string? Dropbox\-API\-Select\-User?; +public type inline_response_200_73_events record { + inline_response_200_73_actor actor?; + inline_response_200_73_assets[] assets?; + inline_response_200_73_actor_user context?; + inline_response_200_73_details details?; + inline_response_200_73_event_category event_category?; + inline_response_200_73_event_type event_type?; + boolean involve_non_team_member?; + inline_response_200_73_origin origin?; + inline_response_200_73_participants[] participants?; + string timestamp?; }; diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json new file mode 100644 index 0000000..e741bd8 --- /dev/null +++ b/docs/spec/openapi.json @@ -0,0 +1,35354 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Dropbox API Reference", + "description": "The powerful, yet simple, Dropbox API allows you to manage and control content and team settings programmatically and extend Dropbox capabilities in new and powerful ways. This is a collection that includes requests to all endpoints in the Dropbox API. \n\nThe Dropbox API is divided in two groups of endpoints: User Endpoints and Business Endpoints. Operations that would most likely be executed by a user, such as file operations, are in the User Endpoints folder. Operations that would most likely be executed by a team administrator, such as adding users to groups, live in the Business Endpoints folder. \n\nIf you are new to Dropbox Business and Team Administration, please have a look at the [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). \n\nIf you want more information on how to use our API please refer to our [Developer Portal](https://www.dropbox.com/developers). \n\n# What's in the collection?\n\nThe endpoints are organized in the following folders:\n* account\n* auth\n* check\n* contacts\n* file_properties\n* file_requests\n* files\n* sharing\n* team\n* team_log\n* users\n\n# Authorization\n\n## OAuth 2.0 for API Access\nDropbox uses OAuth 2.0, an open specification, to authorize access to data. To get an OAuth token from Dropbox to enable Postman to access your Dropbox account via the API you’ll need to create a new app on the DBX Platform.\n\n## Creating an App on the DBX Platform\nNavigate to https://www.dropbox.com/developers/apps and select “Create app” \n1. Choose an API \n2. Choose the type of access you need \n3. Give your app a name \n4. Choose the Dropbox account that will own your app \n\nFor reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) \n\n## Generating an Access Token\nOnce you select “Create app” a page will load that displays information about your newly created app. To generate an access token scroll down to “OAuth 2” and click “Generate” beneath “Generated access token.” The token will display as a long string of characters. Copy this token for use with the Postman Collection.\n\n## Adding an Access Token to the requests\nIn the Postman client, click on the three dots to the right of the collection name to \"View more actions.\"\n\n![Screenshot of adding access token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1)\n\nThen, click \"Edit.\"\n\nClick on the \"Variables\" tab and, in the row for the `access_token` variable, paste your access token in the `CURRENT VALUE` column. The default value is `your-access-token-here`.\n\n![Screenshot of adding access token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1)\n\nFor information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/.\n\n# Notes\n* Dropbox also has a Postman Collection in the API Network to help administrators with team management workflows. It is called [Dropbox Team Admin Workflows](). \n\n", + "version": "1.0.0", + "contact": {} + }, + "servers": [ + { + "url": "https://api.dropboxapi.com" + }, + { + "url": "https://content.dropboxapi.com" + }, + { + "url": "https://notify.dropboxapi.com" + } + ], + "paths": { + "/2/account/set_profile_photo": { + "post": { + "tags": [ + "account" + ], + "summary": "set_profile_photo", + "description": "[set_profile_photo](https://www.dropbox.com/developers/documentation/http/documentation#account-set_profile_photo)\n\nscope: `account_info.write`\n\nSets a user's profile photo.", + "operationId": "setProfilePhoto", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "photo": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "base64_data" + }, + "base64_data": { + "type": "string", + "example": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" + } + } + } + } + }, + "examples": { + "set_profile_photo": { + "value": { + "photo": { + ".tag": "base64_data", + "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "set_profile_photo response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + } + } + }, + "examples": { + "set_profile_photo response": { + "value": { + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + } + } + } + } + } + } + } + } + }, + "/2/auth/token/from_oauth1": { + "post": { + "tags": [ + "auth" + ], + "summary": "token/from_oauth1", + "description": "[token/from_oauth1](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-from_oauth1)\n\nscope: `None`\n\nCreates an OAuth 2.0 access token from the supplied OAuth 1.0 access token.", + "operationId": "tokenFromOauth1", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "oauth1_token": { + "type": "string", + "example": "qievr8hamyg6ndck" + }, + "oauth1_token_secret": { + "type": "string", + "example": "qomoftv0472git7" + } + } + }, + "examples": { + "token/from_oauth1": { + "value": { + "oauth1_token": "qievr8hamyg6ndck", + "oauth1_token_secret": "qomoftv0472git7" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "token/from_oauth1 response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "oauth2_token": { + "type": "string", + "example": "9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn" + } + } + }, + "examples": { + "token/from_oauth1 response": { + "value": { + "oauth2_token": "9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn" + } + } + } + } + } + } + } + } + }, + "/2/auth/token/revoke": { + "post": { + "tags": [ + "auth" + ], + "summary": "token/revoke", + "description": "[token/revoke](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke)\n\nscope: `None`\n\nDisables the access token used to authenticate the call.", + "operationId": "tokenRevoke", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/check/app": { + "post": { + "tags": [ + "check" + ], + "summary": "app", + "description": "[app](https://www.dropbox.com/developers/documentation/http/documentation#check-app)\n\nscope: `None`\n\nThis endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid.", + "operationId": "app", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "string", + "example": "foo" + } + } + }, + "examples": { + "app": { + "value": { + "query": "foo" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "app response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "foo" + } + } + }, + "examples": { + "app response": { + "value": { + "result": "foo" + } + } + } + } + } + } + } + } + }, + "/2/check/user": { + "post": { + "tags": [ + "check" + ], + "summary": "user", + "description": "[user](https://www.dropbox.com/developers/documentation/http/documentation#check-user)\n\nscope: `None`\n\nThis endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the access token is valid.", + "operationId": "user", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "string", + "example": "foo" + } + } + }, + "examples": { + "user": { + "value": { + "query": "foo" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "user response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "foo" + } + } + }, + "examples": { + "user response": { + "value": { + "result": "foo" + } + } + } + } + } + } + } + } + }, + "/2/contacts/delete_manual_contacts": { + "post": { + "tags": [ + "contacts" + ], + "summary": "delete_manual_contacts", + "description": "[delete_manual_contacts](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts)\n\nscope: `contacts.write`\n\nRemoves all manually added contacts. You'll still keep contacts who are on your team or who you imported. New contacts will be added when you share.", + "operationId": "deleteManualContacts", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/contacts/delete_manual_contacts_batch": { + "post": { + "tags": [ + "contacts" + ], + "summary": "delete_manual_contacts_batch", + "description": "[delete_manual_contacts_batch](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts_batch)\n\nscope: `contacts.write`\n\nRemoves manually added contacts from the given list.", + "operationId": "deleteManualContactsBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email_addresses": { + "type": "array", + "items": { + "type": "string", + "example": "contactemailaddress1@domain.com" + }, + "example": [ + "contactemailaddress1@domain.com", + "contactemailaddress2@domain.com" + ] + } + } + }, + "examples": { + "delete_manual_contacts_batch": { + "value": { + "email_addresses": [ + "contactemailaddress1@domain.com", + "contactemailaddress2@domain.com" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/file_properties/properties/add": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "properties/add", + "description": "[properties/add](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add)\n\nscope: `files.metadata.write`\n\nAdd property groups to a Dropbox file. See `templates/add_for_user` or `templates/add_for_team` to create new templates.", + "operationId": "propertiesAdd", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/my_awesome/word.docx" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + }, + "examples": { + "properties/add": { + "value": { + "path": "/my_awesome/word.docx", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/file_properties/properties/overwrite": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "properties/overwrite", + "description": "[properties/overwrite](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite)\n\nscope: `files.metadata.write`\n\nOverwrite property groups associated with a file. This endpoint should be used instead of `properties/update` when property groups are being updated via a \"snapshot\" instead of via a \"delta\". In other words, this endpoint will delete all omitted fields from a property group, whereas `properties/update` will only delete fields that are explicitly marked for deletion.", + "operationId": "propertiesOverwrite", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/my_awesome/word.docx" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + }, + "examples": { + "properties/overwrite": { + "value": { + "path": "/my_awesome/word.docx", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/file_properties/properties/remove": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "properties/remove", + "description": "[properties/remove](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove)\n\nscope: `files.metadata.write`\n\nPermanently removes the specified property group from the file. To remove specific property field key value pairs, see `properties/update`. To update a template, see `templates/update_for_user` or `templates/update_for_team`. To remove a template, see `templates/remove_for_user` or `templates/remove_for_team`.", + "operationId": "propertiesRemove", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/my_awesome/word.docx" + }, + "property_template_ids": { + "type": "array", + "items": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + }, + "example": [ + "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + ] + } + } + }, + "examples": { + "properties/remove": { + "value": { + "path": "/my_awesome/word.docx", + "property_template_ids": [ + "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/file_properties/properties/search": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "properties/search", + "description": "[properties/search](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search)\n\nscope: `files.metadata.read`\n\nSearch across property templates for particular property field values.", + "operationId": "propertiesSearch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "logical_operator": { + "type": "string", + "example": "or_operator" + }, + "mode": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "field_name" + }, + "field_name": { + "type": "string", + "example": "Security" + } + } + }, + "query": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "logical_operator": "or_operator", + "mode": { + ".tag": "field_name", + "field_name": "Security" + }, + "query": "Confidential" + } + ] + }, + "template_filter": { + "type": "string", + "example": "filter_none" + } + } + }, + "examples": { + "properties/search": { + "value": { + "queries": [ + { + "logical_operator": "or_operator", + "mode": { + ".tag": "field_name", + "field_name": "Security" + }, + "query": "Confidential" + } + ], + "template_filter": "filter_none" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "properties/search response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXz" + }, + "is_deleted": { + "type": "boolean", + "example": false + }, + "path": { + "type": "string", + "example": "/my_awesome/word.docx" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "is_deleted": false, + "path": "/my_awesome/word.docx", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + ] + } + } + }, + "examples": { + "properties/search response": { + "value": { + "matches": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "is_deleted": false, + "path": "/my_awesome/word.docx", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + ] + } + } + } + } + } + } + } + } + }, + "/2/file_properties/properties/search/continue": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "properties/search/continue", + "description": "[properties/search/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue)\n\nscope: `files.metadata.read`\n\nOnce a cursor has been retrieved from `properties/search`, use this to paginate through all search results.", + "operationId": "propertiesSearchContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "properties/search/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "properties/search/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXz" + }, + "is_deleted": { + "type": "boolean", + "example": false + }, + "path": { + "type": "string", + "example": "/my_awesome/word.docx" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "is_deleted": false, + "path": "/my_awesome/word.docx", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + ] + } + } + }, + "examples": { + "properties/search/continue response": { + "value": { + "matches": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "is_deleted": false, + "path": "/my_awesome/word.docx", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + ] + } + } + } + } + } + } + } + } + }, + "/2/file_properties/properties/update": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "properties/update", + "description": "[properties/update](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update)\n\nscope: `files.metadata.write`\n\nAdd, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of `properties/overwrite` when property groups are being updated via a \"delta\" instead of via a \"snapshot\" . In other words, this endpoint will not delete any omitted fields from a property group, whereas `properties/overwrite` will delete any fields that are omitted from a property group.", + "operationId": "propertiesUpdate", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/my_awesome/word.docx" + }, + "update_property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "add_or_update_fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "remove_fields": { + "type": "array", + "items": {}, + "example": [] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "add_or_update_fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "remove_fields": [], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + }, + "examples": { + "properties/update": { + "value": { + "path": "/my_awesome/word.docx", + "update_property_groups": [ + { + "add_or_update_fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "remove_fields": [], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/file_properties/templates/add_for_team": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/add_for_team", + "description": "[templates/add_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-add_for_team)\n\nscope: `files.team_metadata.write`\n\nAdd a template associated with a team. See `properties/add` to add properties to a file or folder.\nNote: this endpoint will create team-owned templates.", + "operationId": "templatesAddForTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "These properties describe how confidential this file or folder is." + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." + }, + "name": { + "type": "string", + "example": "Security Policy" + }, + "type": { + "type": "string", + "example": "string" + } + } + }, + "example": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ] + }, + "name": { + "type": "string", + "example": "Security" + } + } + }, + "examples": { + "templates/add_for_team": { + "value": { + "description": "These properties describe how confidential this file or folder is.", + "fields": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ], + "name": "Security" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "templates/add_for_team response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/add_for_team response": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/file_properties/templates/add_for_user": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/add_for_user", + "description": "[templates/add_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user)\n\nscope: `files.metadata.write`\n\nAdd a template associated with a user. See `properties/add` to add properties to a file. This endpoint can't be called on a team member or admin's behalf.", + "operationId": "templatesAddForUser", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "These properties describe how confidential this file or folder is." + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." + }, + "name": { + "type": "string", + "example": "Security Policy" + }, + "type": { + "type": "string", + "example": "string" + } + } + }, + "example": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ] + }, + "name": { + "type": "string", + "example": "Security" + } + } + }, + "examples": { + "templates/add_for_user": { + "value": { + "description": "These properties describe how confidential this file or folder is.", + "fields": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ], + "name": "Security" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "templates/add_for_user response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/add_for_user response": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + } + } + } + }, + "/2/file_properties/templates/get_for_team": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/get_for_team", + "description": "[templates/get_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-get_for_team)\n\nscope: `files.team_metadata.write`\n\nGet the schema for a specified template.", + "operationId": "templatesGetForTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/get_for_team": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "templates/get_for_team response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "These properties describe how confidential this file or folder is." + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." + }, + "name": { + "type": "string", + "example": "Security Policy" + }, + "type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "string" + } + } + } + } + }, + "example": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": { + ".tag": "string" + } + } + ] + }, + "name": { + "type": "string", + "example": "Security" + } + } + }, + "examples": { + "templates/get_for_team response": { + "value": { + "description": "These properties describe how confidential this file or folder is.", + "fields": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": { + ".tag": "string" + } + } + ], + "name": "Security" + } + } + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/file_properties/templates/get_for_user": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/get_for_user", + "description": "[templates/get_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user)\n\nscope: `files.metadata.read`\n\nGet the schema for a specified template. This endpoint can't be called on a team member or admin's behalf.", + "operationId": "templatesGetForUser", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/get_for_user": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "templates/get_for_user response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "These properties describe how confidential this file or folder is." + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." + }, + "name": { + "type": "string", + "example": "Security Policy" + }, + "type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "string" + } + } + } + } + }, + "example": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": { + ".tag": "string" + } + } + ] + }, + "name": { + "type": "string", + "example": "Security" + } + } + }, + "examples": { + "templates/get_for_user response": { + "value": { + "description": "These properties describe how confidential this file or folder is.", + "fields": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": { + ".tag": "string" + } + } + ], + "name": "Security" + } + } + } + } + } + } + } + } + }, + "/2/file_properties/templates/list_for_team": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/list_for_team", + "description": "[templates/list_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-list_for_team)\n\nscope: `files.team_metadata.write`\n\nGet the template identifiers for a team. To get the schema of each template use `templates/get_for_team`.", + "operationId": "templatesListForTeam", + "responses": { + "200": { + "description": "templates/list_for_team response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_ids": { + "type": "array", + "items": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + }, + "example": [ + "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + ] + } + } + }, + "examples": { + "templates/list_for_team response": { + "value": { + "template_ids": [ + "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + ] + } + } + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/file_properties/templates/list_for_user": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/list_for_user", + "description": "[templates/list_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user)\n\nscope: `files.metadata.read`\n\nGet the template identifiers for a team. To get the schema of each template use `templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf.", + "operationId": "templatesListForUser", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "templates/list_for_user response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_ids": { + "type": "array", + "items": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + }, + "example": [ + "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + ] + } + } + }, + "examples": { + "templates/list_for_user response": { + "value": { + "template_ids": [ + "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + ] + } + } + } + } + } + } + } + } + }, + "/2/file_properties/templates/remove_for_team": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/remove_for_team", + "description": "[templates/remove_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-remove_for_team)\n\nscope: `files.team_metadata.write`\n\nPermanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.", + "operationId": "templatesRemoveForTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/remove_for_team": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/file_properties/templates/remove_for_user": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/remove_for_user", + "description": "[templates/remove_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user)\n\nscope: `files.metadata.write`\n\nPermanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.", + "operationId": "templatesRemoveForUser", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/remove_for_user": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/file_properties/templates/update_for_team": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/update_for_team", + "description": "[templates/update_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-update_for_team)\n\nscope: `files.team_metadata.write`\n\nUpdate a template associated with a team. This route can update the template name, the template description and add optional properties to templates.", + "operationId": "templatesUpdateForTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "add_fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." + }, + "name": { + "type": "string", + "example": "Security Policy" + }, + "type": { + "type": "string", + "example": "string" + } + } + }, + "example": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ] + }, + "description": { + "type": "string", + "example": "These properties will describe how confidential this file or folder is." + }, + "name": { + "type": "string", + "example": "New Security Template Name" + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/update_for_team": { + "value": { + "add_fields": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ], + "description": "These properties will describe how confidential this file or folder is.", + "name": "New Security Template Name", + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "templates/update_for_team response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/update_for_team response": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/file_properties/templates/update_for_user": { + "post": { + "tags": [ + "file_properties" + ], + "summary": "templates/update_for_user", + "description": "[templates/update_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user)\n\nscope: `files.metadata.write`\n\nUpdate a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf.", + "operationId": "templatesUpdateForUser", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "add_fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." + }, + "name": { + "type": "string", + "example": "Security Policy" + }, + "type": { + "type": "string", + "example": "string" + } + } + }, + "example": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ] + }, + "description": { + "type": "string", + "example": "These properties will describe how confidential this file or folder is." + }, + "name": { + "type": "string", + "example": "New Security Template Name" + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/update_for_user": { + "value": { + "add_fields": [ + { + "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", + "name": "Security Policy", + "type": "string" + } + ], + "description": "These properties will describe how confidential this file or folder is.", + "name": "New Security Template Name", + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "templates/update_for_user response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "examples": { + "templates/update_for_user response": { + "value": { + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + } + } + } + } + } + } + }, + "/2/file_requests/count": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "count", + "description": "[count](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-count)\n\nscope: `file_requests.read`\n\nReturns the total number of file requests owned by this user. Includes both open and closed file requests.", + "operationId": "count", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "count response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file_request_count": { + "type": "number", + "example": 15 + } + } + }, + "examples": { + "count response": { + "value": { + "file_request_count": 15 + } + } + } + } + } + } + } + } + }, + "/2/file_requests/create": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "create", + "description": "[create](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create)\n\nscope: `file_requests.write`\n\nCreates a file request for this user.", + "operationId": "create", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "string", + "example": "seven_days" + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + } + } + }, + "examples": { + "create": { + "value": { + "deadline": { + "allow_late_uploads": "seven_days", + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "open": true, + "title": "Homework submission" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "create response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-10-05T17:00:00Z" + }, + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "seven_days" + } + } + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "file_count": { + "type": "number", + "example": 3 + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "is_open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + }, + "examples": { + "create response": { + "value": { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + } + } + } + } + } + } + }, + "/2/file_requests/delete": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "delete", + "description": "[delete](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete)\n\nscope: `file_requests.write`\n\nDelete a batch of closed file requests.", + "operationId": "delete", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "example": [ + "oaCAVmEyrqYnkZX9955Y", + "BaZmehYoXMPtaRmfTbSG" + ] + } + } + }, + "examples": { + "delete": { + "value": { + "ids": [ + "oaCAVmEyrqYnkZX9955Y", + "BaZmehYoXMPtaRmfTbSG" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "delete response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-10-05T17:00:00Z" + }, + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "seven_days" + } + } + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "file_count": { + "type": "number", + "example": 3 + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "is_open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + }, + "example": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ] + } + } + }, + "examples": { + "delete response": { + "value": { + "file_requests": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/file_requests/delete_all_closed": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "delete_all_closed", + "description": "[delete_all_closed](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete_all_closed)\n\nscope: `file_requests.write`\n\nDelete all closed file requests owned by this user.", + "operationId": "deleteAllClosed", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "delete_all_closed response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-10-05T17:00:00Z" + }, + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "seven_days" + } + } + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "file_count": { + "type": "number", + "example": 3 + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "is_open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + }, + "example": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ] + } + } + }, + "examples": { + "delete_all_closed response": { + "value": { + "file_requests": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/file_requests/get": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "get", + "description": "[get](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get)\n\nscope: `file_requests.read`\n\nReturns the specified file request.", + "operationId": "get", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + } + } + }, + "examples": { + "get": { + "value": { + "id": "oaCAVmEyrqYnkZX9955Y" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-10-05T17:00:00Z" + }, + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "seven_days" + } + } + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "file_count": { + "type": "number", + "example": 3 + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "is_open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + }, + "examples": { + "get response": { + "value": { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + } + } + } + } + } + } + }, + "/2/file_requests/list_v2": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "list", + "description": "[list](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list)\n\nscope: `file_requests.read`\n\nReturns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.", + "operationId": "list", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "number", + "example": 1000 + } + } + }, + "examples": { + "list": { + "value": { + "limit": 1000 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "file_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-10-05T17:00:00Z" + }, + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "seven_days" + } + } + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "file_count": { + "type": "number", + "example": 3 + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "is_open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + }, + "example": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ] + }, + "has_more": { + "type": "boolean", + "example": true + } + } + }, + "examples": { + "list response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "file_requests": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ], + "has_more": true + } + } + } + } + } + } + } + } + }, + "/2/file_requests/list/continue": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "list/continue", + "description": "[list/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list-continue)\n\nscope: `file_requests.read`\n\nOnce a cursor has been retrieved from `list:2`, use this to paginate through all file requests. The cursor must come from a previous call to `list:2` or `list/continue`.", + "operationId": "listContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "file_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-10-05T17:00:00Z" + }, + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "seven_days" + } + } + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "file_count": { + "type": "number", + "example": 3 + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "is_open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + }, + "example": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ] + }, + "has_more": { + "type": "boolean", + "example": true + } + } + }, + "examples": { + "list/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "file_requests": [ + { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + }, + { + "created": "2015-11-02T04:00:00Z", + "deadline": { + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/Photo contest entries", + "file_count": 105, + "id": "BAJ7IrRGicQKGToykQdB", + "is_open": true, + "title": "Photo contest submission", + "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" + }, + { + "created": "2015-12-15T13:02:00Z", + "destination": "/Wedding photos", + "file_count": 37, + "id": "rxwMPvK3ATTa0VxOJu5T", + "is_open": true, + "title": "Wedding photo submission", + "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" + } + ], + "has_more": true + } + } + } + } + } + } + } + } + }, + "/2/file_requests/update": { + "post": { + "tags": [ + "file_requests" + ], + "summary": "update", + "description": "[update](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-update)\n\nscope: `file_requests.write`\n\nUpdate a file request.", + "operationId": "update", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deadline": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "update" + }, + "allow_late_uploads": { + "type": "string", + "example": "seven_days" + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + } + } + }, + "examples": { + "update": { + "value": { + "deadline": { + ".tag": "update", + "allow_late_uploads": "seven_days", + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "id": "oaCAVmEyrqYnkZX9955Y", + "open": true, + "title": "Homework submission" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "update response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-10-05T17:00:00Z" + }, + "deadline": { + "type": "object", + "properties": { + "allow_late_uploads": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "seven_days" + } + } + }, + "deadline": { + "type": "string", + "example": "2020-10-12T17:00:00Z" + } + } + }, + "destination": { + "type": "string", + "example": "/File Requests/Homework" + }, + "file_count": { + "type": "number", + "example": 3 + }, + "id": { + "type": "string", + "example": "oaCAVmEyrqYnkZX9955Y" + }, + "is_open": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "Homework submission" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + }, + "examples": { + "update response": { + "value": { + "created": "2015-10-05T17:00:00Z", + "deadline": { + "allow_late_uploads": { + ".tag": "seven_days" + }, + "deadline": "2020-10-12T17:00:00Z" + }, + "destination": "/File Requests/Homework", + "file_count": 3, + "id": "oaCAVmEyrqYnkZX9955Y", + "is_open": true, + "title": "Homework submission", + "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" + } + } + } + } + } + } + } + } + }, + "/2/files/copy_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "copy", + "description": "[copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy)\n\nscope: `files.content.write`\n\nCopy a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be copied.", + "operationId": "copy", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_ownership_transfer": { + "type": "boolean", + "example": false + }, + "allow_shared_folder": { + "type": "boolean", + "example": false + }, + "autorename": { + "type": "boolean", + "example": false + }, + "from_path": { + "type": "string", + "example": "/Homework/math" + }, + "to_path": { + "type": "string", + "example": "/Homework/algebra" + } + } + }, + "examples": { + "copy": { + "value": { + "allow_ownership_transfer": false, + "allow_shared_folder": false, + "autorename": false, + "from_path": "/Homework/math", + "to_path": "/Homework/algebra" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "copy response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "copy response": { + "value": { + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/copy_batch_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "copy_batch", + "description": "[copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch)\n\nscope: `files.content.write`\n\nCopy multiple files or folders to different locations at once in the user's Dropbox.\nThis route will replace `copy_batch:1`. The main difference is this route will return status for each entry, while `copy_batch:1` raises failure if any entry fails.\nThis route will either finish synchronously, or return a job ID and do the async copy job in background. Please use `copy_batch/check:2` to check the job status.", + "operationId": "copyBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "autorename": { + "type": "boolean", + "example": false + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "from_path": { + "type": "string", + "example": "/Homework/math" + }, + "to_path": { + "type": "string", + "example": "/Homework/algebra" + } + } + }, + "example": [ + { + "from_path": "/Homework/math", + "to_path": "/Homework/algebra" + } + ] + } + } + }, + "examples": { + "copy_batch": { + "value": { + "autorename": false, + "entries": [ + { + "from_path": "/Homework/math", + "to_path": "/Homework/algebra" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "copy_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "success": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "copy_batch response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/copy_batch/check_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "copy_batch/check", + "description": "[copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `copy_batch:2`. It returns list of results for each entry.", + "operationId": "copyBatchCheck", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "copy_batch/check": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "copy_batch/check response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "success": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "copy_batch/check response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/copy_reference/get": { + "post": { + "tags": [ + "files" + ], + "summary": "copy_reference/get", + "description": "[copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get)\n\nscope: `files.content.write`\n\nGet a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to `copy_reference/save`.", + "operationId": "copyReferenceGet", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/video.mp4" + } + } + }, + "examples": { + "copy_reference/get": { + "value": { + "path": "/video.mp4" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "copy_reference/get response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "copy_reference": { + "type": "string", + "example": "z1X6ATl6aWtzOGq0c3g5Ng" + }, + "expires": { + "type": "string", + "example": "2045-05-12T15:50:38Z" + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "copy_reference/get response": { + "value": { + "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", + "expires": "2045-05-12T15:50:38Z", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/copy_reference/save": { + "post": { + "tags": [ + "files" + ], + "summary": "copy_reference/save", + "description": "[copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save)\n\nscope: `files.content.write`\n\nSave a copy reference returned by `copy_reference/get` to the user's Dropbox.", + "operationId": "copyReferenceSave", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "copy_reference": { + "type": "string", + "example": "z1X6ATl6aWtzOGq0c3g5Ng" + }, + "path": { + "type": "string", + "example": "/video.mp4" + } + } + }, + "examples": { + "copy_reference/save": { + "value": { + "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", + "path": "/video.mp4" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "copy_reference/save response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "copy_reference/save response": { + "value": { + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/create_folder_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "create_folder", + "description": "[create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder)\n\nscope: `files.content.write`\n\nCreate a folder at a given path.", + "operationId": "createFolder", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "autorename": { + "type": "boolean", + "example": false + }, + "path": { + "type": "string", + "example": "/Homework/math" + } + } + }, + "examples": { + "create_folder": { + "value": { + "autorename": false, + "path": "/Homework/math" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "create_folder response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXz" + }, + "name": { + "type": "string", + "example": "math" + }, + "path_display": { + "type": "string", + "example": "/Homework/math" + }, + "path_lower": { + "type": "string", + "example": "/homework/math" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "sharing_info": { + "type": "object", + "properties": { + "no_access": { + "type": "boolean", + "example": false + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": false + }, + "traverse_only": { + "type": "boolean", + "example": false + } + } + } + } + } + } + }, + "examples": { + "create_folder response": { + "value": { + "metadata": { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + } + } + } + } + } + } + } + } + }, + "/2/files/create_folder_batch": { + "post": { + "tags": [ + "files" + ], + "summary": "create_folder_batch", + "description": "[create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch)\n\nscope: `files.content.write`\n\nCreate multiple folders at once.\nThis route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the `CreateFolderBatchArg.force_async` flag. Use `create_folder_batch/check` to check the job status.", + "operationId": "createFolderBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "autorename": { + "type": "boolean", + "example": false + }, + "force_async": { + "type": "boolean", + "example": false + }, + "paths": { + "type": "array", + "items": { + "type": "string", + "example": "/Homework/math" + }, + "example": [ + "/Homework/math" + ] + } + } + }, + "examples": { + "create_folder_batch": { + "value": { + "autorename": false, + "force_async": false, + "paths": [ + "/Homework/math" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "create_folder_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "metadata": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXz" + }, + "name": { + "type": "string", + "example": "math" + }, + "path_display": { + "type": "string", + "example": "/Homework/math" + }, + "path_lower": { + "type": "string", + "example": "/homework/math" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "sharing_info": { + "type": "object", + "properties": { + "no_access": { + "type": "boolean", + "example": false + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": false + }, + "traverse_only": { + "type": "boolean", + "example": false + } + } + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "metadata": { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + } + ] + } + } + }, + "examples": { + "create_folder_batch response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "metadata": { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/create_folder_batch/check": { + "post": { + "tags": [ + "files" + ], + "summary": "create_folder_batch/check", + "description": "[create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `create_folder_batch`. If success, it returns list of result for each entry.", + "operationId": "createFolderBatchCheck", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "create_folder_batch/check": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "create_folder_batch/check response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "metadata": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXz" + }, + "name": { + "type": "string", + "example": "math" + }, + "path_display": { + "type": "string", + "example": "/Homework/math" + }, + "path_lower": { + "type": "string", + "example": "/homework/math" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "sharing_info": { + "type": "object", + "properties": { + "no_access": { + "type": "boolean", + "example": false + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": false + }, + "traverse_only": { + "type": "boolean", + "example": false + } + } + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "metadata": { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + } + ] + } + } + }, + "examples": { + "create_folder_batch/check response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "metadata": { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/delete_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "delete", + "description": "[delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete)\n\nscope: `files.content.write`\n\nDelete the file or folder at a given path.\nIf the path is a folder, all its contents will be deleted too.\nA successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding `FileMetadata` or `FolderMetadata` for the item at time of deletion, and not a `DeletedMetadata` object.", + "operationId": "delete1", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + } + } + }, + "examples": { + "delete": { + "value": { + "path": "/Homework/math/Prime_Numbers.txt" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "delete response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "delete response": { + "value": { + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/delete_batch": { + "post": { + "tags": [ + "files" + ], + "summary": "delete_batch", + "description": "[delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch)\n\nscope: `files.content.write`\n\nDelete multiple files/folders at once.\nThis route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use `delete_batch/check` to check the job status.", + "operationId": "deleteBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + } + } + }, + "example": [ + { + "path": "/Homework/math/Prime_Numbers.txt" + } + ] + } + } + }, + "examples": { + "delete_batch": { + "value": { + "entries": [ + { + "path": "/Homework/math/Prime_Numbers.txt" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "delete_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "delete_batch response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/delete_batch/check": { + "post": { + "tags": [ + "files" + ], + "summary": "delete_batch/check", + "description": "[delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `delete_batch`. If success, it returns list of result for each entry.", + "operationId": "deleteBatchCheck", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "delete_batch/check": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "delete_batch/check response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "delete_batch/check response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/download": { + "post": { + "tags": [ + "files" + ], + "summary": "download", + "description": "[download](https://www.dropbox.com/developers/documentation/http/documentation#files-download)\n\nscope: `files.content.read`\n\nDownload a file from a user's Dropbox.", + "operationId": "download", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"path\": \"/Homework/math/Prime_Numbers.txt\"\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "download response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "examples": { + "download response": { + "value": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + }, + "/2/files/download_zip": { + "post": { + "tags": [ + "files" + ], + "summary": "download_zip", + "description": "[download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip)\n\nscope: `files.content.read`\n\nDownload a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size.", + "operationId": "downloadZip", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"path\": \"/Homework/math\"\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "download_zip response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXz" + }, + "name": { + "type": "string", + "example": "math" + }, + "path_display": { + "type": "string", + "example": "/Homework/math" + }, + "path_lower": { + "type": "string", + "example": "/homework/math" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "sharing_info": { + "type": "object", + "properties": { + "no_access": { + "type": "boolean", + "example": false + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": false + }, + "traverse_only": { + "type": "boolean", + "example": false + } + } + } + } + } + } + }, + "examples": { + "download_zip response": { + "value": { + "metadata": { + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + } + } + } + } + } + } + } + } + }, + "/2/files/export": { + "post": { + "tags": [ + "files" + ], + "summary": "export", + "description": "[export](https://www.dropbox.com/developers/documentation/http/documentation#files-export)\n\nscope: `files.content.read`\n\nExport a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose `ExportResult.file_metadata` has `ExportInfo.export_as` populated.", + "operationId": "export", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"path\": \"/Homework/math/Prime_Numbers.gsheet\"\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "export response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "export_metadata": { + "type": "object", + "properties": { + "export_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "name": { + "type": "string", + "example": "Prime_Numbers.xlsx" + }, + "size": { + "type": "number", + "example": 7189 + } + } + }, + "file_metadata": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "export response": { + "value": { + "export_metadata": { + "export_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "name": "Prime_Numbers.xlsx", + "size": 7189 + }, + "file_metadata": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/get_file_lock_batch": { + "post": { + "tags": [ + "files" + ], + "summary": "get_file_lock_batch", + "description": "[get_file_lock_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_file_lock_batch)\n\nscope: `files.content.read`\n\nReturn the lock metadata for the given list of paths.", + "operationId": "getFileLockBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/John Doe/sample/test.pdf" + } + } + }, + "example": [ + { + "path": "/John Doe/sample/test.pdf" + } + ] + } + } + }, + "examples": { + "get_file_lock_batch": { + "value": { + "entries": [ + { + "path": "/John Doe/sample/test.pdf" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_file_lock_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "lock": { + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "single_user" + }, + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "lock_holder_account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "lock_holder_team_id": { + "type": "string", + "example": "dbtid:1234abcd" + } + } + } + } + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "lock": { + "content": { + ".tag": "single_user", + "created": "2015-05-12T15:50:38Z", + "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "lock_holder_team_id": "dbtid:1234abcd" + } + }, + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "get_file_lock_batch response": { + "value": { + "entries": [ + { + ".tag": "success", + "lock": { + "content": { + ".tag": "single_user", + "created": "2015-05-12T15:50:38Z", + "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "lock_holder_team_id": "dbtid:1234abcd" + } + }, + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/get_metadata": { + "post": { + "tags": [ + "files" + ], + "summary": "get_metadata", + "description": "[get_metadata](https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata)\n\nscope: `files.metadata.read`\n\nReturns the metadata for a file or folder.\nNote: Metadata for the root folder is unsupported.", + "operationId": "getMetadata", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_deleted": { + "type": "boolean", + "example": false + }, + "include_has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "include_media_info": { + "type": "boolean", + "example": false + }, + "path": { + "type": "string", + "example": "/Homework/math" + } + } + }, + "examples": { + "get_metadata": { + "value": { + "include_deleted": false, + "include_has_explicit_shared_members": false, + "include_media_info": false, + "path": "/Homework/math" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_metadata response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "examples": { + "get_metadata response": { + "value": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + }, + "/2/files/get_preview": { + "post": { + "tags": [ + "files" + ], + "summary": "get_preview", + "description": "[get_preview](https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview)\n\nscope: `files.content.read`\n\nGet a preview for a file.\nCurrently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf.\nHTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx.\nOther formats will return an unsupported extension error.", + "operationId": "getPreview", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"path\": \"/word.docx\"\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "get_preview response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "examples": { + "get_preview response": { + "value": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + }, + "/2/files/get_temporary_link": { + "post": { + "tags": [ + "files" + ], + "summary": "get_temporary_link", + "description": "[get_temporary_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link)\n\nscope: `files.content.read`\n\nGet a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type.", + "operationId": "getTemporaryLink", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/video.mp4" + } + } + }, + "examples": { + "get_temporary_link": { + "value": { + "path": "/video.mp4" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_temporary_link response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "link": { + "type": "string", + "example": "https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2" + }, + "metadata": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "get_temporary_link response": { + "value": { + "link": "https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2", + "metadata": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/get_temporary_upload_link": { + "post": { + "tags": [ + "files" + ], + "summary": "get_temporary_upload_link", + "description": "[get_temporary_upload_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_upload_link)\n\nscope: `files.content.write`\n\nGet a one-time use temporary upload link to upload a file to a Dropbox location.\n\nThis endpoint acts as a delayed `upload`. The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the `CommitInfo` previously provided to `get_temporary_upload_link` but evaluated only upon consumption. Hence, errors stemming from invalid `CommitInfo` with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time.\n\nThe POST request on the temporary upload link must have its Content-Type set to \"application/octet-stream\".\n\nExample temporary upload link consumption request:\n\ncurl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND\n--header \"Content-Type: application/octet-stream\"\n--data-binary @local_file.txt\n\nA successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format.\n\nExample succesful temporary upload link consumption response:\n{\"content-hash\": \"599d71033d700ac892a0e48fa61b125d2f5994\"}\n\nAn unsuccessful temporary upload link consumption request returns any of the following status codes:\n\nHTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid.\nHTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened.\nHTTP 410 Gone: The temporary upload link is expired or consumed.\n\nExample unsuccessful temporary upload link consumption response:\nTemporary upload link has been recently consumed.", + "operationId": "getTemporaryUploadLink", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_info": { + "type": "object", + "properties": { + "autorename": { + "type": "boolean", + "example": true + }, + "mode": { + "type": "string", + "example": "add" + }, + "mute": { + "type": "boolean", + "example": false + }, + "path": { + "type": "string", + "example": "/Homework/math/Matrices.txt" + }, + "strict_conflict": { + "type": "boolean", + "example": false + } + } + }, + "duration": { + "type": "number", + "example": 3600 + } + } + }, + "examples": { + "get_temporary_upload_link": { + "value": { + "commit_info": { + "autorename": true, + "mode": "add", + "mute": false, + "path": "/Homework/math/Matrices.txt", + "strict_conflict": false + }, + "duration": 3600 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_temporary_upload_link response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "link": { + "type": "string", + "example": "https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND" + } + } + }, + "examples": { + "get_temporary_upload_link response": { + "value": { + "link": "https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND" + } + } + } + } + } + } + } + } + }, + "/2/files/get_thumbnail_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "get_thumbnail", + "description": "[get_thumbnail](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail)\n\nscope: `files.content.read`\n\nGet a thumbnail for a file.", + "operationId": "getThumbnail", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"resource\": {\n \".tag\": \"path\", \n \"path\": \"/a.docx\"\n }, \n \"format\": \"jpeg\", \n \"size\": \"w64h64\", \n \"mode\": \"strict\"\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "get_thumbnail response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file_metadata": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "get_thumbnail response": { + "value": { + "file_metadata": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/get_thumbnail_batch": { + "post": { + "tags": [ + "files" + ], + "summary": "get_thumbnail_batch", + "description": "[get_thumbnail_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch)\n\nscope: `files.content.read`\n\nGet thumbnails for a list of images. We allow up to 25 thumbnails in a single batch.\nThis method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.", + "operationId": "getThumbnailBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "format": { + "type": "string", + "example": "jpeg" + }, + "mode": { + "type": "string", + "example": "strict" + }, + "path": { + "type": "string", + "example": "/image.jpg" + }, + "size": { + "type": "string", + "example": "w64h64" + } + } + }, + "example": [ + { + "format": "jpeg", + "mode": "strict", + "path": "/image.jpg", + "size": "w64h64" + } + ] + } + } + }, + "examples": { + "get_thumbnail_batch": { + "value": { + "entries": [ + { + "format": "jpeg", + "mode": "strict", + "path": "/image.jpg", + "size": "w64h64" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_thumbnail_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "metadata": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "thumbnail": { + "type": "string", + "example": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" + } + } + }, + "example": [ + { + ".tag": "success", + "metadata": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + }, + "thumbnail": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" + } + ] + } + } + }, + "examples": { + "get_thumbnail_batch response": { + "value": { + "entries": [ + { + ".tag": "success", + "metadata": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + }, + "thumbnail": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/list_folder": { + "post": { + "tags": [ + "files" + ], + "summary": "list_folder", + "description": "[list_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder)\n\nscope: `files.metadata.read`\n\nStarts returning the contents of a folder. If the result's `ListFolderResult.has_more` field is `true`, call `list_folder/continue` with the returned `ListFolderResult.cursor` to retrieve more entries.\nIf you're using `ListFolderArg.recursive` set to `true` to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync:\nFor each `FileMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children.\nFor each `FolderMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's `FolderSharingInfo.read_only` and set all its children's read-only statuses to match.\nFor each `DeletedMetadata`, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry.\nNote: `auth.RateLimitError` may be returned if multiple `list_folder` or `list_folder/continue` calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.", + "operationId": "listFolder", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_deleted": { + "type": "boolean", + "example": false + }, + "include_has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "include_media_info": { + "type": "boolean", + "example": false + }, + "include_mounted_folders": { + "type": "boolean", + "example": true + }, + "include_non_downloadable_files": { + "type": "boolean", + "example": true + }, + "path": { + "type": "string", + "example": "/Homework/math" + }, + "recursive": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "list_folder": { + "value": { + "include_deleted": false, + "include_has_explicit_shared_members": false, + "include_media_info": false, + "include_mounted_folders": true, + "include_non_downloadable_files": true, + "path": "/Homework/math", + "recursive": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_folder response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "no_access": { + "type": "boolean", + "example": false + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + }, + "traverse_only": { + "type": "boolean", + "example": false + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "example": [ + { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + }, + { + ".tag": "folder", + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "list_folder response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "entries": [ + { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + }, + { + ".tag": "folder", + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + ], + "has_more": false + } + } + } + } + } + } + } + } + }, + "/2/files/list_folder/continue": { + "post": { + "tags": [ + "files" + ], + "summary": "list_folder/continue", + "description": "[list_folder/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue)\n\nscope: `files.metadata.read`\n\nOnce a cursor has been retrieved from `list_folder`, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for `list_folder`.", + "operationId": "listFolderContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list_folder/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_folder/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "no_access": { + "type": "boolean", + "example": false + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + }, + "traverse_only": { + "type": "boolean", + "example": false + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "example": [ + { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + }, + { + ".tag": "folder", + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "list_folder/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "entries": [ + { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + }, + { + ".tag": "folder", + "id": "id:a4ayc_80_OEAAAAAAAAAXz", + "name": "math", + "path_display": "/Homework/math", + "path_lower": "/homework/math", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "sharing_info": { + "no_access": false, + "parent_shared_folder_id": "84528192421", + "read_only": false, + "traverse_only": false + } + } + ], + "has_more": false + } + } + } + } + } + } + } + } + }, + "/2/files/list_folder/get_latest_cursor": { + "post": { + "tags": [ + "files" + ], + "summary": "list_folder/get_latest_cursor", + "description": "[list_folder/get_latest_cursor](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-get_latest_cursor)\n\nscope: `files.metadata.read`\n\nA way to quickly get a cursor for the folder's state. Unlike `list_folder`, `list_folder/get_latest_cursor` doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.", + "operationId": "listFolderGetLatestCursor", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_deleted": { + "type": "boolean", + "example": false + }, + "include_has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "include_media_info": { + "type": "boolean", + "example": false + }, + "include_mounted_folders": { + "type": "boolean", + "example": true + }, + "include_non_downloadable_files": { + "type": "boolean", + "example": true + }, + "path": { + "type": "string", + "example": "/Homework/math" + }, + "recursive": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "list_folder/get_latest_cursor": { + "value": { + "include_deleted": false, + "include_has_explicit_shared_members": false, + "include_media_info": false, + "include_mounted_folders": true, + "include_non_downloadable_files": true, + "path": "/Homework/math", + "recursive": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_folder/get_latest_cursor response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list_folder/get_latest_cursor response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + } + } + } + }, + "/2/files/list_folder/longpoll": { + "post": { + "tags": [ + "files" + ], + "summary": "list_folder/longpoll", + "description": "[list_folder/longpoll](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-longpoll)\n\nscope: `files.metadata.read`\n\nA longpoll endpoint to wait for changes on an account. In conjunction with `list_folder/continue`, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps. If you're looking for server-side notifications, check out our [webhooks documentation](https://www.dropbox.com/developers/reference/webhooks).", + "operationId": "listFolderLongpoll", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "timeout": { + "type": "number", + "example": 30 + } + } + }, + "examples": { + "list_folder/longpoll": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "timeout": 30 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_folder/longpoll response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "changes": { + "type": "boolean", + "example": true + } + } + }, + "examples": { + "list_folder/longpoll response": { + "value": { + "changes": true + } + } + } + } + } + } + } + } + }, + "/2/files/list_revisions": { + "post": { + "tags": [ + "files" + ], + "summary": "list_revisions", + "description": "[list_revisions](https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions)\n\nscope: `files.metadata.read`\n\nReturns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately.\nIn the `ListRevisionsMode.path` (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to `ListRevisionsMode.id`. The `ListRevisionsMode.id` mode is useful to retrieve revisions for a given file across moves or renames.", + "operationId": "listRevisions", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "number", + "example": 10 + }, + "mode": { + "type": "string", + "example": "path" + }, + "path": { + "type": "string", + "example": "/root/word.docx" + } + } + }, + "examples": { + "list_revisions": { + "value": { + "limit": 10, + "mode": "path", + "path": "/root/word.docx" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_revisions response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "example": [ + { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + ] + }, + "is_deleted": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "list_revisions response": { + "value": { + "entries": [ + { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + ], + "is_deleted": false + } + } + } + } + } + } + } + } + }, + "/2/files/lock_file_batch": { + "post": { + "tags": [ + "files" + ], + "summary": "lock_file_batch", + "description": "[lock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-lock_file_batch)\n\nscope: `files.content.write`\n\nLock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.", + "operationId": "lockFileBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/John Doe/sample/test.pdf" + } + } + }, + "example": [ + { + "path": "/John Doe/sample/test.pdf" + } + ] + } + } + }, + "examples": { + "lock_file_batch": { + "value": { + "entries": [ + { + "path": "/John Doe/sample/test.pdf" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "lock_file_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "lock": { + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "single_user" + }, + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "lock_holder_account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "lock_holder_team_id": { + "type": "string", + "example": "dbtid:1234abcd" + } + } + } + } + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "lock": { + "content": { + ".tag": "single_user", + "created": "2015-05-12T15:50:38Z", + "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "lock_holder_team_id": "dbtid:1234abcd" + } + }, + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "lock_file_batch response": { + "value": { + "entries": [ + { + ".tag": "success", + "lock": { + "content": { + ".tag": "single_user", + "created": "2015-05-12T15:50:38Z", + "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "lock_holder_team_id": "dbtid:1234abcd" + } + }, + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/move_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "move", + "description": "[move](https://www.dropbox.com/developers/documentation/http/documentation#files-move)\n\nscope: `files.content.write`\n\nMove a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be moved.\nNote that we do not currently support case-only renaming.", + "operationId": "move", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_ownership_transfer": { + "type": "boolean", + "example": false + }, + "allow_shared_folder": { + "type": "boolean", + "example": false + }, + "autorename": { + "type": "boolean", + "example": false + }, + "from_path": { + "type": "string", + "example": "/Homework/math" + }, + "to_path": { + "type": "string", + "example": "/Homework/algebra" + } + } + }, + "examples": { + "move": { + "value": { + "allow_ownership_transfer": false, + "allow_shared_folder": false, + "autorename": false, + "from_path": "/Homework/math", + "to_path": "/Homework/algebra" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "move response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "examples": { + "move response": { + "value": { + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + } + }, + "/2/files/move_batch_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "move_batch", + "description": "[move_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch)\n\nscope: `files.content.write`\n\nMove multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming.\nThis route will replace `move_batch:1`. The main difference is this route will return status for each entry, while `move_batch:1` raises failure if any entry fails.\nThis route will either finish synchronously, or return a job ID and do the async move job in background. Please use `move_batch/check:2` to check the job status.", + "operationId": "moveBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_ownership_transfer": { + "type": "boolean", + "example": false + }, + "autorename": { + "type": "boolean", + "example": false + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "from_path": { + "type": "string", + "example": "/Homework/math" + }, + "to_path": { + "type": "string", + "example": "/Homework/algebra" + } + } + }, + "example": [ + { + "from_path": "/Homework/math", + "to_path": "/Homework/algebra" + } + ] + } + } + }, + "examples": { + "move_batch": { + "value": { + "allow_ownership_transfer": false, + "autorename": false, + "entries": [ + { + "from_path": "/Homework/math", + "to_path": "/Homework/algebra" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "move_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "success": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "move_batch response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/move_batch/check_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "move_batch/check", + "description": "[move_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `move_batch:2`. It returns list of results for each entry.", + "operationId": "moveBatchCheck", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "move_batch/check": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "move_batch/check response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "success": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "move_batch/check response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "success": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/permanently_delete": { + "post": { + "tags": [ + "files" + ], + "summary": "permanently_delete", + "description": "[permanently_delete](https://www.dropbox.com/developers/documentation/http/documentation#files-permanently_delete)\n\nscope: `files.permanent_delete`\n\nPermanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).\nNote: This endpoint is only available for Dropbox Business apps.", + "operationId": "permanentlyDelete", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + } + } + }, + "examples": { + "permanently_delete": { + "value": { + "path": "/Homework/math/Prime_Numbers.txt" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/files/restore": { + "post": { + "tags": [ + "files" + ], + "summary": "restore", + "description": "[restore](https://www.dropbox.com/developers/documentation/http/documentation#files-restore)\n\nscope: `files.content.write`\n\nRestore a specific revision of a file to the given path.", + "operationId": "restore", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/root/word.docx" + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + } + } + }, + "examples": { + "restore": { + "value": { + "path": "/root/word.docx", + "rev": "a1c10ce0dd78" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "restore response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "examples": { + "restore response": { + "value": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + }, + "/2/files/save_url": { + "post": { + "tags": [ + "files" + ], + "summary": "save_url", + "description": "[save_url](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url)\n\nscope: `files.content.write`\n\nSave the data from a specified URL into a file in user's Dropbox.\nNote that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail.\nIf the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).", + "operationId": "saveUrl", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/a.txt" + }, + "url": { + "type": "string", + "example": "http://example.com/a.txt" + } + } + }, + "examples": { + "save_url": { + "value": { + "path": "/a.txt", + "url": "http://example.com/a.txt" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "save_url response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "examples": { + "save_url response": { + "value": { + ".tag": "complete", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + }, + "/2/files/save_url/check_job_status": { + "post": { + "tags": [ + "files" + ], + "summary": "save_url/check_job_status", + "description": "[save_url/check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url-check_job_status)\n\nscope: `files.content.write`\n\nCheck the status of a `save_url` job.", + "operationId": "saveUrlCheckJobStatus", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "save_url/check_job_status": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "save_url/check_job_status response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "in_progress" + } + } + }, + "examples": { + "save_url/check_job_status response": { + "value": { + ".tag": "in_progress" + } + } + } + } + } + } + } + } + }, + "/2/files/search_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "search", + "description": "[search](https://www.dropbox.com/developers/documentation/http/documentation#files-search)\n\nscope: `files.metadata.read`\n\nSearches for files and folders.\nNote: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches.\nRecent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.", + "operationId": "search", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_highlights": { + "type": "boolean", + "example": false + }, + "query": { + "type": "string", + "example": "cat" + } + } + }, + "examples": { + "search": { + "value": { + "include_highlights": false, + "query": "cat" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "search response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "has_more": { + "type": "boolean", + "example": false + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "metadata" + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + } + } + }, + "example": [ + { + "metadata": { + ".tag": "metadata", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + ] + } + } + }, + "examples": { + "search response": { + "value": { + "has_more": false, + "matches": [ + { + "metadata": { + ".tag": "metadata", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/search/continue_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "search/continue", + "description": "[search/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-search-continue)\n\nscope: `files.metadata.read`\n\nFetches the next page of search results returned from `search:2`.\nNote: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches.\nRecent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.", + "operationId": "searchContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "search/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "search/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "has_more": { + "type": "boolean", + "example": false + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "metadata" + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + } + } + }, + "example": [ + { + "metadata": { + ".tag": "metadata", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + ] + } + } + }, + "examples": { + "search/continue response": { + "value": { + "has_more": false, + "matches": [ + { + "metadata": { + ".tag": "metadata", + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/unlock_file_batch": { + "post": { + "tags": [ + "files" + ], + "summary": "unlock_file_batch", + "description": "[unlock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-unlock_file_batch)\n\nscope: `files.content.write`\n\nUnlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.", + "operationId": "unlockFileBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/John Doe/sample/test.pdf" + } + } + }, + "example": [ + { + "path": "/John Doe/sample/test.pdf" + } + ] + } + } + }, + "examples": { + "unlock_file_batch": { + "value": { + "entries": [ + { + "path": "/John Doe/sample/test.pdf" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "unlock_file_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "lock": { + "type": "object", + "properties": { + "content": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "single_user" + }, + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "lock_holder_account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "lock_holder_team_id": { + "type": "string", + "example": "dbtid:1234abcd" + } + } + } + } + }, + "metadata": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "lock": { + "content": { + ".tag": "single_user", + "created": "2015-05-12T15:50:38Z", + "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "lock_holder_team_id": "dbtid:1234abcd" + } + }, + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + }, + "examples": { + "unlock_file_batch response": { + "value": { + "entries": [ + { + ".tag": "success", + "lock": { + "content": { + ".tag": "single_user", + "created": "2015-05-12T15:50:38Z", + "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "lock_holder_team_id": "dbtid:1234abcd" + } + }, + "metadata": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/upload": { + "post": { + "tags": [ + "files" + ], + "summary": "upload", + "description": "[upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload)\n\nscope: `files.content.write`\n\nCreate a new file with the contents provided in the request.\nDo not use this to upload a file larger than 150 MB. Instead, create an upload session with `upload_session/start`.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", + "operationId": "upload", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\": false\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "upload response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "examples": { + "upload response": { + "value": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + }, + "/2/files/upload_session/append_v2": { + "post": { + "tags": [ + "files" + ], + "summary": "upload_session/append", + "description": "[upload_session/append](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append)\n\nscope: `files.content.write`\n\nAppend more data to an upload session.\nWhen the parameter close is set, this call will close the session.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", + "operationId": "uploadSessionAppend", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\", \n \"offset\": 0\n }, \n \"close\": false\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/files/upload_session/finish": { + "post": { + "tags": [ + "files" + ], + "summary": "upload_session/finish", + "description": "[upload_session/finish](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish)\n\nscope: `files.content.write`\n\nFinish an upload session and save the uploaded data to the given file path.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", + "operationId": "uploadSessionFinish", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\", \n \"offset\": 0\n }, \n \"commit\": {\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\": false\n }\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "upload_session/finish response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "examples": { + "upload_session/finish response": { + "value": { + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + } + } + } + } + } + } + } + }, + "/2/files/upload_session/finish_batch": { + "post": { + "tags": [ + "files" + ], + "summary": "upload_session/finish_batch", + "description": "[upload_session/finish_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch)\n\nscope: `files.content.write`\n\nThis route helps you commit many files at once into a user's Dropbox. Use `upload_session/start` and `upload_session/append:2` to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling `upload_session/finish`, use this route to finish all your upload sessions in a single request.\n`UploadSessionStartArg.close` or `UploadSessionAppendArg.close` needs to be true for the last `upload_session/start` or `upload_session/append:2` call. The maximum size of a file one can upload to an upload session is 350 GB.\nThis route will return a job_id immediately and do the async commit job in background. Use `upload_session/finish_batch/check` to check the job status.\nFor the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", + "operationId": "uploadSessionFinishBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "object", + "properties": { + "autorename": { + "type": "boolean", + "example": true + }, + "mode": { + "type": "string", + "example": "add" + }, + "mute": { + "type": "boolean", + "example": false + }, + "path": { + "type": "string", + "example": "/Homework/math/Matrices.txt" + }, + "strict_conflict": { + "type": "boolean", + "example": false + } + } + }, + "cursor": { + "type": "object", + "properties": { + "offset": { + "type": "number", + "example": 0 + }, + "session_id": { + "type": "string", + "example": "1234faaf0678bcde" + } + } + } + } + }, + "example": [ + { + "commit": { + "autorename": true, + "mode": "add", + "mute": false, + "path": "/Homework/math/Matrices.txt", + "strict_conflict": false + }, + "cursor": { + "offset": 0, + "session_id": "1234faaf0678bcde" + } + } + ] + } + } + }, + "examples": { + "upload_session/finish_batch": { + "value": { + "entries": [ + { + "commit": { + "autorename": true, + "mode": "add", + "mute": false, + "path": "/Homework/math/Matrices.txt", + "strict_conflict": false + }, + "cursor": { + "offset": 0, + "session_id": "1234faaf0678bcde" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "upload_session/finish_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "example": [ + { + ".tag": "success", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + ] + } + } + }, + "examples": { + "upload_session/finish_batch response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/upload_session/finish_batch/check": { + "post": { + "tags": [ + "files" + ], + "summary": "upload_session/finish_batch/check", + "description": "[upload_session/finish_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `upload_session/finish_batch`. If success, it returns list of result for each entry.", + "operationId": "uploadSessionFinishBatchCheck", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "upload_session/finish_batch/check": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "upload_session/finish_batch/check response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "content_hash": { + "type": "string", + "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + }, + "file_lock_info": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "is_lockholder": { + "type": "boolean", + "example": true + }, + "lockholder_name": { + "type": "string", + "example": "Imaginary User" + } + } + }, + "has_explicit_shared_members": { + "type": "boolean", + "example": false + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "is_downloadable": { + "type": "boolean", + "example": true + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_display": { + "type": "string", + "example": "/Homework/math/Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "property_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Security Policy" + }, + "value": { + "type": "string", + "example": "Confidential" + } + } + }, + "example": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ] + }, + "template_id": { + "type": "string", + "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + } + }, + "example": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ] + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "sharing_info": { + "type": "object", + "properties": { + "modified_by": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "parent_shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "read_only": { + "type": "boolean", + "example": true + } + } + }, + "size": { + "type": "number", + "example": 7212 + } + } + }, + "example": [ + { + ".tag": "success", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + ] + } + } + }, + "examples": { + "upload_session/finish_batch/check response": { + "value": { + ".tag": "complete", + "entries": [ + { + ".tag": "success", + "client_modified": "2015-05-12T15:50:38Z", + "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "file_lock_info": { + "created": "2015-05-12T15:50:38Z", + "is_lockholder": true, + "lockholder_name": "Imaginary User" + }, + "has_explicit_shared_members": false, + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "is_downloadable": true, + "name": "Prime_Numbers.txt", + "path_display": "/Homework/math/Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "property_groups": [ + { + "fields": [ + { + "name": "Security Policy", + "value": "Confidential" + } + ], + "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" + } + ], + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "sharing_info": { + "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "parent_shared_folder_id": "84528192421", + "read_only": true + }, + "size": 7212 + } + ] + } + } + } + } + } + } + } + } + }, + "/2/files/upload_session/start": { + "post": { + "tags": [ + "files" + ], + "summary": "upload_session/start", + "description": "[upload_session/start](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start)\n\nscope: `files.content.write`\n\nUpload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. This call starts a new upload session with the given data. You can then use `upload_session/append:2` to add more data and `upload_session/finish` to save all the data to a file in Dropbox.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nAn upload session can be used for a maximum of 48 hours. Attempting to use an `UploadSessionStartResult.session_id` with `upload_session/append:2` or `upload_session/finish` more than 48 hours after its creation will return a `UploadSessionLookupError.not_found`.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", + "operationId": "uploadSessionStart", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"close\": false\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "upload_session/start response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "session_id": { + "type": "string", + "example": "1234faaf0678bcde" + } + } + }, + "examples": { + "upload_session/start response": { + "value": { + "session_id": "1234faaf0678bcde" + } + } + } + } + } + } + } + } + }, + "/2/sharing/add_file_member": { + "post": { + "tags": [ + "sharing" + ], + "summary": "add_file_member", + "description": "[add_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member)\n\nscope: `sharing.write`\n\nAdds specified members to a file.", + "operationId": "addFileMember", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "example": "viewer" + }, + "add_message_as_comment": { + "type": "boolean", + "example": false + }, + "custom_message": { + "type": "string", + "example": "This is a custom message about ACME.doc" + }, + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "justin@example.com" + } + } + }, + "example": [ + { + ".tag": "email", + "email": "justin@example.com" + } + ] + }, + "quiet": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "add_file_member": { + "value": { + "access_level": "viewer", + "add_message_as_comment": false, + "custom_message": "This is a custom message about ACME.doc", + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "members": [ + { + ".tag": "email", + "email": "justin@example.com" + } + ], + "quiet": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "add_file_member response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "member": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "justin@example.com" + } + } + }, + "result": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + } + } + } + } + }, + "example": [ + { + "member": { + ".tag": "email", + "email": "justin@example.com" + }, + "result": { + ".tag": "success" + } + } + ] + }, + "examples": { + "add_file_member response": { + "value": [ + { + "member": { + ".tag": "email", + "email": "justin@example.com" + }, + "result": { + ".tag": "success" + } + } + ] + } + } + } + } + } + } + } + }, + "/2/sharing/add_folder_member": { + "post": { + "tags": [ + "sharing" + ], + "summary": "add_folder_member", + "description": "[add_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.\nFor the new member to get access to all the functionality for this folder, you will need to call `mount_folder` on their behalf.", + "operationId": "addFolderMember", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "custom_message": { + "type": "string", + "example": "Documentation for launch day" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "example": "editor" + }, + "member": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "dropbox_id": { + "type": "string", + "example": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" + }, + "email": { + "type": "string", + "example": "justin@example.com" + } + } + } + } + }, + "example": [ + { + "access_level": "editor", + "member": { + ".tag": "email", + "email": "justin@example.com" + } + }, + { + "access_level": "viewer", + "member": { + ".tag": "dropbox_id", + "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" + } + } + ] + }, + "quiet": { + "type": "boolean", + "example": false + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "add_folder_member": { + "value": { + "custom_message": "Documentation for launch day", + "members": [ + { + "access_level": "editor", + "member": { + ".tag": "email", + "email": "justin@example.com" + } + }, + { + "access_level": "viewer", + "member": { + ".tag": "dropbox_id", + "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" + } + } + ], + "quiet": false, + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/sharing/check_job_status": { + "post": { + "tags": [ + "sharing" + ], + "summary": "check_job_status", + "description": "[check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job.", + "operationId": "checkJobStatus", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "check_job_status": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "check_job_status response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "in_progress" + } + } + }, + "examples": { + "check_job_status response": { + "value": { + ".tag": "in_progress" + } + } + } + } + } + } + } + } + }, + "/2/sharing/check_remove_member_job_status": { + "post": { + "tags": [ + "sharing" + ], + "summary": "check_remove_member_job_status", + "description": "[check_remove_member_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job for sharing a folder.", + "operationId": "checkRemoveMemberJobStatus", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "check_remove_member_job_status": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "check_remove_member_job_status response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "check_remove_member_job_status response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/sharing/check_share_job_status": { + "post": { + "tags": [ + "sharing" + ], + "summary": "check_share_job_status", + "description": "[check_share_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_share_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job for sharing a folder.", + "operationId": "checkShareJobStatus", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "check_share_job_status": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "check_share_job_status response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "examples": { + "check_share_job_status response": { + "value": { + ".tag": "complete", + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + } + } + } + } + } + } + } + }, + "/2/sharing/get_file_metadata": { + "post": { + "tags": [ + "sharing" + ], + "summary": "get_file_metadata", + "description": "[get_file_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata)\n\nscope: `sharing.read`\n\nReturns shared file metadata.", + "operationId": "getFileMetadata", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": {}, + "example": [] + }, + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + } + } + }, + "examples": { + "get_file_metadata": { + "value": { + "actions": [], + "file": "id:3kmLmQFnf1AAAAAAAAAAAw" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_file_metadata response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "id": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "name": { + "type": "string", + "example": "file.txt" + }, + "owner_display_names": { + "type": "array", + "items": { + "type": "string", + "example": "Jane Doe" + }, + "example": [ + "Jane Doe" + ] + }, + "owner_team": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + }, + "path_display": { + "type": "string", + "example": "/dir/file.txt" + }, + "path_lower": { + "type": "string", + "example": "/dir/file.txt" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fi/fir9vjelf" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "examples": { + "get_file_metadata response": { + "value": { + "access_type": { + ".tag": "viewer" + }, + "id": "id:3kmLmQFnf1AAAAAAAAAAAw", + "name": "file.txt", + "owner_display_names": [ + "Jane Doe" + ], + "owner_team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + }, + "path_display": "/dir/file.txt", + "path_lower": "/dir/file.txt", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", + "time_invited": "2016-01-20T00:00:00Z" + } + } + } + } + } + } + } + } + }, + "/2/sharing/get_file_metadata/batch": { + "post": { + "tags": [ + "sharing" + ], + "summary": "get_file_metadata/batch", + "description": "[get_file_metadata/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch)\n\nscope: `sharing.read`\n\nReturns shared file metadata.", + "operationId": "getFileMetadataBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": {}, + "example": [] + }, + "files": { + "type": "array", + "items": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "example": [ + "id:3kmLmQFnf1AAAAAAAAAAAw", + "id:VvTaJu2VZzAAAAAAAAAADQ" + ] + } + } + }, + "examples": { + "get_file_metadata/batch": { + "value": { + "actions": [], + "files": [ + "id:3kmLmQFnf1AAAAAAAAAAAw", + "id:VvTaJu2VZzAAAAAAAAAADQ" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_file_metadata/batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "result": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "metadata" + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "id": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "name": { + "type": "string", + "example": "file.txt" + }, + "owner_display_names": { + "type": "array", + "items": { + "type": "string", + "example": "Jane Doe" + }, + "example": [ + "Jane Doe" + ] + }, + "owner_team": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + }, + "path_display": { + "type": "string", + "example": "/dir/file.txt" + }, + "path_lower": { + "type": "string", + "example": "/dir/file.txt" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fi/fir9vjelf" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + } + } + }, + "example": [ + { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "result": { + ".tag": "metadata", + "access_type": { + ".tag": "viewer" + }, + "id": "id:3kmLmQFnf1AAAAAAAAAAAw", + "name": "file.txt", + "owner_display_names": [ + "Jane Doe" + ], + "owner_team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + }, + "path_display": "/dir/file.txt", + "path_lower": "/dir/file.txt", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", + "time_invited": "2016-01-20T00:00:00Z" + } + } + ] + }, + "examples": { + "get_file_metadata/batch response": { + "value": [ + { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "result": { + ".tag": "metadata", + "access_type": { + ".tag": "viewer" + }, + "id": "id:3kmLmQFnf1AAAAAAAAAAAw", + "name": "file.txt", + "owner_display_names": [ + "Jane Doe" + ], + "owner_team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + }, + "path_display": "/dir/file.txt", + "path_lower": "/dir/file.txt", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", + "time_invited": "2016-01-20T00:00:00Z" + } + } + ] + } + } + } + } + } + } + } + }, + "/2/sharing/get_folder_metadata": { + "post": { + "tags": [ + "sharing" + ], + "summary": "get_folder_metadata", + "description": "[get_folder_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata)\n\nscope: `sharing.read`\n\nReturns shared folder metadata by its folder ID.", + "operationId": "getFolderMetadata", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": {}, + "example": [] + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "get_folder_metadata": { + "value": { + "actions": [], + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_folder_metadata response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "examples": { + "get_folder_metadata response": { + "value": { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + } + } + } + } + } + } + } + }, + "/2/sharing/get_shared_link_file": { + "post": { + "tags": [ + "sharing" + ], + "summary": "get_shared_link_file", + "description": "[get_shared_link_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file)\n\nscope: `sharing.read`\n\nDownload the shared link's file from a user's Dropbox.", + "operationId": "getSharedLinkFile", + "parameters": [ + { + "name": "dropbox-api-arg", + "in": "header", + "schema": { + "type": "string", + "example": "{\n \"url\": \"https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0\", \n \"path\": \"/Prime_Numbers.txt\"\n}" + } + }, + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "get_shared_link_file response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "link_permissions": { + "type": "object", + "properties": { + "can_revoke": { + "type": "boolean", + "example": false + }, + "resolved_visibility": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "revoke_failure_reason": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner_only" + } + } + } + } + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "size": { + "type": "number", + "example": 7212 + }, + "team_member_info": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "Roger Rabbit" + }, + "member_id": { + "type": "string", + "example": "dbmid:abcd1234" + }, + "team_info": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + } + } + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + }, + "examples": { + "get_shared_link_file response": { + "value": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "link_permissions": { + "can_revoke": false, + "resolved_visibility": { + ".tag": "public" + }, + "revoke_failure_reason": { + ".tag": "owner_only" + } + }, + "name": "Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "size": 7212, + "team_member_info": { + "display_name": "Roger Rabbit", + "member_id": "dbmid:abcd1234", + "team_info": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + } + }, + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + } + } + } + } + } + } + }, + "/2/sharing/get_shared_link_metadata": { + "post": { + "tags": [ + "sharing" + ], + "summary": "get_shared_link_metadata", + "description": "[get_shared_link_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_metadata)\n\nscope: `sharing.read`\n\nGet the shared link's metadata.", + "operationId": "getSharedLinkMetadata", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/Prime_Numbers.txt" + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + }, + "examples": { + "get_shared_link_metadata": { + "value": { + "path": "/Prime_Numbers.txt", + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_shared_link_metadata response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "link_permissions": { + "type": "object", + "properties": { + "can_revoke": { + "type": "boolean", + "example": false + }, + "resolved_visibility": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "revoke_failure_reason": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner_only" + } + } + } + } + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "size": { + "type": "number", + "example": 7212 + }, + "team_member_info": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "Roger Rabbit" + }, + "member_id": { + "type": "string", + "example": "dbmid:abcd1234" + }, + "team_info": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + } + } + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + }, + "examples": { + "get_shared_link_metadata response": { + "value": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "link_permissions": { + "can_revoke": false, + "resolved_visibility": { + ".tag": "public" + }, + "revoke_failure_reason": { + ".tag": "owner_only" + } + }, + "name": "Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "size": 7212, + "team_member_info": { + "display_name": "Roger Rabbit", + "member_id": "dbmid:abcd1234", + "team_info": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + } + }, + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_file_members": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_file_members", + "description": "[list_file_members](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members)\n\nscope: `sharing.read`\n\nUse to obtain the members who have been invited to a file, both inherited and uninherited members.", + "operationId": "listFileMembers", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "include_inherited": { + "type": "boolean", + "example": true + }, + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "list_file_members": { + "value": { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "include_inherited": true, + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_file_members response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "editor" + } + } + }, + "group": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "Test group" + }, + "group_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "is_member": { + "type": "boolean", + "example": false + }, + "is_owner": { + "type": "boolean", + "example": false + }, + "member_count": { + "type": "number", + "example": 10 + }, + "same_team": { + "type": "boolean", + "example": true + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "invitees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "invitee": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "jessica@example.com" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "platform_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "unknown" + } + } + }, + "time_last_seen": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + }, + "user": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "display_name": { + "type": "string", + "example": "Robert Smith" + }, + "email": { + "type": "string", + "example": "bob@example.com" + }, + "same_team": { + "type": "boolean", + "example": true + }, + "team_member_id": { + "type": "string", + "example": "dbmid:abcd1234" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "platform_type": { + ".tag": "unknown" + }, + "time_last_seen": "2016-01-20T00:00:00Z", + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + }, + "examples": { + "list_file_members response": { + "value": { + "groups": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ], + "invitees": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ], + "users": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "platform_type": { + ".tag": "unknown" + }, + "time_last_seen": "2016-01-20T00:00:00Z", + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_file_members/batch": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_file_members/batch", + "description": "[list_file_members/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch)\n\nscope: `sharing.read`\n\nGet members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.\nInherited users and groups are not included in the result, and permissions are not returned for this endpoint.", + "operationId": "listFileMembersBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "files": { + "type": "array", + "items": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "example": [ + "id:3kmLmQFnf1AAAAAAAAAAAw", + "id:VvTaJu2VZzAAAAAAAAAADQ" + ] + }, + "limit": { + "type": "number", + "example": 10 + } + } + }, + "examples": { + "list_file_members/batch": { + "value": { + "files": [ + "id:3kmLmQFnf1AAAAAAAAAAAw", + "id:VvTaJu2VZzAAAAAAAAAADQ" + ], + "limit": 10 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_file_members/batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "result": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "result" + }, + "member_count": { + "type": "number", + "example": 3 + }, + "members": { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "editor" + } + } + }, + "group": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "Test group" + }, + "group_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "is_member": { + "type": "boolean", + "example": false + }, + "is_owner": { + "type": "boolean", + "example": false + }, + "member_count": { + "type": "number", + "example": 10 + }, + "same_team": { + "type": "boolean", + "example": true + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "invitees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "invitee": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "jessica@example.com" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "platform_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "unknown" + } + } + }, + "time_last_seen": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + }, + "user": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "display_name": { + "type": "string", + "example": "Robert Smith" + }, + "email": { + "type": "string", + "example": "bob@example.com" + }, + "same_team": { + "type": "boolean", + "example": true + }, + "team_member_id": { + "type": "string", + "example": "dbmid:abcd1234" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "platform_type": { + ".tag": "unknown" + }, + "time_last_seen": "2016-01-20T00:00:00Z", + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + } + } + } + } + }, + "example": [ + { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "result": { + ".tag": "result", + "member_count": 3, + "members": { + "groups": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ], + "invitees": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ], + "users": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "platform_type": { + ".tag": "unknown" + }, + "time_last_seen": "2016-01-20T00:00:00Z", + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + } + ] + }, + "examples": { + "list_file_members/batch response": { + "value": [ + { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "result": { + ".tag": "result", + "member_count": 3, + "members": { + "groups": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ], + "invitees": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ], + "users": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "platform_type": { + ".tag": "unknown" + }, + "time_last_seen": "2016-01-20T00:00:00Z", + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + } + ] + } + } + } + } + } + } + } + }, + "/2/sharing/list_file_members/continue": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_file_members/continue", + "description": "[list_file_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_file_members` or `list_file_members/batch`, use this to paginate through all shared file members.", + "operationId": "listFileMembersContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list_file_members/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_file_members/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "editor" + } + } + }, + "group": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "Test group" + }, + "group_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "is_member": { + "type": "boolean", + "example": false + }, + "is_owner": { + "type": "boolean", + "example": false + }, + "member_count": { + "type": "number", + "example": 10 + }, + "same_team": { + "type": "boolean", + "example": true + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "invitees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "invitee": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "jessica@example.com" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "platform_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "unknown" + } + } + }, + "time_last_seen": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + }, + "user": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "display_name": { + "type": "string", + "example": "Robert Smith" + }, + "email": { + "type": "string", + "example": "bob@example.com" + }, + "same_team": { + "type": "boolean", + "example": true + }, + "team_member_id": { + "type": "string", + "example": "dbmid:abcd1234" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "platform_type": { + ".tag": "unknown" + }, + "time_last_seen": "2016-01-20T00:00:00Z", + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + }, + "examples": { + "list_file_members/continue response": { + "value": { + "groups": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ], + "invitees": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ], + "users": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "platform_type": { + ".tag": "unknown" + }, + "time_last_seen": "2016-01-20T00:00:00Z", + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_folder_members/continue": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_folder_members/continue", + "description": "[list_folder_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_folder_members`, use this to paginate through all shared folder members.", + "operationId": "listFolderMembersContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list_folder_members/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_folder_members/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "editor" + } + } + }, + "group": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "Test group" + }, + "group_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "is_member": { + "type": "boolean", + "example": false + }, + "is_owner": { + "type": "boolean", + "example": false + }, + "member_count": { + "type": "number", + "example": 10 + }, + "same_team": { + "type": "boolean", + "example": true + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "invitees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "invitee": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "jessica@example.com" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "example": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ] + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inherited": { + "type": "boolean", + "example": false + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "user": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "display_name": { + "type": "string", + "example": "Robert Smith" + }, + "email": { + "type": "string", + "example": "bob@example.com" + }, + "same_team": { + "type": "boolean", + "example": true + }, + "team_member_id": { + "type": "string", + "example": "dbmid:abcd1234" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + }, + "examples": { + "list_folder_members/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "groups": [ + { + "access_type": { + ".tag": "editor" + }, + "group": { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "group_type": { + ".tag": "user_managed" + }, + "is_member": false, + "is_owner": false, + "member_count": 10, + "same_team": true + }, + "is_inherited": false, + "permissions": [] + } + ], + "invitees": [ + { + "access_type": { + ".tag": "viewer" + }, + "invitee": { + ".tag": "email", + "email": "jessica@example.com" + }, + "is_inherited": false, + "permissions": [] + } + ], + "users": [ + { + "access_type": { + ".tag": "owner" + }, + "is_inherited": false, + "permissions": [], + "user": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "display_name": "Robert Smith", + "email": "bob@example.com", + "same_team": true, + "team_member_id": "dbmid:abcd1234" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_folders": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_folders", + "description": "[list_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders)\n\nscope: `sharing.read`\n\nReturn the list of all shared folders the current user has access to.", + "operationId": "listFolders", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": {}, + "example": [] + }, + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "list_folders": { + "value": { + "actions": [], + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_folders response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "example": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + }, + "examples": { + "list_folders response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "entries": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_folders/continue": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_folders/continue", + "description": "[list_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_folders`, use this to paginate through all shared folders. The cursor must come from a previous call to `list_folders` or `list_folders/continue`.", + "operationId": "listFoldersContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list_folders/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_folders/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "example": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + }, + "examples": { + "list_folders/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "entries": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_mountable_folders": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_mountable_folders", + "description": "[list_mountable_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders)\n\nscope: `sharing.read`\n\nReturn the list of all shared folders the current user can mount or unmount.", + "operationId": "listMountableFolders", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": {}, + "example": [] + }, + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "list_mountable_folders": { + "value": { + "actions": [], + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_mountable_folders response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "example": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + }, + "examples": { + "list_mountable_folders response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "entries": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_mountable_folders/continue": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_mountable_folders/continue", + "description": "[list_mountable_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_mountable_folders`, use this to paginate through all mountable shared folders. The cursor must come from a previous call to `list_mountable_folders` or `list_mountable_folders/continue`.", + "operationId": "listMountableFoldersContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list_mountable_folders/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_mountable_folders/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "example": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + }, + "examples": { + "list_mountable_folders/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "entries": [ + { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_received_files": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_received_files", + "description": "[list_received_files](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files)\n\nscope: `sharing.read`\n\nReturns a list of all files shared with current user.\n Does not include files the user has received via shared folders, and does not include unclaimed invitations.", + "operationId": "listReceivedFiles", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": {}, + "example": [] + }, + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "list_received_files": { + "value": { + "actions": [], + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_received_files response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "id": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "name": { + "type": "string", + "example": "file.txt" + }, + "owner_display_names": { + "type": "array", + "items": { + "type": "string", + "example": "Jane Doe" + }, + "example": [ + "Jane Doe" + ] + }, + "owner_team": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + }, + "path_display": { + "type": "string", + "example": "/dir/file.txt" + }, + "path_lower": { + "type": "string", + "example": "/dir/file.txt" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fi/fir9vjelf" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "example": [ + { + "access_type": { + ".tag": "viewer" + }, + "id": "id:3kmLmQFnf1AAAAAAAAAAAw", + "name": "file.txt", + "owner_display_names": [ + "Jane Doe" + ], + "owner_team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + }, + "path_display": "/dir/file.txt", + "path_lower": "/dir/file.txt", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + }, + "examples": { + "list_received_files response": { + "value": { + "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ", + "entries": [ + { + "access_type": { + ".tag": "viewer" + }, + "id": "id:3kmLmQFnf1AAAAAAAAAAAw", + "name": "file.txt", + "owner_display_names": [ + "Jane Doe" + ], + "owner_team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + }, + "path_display": "/dir/file.txt", + "path_lower": "/dir/file.txt", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_received_files/continue": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_received_files/continue", + "description": "[list_received_files/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue)\n\nscope: `sharing.read`\n\nGet more results with a cursor from `list_received_files`.", + "operationId": "listReceivedFilesContinue", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId" + } + } + }, + "examples": { + "list_received_files/continue": { + "value": { + "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_received_files/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer" + } + } + }, + "id": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "name": { + "type": "string", + "example": "file.txt" + }, + "owner_display_names": { + "type": "array", + "items": { + "type": "string", + "example": "Jane Doe" + }, + "example": [ + "Jane Doe" + ] + }, + "owner_team": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + }, + "path_display": { + "type": "string", + "example": "/dir/file.txt" + }, + "path_lower": { + "type": "string", + "example": "/dir/file.txt" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fi/fir9vjelf" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "example": [ + { + "access_type": { + ".tag": "viewer" + }, + "id": "id:3kmLmQFnf1AAAAAAAAAAAw", + "name": "file.txt", + "owner_display_names": [ + "Jane Doe" + ], + "owner_team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + }, + "path_display": "/dir/file.txt", + "path_lower": "/dir/file.txt", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + }, + "examples": { + "list_received_files/continue response": { + "value": { + "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ", + "entries": [ + { + "access_type": { + ".tag": "viewer" + }, + "id": "id:3kmLmQFnf1AAAAAAAAAAAw", + "name": "file.txt", + "owner_display_names": [ + "Jane Doe" + ], + "owner_team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + }, + "path_display": "/dir/file.txt", + "path_lower": "/dir/file.txt", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", + "time_invited": "2016-01-20T00:00:00Z" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/list_shared_links": { + "post": { + "tags": [ + "sharing" + ], + "summary": "list_shared_links", + "description": "[list_shared_links](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links)\n\nscope: `sharing.read`\n\nList shared links of this user.\nIf no path is given, returns a list of all shared links for the current user.\nIf a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.", + "operationId": "listSharedLinks", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "list_shared_links": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "list_shared_links response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": true + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "link_permissions": { + "type": "object", + "properties": { + "can_revoke": { + "type": "boolean", + "example": false + }, + "resolved_visibility": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "revoke_failure_reason": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner_only" + } + } + } + } + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "size": { + "type": "number", + "example": 7212 + }, + "team_member_info": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "Roger Rabbit" + }, + "member_id": { + "type": "string", + "example": "dbmid:abcd1234" + }, + "team_info": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + } + } + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + }, + "example": [ + { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "link_permissions": { + "can_revoke": false, + "resolved_visibility": { + ".tag": "public" + }, + "revoke_failure_reason": { + ".tag": "owner_only" + } + }, + "name": "Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "size": 7212, + "team_member_info": { + "display_name": "Roger Rabbit", + "member_id": "dbmid:abcd1234", + "team_info": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + } + }, + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + ] + } + } + }, + "examples": { + "list_shared_links response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": true, + "links": [ + { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "link_permissions": { + "can_revoke": false, + "resolved_visibility": { + ".tag": "public" + }, + "revoke_failure_reason": { + ".tag": "owner_only" + } + }, + "name": "Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "size": 7212, + "team_member_info": { + "display_name": "Roger Rabbit", + "member_id": "dbmid:abcd1234", + "team_info": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + } + }, + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/sharing/modify_shared_link_settings": { + "post": { + "tags": [ + "sharing" + ], + "summary": "modify_shared_link_settings", + "description": "[modify_shared_link_settings](https://www.dropbox.com/developers/documentation/http/documentation#sharing-modify_shared_link_settings)\n\nscope: `sharing.write`\n\nModify the shared link's settings.\nIf the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the `LinkPermissions.resolved_visibility` of the returned `SharedLinkMetadata` will reflect the actual visibility of the shared link and the `LinkPermissions.requested_visibility` will reflect the requested visibility.", + "operationId": "modifySharedLinkSettings", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "remove_expiration": { + "type": "boolean", + "example": false + }, + "settings": { + "type": "object", + "properties": { + "access": { + "type": "string", + "example": "viewer" + }, + "audience": { + "type": "string", + "example": "public" + }, + "requested_visibility": { + "type": "string", + "example": "public" + } + } + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + }, + "examples": { + "modify_shared_link_settings": { + "value": { + "remove_expiration": false, + "settings": { + "access": "viewer", + "audience": "public", + "requested_visibility": "public" + }, + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "modify_shared_link_settings response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "client_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "link_permissions": { + "type": "object", + "properties": { + "can_revoke": { + "type": "boolean", + "example": false + }, + "resolved_visibility": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "revoke_failure_reason": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner_only" + } + } + } + } + }, + "name": { + "type": "string", + "example": "Prime_Numbers.txt" + }, + "path_lower": { + "type": "string", + "example": "/homework/math/prime_numbers.txt" + }, + "rev": { + "type": "string", + "example": "a1c10ce0dd78" + }, + "server_modified": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "size": { + "type": "number", + "example": 7212 + }, + "team_member_info": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "Roger Rabbit" + }, + "member_id": { + "type": "string", + "example": "dbmid:abcd1234" + }, + "team_info": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + } + } + } + } + }, + "url": { + "type": "string", + "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + }, + "examples": { + "modify_shared_link_settings response": { + "value": { + ".tag": "file", + "client_modified": "2015-05-12T15:50:38Z", + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "link_permissions": { + "can_revoke": false, + "resolved_visibility": { + ".tag": "public" + }, + "revoke_failure_reason": { + ".tag": "owner_only" + } + }, + "name": "Prime_Numbers.txt", + "path_lower": "/homework/math/prime_numbers.txt", + "rev": "a1c10ce0dd78", + "server_modified": "2015-05-12T15:50:38Z", + "size": 7212, + "team_member_info": { + "display_name": "Roger Rabbit", + "member_id": "dbmid:abcd1234", + "team_info": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc." + } + }, + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + } + } + } + } + } + } + }, + "/2/sharing/mount_folder": { + "post": { + "tags": [ + "sharing" + ], + "summary": "mount_folder", + "description": "[mount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder)\n\nscope: `sharing.write`\n\nThe current user mounts the designated folder.\nMount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.", + "operationId": "mountFolder", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "mount_folder": { + "value": { + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "mount_folder response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "examples": { + "mount_folder response": { + "value": { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + } + } + } + } + } + } + } + }, + "/2/sharing/relinquish_file_membership": { + "post": { + "tags": [ + "sharing" + ], + "summary": "relinquish_file_membership", + "description": "[relinquish_file_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership)\n\nscope: `sharing.write`\n\nThe current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.", + "operationId": "relinquishFileMembership", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + } + } + }, + "examples": { + "relinquish_file_membership": { + "value": { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/sharing/relinquish_folder_membership": { + "post": { + "tags": [ + "sharing" + ], + "summary": "relinquish_folder_membership", + "description": "[relinquish_folder_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership)\n\nscope: `sharing.write`\n\nThe current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder.\nThis will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.", + "operationId": "relinquishFolderMembership", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "leave_a_copy": { + "type": "boolean", + "example": false + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "relinquish_folder_membership": { + "value": { + "leave_a_copy": false, + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "relinquish_folder_membership response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "relinquish_folder_membership response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/sharing/remove_file_member_2": { + "post": { + "tags": [ + "sharing" + ], + "summary": "remove_file_member_2", + "description": "[remove_file_member_2](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2)\n\nscope: `sharing.write`\n\nRemoves a specified member from the file.", + "operationId": "removeFileMember2", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "member": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "justin@example.com" + } + } + } + } + }, + "examples": { + "remove_file_member_2": { + "value": { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "member": { + ".tag": "email", + "email": "justin@example.com" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "remove_file_member_2 response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "other" + } + } + }, + "examples": { + "remove_file_member_2 response": { + "value": { + ".tag": "other" + } + } + } + } + } + } + } + } + }, + "/2/sharing/remove_folder_member": { + "post": { + "tags": [ + "sharing" + ], + "summary": "remove_folder_member", + "description": "[remove_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.", + "operationId": "removeFolderMember", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "leave_a_copy": { + "type": "boolean", + "example": false + }, + "member": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "justin@example.com" + } + } + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "remove_folder_member": { + "value": { + "leave_a_copy": false, + "member": { + ".tag": "email", + "email": "justin@example.com" + }, + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "remove_folder_member response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "async_job_id" + }, + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "remove_folder_member response": { + "value": { + ".tag": "async_job_id", + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + } + } + } + }, + "/2/sharing/revoke_shared_link": { + "post": { + "tags": [ + "sharing" + ], + "summary": "revoke_shared_link", + "description": "[revoke_shared_link](https://www.dropbox.com/developers/documentation/http/documentation#sharing-revoke_shared_link)\n\nscope: `sharing.write`\n\nRevoke a shared link.\nNote that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the `list_shared_links` with the file as the `ListSharedLinksArg.path` argument.", + "operationId": "revokeSharedLink", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + }, + "examples": { + "revoke_shared_link": { + "value": { + "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/sharing/set_access_inheritance": { + "post": { + "tags": [ + "sharing" + ], + "summary": "set_access_inheritance", + "description": "[set_access_inheritance](https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance)\n\nscope: `sharing.write`\n\nChange the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root.\nIf a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder.", + "operationId": "setAccessInheritance", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "string", + "example": "inherit" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "set_access_inheritance": { + "value": { + "access_inheritance": "inherit", + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "set_access_inheritance response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "examples": { + "set_access_inheritance response": { + "value": { + ".tag": "complete", + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + } + } + } + } + } + } + } + }, + "/2/sharing/share_folder": { + "post": { + "tags": [ + "sharing" + ], + "summary": "share_folder", + "description": "[share_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-share_folder)\n\nscope: `sharing.write`\n\nShare a folder with collaborators.\nMost sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`.\nIf a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder.", + "operationId": "shareFolder", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "string", + "example": "inherit" + }, + "acl_update_policy": { + "type": "string", + "example": "editors" + }, + "force_async": { + "type": "boolean", + "example": false + }, + "member_policy": { + "type": "string", + "example": "team" + }, + "path": { + "type": "string", + "example": "/example/workspace" + }, + "shared_link_policy": { + "type": "string", + "example": "members" + } + } + }, + "examples": { + "share_folder": { + "value": { + "access_inheritance": "inherit", + "acl_update_policy": "editors", + "force_async": false, + "member_policy": "team", + "path": "/example/workspace", + "shared_link_policy": "members" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "share_folder response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "examples": { + "share_folder response": { + "value": { + ".tag": "complete", + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + } + } + } + } + } + } + } + }, + "/2/sharing/transfer_folder": { + "post": { + "tags": [ + "sharing" + ], + "summary": "transfer_folder", + "description": "[transfer_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder)\n\nscope: `sharing.write`\n\nTransfer ownership of a shared folder to a member of the shared folder.\nUser must have `AccessLevel.owner` access to the shared folder to perform a transfer.", + "operationId": "transferFolder", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "to_dropbox_id": { + "type": "string", + "example": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" + } + } + }, + "examples": { + "transfer_folder": { + "value": { + "shared_folder_id": "84528192421", + "to_dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/sharing/unmount_folder": { + "post": { + "tags": [ + "sharing" + ], + "summary": "unmount_folder", + "description": "[unmount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder)\n\nscope: `sharing.write`\n\nThe current user unmounts the designated folder. They can re-mount the folder at a later time using `mount_folder`.", + "operationId": "unmountFolder", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "unmount_folder": { + "value": { + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/sharing/unshare_file": { + "post": { + "tags": [ + "sharing" + ], + "summary": "unshare_file", + "description": "[unshare_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_file)\n\nscope: `sharing.write`\n\nRemove all members from this file. Does not remove inherited members.", + "operationId": "unshareFile", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + } + } + }, + "examples": { + "unshare_file": { + "value": { + "file": "id:3kmLmQFnf1AAAAAAAAAAAw" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/sharing/unshare_folder": { + "post": { + "tags": [ + "sharing" + ], + "summary": "unshare_folder", + "description": "[unshare_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_folder)\n\nscope: `sharing.write`\n\nAllows a shared folder owner to unshare the folder.\nYou'll need to call `check_job_status` to determine if the action has completed successfully.", + "operationId": "unshareFolder", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "leave_a_copy": { + "type": "boolean", + "example": false + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "unshare_folder": { + "value": { + "leave_a_copy": false, + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "unshare_folder response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "unshare_folder response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/sharing/update_file_member": { + "post": { + "tags": [ + "sharing" + ], + "summary": "update_file_member", + "description": "[update_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member)\n\nscope: `sharing.write`\n\nChanges a member's access on a shared file.", + "operationId": "updateFileMember", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "example": "viewer" + }, + "file": { + "type": "string", + "example": "id:3kmLmQFnf1AAAAAAAAAAAw" + }, + "member": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "justin@example.com" + } + } + } + } + }, + "examples": { + "update_file_member": { + "value": { + "access_level": "viewer", + "file": "id:3kmLmQFnf1AAAAAAAAAAAw", + "member": { + ".tag": "email", + "email": "justin@example.com" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "update_file_member response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {} + }, + "examples": { + "update_file_member response": { + "value": {} + } + } + } + } + } + } + } + }, + "/2/sharing/update_folder_member": { + "post": { + "tags": [ + "sharing" + ], + "summary": "update_folder_member", + "description": "[update_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor of a shared folder to update another member's permissions.", + "operationId": "updateFolderMember", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "example": "editor" + }, + "member": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "email" + }, + "email": { + "type": "string", + "example": "justin@example.com" + } + } + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + } + } + }, + "examples": { + "update_folder_member": { + "value": { + "access_level": "editor", + "member": { + ".tag": "email", + "email": "justin@example.com" + }, + "shared_folder_id": "84528192421" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "update_folder_member response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {} + }, + "examples": { + "update_folder_member response": { + "value": {} + } + } + } + } + } + } + } + }, + "/2/sharing/update_folder_policy": { + "post": { + "tags": [ + "sharing" + ], + "summary": "update_folder_policy", + "description": "[update_folder_policy](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy)\n\nscope: `sharing.write`\n\nUpdate the sharing policies for a shared folder.\nUser must have `AccessLevel.owner` access to the shared folder to update its policies.", + "operationId": "updateFolderPolicy", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "string", + "example": "owner" + }, + "member_policy": { + "type": "string", + "example": "team" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "shared_link_policy": { + "type": "string", + "example": "members" + } + } + }, + "examples": { + "update_folder_policy": { + "value": { + "acl_update_policy": "owner", + "member_policy": "team", + "shared_folder_id": "84528192421", + "shared_link_policy": "members" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "update_folder_policy response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_inheritance": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "inherit" + } + } + }, + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "is_inside_team_folder": { + "type": "boolean", + "example": false + }, + "is_team_folder": { + "type": "boolean", + "example": false + }, + "link_metadata": { + "type": "object", + "properties": { + "audience_options": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "example": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ] + }, + "current_audience": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "public" + } + } + }, + "link_permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "change_audience" + } + } + }, + "allow": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ] + }, + "password_protected": { + "type": "boolean", + "example": false + }, + "url": { + "type": "string", + "example": "" + } + } + }, + "name": { + "type": "string", + "example": "dir" + }, + "path_lower": { + "type": "string", + "example": "/dir" + }, + "permissions": { + "type": "array", + "items": {}, + "example": [] + }, + "policy": { + "type": "object", + "properties": { + "acl_update_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "owner" + } + } + }, + "member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + }, + "resolved_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "anyone" + } + } + } + } + }, + "preview_url": { + "type": "string", + "example": "https://www.dropbox.com/scl/fo/fir9vjelf" + }, + "shared_folder_id": { + "type": "string", + "example": "84528192421" + }, + "time_invited": { + "type": "string", + "example": "2016-01-20T00:00:00Z" + } + } + }, + "examples": { + "update_folder_policy response": { + "value": { + "access_inheritance": { + ".tag": "inherit" + }, + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "link_metadata": { + "audience_options": [ + { + ".tag": "public" + }, + { + ".tag": "team" + }, + { + ".tag": "members" + } + ], + "current_audience": { + ".tag": "public" + }, + "link_permissions": [ + { + "action": { + ".tag": "change_audience" + }, + "allow": true + } + ], + "password_protected": false, + "url": "" + }, + "name": "dir", + "path_lower": "/dir", + "permissions": [], + "policy": { + "acl_update_policy": { + ".tag": "owner" + }, + "member_policy": { + ".tag": "anyone" + }, + "resolved_member_policy": { + ".tag": "team" + }, + "shared_link_policy": { + ".tag": "anyone" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", + "shared_folder_id": "84528192421", + "time_invited": "2016-01-20T00:00:00Z" + } + } + } + } + } + } + } + } + }, + "/2/team/devices/list_member_devices": { + "post": { + "tags": [ + "team", + "devices" + ], + "summary": "devices/list_member_devices", + "description": "[devices/list_member_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_member_devices)\n\nscope: `sessions.list`\n\nList all device sessions of a team's member.", + "operationId": "devicesListMemberDevices", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_desktop_clients": { + "type": "boolean", + "example": true + }, + "include_mobile_clients": { + "type": "boolean", + "example": true + }, + "include_web_sessions": { + "type": "boolean", + "example": true + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + } + } + }, + "examples": { + "devices/list_member_devices": { + "value": { + "include_desktop_clients": true, + "include_mobile_clients": true, + "include_web_sessions": true, + "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/devices/list_members_devices": { + "post": { + "tags": [ + "team", + "devices" + ], + "summary": "devices/list_members_devices", + "description": "[devices/list_members_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_members_devices)\n\nscope: `sessions.list`\n\nList all device sessions of a team.\nPermission : Team member file access.", + "operationId": "devicesListMembersDevices", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "devices/list_members_devices": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/devices/revoke_device_session": { + "post": { + "tags": [ + "team", + "devices" + ], + "summary": "devices/revoke_device_session", + "description": "[devices/revoke_device_session](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session)\n\nscope: `sessions.modify`\n\nRevoke a device session of a team's member.", + "operationId": "devicesRevokeDeviceSession", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "web_session" + }, + "session_id": { + "type": "string", + "example": "1234faaf0678bcde" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + } + } + }, + "examples": { + "devices/revoke_device_session": { + "value": { + ".tag": "web_session", + "session_id": "1234faaf0678bcde", + "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/devices/revoke_device_session_batch": { + "post": { + "tags": [ + "team", + "devices" + ], + "summary": "devices/revoke_device_session_batch", + "description": "[devices/revoke_device_session_batch](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session_batch)\n\nscope: `sessions.modify`\n\nRevoke a list of device sessions of team members.", + "operationId": "devicesRevokeDeviceSessionBatch", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "revoke_devices": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "web_session" + }, + "session_id": { + "type": "string", + "example": "1234faaf0678bcde" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + } + } + }, + "example": [ + { + ".tag": "web_session", + "session_id": "1234faaf0678bcde", + "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + } + ] + } + } + }, + "examples": { + "devices/revoke_device_session_batch": { + "value": { + "revoke_devices": [ + { + ".tag": "web_session", + "session_id": "1234faaf0678bcde", + "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/groups/create": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/create", + "description": "[groups/create](https://www.dropbox.com/developers/documentation/http/teams#team-groups-create)\n\nscope: `groups.write`\n\nCreates a new, empty group, with a requested name.\nPermission : Team member management.", + "operationId": "groupsCreate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "add_creator_as_owner": { + "type": "boolean", + "example": false + }, + "group_external_id": { + "type": "string", + "example": "group-134" + }, + "group_name": { + "type": "string", + "example": "Europe sales" + } + } + }, + "examples": { + "groups/create": { + "value": { + "add_creator_as_owner": false, + "group_external_id": "group-134", + "group_name": "Europe sales" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/create response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created": { + "type": "number", + "example": 1447255518000 + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "project launch" + }, + "member_count": { + "type": "number", + "example": 5 + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member" + } + } + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "mary@lamb.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "apple@orange.com" + }, + "is_verified": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + }, + "examples": { + "groups/create response": { + "value": { + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/groups/delete": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/delete", + "description": "[groups/delete](https://www.dropbox.com/developers/documentation/http/teams#team-groups-delete)\n\nscope: `groups.write`\n\nDeletes a group.\nThe group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nPermission : Team member management.", + "operationId": "groupsDelete", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_id" + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + } + } + }, + "examples": { + "groups/delete": { + "value": { + ".tag": "group_id", + "group_id": "g:e2db7665347abcd600000000001a2b3c" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/delete response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "groups/delete response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/team/groups/get_info": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/get_info", + "description": "[groups/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-groups-get_info)\n\nscope: `groups.read`\n\nRetrieves information about one or more groups. Note that the optional field `GroupFullInfo.members` is not returned for system-managed groups.\nPermission : Team Information.", + "operationId": "groupsGetInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_ids" + }, + "group_ids": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c", + "g:111111147abcd6000000000222222c" + ] + } + } + }, + "examples": { + "groups/get_info": { + "value": { + ".tag": "group_ids", + "group_ids": [ + "g:e2db7665347abcd600000000001a2b3c", + "g:111111147abcd6000000000222222c" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/get_info response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_info" + }, + "created": { + "type": "number", + "example": 1447255518000 + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "project launch" + }, + "member_count": { + "type": "number", + "example": 5 + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member" + } + } + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "mary@lamb.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "apple@orange.com" + }, + "is_verified": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + }, + "example": [ + { + ".tag": "group_info", + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + ] + }, + "examples": { + "groups/get_info response": { + "value": [ + { + ".tag": "group_info", + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + ] + } + } + } + } + } + } + } + }, + "/2/team/groups/job_status/get": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/job_status/get", + "description": "[groups/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-groups-job_status-get)\n\nscope: `groups.write`\n\nOnce an async_job_id is returned from `groups/delete`, `groups/members/add` , or `groups/members/remove` use this method to poll the status of granting/revoking group members' access to group-owned resources.\nPermission : Team member management.", + "operationId": "groupsJobStatusGet", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "groups/job_status/get": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/job_status/get response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "groups/job_status/get response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/team/groups/list": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/list", + "description": "[groups/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list)\n\nscope: `groups.read`\n\nLists groups on a team.\nPermission : Team Information.", + "operationId": "groupsList", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "groups/list": { + "value": { + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/list response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "Test group" + }, + "member_count": { + "type": "number", + "example": 10 + } + } + }, + "example": [ + { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "member_count": 10 + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "groups/list response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "groups": [ + { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "member_count": 10 + } + ], + "has_more": false + } + } + } + } + } + } + } + } + }, + "/2/team/groups/list/continue": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/list/continue", + "description": "[groups/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list-continue)\n\nscope: `groups.read`\n\nOnce a cursor has been retrieved from `groups/list`, use this to paginate through all groups.\nPermission : Team Information.", + "operationId": "groupsListContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "groups/list/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/list/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "Test group" + }, + "member_count": { + "type": "number", + "example": 10 + } + } + }, + "example": [ + { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "member_count": 10 + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "groups/list/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "groups": [ + { + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "Test group", + "member_count": 10 + } + ], + "has_more": false + } + } + } + } + } + } + } + } + }, + "/2/team/groups/members/add": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/members/add", + "description": "[groups/members/add](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-add)\n\nscope: `groups.write`\n\nAdds members to a group.\nThe members are added immediately. However the granting of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nPermission : Team member management.", + "operationId": "groupsMembersAdd", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_id" + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + } + } + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "string", + "example": "member" + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + "access_type": "member", + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + }, + "return_members": { + "type": "boolean", + "example": true + } + } + }, + "examples": { + "groups/members/add": { + "value": { + "group": { + ".tag": "group_id", + "group_id": "g:e2db7665347abcd600000000001a2b3c" + }, + "members": [ + { + "access_type": "member", + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ], + "return_members": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/members/add response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "99988877733388" + }, + "group_info": { + "type": "object", + "properties": { + "created": { + "type": "number", + "example": 1447255518000 + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "project launch" + }, + "member_count": { + "type": "number", + "example": 5 + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member" + } + } + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "mary@lamb.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "apple@orange.com" + }, + "is_verified": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + } + } + }, + "examples": { + "groups/members/add response": { + "value": { + "async_job_id": "99988877733388", + "group_info": { + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "/2/team/groups/members/list": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/members/list", + "description": "[groups/members/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list)\n\nscope: `groups.read`\n\nLists members of a group.\nPermission : Team Information.", + "operationId": "groupsMembersList", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_id" + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + } + } + }, + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "groups/members/list": { + "value": { + "group": { + ".tag": "group_id", + "group_id": "g:e2db7665347abcd600000000001a2b3c" + }, + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/members/list response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "members": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "examples": { + "groups/members/list response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "members": [] + } + } + } + } + } + } + } + } + }, + "/2/team/groups/members/list/continue": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/members/list/continue", + "description": "[groups/members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list-continue)\n\nscope: `groups.read`\n\nOnce a cursor has been retrieved from `groups/members/list`, use this to paginate through all members of the group.\nPermission : Team information.", + "operationId": "groupsMembersListContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "groups/members/list/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/members/list/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "members": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "examples": { + "groups/members/list/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "members": [] + } + } + } + } + } + } + } + } + }, + "/2/team/groups/members/remove": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/members/remove", + "description": "[groups/members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-remove)\n\nscope: `groups.write`\n\nRemoves members from a group.\nThe members are removed immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nThis method permits removing the only owner of a group, even in cases where this is not possible via the web client.\nPermission : Team member management.", + "operationId": "groupsMembersRemove", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_id" + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + } + } + }, + "return_members": { + "type": "boolean", + "example": true + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "example": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + }, + "examples": { + "groups/members/remove": { + "value": { + "group": { + ".tag": "group_id", + "group_id": "g:e2db7665347abcd600000000001a2b3c" + }, + "return_members": true, + "users": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/members/remove response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "99988877733388" + }, + "group_info": { + "type": "object", + "properties": { + "created": { + "type": "number", + "example": 1447255518000 + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "project launch" + }, + "member_count": { + "type": "number", + "example": 5 + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member" + } + } + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "mary@lamb.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "apple@orange.com" + }, + "is_verified": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + } + } + }, + "examples": { + "groups/members/remove response": { + "value": { + "async_job_id": "99988877733388", + "group_info": { + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "/2/team/groups/members/set_access_type": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/members/set_access_type", + "description": "[groups/members/set_access_type](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-set_access_type)\n\nscope: `groups.write`\n\nSets a member's access type in a group.\nPermission : Team member management.", + "operationId": "groupsMembersSetAccessType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_type": { + "type": "string", + "example": "member" + }, + "group": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_id" + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + } + } + }, + "return_members": { + "type": "boolean", + "example": true + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "groups/members/set_access_type": { + "value": { + "access_type": "member", + "group": { + ".tag": "group_id", + "group_id": "g:e2db7665347abcd600000000001a2b3c" + }, + "return_members": true, + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/members/set_access_type response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_info" + }, + "created": { + "type": "number", + "example": 1447255518000 + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "project launch" + }, + "member_count": { + "type": "number", + "example": 5 + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member" + } + } + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "mary@lamb.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "apple@orange.com" + }, + "is_verified": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + }, + "example": [ + { + ".tag": "group_info", + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + ] + }, + "examples": { + "groups/members/set_access_type response": { + "value": [ + { + ".tag": "group_info", + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + ] + } + } + } + } + } + } + } + }, + "/2/team/groups/update": { + "post": { + "tags": [ + "team", + "groups" + ], + "summary": "groups/update", + "description": "[groups/update](https://www.dropbox.com/developers/documentation/http/teams#team-groups-update)\n\nscope: `groups.write`\n\nUpdates a group's name and/or external ID.\nPermission : Team member management.", + "operationId": "groupsUpdate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "group_id" + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + } + } + }, + "new_group_external_id": { + "type": "string", + "example": "sales-234" + }, + "new_group_management_type": { + "type": "string", + "example": "company_managed" + }, + "new_group_name": { + "type": "string", + "example": "Europe west sales" + }, + "return_members": { + "type": "boolean", + "example": true + } + } + }, + "examples": { + "groups/update": { + "value": { + "group": { + ".tag": "group_id", + "group_id": "g:e2db7665347abcd600000000001a2b3c" + }, + "new_group_external_id": "sales-234", + "new_group_management_type": "company_managed", + "new_group_name": "Europe west sales", + "return_members": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "groups/update response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created": { + "type": "number", + "example": 1447255518000 + }, + "group_id": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "group_management_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user_managed" + } + } + }, + "group_name": { + "type": "string", + "example": "project launch" + }, + "member_count": { + "type": "number", + "example": 5 + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member" + } + } + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "mary@lamb.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "apple@orange.com" + }, + "is_verified": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + } + } + }, + "example": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + }, + "examples": { + "groups/update response": { + "value": { + "created": 1447255518000, + "group_id": "g:e2db7665347abcd600000000001a2b3c", + "group_management_type": { + ".tag": "user_managed" + }, + "group_name": "project launch", + "member_count": 5, + "members": [ + { + "access_type": { + ".tag": "member" + }, + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "mary@lamb.com", + "email_verified": true, + "joined_on": "2015-05-12T15:50:38Z", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "apple@orange.com", + "is_verified": true + }, + { + "email": "banana@honeydew.com", + "is_verified": true + }, + { + "email": "grape@strawberry.com", + "is_verified": false + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:1234567" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/legal_holds/create_policy": { + "post": { + "tags": [ + "team", + "legal_holds" + ], + "summary": "legal_holds/create_policy", + "description": "[legal_holds/create_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-create_policy)\n\nscope: `team_data.member`\n\nCreates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", + "operationId": "legalHoldsCreatePolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "end_date": { + "type": "string", + "example": "2017-12-31T00:00:00Z" + }, + "members": { + "type": "array", + "items": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + }, + "example": [ + "dbmid:FDFSVF-DFSDF" + ] + }, + "name": { + "type": "string", + "example": "acme cfo policy" + }, + "start_date": { + "type": "string", + "example": "2016-01-01T00:00:00Z" + } + } + }, + "examples": { + "legal_holds/create_policy": { + "value": { + "end_date": "2017-12-31T00:00:00Z", + "members": [ + "dbmid:FDFSVF-DFSDF" + ], + "name": "acme cfo policy", + "start_date": "2016-01-01T00:00:00Z" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "legal_holds/create_policy response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "activation_time": { + "type": "string", + "example": "2016-01-20T00:00:10Z" + }, + "end_date": { + "type": "string", + "example": "2017-12-31T00:00:00Z" + }, + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + }, + "members": { + "type": "object", + "properties": { + "permanently_deleted_users": { + "type": "number", + "example": 2 + }, + "team_member_ids": { + "type": "array", + "items": { + "type": "string", + "example": "dbmid:efgh5678" + }, + "example": [ + "dbmid:efgh5678" + ] + } + } + }, + "name": { + "type": "string", + "example": "acme cfo policy" + }, + "start_date": { + "type": "string", + "example": "2016-01-01T00:00:00Z" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + } + } + }, + "examples": { + "legal_holds/create_policy response": { + "value": { + "activation_time": "2016-01-20T00:00:10Z", + "end_date": "2017-12-31T00:00:00Z", + "id": "pid_dbhid:abcd1234", + "members": { + "permanently_deleted_users": 2, + "team_member_ids": [ + "dbmid:efgh5678" + ] + }, + "name": "acme cfo policy", + "start_date": "2016-01-01T00:00:00Z", + "status": { + ".tag": "active" + } + } + } + } + } + } + } + } + } + }, + "/2/team/legal_holds/get_policy": { + "post": { + "tags": [ + "team", + "legal_holds" + ], + "summary": "legal_holds/get_policy", + "description": "[legal_holds/get_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-get_policy)\n\nscope: `team_data.member`\n\nGets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", + "operationId": "legalHoldsGetPolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + } + } + }, + "examples": { + "legal_holds/get_policy": { + "value": { + "id": "pid_dbhid:abcd1234" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "legal_holds/get_policy response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "activation_time": { + "type": "string", + "example": "2016-01-20T00:00:10Z" + }, + "end_date": { + "type": "string", + "example": "2017-12-31T00:00:00Z" + }, + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + }, + "members": { + "type": "object", + "properties": { + "permanently_deleted_users": { + "type": "number", + "example": 2 + }, + "team_member_ids": { + "type": "array", + "items": { + "type": "string", + "example": "dbmid:efgh5678" + }, + "example": [ + "dbmid:efgh5678" + ] + } + } + }, + "name": { + "type": "string", + "example": "acme cfo policy" + }, + "start_date": { + "type": "string", + "example": "2016-01-01T00:00:00Z" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + } + } + }, + "examples": { + "legal_holds/get_policy response": { + "value": { + "activation_time": "2016-01-20T00:00:10Z", + "end_date": "2017-12-31T00:00:00Z", + "id": "pid_dbhid:abcd1234", + "members": { + "permanently_deleted_users": 2, + "team_member_ids": [ + "dbmid:efgh5678" + ] + }, + "name": "acme cfo policy", + "start_date": "2016-01-01T00:00:00Z", + "status": { + ".tag": "active" + } + } + } + } + } + } + } + } + } + }, + "/2/team/legal_holds/list_held_revisions": { + "post": { + "tags": [ + "team", + "legal_holds" + ], + "summary": "legal_holds/list_held_revisions", + "description": "[legal_holds/list_held_revisions](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions)\n\nscope: `team_data.member`\n\nList the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", + "operationId": "legalHoldsListHeldRevisions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + } + } + }, + "examples": { + "legal_holds/list_held_revisions": { + "value": { + "id": "pid_dbhid:abcd1234" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "legal_holds/list_held_revisions response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author_email": { + "type": "string", + "example": "a@a.com" + }, + "author_member_id": { + "type": "string", + "example": "dbmid:abcd1234abcd1234abcd1234abcd1234a23" + }, + "author_member_status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "content_hash": { + "type": "string", + "example": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234" + }, + "file_type": { + "type": "string", + "example": "Document" + }, + "new_filename": { + "type": "string", + "example": "111_222.pdf" + }, + "original_file_path": { + "type": "string", + "example": "/a.pdf" + }, + "original_revision_id": { + "type": "string", + "example": "ab2rij4i5ojgfd" + }, + "server_modified": { + "type": "string", + "example": "2019-08-12T12:08:52Z" + }, + "size": { + "type": "number", + "example": 3 + } + } + }, + "example": [ + { + "author_email": "a@a.com", + "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", + "author_member_status": { + ".tag": "active" + }, + "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", + "file_type": "Document", + "new_filename": "111_222.pdf", + "original_file_path": "/a.pdf", + "original_revision_id": "ab2rij4i5ojgfd", + "server_modified": "2019-08-12T12:08:52Z", + "size": 3 + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "legal_holds/list_held_revisions response": { + "value": { + "entries": [ + { + "author_email": "a@a.com", + "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", + "author_member_status": { + ".tag": "active" + }, + "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", + "file_type": "Document", + "new_filename": "111_222.pdf", + "original_file_path": "/a.pdf", + "original_revision_id": "ab2rij4i5ojgfd", + "server_modified": "2019-08-12T12:08:52Z", + "size": 3 + } + ], + "has_more": false + } + } + } + } + } + } + } + } + }, + "/2/team/legal_holds/list_held_revisions_continue": { + "post": { + "tags": [ + "team", + "legal_holds" + ], + "summary": "legal_holds/list_held_revisions_continue", + "description": "[legal_holds/list_held_revisions_continue](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions_continue)\n\nscope: `team_data.member`\n\nContinue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", + "operationId": "legalHoldsListHeldRevisionsContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + } + } + }, + "examples": { + "legal_holds/list_held_revisions_continue": { + "value": { + "id": "pid_dbhid:abcd1234" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "legal_holds/list_held_revisions_continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author_email": { + "type": "string", + "example": "a@a.com" + }, + "author_member_id": { + "type": "string", + "example": "dbmid:abcd1234abcd1234abcd1234abcd1234a23" + }, + "author_member_status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "content_hash": { + "type": "string", + "example": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234" + }, + "file_type": { + "type": "string", + "example": "Document" + }, + "new_filename": { + "type": "string", + "example": "111_222.pdf" + }, + "original_file_path": { + "type": "string", + "example": "/a.pdf" + }, + "original_revision_id": { + "type": "string", + "example": "ab2rij4i5ojgfd" + }, + "server_modified": { + "type": "string", + "example": "2019-08-12T12:08:52Z" + }, + "size": { + "type": "number", + "example": 3 + } + } + }, + "example": [ + { + "author_email": "a@a.com", + "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", + "author_member_status": { + ".tag": "active" + }, + "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", + "file_type": "Document", + "new_filename": "111_222.pdf", + "original_file_path": "/a.pdf", + "original_revision_id": "ab2rij4i5ojgfd", + "server_modified": "2019-08-12T12:08:52Z", + "size": 3 + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "legal_holds/list_held_revisions_continue response": { + "value": { + "entries": [ + { + "author_email": "a@a.com", + "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", + "author_member_status": { + ".tag": "active" + }, + "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", + "file_type": "Document", + "new_filename": "111_222.pdf", + "original_file_path": "/a.pdf", + "original_revision_id": "ab2rij4i5ojgfd", + "server_modified": "2019-08-12T12:08:52Z", + "size": 3 + } + ], + "has_more": false + } + } + } + } + } + } + } + } + }, + "/2/team/legal_holds/list_policies": { + "post": { + "tags": [ + "team", + "legal_holds" + ], + "summary": "legal_holds/list_policies", + "description": "[legal_holds/list_policies](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_policies)\n\nscope: `team_data.member`\n\nLists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", + "operationId": "legalHoldsListPolicies", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_released": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "legal_holds/list_policies": { + "value": { + "include_released": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "legal_holds/list_policies response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "policies": { + "type": "array", + "items": { + "type": "object", + "properties": { + "activation_time": { + "type": "string", + "example": "2016-01-20T00:00:10Z" + }, + "end_date": { + "type": "string", + "example": "2017-12-31T00:00:00Z" + }, + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + }, + "members": { + "type": "object", + "properties": { + "permanently_deleted_users": { + "type": "number", + "example": 2 + }, + "team_member_ids": { + "type": "array", + "items": { + "type": "string", + "example": "dbmid:efgh5678" + }, + "example": [ + "dbmid:efgh5678" + ] + } + } + }, + "name": { + "type": "string", + "example": "acme cfo policy" + }, + "start_date": { + "type": "string", + "example": "2016-01-01T00:00:00Z" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + } + } + }, + "example": [ + { + "activation_time": "2016-01-20T00:00:10Z", + "end_date": "2017-12-31T00:00:00Z", + "id": "pid_dbhid:abcd1234", + "members": { + "permanently_deleted_users": 2, + "team_member_ids": [ + "dbmid:efgh5678" + ] + }, + "name": "acme cfo policy", + "start_date": "2016-01-01T00:00:00Z", + "status": { + ".tag": "active" + } + } + ] + } + } + }, + "examples": { + "legal_holds/list_policies response": { + "value": { + "policies": [ + { + "activation_time": "2016-01-20T00:00:10Z", + "end_date": "2017-12-31T00:00:00Z", + "id": "pid_dbhid:abcd1234", + "members": { + "permanently_deleted_users": 2, + "team_member_ids": [ + "dbmid:efgh5678" + ] + }, + "name": "acme cfo policy", + "start_date": "2016-01-01T00:00:00Z", + "status": { + ".tag": "active" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/legal_holds/release_policy": { + "post": { + "tags": [ + "team", + "legal_holds" + ], + "summary": "legal_holds/release_policy", + "description": "[legal_holds/release_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-release_policy)\n\nscope: `team_data.member`\n\nReleases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", + "operationId": "legalHoldsReleasePolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + } + } + }, + "examples": { + "legal_holds/release_policy": { + "value": { + "id": "pid_dbhid:abcd1234" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/legal_holds/update_policy": { + "post": { + "tags": [ + "team", + "legal_holds" + ], + "summary": "legal_holds/update_policy", + "description": "[legal_holds/update_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-update_policy)\n\nscope: `team_data.member`\n\nUpdates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", + "operationId": "legalHoldsUpdatePolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + }, + "members": { + "type": "array", + "items": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + }, + "example": [ + "dbmid:FDFSVF-DFSDF" + ] + } + } + }, + "examples": { + "legal_holds/update_policy": { + "value": { + "id": "pid_dbhid:abcd1234", + "members": [ + "dbmid:FDFSVF-DFSDF" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "legal_holds/update_policy response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "activation_time": { + "type": "string", + "example": "2016-01-20T00:00:10Z" + }, + "end_date": { + "type": "string", + "example": "2017-12-31T00:00:00Z" + }, + "id": { + "type": "string", + "example": "pid_dbhid:abcd1234" + }, + "members": { + "type": "object", + "properties": { + "permanently_deleted_users": { + "type": "number", + "example": 2 + }, + "team_member_ids": { + "type": "array", + "items": { + "type": "string", + "example": "dbmid:efgh5678" + }, + "example": [ + "dbmid:efgh5678" + ] + } + } + }, + "name": { + "type": "string", + "example": "acme cfo policy" + }, + "start_date": { + "type": "string", + "example": "2016-01-01T00:00:00Z" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + } + } + }, + "examples": { + "legal_holds/update_policy response": { + "value": { + "activation_time": "2016-01-20T00:00:10Z", + "end_date": "2017-12-31T00:00:00Z", + "id": "pid_dbhid:abcd1234", + "members": { + "permanently_deleted_users": 2, + "team_member_ids": [ + "dbmid:efgh5678" + ] + }, + "name": "acme cfo policy", + "start_date": "2016-01-01T00:00:00Z", + "status": { + ".tag": "active" + } + } + } + } + } + } + } + } + } + }, + "/2/team/linked_apps/list_member_linked_apps": { + "post": { + "tags": [ + "team", + "linked_apps" + ], + "summary": "linked_apps/list_member_linked_apps", + "description": "[linked_apps/list_member_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_member_linked_apps)\n\nscope: `sessions.list`\n\nList all linked applications of the team member.\nNote, this endpoint does not list any team-linked applications.", + "operationId": "linkedAppsListMemberLinkedApps", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "team_member_id": { + "type": "string", + "example": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + } + } + }, + "examples": { + "linked_apps/list_member_linked_apps": { + "value": { + "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/linked_apps/list_members_linked_apps": { + "post": { + "tags": [ + "team", + "linked_apps" + ], + "summary": "linked_apps/list_members_linked_apps", + "description": "[linked_apps/list_members_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_members_linked_apps)\n\nscope: `sessions.list`\n\nList all applications linked to the team members' accounts.\nNote, this endpoint does not list any team-linked applications.", + "operationId": "linkedAppsListMembersLinkedApps", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "linked_apps/list_members_linked_apps": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/linked_apps/revoke_linked_app": { + "post": { + "tags": [ + "team", + "linked_apps" + ], + "summary": "linked_apps/revoke_linked_app", + "description": "[linked_apps/revoke_linked_app](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app)\n\nscope: `sessions.modify`\n\nRevoke a linked application of the team member.", + "operationId": "linkedAppsRevokeLinkedApp", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "linked_apps/revoke_linked_app": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/linked_apps/revoke_linked_app_batch": { + "post": { + "tags": [ + "team", + "linked_apps" + ], + "summary": "linked_apps/revoke_linked_app_batch", + "description": "[linked_apps/revoke_linked_app_batch](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app_batch)\n\nscope: `sessions.modify`\n\nRevoke a list of linked applications of the team members.", + "operationId": "linkedAppsRevokeLinkedAppBatch", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "linked_apps/revoke_linked_app_batch": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/member_space_limits/excluded_users/add": { + "post": { + "tags": [ + "team", + "member_space_limits" + ], + "summary": "member_space_limits/excluded_users/add", + "description": "[member_space_limits/excluded_users/add](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-add)\n\nscope: `members.write`\n\nAdd users to member space limits excluded users list.", + "operationId": "memberSpaceLimitsExcludedUsersAdd", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "example": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + }, + "examples": { + "member_space_limits/excluded_users/add": { + "value": { + "users": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "member_space_limits/excluded_users/add response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + } + } + } + } + }, + "examples": { + "member_space_limits/excluded_users/add response": { + "value": { + "status": { + ".tag": "success" + } + } + } + } + } + } + } + } + } + }, + "/2/team/member_space_limits/excluded_users/list": { + "post": { + "tags": [ + "team", + "member_space_limits" + ], + "summary": "member_space_limits/excluded_users/list", + "description": "[member_space_limits/excluded_users/list](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list)\n\nscope: `members.read`\n\nList member space limits excluded users.", + "operationId": "memberSpaceLimitsExcludedUsersList", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "member_space_limits/excluded_users/list": { + "value": { + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "member_space_limits/excluded_users/list response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "users": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "examples": { + "member_space_limits/excluded_users/list response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "users": [] + } + } + } + } + } + } + } + } + }, + "/2/team/member_space_limits/excluded_users/list/continue": { + "post": { + "tags": [ + "team", + "member_space_limits" + ], + "summary": "member_space_limits/excluded_users/list/continue", + "description": "[member_space_limits/excluded_users/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list-continue)\n\nscope: `members.read`\n\nContinue listing member space limits excluded users.", + "operationId": "memberSpaceLimitsExcludedUsersListContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "member_space_limits/excluded_users/list/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "member_space_limits/excluded_users/list/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "users": { + "type": "array", + "items": {}, + "example": [] + } + } + }, + "examples": { + "member_space_limits/excluded_users/list/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "users": [] + } + } + } + } + } + } + } + } + }, + "/2/team/member_space_limits/excluded_users/remove": { + "post": { + "tags": [ + "team", + "member_space_limits" + ], + "summary": "member_space_limits/excluded_users/remove", + "description": "[member_space_limits/excluded_users/remove](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-remove)\n\nscope: `members.write`\n\nRemove users from member space limits excluded users list.", + "operationId": "memberSpaceLimitsExcludedUsersRemove", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "example": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + }, + "examples": { + "member_space_limits/excluded_users/remove": { + "value": { + "users": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "member_space_limits/excluded_users/remove response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + } + } + } + } + }, + "examples": { + "member_space_limits/excluded_users/remove response": { + "value": { + "status": { + ".tag": "success" + } + } + } + } + } + } + } + } + } + }, + "/2/team/member_space_limits/get_custom_quota": { + "post": { + "tags": [ + "team", + "member_space_limits" + ], + "summary": "member_space_limits/get_custom_quota", + "description": "[member_space_limits/get_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-get_custom_quota)\n\nscope: `members.read`\n\nGet users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.", + "operationId": "memberSpaceLimitsGetCustomQuota", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "example": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + }, + "examples": { + "member_space_limits/get_custom_quota": { + "value": { + "users": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "member_space_limits/get_custom_quota response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "other" + } + } + }, + "example": [ + { + ".tag": "other" + } + ] + }, + "examples": { + "member_space_limits/get_custom_quota response": { + "value": [ + { + ".tag": "other" + } + ] + } + } + } + } + } + } + } + }, + "/2/team/member_space_limits/remove_custom_quota": { + "post": { + "tags": [ + "team", + "member_space_limits" + ], + "summary": "member_space_limits/remove_custom_quota", + "description": "[member_space_limits/remove_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-remove_custom_quota)\n\nscope: `members.write`\n\nRemove users custom quota. A maximum of 1000 members can be specified in a single call.", + "operationId": "memberSpaceLimitsRemoveCustomQuota", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "example": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + }, + "examples": { + "member_space_limits/remove_custom_quota": { + "value": { + "users": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "member_space_limits/remove_custom_quota response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "other" + } + } + }, + "example": [ + { + ".tag": "other" + } + ] + }, + "examples": { + "member_space_limits/remove_custom_quota response": { + "value": [ + { + ".tag": "other" + } + ] + } + } + } + } + } + } + } + }, + "/2/team/member_space_limits/set_custom_quota": { + "post": { + "tags": [ + "team", + "member_space_limits" + ], + "summary": "member_space_limits/set_custom_quota", + "description": "[member_space_limits/set_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-set_custom_quota)\n\nscope: `members.read`\n\nSet users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.", + "operationId": "memberSpaceLimitsSetCustomQuota", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users_and_quotas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quota_gb": { + "type": "number", + "example": 30 + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + "quota_gb": 30, + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + }, + "examples": { + "member_space_limits/set_custom_quota": { + "value": { + "users_and_quotas": [ + { + "quota_gb": 30, + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "member_space_limits/set_custom_quota response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "other" + } + } + }, + "example": [ + { + ".tag": "other" + } + ] + }, + "examples": { + "member_space_limits/set_custom_quota response": { + "value": [ + { + ".tag": "other" + } + ] + } + } + } + } + } + } + } + }, + "/2/team/members/add": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/add", + "description": "[members/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-add)\n\nscope: `members.write`\n\nAdds members to a team.\nPermission : Team member management\nA maximum of 20 members can be specified in a single call.\nIf no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.\nIf a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.\nTeam member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.", + "operationId": "membersAdd", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "force_async": { + "type": "boolean", + "example": false + }, + "new_members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "member_email": { + "type": "string", + "example": "tom.s@company.com" + }, + "member_external_id": { + "type": "string", + "example": "company_id:342432" + }, + "member_given_name": { + "type": "string", + "example": "Tom" + }, + "member_surname": { + "type": "string", + "example": "Silverstone" + }, + "role": { + "type": "string", + "example": "member_only" + }, + "send_welcome_email": { + "type": "boolean", + "example": true + } + } + }, + "example": [ + { + "member_email": "tom.s@company.com", + "member_external_id": "company_id:342432", + "member_given_name": "Tom", + "member_surname": "Silverstone", + "role": "member_only", + "send_welcome_email": true + } + ] + } + } + }, + "examples": { + "members/add": { + "value": { + "force_async": false, + "new_members": [ + { + "member_email": "tom.s@company.com", + "member_external_id": "company_id:342432", + "member_given_name": "Tom", + "member_surname": "Silverstone", + "role": "member_only", + "send_welcome_email": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/add response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "complete": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + }, + "examples": { + "members/add response": { + "value": { + ".tag": "complete", + "complete": [ + { + ".tag": "success", + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/members/add/job_status/get": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/add/job_status/get", + "description": "[members/add/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-add-job_status-get)\n\nscope: `members.write`\n\nOnce an async_job_id is returned from `members/add` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", + "operationId": "membersAddJobStatusGet", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "members/add/job_status/get": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/add/job_status/get response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "complete": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + }, + "examples": { + "members/add/job_status/get response": { + "value": { + ".tag": "complete", + "complete": [ + { + ".tag": "success", + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/members/delete_profile_photo": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/delete_profile_photo", + "description": "[members/delete_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-delete_profile_photo)\n\nscope: `members.write`\n\nDeletes a team member's profile photo.\nPermission : Team member management.", + "operationId": "membersDeleteProfilePhoto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "members/delete_profile_photo": { + "value": { + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/delete_profile_photo response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "examples": { + "members/delete_profile_photo response": { + "value": { + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + } + } + } + } + } + } + } + }, + "/2/team/members/get_info": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/get_info", + "description": "[members/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-members-get_info)\n\nscope: `members.read`\n\nReturns information about multiple team members.\nPermission : Team information\nThis endpoint will return `MembersGetInfoItem.id_not_found`, for IDs (or emails) that cannot be matched to a valid team member.", + "operationId": "membersGetInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "example": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + }, + "examples": { + "members/get_info": { + "value": { + "members": [ + { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/get_info response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_info" + }, + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "example": [ + { + ".tag": "member_info", + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + }, + "examples": { + "members/get_info response": { + "value": [ + { + ".tag": "member_info", + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + } + } + } + } + } + }, + "/2/team/members/list": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/list", + "description": "[members/list](https://www.dropbox.com/developers/documentation/http/teams#team-members-list)\n\nscope: `members.read`\n\nLists members of a team.\nPermission : Team information.", + "operationId": "membersList", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_removed": { + "type": "boolean", + "example": false + }, + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "members/list": { + "value": { + "include_removed": false, + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/list response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": true + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "example": [ + { + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + }, + "examples": { + "members/list response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": true, + "members": [ + { + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/members/list/continue": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/list/continue", + "description": "[members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-members-list-continue)\n\nscope: `members.read`\n\nOnce a cursor has been retrieved from `members/list`, use this to paginate through all team members.\nPermission : Team information.", + "operationId": "membersListContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "members/list/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/list/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": true + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "example": [ + { + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + }, + "examples": { + "members/list/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": true, + "members": [ + { + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/members/move_former_member_files": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/move_former_member_files", + "description": "[members/move_former_member_files](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files)\n\nscope: `members.write`\n\nMoves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/move_former_member_files/job_status/check`.\nPermission : Team member management.", + "operationId": "membersMoveFormerMemberFiles", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "transfer_admin_id": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "transfer_dest_id": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "members/move_former_member_files": { + "value": { + "transfer_admin_id": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + }, + "transfer_dest_id": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + }, + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/move_former_member_files response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "members/move_former_member_files response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/team/members/move_former_member_files/job_status/check": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/move_former_member_files/job_status/check", + "description": "[members/move_former_member_files/job_status/check](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files-job_status-check)\n\nscope: `members.write`\n\nOnce an async_job_id is returned from `members/move_former_member_files` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", + "operationId": "membersMoveFormerMemberFilesJobStatusCheck", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "members/move_former_member_files/job_status/check": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/move_former_member_files/job_status/check response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "members/move_former_member_files/job_status/check response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/team/members/recover": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/recover", + "description": "[members/recover](https://www.dropbox.com/developers/documentation/http/teams#team-members-recover)\n\nscope: `members.delete`\n\nRecover a deleted member.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", + "operationId": "membersRecover", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "members/recover": { + "value": { + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/members/remove": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/remove", + "description": "[members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove)\n\nscope: `members.delete`\n\nRemoves a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.\nAccounts can be recovered via `members/recover` for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling `members/add` while a user is still recoverable on your team will return with `MemberAddResult.user_already_on_team`.\nAccounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams).\nThis endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/remove/job_status/get`.", + "operationId": "membersRemove", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "keep_account": { + "type": "boolean", + "example": false + }, + "retain_team_shares": { + "type": "boolean", + "example": false + }, + "transfer_admin_id": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "transfer_dest_id": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "wipe_data": { + "type": "boolean", + "example": true + } + } + }, + "examples": { + "members/remove": { + "value": { + "keep_account": false, + "retain_team_shares": false, + "transfer_admin_id": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + }, + "transfer_dest_id": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + }, + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + }, + "wipe_data": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/remove response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "members/remove response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/team/members/remove/job_status/get": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/remove/job_status/get", + "description": "[members/remove/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove-job_status-get)\n\nscope: `members.delete`\n\nOnce an async_job_id is returned from `members/remove` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", + "operationId": "membersRemoveJobStatusGet", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "members/remove/job_status/get": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/remove/job_status/get response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + } + } + }, + "examples": { + "members/remove/job_status/get response": { + "value": { + ".tag": "complete" + } + } + } + } + } + } + } + } + }, + "/2/team/members/secondary_emails/add": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/secondary_emails/add", + "description": "[members/secondary_emails/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-add)\n\nscope: `members.write`\n\nAdd secondary emails to users.\nPermission : Team member management.\nEmails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.", + "operationId": "membersSecondaryEmailsAdd", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "secondary_emails": { + "type": "array", + "items": { + "type": "string", + "example": "bob2@hotmail.com" + }, + "example": [ + "bob2@hotmail.com", + "bob@inst.gov" + ] + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + "secondary_emails": [ + "bob2@hotmail.com", + "bob@inst.gov" + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + }, + "examples": { + "members/secondary_emails/add": { + "value": { + "new_secondary_emails": [ + { + "secondary_emails": [ + "bob2@hotmail.com", + "bob@inst.gov" + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/secondary_emails/add response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "invalid_user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "success": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "apple@orange.com" + }, + "is_verified": { + "type": "boolean", + "example": true + } + } + }, + "unavailable": { + "type": "string", + "example": "alice@example.com" + } + } + }, + "example": [ + { + ".tag": "success", + "success": { + "email": "apple@orange.com", + "is_verified": true + } + }, + { + ".tag": "unavailable", + "unavailable": "alice@example.com" + } + ] + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "results": [ + { + ".tag": "success", + "success": { + "email": "apple@orange.com", + "is_verified": true + } + }, + { + ".tag": "unavailable", + "unavailable": "alice@example.com" + } + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + }, + { + ".tag": "invalid_user", + "invalid_user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + }, + "examples": { + "members/secondary_emails/add response": { + "value": { + "results": [ + { + ".tag": "success", + "results": [ + { + ".tag": "success", + "success": { + "email": "apple@orange.com", + "is_verified": true + } + }, + { + ".tag": "unavailable", + "unavailable": "alice@example.com" + } + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + }, + { + ".tag": "invalid_user", + "invalid_user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/members/secondary_emails/delete": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/secondary_emails/delete", + "description": "[members/secondary_emails/delete](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-delete)\n\nscope: `members.write`\n\nDelete secondary emails from users\nPermission : Team member management.\nUsers will be notified of deletions of verified secondary emails at both the secondary email and their primary email.", + "operationId": "membersSecondaryEmailsDelete", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "emails_to_delete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "secondary_emails": { + "type": "array", + "items": { + "type": "string", + "example": "bob2@hotmail.com" + }, + "example": [ + "bob2@hotmail.com", + "bob@inst.gov" + ] + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + "secondary_emails": [ + "bob2@hotmail.com", + "bob@inst.gov" + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + }, + "examples": { + "members/secondary_emails/delete": { + "value": { + "emails_to_delete": [ + { + "secondary_emails": [ + "bob2@hotmail.com", + "bob@inst.gov" + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/secondary_emails/delete response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "not_found": { + "type": "string", + "example": "alic@example.com" + }, + "success": { + "type": "string", + "example": "alice@example.com" + } + } + }, + "example": [ + { + ".tag": "success", + "success": "alice@example.com" + }, + { + ".tag": "not_found", + "not_found": "alic@example.com" + } + ] + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "results": [ + { + ".tag": "success", + "success": "alice@example.com" + }, + { + ".tag": "not_found", + "not_found": "alic@example.com" + } + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + }, + "examples": { + "members/secondary_emails/delete response": { + "value": { + "results": [ + { + ".tag": "success", + "results": [ + { + ".tag": "success", + "success": "alice@example.com" + }, + { + ".tag": "not_found", + "not_found": "alic@example.com" + } + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/members/secondary_emails/resend_verification_emails": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/secondary_emails/resend_verification_emails", + "description": "[members/secondary_emails/resend_verification_emails](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-resend_verification_emails)\n\nscope: `members.write`\n\nResend secondary email verification emails.\nPermission : Team member management.", + "operationId": "membersSecondaryEmailsResendVerificationEmails", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "emails_to_resend": { + "type": "array", + "items": { + "type": "object", + "properties": { + "secondary_emails": { + "type": "array", + "items": { + "type": "string", + "example": "bob2@hotmail.com" + }, + "example": [ + "bob2@hotmail.com", + "bob@inst.gov" + ] + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + "secondary_emails": [ + "bob2@hotmail.com", + "bob@inst.gov" + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + }, + "examples": { + "members/secondary_emails/resend_verification_emails": { + "value": { + "emails_to_resend": [ + { + "secondary_emails": [ + "bob2@hotmail.com", + "bob@inst.gov" + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/secondary_emails/resend_verification_emails response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "success" + }, + "success": { + "type": "string", + "example": "alice@example.com" + } + } + }, + "example": [ + { + ".tag": "success", + "success": "alice@example.com" + } + ] + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "example": [ + { + ".tag": "success", + "results": [ + { + ".tag": "success", + "success": "alice@example.com" + } + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + }, + "examples": { + "members/secondary_emails/resend_verification_emails response": { + "value": { + "results": [ + { + ".tag": "success", + "results": [ + { + ".tag": "success", + "success": "alice@example.com" + } + ], + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/members/send_welcome_email": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/send_welcome_email", + "description": "[members/send_welcome_email](https://www.dropbox.com/developers/documentation/http/teams#team-members-send_welcome_email)\n\nscope: `members.write`\n\nSends welcome email to pending team member.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.\nNo-op if team member is not pending.", + "operationId": "membersSendWelcomeEmail", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "examples": { + "members/send_welcome_email": { + "value": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/members/set_admin_permissions": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/set_admin_permissions", + "description": "[members/set_admin_permissions](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_admin_permissions)\n\nscope: `members.write`\n\nUpdates a team member's permissions.\nPermission : Team member management.", + "operationId": "membersSetAdminPermissions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_role": { + "type": "string", + "example": "member_only" + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "members/set_admin_permissions": { + "value": { + "new_role": "member_only", + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/set_admin_permissions response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:9978889" + } + } + }, + "examples": { + "members/set_admin_permissions response": { + "value": { + "role": { + ".tag": "member_only" + }, + "team_member_id": "dbmid:9978889" + } + } + } + } + } + } + } + } + }, + "/2/team/members/set_profile": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/set_profile", + "description": "[members/set_profile](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile)\n\nscope: `members.write`\n\nUpdates a team member's profile.\nPermission : Team member management.", + "operationId": "membersSetProfile", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_email": { + "type": "string", + "example": "t.smith@domain.com" + }, + "new_surname": { + "type": "string", + "example": "Smith" + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "members/set_profile": { + "value": { + "new_email": "t.smith@domain.com", + "new_surname": "Smith", + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/set_profile response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "examples": { + "members/set_profile response": { + "value": { + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + } + } + } + } + } + } + } + }, + "/2/team/members/set_profile_photo": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/set_profile_photo", + "description": "[members/set_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile_photo)\n\nscope: `members.write`\n\nUpdates a team member's profile photo.\nPermission : Team member management.", + "operationId": "membersSetProfilePhoto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "photo": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "base64_data" + }, + "base64_data": { + "type": "string", + "example": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" + } + } + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "members/set_profile_photo": { + "value": { + "photo": { + ".tag": "base64_data", + "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" + }, + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "members/set_profile_photo response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, + "role": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "member_only" + } + } + } + } + }, + "examples": { + "members/set_profile_photo response": { + "value": { + "profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + }, + "role": { + ".tag": "member_only" + } + } + } + } + } + } + } + } + } + }, + "/2/team/members/suspend": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/suspend", + "description": "[members/suspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-suspend)\n\nscope: `members.write`\n\nSuspend a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", + "operationId": "membersSuspend", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + }, + "wipe_data": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "members/suspend": { + "value": { + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + }, + "wipe_data": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/members/unsuspend": { + "post": { + "tags": [ + "team", + "members" + ], + "summary": "members/unsuspend", + "description": "[members/unsuspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-unsuspend)\n\nscope: `members.write`\n\nUnsuspend a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", + "operationId": "membersUnsuspend", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member_id" + }, + "team_member_id": { + "type": "string", + "example": "dbmid:efgh5678" + } + } + } + } + }, + "examples": { + "members/unsuspend": { + "value": { + "user": { + ".tag": "team_member_id", + "team_member_id": "dbmid:efgh5678" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/namespaces/list": { + "post": { + "tags": [ + "team", + "namespaces" + ], + "summary": "namespaces/list", + "description": "[namespaces/list](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list)\n\nscope: `team_data.member`\n\nReturns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.", + "operationId": "namespacesList", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "number", + "example": 1 + } + } + }, + "examples": { + "namespaces/list": { + "value": { + "limit": 1 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "namespaces/list response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "namespaces": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Marketing" + }, + "namespace_id": { + "type": "string", + "example": "123456789" + }, + "namespace_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "shared_folder" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + }, + "example": [ + { + "name": "Marketing", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "shared_folder" + } + }, + { + "name": "Franz Ferdinand", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "team_member_folder" + }, + "team_member_id": "dbmid:1234567" + } + ] + } + } + }, + "examples": { + "namespaces/list response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "namespaces": [ + { + "name": "Marketing", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "shared_folder" + } + }, + { + "name": "Franz Ferdinand", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "team_member_folder" + }, + "team_member_id": "dbmid:1234567" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/namespaces/list/continue": { + "post": { + "tags": [ + "team", + "namespaces" + ], + "summary": "namespaces/list/continue", + "description": "[namespaces/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list-continue)\n\nscope: `team_data.member`\n\nOnce a cursor has been retrieved from `namespaces/list`, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.", + "operationId": "namespacesListContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "namespaces/list/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "namespaces/list/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "namespaces": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Marketing" + }, + "namespace_id": { + "type": "string", + "example": "123456789" + }, + "namespace_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "shared_folder" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:1234567" + } + } + }, + "example": [ + { + "name": "Marketing", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "shared_folder" + } + }, + { + "name": "Franz Ferdinand", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "team_member_folder" + }, + "team_member_id": "dbmid:1234567" + } + ] + } + } + }, + "examples": { + "namespaces/list/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "namespaces": [ + { + "name": "Marketing", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "shared_folder" + } + }, + { + "name": "Franz Ferdinand", + "namespace_id": "123456789", + "namespace_type": { + ".tag": "team_member_folder" + }, + "team_member_id": "dbmid:1234567" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/reports/get_activity": { + "post": { + "tags": [ + "team", + "reports" + ], + "summary": "reports/get_activity", + "description": "[reports/get_activity](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_activity)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's user activity.", + "operationId": "reportsGetActivity", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "reports/get_activity": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/reports/get_devices": { + "post": { + "tags": [ + "team", + "reports" + ], + "summary": "reports/get_devices", + "description": "[reports/get_devices](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_devices)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's linked devices.", + "operationId": "reportsGetDevices", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "reports/get_devices": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/reports/get_membership": { + "post": { + "tags": [ + "team", + "reports" + ], + "summary": "reports/get_membership", + "description": "[reports/get_membership](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_membership)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's membership.", + "operationId": "reportsGetMembership", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "reports/get_membership": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/reports/get_storage": { + "post": { + "tags": [ + "team", + "reports" + ], + "summary": "reports/get_storage", + "description": "[reports/get_storage](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_storage)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's storage usage.", + "operationId": "reportsGetStorage", + "requestBody": { + "content": { + "text/plain": { + "examples": { + "reports/get_storage": { + "value": "" + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/team_folder/activate": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/activate", + "description": "[team_folder/activate](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-activate)\n\nscope: `team_data.team_space`\n\nSets an archived team folder's status to active.\nPermission : Team member file access.", + "operationId": "teamFolderActivate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/activate": { + "value": { + "team_folder_id": "123456789" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/activate response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/activate response": { + "value": { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + } + } + } + } + } + } + } + }, + "/2/team/team_folder/archive": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/archive", + "description": "[team_folder/archive](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive)\n\nscope: `team_data.team_space`\n\nSets an active team folder's status to archived and removes all folder and file members.\nPermission : Team member file access.", + "operationId": "teamFolderArchive", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "force_async_off": { + "type": "boolean", + "example": false + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/archive": { + "value": { + "force_async_off": false, + "team_folder_id": "123456789" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/archive response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/archive response": { + "value": { + ".tag": "complete", + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + } + } + } + } + } + } + } + }, + "/2/team/team_folder/archive/check": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/archive/check", + "description": "[team_folder/archive/check](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive-check)\n\nscope: `team_data.team_space`\n\nReturns the status of an asynchronous job for archiving a team folder.\nPermission : Team member file access.", + "operationId": "teamFolderArchiveCheck", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async_job_id": { + "type": "string", + "example": "34g93hh34h04y384084" + } + } + }, + "examples": { + "team_folder/archive/check": { + "value": { + "async_job_id": "34g93hh34h04y384084" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/archive/check response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "complete" + }, + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/archive/check response": { + "value": { + ".tag": "complete", + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + } + } + } + } + } + } + } + }, + "/2/team/team_folder/create": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/create", + "description": "[team_folder/create](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-create)\n\nscope: `team_data.team_space`\n\nCreates a new, active, team folder with no members.\nPermission : Team member file access.", + "operationId": "teamFolderCreate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Marketing" + }, + "sync_setting": { + "type": "string", + "example": "not_synced" + } + } + }, + "examples": { + "team_folder/create": { + "value": { + "name": "Marketing", + "sync_setting": "not_synced" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/create response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/create response": { + "value": { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + } + } + } + } + } + } + } + }, + "/2/team/team_folder/get_info": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/get_info", + "description": "[team_folder/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-get_info)\n\nscope: `team_data.team_space`\n\nRetrieves metadata for team folders.\nPermission : Team member file access.", + "operationId": "teamFolderGetInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "team_folder_ids": { + "type": "array", + "items": { + "type": "string", + "example": "947182" + }, + "example": [ + "947182", + "5819424", + "852307532" + ] + } + } + }, + "examples": { + "team_folder/get_info": { + "value": { + "team_folder_ids": [ + "947182", + "5819424", + "852307532" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/team_folder/list": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/list", + "description": "[team_folder/list](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list)\n\nscope: `team_data.team_space`\n\nLists all team folders.\nPermission : Team member file access.", + "operationId": "teamFolderList", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "number", + "example": 100 + } + } + }, + "examples": { + "team_folder/list": { + "value": { + "limit": 100 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/list response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "team_folders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "example": [ + { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + ] + } + } + }, + "examples": { + "team_folder/list response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "team_folders": [ + { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/team_folder/list/continue": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/list/continue", + "description": "[team_folder/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list-continue)\n\nscope: `team_data.team_space`\n\nOnce a cursor has been retrieved from `team_folder/list`, use this to paginate through all team folders.\nPermission : Team member file access.", + "operationId": "teamFolderListContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "team_folder/list/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/list/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "has_more": { + "type": "boolean", + "example": false + }, + "team_folders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "example": [ + { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + ] + } + } + }, + "examples": { + "team_folder/list/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "has_more": false, + "team_folders": [ + { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/team_folder/permanently_delete": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/permanently_delete", + "description": "[team_folder/permanently_delete](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-permanently_delete)\n\nscope: `team_data.team_space`\n\nPermanently deletes an archived team folder.\nPermission : Team member file access.", + "operationId": "teamFolderPermanentlyDelete", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/permanently_delete": { + "value": { + "team_folder_id": "123456789" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/2/team/team_folder/rename": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/rename", + "description": "[team_folder/rename](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-rename)\n\nscope: `team_data.team_space`\n\nChanges an active team folder's name.\nPermission : Team member file access.", + "operationId": "teamFolderRename", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Sales" + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/rename": { + "value": { + "name": "Sales", + "team_folder_id": "123456789" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/rename response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/rename response": { + "value": { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + } + } + } + } + } + } + } + }, + "/2/team/team_folder/update_sync_settings": { + "post": { + "tags": [ + "team", + "team_folder" + ], + "summary": "team_folder/update_sync_settings", + "description": "[team_folder/update_sync_settings](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-update_sync_settings)\n\nscope: `team_data.team_space`\n\nUpdates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.", + "operationId": "teamFolderUpdateSyncSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "string", + "example": "not_synced" + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": "not_synced" + } + ] + }, + "sync_setting": { + "type": "string", + "example": "not_synced" + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/update_sync_settings": { + "value": { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": "not_synced" + } + ], + "sync_setting": "not_synced", + "team_folder_id": "123456789" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "team_folder/update_sync_settings response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content_sync_settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "id:a4ayc_80_OEAAAAAAAAAXw" + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + } + } + }, + "example": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ] + }, + "is_team_shared_dropbox": { + "type": "boolean", + "example": false + }, + "name": { + "type": "string", + "example": "Marketing" + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "sync_setting": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "default" + } + } + }, + "team_folder_id": { + "type": "string", + "example": "123456789" + } + } + }, + "examples": { + "team_folder/update_sync_settings response": { + "value": { + "content_sync_settings": [ + { + "id": "id:a4ayc_80_OEAAAAAAAAAXw", + "sync_setting": { + ".tag": "default" + } + } + ], + "is_team_shared_dropbox": false, + "name": "Marketing", + "status": { + ".tag": "active" + }, + "sync_setting": { + ".tag": "default" + }, + "team_folder_id": "123456789" + } + } + } + } + } + } + } + } + }, + "/2/team/features/get_values": { + "post": { + "tags": [ + "team" + ], + "summary": "features/get_values", + "description": "[features/get_values](https://www.dropbox.com/developers/documentation/http/teams#team-features-get_values)\n\nscope: `team_info.read`\n\nGet the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features.\nPermission : Team information.", + "operationId": "featuresGetValues", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "features": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "upload_api_rate_limit" + } + } + }, + "example": [ + { + ".tag": "upload_api_rate_limit" + }, + { + ".tag": "has_team_shared_dropbox" + } + ] + } + } + }, + "examples": { + "features/get_values": { + "value": { + "features": [ + { + ".tag": "upload_api_rate_limit" + }, + { + ".tag": "has_team_shared_dropbox" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "features/get_values response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "upload_api_rate_limit" + }, + "has_team_shared_dropbox": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "has_team_shared_dropbox" + }, + "has_team_shared_dropbox": { + "type": "boolean", + "example": false + } + } + }, + "upload_api_rate_limit": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "limit" + }, + "limit": { + "type": "number", + "example": 25000 + } + } + } + } + }, + "example": [ + { + ".tag": "upload_api_rate_limit", + "upload_api_rate_limit": { + ".tag": "limit", + "limit": 25000 + } + }, + { + ".tag": "has_team_shared_dropbox", + "has_team_shared_dropbox": { + ".tag": "has_team_shared_dropbox", + "has_team_shared_dropbox": false + } + } + ] + } + } + }, + "examples": { + "features/get_values response": { + "value": { + "values": [ + { + ".tag": "upload_api_rate_limit", + "upload_api_rate_limit": { + ".tag": "limit", + "limit": 25000 + } + }, + { + ".tag": "has_team_shared_dropbox", + "has_team_shared_dropbox": { + ".tag": "has_team_shared_dropbox", + "has_team_shared_dropbox": false + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/team/get_info": { + "post": { + "tags": [ + "team" + ], + "summary": "get_info", + "description": "[get_info](https://www.dropbox.com/developers/documentation/http/teams#team-get_info)\n\nscope: `team_info.read`\n\nRetrieves information about a team.", + "operationId": "getInfo", + "responses": { + "200": { + "description": "get_info response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Dropbox Inc." + }, + "num_licensed_users": { + "type": "number", + "example": 5 + }, + "num_provisioned_users": { + "type": "number", + "example": 2 + }, + "policies": { + "type": "object", + "properties": { + "emm_state": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "disabled" + } + } + }, + "office_addin": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "disabled" + } + } + }, + "sharing": { + "type": "object", + "properties": { + "shared_folder_join_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "from_anyone" + } + } + }, + "shared_folder_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_create_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_only" + } + } + } + } + } + } + }, + "team_id": { + "type": "string", + "example": "dbtid:1234abcd" + } + } + }, + "examples": { + "get_info response": { + "value": { + "name": "Dropbox Inc.", + "num_licensed_users": 5, + "num_provisioned_users": 2, + "policies": { + "emm_state": { + ".tag": "disabled" + }, + "office_addin": { + ".tag": "disabled" + }, + "sharing": { + "shared_folder_join_policy": { + ".tag": "from_anyone" + }, + "shared_folder_member_policy": { + ".tag": "team" + }, + "shared_link_create_policy": { + ".tag": "team_only" + } + } + }, + "team_id": "dbtid:1234abcd" + } + } + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/team/token/get_authenticated_admin": { + "post": { + "tags": [ + "team" + ], + "summary": "token/get_authenticated_admin", + "description": "[token/get_authenticated_admin](https://www.dropbox.com/developers/documentation/http/teams#team-token-get_authenticated_admin)\n\nscope: `team_info.read`\n\nReturns the member profile of the admin who generated the team access token used to make the call.", + "operationId": "tokenGetAuthenticatedAdmin", + "responses": { + "200": { + "description": "token/get_authenticated_admin response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "admin_profile": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "email": { + "type": "string", + "example": "tami@seagull.com" + }, + "email_verified": { + "type": "boolean", + "example": false + }, + "external_id": { + "type": "string", + "example": "244423" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "example": "g:e2db7665347abcd600000000001a2b3c" + }, + "example": [ + "g:e2db7665347abcd600000000001a2b3c" + ] + }, + "joined_on": { + "type": "string", + "example": "2015-05-12T15:50:38Z" + }, + "member_folder_id": { + "type": "string", + "example": "20" + }, + "membership_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "full" + } + } + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + }, + "secondary_emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string", + "example": "grape@strawberry.com" + }, + "is_verified": { + "type": "boolean", + "example": false + } + } + }, + "example": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ] + }, + "status": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "active" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + } + } + }, + "examples": { + "token/get_authenticated_admin response": { + "value": { + "admin_profile": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "email": "tami@seagull.com", + "email_verified": false, + "external_id": "244423", + "groups": [ + "g:e2db7665347abcd600000000001a2b3c" + ], + "joined_on": "2015-05-12T15:50:38Z", + "member_folder_id": "20", + "membership_type": { + ".tag": "full" + }, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", + "secondary_emails": [ + { + "email": "grape@strawberry.com", + "is_verified": false + }, + { + "email": "apple@orange.com", + "is_verified": true + } + ], + "status": { + ".tag": "active" + }, + "team_member_id": "dbmid:FDFSVF-DFSDF" + } + } + } + } + } + } + } + } + } + }, + "/2/team_log/get_events": { + "post": { + "tags": [ + "team_log" + ], + "summary": "get_events", + "description": "[get_events](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events)\n\nscope: `events.read`\n\nRetrieves team events. If the result's `GetTeamEventsResult.has_more` field is `true`, call `get_events/continue` with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll `get_events/continue` for new events.\nMany attributes note 'may be missing due to historical data gap'.\nNote that the file_operations category and & analogous paper events are not available on all Dropbox Business [plans](http://www.dropbox.com/business/plans-comparison). Use [features/get_values](http://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) to check for this feature.\nPermission : Team Auditing.", + "operationId": "getEvents", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "example": "groups" + }, + "limit": { + "type": "number", + "example": 50 + } + } + }, + "examples": { + "get_events": { + "value": { + "category": "groups", + "limit": 50 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_events response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "actor": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user" + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" + }, + "display_name": { + "type": "string", + "example": "John Smith" + }, + "email": { + "type": "string", + "example": "john_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + } + } + }, + "assets": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "display_name": { + "type": "string", + "example": "reports.xls" + }, + "file_id": { + "type": "string", + "example": "id:jQKLsZFQImAAAAAAEZAAQt" + }, + "file_size": { + "type": "number", + "example": 4 + }, + "path": { + "type": "object", + "properties": { + "contextual": { + "type": "string", + "example": "/Contract Work/Draft" + }, + "namespace_relative": { + "type": "object", + "properties": { + "is_shared_namespace": { + "type": "boolean", + "example": false + }, + "ns_id": { + "type": "string", + "example": "1234" + }, + "relative_path": { + "type": "string", + "example": "/Contract Work/Draft" + } + } + } + } + } + } + }, + "example": [ + { + ".tag": "file", + "display_name": "reports.xls", + "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", + "file_size": 4, + "path": { + "contextual": "/Contract Work/Draft", + "namespace_relative": { + "is_shared_namespace": false, + "ns_id": "1234", + "relative_path": "/Contract Work/Draft" + } + } + } + ] + }, + "context": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" + }, + "display_name": { + "type": "string", + "example": "John Smith" + }, + "email": { + "type": "string", + "example": "john_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + }, + "details": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "shared_content_download_details" + }, + "shared_content_access_level": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer_no_comment" + } + } + }, + "shared_content_link": { + "type": "string", + "example": "abc" + }, + "shared_content_owner": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" + }, + "display_name": { + "type": "string", + "example": "John Smith" + }, + "email": { + "type": "string", + "example": "john_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + } + } + }, + "event_category": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "tfa" + } + } + }, + "event_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "shared_content_download" + }, + "description": { + "type": "string", + "example": "(sharing) Downloaded shared file/folder" + } + } + }, + "involve_non_team_member": { + "type": "boolean", + "example": true + }, + "origin": { + "type": "object", + "properties": { + "access_method": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "end_user" + }, + "end_user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "web" + }, + "session_id": { + "type": "string", + "example": "dbwsid:123456789012345678901234567890123456789" + } + } + } + } + }, + "geo_location": { + "type": "object", + "properties": { + "city": { + "type": "string", + "example": "San Francisco" + }, + "country": { + "type": "string", + "example": "US" + }, + "ip_address": { + "type": "string", + "example": "45.56.78.100" + }, + "region": { + "type": "string", + "example": "California" + } + } + } + } + }, + "participants": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user" + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw" + }, + "display_name": { + "type": "string", + "example": "Jane Smith" + }, + "email": { + "type": "string", + "example": "jane_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + } + } + }, + "example": [ + { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", + "display_name": "Jane Smith", + "email": "jane_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + ] + }, + "timestamp": { + "type": "string", + "example": "2017-01-25T15:51:30Z" + } + } + }, + "example": [ + { + "actor": { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "assets": [ + { + ".tag": "file", + "display_name": "reports.xls", + "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", + "file_size": 4, + "path": { + "contextual": "/Contract Work/Draft", + "namespace_relative": { + "is_shared_namespace": false, + "ns_id": "1234", + "relative_path": "/Contract Work/Draft" + } + } + } + ], + "context": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + }, + "details": { + ".tag": "shared_content_download_details", + "shared_content_access_level": { + ".tag": "viewer_no_comment" + }, + "shared_content_link": "abc", + "shared_content_owner": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "event_category": { + ".tag": "tfa" + }, + "event_type": { + ".tag": "shared_content_download", + "description": "(sharing) Downloaded shared file/folder" + }, + "involve_non_team_member": true, + "origin": { + "access_method": { + ".tag": "end_user", + "end_user": { + ".tag": "web", + "session_id": "dbwsid:123456789012345678901234567890123456789" + } + }, + "geo_location": { + "city": "San Francisco", + "country": "US", + "ip_address": "45.56.78.100", + "region": "California" + } + }, + "participants": [ + { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", + "display_name": "Jane Smith", + "email": "jane_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + ], + "timestamp": "2017-01-25T15:51:30Z" + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "get_events response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "events": [ + { + "actor": { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "assets": [ + { + ".tag": "file", + "display_name": "reports.xls", + "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", + "file_size": 4, + "path": { + "contextual": "/Contract Work/Draft", + "namespace_relative": { + "is_shared_namespace": false, + "ns_id": "1234", + "relative_path": "/Contract Work/Draft" + } + } + } + ], + "context": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + }, + "details": { + ".tag": "shared_content_download_details", + "shared_content_access_level": { + ".tag": "viewer_no_comment" + }, + "shared_content_link": "abc", + "shared_content_owner": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "event_category": { + ".tag": "tfa" + }, + "event_type": { + ".tag": "shared_content_download", + "description": "(sharing) Downloaded shared file/folder" + }, + "involve_non_team_member": true, + "origin": { + "access_method": { + ".tag": "end_user", + "end_user": { + ".tag": "web", + "session_id": "dbwsid:123456789012345678901234567890123456789" + } + }, + "geo_location": { + "city": "San Francisco", + "country": "US", + "ip_address": "45.56.78.100", + "region": "California" + } + }, + "participants": [ + { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", + "display_name": "Jane Smith", + "email": "jane_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + ], + "timestamp": "2017-01-25T15:51:30Z" + } + ], + "has_more": false + } + } + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/team_log/get_events/continue": { + "post": { + "tags": [ + "team_log" + ], + "summary": "get_events/continue", + "description": "[get_events/continue](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events-continue)\n\nscope: `events.read`\n\nOnce a cursor has been retrieved from `get_events`, use this to paginate through all events.\nPermission : Team Auditing.", + "operationId": "getEventsContinue", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + }, + "examples": { + "get_events/continue": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_events/continue response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "type": "string", + "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "actor": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user" + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" + }, + "display_name": { + "type": "string", + "example": "John Smith" + }, + "email": { + "type": "string", + "example": "john_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + } + } + }, + "assets": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "file" + }, + "display_name": { + "type": "string", + "example": "reports.xls" + }, + "file_id": { + "type": "string", + "example": "id:jQKLsZFQImAAAAAAEZAAQt" + }, + "file_size": { + "type": "number", + "example": 4 + }, + "path": { + "type": "object", + "properties": { + "contextual": { + "type": "string", + "example": "/Contract Work/Draft" + }, + "namespace_relative": { + "type": "object", + "properties": { + "is_shared_namespace": { + "type": "boolean", + "example": false + }, + "ns_id": { + "type": "string", + "example": "1234" + }, + "relative_path": { + "type": "string", + "example": "/Contract Work/Draft" + } + } + } + } + } + } + }, + "example": [ + { + ".tag": "file", + "display_name": "reports.xls", + "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", + "file_size": 4, + "path": { + "contextual": "/Contract Work/Draft", + "namespace_relative": { + "is_shared_namespace": false, + "ns_id": "1234", + "relative_path": "/Contract Work/Draft" + } + } + } + ] + }, + "context": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" + }, + "display_name": { + "type": "string", + "example": "John Smith" + }, + "email": { + "type": "string", + "example": "john_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + }, + "details": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "shared_content_download_details" + }, + "shared_content_access_level": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "viewer_no_comment" + } + } + }, + "shared_content_link": { + "type": "string", + "example": "abc" + }, + "shared_content_owner": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" + }, + "display_name": { + "type": "string", + "example": "John Smith" + }, + "email": { + "type": "string", + "example": "john_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + } + } + }, + "event_category": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "tfa" + } + } + }, + "event_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "shared_content_download" + }, + "description": { + "type": "string", + "example": "(sharing) Downloaded shared file/folder" + } + } + }, + "involve_non_team_member": { + "type": "boolean", + "example": true + }, + "origin": { + "type": "object", + "properties": { + "access_method": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "end_user" + }, + "end_user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "web" + }, + "session_id": { + "type": "string", + "example": "dbwsid:123456789012345678901234567890123456789" + } + } + } + } + }, + "geo_location": { + "type": "object", + "properties": { + "city": { + "type": "string", + "example": "San Francisco" + }, + "country": { + "type": "string", + "example": "US" + }, + "ip_address": { + "type": "string", + "example": "45.56.78.100" + }, + "region": { + "type": "string", + "example": "California" + } + } + } + } + }, + "participants": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user" + }, + "user": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_member" + }, + "account_id": { + "type": "string", + "example": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw" + }, + "display_name": { + "type": "string", + "example": "Jane Smith" + }, + "email": { + "type": "string", + "example": "jane_smith@acmecorp.com" + }, + "member_external_id": { + "type": "string", + "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225" + }, + "team": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "example": "A Team" + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + } + } + }, + "example": [ + { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", + "display_name": "Jane Smith", + "email": "jane_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + ] + }, + "timestamp": { + "type": "string", + "example": "2017-01-25T15:51:30Z" + } + } + }, + "example": [ + { + "actor": { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "assets": [ + { + ".tag": "file", + "display_name": "reports.xls", + "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", + "file_size": 4, + "path": { + "contextual": "/Contract Work/Draft", + "namespace_relative": { + "is_shared_namespace": false, + "ns_id": "1234", + "relative_path": "/Contract Work/Draft" + } + } + } + ], + "context": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + }, + "details": { + ".tag": "shared_content_download_details", + "shared_content_access_level": { + ".tag": "viewer_no_comment" + }, + "shared_content_link": "abc", + "shared_content_owner": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "event_category": { + ".tag": "tfa" + }, + "event_type": { + ".tag": "shared_content_download", + "description": "(sharing) Downloaded shared file/folder" + }, + "involve_non_team_member": true, + "origin": { + "access_method": { + ".tag": "end_user", + "end_user": { + ".tag": "web", + "session_id": "dbwsid:123456789012345678901234567890123456789" + } + }, + "geo_location": { + "city": "San Francisco", + "country": "US", + "ip_address": "45.56.78.100", + "region": "California" + } + }, + "participants": [ + { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", + "display_name": "Jane Smith", + "email": "jane_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + ], + "timestamp": "2017-01-25T15:51:30Z" + } + ] + }, + "has_more": { + "type": "boolean", + "example": false + } + } + }, + "examples": { + "get_events/continue response": { + "value": { + "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", + "events": [ + { + "actor": { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "assets": [ + { + ".tag": "file", + "display_name": "reports.xls", + "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", + "file_size": 4, + "path": { + "contextual": "/Contract Work/Draft", + "namespace_relative": { + "is_shared_namespace": false, + "ns_id": "1234", + "relative_path": "/Contract Work/Draft" + } + } + } + ], + "context": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + }, + "details": { + ".tag": "shared_content_download_details", + "shared_content_access_level": { + ".tag": "viewer_no_comment" + }, + "shared_content_link": "abc", + "shared_content_owner": { + ".tag": "team_member", + "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", + "display_name": "John Smith", + "email": "john_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + }, + "event_category": { + ".tag": "tfa" + }, + "event_type": { + ".tag": "shared_content_download", + "description": "(sharing) Downloaded shared file/folder" + }, + "involve_non_team_member": true, + "origin": { + "access_method": { + ".tag": "end_user", + "end_user": { + ".tag": "web", + "session_id": "dbwsid:123456789012345678901234567890123456789" + } + }, + "geo_location": { + "city": "San Francisco", + "country": "US", + "ip_address": "45.56.78.100", + "region": "California" + } + }, + "participants": [ + { + ".tag": "user", + "user": { + ".tag": "team_member", + "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", + "display_name": "Jane Smith", + "email": "jane_smith@acmecorp.com", + "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", + "team": { + "display_name": "A Team" + }, + "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" + } + } + ], + "timestamp": "2017-01-25T15:51:30Z" + } + ], + "has_more": false + } + } + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/2/users/features/get_values": { + "post": { + "tags": [ + "users" + ], + "summary": "features/get_values", + "description": "[features/get_values](https://www.dropbox.com/developers/documentation/http/documentation#users-features-get_values)\n\nscope: `account_info.read`\n\nGet a list of feature values that may be configured for the current account.", + "operationId": "featuresGetValues1", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "features": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "paper_as_files" + } + } + }, + "example": [ + { + ".tag": "paper_as_files" + }, + { + ".tag": "file_locking" + } + ] + } + } + }, + "examples": { + "features/get_values": { + "value": { + "features": [ + { + ".tag": "paper_as_files" + }, + { + ".tag": "file_locking" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "features/get_values response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "paper_as_files" + }, + "paper_as_files": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "enabled" + }, + "enabled": { + "type": "boolean", + "example": true + } + } + } + } + }, + "example": [ + { + ".tag": "paper_as_files", + "paper_as_files": { + ".tag": "enabled", + "enabled": true + } + } + ] + } + } + }, + "examples": { + "features/get_values response": { + "value": { + "values": [ + { + ".tag": "paper_as_files", + "paper_as_files": { + ".tag": "enabled", + "enabled": true + } + } + ] + } + } + } + } + } + } + } + } + }, + "/2/users/get_account": { + "post": { + "tags": [ + "users" + ], + "summary": "get_account", + "description": "[get_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account)\n\nscope: `sharing.read`\n\nGet information about a user's account.", + "operationId": "getAccount", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + } + } + }, + "examples": { + "get_account": { + "value": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_account response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "disabled": { + "type": "boolean", + "example": false + }, + "email": { + "type": "string", + "example": "franz@dropbox.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "is_teammate": { + "type": "boolean", + "example": false + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + } + } + }, + "examples": { + "get_account response": { + "value": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "disabled": false, + "email": "franz@dropbox.com", + "email_verified": true, + "is_teammate": false, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + } + } + } + } + } + } + } + } + }, + "/2/users/get_account_batch": { + "post": { + "tags": [ + "users" + ], + "summary": "get_account_batch", + "description": "[get_account_batch](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account_batch)\n\nscope: `sharing.read`\n\nGet information about multiple user accounts. At most 300 accounts may be queried per request.", + "operationId": "getAccountBatch", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_ids": { + "type": "array", + "items": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "example": [ + "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ" + ] + } + } + }, + "examples": { + "get_account_batch": { + "value": { + "account_ids": [ + "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "get_account_batch response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "disabled": { + "type": "boolean", + "example": false + }, + "email": { + "type": "string", + "example": "franz@dropbox.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "is_teammate": { + "type": "boolean", + "example": false + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "profile_photo_url": { + "type": "string", + "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + } + } + }, + "example": [ + { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "disabled": false, + "email": "franz@dropbox.com", + "email_verified": true, + "is_teammate": false, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + } + ] + }, + "examples": { + "get_account_batch response": { + "value": [ + { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "disabled": false, + "email": "franz@dropbox.com", + "email_verified": true, + "is_teammate": false, + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" + } + ] + } + } + } + } + } + } + } + }, + "/2/users/get_current_account": { + "post": { + "tags": [ + "users" + ], + "summary": "get_current_account", + "description": "[get_current_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account)\n\nscope: `account_info.read`\n\nGet information about the current user's account.", + "operationId": "getCurrentAccount", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "get_current_account response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_id": { + "type": "string", + "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" + }, + "account_type": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "business" + } + } + }, + "country": { + "type": "string", + "example": "US" + }, + "disabled": { + "type": "boolean", + "example": false + }, + "email": { + "type": "string", + "example": "franz@dropbox.com" + }, + "email_verified": { + "type": "boolean", + "example": true + }, + "is_paired": { + "type": "boolean", + "example": true + }, + "locale": { + "type": "string", + "example": "en" + }, + "name": { + "type": "object", + "properties": { + "abbreviated_name": { + "type": "string", + "example": "FF" + }, + "display_name": { + "type": "string", + "example": "Franz Ferdinand (Personal)" + }, + "familiar_name": { + "type": "string", + "example": "Franz" + }, + "given_name": { + "type": "string", + "example": "Franz" + }, + "surname": { + "type": "string", + "example": "Ferdinand" + } + } + }, + "referral_link": { + "type": "string", + "example": "https://db.tt/ZITNuhtI" + }, + "root_info": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "user" + }, + "home_namespace_id": { + "type": "string", + "example": "3235641" + }, + "root_namespace_id": { + "type": "string", + "example": "3235641" + } + } + }, + "team": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" + }, + "name": { + "type": "string", + "example": "Acme, Inc." + }, + "office_addin_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "disabled" + } + } + }, + "sharing_policies": { + "type": "object", + "properties": { + "shared_folder_join_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "from_anyone" + } + } + }, + "shared_folder_member_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team" + } + } + }, + "shared_link_create_policy": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "team_only" + } + } + } + } + } + } + }, + "team_member_id": { + "type": "string", + "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + } + } + }, + "examples": { + "get_current_account response": { + "value": { + "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", + "account_type": { + ".tag": "business" + }, + "country": "US", + "disabled": false, + "email": "franz@dropbox.com", + "email_verified": true, + "is_paired": true, + "locale": "en", + "name": { + "abbreviated_name": "FF", + "display_name": "Franz Ferdinand (Personal)", + "familiar_name": "Franz", + "given_name": "Franz", + "surname": "Ferdinand" + }, + "referral_link": "https://db.tt/ZITNuhtI", + "root_info": { + ".tag": "user", + "home_namespace_id": "3235641", + "root_namespace_id": "3235641" + }, + "team": { + "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", + "name": "Acme, Inc.", + "office_addin_policy": { + ".tag": "disabled" + }, + "sharing_policies": { + "shared_folder_join_policy": { + ".tag": "from_anyone" + }, + "shared_folder_member_policy": { + ".tag": "team" + }, + "shared_link_create_policy": { + ".tag": "team_only" + } + } + }, + "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + } + } + } + } + } + } + } + } + }, + "/2/users/get_space_usage": { + "post": { + "tags": [ + "users" + ], + "summary": "get_space_usage", + "description": "[get_space_usage](https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage)\n\nscope: `account_info.read`\n\nGet the space usage information for the current user's account.", + "operationId": "getSpaceUsage", + "parameters": [ + { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + ], + "responses": { + "200": { + "description": "get_space_usage response", + "headers": { + "X-Dropbox-Request-Id": { + "schema": { + "type": "string", + "example": "1234" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allocation": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "individual" + }, + "allocated": { + "type": "number", + "example": 10000000000 + } + } + }, + "used": { + "type": "number", + "example": 314159265 + } + } + }, + "examples": { + "get_space_usage response": { + "value": { + "allocation": { + ".tag": "individual", + "allocated": 10000000000 + }, + "used": 314159265 + } + } + } + } + } + } + } + } + } + }, + "components": { + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer" + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ], + "tags": [ + { + "name": "account" + }, + { + "name": "auth" + }, + { + "name": "check" + }, + { + "name": "contacts" + }, + { + "name": "file_properties", + "description": "This namespace contains helpers for property and template metadata endpoints.\n\nThese endpoints enable you to tag arbitrary key/value data to Dropbox files.\n\nThe most basic unit in this namespace is the :type:`PropertyField`. These fields encapsulate the actual key/value data.\n\nFields are added to a Dropbox file using a :type:`PropertyGroup`. Property groups contain a reference to a Dropbox file and a :type:`PropertyGroupTemplate`. Property groups are uniquely identified by the combination of their associated Dropbox file and template.\n\nThe :type:`PropertyGroupTemplate` is a way of restricting the possible key names and value types of the data within a property group. The possible key names and value types are explicitly enumerated using :type:`PropertyFieldTemplate` objects.\n\nYou can think of a property group template as a class definition for a particular key/value metadata object, and the property groups themselves as the instantiations of these objects.\n\nTemplates are owned either by a user/app pair or team/app pair. Templates and their associated properties can't be accessed by any app other than the app that created them, and even then, only when the app is linked with the owner of the template (either a user or team).\n\nUser-owned templates are accessed via the user-auth file_properties/templates/*_for_user endpoints, while team-owned templates are accessed via the team-auth file_properties/templates/*_for_team endpoints. Properties associated with either type of template can be accessed via the user-auth properties/* endpoints.\n\nFinally, properties can be accessed from a number of endpoints that return metadata, including `files/get_metadata`, and `files/list_folder`. Properties can also be added during upload, using `files/upload`.\n" + }, + { + "name": "file_requests", + "description": "This namespace contains endpoints and data types for file request operations.\n" + }, + { + "name": "files", + "description": "This namespace contains endpoints and data types for basic file operations.\n" + }, + { + "name": "sharing", + "description": "This namespace contains endpoints and data types for creating and managing shared links and shared folders.\n" + }, + { + "name": "team" + }, + { + "name": "devices" + }, + { + "name": "groups" + }, + { + "name": "legal_holds" + }, + { + "name": "linked_apps" + }, + { + "name": "member_space_limits" + }, + { + "name": "members" + }, + { + "name": "namespaces" + }, + { + "name": "reports" + }, + { + "name": "team_folder" + }, + { + "name": "team_log" + }, + { + "name": "users", + "description": "This namespace contains endpoints and data types for user management.\n" + } + ] +} diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml deleted file mode 100644 index 18b2eb4..0000000 --- a/docs/spec/openapi.yaml +++ /dev/null @@ -1,13244 +0,0 @@ -openapi: 3.0.0 -info: - title: Dropbox API Reference - description: >+ - The powerful, yet simple, Dropbox API allows you to manage and control - content and team settings programmatically and extend Dropbox capabilities - in new and powerful ways. This is a collection that includes requests to all - endpoints in the Dropbox API. - - - The Dropbox API is divided in two groups of endpoints: User Endpoints and - Business Endpoints. Operations that would most likely be executed by a user, - such as file operations, are in the User Endpoints folder. Operations that - would most likely be executed by a team administrator, such as adding users - to groups, live in the Business Endpoints folder. - - - If you are new to Dropbox Business and Team Administration, please have a - look at the [Dropobox Admin - Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). - - - If you want more information on how to use our API please refer to our - [Developer Portal](https://www.dropbox.com/developers). - - - # What's in the collection? - - - The endpoints are organized in the following folders: - - * account - - * auth - - * check - - * contacts - - * file_properties - - * file_requests - - * files - - * sharing - - * team - - * team_log - - * users - - - # Authorization - - - ## OAuth 2.0 for API Access - - Dropbox uses OAuth 2.0, an open specification, to authorize access to data. - To get an OAuth token from Dropbox to enable Postman to access your Dropbox - account via the API you’ll need to create a new app on the DBX Platform. - - - ## Creating an App on the DBX Platform - - Navigate to https://www.dropbox.com/developers/apps and select “Create app” - - 1. Choose an API - - 2. Choose the type of access you need - - 3. Give your app a name - - 4. Choose the Dropbox account that will own your app - - - For reference, please use the [Dropbox OAuth - guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) - - - ## Generating an Access Token - - Once you select “Create app” a page will load that displays information - about your newly created app. To generate an access token scroll down to - “OAuth 2” and click “Generate” beneath “Generated access token.” The token - will display as a long string of characters. Copy this token for use with - the Postman Collection. - - - ## Adding an Access Token to the requests - - In the Postman client, click on the three dots to the right of the - collection name to "View more actions." - - - ![Screenshot of adding access - token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1) - - - Then, click "Edit." - - - Click on the "Variables" tab and, in the row for the `access_token` - variable, paste your access token in the `CURRENT VALUE` column. The default - value is `your-access-token-here`. - - - ![Screenshot of adding access - token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1) - - - For information on sessions and variables in Postman see the blog post at - https://blog.postman.com/sessions-faq/. - - - # Notes - - * Dropbox also has a Postman Collection in the API Network to help - administrators with team management workflows. It is called [Dropbox Team - Admin Workflows](). - - version: 1.0.0 -servers: - - url: https://api.dropboxapi.com - - url: https://content.dropboxapi.com - - url: https://notify.dropboxapi.com -components: - requestBodies: - EmptyRequestBody: - content: - application/json: - schema: - type: object - properties: {} - securitySchemes: - bearerAuth: - type: http - scheme: bearer -security: - - bearerAuth: [] -tags: - - name: account - - name: auth - - name: check - - name: contacts - - name: file_properties - description: > - This namespace contains helpers for property and template metadata - endpoints. - - - These endpoints enable you to tag arbitrary key/value data to Dropbox - files. - - - The most basic unit in this namespace is the :type:`PropertyField`. These - fields encapsulate the actual key/value data. - - - Fields are added to a Dropbox file using a :type:`PropertyGroup`. Property - groups contain a reference to a Dropbox file and a - :type:`PropertyGroupTemplate`. Property groups are uniquely identified by - the combination of their associated Dropbox file and template. - - - The :type:`PropertyGroupTemplate` is a way of restricting the possible key - names and value types of the data within a property group. The possible - key names and value types are explicitly enumerated using - :type:`PropertyFieldTemplate` objects. - - - You can think of a property group template as a class definition for a - particular key/value metadata object, and the property groups themselves - as the instantiations of these objects. - - - Templates are owned either by a user/app pair or team/app pair. Templates - and their associated properties can't be accessed by any app other than - the app that created them, and even then, only when the app is linked with - the owner of the template (either a user or team). - - - User-owned templates are accessed via the user-auth - file_properties/templates/*_for_user endpoints, while team-owned templates - are accessed via the team-auth file_properties/templates/*_for_team - endpoints. Properties associated with either type of template can be - accessed via the user-auth properties/* endpoints. - - - Finally, properties can be accessed from a number of endpoints that return - metadata, including `files/get_metadata`, and `files/list_folder`. - Properties can also be added during upload, using `files/upload`. - - name: file_requests - description: > - This namespace contains endpoints and data types for file request - operations. - - name: files - description: > - This namespace contains endpoints and data types for basic file - operations. - - name: sharing - description: > - This namespace contains endpoints and data types for creating and managing - shared links and shared folders. - - name: team - - name: team > devices - - name: team > groups - - name: team > legal_holds - - name: team > linked_apps - - name: team > member_space_limits - - name: team > members - - name: team > namespaces - - name: team > reports - - name: team > team_folder - - name: team_log - - name: users - description: | - This namespace contains endpoints and data types for user management. -paths: - /2/account/set_profile_photo: - post: - tags: - - account - summary: set_profile_photo - description: >- - [set_profile_photo](https://www.dropbox.com/developers/documentation/http/documentation#account-set_profile_photo) - - - scope: `account_info.write` - - - Sets a user's profile photo. - requestBody: - content: - application/json: - schema: - type: object - example: - photo: - .tag: base64_data - base64_data: >- - SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - /2/auth/token/from_oauth1: - post: - tags: - - auth - summary: token/from_oauth1 - description: >- - [token/from_oauth1](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-from_oauth1) - - - scope: `None` - - - Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access - token. - requestBody: - content: - application/json: - schema: - type: object - example: - oauth1_token: qievr8hamyg6ndck - oauth1_token_secret: qomoftv0472git7 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - oauth2_token: >- - 9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn - /2/auth/token/revoke: - post: - tags: - - auth - summary: token/revoke - description: >- - [token/revoke](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke) - - - scope: `None` - - - Disables the access token used to authenticate the call. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/check/app: - post: - tags: - - check - summary: app - description: >- - [app](https://www.dropbox.com/developers/documentation/http/documentation#check-app) - - - scope: `None` - - - This endpoint performs App Authentication, validating the supplied app - key and secret, and returns the supplied string, to allow you to test - your code and connection to the Dropbox API. It has no other effect. If - you receive an HTTP 200 response with the supplied query, it indicates - at least part of the Dropbox API infrastructure is working and that the - app key and secret valid. - requestBody: - content: - application/json: - schema: - type: object - example: - query: foo - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - result: foo - /2/check/user: - post: - tags: - - check - summary: user - description: >- - [user](https://www.dropbox.com/developers/documentation/http/documentation#check-user) - - - scope: `None` - - - This endpoint performs User Authentication, validating the supplied - access token, and returns the supplied string, to allow you to test your - code and connection to the Dropbox API. It has no other effect. If you - receive an HTTP 200 response with the supplied query, it indicates at - least part of the Dropbox API infrastructure is working and that the - access token is valid. - requestBody: - content: - application/json: - schema: - type: object - example: - query: foo - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - result: foo - /2/contacts/delete_manual_contacts: - post: - tags: - - contacts - summary: delete_manual_contacts - description: >- - [delete_manual_contacts](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts) - - - scope: `contacts.write` - - - Removes all manually added contacts. You'll still keep contacts who are - on your team or who you imported. New contacts will be added when you - share. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/contacts/delete_manual_contacts_batch: - post: - tags: - - contacts - summary: delete_manual_contacts_batch - description: >- - [delete_manual_contacts_batch](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts_batch) - - - scope: `contacts.write` - - - Removes manually added contacts from the given list. - requestBody: - content: - application/json: - schema: - type: object - example: - email_addresses: - - contactemailaddress1@domain.com - - contactemailaddress2@domain.com - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/file_properties/properties/add: - post: - tags: - - file_properties - summary: properties/add - description: >- - [properties/add](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add) - - - scope: `files.metadata.write` - - - Add property groups to a Dropbox file. See `templates/add_for_user` or - `templates/add_for_team` to create new templates. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /my_awesome/word.docx - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/file_properties/properties/overwrite: - post: - tags: - - file_properties - summary: properties/overwrite - description: >- - [properties/overwrite](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite) - - - scope: `files.metadata.write` - - - Overwrite property groups associated with a file. This endpoint should - be used instead of `properties/update` when property groups are being - updated via a "snapshot" instead of via a "delta". In other words, this - endpoint will delete all omitted fields from a property group, whereas - `properties/update` will only delete fields that are explicitly marked - for deletion. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /my_awesome/word.docx - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/file_properties/properties/remove: - post: - tags: - - file_properties - summary: properties/remove - description: >- - [properties/remove](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove) - - - scope: `files.metadata.write` - - - Permanently removes the specified property group from the file. To - remove specific property field key value pairs, see `properties/update`. - To update a template, see `templates/update_for_user` or - `templates/update_for_team`. To remove a template, see - `templates/remove_for_user` or `templates/remove_for_team`. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /my_awesome/word.docx - property_template_ids: - - ptid:1a5n2i6d3OYEAAAAAAAAAYa - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/file_properties/properties/search: - post: - tags: - - file_properties - summary: properties/search - description: >- - [properties/search](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search) - - - scope: `files.metadata.read` - - - Search across property templates for particular property field values. - requestBody: - content: - application/json: - schema: - type: object - example: - queries: - - query: Compliance Bot - Beta - mode: - .tag: field_name - field_name: Security - logical_operator: or_operator - template_filter: filter_none - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Authorization - in: header - schema: - type: string - example: ' Bearer IU571Pc9cGAAAAAAAAAAAQh57r-VTd7qBjZBUsVHLR6NRVTcd0FOThotVQmF9q9F' - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - matches: - - id: id:a4ayc_80_OEAAAAAAAAAXz - path: /my_awesome/word.docx - is_deleted: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - /2/file_properties/properties/search/continue: - post: - tags: - - file_properties - summary: properties/search/continue - description: >- - [properties/search/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue) - - - scope: `files.metadata.read` - - - Once a cursor has been retrieved from `properties/search`, use this to - paginate through all search results. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - matches: - - id: id:a4ayc_80_OEAAAAAAAAAXz - path: /my_awesome/word.docx - is_deleted: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - /2/file_properties/properties/update: - post: - tags: - - file_properties - summary: properties/update - description: >- - [properties/update](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update) - - - scope: `files.metadata.write` - - - Add, update or remove properties associated with the supplied file and - templates. This endpoint should be used instead of - `properties/overwrite` when property groups are being updated via a - "delta" instead of via a "snapshot" . In other words, this endpoint will - not delete any omitted fields from a property group, whereas - `properties/overwrite` will delete any fields that are omitted from a - property group. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /my_awesome/word.docx - update_property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - add_or_update_fields: - - name: Security Policy - value: Confidential - remove_fields: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/file_properties/templates/add_for_team: - post: - tags: - - file_properties - summary: templates/add_for_team - description: >- - [templates/add_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-add_for_team) - - - scope: `files.team_metadata.write` - - - Add a template associated with a team. See `properties/add` to add - properties to a file or folder. - - Note: this endpoint will create team-owned templates. - requestBody: - content: - application/json: - schema: - type: object - example: - name: Security - description: >- - These properties describe how confidential this file or folder - is. - fields: - - name: Security Policy - description: >- - This is the security policy of the file or folder - described. - - Policies can be Confidential, Public or Internal. - type: string - security: - - bearerAuth: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - /2/file_properties/templates/add_for_user: - post: - tags: - - file_properties - summary: templates/add_for_user - description: >- - [templates/add_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user) - - - scope: `files.metadata.write` - - - Add a template associated with a user. See `properties/add` to add - properties to a file. This endpoint can't be called on a team member or - admin's behalf. - requestBody: - content: - application/json: - schema: - type: object - example: - name: Security - description: >- - These properties describe how confidential this file or folder - is. - fields: - - name: Security Policy - description: >- - This is the security policy of the file or folder - described. - - Policies can be Confidential, Public or Internal. - type: string - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - /2/file_properties/templates/get_for_team: - post: - tags: - - file_properties - summary: templates/get_for_team - description: >- - [templates/get_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-get_for_team) - - - scope: `files.team_metadata.write` - - - Get the schema for a specified template. - requestBody: - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - security: - - bearerAuth: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Security - description: >- - These properties describe how confidential this file or folder - is. - fields: - - name: Security Policy - description: >- - This is the security policy of the file or folder - described. - - Policies can be Confidential, Public or Internal. - type: - .tag: string - /2/file_properties/templates/get_for_user: - post: - tags: - - file_properties - summary: templates/get_for_user - description: >- - [templates/get_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user) - - - scope: `files.metadata.read` - - - Get the schema for a specified template. This endpoint can't be called - on a team member or admin's behalf. - requestBody: - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Security - description: >- - These properties describe how confidential this file or folder - is. - fields: - - name: Security Policy - description: >- - This is the security policy of the file or folder - described. - - Policies can be Confidential, Public or Internal. - type: - .tag: string - /2/file_properties/templates/list_for_team: - post: - tags: - - file_properties - summary: templates/list_for_team - description: >- - [templates/list_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-list_for_team) - - - scope: `files.team_metadata.write` - - - Get the template identifiers for a team. To get the schema of each - template use `templates/get_for_team`. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - security: - - bearerAuth: [] - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - template_ids: - - ptid:1a5n2i6d3OYEAAAAAAAAAYa - /2/file_properties/templates/list_for_user: - post: - tags: - - file_properties - summary: templates/list_for_user - description: >- - [templates/list_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user) - - - scope: `files.metadata.read` - - - Get the template identifiers for a team. To get the schema of each - template use `templates/get_for_user`. This endpoint can't be called on - a team member or admin's behalf. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - template_ids: - - ptid:1a5n2i6d3OYEAAAAAAAAAYa - /2/file_properties/templates/remove_for_team: - post: - tags: - - file_properties - summary: templates/remove_for_team - description: >- - [templates/remove_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-remove_for_team) - - - scope: `files.team_metadata.write` - - - Permanently removes the specified template created from - `templates/add_for_user`. All properties associated with the template - will also be removed. This action cannot be undone. - requestBody: - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - security: - - bearerAuth: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/file_properties/templates/remove_for_user: - post: - tags: - - file_properties - summary: templates/remove_for_user - description: >- - [templates/remove_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user) - - - scope: `files.metadata.write` - - - Permanently removes the specified template created from - `templates/add_for_user`. All properties associated with the template - will also be removed. This action cannot be undone. - requestBody: - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/file_properties/templates/update_for_team: - post: - tags: - - file_properties - summary: templates/update_for_team - description: >- - [templates/update_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-update_for_team) - - - scope: `files.team_metadata.write` - - - Update a template associated with a team. This route can update the - template name, the template description and add optional properties to - templates. - requestBody: - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - name: New Security Template Name - description: >- - These properties will describe how confidential this file or - folder is. - add_fields: - - name: Security Policy - description: >- - This is the security policy of the file or folder - described. - - Policies can be Confidential, Public or Internal. - type: string - security: - - bearerAuth: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - /2/file_properties/templates/update_for_user: - post: - tags: - - file_properties - summary: templates/update_for_user - description: >- - [templates/update_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user) - - - scope: `files.metadata.write` - - - Update a template associated with a user. This route can update the - template name, the template description and add optional properties to - templates. This endpoint can't be called on a team member or admin's - behalf. - requestBody: - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - name: New Security Template Name - description: >- - These properties will describe how confidential this file or - folder is. - add_fields: - - name: Security Policy - description: >- - This is the security policy of the file or folder - described. - - Policies can be Confidential, Public or Internal. - type: string - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - /2/file_requests/count: - post: - tags: - - file_requests - summary: count - description: >- - [count](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-count) - - - scope: `file_requests.read` - - - Returns the total number of file requests owned by this user. Includes - both open and closed file requests. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - file_request_count: 15 - /2/file_requests/create: - post: - tags: - - file_requests - summary: create - description: >- - [create](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create) - - - scope: `file_requests.write` - - - Creates a file request for this user. - requestBody: - content: - application/json: - schema: - type: object - example: - title: Homework submission - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: seven_days - open: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - id: oaCAVmEyrqYnkZX9955Y - url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - title: Homework submission - created: '2015-10-05T17:00:00Z' - is_open: true - file_count: 3 - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: - .tag: seven_days - /2/file_requests/delete: - post: - tags: - - file_requests - summary: delete - description: >- - [delete](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete) - - - scope: `file_requests.write` - - - Delete a batch of closed file requests. - requestBody: - content: - application/json: - schema: - type: object - example: - ids: - - oaCAVmEyrqYnkZX9955Y - - BaZmehYoXMPtaRmfTbSG - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - file_requests: - - id: oaCAVmEyrqYnkZX9955Y - url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - title: Homework submission - created: '2015-10-05T17:00:00Z' - is_open: true - file_count: 3 - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: - .tag: seven_days - - id: BAJ7IrRGicQKGToykQdB - url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB - title: Photo contest submission - created: '2015-11-02T04:00:00Z' - is_open: true - file_count: 105 - destination: /Photo contest entries - deadline: - deadline: '2020-10-12T17:00:00Z' - - id: rxwMPvK3ATTa0VxOJu5T - url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T - title: Wedding photo submission - created: '2015-12-15T13:02:00Z' - is_open: true - file_count: 37 - destination: /Wedding photos - /2/file_requests/delete_all_closed: - post: - tags: - - file_requests - summary: delete_all_closed - description: >- - [delete_all_closed](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete_all_closed) - - - scope: `file_requests.write` - - - Delete all closed file requests owned by this user. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - file_requests: - - id: oaCAVmEyrqYnkZX9955Y - url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - title: Homework submission - created: '2015-10-05T17:00:00Z' - is_open: true - file_count: 3 - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: - .tag: seven_days - - id: BAJ7IrRGicQKGToykQdB - url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB - title: Photo contest submission - created: '2015-11-02T04:00:00Z' - is_open: true - file_count: 105 - destination: /Photo contest entries - deadline: - deadline: '2020-10-12T17:00:00Z' - - id: rxwMPvK3ATTa0VxOJu5T - url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T - title: Wedding photo submission - created: '2015-12-15T13:02:00Z' - is_open: true - file_count: 37 - destination: /Wedding photos - /2/file_requests/get: - post: - tags: - - file_requests - summary: get - description: >- - [get](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get) - - - scope: `file_requests.read` - - - Returns the specified file request. - requestBody: - content: - application/json: - schema: - type: object - example: - id: oaCAVmEyrqYnkZX9955Y - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - id: oaCAVmEyrqYnkZX9955Y - url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - title: Homework submission - created: '2015-10-05T17:00:00Z' - is_open: true - file_count: 3 - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: - .tag: seven_days - /2/file_requests/list_v2: - post: - tags: - - file_requests - summary: list - description: >- - [list](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list) - - - scope: `file_requests.read` - - - Returns a list of file requests owned by this user. For apps with the - app folder permission, this will only return file requests with - destinations in the app folder. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 1000 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - file_requests: - - id: oaCAVmEyrqYnkZX9955Y - url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - title: Homework submission - created: '2015-10-05T17:00:00Z' - is_open: true - file_count: 3 - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: - .tag: seven_days - - id: BAJ7IrRGicQKGToykQdB - url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB - title: Photo contest submission - created: '2015-11-02T04:00:00Z' - is_open: true - file_count: 105 - destination: /Photo contest entries - deadline: - deadline: '2020-10-12T17:00:00Z' - - id: rxwMPvK3ATTa0VxOJu5T - url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T - title: Wedding photo submission - created: '2015-12-15T13:02:00Z' - is_open: true - file_count: 37 - destination: /Wedding photos - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: true - /2/file_requests/list/continue: - post: - tags: - - file_requests - summary: list/continue - description: >- - [list/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list-continue) - - - scope: `file_requests.read` - - - Once a cursor has been retrieved from `list:2`, use this to paginate - through all file requests. The cursor must come from a previous call to - `list:2` or `list/continue`. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - file_requests: - - id: oaCAVmEyrqYnkZX9955Y - url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - title: Homework submission - created: '2015-10-05T17:00:00Z' - is_open: true - file_count: 3 - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: - .tag: seven_days - - id: BAJ7IrRGicQKGToykQdB - url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB - title: Photo contest submission - created: '2015-11-02T04:00:00Z' - is_open: true - file_count: 105 - destination: /Photo contest entries - deadline: - deadline: '2020-10-12T17:00:00Z' - - id: rxwMPvK3ATTa0VxOJu5T - url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T - title: Wedding photo submission - created: '2015-12-15T13:02:00Z' - is_open: true - file_count: 37 - destination: /Wedding photos - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: true - /2/file_requests/update: - post: - tags: - - file_requests - summary: update - description: >- - [update](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-update) - - - scope: `file_requests.write` - - - Update a file request. - requestBody: - content: - application/json: - schema: - type: object - example: - id: oaCAVmEyrqYnkZX9955Y - title: Homework submission - destination: /File Requests/Homework - deadline: - .tag: update - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: seven_days - open: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - id: oaCAVmEyrqYnkZX9955Y - url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - title: Homework submission - created: '2015-10-05T17:00:00Z' - is_open: true - file_count: 3 - destination: /File Requests/Homework - deadline: - deadline: '2020-10-12T17:00:00Z' - allow_late_uploads: - .tag: seven_days - /2/files/copy_v2: - post: - tags: - - files - summary: copy - description: >- - [copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy) - - - scope: `files.content.write` - - - Copy a file or folder to a different location in the user's Dropbox. - - If the source path is a folder all its contents will be copied. - requestBody: - content: - application/json: - schema: - type: object - example: - from_path: /Homework/math - to_path: /Homework/algebra - allow_shared_folder: false - autorename: false - allow_ownership_transfer: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/copy_batch_v2: - post: - tags: - - files - summary: copy_batch - description: >- - [copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch) - - - scope: `files.content.write` - - - Copy multiple files or folders to different locations at once in the - user's Dropbox. - - This route will replace `copy_batch:1`. The main difference is this - route will return status for each entry, while `copy_batch:1` raises - failure if any entry fails. - - This route will either finish synchronously, or return a job ID and do - the async copy job in background. Please use `copy_batch/check:2` to - check the job status. - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - from_path: /Homework/math - to_path: /Homework/algebra - autorename: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - success: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/copy_batch/check_v2: - post: - tags: - - files - summary: copy_batch/check - description: >- - [copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check) - - - scope: `files.content.write` - - - Returns the status of an asynchronous job for `copy_batch:2`. It returns - list of results for each entry. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - success: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/copy_reference/get: - post: - tags: - - files - summary: copy_reference/get - description: >- - [copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get) - - - scope: `files.content.write` - - - Get a copy reference to a file or folder. This reference string can be - used to save that file or folder to another user's Dropbox by passing it - to `copy_reference/save`. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /video.mp4 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - copy_reference: z1X6ATl6aWtzOGq0c3g5Ng - expires: '2045-05-12T15:50:38Z' - /2/files/copy_reference/save: - post: - tags: - - files - summary: copy_reference/save - description: >- - [copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save) - - - scope: `files.content.write` - - - Save a copy reference returned by `copy_reference/get` to the user's - Dropbox. - requestBody: - content: - application/json: - schema: - type: object - example: - copy_reference: z1X6ATl6aWtzOGq0c3g5Ng - path: /video.mp4 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/create_folder_v2: - post: - tags: - - files - summary: create_folder - description: >- - [create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder) - - - scope: `files.content.write` - - - Create a folder at a given path. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /Homework/math - autorename: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - name: math - id: id:a4ayc_80_OEAAAAAAAAAXz - path_lower: /homework/math - path_display: /Homework/math - sharing_info: - read_only: false - parent_shared_folder_id: '84528192421' - traverse_only: false - no_access: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - /2/files/create_folder_batch: - post: - tags: - - files - summary: create_folder_batch - description: >- - [create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch) - - - scope: `files.content.write` - - - Create multiple folders at once. - - This route is asynchronous for large batches, which returns a job ID - immediately and runs the create folder batch asynchronously. Otherwise, - creates the folders and returns the result synchronously for smaller - inputs. You can force asynchronous behaviour by using the - `CreateFolderBatchArg.force_async` flag. Use - `create_folder_batch/check` to check the job status. - requestBody: - content: - application/json: - schema: - type: object - example: - paths: - - /Homework/math - autorename: false - force_async: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - metadata: - name: math - id: id:a4ayc_80_OEAAAAAAAAAXz - path_lower: /homework/math - path_display: /Homework/math - sharing_info: - read_only: false - parent_shared_folder_id: '84528192421' - traverse_only: false - no_access: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - /2/files/create_folder_batch/check: - post: - tags: - - files - summary: create_folder_batch/check - description: >- - [create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check) - - - scope: `files.content.write` - - - Returns the status of an asynchronous job for `create_folder_batch`. If - success, it returns list of result for each entry. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - metadata: - name: math - id: id:a4ayc_80_OEAAAAAAAAAXz - path_lower: /homework/math - path_display: /Homework/math - sharing_info: - read_only: false - parent_shared_folder_id: '84528192421' - traverse_only: false - no_access: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - /2/files/delete_v2: - post: - tags: - - files - summary: delete - description: >- - [delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete) - - - scope: `files.content.write` - - - Delete the file or folder at a given path. - - If the path is a folder, all its contents will be deleted too. - - A successful response indicates that the file or folder was deleted. The - returned metadata will be the corresponding `FileMetadata` or - `FolderMetadata` for the item at time of deletion, and not a - `DeletedMetadata` object. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /Homework/math/Prime_Numbers.txt - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/delete_batch: - post: - tags: - - files - summary: delete_batch - description: >- - [delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch) - - - scope: `files.content.write` - - - Delete multiple files/folders at once. - - This route is asynchronous, which returns a job ID immediately and runs - the delete batch asynchronously. Use `delete_batch/check` to check the - job status. - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - path: /Homework/math/Prime_Numbers.txt - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/delete_batch/check: - post: - tags: - - files - summary: delete_batch/check - description: >- - [delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check) - - - scope: `files.content.write` - - - Returns the status of an asynchronous job for `delete_batch`. If - success, it returns list of result for each entry. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/download: - post: - tags: - - files - summary: download - description: >- - [download](https://www.dropbox.com/developers/documentation/http/documentation#files-download) - - - scope: `files.content.read` - - - Download a file from a user's Dropbox. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "path": "/Homework/math/Prime_Numbers.txt" - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/download_zip: - post: - tags: - - files - summary: download_zip - description: >- - [download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip) - - - scope: `files.content.read` - - - Download a folder from the user's Dropbox, as a zip file. The folder - must be less than 20 GB in size and have fewer than 10,000 total files. - The input cannot be a single file. Any single file must be less than 4GB - in size. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "path": "/Homework/math" - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - name: math - id: id:a4ayc_80_OEAAAAAAAAAXz - path_lower: /homework/math - path_display: /Homework/math - sharing_info: - read_only: false - parent_shared_folder_id: '84528192421' - traverse_only: false - no_access: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - /2/files/export: - post: - tags: - - files - summary: export - description: >- - [export](https://www.dropbox.com/developers/documentation/http/documentation#files-export) - - - scope: `files.content.read` - - - Export a file from a user's Dropbox. This route only supports exporting - files that cannot be downloaded directly and whose - `ExportResult.file_metadata` has `ExportInfo.export_as` populated. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "path": "/Homework/math/Prime_Numbers.gsheet" - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - export_metadata: - name: Prime_Numbers.xlsx - size: 7189 - export_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_metadata: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/get_file_lock_batch: - post: - tags: - - files - summary: get_file_lock_batch - description: >- - [get_file_lock_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_file_lock_batch) - - - scope: `files.content.read` - - - Return the lock metadata for the given list of paths. - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - path: /John Doe/sample/test.pdf - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - .tag: success - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - lock: - content: - .tag: single_user - created: '2015-05-12T15:50:38Z' - lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - lock_holder_team_id: dbtid:1234abcd - /2/files/get_metadata: - post: - tags: - - files - summary: get_metadata - description: >- - [get_metadata](https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata) - - - scope: `files.metadata.read` - - - Returns the metadata for a file or folder. - - Note: Metadata for the root folder is unsupported. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /Homework/math - include_media_info: false - include_deleted: false - include_has_explicit_shared_members: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/get_preview: - post: - tags: - - files - summary: get_preview - description: >- - [get_preview](https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview) - - - scope: `files.content.read` - - - Get a preview for a file. - - Currently, PDF previews are generated for files with the following - extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, - .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. - - HTML previews are generated for files with the following extensions: - .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. - - Other formats will return an unsupported extension error. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "path": "/word.docx" - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/get_temporary_link: - post: - tags: - - files - summary: get_temporary_link - description: >- - [get_temporary_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link) - - - scope: `files.content.read` - - - Get a temporary link to stream content of a file. This link will expire - in four hours and afterwards you will get 410 Gone. This URL should not - be used to display content directly in the browser. The Content-Type of - the link is determined automatically by the file's mime type. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /video.mp4 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - link: >- - https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 - /2/files/get_temporary_upload_link: - post: - tags: - - files - summary: get_temporary_upload_link - description: >- - [get_temporary_upload_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_upload_link) - - - scope: `files.content.write` - - - Get a one-time use temporary upload link to upload a file to a Dropbox - location. - - - This endpoint acts as a delayed `upload`. The returned temporary upload - link may be used to make a POST request with the data to be uploaded. - The upload will then be perfomed with the `CommitInfo` previously - provided to `get_temporary_upload_link` but evaluated only upon - consumption. Hence, errors stemming from invalid `CommitInfo` with - respect to the state of the user's Dropbox will only be communicated at - consumption time. Additionally, these errors are surfaced as generic - HTTP 409 Conflict responses, potentially hiding issue details. The - maximum temporary upload link duration is 4 hours. Upon consumption or - expiration, a new link will have to be generated. Multiple links may - exist for a specific upload path at any given time. - - - The POST request on the temporary upload link must have its Content-Type - set to "application/octet-stream". - - - Example temporary upload link consumption request: - - - curl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND - - --header "Content-Type: application/octet-stream" - - --data-binary @local_file.txt - - - A successful temporary upload link consumption request returns the - content hash of the uploaded data in JSON format. - - - Example succesful temporary upload link consumption response: - - {"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"} - - - An unsuccessful temporary upload link consumption request returns any of - the following status codes: - - - HTTP 400 Bad Request: Content-Type is not one of - application/octet-stream and text/plain or request is invalid. - - HTTP 409 Conflict: The temporary upload link does not exist or is - currently unavailable, the upload failed, or another error happened. - - HTTP 410 Gone: The temporary upload link is expired or consumed. - - - Example unsuccessful temporary upload link consumption response: - - Temporary upload link has been recently consumed. - requestBody: - content: - application/json: - schema: - type: object - example: - commit_info: - path: /Homework/math/Matrices.txt - mode: add - autorename: true - mute: false - strict_conflict: false - duration: 3600 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - link: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND - /2/files/get_thumbnail_v2: - post: - tags: - - files - summary: get_thumbnail - description: >- - [get_thumbnail](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail) - - - scope: `files.content.read` - - - Get a thumbnail for a file. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "resource": { - ".tag": "path", - "path": "/a.docx" - }, - "format": "jpeg", - "size": "w64h64", - "mode": "strict" - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - file_metadata: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/get_thumbnail_batch: - post: - tags: - - files - summary: get_thumbnail_batch - description: >- - [get_thumbnail_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch) - - - scope: `files.content.read` - - - Get thumbnails for a list of images. We allow up to 25 thumbnails in a - single batch. - - This method currently supports files with the following file extensions: - jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB - in size won't be converted to a thumbnail. - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - path: /image.jpg - format: jpeg - size: w64h64 - mode: strict - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - .tag: success - metadata: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= - /2/files/list_folder: - post: - tags: - - files - summary: list_folder - description: >- - [list_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder) - - - scope: `files.metadata.read` - - - Starts returning the contents of a folder. If the result's - `ListFolderResult.has_more` field is `true`, call `list_folder/continue` - with the returned `ListFolderResult.cursor` to retrieve more entries. - - If you're using `ListFolderArg.recursive` set to `true` to keep a local - cache of the contents of a Dropbox account, iterate through each entry - in order and process them as follows to keep your local state in sync: - - For each `FileMetadata`, store the new entry at the given path in your - local state. If the required parent folders don't exist yet, create - them. If there's already something else at the given path, replace it - and remove all its children. - - For each `FolderMetadata`, store the new entry at the given path in your - local state. If the required parent folders don't exist yet, create - them. If there's already something else at the given path, replace it - but leave the children as they are. Check the new entry's - `FolderSharingInfo.read_only` and set all its children's read-only - statuses to match. - - For each `DeletedMetadata`, if your local state has something at the - given path, remove it and all its children. If there's nothing at the - given path, ignore this entry. - - Note: `auth.RateLimitError` may be returned if multiple `list_folder` or - `list_folder/continue` calls with same parameters are made - simultaneously by same API app for same user. If your app implements - retry logic, please hold off the retry until the previous request - finishes. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /Homework/math - recursive: false - include_media_info: false - include_deleted: false - include_has_explicit_shared_members: false - include_mounted_folders: true - include_non_downloadable_files: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - - .tag: folder - name: math - id: id:a4ayc_80_OEAAAAAAAAAXz - path_lower: /homework/math - path_display: /Homework/math - sharing_info: - read_only: false - parent_shared_folder_id: '84528192421' - traverse_only: false - no_access: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/files/list_folder/continue: - post: - tags: - - files - summary: list_folder/continue - description: >- - [list_folder/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue) - - - scope: `files.metadata.read` - - - Once a cursor has been retrieved from `list_folder`, use this to - paginate through all files and retrieve updates to the folder, following - the same rules as documented for `list_folder`. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - - .tag: folder - name: math - id: id:a4ayc_80_OEAAAAAAAAAXz - path_lower: /homework/math - path_display: /Homework/math - sharing_info: - read_only: false - parent_shared_folder_id: '84528192421' - traverse_only: false - no_access: false - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/files/list_folder/get_latest_cursor: - post: - tags: - - files - summary: list_folder/get_latest_cursor - description: >- - [list_folder/get_latest_cursor](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-get_latest_cursor) - - - scope: `files.metadata.read` - - - A way to quickly get a cursor for the folder's state. Unlike - `list_folder`, `list_folder/get_latest_cursor` doesn't return any - entries. This endpoint is for app which only needs to know about new - files and modifications and doesn't need to know about files that - already exist in Dropbox. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /Homework/math - recursive: false - include_media_info: false - include_deleted: false - include_has_explicit_shared_members: false - include_mounted_folders: true - include_non_downloadable_files: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/files/list_folder/longpoll: - post: - tags: - - files - summary: list_folder/longpoll - description: >- - [list_folder/longpoll](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-longpoll) - - - scope: `files.metadata.read` - - - A longpoll endpoint to wait for changes on an account. In conjunction - with `list_folder/continue`, this call gives you a low-latency way to - monitor an account for file changes. The connection will block until - there are changes available or a timeout occurs. This endpoint is useful - mostly for client-side apps. If you're looking for server-side - notifications, check out our [webhooks - documentation](https://www.dropbox.com/developers/reference/webhooks). - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - timeout: 30 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - changes: true - /2/files/list_revisions: - post: - tags: - - files - summary: list_revisions - description: >- - [list_revisions](https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions) - - - scope: `files.metadata.read` - - - Returns revisions for files based on a file path or a file id. The file - path or file id is identified from the latest file entry at the given - file path or id. This end point allows your app to query either by file - path or file id by setting the mode parameter appropriately. - - In the `ListRevisionsMode.path` (default) mode, all revisions at the - same file path as the latest file entry are returned. If revisions with - the same file id are desired, then mode must be set to - `ListRevisionsMode.id`. The `ListRevisionsMode.id` mode is useful to - retrieve revisions for a given file across moves or renames. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /root/word.docx - mode: path - limit: 10 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - is_deleted: false - entries: - - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/lock_file_batch: - post: - tags: - - files - summary: lock_file_batch - description: >- - [lock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-lock_file_batch) - - - scope: `files.content.write` - - - Lock the files at the given paths. A locked file will be writable only - by the lock holder. A successful response indicates that the file has - been locked. Returns a list of the locked file paths and their metadata - after this operation. - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - path: /John Doe/sample/test.pdf - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - .tag: success - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - lock: - content: - .tag: single_user - created: '2015-05-12T15:50:38Z' - lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - lock_holder_team_id: dbtid:1234abcd - /2/files/move_v2: - post: - tags: - - files - summary: move - description: >- - [move](https://www.dropbox.com/developers/documentation/http/documentation#files-move) - - - scope: `files.content.write` - - - Move a file or folder to a different location in the user's Dropbox. - - If the source path is a folder all its contents will be moved. - - Note that we do not currently support case-only renaming. - requestBody: - content: - application/json: - schema: - type: object - example: - from_path: /Homework/math - to_path: /Homework/algebra - allow_shared_folder: false - autorename: false - allow_ownership_transfer: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/move_batch_v2: - post: - tags: - - files - summary: move_batch - description: >- - [move_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch) - - - scope: `files.content.write` - - - Move multiple files or folders to different locations at once in the - user's Dropbox. Note that we do not currently support case-only - renaming. - - This route will replace `move_batch:1`. The main difference is this - route will return status for each entry, while `move_batch:1` raises - failure if any entry fails. - - This route will either finish synchronously, or return a job ID and do - the async move job in background. Please use `move_batch/check:2` to - check the job status. - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - from_path: /Homework/math - to_path: /Homework/algebra - autorename: false - allow_ownership_transfer: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - success: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/move_batch/check_v2: - post: - tags: - - files - summary: move_batch/check - description: >- - [move_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch-check) - - - scope: `files.content.write` - - - Returns the status of an asynchronous job for `move_batch:2`. It returns - list of results for each entry. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - success: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/permanently_delete: - post: - tags: - - files - summary: permanently_delete - description: >- - [permanently_delete](https://www.dropbox.com/developers/documentation/http/documentation#files-permanently_delete) - - - scope: `files.permanent_delete` - - - Permanently delete the file or folder at a given path (see - https://www.dropbox.com/en/help/40). - - Note: This endpoint is only available for Dropbox Business apps. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /Homework/math/Prime_Numbers.txt - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/files/restore: - post: - tags: - - files - summary: restore - description: >- - [restore](https://www.dropbox.com/developers/documentation/http/documentation#files-restore) - - - scope: `files.content.write` - - - Restore a specific revision of a file to the given path. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /root/word.docx - rev: a1c10ce0dd78 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/save_url: - post: - tags: - - files - summary: save_url - description: >- - [save_url](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url) - - - scope: `files.content.write` - - - Save the data from a specified URL into a file in user's Dropbox. - - Note that the transfer from the URL must complete within 5 minutes, or - the operation will time out and the job will fail. - - If the given path already exists, the file will be renamed to avoid the - conflict (e.g. myfile (1).txt). - requestBody: - content: - application/json: - schema: - type: object - example: - path: /a.txt - url: http://example.com/a.txt - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/save_url/check_job_status: - post: - tags: - - files - summary: save_url/check_job_status - description: >- - [save_url/check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url-check_job_status) - - - scope: `files.content.write` - - - Check the status of a `save_url` job. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: in_progress - /2/files/search_v2: - post: - tags: - - files - summary: search - description: >- - [search](https://www.dropbox.com/developers/documentation/http/documentation#files-search) - - - scope: `files.metadata.read` - - - Searches for files and folders. - - Note: `search:2` along with `search/continue:2` can only be used to - retrieve a maximum of 10,000 matches. - - Recent changes may not immediately be reflected in search results due to - a short delay in indexing. Duplicate results may be returned across - pages. Some results may not be returned. - requestBody: - content: - application/json: - schema: - type: object - example: - query: cat - include_highlights: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - matches: - - metadata: - .tag: metadata - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - has_more: false - /2/files/search/continue_v2: - post: - tags: - - files - summary: search/continue - description: >- - [search/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-search-continue) - - - scope: `files.metadata.read` - - - Fetches the next page of search results returned from `search:2`. - - Note: `search:2` along with `search/continue:2` can only be used to - retrieve a maximum of 10,000 matches. - - Recent changes may not immediately be reflected in search results due to - a short delay in indexing. Duplicate results may be returned across - pages. Some results may not be returned. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - matches: - - metadata: - .tag: metadata - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - has_more: false - /2/files/unlock_file_batch: - post: - tags: - - files - summary: unlock_file_batch - description: >- - [unlock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-unlock_file_batch) - - - scope: `files.content.write` - - - Unlock the files at the given paths. A locked file can only be unlocked - by the lock holder or, if a business account, a team admin. A successful - response indicates that the file has been unlocked. Returns a list of - the unlocked file paths and their metadata after this operation. - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - path: /John Doe/sample/test.pdf - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - .tag: success - metadata: - .tag: file - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - lock: - content: - .tag: single_user - created: '2015-05-12T15:50:38Z' - lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - lock_holder_team_id: dbtid:1234abcd - /2/files/upload: - post: - tags: - - files - summary: upload - description: >- - [upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload) - - - scope: `files.content.write` - - - Create a new file with the contents provided in the request. - - Do not use this to upload a file larger than 150 MB. Instead, create an - upload session with `upload_session/start`. - - Calls to this endpoint will count as data transport calls for any - Dropbox Business teams with a limit on the number of data transport - calls allowed per month. For more information, see the [Data transport - limit - page](https://www.dropbox.com/developers/reference/data-transport-limit). - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/upload_session/append_v2: - post: - tags: - - files - summary: upload_session/append - description: >- - [upload_session/append](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append) - - - scope: `files.content.write` - - - Append more data to an upload session. - - When the parameter close is set, this call will close the session. - - A single request should not upload more than 150 MB. The maximum size of - a file one can upload to an upload session is 350 GB. - - Calls to this endpoint will count as data transport calls for any - Dropbox Business teams with a limit on the number of data transport - calls allowed per month. For more information, see the [Data transport - limit - page](https://www.dropbox.com/developers/reference/data-transport-limit). - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "close": false - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/files/upload_session/finish: - post: - tags: - - files - summary: upload_session/finish - description: >- - [upload_session/finish](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish) - - - scope: `files.content.write` - - - Finish an upload session and save the uploaded data to the given file - path. - - A single request should not upload more than 150 MB. The maximum size of - a file one can upload to an upload session is 350 GB. - - Calls to this endpoint will count as data transport calls for any - Dropbox Business teams with a limit on the number of data transport - calls allowed per month. For more information, see the [Data transport - limit - page](https://www.dropbox.com/developers/reference/data-transport-limit). - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "commit": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/upload_session/finish_batch: - post: - tags: - - files - summary: upload_session/finish_batch - description: >- - [upload_session/finish_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch) - - - scope: `files.content.write` - - - This route helps you commit many files at once into a user's Dropbox. - Use `upload_session/start` and `upload_session/append:2` to upload file - contents. We recommend uploading many files in parallel to increase - throughput. Once the file contents have been uploaded, rather than - calling `upload_session/finish`, use this route to finish all your - upload sessions in a single request. - - `UploadSessionStartArg.close` or `UploadSessionAppendArg.close` needs to - be true for the last `upload_session/start` or `upload_session/append:2` - call. The maximum size of a file one can upload to an upload session is - 350 GB. - - This route will return a job_id immediately and do the async commit job - in background. Use `upload_session/finish_batch/check` to check the job - status. - - For the same account, this route should be executed serially. That means - you should not start the next job before current job finishes. We allow - up to 1000 entries in a single request. - - Calls to this endpoint will count as data transport calls for any - Dropbox Business teams with a limit on the number of data transport - calls allowed per month. For more information, see the [Data transport - limit - page](https://www.dropbox.com/developers/reference/data-transport-limit). - requestBody: - content: - application/json: - schema: - type: object - example: - entries: - - cursor: - session_id: 1234faaf0678bcde - offset: 0 - commit: - path: /Homework/math/Matrices.txt - mode: add - autorename: true - mute: false - strict_conflict: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/upload_session/finish_batch/check: - post: - tags: - - files - summary: upload_session/finish_batch/check - description: >- - [upload_session/finish_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch-check) - - - scope: `files.content.write` - - - Returns the status of an asynchronous job for - `upload_session/finish_batch`. If success, it returns list of result for - each entry. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - entries: - - .tag: success - name: Prime_Numbers.txt - id: id:a4ayc_80_OEAAAAAAAAAXw - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - path_lower: /homework/math/prime_numbers.txt - path_display: /Homework/math/Prime_Numbers.txt - sharing_info: - read_only: true - parent_shared_folder_id: '84528192421' - modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - is_downloadable: true - property_groups: - - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - fields: - - name: Security Policy - value: Confidential - has_explicit_shared_members: false - content_hash: >- - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - is_lockholder: true - lockholder_name: Imaginary User - created: '2015-05-12T15:50:38Z' - /2/files/upload_session/start: - post: - tags: - - files - summary: upload_session/start - description: >- - [upload_session/start](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start) - - - scope: `files.content.write` - - - Upload sessions allow you to upload a single file in one or more - requests, for example where the size of the file is greater than 150 - MB. This call starts a new upload session with the given data. You can - then use `upload_session/append:2` to add more data and - `upload_session/finish` to save all the data to a file in Dropbox. - - A single request should not upload more than 150 MB. The maximum size of - a file one can upload to an upload session is 350 GB. - - An upload session can be used for a maximum of 48 hours. Attempting to - use an `UploadSessionStartResult.session_id` with - `upload_session/append:2` or `upload_session/finish` more than 48 hours - after its creation will return a `UploadSessionLookupError.not_found`. - - Calls to this endpoint will count as data transport calls for any - Dropbox Business teams with a limit on the number of data transport - calls allowed per month. For more information, see the [Data transport - limit - page](https://www.dropbox.com/developers/reference/data-transport-limit). - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "close": false - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - session_id: 1234faaf0678bcde - /2/sharing/add_file_member: - post: - tags: - - sharing - summary: add_file_member - description: >- - [add_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member) - - - scope: `sharing.write` - - - Adds specified members to a file. - requestBody: - content: - application/json: - schema: - type: object - example: - file: id:3kmLmQFnf1AAAAAAAAAAAw - members: - - .tag: email - email: justin@example.com - custom_message: This is a custom message about ACME.doc - quiet: false - access_level: viewer - add_message_as_comment: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - member: - .tag: email - email: justin@example.com - result: - .tag: success - /2/sharing/add_folder_member: - post: - tags: - - sharing - summary: add_folder_member - description: >- - [add_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member) - - - scope: `sharing.write` - - - Allows an owner or editor (if the ACL update policy allows) of a shared - folder to add another member. - - For the new member to get access to all the functionality for this - folder, you will need to call `mount_folder` on their behalf. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - members: - - member: - .tag: email - email: justin@example.com - access_level: editor - - member: - .tag: dropbox_id - dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q - access_level: viewer - quiet: false - custom_message: Documentation for launch day - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/sharing/check_job_status: - post: - tags: - - sharing - summary: check_job_status - description: >- - [check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status) - - - scope: `sharing.write` - - - Returns the status of an asynchronous job. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: in_progress - /2/sharing/check_remove_member_job_status: - post: - tags: - - sharing - summary: check_remove_member_job_status - description: >- - [check_remove_member_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status) - - - scope: `sharing.write` - - - Returns the status of an asynchronous job for sharing a folder. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/sharing/check_share_job_status: - post: - tags: - - sharing - summary: check_share_job_status - description: >- - [check_share_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_share_job_status) - - - scope: `sharing.write` - - - Returns the status of an asynchronous job for sharing a folder. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - /2/sharing/get_file_metadata: - post: - tags: - - sharing - summary: get_file_metadata - description: >- - [get_file_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata) - - - scope: `sharing.read` - - - Returns shared file metadata. - requestBody: - content: - application/json: - schema: - type: object - example: - file: id:3kmLmQFnf1AAAAAAAAAAAw - actions: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - id: id:3kmLmQFnf1AAAAAAAAAAAw - name: file.txt - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fi/fir9vjelf - access_type: - .tag: viewer - owner_display_names: - - Jane Doe - owner_team: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - path_display: /dir/file.txt - path_lower: /dir/file.txt - permissions: [] - time_invited: '2016-01-20T00:00:00Z' - /2/sharing/get_file_metadata/batch: - post: - tags: - - sharing - summary: get_file_metadata/batch - description: >- - [get_file_metadata/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch) - - - scope: `sharing.read` - - - Returns shared file metadata. - requestBody: - content: - application/json: - schema: - type: object - example: - files: - - id:3kmLmQFnf1AAAAAAAAAAAw - - id:VvTaJu2VZzAAAAAAAAAADQ - actions: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - file: id:3kmLmQFnf1AAAAAAAAAAAw - result: - .tag: metadata - id: id:3kmLmQFnf1AAAAAAAAAAAw - name: file.txt - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fi/fir9vjelf - access_type: - .tag: viewer - owner_display_names: - - Jane Doe - owner_team: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - path_display: /dir/file.txt - path_lower: /dir/file.txt - permissions: [] - time_invited: '2016-01-20T00:00:00Z' - /2/sharing/get_folder_metadata: - post: - tags: - - sharing - summary: get_folder_metadata - description: >- - [get_folder_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata) - - - scope: `sharing.read` - - - Returns shared folder metadata by its folder ID. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - actions: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - /2/sharing/get_shared_link_file: - post: - tags: - - sharing - summary: get_shared_link_file - description: >- - [get_shared_link_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file) - - - scope: `sharing.read` - - - Download the shared link's file from a user's Dropbox. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Arg - in: header - schema: - type: string - example: |- - { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "path": "/Prime_Numbers.txt" - } - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: file - url: >- - https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - name: Prime_Numbers.txt - link_permissions: - can_revoke: false - resolved_visibility: - .tag: public - revoke_failure_reason: - .tag: owner_only - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - id: id:a4ayc_80_OEAAAAAAAAAXw - path_lower: /homework/math/prime_numbers.txt - team_member_info: - team_info: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - display_name: Roger Rabbit - member_id: dbmid:abcd1234 - /2/sharing/get_shared_link_metadata: - post: - tags: - - sharing - summary: get_shared_link_metadata - description: >- - [get_shared_link_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_metadata) - - - scope: `sharing.read` - - - Get the shared link's metadata. - requestBody: - content: - application/json: - schema: - type: object - example: - url: >- - https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - path: /Prime_Numbers.txt - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: file - url: >- - https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - name: Prime_Numbers.txt - link_permissions: - can_revoke: false - resolved_visibility: - .tag: public - revoke_failure_reason: - .tag: owner_only - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - id: id:a4ayc_80_OEAAAAAAAAAXw - path_lower: /homework/math/prime_numbers.txt - team_member_info: - team_info: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - display_name: Roger Rabbit - member_id: dbmid:abcd1234 - /2/sharing/list_file_members: - post: - tags: - - sharing - summary: list_file_members - description: >- - [list_file_members](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members) - - - scope: `sharing.read` - - - Use to obtain the members who have been invited to a file, both - inherited and uninherited members. - requestBody: - content: - application/json: - schema: - type: object - example: - file: id:3kmLmQFnf1AAAAAAAAAAAw - include_inherited: true - limit: 100 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - users: - - access_type: - .tag: owner - user: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - email: bob@example.com - display_name: Robert Smith - same_team: true - team_member_id: dbmid:abcd1234 - permissions: [] - is_inherited: false - time_last_seen: '2016-01-20T00:00:00Z' - platform_type: - .tag: unknown - groups: - - access_type: - .tag: editor - group: - group_name: Test group - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - group_type: - .tag: user_managed - is_member: false - is_owner: false - same_team: true - member_count: 10 - permissions: [] - is_inherited: false - invitees: - - access_type: - .tag: viewer - invitee: - .tag: email - email: jessica@example.com - permissions: [] - is_inherited: false - /2/sharing/list_file_members/batch: - post: - tags: - - sharing - summary: list_file_members/batch - description: >- - [list_file_members/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch) - - - scope: `sharing.read` - - - Get members of multiple files at once. The arguments to this route are - more limited, and the limit on query result size per file is more - strict. To customize the results more, use the individual file endpoint. - - Inherited users and groups are not included in the result, and - permissions are not returned for this endpoint. - requestBody: - content: - application/json: - schema: - type: object - example: - files: - - id:3kmLmQFnf1AAAAAAAAAAAw - - id:VvTaJu2VZzAAAAAAAAAADQ - limit: 10 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - file: id:3kmLmQFnf1AAAAAAAAAAAw - result: - .tag: result - members: - users: - - access_type: - .tag: owner - user: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - email: bob@example.com - display_name: Robert Smith - same_team: true - team_member_id: dbmid:abcd1234 - permissions: [] - is_inherited: false - time_last_seen: '2016-01-20T00:00:00Z' - platform_type: - .tag: unknown - groups: - - access_type: - .tag: editor - group: - group_name: Test group - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - group_type: - .tag: user_managed - is_member: false - is_owner: false - same_team: true - member_count: 10 - permissions: [] - is_inherited: false - invitees: - - access_type: - .tag: viewer - invitee: - .tag: email - email: jessica@example.com - permissions: [] - is_inherited: false - member_count: 3 - /2/sharing/list_file_members/continue: - post: - tags: - - sharing - summary: list_file_members/continue - description: >- - [list_file_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue) - - - scope: `sharing.read` - - - Once a cursor has been retrieved from `list_file_members` or - `list_file_members/batch`, use this to paginate through all shared file - members. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - users: - - access_type: - .tag: owner - user: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - email: bob@example.com - display_name: Robert Smith - same_team: true - team_member_id: dbmid:abcd1234 - permissions: [] - is_inherited: false - time_last_seen: '2016-01-20T00:00:00Z' - platform_type: - .tag: unknown - groups: - - access_type: - .tag: editor - group: - group_name: Test group - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - group_type: - .tag: user_managed - is_member: false - is_owner: false - same_team: true - member_count: 10 - permissions: [] - is_inherited: false - invitees: - - access_type: - .tag: viewer - invitee: - .tag: email - email: jessica@example.com - permissions: [] - is_inherited: false - /2/sharing/list_folder_members/continue: - post: - tags: - - sharing - summary: list_folder_members/continue - description: >- - [list_folder_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue) - - - scope: `sharing.read` - - - Once a cursor has been retrieved from `list_folder_members`, use this to - paginate through all shared folder members. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - users: - - access_type: - .tag: owner - user: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - email: bob@example.com - display_name: Robert Smith - same_team: true - team_member_id: dbmid:abcd1234 - permissions: [] - is_inherited: false - groups: - - access_type: - .tag: editor - group: - group_name: Test group - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - group_type: - .tag: user_managed - is_member: false - is_owner: false - same_team: true - member_count: 10 - permissions: [] - is_inherited: false - invitees: - - access_type: - .tag: viewer - invitee: - .tag: email - email: jessica@example.com - permissions: [] - is_inherited: false - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/sharing/list_folders: - post: - tags: - - sharing - summary: list_folders - description: >- - [list_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders) - - - scope: `sharing.read` - - - Return the list of all shared folders the current user has access to. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 100 - actions: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/sharing/list_folders/continue: - post: - tags: - - sharing - summary: list_folders/continue - description: >- - [list_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue) - - - scope: `sharing.read` - - - Once a cursor has been retrieved from `list_folders`, use this to - paginate through all shared folders. The cursor must come from a - previous call to `list_folders` or `list_folders/continue`. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/sharing/list_mountable_folders: - post: - tags: - - sharing - summary: list_mountable_folders - description: >- - [list_mountable_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders) - - - scope: `sharing.read` - - - Return the list of all shared folders the current user can mount or - unmount. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 100 - actions: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/sharing/list_mountable_folders/continue: - post: - tags: - - sharing - summary: list_mountable_folders/continue - description: >- - [list_mountable_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue) - - - scope: `sharing.read` - - - Once a cursor has been retrieved from `list_mountable_folders`, use this - to paginate through all mountable shared folders. The cursor must come - from a previous call to `list_mountable_folders` or - `list_mountable_folders/continue`. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/sharing/list_received_files: - post: - tags: - - sharing - summary: list_received_files - description: >- - [list_received_files](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files) - - - scope: `sharing.read` - - - Returns a list of all files shared with current user. - Does not include files the user has received via shared folders, and does not include unclaimed invitations. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 100 - actions: [] - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - id: id:3kmLmQFnf1AAAAAAAAAAAw - name: file.txt - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fi/fir9vjelf - access_type: - .tag: viewer - owner_display_names: - - Jane Doe - owner_team: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - path_display: /dir/file.txt - path_lower: /dir/file.txt - permissions: [] - time_invited: '2016-01-20T00:00:00Z' - cursor: >- - AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ - /2/sharing/list_received_files/continue: - post: - tags: - - sharing - summary: list_received_files/continue - description: >- - [list_received_files/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue) - - - scope: `sharing.read` - - - Get more results with a cursor from `list_received_files`. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: >- - AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - id: id:3kmLmQFnf1AAAAAAAAAAAw - name: file.txt - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fi/fir9vjelf - access_type: - .tag: viewer - owner_display_names: - - Jane Doe - owner_team: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - path_display: /dir/file.txt - path_lower: /dir/file.txt - permissions: [] - time_invited: '2016-01-20T00:00:00Z' - cursor: >- - AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ - /2/sharing/list_shared_links: - post: - tags: - - sharing - summary: list_shared_links - description: >- - [list_shared_links](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links) - - - scope: `sharing.read` - - - List shared links of this user. - - If no path is given, returns a list of all shared links for the current - user. - - If a non-empty path is given, returns a list of all shared links that - allow access to the given path - direct links to the given path and - links to parent folders of the given path. Links to parent folders can - be suppressed by setting direct_only to true. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - links: - - .tag: file - url: >- - https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - name: Prime_Numbers.txt - link_permissions: - can_revoke: false - resolved_visibility: - .tag: public - revoke_failure_reason: - .tag: owner_only - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - id: id:a4ayc_80_OEAAAAAAAAAXw - path_lower: /homework/math/prime_numbers.txt - team_member_info: - team_info: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - display_name: Roger Rabbit - member_id: dbmid:abcd1234 - has_more: true - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/sharing/modify_shared_link_settings: - post: - tags: - - sharing - summary: modify_shared_link_settings - description: >- - [modify_shared_link_settings](https://www.dropbox.com/developers/documentation/http/documentation#sharing-modify_shared_link_settings) - - - scope: `sharing.write` - - - Modify the shared link's settings. - - If the requested visibility conflict with the shared links policy of the - team or the shared folder (in case the linked file is part of a shared - folder) then the `LinkPermissions.resolved_visibility` of the returned - `SharedLinkMetadata` will reflect the actual visibility of the shared - link and the `LinkPermissions.requested_visibility` will reflect the - requested visibility. - requestBody: - content: - application/json: - schema: - type: object - example: - url: >- - https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - settings: - requested_visibility: public - audience: public - access: viewer - remove_expiration: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: file - url: >- - https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - name: Prime_Numbers.txt - link_permissions: - can_revoke: false - resolved_visibility: - .tag: public - revoke_failure_reason: - .tag: owner_only - client_modified: '2015-05-12T15:50:38Z' - server_modified: '2015-05-12T15:50:38Z' - rev: a1c10ce0dd78 - size: 7212 - id: id:a4ayc_80_OEAAAAAAAAAXw - path_lower: /homework/math/prime_numbers.txt - team_member_info: - team_info: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - display_name: Roger Rabbit - member_id: dbmid:abcd1234 - /2/sharing/mount_folder: - post: - tags: - - sharing - summary: mount_folder - description: >- - [mount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder) - - - scope: `sharing.write` - - - The current user mounts the designated folder. - - Mount a shared folder for a user after they have been added as a member. - Once mounted, the shared folder will appear in their Dropbox. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - /2/sharing/relinquish_file_membership: - post: - tags: - - sharing - summary: relinquish_file_membership - description: >- - [relinquish_file_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership) - - - scope: `sharing.write` - - - The current user relinquishes their membership in the designated file. - Note that the current user may still have inherited access to this file - through the parent folder. - requestBody: - content: - application/json: - schema: - type: object - example: - file: id:3kmLmQFnf1AAAAAAAAAAAw - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/sharing/relinquish_folder_membership: - post: - tags: - - sharing - summary: relinquish_folder_membership - description: >- - [relinquish_folder_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership) - - - scope: `sharing.write` - - - The current user relinquishes their membership in the designated shared - folder and will no longer have access to the folder. A folder owner - cannot relinquish membership in their own folder. - - This will run synchronously if leave_a_copy is false, and asynchronously - if leave_a_copy is true. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - leave_a_copy: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/sharing/remove_file_member_2: - post: - tags: - - sharing - summary: remove_file_member_2 - description: >- - [remove_file_member_2](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2) - - - scope: `sharing.write` - - - Removes a specified member from the file. - requestBody: - content: - application/json: - schema: - type: object - example: - file: id:3kmLmQFnf1AAAAAAAAAAAw - member: - .tag: email - email: justin@example.com - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: other - /2/sharing/remove_folder_member: - post: - tags: - - sharing - summary: remove_folder_member - description: >- - [remove_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member) - - - scope: `sharing.write` - - - Allows an owner or editor (if the ACL update policy allows) of a shared - folder to remove another member. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - member: - .tag: email - email: justin@example.com - leave_a_copy: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: async_job_id - async_job_id: 34g93hh34h04y384084 - /2/sharing/revoke_shared_link: - post: - tags: - - sharing - summary: revoke_shared_link - description: >- - [revoke_shared_link](https://www.dropbox.com/developers/documentation/http/documentation#sharing-revoke_shared_link) - - - scope: `sharing.write` - - - Revoke a shared link. - - Note that even after revoking a shared link to a file, the file may be - accessible if there are shared links leading to any of the file parent - folders. To list all shared links that enable access to a specific file, - you can use the `list_shared_links` with the file as the - `ListSharedLinksArg.path` argument. - requestBody: - content: - application/json: - schema: - type: object - example: - url: >- - https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/sharing/set_access_inheritance: - post: - tags: - - sharing - summary: set_access_inheritance - description: >- - [set_access_inheritance](https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance) - - - scope: `sharing.write` - - - Change the inheritance policy of an existing Shared Folder. Only - permitted for shared folders in a shared team root. - - If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call - `check_share_job_status` until the action completes to get the metadata - for the folder. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - access_inheritance: inherit - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - /2/sharing/share_folder: - post: - tags: - - sharing - summary: share_folder - description: >- - [share_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-share_folder) - - - scope: `sharing.write` - - - Share a folder with collaborators. - - Most sharing will be completed synchronously. Large folders will be - completed asynchronously. To make testing the async case repeatable, set - `ShareFolderArg.force_async`. - - If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call - `check_share_job_status` until the action completes to get the metadata - for the folder. - requestBody: - content: - application/json: - schema: - type: object - example: - path: /example/workspace - acl_update_policy: editors - force_async: false - member_policy: team - shared_link_policy: members - access_inheritance: inherit - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - /2/sharing/transfer_folder: - post: - tags: - - sharing - summary: transfer_folder - description: >- - [transfer_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder) - - - scope: `sharing.write` - - - Transfer ownership of a shared folder to a member of the shared folder. - - User must have `AccessLevel.owner` access to the shared folder to - perform a transfer. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - to_dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/sharing/unmount_folder: - post: - tags: - - sharing - summary: unmount_folder - description: >- - [unmount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder) - - - scope: `sharing.write` - - - The current user unmounts the designated folder. They can re-mount the - folder at a later time using `mount_folder`. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/sharing/unshare_file: - post: - tags: - - sharing - summary: unshare_file - description: >- - [unshare_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_file) - - - scope: `sharing.write` - - - Remove all members from this file. Does not remove inherited members. - requestBody: - content: - application/json: - schema: - type: object - example: - file: id:3kmLmQFnf1AAAAAAAAAAAw - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: Successful response - content: - application/json: {} - /2/sharing/unshare_folder: - post: - tags: - - sharing - summary: unshare_folder - description: >- - [unshare_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_folder) - - - scope: `sharing.write` - - - Allows a shared folder owner to unshare the folder. - - You'll need to call `check_job_status` to determine if the action has - completed successfully. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - leave_a_copy: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/sharing/update_file_member: - post: - tags: - - sharing - summary: update_file_member - description: >- - [update_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member) - - - scope: `sharing.write` - - - Changes a member's access on a shared file. - requestBody: - content: - application/json: - schema: - type: object - example: - file: id:3kmLmQFnf1AAAAAAAAAAAw - member: - .tag: email - email: justin@example.com - access_level: viewer - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: {} - /2/sharing/update_folder_member: - post: - tags: - - sharing - summary: update_folder_member - description: >- - [update_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member) - - - scope: `sharing.write` - - - Allows an owner or editor of a shared folder to update another member's - permissions. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - member: - .tag: email - email: justin@example.com - access_level: editor - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: {} - /2/sharing/update_folder_policy: - post: - tags: - - sharing - summary: update_folder_policy - description: >- - [update_folder_policy](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy) - - - scope: `sharing.write` - - - Update the sharing policies for a shared folder. - - User must have `AccessLevel.owner` access to the shared folder to update - its policies. - requestBody: - content: - application/json: - schema: - type: object - example: - shared_folder_id: '84528192421' - member_policy: team - acl_update_policy: owner - shared_link_policy: members - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - access_type: - .tag: owner - is_inside_team_folder: false - is_team_folder: false - name: dir - policy: - acl_update_policy: - .tag: owner - shared_link_policy: - .tag: anyone - member_policy: - .tag: anyone - resolved_member_policy: - .tag: team - preview_url: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: '84528192421' - time_invited: '2016-01-20T00:00:00Z' - path_lower: /dir - link_metadata: - audience_options: - - .tag: public - - .tag: team - - .tag: members - current_audience: - .tag: public - link_permissions: - - action: - .tag: change_audience - allow: true - password_protected: false - url: '' - permissions: [] - access_inheritance: - .tag: inherit - /2/team/devices/list_member_devices: - post: - tags: - - team > devices - summary: devices/list_member_devices - description: >- - [devices/list_member_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_member_devices) - - - scope: `sessions.list` - - - List all device sessions of a team's member. - requestBody: - content: - application/json: - schema: - type: object - example: - team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - include_web_sessions: true - include_desktop_clients: true - include_mobile_clients: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/devices/list_members_devices: - post: - tags: - - team > devices - summary: devices/list_members_devices - description: >- - [devices/list_members_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_members_devices) - - - scope: `sessions.list` - - - List all device sessions of a team. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/devices/revoke_device_session: - post: - tags: - - team > devices - summary: devices/revoke_device_session - description: >- - [devices/revoke_device_session](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session) - - - scope: `sessions.modify` - - - Revoke a device session of a team's member. - requestBody: - content: - application/json: - schema: - type: object - example: - .tag: web_session - session_id: 1234faaf0678bcde - team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/devices/revoke_device_session_batch: - post: - tags: - - team > devices - summary: devices/revoke_device_session_batch - description: >- - [devices/revoke_device_session_batch](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session_batch) - - - scope: `sessions.modify` - - - Revoke a list of device sessions of team members. - requestBody: - content: - application/json: - schema: - type: object - example: - revoke_devices: - - .tag: web_session - session_id: 1234faaf0678bcde - team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/groups/create: - post: - tags: - - team > groups - summary: groups/create - description: >- - [groups/create](https://www.dropbox.com/developers/documentation/http/teams#team-groups-create) - - - scope: `groups.write` - - - Creates a new, empty group, with a requested name. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - group_name: Europe sales - add_creator_as_owner: false - group_external_id: group-134 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - group_name: project launch - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - created: 1447255518000 - member_count: 5 - members: - - profile: - team_member_id: dbmid:1234567 - email: mary@lamb.com - email_verified: true - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: apple@orange.com - is_verified: true - - email: banana@honeydew.com - is_verified: true - - email: grape@strawberry.com - is_verified: false - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - access_type: - .tag: member - /2/team/groups/delete: - post: - tags: - - team > groups - summary: groups/delete - description: >- - [groups/delete](https://www.dropbox.com/developers/documentation/http/teams#team-groups-delete) - - - scope: `groups.write` - - - Deletes a group. - - The group is deleted immediately. However the revoking of group-owned - resources may take additional time. Use the `groups/job_status/get` to - determine whether this process has completed. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - .tag: group_id - group_id: g:e2db7665347abcd600000000001a2b3c - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/team/groups/get_info: - post: - tags: - - team > groups - summary: groups/get_info - description: >- - [groups/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-groups-get_info) - - - scope: `groups.read` - - - Retrieves information about one or more groups. Note that the optional - field `GroupFullInfo.members` is not returned for system-managed - groups. - - Permission : Team Information. - requestBody: - content: - application/json: - schema: - type: object - example: - .tag: group_ids - group_ids: - - g:e2db7665347abcd600000000001a2b3c - - g:111111147abcd6000000000222222c - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - .tag: group_info - group_name: project launch - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - created: 1447255518000 - member_count: 5 - members: - - profile: - team_member_id: dbmid:1234567 - email: mary@lamb.com - email_verified: true - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: apple@orange.com - is_verified: true - - email: banana@honeydew.com - is_verified: true - - email: grape@strawberry.com - is_verified: false - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - access_type: - .tag: member - /2/team/groups/job_status/get: - post: - tags: - - team > groups - summary: groups/job_status/get - description: >- - [groups/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-groups-job_status-get) - - - scope: `groups.write` - - - Once an async_job_id is returned from `groups/delete`, - `groups/members/add` , or `groups/members/remove` use this method to - poll the status of granting/revoking group members' access to - group-owned resources. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/team/groups/list: - post: - tags: - - team > groups - summary: groups/list - description: >- - [groups/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list) - - - scope: `groups.read` - - - Lists groups on a team. - - Permission : Team Information. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 100 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - groups: - - group_name: Test group - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - member_count: 10 - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/groups/list/continue: - post: - tags: - - team > groups - summary: groups/list/continue - description: >- - [groups/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list-continue) - - - scope: `groups.read` - - - Once a cursor has been retrieved from `groups/list`, use this to - paginate through all groups. - - Permission : Team Information. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - groups: - - group_name: Test group - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - member_count: 10 - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/groups/members/add: - post: - tags: - - team > groups - summary: groups/members/add - description: >- - [groups/members/add](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-add) - - - scope: `groups.write` - - - Adds members to a group. - - The members are added immediately. However the granting of group-owned - resources may take additional time. Use the `groups/job_status/get` to - determine whether this process has completed. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - group: - .tag: group_id - group_id: g:e2db7665347abcd600000000001a2b3c - members: - - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - access_type: member - return_members: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - group_info: - group_name: project launch - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - created: 1447255518000 - member_count: 5 - members: - - profile: - team_member_id: dbmid:1234567 - email: mary@lamb.com - email_verified: true - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: apple@orange.com - is_verified: true - - email: banana@honeydew.com - is_verified: true - - email: grape@strawberry.com - is_verified: false - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - access_type: - .tag: member - async_job_id: '99988877733388' - /2/team/groups/members/list: - post: - tags: - - team > groups - summary: groups/members/list - description: >- - [groups/members/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list) - - - scope: `groups.read` - - - Lists members of a group. - - Permission : Team Information. - requestBody: - content: - application/json: - schema: - type: object - example: - group: - .tag: group_id - group_id: g:e2db7665347abcd600000000001a2b3c - limit: 100 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - members: [] - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/groups/members/list/continue: - post: - tags: - - team > groups - summary: groups/members/list/continue - description: >- - [groups/members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list-continue) - - - scope: `groups.read` - - - Once a cursor has been retrieved from `groups/members/list`, use this to - paginate through all members of the group. - - Permission : Team information. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - members: [] - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/groups/members/remove: - post: - tags: - - team > groups - summary: groups/members/remove - description: >- - [groups/members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-remove) - - - scope: `groups.write` - - - Removes members from a group. - - The members are removed immediately. However the revoking of group-owned - resources may take additional time. Use the `groups/job_status/get` to - determine whether this process has completed. - - This method permits removing the only owner of a group, even in cases - where this is not possible via the web client. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - group: - .tag: group_id - group_id: g:e2db7665347abcd600000000001a2b3c - users: - - .tag: team_member_id - team_member_id: dbmid:efgh5678 - return_members: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - group_info: - group_name: project launch - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - created: 1447255518000 - member_count: 5 - members: - - profile: - team_member_id: dbmid:1234567 - email: mary@lamb.com - email_verified: true - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: apple@orange.com - is_verified: true - - email: banana@honeydew.com - is_verified: true - - email: grape@strawberry.com - is_verified: false - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - access_type: - .tag: member - async_job_id: '99988877733388' - /2/team/groups/members/set_access_type: - post: - tags: - - team > groups - summary: groups/members/set_access_type - description: >- - [groups/members/set_access_type](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-set_access_type) - - - scope: `groups.write` - - - Sets a member's access type in a group. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - group: - .tag: group_id - group_id: g:e2db7665347abcd600000000001a2b3c - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - access_type: member - return_members: true - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - .tag: group_info - group_name: project launch - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - created: 1447255518000 - member_count: 5 - members: - - profile: - team_member_id: dbmid:1234567 - email: mary@lamb.com - email_verified: true - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: apple@orange.com - is_verified: true - - email: banana@honeydew.com - is_verified: true - - email: grape@strawberry.com - is_verified: false - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - access_type: - .tag: member - /2/team/groups/update: - post: - tags: - - team > groups - summary: groups/update - description: >- - [groups/update](https://www.dropbox.com/developers/documentation/http/teams#team-groups-update) - - - scope: `groups.write` - - - Updates a group's name and/or external ID. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - group: - .tag: group_id - group_id: g:e2db7665347abcd600000000001a2b3c - return_members: true - new_group_name: Europe west sales - new_group_external_id: sales-234 - new_group_management_type: company_managed - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - group_name: project launch - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - .tag: user_managed - created: 1447255518000 - member_count: 5 - members: - - profile: - team_member_id: dbmid:1234567 - email: mary@lamb.com - email_verified: true - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: apple@orange.com - is_verified: true - - email: banana@honeydew.com - is_verified: true - - email: grape@strawberry.com - is_verified: false - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - access_type: - .tag: member - /2/team/legal_holds/create_policy: - post: - tags: - - team > legal_holds - summary: legal_holds/create_policy - description: >- - [legal_holds/create_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-create_policy) - - - scope: `team_data.member` - - - Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not - all teams have the feature. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - name: acme cfo policy - members: - - dbmid:FDFSVF-DFSDF - start_date: '2016-01-01T00:00:00Z' - end_date: '2017-12-31T00:00:00Z' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - name: acme cfo policy - members: - team_member_ids: - - dbmid:efgh5678 - permanently_deleted_users: 2 - status: - .tag: active - start_date: '2016-01-01T00:00:00Z' - activation_time: '2016-01-20T00:00:10Z' - end_date: '2017-12-31T00:00:00Z' - /2/team/legal_holds/get_policy: - post: - tags: - - team > legal_holds - summary: legal_holds/get_policy - description: >- - [legal_holds/get_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-get_policy) - - - scope: `team_data.member` - - - Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all - teams have the feature. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - name: acme cfo policy - members: - team_member_ids: - - dbmid:efgh5678 - permanently_deleted_users: 2 - status: - .tag: active - start_date: '2016-01-01T00:00:00Z' - activation_time: '2016-01-20T00:00:10Z' - end_date: '2017-12-31T00:00:00Z' - /2/team/legal_holds/list_held_revisions: - post: - tags: - - team > legal_holds - summary: legal_holds/list_held_revisions - description: >- - [legal_holds/list_held_revisions](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions) - - - scope: `team_data.member` - - - List the file metadata that's under the hold. Note: Legal Holds is a - paid add-on. Not all teams have the feature. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - new_filename: 111_222.pdf - original_revision_id: ab2rij4i5ojgfd - original_file_path: /a.pdf - server_modified: '2019-08-12T12:08:52Z' - author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 - author_member_status: - .tag: active - author_email: a@a.com - file_type: Document - size: 3 - content_hash: >- - abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 - has_more: false - /2/team/legal_holds/list_held_revisions_continue: - post: - tags: - - team > legal_holds - summary: legal_holds/list_held_revisions_continue - description: >- - [legal_holds/list_held_revisions_continue](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions_continue) - - - scope: `team_data.member` - - - Continue listing the file metadata that's under the hold. Note: Legal - Holds is a paid add-on. Not all teams have the feature. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - entries: - - new_filename: 111_222.pdf - original_revision_id: ab2rij4i5ojgfd - original_file_path: /a.pdf - server_modified: '2019-08-12T12:08:52Z' - author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 - author_member_status: - .tag: active - author_email: a@a.com - file_type: Document - size: 3 - content_hash: >- - abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 - has_more: false - /2/team/legal_holds/list_policies: - post: - tags: - - team > legal_holds - summary: legal_holds/list_policies - description: >- - [legal_holds/list_policies](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_policies) - - - scope: `team_data.member` - - - Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all - teams have the feature. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - include_released: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - policies: - - id: pid_dbhid:abcd1234 - name: acme cfo policy - members: - team_member_ids: - - dbmid:efgh5678 - permanently_deleted_users: 2 - status: - .tag: active - start_date: '2016-01-01T00:00:00Z' - activation_time: '2016-01-20T00:00:10Z' - end_date: '2017-12-31T00:00:00Z' - /2/team/legal_holds/release_policy: - post: - tags: - - team > legal_holds - summary: legal_holds/release_policy - description: >- - [legal_holds/release_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-release_policy) - - - scope: `team_data.member` - - - Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all - teams have the feature. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/legal_holds/update_policy: - post: - tags: - - team > legal_holds - summary: legal_holds/update_policy - description: >- - [legal_holds/update_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-update_policy) - - - scope: `team_data.member` - - - Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams - have the feature. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - members: - - dbmid:FDFSVF-DFSDF - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - id: pid_dbhid:abcd1234 - name: acme cfo policy - members: - team_member_ids: - - dbmid:efgh5678 - permanently_deleted_users: 2 - status: - .tag: active - start_date: '2016-01-01T00:00:00Z' - activation_time: '2016-01-20T00:00:10Z' - end_date: '2017-12-31T00:00:00Z' - /2/team/linked_apps/list_member_linked_apps: - post: - tags: - - team > linked_apps - summary: linked_apps/list_member_linked_apps - description: >- - [linked_apps/list_member_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_member_linked_apps) - - - scope: `sessions.list` - - - List all linked applications of the team member. - - Note, this endpoint does not list any team-linked applications. - requestBody: - content: - application/json: - schema: - type: object - example: - team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/linked_apps/list_members_linked_apps: - post: - tags: - - team > linked_apps - summary: linked_apps/list_members_linked_apps - description: >- - [linked_apps/list_members_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_members_linked_apps) - - - scope: `sessions.list` - - - List all applications linked to the team members' accounts. - - Note, this endpoint does not list any team-linked applications. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/linked_apps/revoke_linked_app: - post: - tags: - - team > linked_apps - summary: linked_apps/revoke_linked_app - description: >- - [linked_apps/revoke_linked_app](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app) - - - scope: `sessions.modify` - - - Revoke a linked application of the team member. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/linked_apps/revoke_linked_app_batch: - post: - tags: - - team > linked_apps - summary: linked_apps/revoke_linked_app_batch - description: >- - [linked_apps/revoke_linked_app_batch](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app_batch) - - - scope: `sessions.modify` - - - Revoke a list of linked applications of the team members. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/member_space_limits/excluded_users/add: - post: - tags: - - team > member_space_limits - summary: member_space_limits/excluded_users/add - description: >- - [member_space_limits/excluded_users/add](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-add) - - - scope: `members.write` - - - Add users to member space limits excluded users list. - requestBody: - content: - application/json: - schema: - type: object - example: - users: - - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - status: - .tag: success - /2/team/member_space_limits/excluded_users/list: - post: - tags: - - team > member_space_limits - summary: member_space_limits/excluded_users/list - description: >- - [member_space_limits/excluded_users/list](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list) - - - scope: `members.read` - - - List member space limits excluded users. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 100 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - users: [] - has_more: false - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/team/member_space_limits/excluded_users/list/continue: - post: - tags: - - team > member_space_limits - summary: member_space_limits/excluded_users/list/continue - description: >- - [member_space_limits/excluded_users/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list-continue) - - - scope: `members.read` - - - Continue listing member space limits excluded users. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - users: [] - has_more: false - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - /2/team/member_space_limits/excluded_users/remove: - post: - tags: - - team > member_space_limits - summary: member_space_limits/excluded_users/remove - description: >- - [member_space_limits/excluded_users/remove](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-remove) - - - scope: `members.write` - - - Remove users from member space limits excluded users list. - requestBody: - content: - application/json: - schema: - type: object - example: - users: - - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - status: - .tag: success - /2/team/member_space_limits/get_custom_quota: - post: - tags: - - team > member_space_limits - summary: member_space_limits/get_custom_quota - description: >- - [member_space_limits/get_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-get_custom_quota) - - - scope: `members.read` - - - Get users custom quota. Returns none as the custom quota if none was - set. A maximum of 1000 members can be specified in a single call. - requestBody: - content: - application/json: - schema: - type: object - example: - users: - - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - .tag: other - /2/team/member_space_limits/remove_custom_quota: - post: - tags: - - team > member_space_limits - summary: member_space_limits/remove_custom_quota - description: >- - [member_space_limits/remove_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-remove_custom_quota) - - - scope: `members.write` - - - Remove users custom quota. A maximum of 1000 members can be specified in - a single call. - requestBody: - content: - application/json: - schema: - type: object - example: - users: - - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - .tag: other - /2/team/member_space_limits/set_custom_quota: - post: - tags: - - team > member_space_limits - summary: member_space_limits/set_custom_quota - description: >- - [member_space_limits/set_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-set_custom_quota) - - - scope: `members.read` - - - Set users custom quota. Custom quota has to be at least 15GB. A maximum - of 1000 members can be specified in a single call. - requestBody: - content: - application/json: - schema: - type: object - example: - users_and_quotas: - - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - quota_gb: 30 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - .tag: other - /2/team/members/add: - post: - tags: - - team > members - summary: members/add - description: >- - [members/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-add) - - - scope: `members.write` - - - Adds members to a team. - - Permission : Team member management - - A maximum of 20 members can be specified in a single call. - - If no Dropbox account exists with the email address specified, a new - Dropbox account will be created with the given email address, and that - account will be invited to the team. - - If a personal Dropbox account exists with the email address specified in - the call, this call will create a placeholder Dropbox account for the - user on the team and send an email inviting the user to migrate their - existing personal account onto the team. - - Team member management apps are required to set an initial given_name - and surname for a user to use in the team invitation and for 'Perform as - team member' actions taken on the user before they become 'active'. - requestBody: - content: - application/json: - schema: - type: object - example: - new_members: - - member_email: tom.s@company.com - member_given_name: Tom - member_surname: Silverstone - member_external_id: company_id:342432 - send_welcome_email: true - role: member_only - force_async: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - complete: - - .tag: success - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - /2/team/members/add/job_status/get: - post: - tags: - - team > members - summary: members/add/job_status/get - description: >- - [members/add/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-add-job_status-get) - - - scope: `members.write` - - - Once an async_job_id is returned from `members/add` , use this to poll - the status of the asynchronous request. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - complete: - - .tag: success - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - /2/team/members/delete_profile_photo: - post: - tags: - - team > members - summary: members/delete_profile_photo - description: >- - [members/delete_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-delete_profile_photo) - - - scope: `members.write` - - - Deletes a team member's profile photo. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - /2/team/members/get_info: - post: - tags: - - team > members - summary: members/get_info - description: >- - [members/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-members-get_info) - - - scope: `members.read` - - - Returns information about multiple team members. - - Permission : Team information - - This endpoint will return `MembersGetInfoItem.id_not_found`, for IDs (or - emails) that cannot be matched to a valid team member. - requestBody: - content: - application/json: - schema: - type: object - example: - members: - - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - .tag: member_info - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - /2/team/members/list: - post: - tags: - - team > members - summary: members/list - description: >- - [members/list](https://www.dropbox.com/developers/documentation/http/teams#team-members-list) - - - scope: `members.read` - - - Lists members of a team. - - Permission : Team information. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 100 - include_removed: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - members: - - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: true - /2/team/members/list/continue: - post: - tags: - - team > members - summary: members/list/continue - description: >- - [members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-members-list-continue) - - - scope: `members.read` - - - Once a cursor has been retrieved from `members/list`, use this to - paginate through all team members. - - Permission : Team information. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - members: - - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: true - /2/team/members/move_former_member_files: - post: - tags: - - team > members - summary: members/move_former_member_files - description: >- - [members/move_former_member_files](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files) - - - scope: `members.write` - - - Moves removed member's files to a different member. This endpoint - initiates an asynchronous job. To obtain the final result of the job, - the client should periodically poll - `members/move_former_member_files/job_status/check`. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - transfer_dest_id: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - transfer_admin_id: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/team/members/move_former_member_files/job_status/check: - post: - tags: - - team > members - summary: members/move_former_member_files/job_status/check - description: >- - [members/move_former_member_files/job_status/check](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files-job_status-check) - - - scope: `members.write` - - - Once an async_job_id is returned from `members/move_former_member_files` - , use this to poll the status of the asynchronous request. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/team/members/recover: - post: - tags: - - team > members - summary: members/recover - description: >- - [members/recover](https://www.dropbox.com/developers/documentation/http/teams#team-members-recover) - - - scope: `members.delete` - - - Recover a deleted member. - - Permission : Team member management - - Exactly one of team_member_id, email, or external_id must be provided to - identify the user account. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/members/remove: - post: - tags: - - team > members - summary: members/remove - description: >- - [members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove) - - - scope: `members.delete` - - - Removes a member from a team. - - Permission : Team member management - - Exactly one of team_member_id, email, or external_id must be provided to - identify the user account. - - Accounts can be recovered via `members/recover` for a 7 day period or - until the account has been permanently deleted or transferred to another - account (whichever comes first). Calling `members/add` while a user is - still recoverable on your team will return with - `MemberAddResult.user_already_on_team`. - - Accounts can have their files transferred via the admin console for a - limited time, based on the version history length associated with the - team (180 days for most teams). - - This endpoint may initiate an asynchronous job. To obtain the final - result of the job, the client should periodically poll - `members/remove/job_status/get`. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - wipe_data: true - transfer_dest_id: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - transfer_admin_id: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - keep_account: false - retain_team_shares: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/team/members/remove/job_status/get: - post: - tags: - - team > members - summary: members/remove/job_status/get - description: >- - [members/remove/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove-job_status-get) - - - scope: `members.delete` - - - Once an async_job_id is returned from `members/remove` , use this to - poll the status of the asynchronous request. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - /2/team/members/secondary_emails/add: - post: - tags: - - team > members - summary: members/secondary_emails/add - description: >- - [members/secondary_emails/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-add) - - - scope: `members.write` - - - Add secondary emails to users. - - Permission : Team member management. - - Emails that are on verified domains will be verified automatically. For - each email address not on a verified domain a verification email will be - sent. - requestBody: - content: - application/json: - schema: - type: object - example: - new_secondary_emails: - - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - secondary_emails: - - bob2@hotmail.com - - bob@inst.gov - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - results: - - .tag: success - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - results: - - .tag: success - success: - email: apple@orange.com - is_verified: true - - .tag: unavailable - unavailable: alice@example.com - - .tag: invalid_user - invalid_user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - /2/team/members/secondary_emails/delete: - post: - tags: - - team > members - summary: members/secondary_emails/delete - description: >- - [members/secondary_emails/delete](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-delete) - - - scope: `members.write` - - - Delete secondary emails from users - - Permission : Team member management. - - Users will be notified of deletions of verified secondary emails at both - the secondary email and their primary email. - requestBody: - content: - application/json: - schema: - type: object - example: - emails_to_delete: - - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - secondary_emails: - - bob2@hotmail.com - - bob@inst.gov - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - results: - - .tag: success - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - results: - - .tag: success - success: alice@example.com - - .tag: not_found - not_found: alic@example.com - /2/team/members/secondary_emails/resend_verification_emails: - post: - tags: - - team > members - summary: members/secondary_emails/resend_verification_emails - description: >- - [members/secondary_emails/resend_verification_emails](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-resend_verification_emails) - - - scope: `members.write` - - - Resend secondary email verification emails. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - emails_to_resend: - - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - secondary_emails: - - bob2@hotmail.com - - bob@inst.gov - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - results: - - .tag: success - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - results: - - .tag: success - success: alice@example.com - /2/team/members/send_welcome_email: - post: - tags: - - team > members - summary: members/send_welcome_email - description: >- - [members/send_welcome_email](https://www.dropbox.com/developers/documentation/http/teams#team-members-send_welcome_email) - - - scope: `members.write` - - - Sends welcome email to pending team member. - - Permission : Team member management - - Exactly one of team_member_id, email, or external_id must be provided to - identify the user account. - - No-op if team member is not pending. - requestBody: - content: - application/json: - schema: - type: object - example: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/members/set_admin_permissions: - post: - tags: - - team > members - summary: members/set_admin_permissions - description: >- - [members/set_admin_permissions](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_admin_permissions) - - - scope: `members.write` - - - Updates a team member's permissions. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - new_role: member_only - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - team_member_id: dbmid:9978889 - role: - .tag: member_only - /2/team/members/set_profile: - post: - tags: - - team > members - summary: members/set_profile - description: >- - [members/set_profile](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile) - - - scope: `members.write` - - - Updates a team member's profile. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - new_email: t.smith@domain.com - new_surname: Smith - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - /2/team/members/set_profile_photo: - post: - tags: - - team > members - summary: members/set_profile_photo - description: >- - [members/set_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile_photo) - - - scope: `members.write` - - - Updates a team member's profile photo. - - Permission : Team member management. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - photo: - .tag: base64_data - base64_data: >- - SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - role: - .tag: member_only - /2/team/members/suspend: - post: - tags: - - team > members - summary: members/suspend - description: >- - [members/suspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-suspend) - - - scope: `members.write` - - - Suspend a member from a team. - - Permission : Team member management - - Exactly one of team_member_id, email, or external_id must be provided to - identify the user account. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - wipe_data: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/members/unsuspend: - post: - tags: - - team > members - summary: members/unsuspend - description: >- - [members/unsuspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-unsuspend) - - - scope: `members.write` - - - Unsuspend a member from a team. - - Permission : Team member management - - Exactly one of team_member_id, email, or external_id must be provided to - identify the user account. - requestBody: - content: - application/json: - schema: - type: object - example: - user: - .tag: team_member_id - team_member_id: dbmid:efgh5678 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/namespaces/list: - post: - tags: - - team > namespaces - summary: namespaces/list - description: >- - [namespaces/list](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list) - - - scope: `team_data.member` - - - Returns a list of all team-accessible namespaces. This list includes - team folders, shared folders containing team members, team members' home - namespaces, and team members' app folders. Home namespaces and app - folders are always owned by this team or members of the team, but shared - folders may be owned by other users or other teams. Duplicates may occur - in the list. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 1 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - namespaces: - - name: Marketing - namespace_id: '123456789' - namespace_type: - .tag: shared_folder - - name: Franz Ferdinand - namespace_id: '123456789' - namespace_type: - .tag: team_member_folder - team_member_id: dbmid:1234567 - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/namespaces/list/continue: - post: - tags: - - team > namespaces - summary: namespaces/list/continue - description: >- - [namespaces/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list-continue) - - - scope: `team_data.member` - - - Once a cursor has been retrieved from `namespaces/list`, use this to - paginate through all team-accessible namespaces. Duplicates may occur in - the list. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - namespaces: - - name: Marketing - namespace_id: '123456789' - namespace_type: - .tag: shared_folder - - name: Franz Ferdinand - namespace_id: '123456789' - namespace_type: - .tag: team_member_folder - team_member_id: dbmid:1234567 - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/reports/get_activity: - post: - tags: - - team > reports - summary: reports/get_activity - description: >- - [reports/get_activity](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_activity) - - - scope: `team_info.read` - - - Retrieves reporting data about a team's user activity. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/reports/get_devices: - post: - tags: - - team > reports - summary: reports/get_devices - description: >- - [reports/get_devices](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_devices) - - - scope: `team_info.read` - - - Retrieves reporting data about a team's linked devices. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/reports/get_membership: - post: - tags: - - team > reports - summary: reports/get_membership - description: >- - [reports/get_membership](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_membership) - - - scope: `team_info.read` - - - Retrieves reporting data about a team's membership. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/reports/get_storage: - post: - tags: - - team > reports - summary: reports/get_storage - description: >- - [reports/get_storage](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_storage) - - - scope: `team_info.read` - - - Retrieves reporting data about a team's storage usage. - requestBody: - content: - application/json: - schema: - type: object - example: '' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/team_folder/activate: - post: - tags: - - team > team_folder - summary: team_folder/activate - description: >- - [team_folder/activate](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-activate) - - - scope: `team_data.team_space` - - - Sets an archived team folder's status to active. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - /2/team/team_folder/archive: - post: - tags: - - team > team_folder - summary: team_folder/archive - description: >- - [team_folder/archive](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive) - - - scope: `team_data.team_space` - - - Sets an active team folder's status to archived and removes all folder - and file members. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - force_async_off: false - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - /2/team/team_folder/archive/check: - post: - tags: - - team > team_folder - summary: team_folder/archive/check - description: >- - [team_folder/archive/check](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive-check) - - - scope: `team_data.team_space` - - - Returns the status of an asynchronous job for archiving a team folder. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - async_job_id: 34g93hh34h04y384084 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - .tag: complete - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - /2/team/team_folder/create: - post: - tags: - - team > team_folder - summary: team_folder/create - description: >- - [team_folder/create](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-create) - - - scope: `team_data.team_space` - - - Creates a new, active, team folder with no members. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - name: Marketing - sync_setting: not_synced - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - /2/team/team_folder/get_info: - post: - tags: - - team > team_folder - summary: team_folder/get_info - description: >- - [team_folder/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-get_info) - - - scope: `team_data.team_space` - - - Retrieves metadata for team folders. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - team_folder_ids: - - '947182' - - '5819424' - - '852307532' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/team_folder/list: - post: - tags: - - team > team_folder - summary: team_folder/list - description: >- - [team_folder/list](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list) - - - scope: `team_data.team_space` - - - Lists all team folders. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 100 - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - team_folders: - - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/team_folder/list/continue: - post: - tags: - - team > team_folder - summary: team_folder/list/continue - description: >- - [team_folder/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list-continue) - - - scope: `team_data.team_space` - - - Once a cursor has been retrieved from `team_folder/list`, use this to - paginate through all team folders. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - team_folders: - - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team/team_folder/permanently_delete: - post: - tags: - - team > team_folder - summary: team_folder/permanently_delete - description: >- - [team_folder/permanently_delete](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-permanently_delete) - - - scope: `team_data.team_space` - - - Permanently deletes an archived team folder. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: {} - /2/team/team_folder/rename: - post: - tags: - - team > team_folder - summary: team_folder/rename - description: >- - [team_folder/rename](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-rename) - - - scope: `team_data.team_space` - - - Changes an active team folder's name. - - Permission : Team member file access. - requestBody: - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - name: Sales - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - /2/team/team_folder/update_sync_settings: - post: - tags: - - team > team_folder - summary: team_folder/update_sync_settings - description: >- - [team_folder/update_sync_settings](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-update_sync_settings) - - - scope: `team_data.team_space` - - - Updates the sync settings on a team folder or its contents. Use of this - endpoint requires that the team has team selective sync enabled. - requestBody: - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - sync_setting: not_synced - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: not_synced - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - team_folder_id: '123456789' - name: Marketing - status: - .tag: active - is_team_shared_dropbox: false - sync_setting: - .tag: default - content_sync_settings: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - .tag: default - /2/team/features/get_values: - post: - tags: - - team - summary: features/get_values - description: >- - [features/get_values](https://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) - - - scope: `team_info.read` - - - Get the values for one or more featues. This route allows you to check - your account's capability for what feature you can access or what value - you have for certain features. - - Permission : Team information. - requestBody: - content: - application/json: - schema: - type: object - example: - features: - - .tag: upload_api_rate_limit - - .tag: has_team_shared_dropbox - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - values: - - .tag: upload_api_rate_limit - upload_api_rate_limit: - .tag: limit - limit: 25000 - - .tag: has_team_shared_dropbox - has_team_shared_dropbox: - .tag: has_team_shared_dropbox - has_team_shared_dropbox: false - /2/team/get_info: - post: - tags: - - team - summary: get_info - description: >- - [get_info](https://www.dropbox.com/developers/documentation/http/teams#team-get_info) - - - scope: `team_info.read` - - - Retrieves information about a team. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - security: - - bearerAuth: [] - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - name: Dropbox Inc. - team_id: dbtid:1234abcd - num_licensed_users: 5 - num_provisioned_users: 2 - policies: - sharing: - shared_folder_member_policy: - .tag: team - shared_folder_join_policy: - .tag: from_anyone - shared_link_create_policy: - .tag: team_only - emm_state: - .tag: disabled - office_addin: - .tag: disabled - /2/team/token/get_authenticated_admin: - post: - tags: - - team - summary: token/get_authenticated_admin - description: >- - [token/get_authenticated_admin](https://www.dropbox.com/developers/documentation/http/teams#team-token-get_authenticated_admin) - - - scope: `team_info.read` - - - Returns the member profile of the admin who generated the team access - token used to make the call. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - admin_profile: - team_member_id: dbmid:FDFSVF-DFSDF - email: tami@seagull.com - email_verified: false - status: - .tag: active - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - membership_type: - .tag: full - groups: - - g:e2db7665347abcd600000000001a2b3c - member_folder_id: '20' - external_id: '244423' - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - secondary_emails: - - email: grape@strawberry.com - is_verified: false - - email: apple@orange.com - is_verified: true - joined_on: '2015-05-12T15:50:38Z' - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - /2/team_log/get_events: - post: - tags: - - team_log - summary: get_events - description: >- - [get_events](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events) - - - scope: `events.read` - - - Retrieves team events. If the result's `GetTeamEventsResult.has_more` - field is `true`, call `get_events/continue` with the returned cursor to - retrieve more entries. If end_time is not specified in your request, you - may use the returned cursor to poll `get_events/continue` for new - events. - - Many attributes note 'may be missing due to historical data gap'. - - Note that the file_operations category and & analogous paper events are - not available on all Dropbox Business - [plans](http://www.dropbox.com/business/plans-comparison). Use - [features/get_values](http://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) - to check for this feature. - - Permission : Team Auditing. - requestBody: - content: - application/json: - schema: - type: object - example: - limit: 50 - category: groups - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - events: - - timestamp: '2017-01-25T15:51:30Z' - event_category: - .tag: tfa - event_type: - .tag: shared_content_download - description: (sharing) Downloaded shared file/folder - details: - .tag: shared_content_download_details - shared_content_link: abc - shared_content_access_level: - .tag: viewer_no_comment - shared_content_owner: - .tag: team_member - account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho - display_name: John Smith - email: john_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 - team: - display_name: A Team - actor: - .tag: user - user: - .tag: team_member - account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho - display_name: John Smith - email: john_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 - team: - display_name: A Team - origin: - access_method: - .tag: end_user - end_user: - .tag: web - session_id: dbwsid:123456789012345678901234567890123456789 - geo_location: - ip_address: 45.56.78.100 - city: San Francisco - region: California - country: US - involve_non_team_member: true - context: - .tag: team_member - account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho - display_name: John Smith - email: john_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 - team: - display_name: A Team - participants: - - .tag: user - user: - .tag: team_member - account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw - display_name: Jane Smith - email: jane_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 - team: - display_name: A Team - assets: - - .tag: file - path: - namespace_relative: - ns_id: '1234' - relative_path: /Contract Work/Draft - is_shared_namespace: false - contextual: /Contract Work/Draft - display_name: reports.xls - file_id: id:jQKLsZFQImAAAAAAEZAAQt - file_size: 4 - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/team_log/get_events/continue: - post: - tags: - - team_log - summary: get_events/continue - description: >- - [get_events/continue](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events-continue) - - - scope: `events.read` - - - Once a cursor has been retrieved from `get_events`, use this to paginate - through all events. - - Permission : Team Auditing. - requestBody: - content: - application/json: - schema: - type: object - example: - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - events: - - timestamp: '2017-01-25T15:51:30Z' - event_category: - .tag: tfa - event_type: - .tag: shared_content_download - description: (sharing) Downloaded shared file/folder - details: - .tag: shared_content_download_details - shared_content_link: abc - shared_content_access_level: - .tag: viewer_no_comment - shared_content_owner: - .tag: team_member - account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho - display_name: John Smith - email: john_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 - team: - display_name: A Team - actor: - .tag: user - user: - .tag: team_member - account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho - display_name: John Smith - email: john_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 - team: - display_name: A Team - origin: - access_method: - .tag: end_user - end_user: - .tag: web - session_id: dbwsid:123456789012345678901234567890123456789 - geo_location: - ip_address: 45.56.78.100 - city: San Francisco - region: California - country: US - involve_non_team_member: true - context: - .tag: team_member - account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho - display_name: John Smith - email: john_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 - team: - display_name: A Team - participants: - - .tag: user - user: - .tag: team_member - account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw - display_name: Jane Smith - email: jane_smith@acmecorp.com - team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 - team: - display_name: A Team - assets: - - .tag: file - path: - namespace_relative: - ns_id: '1234' - relative_path: /Contract Work/Draft - is_shared_namespace: false - contextual: /Contract Work/Draft - display_name: reports.xls - file_id: id:jQKLsZFQImAAAAAAEZAAQt - file_size: 4 - cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - has_more: false - /2/users/features/get_values: - post: - tags: - - users - summary: features/get_values - description: >- - [features/get_values](https://www.dropbox.com/developers/documentation/http/documentation#users-features-get_values) - - - scope: `account_info.read` - - - Get a list of feature values that may be configured for the current - account. - requestBody: - content: - application/json: - schema: - type: object - example: - features: - - .tag: paper_as_files - - .tag: file_locking - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - values: - - .tag: paper_as_files - paper_as_files: - .tag: enabled - enabled: true - /2/users/get_account: - post: - tags: - - users - summary: get_account - description: >- - [get_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account) - - - scope: `sharing.read` - - - Get information about a user's account. - requestBody: - content: - application/json: - schema: - type: object - example: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - email: franz@dropbox.com - email_verified: true - disabled: false - is_teammate: false - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - /2/users/get_account_batch: - post: - tags: - - users - summary: get_account_batch - description: >- - [get_account_batch](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account_batch) - - - scope: `sharing.read` - - - Get information about multiple user accounts. At most 300 accounts may - be queried per request. - requestBody: - content: - application/json: - schema: - type: object - example: - account_ids: - - dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - - dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - email: franz@dropbox.com - email_verified: true - disabled: false - is_teammate: false - profile_photo_url: >- - https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - /2/users/get_current_account: - post: - tags: - - users - summary: get_current_account - description: >- - [get_current_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account) - - - scope: `account_info.read` - - - Get information about the current user's account. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - - name: Dropbox-API-Select-Admin - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - name: - given_name: Franz - surname: Ferdinand - familiar_name: Franz - display_name: Franz Ferdinand (Personal) - abbreviated_name: FF - email: franz@dropbox.com - email_verified: true - disabled: false - locale: en - referral_link: https://db.tt/ZITNuhtI - is_paired: true - account_type: - .tag: business - root_info: - .tag: user - root_namespace_id: '3235641' - home_namespace_id: '3235641' - country: US - team: - id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - name: Acme, Inc. - sharing_policies: - shared_folder_member_policy: - .tag: team - shared_folder_join_policy: - .tag: from_anyone - shared_link_create_policy: - .tag: team_only - office_addin_policy: - .tag: disabled - team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU - /2/users/get_space_usage: - post: - tags: - - users - summary: get_space_usage - description: >- - [get_space_usage](https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage) - - - scope: `account_info.read` - - - Get the space usage information for the current user's account. - requestBody: - $ref: "#/components/requestBodies/EmptyRequestBody" - parameters: - - name: Dropbox-API-Path-Root - in: header - schema: - type: string - example: '{".tag": "namespace_id", "namespace_id": "2"}' - - name: Dropbox-API-Select-User - in: header - schema: - type: string - example: dbmid:FDFSVF-DFSDF - responses: - '200': - description: OK - headers: - X-Dropbox-Request-Id: - schema: - type: integer - example: '1234' - Content-Type: - schema: - type: string - example: application/json - content: - application/json: - schema: - type: object - example: - used: 314159265 - allocation: - .tag: individual - allocated: 10000000000 diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 192f179..403e307 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -19,6 +19,6 @@ These changes are done in order to improve the overall usability, and as workaro The following command was used to generate the Ballerina client from the OpenAPI specification. The command should be executed from the repository root directory. ```bash -bal openapi -i docs/spec/openapi.yaml --mode client --license docs/license.txt -o ballerina +bal openapi -i docs/spec/openapi.json --mode client --license docs/license.txt -o ballerina ``` Note: The license year is hardcoded to 2024, change if necessary. From 440f0aa61c3b35006993c1bbc6f2947b8e0d8cb8 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Sat, 26 Oct 2024 23:44:11 +0530 Subject: [PATCH 08/15] Remove API version from endpoint and add it to the server url instead to centralize the versioning to the base URL --- ballerina/client.bal | 1402 +++++++++++++++++++++++++++----------- ballerina/types.bal | 1110 +++++++++++++++--------------- docs/spec/openapi.json | 388 +++++------ docs/spec/sanitations.md | 19 +- 4 files changed, 1784 insertions(+), 1135 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 4c516b4..62ac88f 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -81,7 +81,7 @@ public isolated client class Client { # + config - The configurations to be used when initializing the `connector` # + serviceUrl - URL of the target service # + return - An error if connector initialization failed - public isolated function init(ConnectionConfig config, string serviceUrl = "https://api.dropboxapi.com") returns error? { + public isolated function init(ConnectionConfig config, string serviceUrl = "https://api.dropboxapi.com/2") returns error? { http:ClientConfiguration httpClientConfig = {auth: config.auth, httpVersion: config.httpVersion, timeout: config.timeout, forwarded: config.forwarded, poolConfig: config.poolConfig, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, validation: config.validation}; do { if config.http1Settings is ClientHttp1Settings { @@ -109,8 +109,8 @@ public isolated client class Client { return; } - resource isolated function post '2/'check/app(check_app_body payload, AppHeaders headers = {}) returns inline_response_200_2|error { - string resourcePath = string `/2/check/app`; + resource isolated function post 'check/app(check_app_body payload, AppHeaders headers = {}) returns inline_response_200_2|error { + string resourcePath = string `/check/app`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -118,8 +118,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/'check/user(check_user_body payload, UserHeaders headers = {}) returns inline_response_200_2|error { - string resourcePath = string `/2/check/user`; + resource isolated function post 'check/user(check_user_body payload, UserHeaders headers = {}) returns inline_response_200_2|error { + string resourcePath = string `/check/user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -127,8 +127,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/account/set_profile_photo(account_set_profile_photo_body payload, SetProfilePhotoHeaders headers = {}) returns inline_response_200|error { - string resourcePath = string `/2/account/set_profile_photo`; + # set_profile_photo + # + # + headers - Headers to be sent with the request + # + return - set_profile_photo response + resource isolated function post account/set_profile_photo(account_set_profile_photo_body payload, SetProfilePhotoHeaders headers = {}) returns inline_response_200|error { + string resourcePath = string `/account/set_profile_photo`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -136,8 +140,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/auth/token/from_oauth1(token_from_oauth1_body payload, TokenFromOauth1Headers headers = {}) returns inline_response_200_1|error { - string resourcePath = string `/2/auth/token/from_oauth1`; + # token/from_oauth1 + # + # + headers - Headers to be sent with the request + # + return - token/from_oauth1 response + resource isolated function post auth/token/from_oauth1(token_from_oauth1_body payload, TokenFromOauth1Headers headers = {}) returns inline_response_200_1|error { + string resourcePath = string `/auth/token/from_oauth1`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -145,22 +153,31 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/auth/token/revoke(TokenRevokeHeaders headers = {}) returns error? { - string resourcePath = string `/2/auth/token/revoke`; + # token/revoke + # + # + headers - Headers to be sent with the request + resource isolated function post auth/token/revoke(TokenRevokeHeaders headers = {}) returns error? { + string resourcePath = string `/auth/token/revoke`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/contacts/delete_manual_contacts(DeleteManualContactsHeaders headers = {}) returns error? { - string resourcePath = string `/2/contacts/delete_manual_contacts`; + # delete_manual_contacts + # + # + headers - Headers to be sent with the request + resource isolated function post contacts/delete_manual_contacts(DeleteManualContactsHeaders headers = {}) returns error? { + string resourcePath = string `/contacts/delete_manual_contacts`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/contacts/delete_manual_contacts_batch(contacts_delete_manual_contacts_batch_body payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { - string resourcePath = string `/2/contacts/delete_manual_contacts_batch`; + # delete_manual_contacts_batch + # + # + headers - Headers to be sent with the request + resource isolated function post contacts/delete_manual_contacts_batch(contacts_delete_manual_contacts_batch_body payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { + string resourcePath = string `/contacts/delete_manual_contacts_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -168,8 +185,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/add(properties_add_body payload, PropertiesAddHeaders headers = {}) returns error? { - string resourcePath = string `/2/file_properties/properties/add`; + # properties/add + # + # + headers - Headers to be sent with the request + resource isolated function post file_properties/properties/add(properties_add_body payload, PropertiesAddHeaders headers = {}) returns error? { + string resourcePath = string `/file_properties/properties/add`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -177,8 +197,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/overwrite(properties_overwrite_body payload, PropertiesOverwriteHeaders headers = {}) returns error? { - string resourcePath = string `/2/file_properties/properties/overwrite`; + # properties/overwrite + # + # + headers - Headers to be sent with the request + resource isolated function post file_properties/properties/overwrite(properties_overwrite_body payload, PropertiesOverwriteHeaders headers = {}) returns error? { + string resourcePath = string `/file_properties/properties/overwrite`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -186,8 +209,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/remove(properties_remove_body payload, PropertiesRemoveHeaders headers = {}) returns error? { - string resourcePath = string `/2/file_properties/properties/remove`; + # properties/remove + # + # + headers - Headers to be sent with the request + resource isolated function post file_properties/properties/remove(properties_remove_body payload, PropertiesRemoveHeaders headers = {}) returns error? { + string resourcePath = string `/file_properties/properties/remove`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -195,8 +221,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/search(properties_search_body payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_3|error { - string resourcePath = string `/2/file_properties/properties/search`; + # properties/search + # + # + headers - Headers to be sent with the request + # + return - properties/search response + resource isolated function post file_properties/properties/search(properties_search_body payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_3|error { + string resourcePath = string `/file_properties/properties/search`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -204,8 +234,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/search/'continue(search_continue_body payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_3|error { - string resourcePath = string `/2/file_properties/properties/search/continue`; + resource isolated function post file_properties/properties/search/'continue(search_continue_body payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_3|error { + string resourcePath = string `/file_properties/properties/search/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -213,8 +243,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/properties/update(properties_update_body payload, PropertiesUpdateHeaders headers = {}) returns error? { - string resourcePath = string `/2/file_properties/properties/update`; + # properties/update + # + # + headers - Headers to be sent with the request + resource isolated function post file_properties/properties/update(properties_update_body payload, PropertiesUpdateHeaders headers = {}) returns error? { + string resourcePath = string `/file_properties/properties/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -222,16 +255,24 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/add_for_team(templates_add_for_team_body payload, map headers = {}) returns inline_response_200_4|error { - string resourcePath = string `/2/file_properties/templates/add_for_team`; + # templates/add_for_team + # + # + headers - Headers to be sent with the request + # + return - templates/add_for_team response + resource isolated function post file_properties/templates/add_for_team(templates_add_for_team_body payload, map headers = {}) returns inline_response_200_4|error { + string resourcePath = string `/file_properties/templates/add_for_team`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/add_for_user(templates_add_for_user_body payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_4|error { - string resourcePath = string `/2/file_properties/templates/add_for_user`; + # templates/add_for_user + # + # + headers - Headers to be sent with the request + # + return - templates/add_for_user response + resource isolated function post file_properties/templates/add_for_user(templates_add_for_user_body payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_4|error { + string resourcePath = string `/file_properties/templates/add_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -239,16 +280,24 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/get_for_team(templates_get_for_team_body payload, map headers = {}) returns inline_response_200_5|error { - string resourcePath = string `/2/file_properties/templates/get_for_team`; + # templates/get_for_team + # + # + headers - Headers to be sent with the request + # + return - templates/get_for_team response + resource isolated function post file_properties/templates/get_for_team(templates_get_for_team_body payload, map headers = {}) returns inline_response_200_5|error { + string resourcePath = string `/file_properties/templates/get_for_team`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/get_for_user(templates_get_for_user_body payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_5|error { - string resourcePath = string `/2/file_properties/templates/get_for_user`; + # templates/get_for_user + # + # + headers - Headers to be sent with the request + # + return - templates/get_for_user response + resource isolated function post file_properties/templates/get_for_user(templates_get_for_user_body payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_5|error { + string resourcePath = string `/file_properties/templates/get_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -256,29 +305,43 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_6|error { - string resourcePath = string `/2/file_properties/templates/list_for_team`; + # templates/list_for_team + # + # + headers - Headers to be sent with the request + # + return - templates/list_for_team response + resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_6|error { + string resourcePath = string `/file_properties/templates/list_for_team`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_6|error { - string resourcePath = string `/2/file_properties/templates/list_for_user`; + # templates/list_for_user + # + # + headers - Headers to be sent with the request + # + return - templates/list_for_user response + resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_6|error { + string resourcePath = string `/file_properties/templates/list_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/remove_for_team(templates_remove_for_team_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/file_properties/templates/remove_for_team`; + # templates/remove_for_team + # + # + headers - Headers to be sent with the request + resource isolated function post file_properties/templates/remove_for_team(templates_remove_for_team_body payload, map headers = {}) returns error? { + string resourcePath = string `/file_properties/templates/remove_for_team`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/remove_for_user(templates_remove_for_user_body payload, TemplatesRemoveForUserHeaders headers = {}) returns error? { - string resourcePath = string `/2/file_properties/templates/remove_for_user`; + # templates/remove_for_user + # + # + headers - Headers to be sent with the request + resource isolated function post file_properties/templates/remove_for_user(templates_remove_for_user_body payload, TemplatesRemoveForUserHeaders headers = {}) returns error? { + string resourcePath = string `/file_properties/templates/remove_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -286,16 +349,24 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns templates_remove_for_user_body|error { - string resourcePath = string `/2/file_properties/templates/update_for_team`; + # templates/update_for_team + # + # + headers - Headers to be sent with the request + # + return - templates/update_for_team response + resource isolated function post file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns templates_remove_for_user_body|error { + string resourcePath = string `/file_properties/templates/update_for_team`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns templates_remove_for_user_body|error { - string resourcePath = string `/2/file_properties/templates/update_for_user`; + # templates/update_for_user + # + # + headers - Headers to be sent with the request + # + return - templates/update_for_user response + resource isolated function post file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns templates_remove_for_user_body|error { + string resourcePath = string `/file_properties/templates/update_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -303,15 +374,23 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/count(CountHeaders headers = {}) returns inline_response_200_7|error { - string resourcePath = string `/2/file_requests/count`; + # count + # + # + headers - Headers to be sent with the request + # + return - count response + resource isolated function post file_requests/count(CountHeaders headers = {}) returns inline_response_200_7|error { + string resourcePath = string `/file_requests/count`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_8|error { - string resourcePath = string `/2/file_requests/create`; + # create + # + # + headers - Headers to be sent with the request + # + return - create response + resource isolated function post file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_8|error { + string resourcePath = string `/file_requests/create`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -319,8 +398,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_9|error { - string resourcePath = string `/2/file_requests/delete`; + # delete + # + # + headers - Headers to be sent with the request + # + return - delete response + resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_9|error { + string resourcePath = string `/file_requests/delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -328,15 +411,23 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_9|error { - string resourcePath = string `/2/file_requests/delete_all_closed`; + # delete_all_closed + # + # + headers - Headers to be sent with the request + # + return - delete_all_closed response + resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_9|error { + string resourcePath = string `/file_requests/delete_all_closed`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_8|error { - string resourcePath = string `/2/file_requests/get`; + # get + # + # + headers - Headers to be sent with the request + # + return - get response + resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_8|error { + string resourcePath = string `/file_requests/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -344,8 +435,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_10|error { - string resourcePath = string `/2/file_requests/list/continue`; + resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_10|error { + string resourcePath = string `/file_requests/list/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -353,8 +444,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_10|error { - string resourcePath = string `/2/file_requests/list_v2`; + # list + # + # + headers - Headers to be sent with the request + # + return - list response + resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_10|error { + string resourcePath = string `/file_requests/list_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -362,8 +457,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_8|error { - string resourcePath = string `/2/file_requests/update`; + # update + # + # + headers - Headers to be sent with the request + # + return - update response + resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_8|error { + string resourcePath = string `/file_requests/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -371,8 +470,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_12|error { - string resourcePath = string `/2/files/copy_batch/check_v2`; + # copy_batch/check + # + # + headers - Headers to be sent with the request + # + return - copy_batch/check response + resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_12|error { + string resourcePath = string `/files/copy_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -380,8 +483,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_12|error { - string resourcePath = string `/2/files/copy_batch_v2`; + # copy_batch + # + # + headers - Headers to be sent with the request + # + return - copy_batch response + resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_12|error { + string resourcePath = string `/files/copy_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -389,8 +496,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_13|error { - string resourcePath = string `/2/files/copy_reference/get`; + # copy_reference/get + # + # + headers - Headers to be sent with the request + # + return - copy_reference/get response + resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_13|error { + string resourcePath = string `/files/copy_reference/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -398,8 +509,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_11|error { - string resourcePath = string `/2/files/copy_reference/save`; + # copy_reference/save + # + # + headers - Headers to be sent with the request + # + return - copy_reference/save response + resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_11|error { + string resourcePath = string `/files/copy_reference/save`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -407,8 +522,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_11|error { - string resourcePath = string `/2/files/copy_v2`; + # copy + # + # + headers - Headers to be sent with the request + # + return - copy response + resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_11|error { + string resourcePath = string `/files/copy_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -416,8 +535,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_15|error { - string resourcePath = string `/2/files/create_folder_batch`; + # create_folder_batch + # + # + headers - Headers to be sent with the request + # + return - create_folder_batch response + resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_15|error { + string resourcePath = string `/files/create_folder_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -425,8 +548,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_15|error { - string resourcePath = string `/2/files/create_folder_batch/check`; + resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_15|error { + string resourcePath = string `/files/create_folder_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -434,8 +557,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_14|error { - string resourcePath = string `/2/files/create_folder_v2`; + # create_folder + # + # + headers - Headers to be sent with the request + # + return - create_folder response + resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_14|error { + string resourcePath = string `/files/create_folder_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -443,8 +570,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_16|error { - string resourcePath = string `/2/files/delete_batch`; + # delete_batch + # + # + headers - Headers to be sent with the request + # + return - delete_batch response + resource isolated function post files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_16|error { + string resourcePath = string `/files/delete_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -452,8 +583,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_16|error { - string resourcePath = string `/2/files/delete_batch/check`; + resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_16|error { + string resourcePath = string `/files/delete_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -461,8 +592,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_11|error { - string resourcePath = string `/2/files/delete_v2`; + # delete + # + # + headers - Headers to be sent with the request + # + return - delete response + resource isolated function post files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_11|error { + string resourcePath = string `/files/delete_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -470,29 +605,45 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/download(DownloadHeaders headers = {}) returns inline_response_200_17|error { - string resourcePath = string `/2/files/download`; + # download + # + # + headers - Headers to be sent with the request + # + return - download response + resource isolated function post files/download(DownloadHeaders headers = {}) returns inline_response_200_17|error { + string resourcePath = string `/files/download`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_14|error { - string resourcePath = string `/2/files/download_zip`; + # download_zip + # + # + headers - Headers to be sent with the request + # + return - download_zip response + resource isolated function post files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_14|error { + string resourcePath = string `/files/download_zip`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/export(ExportHeaders headers = {}) returns inline_response_200_18|error { - string resourcePath = string `/2/files/export`; + # export + # + # + headers - Headers to be sent with the request + # + return - export response + resource isolated function post files/export(ExportHeaders headers = {}) returns inline_response_200_18|error { + string resourcePath = string `/files/export`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_19|error { - string resourcePath = string `/2/files/get_file_lock_batch`; + # get_file_lock_batch + # + # + headers - Headers to be sent with the request + # + return - get_file_lock_batch response + resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_19|error { + string resourcePath = string `/files/get_file_lock_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -500,8 +651,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_20|error { - string resourcePath = string `/2/files/get_metadata`; + # get_metadata + # + # + headers - Headers to be sent with the request + # + return - get_metadata response + resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_20|error { + string resourcePath = string `/files/get_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -509,15 +664,23 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_17|error { - string resourcePath = string `/2/files/get_preview`; + # get_preview + # + # + headers - Headers to be sent with the request + # + return - get_preview response + resource isolated function post files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_17|error { + string resourcePath = string `/files/get_preview`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_21|error { - string resourcePath = string `/2/files/get_temporary_link`; + # get_temporary_link + # + # + headers - Headers to be sent with the request + # + return - get_temporary_link response + resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_21|error { + string resourcePath = string `/files/get_temporary_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -525,8 +688,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_22|error { - string resourcePath = string `/2/files/get_temporary_upload_link`; + # get_temporary_upload_link + # + # + headers - Headers to be sent with the request + # + return - get_temporary_upload_link response + resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_22|error { + string resourcePath = string `/files/get_temporary_upload_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -534,8 +701,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_24|error { - string resourcePath = string `/2/files/get_thumbnail_batch`; + # get_thumbnail_batch + # + # + headers - Headers to be sent with the request + # + return - get_thumbnail_batch response + resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_24|error { + string resourcePath = string `/files/get_thumbnail_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -543,15 +714,23 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_23|error { - string resourcePath = string `/2/files/get_thumbnail_v2`; + # get_thumbnail + # + # + headers - Headers to be sent with the request + # + return - get_thumbnail response + resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_23|error { + string resourcePath = string `/files/get_thumbnail_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_25|error { - string resourcePath = string `/2/files/list_folder`; + # list_folder + # + # + headers - Headers to be sent with the request + # + return - list_folder response + resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_25|error { + string resourcePath = string `/files/list_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -559,8 +738,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_25|error { - string resourcePath = string `/2/files/list_folder/continue`; + resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_25|error { + string resourcePath = string `/files/list_folder/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -568,8 +747,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder/get_latest_cursor(list_folder_get_latest_cursor_body payload, ListFolderGetLatestCursorHeaders headers = {}) returns list_folder_continue_body|error { - string resourcePath = string `/2/files/list_folder/get_latest_cursor`; + # list_folder/get_latest_cursor + # + # + headers - Headers to be sent with the request + # + return - list_folder/get_latest_cursor response + resource isolated function post files/list_folder/get_latest_cursor(list_folder_get_latest_cursor_body payload, ListFolderGetLatestCursorHeaders headers = {}) returns list_folder_continue_body|error { + string resourcePath = string `/files/list_folder/get_latest_cursor`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -577,8 +760,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_26|error { - string resourcePath = string `/2/files/list_folder/longpoll`; + # list_folder/longpoll + # + # + headers - Headers to be sent with the request + # + return - list_folder/longpoll response + resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_26|error { + string resourcePath = string `/files/list_folder/longpoll`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -586,8 +773,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_27|error { - string resourcePath = string `/2/files/list_revisions`; + # list_revisions + # + # + headers - Headers to be sent with the request + # + return - list_revisions response + resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_27|error { + string resourcePath = string `/files/list_revisions`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -595,8 +786,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_19|error { - string resourcePath = string `/2/files/lock_file_batch`; + # lock_file_batch + # + # + headers - Headers to be sent with the request + # + return - lock_file_batch response + resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_19|error { + string resourcePath = string `/files/lock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -604,8 +799,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_12|error { - string resourcePath = string `/2/files/move_batch/check_v2`; + # move_batch/check + # + # + headers - Headers to be sent with the request + # + return - move_batch/check response + resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_12|error { + string resourcePath = string `/files/move_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -613,8 +812,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_12|error { - string resourcePath = string `/2/files/move_batch_v2`; + # move_batch + # + # + headers - Headers to be sent with the request + # + return - move_batch response + resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_12|error { + string resourcePath = string `/files/move_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -622,8 +825,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_11|error { - string resourcePath = string `/2/files/move_v2`; + # move + # + # + headers - Headers to be sent with the request + # + return - move response + resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_11|error { + string resourcePath = string `/files/move_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -631,8 +838,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/permanently_delete(files_permanently_delete_body payload, PermanentlyDeleteHeaders headers = {}) returns error? { - string resourcePath = string `/2/files/permanently_delete`; + # permanently_delete + # + # + headers - Headers to be sent with the request + resource isolated function post files/permanently_delete(files_permanently_delete_body payload, PermanentlyDeleteHeaders headers = {}) returns error? { + string resourcePath = string `/files/permanently_delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -640,8 +850,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_17|error { - string resourcePath = string `/2/files/restore`; + # restore + # + # + headers - Headers to be sent with the request + # + return - restore response + resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_17|error { + string resourcePath = string `/files/restore`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -649,8 +863,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_28|error { - string resourcePath = string `/2/files/save_url`; + # save_url + # + # + headers - Headers to be sent with the request + # + return - save_url response + resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_28|error { + string resourcePath = string `/files/save_url`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -658,8 +876,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { - string resourcePath = string `/2/files/save_url/check_job_status`; + # save_url/check_job_status + # + # + headers - Headers to be sent with the request + # + return - save_url/check_job_status response + resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { + string resourcePath = string `/files/save_url/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -667,8 +889,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_30|error { - string resourcePath = string `/2/files/search/continue_v2`; + # search/continue + # + # + headers - Headers to be sent with the request + # + return - search/continue response + resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_30|error { + string resourcePath = string `/files/search/continue_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -676,8 +902,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_30|error { - string resourcePath = string `/2/files/search_v2`; + # search + # + # + headers - Headers to be sent with the request + # + return - search response + resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_30|error { + string resourcePath = string `/files/search_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -685,8 +915,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_19|error { - string resourcePath = string `/2/files/unlock_file_batch`; + # unlock_file_batch + # + # + headers - Headers to be sent with the request + # + return - unlock_file_batch response + resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_19|error { + string resourcePath = string `/files/unlock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -694,36 +928,51 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload(UploadHeaders headers = {}) returns inline_response_200_17|error { - string resourcePath = string `/2/files/upload`; + # upload + # + # + headers - Headers to be sent with the request + # + return - upload response + resource isolated function post files/upload(UploadHeaders headers = {}) returns inline_response_200_17|error { + string resourcePath = string `/files/upload`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_32|error { - string resourcePath = string `/2/files/upload_session/start`; + resource isolated function post files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_32|error { + string resourcePath = string `/files/upload_session/start`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/append_v2(UploadSessionAppendHeaders headers = {}) returns error? { - string resourcePath = string `/2/files/upload_session/append_v2`; + # upload_session/append + # + # + headers - Headers to be sent with the request + resource isolated function post files/upload_session/append_v2(UploadSessionAppendHeaders headers = {}) returns error? { + string resourcePath = string `/files/upload_session/append_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_17|error { - string resourcePath = string `/2/files/upload_session/finish`; + # upload_session/finish + # + # + headers - Headers to be sent with the request + # + return - upload_session/finish response + resource isolated function post files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_17|error { + string resourcePath = string `/files/upload_session/finish`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_31|error { - string resourcePath = string `/2/files/upload_session/finish_batch`; + # upload_session/finish_batch + # + # + headers - Headers to be sent with the request + # + return - upload_session/finish_batch response + resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_31|error { + string resourcePath = string `/files/upload_session/finish_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -731,8 +980,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_31|error { - string resourcePath = string `/2/files/upload_session/finish_batch/check`; + resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_31|error { + string resourcePath = string `/files/upload_session/finish_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -740,8 +989,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_33[]|error { - string resourcePath = string `/2/sharing/add_file_member`; + # add_file_member + # + # + headers - Headers to be sent with the request + # + return - add_file_member response + resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_33[]|error { + string resourcePath = string `/sharing/add_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -749,8 +1002,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/add_folder_member(sharing_add_folder_member_body payload, AddFolderMemberHeaders headers = {}) returns error? { - string resourcePath = string `/2/sharing/add_folder_member`; + # add_folder_member + # + # + headers - Headers to be sent with the request + resource isolated function post sharing/add_folder_member(sharing_add_folder_member_body payload, AddFolderMemberHeaders headers = {}) returns error? { + string resourcePath = string `/sharing/add_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -758,8 +1014,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { - string resourcePath = string `/2/sharing/check_job_status`; + # check_job_status + # + # + headers - Headers to be sent with the request + # + return - check_job_status response + resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { + string resourcePath = string `/sharing/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -767,8 +1027,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/sharing/check_remove_member_job_status`; + # check_remove_member_job_status + # + # + headers - Headers to be sent with the request + # + return - check_remove_member_job_status response + resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/sharing/check_remove_member_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -776,8 +1040,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_35|error { - string resourcePath = string `/2/sharing/check_share_job_status`; + # check_share_job_status + # + # + headers - Headers to be sent with the request + # + return - check_share_job_status response + resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_35|error { + string resourcePath = string `/sharing/check_share_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -785,8 +1053,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_36|error { - string resourcePath = string `/2/sharing/get_file_metadata`; + # get_file_metadata + # + # + headers - Headers to be sent with the request + # + return - get_file_metadata response + resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_36|error { + string resourcePath = string `/sharing/get_file_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -794,8 +1066,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_37[]|error { - string resourcePath = string `/2/sharing/get_file_metadata/batch`; + # get_file_metadata/batch + # + # + headers - Headers to be sent with the request + # + return - get_file_metadata/batch response + resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_37[]|error { + string resourcePath = string `/sharing/get_file_metadata/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -803,8 +1079,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_38|error { - string resourcePath = string `/2/sharing/get_folder_metadata`; + # get_folder_metadata + # + # + headers - Headers to be sent with the request + # + return - get_folder_metadata response + resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_38|error { + string resourcePath = string `/sharing/get_folder_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -812,15 +1092,23 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_39|error { - string resourcePath = string `/2/sharing/get_shared_link_file`; + # get_shared_link_file + # + # + headers - Headers to be sent with the request + # + return - get_shared_link_file response + resource isolated function post sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_39|error { + string resourcePath = string `/sharing/get_shared_link_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_39|error { - string resourcePath = string `/2/sharing/get_shared_link_metadata`; + # get_shared_link_metadata + # + # + headers - Headers to be sent with the request + # + return - get_shared_link_metadata response + resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_39|error { + string resourcePath = string `/sharing/get_shared_link_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -828,8 +1116,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_40|error { - string resourcePath = string `/2/sharing/list_file_members`; + # list_file_members + # + # + headers - Headers to be sent with the request + # + return - list_file_members response + resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_40|error { + string resourcePath = string `/sharing/list_file_members`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -837,8 +1129,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_40|error { - string resourcePath = string `/2/sharing/list_file_members/continue`; + resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_40|error { + string resourcePath = string `/sharing/list_file_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -846,8 +1138,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_41[]|error { - string resourcePath = string `/2/sharing/list_file_members/batch`; + # list_file_members/batch + # + # + headers - Headers to be sent with the request + # + return - list_file_members/batch response + resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_41[]|error { + string resourcePath = string `/sharing/list_file_members/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -855,8 +1151,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_42|error { - string resourcePath = string `/2/sharing/list_folder_members/continue`; + resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_42|error { + string resourcePath = string `/sharing/list_folder_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -864,8 +1160,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_43|error { - string resourcePath = string `/2/sharing/list_folders`; + # list_folders + # + # + headers - Headers to be sent with the request + # + return - list_folders response + resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_43|error { + string resourcePath = string `/sharing/list_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -873,8 +1173,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { - string resourcePath = string `/2/sharing/list_folders/continue`; + resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { + string resourcePath = string `/sharing/list_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -882,8 +1182,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_43|error { - string resourcePath = string `/2/sharing/list_mountable_folders`; + # list_mountable_folders + # + # + headers - Headers to be sent with the request + # + return - list_mountable_folders response + resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_43|error { + string resourcePath = string `/sharing/list_mountable_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -891,8 +1195,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { - string resourcePath = string `/2/sharing/list_mountable_folders/continue`; + resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { + string resourcePath = string `/sharing/list_mountable_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -900,8 +1204,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_44|error { - string resourcePath = string `/2/sharing/list_received_files`; + # list_received_files + # + # + headers - Headers to be sent with the request + # + return - list_received_files response + resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_44|error { + string resourcePath = string `/sharing/list_received_files`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -909,8 +1217,8 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_44|error { - string resourcePath = string `/2/sharing/list_received_files/continue`; + resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_44|error { + string resourcePath = string `/sharing/list_received_files/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -918,8 +1226,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_45|error { - string resourcePath = string `/2/sharing/list_shared_links`; + # list_shared_links + # + # + headers - Headers to be sent with the request + # + return - list_shared_links response + resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_45|error { + string resourcePath = string `/sharing/list_shared_links`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -927,8 +1239,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_39|error { - string resourcePath = string `/2/sharing/modify_shared_link_settings`; + # modify_shared_link_settings + # + # + headers - Headers to be sent with the request + # + return - modify_shared_link_settings response + resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_39|error { + string resourcePath = string `/sharing/modify_shared_link_settings`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -936,8 +1252,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_38|error { - string resourcePath = string `/2/sharing/mount_folder`; + # mount_folder + # + # + headers - Headers to be sent with the request + # + return - mount_folder response + resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_38|error { + string resourcePath = string `/sharing/mount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -945,8 +1265,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/relinquish_file_membership(sharing_relinquish_file_membership_body payload, RelinquishFileMembershipHeaders headers = {}) returns error? { - string resourcePath = string `/2/sharing/relinquish_file_membership`; + # relinquish_file_membership + # + # + headers - Headers to be sent with the request + resource isolated function post sharing/relinquish_file_membership(sharing_relinquish_file_membership_body payload, RelinquishFileMembershipHeaders headers = {}) returns error? { + string resourcePath = string `/sharing/relinquish_file_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -954,8 +1277,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/sharing/relinquish_folder_membership`; + # relinquish_folder_membership + # + # + headers - Headers to be sent with the request + # + return - relinquish_folder_membership response + resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/sharing/relinquish_folder_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -963,8 +1290,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_46|error { - string resourcePath = string `/2/sharing/remove_file_member_2`; + # remove_file_member_2 + # + # + headers - Headers to be sent with the request + # + return - remove_file_member_2 response + resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_46|error { + string resourcePath = string `/sharing/remove_file_member_2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -972,8 +1303,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_47|error { - string resourcePath = string `/2/sharing/remove_folder_member`; + # remove_folder_member + # + # + headers - Headers to be sent with the request + # + return - remove_folder_member response + resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_47|error { + string resourcePath = string `/sharing/remove_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -981,8 +1316,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/revoke_shared_link(sharing_revoke_shared_link_body payload, RevokeSharedLinkHeaders headers = {}) returns error? { - string resourcePath = string `/2/sharing/revoke_shared_link`; + # revoke_shared_link + # + # + headers - Headers to be sent with the request + resource isolated function post sharing/revoke_shared_link(sharing_revoke_shared_link_body payload, RevokeSharedLinkHeaders headers = {}) returns error? { + string resourcePath = string `/sharing/revoke_shared_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -990,8 +1328,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_35|error { - string resourcePath = string `/2/sharing/set_access_inheritance`; + # set_access_inheritance + # + # + headers - Headers to be sent with the request + # + return - set_access_inheritance response + resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_35|error { + string resourcePath = string `/sharing/set_access_inheritance`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -999,8 +1341,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_35|error { - string resourcePath = string `/2/sharing/share_folder`; + # share_folder + # + # + headers - Headers to be sent with the request + # + return - share_folder response + resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_35|error { + string resourcePath = string `/sharing/share_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1008,8 +1354,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/transfer_folder(sharing_transfer_folder_body payload, TransferFolderHeaders headers = {}) returns error? { - string resourcePath = string `/2/sharing/transfer_folder`; + # transfer_folder + # + # + headers - Headers to be sent with the request + resource isolated function post sharing/transfer_folder(sharing_transfer_folder_body payload, TransferFolderHeaders headers = {}) returns error? { + string resourcePath = string `/sharing/transfer_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1017,8 +1366,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/unmount_folder(sharing_unmount_folder_body payload, UnmountFolderHeaders headers = {}) returns error? { - string resourcePath = string `/2/sharing/unmount_folder`; + # unmount_folder + # + # + headers - Headers to be sent with the request + resource isolated function post sharing/unmount_folder(sharing_unmount_folder_body payload, UnmountFolderHeaders headers = {}) returns error? { + string resourcePath = string `/sharing/unmount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1026,8 +1378,11 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/unshare_file(sharing_unshare_file_body payload, UnshareFileHeaders headers = {}) returns error? { - string resourcePath = string `/2/sharing/unshare_file`; + # unshare_file + # + # + headers - Headers to be sent with the request + resource isolated function post sharing/unshare_file(sharing_unshare_file_body payload, UnshareFileHeaders headers = {}) returns error? { + string resourcePath = string `/sharing/unshare_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1035,8 +1390,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/sharing/unshare_folder`; + # unshare_folder + # + # + headers - Headers to be sent with the request + # + return - unshare_folder response + resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/sharing/unshare_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1044,8 +1403,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/update_file_member(sharing_update_file_member_body payload, UpdateFileMemberHeaders headers = {}) returns record {}|error { - string resourcePath = string `/2/sharing/update_file_member`; + # update_file_member + # + # + headers - Headers to be sent with the request + # + return - update_file_member response + resource isolated function post sharing/update_file_member(sharing_update_file_member_body payload, UpdateFileMemberHeaders headers = {}) returns record {}|error { + string resourcePath = string `/sharing/update_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1053,8 +1416,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/update_folder_member(sharing_update_folder_member_body payload, UpdateFolderMemberHeaders headers = {}) returns record {}|error { - string resourcePath = string `/2/sharing/update_folder_member`; + # update_folder_member + # + # + headers - Headers to be sent with the request + # + return - update_folder_member response + resource isolated function post sharing/update_folder_member(sharing_update_folder_member_body payload, UpdateFolderMemberHeaders headers = {}) returns record {}|error { + string resourcePath = string `/sharing/update_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1062,8 +1429,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_38|error { - string resourcePath = string `/2/sharing/update_folder_policy`; + # update_folder_policy + # + # + headers - Headers to be sent with the request + # + return - update_folder_policy response + resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_38|error { + string resourcePath = string `/sharing/update_folder_policy`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1071,596 +1442,845 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/team/devices/list_member_devices(devices_list_member_devices_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/devices/list_member_devices`; + # devices/list_member_devices + # + # + headers - Headers to be sent with the request + resource isolated function post team/devices/list_member_devices(devices_list_member_devices_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/devices/list_member_devices`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/devices/list_members_devices(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/devices/list_members_devices`; + # devices/list_members_devices + # + # + headers - Headers to be sent with the request + resource isolated function post team/devices/list_members_devices(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/devices/list_members_devices`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/devices/revoke_device_session(devices_revoke_device_session_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/devices/revoke_device_session`; + # devices/revoke_device_session + # + # + headers - Headers to be sent with the request + resource isolated function post team/devices/revoke_device_session(devices_revoke_device_session_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/devices/revoke_device_session`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/devices/revoke_device_session_batch(devices_revoke_device_session_batch_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/devices/revoke_device_session_batch`; + # devices/revoke_device_session_batch + # + # + headers - Headers to be sent with the request + resource isolated function post team/devices/revoke_device_session_batch(devices_revoke_device_session_batch_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/devices/revoke_device_session_batch`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_70|error { - string resourcePath = string `/2/team/features/get_values`; + # features/get_values + # + # + headers - Headers to be sent with the request + # + return - features/get_values response + resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_70|error { + string resourcePath = string `/team/features/get_values`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/get_info(map headers = {}) returns inline_response_200_71|error { - string resourcePath = string `/2/team/get_info`; + # get_info + # + # + headers - Headers to be sent with the request + # + return - get_info response + resource isolated function post team/get_info(map headers = {}) returns inline_response_200_71|error { + string resourcePath = string `/team/get_info`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_48|error { - string resourcePath = string `/2/team/groups/create`; + # groups/create + # + # + headers - Headers to be sent with the request + # + return - groups/create response + resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_48|error { + string resourcePath = string `/team/groups/create`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/team/groups/delete`; + # groups/delete + # + # + headers - Headers to be sent with the request + # + return - groups/delete response + resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/team/groups/delete`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_49[]|error { - string resourcePath = string `/2/team/groups/get_info`; + # groups/get_info + # + # + headers - Headers to be sent with the request + # + return - groups/get_info response + resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_49[]|error { + string resourcePath = string `/team/groups/get_info`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/team/groups/job_status/get`; + # groups/job_status/get + # + # + headers - Headers to be sent with the request + # + return - groups/job_status/get response + resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/team/groups/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_50|error { - string resourcePath = string `/2/team/groups/list`; + # groups/list + # + # + headers - Headers to be sent with the request + # + return - groups/list response + resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_50|error { + string resourcePath = string `/team/groups/list`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_50|error { - string resourcePath = string `/2/team/groups/list/continue`; + resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_50|error { + string resourcePath = string `/team/groups/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_51|error { - string resourcePath = string `/2/team/groups/members/add`; + # groups/members/add + # + # + headers - Headers to be sent with the request + # + return - groups/members/add response + resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_51|error { + string resourcePath = string `/team/groups/members/add`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_52|error { - string resourcePath = string `/2/team/groups/members/list`; + # groups/members/list + # + # + headers - Headers to be sent with the request + # + return - groups/members/list response + resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_52|error { + string resourcePath = string `/team/groups/members/list`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_52|error { - string resourcePath = string `/2/team/groups/members/list/continue`; + resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_52|error { + string resourcePath = string `/team/groups/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_51|error { - string resourcePath = string `/2/team/groups/members/remove`; + # groups/members/remove + # + # + headers - Headers to be sent with the request + # + return - groups/members/remove response + resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_51|error { + string resourcePath = string `/team/groups/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_49[]|error { - string resourcePath = string `/2/team/groups/members/set_access_type`; + # groups/members/set_access_type + # + # + headers - Headers to be sent with the request + # + return - groups/members/set_access_type response + resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_49[]|error { + string resourcePath = string `/team/groups/members/set_access_type`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_48|error { - string resourcePath = string `/2/team/groups/update`; + # groups/update + # + # + headers - Headers to be sent with the request + # + return - groups/update response + resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_48|error { + string resourcePath = string `/team/groups/update`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_53|error { - string resourcePath = string `/2/team/legal_holds/create_policy`; + # legal_holds/create_policy + # + # + headers - Headers to be sent with the request + # + return - legal_holds/create_policy response + resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_53|error { + string resourcePath = string `/team/legal_holds/create_policy`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_53|error { - string resourcePath = string `/2/team/legal_holds/get_policy`; + # legal_holds/get_policy + # + # + headers - Headers to be sent with the request + # + return - legal_holds/get_policy response + resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_53|error { + string resourcePath = string `/team/legal_holds/get_policy`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_54|error { - string resourcePath = string `/2/team/legal_holds/list_held_revisions`; + # legal_holds/list_held_revisions + # + # + headers - Headers to be sent with the request + # + return - legal_holds/list_held_revisions response + resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_54|error { + string resourcePath = string `/team/legal_holds/list_held_revisions`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_54|error { - string resourcePath = string `/2/team/legal_holds/list_held_revisions_continue`; + # legal_holds/list_held_revisions_continue + # + # + headers - Headers to be sent with the request + # + return - legal_holds/list_held_revisions_continue response + resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_54|error { + string resourcePath = string `/team/legal_holds/list_held_revisions_continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_55|error { - string resourcePath = string `/2/team/legal_holds/list_policies`; + # legal_holds/list_policies + # + # + headers - Headers to be sent with the request + # + return - legal_holds/list_policies response + resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_55|error { + string resourcePath = string `/team/legal_holds/list_policies`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/release_policy(legal_holds_release_policy_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/legal_holds/release_policy`; + # legal_holds/release_policy + # + # + headers - Headers to be sent with the request + resource isolated function post team/legal_holds/release_policy(legal_holds_release_policy_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/legal_holds/release_policy`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_53|error { - string resourcePath = string `/2/team/legal_holds/update_policy`; + # legal_holds/update_policy + # + # + headers - Headers to be sent with the request + # + return - legal_holds/update_policy response + resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_53|error { + string resourcePath = string `/team/legal_holds/update_policy`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/list_member_linked_apps(linked_apps_list_member_linked_apps_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/linked_apps/list_member_linked_apps`; + # linked_apps/list_member_linked_apps + # + # + headers - Headers to be sent with the request + resource isolated function post team/linked_apps/list_member_linked_apps(linked_apps_list_member_linked_apps_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/linked_apps/list_member_linked_apps`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/list_members_linked_apps(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/linked_apps/list_members_linked_apps`; + # linked_apps/list_members_linked_apps + # + # + headers - Headers to be sent with the request + resource isolated function post team/linked_apps/list_members_linked_apps(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/linked_apps/list_members_linked_apps`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/revoke_linked_app(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/linked_apps/revoke_linked_app`; + # linked_apps/revoke_linked_app + # + # + headers - Headers to be sent with the request + resource isolated function post team/linked_apps/revoke_linked_app(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/linked_apps/revoke_linked_app`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/linked_apps/revoke_linked_app_batch(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/linked_apps/revoke_linked_app_batch`; + # linked_apps/revoke_linked_app_batch + # + # + headers - Headers to be sent with the request + resource isolated function post team/linked_apps/revoke_linked_app_batch(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/linked_apps/revoke_linked_app_batch`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_56|error { - string resourcePath = string `/2/team/member_space_limits/excluded_users/add`; + # member_space_limits/excluded_users/add + # + # + headers - Headers to be sent with the request + # + return - member_space_limits/excluded_users/add response + resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_56|error { + string resourcePath = string `/team/member_space_limits/excluded_users/add`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_57|error { - string resourcePath = string `/2/team/member_space_limits/excluded_users/list`; + # member_space_limits/excluded_users/list + # + # + headers - Headers to be sent with the request + # + return - member_space_limits/excluded_users/list response + resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_57|error { + string resourcePath = string `/team/member_space_limits/excluded_users/list`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_57|error { - string resourcePath = string `/2/team/member_space_limits/excluded_users/list/continue`; + resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_57|error { + string resourcePath = string `/team/member_space_limits/excluded_users/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_56|error { - string resourcePath = string `/2/team/member_space_limits/excluded_users/remove`; + # member_space_limits/excluded_users/remove + # + # + headers - Headers to be sent with the request + # + return - member_space_limits/excluded_users/remove response + resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_56|error { + string resourcePath = string `/team/member_space_limits/excluded_users/remove`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { - string resourcePath = string `/2/team/member_space_limits/get_custom_quota`; + # member_space_limits/get_custom_quota + # + # + headers - Headers to be sent with the request + # + return - member_space_limits/get_custom_quota response + resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + string resourcePath = string `/team/member_space_limits/get_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { - string resourcePath = string `/2/team/member_space_limits/remove_custom_quota`; + # member_space_limits/remove_custom_quota + # + # + headers - Headers to be sent with the request + # + return - member_space_limits/remove_custom_quota response + resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + string resourcePath = string `/team/member_space_limits/remove_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { - string resourcePath = string `/2/team/member_space_limits/set_custom_quota`; + # member_space_limits/set_custom_quota + # + # + headers - Headers to be sent with the request + # + return - member_space_limits/set_custom_quota response + resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + string resourcePath = string `/team/member_space_limits/set_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_58|error { - string resourcePath = string `/2/team/members/add`; + # members/add + # + # + headers - Headers to be sent with the request + # + return - members/add response + resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_58|error { + string resourcePath = string `/team/members/add`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_58|error { - string resourcePath = string `/2/team/members/add/job_status/get`; + # members/add/job_status/get + # + # + headers - Headers to be sent with the request + # + return - members/add/job_status/get response + resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_58|error { + string resourcePath = string `/team/members/add/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { - string resourcePath = string `/2/team/members/delete_profile_photo`; + # members/delete_profile_photo + # + # + headers - Headers to be sent with the request + # + return - members/delete_profile_photo response + resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { + string resourcePath = string `/team/members/delete_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_60[]|error { - string resourcePath = string `/2/team/members/get_info`; + # members/get_info + # + # + headers - Headers to be sent with the request + # + return - members/get_info response + resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_60[]|error { + string resourcePath = string `/team/members/get_info`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_61|error { - string resourcePath = string `/2/team/members/list`; + # members/list + # + # + headers - Headers to be sent with the request + # + return - members/list response + resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_61|error { + string resourcePath = string `/team/members/list`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_61|error { - string resourcePath = string `/2/team/members/list/continue`; + resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_61|error { + string resourcePath = string `/team/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/team/members/move_former_member_files`; + # members/move_former_member_files + # + # + headers - Headers to be sent with the request + # + return - members/move_former_member_files response + resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/team/members/move_former_member_files`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/team/members/move_former_member_files/job_status/check`; + resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/team/members/move_former_member_files/job_status/check`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/recover(members_recover_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/members/recover`; + # members/recover + # + # + headers - Headers to be sent with the request + resource isolated function post team/members/recover(members_recover_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/members/recover`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/team/members/remove`; + # members/remove + # + # + headers - Headers to be sent with the request + # + return - members/remove response + resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/team/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_34|error { - string resourcePath = string `/2/team/members/remove/job_status/get`; + # members/remove/job_status/get + # + # + headers - Headers to be sent with the request + # + return - members/remove/job_status/get response + resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_34|error { + string resourcePath = string `/team/members/remove/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_62|error { - string resourcePath = string `/2/team/members/secondary_emails/add`; + # members/secondary_emails/add + # + # + headers - Headers to be sent with the request + # + return - members/secondary_emails/add response + resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_62|error { + string resourcePath = string `/team/members/secondary_emails/add`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_63|error { - string resourcePath = string `/2/team/members/secondary_emails/delete`; + # members/secondary_emails/delete + # + # + headers - Headers to be sent with the request + # + return - members/secondary_emails/delete response + resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_63|error { + string resourcePath = string `/team/members/secondary_emails/delete`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_64|error { - string resourcePath = string `/2/team/members/secondary_emails/resend_verification_emails`; + # members/secondary_emails/resend_verification_emails + # + # + headers - Headers to be sent with the request + # + return - members/secondary_emails/resend_verification_emails response + resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_64|error { + string resourcePath = string `/team/members/secondary_emails/resend_verification_emails`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/send_welcome_email(members_send_welcome_email_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/members/send_welcome_email`; + # members/send_welcome_email + # + # + headers - Headers to be sent with the request + resource isolated function post team/members/send_welcome_email(members_send_welcome_email_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/members/send_welcome_email`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_65|error { - string resourcePath = string `/2/team/members/set_admin_permissions`; + # members/set_admin_permissions + # + # + headers - Headers to be sent with the request + # + return - members/set_admin_permissions response + resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_65|error { + string resourcePath = string `/team/members/set_admin_permissions`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_59|error { - string resourcePath = string `/2/team/members/set_profile`; + # members/set_profile + # + # + headers - Headers to be sent with the request + # + return - members/set_profile response + resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_59|error { + string resourcePath = string `/team/members/set_profile`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { - string resourcePath = string `/2/team/members/set_profile_photo`; + # members/set_profile_photo + # + # + headers - Headers to be sent with the request + # + return - members/set_profile_photo response + resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { + string resourcePath = string `/team/members/set_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/suspend(members_suspend_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/members/suspend`; + # members/suspend + # + # + headers - Headers to be sent with the request + resource isolated function post team/members/suspend(members_suspend_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/members/suspend`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/members/unsuspend(members_unsuspend_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/members/unsuspend`; + # members/unsuspend + # + # + headers - Headers to be sent with the request + resource isolated function post team/members/unsuspend(members_unsuspend_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/members/unsuspend`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_66|error { - string resourcePath = string `/2/team/namespaces/list`; + # namespaces/list + # + # + headers - Headers to be sent with the request + # + return - namespaces/list response + resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_66|error { + string resourcePath = string `/team/namespaces/list`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_66|error { - string resourcePath = string `/2/team/namespaces/list/continue`; + resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_66|error { + string resourcePath = string `/team/namespaces/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_activity(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/reports/get_activity`; + # reports/get_activity + # + # + headers - Headers to be sent with the request + resource isolated function post team/reports/get_activity(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/reports/get_activity`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_devices(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/reports/get_devices`; + # reports/get_devices + # + # + headers - Headers to be sent with the request + resource isolated function post team/reports/get_devices(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/reports/get_devices`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_membership(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/reports/get_membership`; + # reports/get_membership + # + # + headers - Headers to be sent with the request + resource isolated function post team/reports/get_membership(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/reports/get_membership`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/reports/get_storage(string payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/reports/get_storage`; + # reports/get_storage + # + # + headers - Headers to be sent with the request + resource isolated function post team/reports/get_storage(string payload, map headers = {}) returns error? { + string resourcePath = string `/team/reports/get_storage`; http:Request request = new; request.setPayload(payload, "text/plain"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_67|error { - string resourcePath = string `/2/team/team_folder/activate`; + # team_folder/activate + # + # + headers - Headers to be sent with the request + # + return - team_folder/activate response + resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_67|error { + string resourcePath = string `/team/team_folder/activate`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_68|error { - string resourcePath = string `/2/team/team_folder/archive`; + # team_folder/archive + # + # + headers - Headers to be sent with the request + # + return - team_folder/archive response + resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_68|error { + string resourcePath = string `/team/team_folder/archive`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_68|error { - string resourcePath = string `/2/team/team_folder/archive/check`; + resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_68|error { + string resourcePath = string `/team/team_folder/archive/check`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_67|error { - string resourcePath = string `/2/team/team_folder/create`; + # team_folder/create + # + # + headers - Headers to be sent with the request + # + return - team_folder/create response + resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_67|error { + string resourcePath = string `/team/team_folder/create`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/get_info(team_folder_get_info_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/team_folder/get_info`; + # team_folder/get_info + # + # + headers - Headers to be sent with the request + resource isolated function post team/team_folder/get_info(team_folder_get_info_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/team_folder/get_info`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_69|error { - string resourcePath = string `/2/team/team_folder/list`; + # team_folder/list + # + # + headers - Headers to be sent with the request + # + return - team_folder/list response + resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_69|error { + string resourcePath = string `/team/team_folder/list`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_69|error { - string resourcePath = string `/2/team/team_folder/list/continue`; + resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_69|error { + string resourcePath = string `/team/team_folder/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/permanently_delete(team_folder_permanently_delete_body payload, map headers = {}) returns error? { - string resourcePath = string `/2/team/team_folder/permanently_delete`; + # team_folder/permanently_delete + # + # + headers - Headers to be sent with the request + resource isolated function post team/team_folder/permanently_delete(team_folder_permanently_delete_body payload, map headers = {}) returns error? { + string resourcePath = string `/team/team_folder/permanently_delete`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_67|error { - string resourcePath = string `/2/team/team_folder/rename`; + # team_folder/rename + # + # + headers - Headers to be sent with the request + # + return - team_folder/rename response + resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_67|error { + string resourcePath = string `/team/team_folder/rename`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_67|error { - string resourcePath = string `/2/team/team_folder/update_sync_settings`; + # team_folder/update_sync_settings + # + # + headers - Headers to be sent with the request + # + return - team_folder/update_sync_settings response + resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_67|error { + string resourcePath = string `/team/team_folder/update_sync_settings`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_72|error { - string resourcePath = string `/2/team/token/get_authenticated_admin`; + # token/get_authenticated_admin + # + # + headers - Headers to be sent with the request + # + return - token/get_authenticated_admin response + resource isolated function post team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_72|error { + string resourcePath = string `/team/token/get_authenticated_admin`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_73|error { - string resourcePath = string `/2/team_log/get_events`; + # get_events + # + # + headers - Headers to be sent with the request + # + return - get_events response + resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_73|error { + string resourcePath = string `/team_log/get_events`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_73|error { - string resourcePath = string `/2/team_log/get_events/continue`; + resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_73|error { + string resourcePath = string `/team_log/get_events/continue`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post '2/users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_74|error { - string resourcePath = string `/2/users/features/get_values`; + # features/get_values + # + # + headers - Headers to be sent with the request + # + return - features/get_values response + resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_74|error { + string resourcePath = string `/users/features/get_values`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1668,8 +2288,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_75|error { - string resourcePath = string `/2/users/get_account`; + # get_account + # + # + headers - Headers to be sent with the request + # + return - get_account response + resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_75|error { + string resourcePath = string `/users/get_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1677,8 +2301,12 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_76[]|error { - string resourcePath = string `/2/users/get_account_batch`; + # get_account_batch + # + # + headers - Headers to be sent with the request + # + return - get_account_batch response + resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_76[]|error { + string resourcePath = string `/users/get_account_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; json jsonBody = payload.toJson(); @@ -1686,15 +2314,23 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_77|error { - string resourcePath = string `/2/users/get_current_account`; + # get_current_account + # + # + headers - Headers to be sent with the request + # + return - get_current_account response + resource isolated function post users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_77|error { + string resourcePath = string `/users/get_current_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post '2/users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_78|error { - string resourcePath = string `/2/users/get_space_usage`; + # get_space_usage + # + # + headers - Headers to be sent with the request + # + return - get_space_usage response + resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_78|error { + string resourcePath = string `/users/get_space_usage`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); diff --git a/ballerina/types.bal b/ballerina/types.bal index 71e06e7..1111b0b 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -49,8 +49,12 @@ public type ListContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2sharinglist_file_membersbatch_result_members_platform_type record { - string \.tag?; +public type sharinglist_file_membersbatch_result_members_user record { + string account_id?; + string display_name?; + string email?; + boolean same_team?; + string team_member_id?; }; public type inline_response_200_15_metadata_sharing_info record { @@ -73,15 +77,22 @@ public type inline_response_200_73_event_category record { string \.tag?; }; -public type '2sharinglist_file_membersbatch_result_members_invitee record { +public type file_propertiespropertiessearch_mode record { string \.tag?; - string email?; + string field_name?; +}; + +public type sharingget_file_metadatabatch_result_policy record { + sharingget_file_metadatabatch_result_policy_acl_update_policy acl_update_policy?; + sharingget_file_metadatabatch_result_policy_member_policy member_policy?; + sharingget_file_metadatabatch_result_policy_resolved_member_policy resolved_member_policy?; + sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; }; public type inline_response_200_39_team_member_info record { string display_name?; string member_id?; - '2sharingget_file_metadatabatch_result_owner_team team_info?; + sharingget_file_metadatabatch_result_owner_team team_info?; }; public type groups_create_body record { @@ -105,7 +116,7 @@ public type inline_response_200_21_metadata record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; inline_response_200_31_sharing_info sharing_info?; @@ -121,18 +132,17 @@ public type inline_response_200_73_path record { inline_response_200_73_path_namespace_relative namespace_relative?; }; -public type '2teamgroupsget_info_profile_secondary_emails record { - string email?; - boolean is_verified?; +public type teammemberssecondary_emailsadd_new_secondary_emails record { + string[] secondary_emails?; + teamgroupsmembersadd_user user?; }; -public type '2filesupload_sessionfinish_batch_cursor record { - decimal offset?; - string session_id?; +public type sharingadd_file_member_result record { + string \.tag?; }; public type member_space_limits_set_custom_quota_body record { - '2teammember_space_limitsset_custom_quota_users_and_quotas[] users_and_quotas?; + teammember_space_limitsset_custom_quota_users_and_quotas[] users_and_quotas?; }; # Represents the Headers record for the operation: moveBatch @@ -147,25 +157,27 @@ public type sharing_list_folders_body record { decimal 'limit?; }; +public type sharingget_file_metadatabatch_result_owner_team record { + string id?; + string name?; +}; + public type job_status_get_body_1 record { string async_job_id?; }; -public type job_status_get_body_2 record { - string async_job_id?; +public type sharinglist_file_membersbatch_result_members_group_group_management_type record { + string \.tag?; }; public type sharing_remove_folder_member_body record { boolean leave_a_copy?; - '2sharingadd_file_member_members member?; + sharingadd_file_member_members member?; string shared_folder_id?; }; -# Represents the Headers record for the operation: getSharedLinkFile -public type GetSharedLinkFileHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-arg?; - string? dropbox\-api\-select\-user?; +public type job_status_get_body_2 record { + string async_job_id?; }; public type files_search_v2_body record { @@ -173,6 +185,13 @@ public type files_search_v2_body record { string query?; }; +# Represents the Headers record for the operation: getSharedLinkFile +public type GetSharedLinkFileHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-arg?; + string? dropbox\-api\-select\-user?; +}; + # Represents the Headers record for the operation: setProfilePhoto public type SetProfilePhotoHeaders record { string? dropbox\-api\-path\-root?; @@ -183,18 +202,12 @@ public type templates_remove_for_team_body record { string template_id?; }; -public type '2file_requestsupdate_deadline record { - string \.tag?; - string allow_late_uploads?; - string deadline?; -}; - public type file_requests_get_body record { string id?; }; public type templates_update_for_user_body record { - '2file_propertiestemplatesadd_for_team_fields[] add_fields?; + file_propertiestemplatesadd_for_team_fields[] add_fields?; string description?; string name?; string template_id?; @@ -208,6 +221,13 @@ public type team_folder_permanently_delete_body record { string team_folder_id?; }; +public type sharinglist_file_membersbatch_result_members_groups record { + sharinglist_file_membersbatch_result_members_access_type access_type?; + sharinglist_file_membersbatch_result_members_group group?; + boolean is_inherited?; + anydata[] permissions?; +}; + public type files_list_folder_body record { boolean include_deleted?; boolean include_has_explicit_shared_members?; @@ -218,30 +238,23 @@ public type files_list_folder_body record { boolean recursive?; }; -public type sharing_list_shared_links_body record { - string cursor?; -}; - public type templates_update_for_team_body record { - '2file_propertiestemplatesadd_for_team_fields[] add_fields?; + file_propertiestemplatesadd_for_team_fields[] add_fields?; string description?; string name?; string template_id?; }; +public type sharing_list_shared_links_body record { + string cursor?; +}; + # Represents the Headers record for the operation: propertiesRemove public type PropertiesRemoveHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type '2sharinglist_file_membersbatch_result_members_invitees record { - '2sharingget_file_metadatabatch_result_access_type access_type?; - '2sharinglist_file_membersbatch_result_members_invitee invitee?; - boolean is_inherited?; - anydata[] permissions?; -}; - public type templates_remove_for_user_body record { string template_id?; }; @@ -260,20 +273,21 @@ public type ClientHttp1Settings record {| ProxyConfig proxy?; |}; -public type '2teammembersadd_new_members record { - string member_email?; - string member_external_id?; - string member_given_name?; - string member_surname?; - string role?; - boolean send_welcome_email?; +public type sharingadd_file_member_members record { + string \.tag?; + string email?; }; public type inline_response_200_42_users record { - '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inherited?; anydata[] permissions?; - '2sharinglist_file_membersbatch_result_members_user user?; + sharinglist_file_membersbatch_result_members_user user?; +}; + +public type teamteam_folderupdate_sync_settings_content_sync_settings record { + string id?; + string sync_setting?; }; # Represents the Headers record for the operation: getTemporaryLink @@ -284,15 +298,10 @@ public type GetTemporaryLinkHeaders record { public type sharing_update_folder_member_body record { string access_level?; - '2sharingadd_file_member_members member?; + sharingadd_file_member_members member?; string shared_folder_id?; }; -public type '2file_propertiespropertiesadd_property_groups record { - '2file_propertiespropertiesadd_fields[] fields?; - string template_id?; -}; - # Represents the Headers record for the operation: getThumbnailBatch public type GetThumbnailBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -300,30 +309,31 @@ public type GetThumbnailBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type sharingadd_folder_member_members record { + string access_level?; + sharingadd_folder_member_member member?; +}; + # Represents the Headers record for the operation: listFileMembersContinue public type ListFileMembersContinueHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_62_results record { - string \.tag?; - '2teamgroupsget_info_profile_secondary_emails success?; - string unavailable?; -}; - # Represents the Headers record for the operation: getTemporaryUploadLink public type GetTemporaryUploadLinkHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type '2sharingget_file_metadatabatch_result_policy_acl_update_policy record { +public type inline_response_200_62_results record { string \.tag?; + teamgroupsget_info_profile_secondary_emails success?; + string unavailable?; }; public type file_requests_update_body record { - '2file_requestsupdate_deadline deadline?; + file_requestsupdate_deadline deadline?; string destination?; string id?; boolean open?; @@ -331,12 +341,12 @@ public type file_requests_update_body record { }; public type secondary_emails_add_body record { - '2teammemberssecondary_emailsadd_new_secondary_emails[] new_secondary_emails?; + teammemberssecondary_emailsadd_new_secondary_emails[] new_secondary_emails?; }; public type sharing_add_folder_member_body record { string custom_message?; - '2sharingadd_folder_member_members[] members?; + sharingadd_folder_member_members[] members?; boolean quiet?; string shared_folder_id?; }; @@ -347,6 +357,10 @@ public type ListMountableFoldersContinueHeaders record { string? dropbox\-api\-select\-user?; }; +public type sharingget_file_metadatabatch_result_policy_acl_update_policy record { + string \.tag?; +}; + # Represents the Headers record for the operation: permanentlyDelete public type PermanentlyDeleteHeaders record { string? dropbox\-api\-path\-root?; @@ -358,10 +372,21 @@ public type get_events_continue_body record { string cursor?; }; +public type sharinglist_file_membersbatch_result_members record { + sharinglist_file_membersbatch_result_members_groups[] groups?; + sharinglist_file_membersbatch_result_members_invitees[] invitees?; + sharinglist_file_membersbatch_result_members_users[] users?; +}; + public type team_folder_list_body record { decimal 'limit?; }; +public type teamgroupsget_info_members record { + teamgroupsget_info_access_type access_type?; + teamgroupsget_info_profile profile?; +}; + public type list_folder_continue_body record { string cursor?; }; @@ -377,16 +402,16 @@ public type sharing_get_file_metadata_body record { string file?; }; +public type file_requests_delete_body record { + string[] ids?; +}; + # Represents the Headers record for the operation: listFolders public type ListFoldersHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type file_requests_delete_body record { - string[] ids?; -}; - public type members_set_profile_body record { string new_email?; string new_surname?; @@ -411,28 +436,22 @@ public type contacts_delete_manual_contacts_batch_body record { string[] email_addresses?; }; -public type '2sharingget_file_metadatabatch_result_policy_resolved_member_policy record { - string \.tag?; +public type filesget_file_lock_batch_entries record { + string path?; }; public type files_get_temporary_link_body record { string path?; }; -public type '2teamteam_folderupdate_sync_settings_content_sync_settings record { - string id?; - string sync_setting?; -}; - public type inline_response_200_74_paper_as_files record { string \.tag?; boolean enabled?; }; -public type '2sharingmodify_shared_link_settings_settings record { - string access?; - string audience?; - string requested_visibility?; +public type teamgroupsmembersadd_user record { + string \.tag?; + string team_member_id?; }; public type files_save_url_body record { @@ -444,13 +463,19 @@ public type archive_check_body record { string async_job_id?; }; -public type '2teamgroupsmembersadd_members record { - string access_type?; - '2teamgroupsmembersadd_user user?; +public type sharinglist_file_membersbatch_result_members_group record { + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_type?; + boolean is_member?; + boolean is_owner?; + decimal member_count?; + boolean same_team?; }; -public type '2teammembersget_info_role record { - string \.tag?; +public type excluded_users_list_body record { + decimal 'limit?; }; # Represents the Headers record for the operation: listFoldersContinue @@ -459,10 +484,6 @@ public type ListFoldersContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type excluded_users_list_body record { - decimal 'limit?; -}; - # Represents the Headers record for the operation: getCurrentAccount public type GetCurrentAccountHeaders record { string? dropbox\-api\-path\-root?; @@ -471,13 +492,11 @@ public type GetCurrentAccountHeaders record { }; public type member_space_limits_remove_custom_quota_body record { - '2teamgroupsmembersadd_user[] users?; + teamgroupsmembersadd_user[] users?; }; -# Represents the Headers record for the operation: propertiesUpdate -public type PropertiesUpdateHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; +public type files_get_thumbnail_batch_body record { + filesget_thumbnail_batch_entries[] entries?; }; public type list_continue_body record { @@ -489,8 +508,10 @@ public type sharing_get_folder_metadata_body record { string shared_folder_id?; }; -public type files_get_thumbnail_batch_body record { - '2filesget_thumbnail_batch_entries[] entries?; +# Represents the Headers record for the operation: propertiesUpdate +public type PropertiesUpdateHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; public type files_create_folder_v2_body record { @@ -531,10 +552,6 @@ public type members_suspend_body record { boolean wipe_data?; }; -public type '2usersfeaturesget_values_features record { - string \.tag?; -}; - # Represents the Headers record for the operation: propertiesSearch public type PropertiesSearchHeaders record { string? dropbox\-api\-path\-root?; @@ -548,11 +565,6 @@ public type legal_holds_create_policy_body record { string start_date?; }; -public type '2filesupload_sessionfinish_batch_entries record { - '2filesget_temporary_upload_link_commit_info 'commit?; - '2filesupload_sessionfinish_batch_cursor cursor?; -}; - # Represents the Headers record for the operation: move public type MoveHeaders record { string? dropbox\-api\-path\-root?; @@ -561,15 +573,15 @@ public type MoveHeaders record { }; public type inline_response_200_44_entries record { - '2sharingget_file_metadatabatch_result_access_type access_type?; + sharingget_file_metadatabatch_result_access_type access_type?; string id?; string name?; string[] owner_display_names?; - '2sharingget_file_metadatabatch_result_owner_team owner_team?; + sharingget_file_metadatabatch_result_owner_team owner_team?; string path_display?; string path_lower?; anydata[] permissions?; - '2sharingget_file_metadatabatch_result_policy policy?; + sharingget_file_metadatabatch_result_policy policy?; string preview_url?; string time_invited?; }; @@ -579,33 +591,34 @@ public type sharing_relinquish_folder_membership_body record { string shared_folder_id?; }; -public type '2filesget_thumbnail_batch_entries record { - string format?; - string mode?; - string path?; - string size?; -}; - # Represents the Headers record for the operation: getAccountBatch public type GetAccountBatchHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type filesget_temporary_upload_link_commit_info record { + boolean autorename?; + string mode?; + boolean mute?; + string path?; + boolean strict_conflict?; +}; + public type members_add_body record { groups_delete_body group?; - '2teamgroupsmembersadd_members[] members?; + teamgroupsmembersadd_members[] members?; boolean return_members?; }; -public type inline_response_200_73_actor_user_team record { - string display_name?; -}; - public type templates_get_for_team_body record { string template_id?; }; +public type inline_response_200_73_actor_user_team record { + string display_name?; +}; + # Represents the Headers record for the operation: deleteBatch public type DeleteBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -625,7 +638,7 @@ public type inline_response_200_5_type record { }; public type files_get_file_lock_batch_body record { - '2filesget_file_lock_batch_entries[] entries?; + filesget_file_lock_batch_entries[] entries?; }; public type files_restore_body record { @@ -639,16 +652,16 @@ public type PropertiesAddHeaders record { string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: revokeSharedLink -public type RevokeSharedLinkHeaders record { +# Represents the Headers record for the operation: copyReferenceGet +public type CopyReferenceGetHeaders record { string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-admin?; string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: copyReferenceGet -public type CopyReferenceGetHeaders record { +# Represents the Headers record for the operation: revokeSharedLink +public type RevokeSharedLinkHeaders record { string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; string? dropbox\-api\-select\-user?; }; @@ -674,7 +687,7 @@ public type groups_update_body record { public type inline_response_200_54_entries record { string author_email?; string author_member_id?; - '2teamgroupsget_info_profile_status author_member_status?; + teamgroupsget_info_profile_status author_member_status?; string content_hash?; string file_type?; string new_filename?; @@ -690,7 +703,7 @@ public type team_folder_activate_body record { public type members_add_body_1 record { boolean force_async?; - '2teammembersadd_new_members[] new_members?; + teammembersadd_new_members[] new_members?; }; # Represents the Headers record for the operation: templatesGetForUser @@ -699,16 +712,20 @@ public type TemplatesGetForUserHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2teammemberssecondary_emailsadd_new_secondary_emails record { - string[] secondary_emails?; - '2teamgroupsmembersadd_user user?; -}; - public type sharing_list_received_files_body record { anydata[] actions?; decimal 'limit?; }; +public type teammembersadd_new_members record { + string member_email?; + string member_external_id?; + string member_given_name?; + string member_surname?; + string role?; + boolean send_welcome_email?; +}; + public type legal_holds_get_policy_body record { string id?; }; @@ -723,10 +740,9 @@ public type inline_response_200_68_sync_setting record { string \.tag?; }; -public type '2sharingadd_folder_member_member record { - string \.tag?; - string dropbox_id?; - string email?; +public type file_propertiespropertiesadd_fields record { + string name?; + string value?; }; public type inline_response_200_64_results_1 record { @@ -746,7 +762,7 @@ public type inline_response_200_31_entries record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; inline_response_200_31_sharing_info sharing_info?; @@ -771,10 +787,10 @@ public type CopyReferenceSaveHeaders record { string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: templatesUpdateForUser -public type TemplatesUpdateForUserHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; +public type sharingadd_folder_member_member record { + string \.tag?; + string dropbox_id?; + string email?; }; public type inline_response_200_25_entries record { @@ -788,42 +804,48 @@ public type inline_response_200_25_entries record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; inline_response_200_25_sharing_info sharing_info?; decimal size?; }; +# Represents the Headers record for the operation: templatesUpdateForUser +public type TemplatesUpdateForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + public type list_mountable_folders_continue_body record { string cursor?; }; +public type file_propertiestemplatesadd_for_team_fields record { + string description?; + string name?; + string 'type?; +}; + +public type sharinglist_file_membersbatch_result_members_invitees record { + sharingget_file_metadatabatch_result_access_type access_type?; + sharinglist_file_membersbatch_result_members_invitee invitee?; + boolean is_inherited?; + anydata[] permissions?; +}; + public type search_continue_body record { string cursor?; }; public type member_space_limits_get_custom_quota_body record { - '2teamgroupsmembersadd_user[] users?; + teamgroupsmembersadd_user[] users?; }; public type legal_holds_list_policies_body record { boolean include_released?; }; -public type '2filesget_temporary_upload_link_commit_info record { - boolean autorename?; - string mode?; - boolean mute?; - string path?; - boolean strict_conflict?; -}; - -public type '2teamgroupsmembersadd_user record { - string \.tag?; - string team_member_id?; -}; - public type inline_response_200_55_members record { decimal permanently_deleted_users?; string[] team_member_ids?; @@ -859,6 +881,10 @@ public type inline_response_200_9_deadline_allow_late_uploads record { string \.tag?; }; +public type teammembersget_info_role record { + string \.tag?; +}; + # Represents the Headers record for the operation: listFolderLongpoll public type ListFolderLongpollHeaders record { string? dropbox\-api\-path\-root?; @@ -866,11 +892,6 @@ public type ListFolderLongpollHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2accountset_profile_photo_photo record { - string \.tag?; - string base64_data?; -}; - public type team_folder_create_body record { string name?; string sync_setting?; @@ -885,18 +906,14 @@ public type TokenRevokeHeaders record { public type members_remove_body_1 record { boolean keep_account?; boolean retain_team_shares?; - '2teamgroupsmembersadd_user transfer_admin_id?; - '2teamgroupsmembersadd_user transfer_dest_id?; - '2teamgroupsmembersadd_user user?; + teamgroupsmembersadd_user transfer_admin_id?; + teamgroupsmembersadd_user transfer_dest_id?; + teamgroupsmembersadd_user user?; boolean wipe_data?; }; -public type '2teamgroupsget_info_access_type record { - string \.tag?; -}; - public type secondary_emails_delete_body record { - '2teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_delete?; + teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_delete?; }; public type inline_response_200_73_user record { @@ -921,14 +938,14 @@ public type inline_response_200_35_link_metadata_action record { public type inline_response_200_43_entries record { inline_response_200_35_access_inheritance access_inheritance?; - '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; inline_response_200_35_link_metadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; - '2sharingget_file_metadatabatch_result_policy policy?; + sharingget_file_metadatabatch_result_policy policy?; string preview_url?; string shared_folder_id?; string time_invited?; @@ -947,15 +964,10 @@ public type inline_response_200_73_origin_access_method record { inline_response_200_73_origin_access_method_end_user end_user?; }; -public type '2teammember_space_limitsset_custom_quota_users_and_quotas record { - decimal quota_gb?; - '2teamgroupsmembersadd_user user?; -}; - public type members_remove_body record { groups_delete_body group?; boolean return_members?; - '2teamgroupsmembersadd_user[] users?; + teamgroupsmembersadd_user[] users?; }; # Represents the Headers record for the operation: updateFileMember @@ -975,19 +987,14 @@ public type inline_response_200_73_actor_user record { string team_member_id?; }; -# Represents the Headers record for the operation: listReceivedFilesContinue -public type ListReceivedFilesContinueHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; -}; - public type sharing_unshare_file_body record { string file?; }; -public type '2sharingget_file_metadatabatch_result_owner_team record { - string id?; - string name?; +# Represents the Headers record for the operation: listReceivedFilesContinue +public type ListReceivedFilesContinueHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; public type inline_response_200_24_entries record { @@ -1001,7 +1008,7 @@ public type sharing_add_file_member_body record { boolean add_message_as_comment?; string custom_message?; string file?; - '2sharingadd_file_member_members[] members?; + sharingadd_file_member_members[] members?; boolean quiet?; }; @@ -1018,7 +1025,7 @@ public type move_batch_check_v2_body record { public type sharing_modify_shared_link_settings_body record { boolean remove_expiration?; - '2sharingmodify_shared_link_settings_settings settings?; + sharingmodify_shared_link_settings_settings settings?; string url?; }; @@ -1026,6 +1033,10 @@ public type inline_response_200_9 record { inline_response_200_9_file_requests[] file_requests?; }; +public type teamfeaturesget_values_features record { + string \.tag?; +}; + public type inline_response_200_5 record { string description?; inline_response_200_5_fields[] fields?; @@ -1075,6 +1086,11 @@ public type inline_response_200_68_content_sync_settings record { inline_response_200_68_sync_setting sync_setting?; }; +public type properties_overwrite_body record { + string path?; + file_propertiespropertiesadd_property_groups[] property_groups?; +}; + public type sharing_update_folder_policy_body record { string acl_update_policy?; string member_policy?; @@ -1082,11 +1098,6 @@ public type sharing_update_folder_policy_body record { string shared_link_policy?; }; -public type properties_overwrite_body record { - string path?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; -}; - # Represents the Headers record for the operation: modifySharedLinkSettings public type ModifySharedLinkSettingsHeaders record { string? dropbox\-api\-path\-root?; @@ -1106,17 +1117,22 @@ public type SaveUrlHeaders record { }; public type account_set_profile_photo_body record { - '2accountset_profile_photo_photo photo?; + accountset_profile_photo_photo photo?; }; public type sharing_update_file_member_body record { string access_level?; string file?; - '2sharingadd_file_member_members member?; + sharingadd_file_member_members member?; }; -public type inline_response_200_1 record { - string oauth2_token?; +public type teamgroupsget_info_profile_secondary_emails record { + string email?; + boolean is_verified?; +}; + +public type inline_response_200_1 record { + string oauth2_token?; }; public type inline_response_200_2 record { @@ -1129,21 +1145,15 @@ public type inline_response_200_3 record { public type files_copy_batch_v2_body record { boolean autorename?; - '2filescopy_batch_v2_entries[] entries?; + filescopy_batch_v2_entries[] entries?; }; public type inline_response_200_4 record { string template_id?; }; -public type '2file_propertiespropertiesupdate_update_property_groups record { - '2file_propertiespropertiesadd_fields[] add_or_update_fields?; - anydata[] remove_fields?; - string template_id?; -}; - public type members_set_profile_photo_body record { - '2accountset_profile_photo_photo photo?; + accountset_profile_photo_photo photo?; members_send_welcome_email_body user?; }; @@ -1158,7 +1168,7 @@ public type inline_response_200_10 record { }; public type members_recover_body record { - '2teamgroupsmembersadd_user user?; + teamgroupsmembersadd_user user?; }; public type inline_response_200_13 record { @@ -1176,6 +1186,17 @@ public type inline_response_200_19 record { inline_response_200_19_entries[] entries?; }; +public type files_list_revisions_body record { + decimal 'limit?; + string mode?; + string path?; +}; + +public type inline_response_200_61_members record { + teammembersget_info_profile profile?; + teammembersget_info_role role?; +}; + # Represents the Headers record for the operation: user public type UserHeaders record { string? dropbox\-api\-path\-root?; @@ -1187,22 +1208,16 @@ public type inline_response_200_18 record { inline_response_200_21_metadata file_metadata?; }; -public type inline_response_200_61_members record { - '2teammembersget_info_profile profile?; - '2teammembersget_info_role role?; -}; - -public type files_list_revisions_body record { - decimal 'limit?; - string mode?; - string path?; -}; - public type inline_response_200_12_entries record { string \.tag?; inline_response_200_30_metadata_metadata success?; }; +public type teammembersget_info_profile_secondary_emails record { + string email?; + boolean is_verified?; +}; + public type inline_response_200_15 record { string \.tag?; inline_response_200_15_entries[] entries?; @@ -1229,7 +1244,7 @@ public type inline_response_200_17 record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; inline_response_200_31_sharing_info sharing_info?; @@ -1300,8 +1315,19 @@ public type DeleteHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2teamgroupsget_info_profile_membership_type record { +public type sharingget_file_metadatabatch_result record { string \.tag?; + sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; }; # Represents the Headers record for the operation: unshareFolder @@ -1311,11 +1337,6 @@ public type UnshareFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2sharingadd_file_member_members record { - string \.tag?; - string email?; -}; - # Represents the Headers record for the operation: listFileMembers public type ListFileMembersHeaders record { string? dropbox\-api\-path\-root?; @@ -1323,20 +1344,33 @@ public type ListFileMembersHeaders record { string? dropbox\-api\-select\-user?; }; +public type teamgroupsget_info_profile_membership_type record { + string \.tag?; +}; + +public type teamgroupsget_info_access_type record { + string \.tag?; +}; + public type inline_response_200_71_policies record { inline_response_200_77_team_office_addin_policy emm_state?; inline_response_200_77_team_office_addin_policy office_addin?; inline_response_200_77_team_sharing_policies sharing?; }; -public type '2teamgroupsget_info_members record { - '2teamgroupsget_info_access_type access_type?; - '2teamgroupsget_info_profile profile?; +public type accountset_profile_photo_photo record { + string \.tag?; + string base64_data?; +}; + +public type filesupload_sessionfinish_batch_entries record { + filesget_temporary_upload_link_commit_info 'commit?; + filesupload_sessionfinish_batch_cursor cursor?; }; public type inline_response_200_33 record { - '2sharingadd_file_member_members member?; - '2sharingadd_file_member_result result?; + sharingadd_file_member_members member?; + sharingadd_file_member_result result?; }; public type inline_response_200_32 record { @@ -1346,14 +1380,14 @@ public type inline_response_200_32 record { public type inline_response_200_35 record { string \.tag?; inline_response_200_35_access_inheritance access_inheritance?; - '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; inline_response_200_35_link_metadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; - '2sharingget_file_metadatabatch_result_policy policy?; + sharingget_file_metadatabatch_result_policy policy?; string preview_url?; string shared_folder_id?; string time_invited?; @@ -1369,11 +1403,11 @@ public type inline_response_200_34 record { }; public type members_get_info_body record { - '2teamgroupsmembersadd_user[] members?; + teamgroupsmembersadd_user[] members?; }; public type secondary_emails_resend_verification_emails_body record { - '2teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_resend?; + teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_resend?; }; public type inline_response_200_31 record { @@ -1383,7 +1417,7 @@ public type inline_response_200_31 record { public type inline_response_200_50_groups record { string group_id?; - '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; string group_name?; decimal member_count?; }; @@ -1400,35 +1434,25 @@ public type DeleteBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2teammembersget_info_profile_secondary_emails record { - string email?; - boolean is_verified?; -}; - public type sharing_check_job_status_body record { string async_job_id?; }; -public type inline_response_200_73_details record { - string \.tag?; - inline_response_200_73_details_shared_content_access_level shared_content_access_level?; - string shared_content_link?; - inline_response_200_73_actor_user shared_content_owner?; -}; - # Represents the Headers record for the operation: getSpaceUsage public type GetSpaceUsageHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_37 record { - string file?; - '2sharingget_file_metadatabatch_result result?; +public type inline_response_200_73_details record { + string \.tag?; + inline_response_200_73_details_shared_content_access_level shared_content_access_level?; + string shared_content_link?; + inline_response_200_73_actor_user shared_content_owner?; }; public type team_folder_update_sync_settings_body record { - '2teamteam_folderupdate_sync_settings_content_sync_settings[] content_sync_settings?; + teamteam_folderupdate_sync_settings_content_sync_settings[] content_sync_settings?; string sync_setting?; string team_folder_id?; }; @@ -1440,16 +1464,21 @@ public type ShareFolderHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_37 record { + string file?; + sharingget_file_metadatabatch_result result?; +}; + public type inline_response_200_36 record { - '2sharingget_file_metadatabatch_result_access_type access_type?; + sharingget_file_metadatabatch_result_access_type access_type?; string id?; string name?; string[] owner_display_names?; - '2sharingget_file_metadatabatch_result_owner_team owner_team?; + sharingget_file_metadatabatch_result_owner_team owner_team?; string path_display?; string path_lower?; anydata[] permissions?; - '2sharingget_file_metadatabatch_result_policy policy?; + sharingget_file_metadatabatch_result_policy policy?; string preview_url?; string time_invited?; }; @@ -1470,14 +1499,14 @@ public type inline_response_200_39 record { public type inline_response_200_38 record { inline_response_200_35_access_inheritance access_inheritance?; - '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; inline_response_200_35_link_metadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; - '2sharingget_file_metadatabatch_result_policy policy?; + sharingget_file_metadatabatch_result_policy policy?; string preview_url?; string shared_folder_id?; string time_invited?; @@ -1488,15 +1517,15 @@ public type properties_remove_body record { string[] property_template_ids?; }; +public type legal_holds_list_held_revisions_body record { + string id?; +}; + public type inline_response_200_74_values record { string \.tag?; inline_response_200_74_paper_as_files paper_as_files?; }; -public type legal_holds_list_held_revisions_body record { - string id?; -}; - public type files_create_folder_batch_body record { boolean autorename?; boolean force_async?; @@ -1510,11 +1539,7 @@ public type SetAccessInheritanceHeaders record { }; public type files_lock_file_batch_body record { - '2filesget_file_lock_batch_entries[] entries?; -}; - -public type '2sharinglist_file_membersbatch_result_members_access_type record { - string \.tag?; + filesget_file_lock_batch_entries[] entries?; }; public type groups_get_info_body record { @@ -1585,21 +1610,16 @@ public type inline_response_200_20 record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; inline_response_200_31_sharing_info sharing_info?; decimal size?; }; -# Represents the Headers record for the operation: create -public type CreateHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; -}; - -public type files_delete_batch_body record { - files_delete_v2_body[] entries?; +public type file_requestscreate_deadline record { + string allow_late_uploads?; + string deadline?; }; public type inline_response_200_70_values record { @@ -1608,6 +1628,16 @@ public type inline_response_200_70_values record { inline_response_200_70_upload_api_rate_limit upload_api_rate_limit?; }; +public type files_delete_batch_body record { + files_delete_v2_body[] entries?; +}; + +# Represents the Headers record for the operation: create +public type CreateHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + # Represents the Headers record for the operation: delete1 public type Delete1Headers record { string? dropbox\-api\-path\-root?; @@ -1615,10 +1645,6 @@ public type Delete1Headers record { string? dropbox\-api\-select\-user?; }; -public type '2sharinglist_file_membersbatch_result_members_group_group_management_type record { - string \.tag?; -}; - public type inline_response_200_29 record { string \.tag?; }; @@ -1651,7 +1677,7 @@ public type inline_response_200_28 record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; inline_response_200_31_sharing_info sharing_info?; @@ -1669,26 +1695,17 @@ public type inline_response_200_73_event_type record { }; public type files_get_temporary_upload_link_body record { - '2filesget_temporary_upload_link_commit_info commit_info?; + filesget_temporary_upload_link_commit_info commit_info?; decimal duration?; }; -public type '2teamfeaturesget_values_features record { - string \.tag?; -}; - -public type members_delete_profile_photo_body record { - '2teamgroupsmembersadd_user user?; -}; - public type inline_response_200_73_actor record { string \.tag?; inline_response_200_73_actor_user user?; }; -public type sharing_get_shared_link_metadata_body record { - string path?; - string url?; +public type members_delete_profile_photo_body record { + teamgroupsmembersadd_user user?; }; # Represents the Headers record for the operation: upload @@ -1699,6 +1716,11 @@ public type UploadHeaders record { string? dropbox\-api\-select\-user?; }; +public type sharing_get_shared_link_metadata_body record { + string path?; + string url?; +}; + # Represents the Headers record for the operation: download public type DownloadHeaders record { string? dropbox\-api\-path\-root?; @@ -1707,6 +1729,10 @@ public type DownloadHeaders record { string? dropbox\-api\-select\-user?; }; +public type sharingget_file_metadatabatch_result_policy_resolved_member_policy record { + string \.tag?; +}; + public type inline_response_200_55 record { inline_response_200_55_policies[] policies?; }; @@ -1722,8 +1748,14 @@ public type inline_response_200_57 record { anydata[] users?; }; +public type file_propertiespropertiessearch_queries record { + string logical_operator?; + file_propertiespropertiessearch_mode mode?; + string query?; +}; + public type inline_response_200_56 record { - '2sharingadd_file_member_result status?; + sharingadd_file_member_result status?; }; public type inline_response_200_51 record { @@ -1744,7 +1776,13 @@ public type inline_response_200_53 record { inline_response_200_55_members members?; string name?; string start_date?; - '2teamgroupsget_info_profile_status status?; + teamgroupsget_info_profile_status status?; +}; + +public type file_requestsupdate_deadline record { + string \.tag?; + string allow_late_uploads?; + string deadline?; }; public type inline_response_200_52 record { @@ -1772,8 +1810,8 @@ public type inline_response_200_77_team record { }; public type inline_response_200_59 record { - '2teammembersget_info_profile profile?; - '2teammembersget_info_role role?; + teammembersget_info_profile profile?; + teammembersget_info_role role?; }; public type inline_response_200_58 record { @@ -1785,10 +1823,6 @@ public type files_permanently_delete_body record { string path?; }; -public type '2sharingadd_file_member_result record { - string \.tag?; -}; - public type list_folder_members_continue_body record { string cursor?; }; @@ -1811,16 +1845,10 @@ public type CheckShareJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2file_propertiespropertiessearch_queries record { - string logical_operator?; - '2file_propertiespropertiessearch_mode mode?; - string query?; -}; - public type inline_response_200_60 record { string \.tag?; - '2teammembersget_info_profile profile?; - '2teammembersget_info_role role?; + teammembersget_info_profile profile?; + teammembersget_info_role role?; }; public type team_log_get_events_body record { @@ -1828,6 +1856,10 @@ public type team_log_get_events_body record { decimal 'limit?; }; +public type sharingget_file_metadatabatch_result_policy_member_policy record { + string \.tag?; +}; + public type inline_response_200_44 record { string cursor?; inline_response_200_44_entries[] entries?; @@ -1854,43 +1886,30 @@ public type members_send_welcome_email_body record { }; public type inline_response_200_40 record { - '2sharinglist_file_membersbatch_result_members_groups[] groups?; - '2sharinglist_file_membersbatch_result_members_invitees[] invitees?; - '2sharinglist_file_membersbatch_result_members_users[] users?; + sharinglist_file_membersbatch_result_members_groups[] groups?; + sharinglist_file_membersbatch_result_members_invitees[] invitees?; + sharinglist_file_membersbatch_result_members_users[] users?; }; public type inline_response_200_42 record { string cursor?; - '2sharinglist_file_membersbatch_result_members_groups[] groups?; - '2sharinglist_file_membersbatch_result_members_invitees[] invitees?; + sharinglist_file_membersbatch_result_members_groups[] groups?; + sharinglist_file_membersbatch_result_members_invitees[] invitees?; inline_response_200_42_users[] users?; }; public type inline_response_200_41 record { string file?; - '2sharinglist_file_membersbatch_result result?; -}; - -public type '2teamgroupsget_info_profile record { - string account_id?; - string email?; - boolean email_verified?; - string joined_on?; - '2teamgroupsget_info_profile_membership_type membership_type?; - '2teamgroupsget_info_profile_name name?; - string profile_photo_url?; - '2teamgroupsget_info_profile_secondary_emails[] secondary_emails?; - '2teamgroupsget_info_profile_status status?; - string team_member_id?; + sharinglist_file_membersbatch_result result?; }; public type inline_response_200_48 record { decimal created?; string group_id?; - '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; string group_name?; decimal member_count?; - '2teamgroupsget_info_members[] members?; + teamgroupsget_info_members[] members?; }; public type inline_response_200_47 record { @@ -1902,14 +1921,14 @@ public type inline_response_200_49 record { string \.tag?; decimal created?; string group_id?; - '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; string group_name?; decimal member_count?; - '2teamgroupsget_info_members[] members?; + teamgroupsget_info_members[] members?; }; public type properties_search_body record { - '2file_propertiespropertiessearch_queries[] queries?; + file_propertiespropertiessearch_queries[] queries?; string template_filter?; }; @@ -1922,7 +1941,7 @@ public type inline_response_200_73_assets record { }; public type file_requests_create_body record { - '2file_requestscreate_deadline deadline?; + file_requestscreate_deadline deadline?; string destination?; boolean open?; string title?; @@ -1942,7 +1961,7 @@ public type inline_response_200_77 record { boolean email_verified?; boolean is_paired?; string locale?; - '2teamgroupsget_info_profile_name name?; + teamgroupsget_info_profile_name name?; string referral_link?; inline_response_200_77_root_info root_info?; inline_response_200_77_team team?; @@ -1955,19 +1974,10 @@ public type inline_response_200_76 record { string email?; boolean email_verified?; boolean is_teammate?; - '2teamgroupsget_info_profile_name name?; + teamgroupsget_info_profile_name name?; string profile_photo_url?; }; -public type '2sharinglist_file_membersbatch_result_members_users record { - '2sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inherited?; - anydata[] permissions?; - '2sharinglist_file_membersbatch_result_members_platform_type platform_type?; - string time_last_seen?; - '2sharinglist_file_membersbatch_result_members_user user?; -}; - # Represents the Headers record for the operation: tokenFromOauth1 public type TokenFromOauth1Headers record { string? dropbox\-api\-path\-root?; @@ -1986,11 +1996,7 @@ public type inline_response_200_73 record { }; public type inline_response_200_72 record { - '2teammembersget_info_profile admin_profile?; -}; - -public type file_requests_list_v2_body record { - decimal 'limit?; + teammembersget_info_profile admin_profile?; }; public type inline_response_200_75 record { @@ -1999,10 +2005,14 @@ public type inline_response_200_75 record { string email?; boolean email_verified?; boolean is_teammate?; - '2teamgroupsget_info_profile_name name?; + teamgroupsget_info_profile_name name?; string profile_photo_url?; }; +public type file_requests_list_v2_body record { + decimal 'limit?; +}; + public type inline_response_200_74 record { inline_response_200_74_values[] values?; }; @@ -2032,10 +2042,10 @@ public type ExportHeaders record { public type inline_response_200_51_group_info record { decimal created?; string group_id?; - '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; string group_name?; decimal member_count?; - '2teamgroupsget_info_members[] members?; + teamgroupsget_info_members[] members?; }; public type users_get_account_body record { @@ -2055,6 +2065,11 @@ public type GetFileMetadataHeaders record { string? dropbox\-api\-select\-user?; }; +public type teammember_space_limitsset_custom_quota_users_and_quotas record { + decimal quota_gb?; + teamgroupsmembersadd_user user?; +}; + public type team_folder_get_info_body record { string[] team_folder_ids?; }; @@ -2066,19 +2081,19 @@ public type GetMetadataHeaders record { string? dropbox\-api\-select\-user?; }; -public type team_folder_rename_body record { - string name?; - string team_folder_id?; -}; - public type inline_response_200_66 record { string cursor?; boolean has_more?; inline_response_200_66_namespaces[] namespaces?; }; +public type team_folder_rename_body record { + string name?; + string team_folder_id?; +}; + public type inline_response_200_65 record { - '2teammembersget_info_role role?; + teammembersget_info_role role?; string team_member_id?; }; @@ -2087,7 +2102,7 @@ public type inline_response_200_68 record { inline_response_200_68_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; - '2teamgroupsget_info_profile_status status?; + teamgroupsget_info_profile_status status?; inline_response_200_68_sync_setting sync_setting?; string team_folder_id?; }; @@ -2096,7 +2111,7 @@ public type inline_response_200_67 record { inline_response_200_68_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; - '2teamgroupsget_info_profile_status status?; + teamgroupsget_info_profile_status status?; inline_response_200_68_sync_setting sync_setting?; string team_folder_id?; }; @@ -2129,23 +2144,18 @@ public type inline_response_200_70_upload_api_rate_limit record { decimal 'limit?; }; +public type file_propertiespropertiesupdate_update_property_groups record { + file_propertiespropertiesadd_fields[] add_or_update_fields?; + anydata[] remove_fields?; + string template_id?; +}; + public type inline_response_200_69 record { string cursor?; boolean has_more?; inline_response_200_69_team_folders[] team_folders?; }; -public type '2sharingget_file_metadatabatch_result_access_type record { - string \.tag?; -}; - -public type '2sharingget_file_metadatabatch_result_policy record { - '2sharingget_file_metadatabatch_result_policy_acl_update_policy acl_update_policy?; - '2sharingget_file_metadatabatch_result_policy_member_policy member_policy?; - '2sharingget_file_metadatabatch_result_policy_resolved_member_policy resolved_member_policy?; - '2sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; -}; - public type copy_reference_get_body record { string path?; }; @@ -2167,14 +2177,14 @@ public type inline_response_200_71 record { string team_id?; }; -public type inline_response_200_70 record { - inline_response_200_70_values[] values?; -}; - public type save_url_check_job_status_body record { string async_job_id?; }; +public type inline_response_200_70 record { + inline_response_200_70_values[] values?; +}; + public type list_folder_get_latest_cursor_body record { boolean include_deleted?; boolean include_has_explicit_shared_members?; @@ -2185,15 +2195,13 @@ public type list_folder_get_latest_cursor_body record { boolean recursive?; }; -public type '2file_propertiestemplatesadd_for_team_fields record { - string description?; - string name?; - string 'type?; -}; - -public type '2filescopy_batch_v2_entries record { - string from_path?; - string to_path?; +public type sharinglist_file_membersbatch_result_members_users record { + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inherited?; + anydata[] permissions?; + sharinglist_file_membersbatch_result_members_platform_type platform_type?; + string time_last_seen?; + sharinglist_file_membersbatch_result_members_user user?; }; public type job_status_get_body record { @@ -2207,6 +2215,16 @@ public type RestoreHeaders record { string? dropbox\-api\-select\-user?; }; +public type sharinglist_file_membersbatch_result record { + string \.tag?; + decimal member_count?; + sharinglist_file_membersbatch_result_members members?; +}; + +public type sharinglist_file_membersbatch_result_members_access_type record { + string \.tag?; +}; + public type groups_list_body record { decimal 'limit?; }; @@ -2233,18 +2251,11 @@ public type DeleteAllClosedHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2sharinglist_file_membersbatch_result_members_groups record { - '2sharinglist_file_membersbatch_result_members_access_type access_type?; - '2sharinglist_file_membersbatch_result_members_group group?; - boolean is_inherited?; - anydata[] permissions?; -}; - public type members_set_access_type_body record { string access_type?; groups_delete_body group?; boolean return_members?; - '2teamgroupsmembersadd_user user?; + teamgroupsmembersadd_user user?; }; public type users_get_account_batch_body record { @@ -2255,39 +2266,33 @@ public type legal_holds_release_policy_body record { string id?; }; -public type templates_add_for_user_body record { - string description?; - '2file_propertiestemplatesadd_for_team_fields[] fields?; - string name?; -}; - public type members_move_former_member_files_body record { - '2teamgroupsmembersadd_user transfer_admin_id?; - '2teamgroupsmembersadd_user transfer_dest_id?; - '2teamgroupsmembersadd_user user?; + teamgroupsmembersadd_user transfer_admin_id?; + teamgroupsmembersadd_user transfer_dest_id?; + teamgroupsmembersadd_user user?; }; -public type '2sharinglist_file_membersbatch_result record { - string \.tag?; - decimal member_count?; - '2sharinglist_file_membersbatch_result_members members?; +public type templates_add_for_user_body record { + string description?; + file_propertiestemplatesadd_for_team_fields[] fields?; + string name?; }; public type sharing_unmount_folder_body record { string shared_folder_id?; }; -public type properties_update_body record { - string path?; - '2file_propertiespropertiesupdate_update_property_groups[] update_property_groups?; -}; - public type templates_add_for_team_body record { string description?; - '2file_propertiestemplatesadd_for_team_fields[] fields?; + file_propertiestemplatesadd_for_team_fields[] fields?; string name?; }; +public type properties_update_body record { + string path?; + file_propertiespropertiesupdate_update_property_groups[] update_property_groups?; +}; + # Represents the Headers record for the operation: templatesAddForUser public type TemplatesAddForUserHeaders record { string? dropbox\-api\-path\-root?; @@ -2309,6 +2314,11 @@ public type inline_response_200_35_link_metadata_link_permissions record { boolean allow?; }; +public type inline_response_200_64_results record { + string \.tag?; + string success?; +}; + public type inline_response_200_19_lock_content record { string \.tag?; string created?; @@ -2316,24 +2326,35 @@ public type inline_response_200_19_lock_content record { string lock_holder_team_id?; }; -public type inline_response_200_64_results record { - string \.tag?; - string success?; -}; - public type inline_response_200_35_link_metadata_audience_options record { string \.tag?; }; public type inline_response_200_77_team_sharing_policies record { inline_response_200_77_team_sharing_policies_shared_folder_join_policy shared_folder_join_policy?; - '2sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; + sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; inline_response_200_77_team_sharing_policies_shared_link_create_policy shared_link_create_policy?; }; public type sharing_remove_file_member_2_body record { string file?; - '2sharingadd_file_member_members member?; + sharingadd_file_member_members member?; +}; + +public type teammembersget_info_profile record { + string account_id?; + string email?; + boolean email_verified?; + string external_id?; + string[] groups?; + string joined_on?; + string member_folder_id?; + teamgroupsget_info_profile_membership_type membership_type?; + teamgroupsget_info_profile_name name?; + string profile_photo_url?; + teammembersget_info_profile_secondary_emails[] secondary_emails?; + teamgroupsget_info_profile_status status?; + string team_member_id?; }; public type inline_response_200_5_fields record { @@ -2346,11 +2367,7 @@ public type inline_response_200_3_matches record { string id?; boolean is_deleted?; string path?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; -}; - -public type features_get_values_body_1 record { - '2usersfeaturesget_values_features[] features?; + file_propertiespropertiesadd_property_groups[] property_groups?; }; public type list_file_members_batch_body record { @@ -2358,9 +2375,8 @@ public type list_file_members_batch_body record { decimal 'limit?; }; -public type '2file_propertiespropertiessearch_mode record { - string \.tag?; - string field_name?; +public type features_get_values_body_1 record { + usersfeaturesget_values_features[] features?; }; # Represents the Headers record for the operation: listRevisions @@ -2371,17 +2387,17 @@ public type ListRevisionsHeaders record { }; public type excluded_users_add_body record { - '2teamgroupsmembersadd_user[] users?; + teamgroupsmembersadd_user[] users?; }; -public type inline_response_200_73_origin_access_method_end_user record { - string \.tag?; +public type filesupload_sessionfinish_batch_cursor record { + decimal offset?; string session_id?; }; -public type copy_reference_save_body record { - string copy_reference?; - string path?; +public type inline_response_200_73_origin_access_method_end_user record { + string \.tag?; + string session_id?; }; public type inline_response_200_73_path_namespace_relative record { @@ -2390,6 +2406,11 @@ public type inline_response_200_73_path_namespace_relative record { string relative_path?; }; +public type copy_reference_save_body record { + string copy_reference?; + string path?; +}; + # Represents the Headers record for the operation: listFolder public type ListFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -2441,15 +2462,30 @@ public type AddFileMemberHeaders record { string? dropbox\-api\-select\-user?; }; +public type teamgroupsget_info_profile_name record { + string abbreviated_name?; + string display_name?; + string familiar_name?; + string given_name?; + string surname?; +}; + public type inline_response_200_16_entries record { string \.tag?; inline_response_200_30_metadata_metadata metadata?; }; -# Represents the Headers record for the operation: listSharedLinks -public type ListSharedLinksHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; +public type teamgroupsget_info_profile record { + string account_id?; + string email?; + boolean email_verified?; + string joined_on?; + teamgroupsget_info_profile_membership_type membership_type?; + teamgroupsget_info_profile_name name?; + string profile_photo_url?; + teamgroupsget_info_profile_secondary_emails[] secondary_emails?; + teamgroupsget_info_profile_status status?; + string team_member_id?; }; # Represents the Headers record for the operation: templatesRemoveForUser @@ -2458,6 +2494,12 @@ public type TemplatesRemoveForUserHeaders record { string? dropbox\-api\-select\-user?; }; +# Represents the Headers record for the operation: listSharedLinks +public type ListSharedLinksHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; +}; + public type team_folder_archive_body record { boolean force_async_off?; string team_folder_id?; @@ -2474,17 +2516,6 @@ public type RemoveFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2sharinglist_file_membersbatch_result_members_group record { - string group_id?; - '2sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - '2sharinglist_file_membersbatch_result_members_group_group_management_type group_type?; - boolean is_member?; - boolean is_owner?; - decimal member_count?; - boolean same_team?; -}; - public type sharing_unshare_folder_body record { boolean leave_a_copy?; string shared_folder_id?; @@ -2506,6 +2537,11 @@ public type list_received_files_continue_body record { string cursor?; }; +public type teamgroupsmembersadd_members record { + string access_type?; + teamgroupsmembersadd_user user?; +}; + public type members_set_admin_permissions_body record { string new_role?; members_send_welcome_email_body user?; @@ -2522,13 +2558,17 @@ public type inline_response_200_30_metadata_metadata record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; inline_response_200_31_sharing_info sharing_info?; decimal size?; }; +public type teamgroupsget_info_profile_status record { + string \.tag?; +}; + # Represents the Headers record for the operation: mountFolder public type MountFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -2542,17 +2582,10 @@ public type ListFolderContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2sharinglist_file_membersbatch_result_members_user record { - string account_id?; - string display_name?; - string email?; - boolean same_team?; - string team_member_id?; -}; - -public type '2file_requestscreate_deadline record { - string allow_late_uploads?; - string deadline?; +public type files_move_batch_v2_body record { + boolean allow_ownership_transfer?; + boolean autorename?; + filescopy_batch_v2_entries[] entries?; }; public type devices_list_member_devices_body record { @@ -2562,26 +2595,20 @@ public type devices_list_member_devices_body record { string team_member_id?; }; -public type files_move_batch_v2_body record { - boolean allow_ownership_transfer?; - boolean autorename?; - '2filescopy_batch_v2_entries[] entries?; -}; - public type check_app_body record { string query?; }; -# Represents the Headers record for the operation: deleteManualContactsBatch -public type DeleteManualContactsBatchHeaders record { +# Represents the Headers record for the operation: copyBatchCheck +public type CopyBatchCheckHeaders record { string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: copyBatchCheck -public type CopyBatchCheckHeaders record { +# Represents the Headers record for the operation: deleteManualContactsBatch +public type DeleteManualContactsBatchHeaders record { string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-admin?; string? dropbox\-api\-select\-user?; }; @@ -2636,7 +2663,7 @@ public type UploadSessionAppendHeaders record { public type properties_add_body record { string path?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; }; public type sharing_relinquish_file_membership_body record { @@ -2653,16 +2680,16 @@ public type devices_revoke_device_session_body record { string team_member_id?; }; -public type files_unlock_file_batch_body record { - '2filesget_file_lock_batch_entries[] entries?; -}; - # Represents the Headers record for the operation: saveUrlCheckJobStatus public type SaveUrlCheckJobStatusHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type files_unlock_file_batch_body record { + filesget_file_lock_batch_entries[] entries?; +}; + # Represents the Headers record for the operation: copy public type CopyHeaders record { string? dropbox\-api\-path\-root?; @@ -2671,7 +2698,7 @@ public type CopyHeaders record { }; public type excluded_users_remove_body record { - '2teamgroupsmembersadd_user[] users?; + teamgroupsmembersadd_user[] users?; }; # Represents the Headers record for the operation: update @@ -2694,6 +2721,10 @@ public type UpdateFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; +public type sharingget_file_metadatabatch_result_access_type record { + string \.tag?; +}; + # Represents the Headers record for the operation: getSharedLinkMetadata public type GetSharedLinkMetadataHeaders record { string? dropbox\-api\-path\-root?; @@ -2707,13 +2738,17 @@ public type inline_response_200_55_policies record { inline_response_200_55_members members?; string name?; string start_date?; - '2teamgroupsget_info_profile_status status?; + teamgroupsget_info_profile_status status?; }; public type sharing_check_share_job_status_body record { string async_job_id?; }; +public type create_folder_batch_check_body record { + string async_job_id?; +}; + # Represents the Headers record for the operation: moveBatchCheck public type MoveBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2721,10 +2756,6 @@ public type MoveBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; -public type create_folder_batch_check_body record { - string async_job_id?; -}; - public type sharing_share_folder_body record { string access_inheritance?; string acl_update_policy?; @@ -2748,7 +2779,7 @@ public type UploadSessionFinishBatchCheckHeaders record { }; public type features_get_values_body record { - '2teamfeaturesget_values_features[] features?; + teamfeaturesget_values_features[] features?; }; public type sharing_mount_folder_body record { @@ -2770,8 +2801,9 @@ public type inline_response_200_66_namespaces record { string team_member_id?; }; -public type '2teamgroupsget_info_profile_status record { +public type sharinglist_file_membersbatch_result_members_invitee record { string \.tag?; + string email?; }; public type files_delete_v2_body record { @@ -2783,15 +2815,10 @@ public type inline_response_200_15_metadata record { string name?; string path_display?; string path_lower?; - '2file_propertiespropertiesadd_property_groups[] property_groups?; + file_propertiespropertiesadd_property_groups[] property_groups?; inline_response_200_15_metadata_sharing_info sharing_info?; }; -public type '2sharingadd_folder_member_members record { - string access_level?; - '2sharingadd_folder_member_member member?; -}; - # Represents the Headers record for the operation: copyBatch public type CopyBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2799,29 +2826,6 @@ public type CopyBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2teamgroupsget_info_profile_name record { - string abbreviated_name?; - string display_name?; - string familiar_name?; - string given_name?; - string surname?; -}; - -public type '2sharingget_file_metadatabatch_result record { - string \.tag?; - '2sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - '2sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - '2sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; -}; - # Represents the Headers record for the operation: relinquishFileMembership public type RelinquishFileMembershipHeaders record { string? dropbox\-api\-path\-root?; @@ -2829,34 +2833,23 @@ public type RelinquishFileMembershipHeaders record { string? dropbox\-api\-select\-user?; }; +public type file_propertiespropertiesadd_property_groups record { + file_propertiespropertiesadd_fields[] fields?; + string template_id?; +}; + public type templates_get_for_user_body record { string template_id?; }; -public type '2teammembersget_info_profile record { - string account_id?; - string email?; - boolean email_verified?; - string external_id?; - string[] groups?; - string joined_on?; - string member_folder_id?; - '2teamgroupsget_info_profile_membership_type membership_type?; - '2teamgroupsget_info_profile_name name?; - string profile_photo_url?; - '2teammembersget_info_profile_secondary_emails[] secondary_emails?; - '2teamgroupsget_info_profile_status status?; - string team_member_id?; +public type inline_response_200_19_lock record { + inline_response_200_19_lock_content content?; }; public type list_continue_body_1 record { string cursor?; }; -public type inline_response_200_19_lock record { - inline_response_200_19_lock_content content?; -}; - public type inline_response_200_9_deadline record { inline_response_200_9_deadline_allow_late_uploads allow_late_uploads?; string deadline?; @@ -2868,18 +2861,27 @@ public type inline_response_200_63_results record { string success?; }; -public type inline_response_200_77_team_office_addin_policy record { +public type usersfeaturesget_values_features record { string \.tag?; }; +public type filescopy_batch_v2_entries record { + string from_path?; + string to_path?; +}; + +public type list_continue_body_5 record { + string cursor?; +}; + public type inline_response_200_18_export_metadata record { string export_hash?; string name?; decimal size?; }; -public type list_continue_body_5 record { - string cursor?; +public type inline_response_200_77_team_office_addin_policy record { + string \.tag?; }; public type list_continue_body_4 record { @@ -2901,23 +2903,14 @@ public type GetFolderMetadataHeaders record { string? dropbox\-api\-select\-user?; }; -public type '2sharingget_file_metadatabatch_result_policy_member_policy record { - string \.tag?; -}; - -public type '2sharinglist_file_membersbatch_result_members record { - '2sharinglist_file_membersbatch_result_members_groups[] groups?; - '2sharinglist_file_membersbatch_result_members_invitees[] invitees?; - '2sharinglist_file_membersbatch_result_members_users[] users?; -}; - public type linked_apps_list_member_linked_apps_body record { string team_member_id?; }; -public type '2file_propertiespropertiesadd_fields record { - string name?; - string value?; +public type sharingmodify_shared_link_settings_settings record { + string access?; + string audience?; + string requested_visibility?; }; # Represents the Headers record for the operation: uploadSessionFinishBatch @@ -2941,8 +2934,8 @@ public type list_continue_body_6 record { string cursor?; }; -public type '2filesget_file_lock_batch_entries record { - string path?; +public type sharinglist_file_membersbatch_result_members_platform_type record { + string \.tag?; }; # Represents the Headers record for the operation: getPreview @@ -2959,8 +2952,8 @@ public type devices_revoke_device_session_batch_body record { public type inline_response_200_58_complete record { string \.tag?; - '2teammembersget_info_profile profile?; - '2teammembersget_info_role role?; + teammembersget_info_profile profile?; + teammembersget_info_role role?; }; public type inline_response_200_70_has_team_shared_dropbox record { @@ -2972,11 +2965,18 @@ public type inline_response_200_69_team_folders record { inline_response_200_68_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; - '2teamgroupsget_info_profile_status status?; + teamgroupsget_info_profile_status status?; inline_response_200_68_sync_setting sync_setting?; string team_folder_id?; }; +public type filesget_thumbnail_batch_entries record { + string format?; + string mode?; + string path?; + string size?; +}; + # Represents the Headers record for the operation: getThumbnail public type GetThumbnailHeaders record { string? dropbox\-api\-path\-root?; @@ -3003,17 +3003,17 @@ public type inline_response_200_15_entries record { inline_response_200_15_metadata metadata?; }; +public type copy_batch_check_v2_body record { + string async_job_id?; +}; + public type get_file_metadata_batch_body record { anydata[] actions?; string[] files?; }; -public type copy_batch_check_v2_body record { - string async_job_id?; -}; - public type upload_session_finish_batch_body record { - '2filesupload_sessionfinish_batch_entries[] entries?; + filesupload_sessionfinish_batch_entries[] entries?; }; public type sharing_transfer_folder_body record { diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index e741bd8..6d71e27 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -8,17 +8,17 @@ }, "servers": [ { - "url": "https://api.dropboxapi.com" + "url": "https://api.dropboxapi.com/2" }, { - "url": "https://content.dropboxapi.com" + "url": "https://content.dropboxapi.com/2" }, { - "url": "https://notify.dropboxapi.com" + "url": "https://notify.dropboxapi.com/2" } ], "paths": { - "/2/account/set_profile_photo": { + "/account/set_profile_photo": { "post": { "tags": [ "account" @@ -113,7 +113,7 @@ } } }, - "/2/auth/token/from_oauth1": { + "/auth/token/from_oauth1": { "post": { "tags": [ "auth" @@ -201,7 +201,7 @@ } } }, - "/2/auth/token/revoke": { + "/auth/token/revoke": { "post": { "tags": [ "auth" @@ -234,7 +234,7 @@ } } }, - "/2/check/app": { + "/check/app": { "post": { "tags": [ "check" @@ -317,7 +317,7 @@ } } }, - "/2/check/user": { + "/check/user": { "post": { "tags": [ "check" @@ -400,7 +400,7 @@ } } }, - "/2/contacts/delete_manual_contacts": { + "/contacts/delete_manual_contacts": { "post": { "tags": [ "contacts" @@ -433,7 +433,7 @@ } } }, - "/2/contacts/delete_manual_contacts_batch": { + "/contacts/delete_manual_contacts_batch": { "post": { "tags": [ "contacts" @@ -498,7 +498,7 @@ } } }, - "/2/file_properties/properties/add": { + "/file_properties/properties/add": { "post": { "tags": [ "file_properties" @@ -609,7 +609,7 @@ } } }, - "/2/file_properties/properties/overwrite": { + "/file_properties/properties/overwrite": { "post": { "tags": [ "file_properties" @@ -720,7 +720,7 @@ } } }, - "/2/file_properties/properties/remove": { + "/file_properties/properties/remove": { "post": { "tags": [ "file_properties" @@ -788,7 +788,7 @@ } } }, - "/2/file_properties/properties/search": { + "/file_properties/properties/search": { "post": { "tags": [ "file_properties" @@ -1016,7 +1016,7 @@ } } }, - "/2/file_properties/properties/search/continue": { + "/file_properties/properties/search/continue": { "post": { "tags": [ "file_properties" @@ -1195,7 +1195,7 @@ } } }, - "/2/file_properties/properties/update": { + "/file_properties/properties/update": { "post": { "tags": [ "file_properties" @@ -1313,7 +1313,7 @@ } } }, - "/2/file_properties/templates/add_for_team": { + "/file_properties/templates/add_for_team": { "post": { "tags": [ "file_properties" @@ -1422,7 +1422,7 @@ ] } }, - "/2/file_properties/templates/add_for_user": { + "/file_properties/templates/add_for_user": { "post": { "tags": [ "file_properties" @@ -1544,7 +1544,7 @@ } } }, - "/2/file_properties/templates/get_for_team": { + "/file_properties/templates/get_for_team": { "post": { "tags": [ "file_properties" @@ -1662,7 +1662,7 @@ ] } }, - "/2/file_properties/templates/get_for_user": { + "/file_properties/templates/get_for_user": { "post": { "tags": [ "file_properties" @@ -1793,7 +1793,7 @@ } } }, - "/2/file_properties/templates/list_for_team": { + "/file_properties/templates/list_for_team": { "post": { "tags": [ "file_properties" @@ -1849,7 +1849,7 @@ ] } }, - "/2/file_properties/templates/list_for_user": { + "/file_properties/templates/list_for_user": { "post": { "tags": [ "file_properties" @@ -1918,7 +1918,7 @@ } } }, - "/2/file_properties/templates/remove_for_team": { + "/file_properties/templates/remove_for_team": { "post": { "tags": [ "file_properties" @@ -1960,7 +1960,7 @@ ] } }, - "/2/file_properties/templates/remove_for_user": { + "/file_properties/templates/remove_for_user": { "post": { "tags": [ "file_properties" @@ -2015,7 +2015,7 @@ } } }, - "/2/file_properties/templates/update_for_team": { + "/file_properties/templates/update_for_team": { "post": { "tags": [ "file_properties" @@ -2129,7 +2129,7 @@ ] } }, - "/2/file_properties/templates/update_for_user": { + "/file_properties/templates/update_for_user": { "post": { "tags": [ "file_properties" @@ -2256,7 +2256,7 @@ } } }, - "/2/file_requests/count": { + "/file_requests/count": { "post": { "tags": [ "file_requests" @@ -2317,7 +2317,7 @@ } } }, - "/2/file_requests/create": { + "/file_requests/create": { "post": { "tags": [ "file_requests" @@ -2481,7 +2481,7 @@ } } }, - "/2/file_requests/delete": { + "/file_requests/delete": { "post": { "tags": [ "file_requests" @@ -2699,7 +2699,7 @@ } } }, - "/2/file_requests/delete_all_closed": { + "/file_requests/delete_all_closed": { "post": { "tags": [ "file_requests" @@ -2885,7 +2885,7 @@ } } }, - "/2/file_requests/get": { + "/file_requests/get": { "post": { "tags": [ "file_requests" @@ -3022,7 +3022,7 @@ } } }, - "/2/file_requests/list_v2": { + "/file_requests/list_v2": { "post": { "tags": [ "file_requests" @@ -3240,7 +3240,7 @@ } } }, - "/2/file_requests/list/continue": { + "/file_requests/list/continue": { "post": { "tags": [ "file_requests" @@ -3458,7 +3458,7 @@ } } }, - "/2/file_requests/update": { + "/file_requests/update": { "post": { "tags": [ "file_requests" @@ -3632,7 +3632,7 @@ } } }, - "/2/files/copy_v2": { + "/files/copy_v2": { "post": { "tags": [ "files" @@ -3905,7 +3905,7 @@ } } }, - "/2/files/copy_batch_v2": { + "/files/copy_batch_v2": { "post": { "tags": [ "files" @@ -4248,7 +4248,7 @@ } } }, - "/2/files/copy_batch/check_v2": { + "/files/copy_batch/check_v2": { "post": { "tags": [ "files" @@ -4563,7 +4563,7 @@ } } }, - "/2/files/copy_reference/get": { + "/files/copy_reference/get": { "post": { "tags": [ "files" @@ -4818,7 +4818,7 @@ } } }, - "/2/files/copy_reference/save": { + "/files/copy_reference/save": { "post": { "tags": [ "files" @@ -5068,7 +5068,7 @@ } } }, - "/2/files/create_folder_v2": { + "/files/create_folder_v2": { "post": { "tags": [ "files" @@ -5269,7 +5269,7 @@ } } }, - "/2/files/create_folder_batch": { + "/files/create_folder_batch": { "post": { "tags": [ "files" @@ -5533,7 +5533,7 @@ } } }, - "/2/files/create_folder_batch/check": { + "/files/create_folder_batch/check": { "post": { "tags": [ "files" @@ -5779,7 +5779,7 @@ } } }, - "/2/files/delete_v2": { + "/files/delete_v2": { "post": { "tags": [ "files" @@ -6032,7 +6032,7 @@ } } }, - "/2/files/delete_batch": { + "/files/delete_batch": { "post": { "tags": [ "files" @@ -6364,7 +6364,7 @@ } } }, - "/2/files/delete_batch/check": { + "/files/delete_batch/check": { "post": { "tags": [ "files" @@ -6679,7 +6679,7 @@ } } }, - "/2/files/download": { + "/files/download": { "post": { "tags": [ "files" @@ -6906,7 +6906,7 @@ } } }, - "/2/files/download_zip": { + "/files/download_zip": { "post": { "tags": [ "files" @@ -7080,7 +7080,7 @@ } } }, - "/2/files/export": { + "/files/export": { "post": { "tags": [ "files" @@ -7336,7 +7336,7 @@ } } }, - "/2/files/get_file_lock_batch": { + "/files/get_file_lock_batch": { "post": { "tags": [ "files" @@ -7697,7 +7697,7 @@ } } }, - "/2/files/get_metadata": { + "/files/get_metadata": { "post": { "tags": [ "files" @@ -7958,7 +7958,7 @@ } } }, - "/2/files/get_preview": { + "/files/get_preview": { "post": { "tags": [ "files" @@ -8185,7 +8185,7 @@ } } }, - "/2/files/get_temporary_link": { + "/files/get_temporary_link": { "post": { "tags": [ "files" @@ -8430,7 +8430,7 @@ } } }, - "/2/files/get_temporary_upload_link": { + "/files/get_temporary_upload_link": { "post": { "tags": [ "files" @@ -8545,7 +8545,7 @@ } } }, - "/2/files/get_thumbnail_v2": { + "/files/get_thumbnail_v2": { "post": { "tags": [ "files" @@ -8779,7 +8779,7 @@ } } }, - "/2/files/get_thumbnail_batch": { + "/files/get_thumbnail_batch": { "post": { "tags": [ "files" @@ -9124,7 +9124,7 @@ } } }, - "/2/files/list_folder": { + "/files/list_folder": { "post": { "tags": [ "files" @@ -9515,7 +9515,7 @@ } } }, - "/2/files/list_folder/continue": { + "/files/list_folder/continue": { "post": { "tags": [ "files" @@ -9876,7 +9876,7 @@ } } }, - "/2/files/list_folder/get_latest_cursor": { + "/files/list_folder/get_latest_cursor": { "post": { "tags": [ "files" @@ -9997,7 +9997,7 @@ } } }, - "/2/files/list_folder/longpoll": { + "/files/list_folder/longpoll": { "post": { "tags": [ "files" @@ -10093,7 +10093,7 @@ } } }, - "/2/files/list_revisions": { + "/files/list_revisions": { "post": { "tags": [ "files" @@ -10397,7 +10397,7 @@ } } }, - "/2/files/lock_file_batch": { + "/files/lock_file_batch": { "post": { "tags": [ "files" @@ -10758,7 +10758,7 @@ } } }, - "/2/files/move_v2": { + "/files/move_v2": { "post": { "tags": [ "files" @@ -11031,7 +11031,7 @@ } } }, - "/2/files/move_batch_v2": { + "/files/move_batch_v2": { "post": { "tags": [ "files" @@ -11379,7 +11379,7 @@ } } }, - "/2/files/move_batch/check_v2": { + "/files/move_batch/check_v2": { "post": { "tags": [ "files" @@ -11694,7 +11694,7 @@ } } }, - "/2/files/permanently_delete": { + "/files/permanently_delete": { "post": { "tags": [ "files" @@ -11757,7 +11757,7 @@ } } }, - "/2/files/restore": { + "/files/restore": { "post": { "tags": [ "files" @@ -12003,7 +12003,7 @@ } } }, - "/2/files/save_url": { + "/files/save_url": { "post": { "tags": [ "files" @@ -12246,7 +12246,7 @@ } } }, - "/2/files/save_url/check_job_status": { + "/files/save_url/check_job_status": { "post": { "tags": [ "files" @@ -12329,7 +12329,7 @@ } } }, - "/2/files/search_v2": { + "/files/search_v2": { "post": { "tags": [ "files" @@ -12650,7 +12650,7 @@ } } }, - "/2/files/search/continue_v2": { + "/files/search/continue_v2": { "post": { "tags": [ "files" @@ -12966,7 +12966,7 @@ } } }, - "/2/files/unlock_file_batch": { + "/files/unlock_file_batch": { "post": { "tags": [ "files" @@ -13335,7 +13335,7 @@ } } }, - "/2/files/upload": { + "/files/upload": { "post": { "tags": [ "files" @@ -13562,7 +13562,7 @@ } } }, - "/2/files/upload_session/append_v2": { + "/files/upload_session/append_v2": { "post": { "tags": [ "files" @@ -13611,7 +13611,7 @@ } } }, - "/2/files/upload_session/finish": { + "/files/upload_session/finish": { "post": { "tags": [ "files" @@ -13838,7 +13838,7 @@ } } }, - "/2/files/upload_session/finish_batch": { + "/files/upload_session/finish_batch": { "post": { "tags": [ "files" @@ -14209,7 +14209,7 @@ } } }, - "/2/files/upload_session/finish_batch/check": { + "/files/upload_session/finish_batch/check": { "post": { "tags": [ "files" @@ -14509,7 +14509,7 @@ } } }, - "/2/files/upload_session/start": { + "/files/upload_session/start": { "post": { "tags": [ "files" @@ -14586,7 +14586,7 @@ } } }, - "/2/sharing/add_file_member": { + "/sharing/add_file_member": { "post": { "tags": [ "sharing" @@ -14765,7 +14765,7 @@ } } }, - "/2/sharing/add_folder_member": { + "/sharing/add_folder_member": { "post": { "tags": [ "sharing" @@ -14899,7 +14899,7 @@ } } }, - "/2/sharing/check_job_status": { + "/sharing/check_job_status": { "post": { "tags": [ "sharing" @@ -14990,7 +14990,7 @@ } } }, - "/2/sharing/check_remove_member_job_status": { + "/sharing/check_remove_member_job_status": { "post": { "tags": [ "sharing" @@ -15081,7 +15081,7 @@ } } }, - "/2/sharing/check_share_job_status": { + "/sharing/check_share_job_status": { "post": { "tags": [ "sharing" @@ -15392,7 +15392,7 @@ } } }, - "/2/sharing/get_file_metadata": { + "/sharing/get_file_metadata": { "post": { "tags": [ "sharing" @@ -15617,7 +15617,7 @@ } } }, - "/2/sharing/get_file_metadata/batch": { + "/sharing/get_file_metadata/batch": { "post": { "tags": [ "sharing" @@ -15905,7 +15905,7 @@ } } }, - "/2/sharing/get_folder_metadata": { + "/sharing/get_folder_metadata": { "post": { "tags": [ "sharing" @@ -16217,7 +16217,7 @@ } } }, - "/2/sharing/get_shared_link_file": { + "/sharing/get_shared_link_file": { "post": { "tags": [ "sharing" @@ -16396,7 +16396,7 @@ } } }, - "/2/sharing/get_shared_link_metadata": { + "/sharing/get_shared_link_metadata": { "post": { "tags": [ "sharing" @@ -16594,7 +16594,7 @@ } } }, - "/2/sharing/list_file_members": { + "/sharing/list_file_members": { "post": { "tags": [ "sharing" @@ -16978,7 +16978,7 @@ } } }, - "/2/sharing/list_file_members/batch": { + "/sharing/list_file_members/batch": { "post": { "tags": [ "sharing" @@ -17460,7 +17460,7 @@ } } }, - "/2/sharing/list_file_members/continue": { + "/sharing/list_file_members/continue": { "post": { "tags": [ "sharing" @@ -17826,7 +17826,7 @@ } } }, - "/2/sharing/list_folder_members/continue": { + "/sharing/list_folder_members/continue": { "post": { "tags": [ "sharing" @@ -18184,7 +18184,7 @@ } } }, - "/2/sharing/list_folders": { + "/sharing/list_folders": { "post": { "tags": [ "sharing" @@ -18563,7 +18563,7 @@ } } }, - "/2/sharing/list_folders/continue": { + "/sharing/list_folders/continue": { "post": { "tags": [ "sharing" @@ -18936,7 +18936,7 @@ } } }, - "/2/sharing/list_mountable_folders": { + "/sharing/list_mountable_folders": { "post": { "tags": [ "sharing" @@ -19315,7 +19315,7 @@ } } }, - "/2/sharing/list_mountable_folders/continue": { + "/sharing/list_mountable_folders/continue": { "post": { "tags": [ "sharing" @@ -19688,7 +19688,7 @@ } } }, - "/2/sharing/list_received_files": { + "/sharing/list_received_files": { "post": { "tags": [ "sharing" @@ -19965,7 +19965,7 @@ } } }, - "/2/sharing/list_received_files/continue": { + "/sharing/list_received_files/continue": { "post": { "tags": [ "sharing" @@ -20228,7 +20228,7 @@ } } }, - "/2/sharing/list_shared_links": { + "/sharing/list_shared_links": { "post": { "tags": [ "sharing" @@ -20473,7 +20473,7 @@ } } }, - "/2/sharing/modify_shared_link_settings": { + "/sharing/modify_shared_link_settings": { "post": { "tags": [ "sharing" @@ -20693,7 +20693,7 @@ } } }, - "/2/sharing/mount_folder": { + "/sharing/mount_folder": { "post": { "tags": [ "sharing" @@ -20991,7 +20991,7 @@ } } }, - "/2/sharing/relinquish_file_membership": { + "/sharing/relinquish_file_membership": { "post": { "tags": [ "sharing" @@ -21054,7 +21054,7 @@ } } }, - "/2/sharing/relinquish_folder_membership": { + "/sharing/relinquish_folder_membership": { "post": { "tags": [ "sharing" @@ -21142,7 +21142,7 @@ } } }, - "/2/sharing/remove_file_member_2": { + "/sharing/remove_file_member_2": { "post": { "tags": [ "sharing" @@ -21250,7 +21250,7 @@ } } }, - "/2/sharing/remove_folder_member": { + "/sharing/remove_folder_member": { "post": { "tags": [ "sharing" @@ -21368,7 +21368,7 @@ } } }, - "/2/sharing/revoke_shared_link": { + "/sharing/revoke_shared_link": { "post": { "tags": [ "sharing" @@ -21431,7 +21431,7 @@ } } }, - "/2/sharing/set_access_inheritance": { + "/sharing/set_access_inheritance": { "post": { "tags": [ "sharing" @@ -21739,7 +21739,7 @@ } } }, - "/2/sharing/share_folder": { + "/sharing/share_folder": { "post": { "tags": [ "sharing" @@ -22075,7 +22075,7 @@ } } }, - "/2/sharing/transfer_folder": { + "/sharing/transfer_folder": { "post": { "tags": [ "sharing" @@ -22143,7 +22143,7 @@ } } }, - "/2/sharing/unmount_folder": { + "/sharing/unmount_folder": { "post": { "tags": [ "sharing" @@ -22206,7 +22206,7 @@ } } }, - "/2/sharing/unshare_file": { + "/sharing/unshare_file": { "post": { "tags": [ "sharing" @@ -22269,7 +22269,7 @@ } } }, - "/2/sharing/unshare_folder": { + "/sharing/unshare_folder": { "post": { "tags": [ "sharing" @@ -22365,7 +22365,7 @@ } } }, - "/2/sharing/update_file_member": { + "/sharing/update_file_member": { "post": { "tags": [ "sharing" @@ -22471,7 +22471,7 @@ } } }, - "/2/sharing/update_folder_member": { + "/sharing/update_folder_member": { "post": { "tags": [ "sharing" @@ -22577,7 +22577,7 @@ } } }, - "/2/sharing/update_folder_policy": { + "/sharing/update_folder_policy": { "post": { "tags": [ "sharing" @@ -22898,7 +22898,7 @@ } } }, - "/2/team/devices/list_member_devices": { + "/team/devices/list_member_devices": { "post": { "tags": [ "team", @@ -22951,7 +22951,7 @@ } } }, - "/2/team/devices/list_members_devices": { + "/team/devices/list_members_devices": { "post": { "tags": [ "team", @@ -22978,7 +22978,7 @@ } } }, - "/2/team/devices/revoke_device_session": { + "/team/devices/revoke_device_session": { "post": { "tags": [ "team", @@ -23026,7 +23026,7 @@ } } }, - "/2/team/devices/revoke_device_session_batch": { + "/team/devices/revoke_device_session_batch": { "post": { "tags": [ "team", @@ -23093,7 +23093,7 @@ } } }, - "/2/team/groups/create": { + "/team/groups/create": { "post": { "tags": [ "team", @@ -23399,7 +23399,7 @@ } } }, - "/2/team/groups/delete": { + "/team/groups/delete": { "post": { "tags": [ "team", @@ -23470,7 +23470,7 @@ } } }, - "/2/team/groups/get_info": { + "/team/groups/get_info": { "post": { "tags": [ "team", @@ -23845,7 +23845,7 @@ } } }, - "/2/team/groups/job_status/get": { + "/team/groups/job_status/get": { "post": { "tags": [ "team", @@ -23911,7 +23911,7 @@ } } }, - "/2/team/groups/list": { + "/team/groups/list": { "post": { "tags": [ "team", @@ -24031,7 +24031,7 @@ } } }, - "/2/team/groups/list/continue": { + "/team/groups/list/continue": { "post": { "tags": [ "team", @@ -24151,7 +24151,7 @@ } } }, - "/2/team/groups/members/add": { + "/team/groups/members/add": { "post": { "tags": [ "team", @@ -24519,7 +24519,7 @@ } } }, - "/2/team/groups/members/list": { + "/team/groups/members/list": { "post": { "tags": [ "team", @@ -24613,7 +24613,7 @@ } } }, - "/2/team/groups/members/list/continue": { + "/team/groups/members/list/continue": { "post": { "tags": [ "team", @@ -24690,7 +24690,7 @@ } } }, - "/2/team/groups/members/remove": { + "/team/groups/members/remove": { "post": { "tags": [ "team", @@ -25043,7 +25043,7 @@ } } }, - "/2/team/groups/members/set_access_type": { + "/team/groups/members/set_access_type": { "post": { "tags": [ "team", @@ -25442,7 +25442,7 @@ } } }, - "/2/team/groups/update": { + "/team/groups/update": { "post": { "tags": [ "team", @@ -25770,7 +25770,7 @@ } } }, - "/2/team/legal_holds/create_policy": { + "/team/legal_holds/create_policy": { "post": { "tags": [ "team", @@ -25916,7 +25916,7 @@ } } }, - "/2/team/legal_holds/get_policy": { + "/team/legal_holds/get_policy": { "post": { "tags": [ "team", @@ -26039,7 +26039,7 @@ } } }, - "/2/team/legal_holds/list_held_revisions": { + "/team/legal_holds/list_held_revisions": { "post": { "tags": [ "team", @@ -26190,7 +26190,7 @@ } } }, - "/2/team/legal_holds/list_held_revisions_continue": { + "/team/legal_holds/list_held_revisions_continue": { "post": { "tags": [ "team", @@ -26341,7 +26341,7 @@ } } }, - "/2/team/legal_holds/list_policies": { + "/team/legal_holds/list_policies": { "post": { "tags": [ "team", @@ -26494,7 +26494,7 @@ } } }, - "/2/team/legal_holds/release_policy": { + "/team/legal_holds/release_policy": { "post": { "tags": [ "team", @@ -26532,7 +26532,7 @@ } } }, - "/2/team/legal_holds/update_policy": { + "/team/legal_holds/update_policy": { "post": { "tags": [ "team", @@ -26668,7 +26668,7 @@ } } }, - "/2/team/linked_apps/list_member_linked_apps": { + "/team/linked_apps/list_member_linked_apps": { "post": { "tags": [ "team", @@ -26706,7 +26706,7 @@ } } }, - "/2/team/linked_apps/list_members_linked_apps": { + "/team/linked_apps/list_members_linked_apps": { "post": { "tags": [ "team", @@ -26733,7 +26733,7 @@ } } }, - "/2/team/linked_apps/revoke_linked_app": { + "/team/linked_apps/revoke_linked_app": { "post": { "tags": [ "team", @@ -26760,7 +26760,7 @@ } } }, - "/2/team/linked_apps/revoke_linked_app_batch": { + "/team/linked_apps/revoke_linked_app_batch": { "post": { "tags": [ "team", @@ -26787,7 +26787,7 @@ } } }, - "/2/team/member_space_limits/excluded_users/add": { + "/team/member_space_limits/excluded_users/add": { "post": { "tags": [ "team", @@ -26883,7 +26883,7 @@ } } }, - "/2/team/member_space_limits/excluded_users/list": { + "/team/member_space_limits/excluded_users/list": { "post": { "tags": [ "team", @@ -26960,7 +26960,7 @@ } } }, - "/2/team/member_space_limits/excluded_users/list/continue": { + "/team/member_space_limits/excluded_users/list/continue": { "post": { "tags": [ "team", @@ -27037,7 +27037,7 @@ } } }, - "/2/team/member_space_limits/excluded_users/remove": { + "/team/member_space_limits/excluded_users/remove": { "post": { "tags": [ "team", @@ -27133,7 +27133,7 @@ } } }, - "/2/team/member_space_limits/get_custom_quota": { + "/team/member_space_limits/get_custom_quota": { "post": { "tags": [ "team", @@ -27232,7 +27232,7 @@ } } }, - "/2/team/member_space_limits/remove_custom_quota": { + "/team/member_space_limits/remove_custom_quota": { "post": { "tags": [ "team", @@ -27331,7 +27331,7 @@ } } }, - "/2/team/member_space_limits/set_custom_quota": { + "/team/member_space_limits/set_custom_quota": { "post": { "tags": [ "team", @@ -27445,7 +27445,7 @@ } } }, - "/2/team/members/add": { + "/team/members/add": { "post": { "tags": [ "team", @@ -27788,7 +27788,7 @@ } } }, - "/2/team/members/add/job_status/get": { + "/team/members/add/job_status/get": { "post": { "tags": [ "team", @@ -28079,7 +28079,7 @@ } } }, - "/2/team/members/delete_profile_photo": { + "/team/members/delete_profile_photo": { "post": { "tags": [ "team", @@ -28316,7 +28316,7 @@ } } }, - "/2/team/members/get_info": { + "/team/members/get_info": { "post": { "tags": [ "team", @@ -28618,7 +28618,7 @@ } } }, - "/2/team/members/list": { + "/team/members/list": { "post": { "tags": [ "team", @@ -28913,7 +28913,7 @@ } } }, - "/2/team/members/list/continue": { + "/team/members/list/continue": { "post": { "tags": [ "team", @@ -29203,7 +29203,7 @@ } } }, - "/2/team/members/move_former_member_files": { + "/team/members/move_former_member_files": { "post": { "tags": [ "team", @@ -29315,7 +29315,7 @@ } } }, - "/2/team/members/move_former_member_files/job_status/check": { + "/team/members/move_former_member_files/job_status/check": { "post": { "tags": [ "team", @@ -29381,7 +29381,7 @@ } } }, - "/2/team/members/recover": { + "/team/members/recover": { "post": { "tags": [ "team", @@ -29431,7 +29431,7 @@ } } }, - "/2/team/members/remove": { + "/team/members/remove": { "post": { "tags": [ "team", @@ -29558,7 +29558,7 @@ } } }, - "/2/team/members/remove/job_status/get": { + "/team/members/remove/job_status/get": { "post": { "tags": [ "team", @@ -29624,7 +29624,7 @@ } } }, - "/2/team/members/secondary_emails/add": { + "/team/members/secondary_emails/add": { "post": { "tags": [ "team", @@ -29874,7 +29874,7 @@ } } }, - "/2/team/members/secondary_emails/delete": { + "/team/members/secondary_emails/delete": { "post": { "tags": [ "team", @@ -30079,7 +30079,7 @@ } } }, - "/2/team/members/secondary_emails/resend_verification_emails": { + "/team/members/secondary_emails/resend_verification_emails": { "post": { "tags": [ "team", @@ -30268,7 +30268,7 @@ } } }, - "/2/team/members/send_welcome_email": { + "/team/members/send_welcome_email": { "post": { "tags": [ "team", @@ -30311,7 +30311,7 @@ } } }, - "/2/team/members/set_admin_permissions": { + "/team/members/set_admin_permissions": { "post": { "tags": [ "team", @@ -30406,7 +30406,7 @@ } } }, - "/2/team/members/set_profile": { + "/team/members/set_profile": { "post": { "tags": [ "team", @@ -30653,7 +30653,7 @@ } } }, - "/2/team/members/set_profile_photo": { + "/team/members/set_profile_photo": { "post": { "tags": [ "team", @@ -30907,7 +30907,7 @@ } } }, - "/2/team/members/suspend": { + "/team/members/suspend": { "post": { "tags": [ "team", @@ -30962,7 +30962,7 @@ } } }, - "/2/team/members/unsuspend": { + "/team/members/unsuspend": { "post": { "tags": [ "team", @@ -31012,7 +31012,7 @@ } } }, - "/2/team/namespaces/list": { + "/team/namespaces/list": { "post": { "tags": [ "team", @@ -31146,7 +31146,7 @@ } } }, - "/2/team/namespaces/list/continue": { + "/team/namespaces/list/continue": { "post": { "tags": [ "team", @@ -31280,7 +31280,7 @@ } } }, - "/2/team/reports/get_activity": { + "/team/reports/get_activity": { "post": { "tags": [ "team", @@ -31307,7 +31307,7 @@ } } }, - "/2/team/reports/get_devices": { + "/team/reports/get_devices": { "post": { "tags": [ "team", @@ -31334,7 +31334,7 @@ } } }, - "/2/team/reports/get_membership": { + "/team/reports/get_membership": { "post": { "tags": [ "team", @@ -31361,7 +31361,7 @@ } } }, - "/2/team/reports/get_storage": { + "/team/reports/get_storage": { "post": { "tags": [ "team", @@ -31388,7 +31388,7 @@ } } }, - "/2/team/team_folder/activate": { + "/team/team_folder/activate": { "post": { "tags": [ "team", @@ -31525,7 +31525,7 @@ } } }, - "/2/team/team_folder/archive": { + "/team/team_folder/archive": { "post": { "tags": [ "team", @@ -31672,7 +31672,7 @@ } } }, - "/2/team/team_folder/archive/check": { + "/team/team_folder/archive/check": { "post": { "tags": [ "team", @@ -31814,7 +31814,7 @@ } } }, - "/2/team/team_folder/create": { + "/team/team_folder/create": { "post": { "tags": [ "team", @@ -31956,7 +31956,7 @@ } } }, - "/2/team/team_folder/get_info": { + "/team/team_folder/get_info": { "post": { "tags": [ "team", @@ -32006,7 +32006,7 @@ } } }, - "/2/team/team_folder/list": { + "/team/team_folder/list": { "post": { "tags": [ "team", @@ -32186,7 +32186,7 @@ } } }, - "/2/team/team_folder/list/continue": { + "/team/team_folder/list/continue": { "post": { "tags": [ "team", @@ -32366,7 +32366,7 @@ } } }, - "/2/team/team_folder/permanently_delete": { + "/team/team_folder/permanently_delete": { "post": { "tags": [ "team", @@ -32404,7 +32404,7 @@ } } }, - "/2/team/team_folder/rename": { + "/team/team_folder/rename": { "post": { "tags": [ "team", @@ -32546,7 +32546,7 @@ } } }, - "/2/team/team_folder/update_sync_settings": { + "/team/team_folder/update_sync_settings": { "post": { "tags": [ "team", @@ -32716,7 +32716,7 @@ } } }, - "/2/team/features/get_values": { + "/team/features/get_values": { "post": { "tags": [ "team" @@ -32869,7 +32869,7 @@ } } }, - "/2/team/get_info": { + "/team/get_info": { "post": { "tags": [ "team" @@ -33006,7 +33006,7 @@ ] } }, - "/2/team/token/get_authenticated_admin": { + "/team/token/get_authenticated_admin": { "post": { "tags": [ "team" @@ -33196,7 +33196,7 @@ } } }, - "/2/team_log/get_events": { + "/team_log/get_events": { "post": { "tags": [ "team_log" @@ -33845,7 +33845,7 @@ ] } }, - "/2/team_log/get_events/continue": { + "/team_log/get_events/continue": { "post": { "tags": [ "team_log" @@ -34489,7 +34489,7 @@ ] } }, - "/2/users/features/get_values": { + "/users/features/get_values": { "post": { "tags": [ "users" @@ -34633,7 +34633,7 @@ } } }, - "/2/users/get_account": { + "/users/get_account": { "post": { "tags": [ "users" @@ -34773,7 +34773,7 @@ } } }, - "/2/users/get_account_batch": { + "/users/get_account_batch": { "post": { "tags": [ "users" @@ -34945,7 +34945,7 @@ } } }, - "/2/users/get_current_account": { + "/users/get_current_account": { "post": { "tags": [ "users" @@ -35192,7 +35192,7 @@ } } }, - "/2/users/get_space_usage": { + "/users/get_space_usage": { "post": { "tags": [ "users" diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 403e307..96c4dbb 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -10,9 +10,22 @@ The OpenAPI specification is obtained from https://www.postman.com/dropbox-api/d These changes are done in order to improve the overall usability, and as workarounds for some known language limitations. [//]: # (TODO: Add sanitation details) -1. Add a content type and schema to each empty content in the request body. -2. -3. +1. **Change the `url` property of the `servers` object**: + - **Original**: + 1. `https://api.dropboxapi.com`, + 2. `https://content.dropboxapi.com` + 3. `https://notify.dropboxapi.com` + - **Updated**: + 1. `https://api.dropboxapi.com/2`, + 2. `https://content.dropboxapi.com/2` + 3. `https://notify.dropboxapi.com/2` + - **Reason**: This change is made to ensure that all API paths are relative to the versioned base URL (`/2`), which improves the consistency and usability of the APIs. +2. **Update API Paths**: + - **Original**: Paths included the version prefix in each endpoint (e.g., `/2/files/list_folder`). + - **Updated**: Paths are modified to remove the version prefix from the endpoints, as it is now included in the base URL. For example: + - **Original**: `/2/files/list_folder` + - **Updated**: `/files/list_folder` + - **Reason**: This modification simplifies the API paths, making them shorter and more readable. It also centralizes the versioning to the base URL, which is a common best practice. ## OpenAPI cli command From a1123989069af6410334929a609a7a6047d0e1d2 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Sun, 27 Oct 2024 05:36:27 +0530 Subject: [PATCH 09/15] Add keywords, copied from https://central.ballerina.io/ballerinax/dropbox/1.5.1 --- ballerina/Ballerina.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index 25293e8..35f64e2 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -5,7 +5,7 @@ name = "dropbox" version = "0.1.0" license = ["Apache-2.0"] authors = ["Ballerina"] -keywords = [] +keywords = ["Content & Files/File Management & Storage", "Cost/Free"] icon = "icon.png" repository = "https://github.com/ballerina-platform/module-ballerinax-dropbox" From 45e5c147eeb57482b24d6263dd79ce4388955e93 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Mon, 28 Oct 2024 16:15:54 +0530 Subject: [PATCH 10/15] Define `dropbox-api-path-root`, `dropbox-api-select-user`, and `dropbox-api-select-admin` parameters and reuse across API endpoints --- ballerina/types.bal | 282 +++--- docs/spec/openapi.json | 2006 +++++++--------------------------------- 2 files changed, 462 insertions(+), 1826 deletions(-) diff --git a/ballerina/types.bal b/ballerina/types.bal index 1111b0b..540ae23 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -30,12 +30,6 @@ public type finish_batch_check_body record { string async_job_id?; }; -public type inline_response_200_31_file_lock_info record { - string created?; - boolean is_lockholder?; - string lockholder_name?; -}; - # Represents the Headers record for the operation: checkRemoveMemberJobStatus public type CheckRemoveMemberJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -57,13 +51,6 @@ public type sharinglist_file_membersbatch_result_members_user record { string team_member_id?; }; -public type inline_response_200_15_metadata_sharing_info record { - boolean no_access?; - string parent_shared_folder_id?; - boolean read_only?; - boolean traverse_only?; -}; - public type inline_response_200_30_matches record { inline_response_200_30_metadata metadata?; }; @@ -89,6 +76,11 @@ public type sharingget_file_metadatabatch_result_policy record { sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; }; +public type inline_response_200_8_deadline record { + inline_response_200_8_deadline_allow_late_uploads allow_late_uploads?; + string deadline?; +}; + public type inline_response_200_39_team_member_info record { string display_name?; string member_id?; @@ -106,23 +98,6 @@ public type legal_holds_update_policy_body record { string[] members?; }; -public type inline_response_200_21_metadata record { - string client_modified?; - string content_hash?; - inline_response_200_31_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_31_sharing_info sharing_info?; - decimal size?; -}; - public type delete_batch_check_body record { string async_job_id?; }; @@ -213,10 +188,6 @@ public type templates_update_for_user_body record { string template_id?; }; -public type inline_response_200_77_team_sharing_policies_shared_link_create_policy record { - string \.tag?; -}; - public type team_folder_permanently_delete_body record { string team_folder_id?; }; @@ -361,6 +332,10 @@ public type sharingget_file_metadatabatch_result_policy_acl_update_policy record string \.tag?; }; +public type inline_response_200_8_deadline_allow_late_uploads record { + string \.tag?; +}; + # Represents the Headers record for the operation: permanentlyDelete public type PermanentlyDeleteHeaders record { string? dropbox\-api\-path\-root?; @@ -402,6 +377,20 @@ public type sharing_get_file_metadata_body record { string file?; }; +public type inline_response_200_14_metadata record { + string id?; + string name?; + string path_display?; + string path_lower?; + file_propertiespropertiesadd_property_groups[] property_groups?; + inline_response_200_14_metadata_sharing_info sharing_info?; +}; + +public type inline_response_200_67_content_sync_settings record { + string id?; + inline_response_200_67_sync_setting sync_setting?; +}; + public type file_requests_delete_body record { string[] ids?; }; @@ -474,6 +463,12 @@ public type sharinglist_file_membersbatch_result_members_group record { boolean same_team?; }; +public type inline_response_200_11_metadata_sharing_info record { + string modified_by?; + string parent_shared_folder_id?; + boolean read_only?; +}; + public type excluded_users_list_body record { decimal 'limit?; }; @@ -533,7 +528,7 @@ public type inline_response_200_77_account_type record { public type inline_response_200_19_entries record { string \.tag?; inline_response_200_19_lock 'lock?; - inline_response_200_30_metadata_metadata metadata?; + inline_response_200_11_metadata metadata?; }; # Represents the Headers record for the operation: checkJobStatus @@ -547,6 +542,11 @@ public type inline_response_200_66_namespace_type record { string \.tag?; }; +public type inline_response_200_53_members record { + decimal permanently_deleted_users?; + string[] team_member_ids?; +}; + public type members_suspend_body record { members_send_welcome_email_body user?; boolean wipe_data?; @@ -565,6 +565,12 @@ public type legal_holds_create_policy_body record { string start_date?; }; +public type inline_response_200_11_metadata_file_lock_info record { + string created?; + boolean is_lockholder?; + string lockholder_name?; +}; + # Represents the Headers record for the operation: move public type MoveHeaders record { string? dropbox\-api\-path\-root?; @@ -736,10 +742,6 @@ public type LockFileBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_68_sync_setting record { - string \.tag?; -}; - public type file_propertiespropertiesadd_fields record { string name?; string value?; @@ -755,7 +757,7 @@ public type inline_response_200_31_entries record { string \.tag?; string client_modified?; string content_hash?; - inline_response_200_31_file_lock_info file_lock_info?; + inline_response_200_11_metadata_file_lock_info file_lock_info?; boolean has_explicit_shared_members?; string id?; boolean is_downloadable?; @@ -765,7 +767,7 @@ public type inline_response_200_31_entries record { file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; - inline_response_200_31_sharing_info sharing_info?; + inline_response_200_11_metadata_sharing_info sharing_info?; decimal size?; }; @@ -797,7 +799,7 @@ public type inline_response_200_25_entries record { string \.tag?; string client_modified?; string content_hash?; - inline_response_200_31_file_lock_info file_lock_info?; + inline_response_200_11_metadata_file_lock_info file_lock_info?; boolean has_explicit_shared_members?; string id?; boolean is_downloadable?; @@ -846,11 +848,6 @@ public type legal_holds_list_policies_body record { boolean include_released?; }; -public type inline_response_200_55_members record { - decimal permanently_deleted_users?; - string[] team_member_ids?; -}; - public type inline_response_200_62_results_1 record { string \.tag?; members_send_welcome_email_body invalid_user?; @@ -877,10 +874,6 @@ public type RelinquishFolderMembershipHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_9_deadline_allow_late_uploads record { - string \.tag?; -}; - public type teammembersget_info_role record { string \.tag?; }; @@ -987,6 +980,10 @@ public type inline_response_200_73_actor_user record { string team_member_id?; }; +public type inline_response_200_71_policies_sharing_shared_link_create_policy record { + string \.tag?; +}; + public type sharing_unshare_file_body record { string file?; }; @@ -999,7 +996,7 @@ public type ListReceivedFilesContinueHeaders record { public type inline_response_200_24_entries record { string \.tag?; - inline_response_200_21_metadata metadata?; + inline_response_200_18_file_metadata metadata?; string thumbnail?; }; @@ -1053,7 +1050,7 @@ public type inline_response_200_7 record { public type inline_response_200_8 record { string created?; - inline_response_200_9_deadline deadline?; + inline_response_200_8_deadline deadline?; string destination?; decimal file_count?; string id?; @@ -1081,11 +1078,6 @@ public type inline_response_200_39_link_permissions record { inline_response_200_39_link_permissions_revoke_failure_reason revoke_failure_reason?; }; -public type inline_response_200_68_content_sync_settings record { - string id?; - inline_response_200_68_sync_setting sync_setting?; -}; - public type properties_overwrite_body record { string path?; file_propertiespropertiesadd_property_groups[] property_groups?; @@ -1110,6 +1102,10 @@ public type sharing_list_file_members_body record { decimal 'limit?; }; +public type inline_response_200_67_sync_setting record { + string \.tag?; +}; + # Represents the Headers record for the operation: saveUrl public type SaveUrlHeaders record { string? dropbox\-api\-path\-root?; @@ -1117,7 +1113,7 @@ public type SaveUrlHeaders record { }; public type account_set_profile_photo_body record { - accountset_profile_photo_photo photo?; + Photo photo?; }; public type sharing_update_file_member_body record { @@ -1153,12 +1149,12 @@ public type inline_response_200_4 record { }; public type members_set_profile_photo_body record { - accountset_profile_photo_photo photo?; + Photo photo?; members_send_welcome_email_body user?; }; public type inline_response_200_11 record { - inline_response_200_30_metadata_metadata metadata?; + inline_response_200_11_metadata metadata?; }; public type inline_response_200_10 record { @@ -1174,7 +1170,7 @@ public type members_recover_body record { public type inline_response_200_13 record { string copy_reference?; string expires?; - inline_response_200_30_metadata_metadata metadata?; + inline_response_200_11_metadata metadata?; }; public type inline_response_200_12 record { @@ -1205,12 +1201,12 @@ public type UserHeaders record { public type inline_response_200_18 record { inline_response_200_18_export_metadata export_metadata?; - inline_response_200_21_metadata file_metadata?; + inline_response_200_18_file_metadata file_metadata?; }; public type inline_response_200_12_entries record { string \.tag?; - inline_response_200_30_metadata_metadata success?; + inline_response_200_11_metadata success?; }; public type teammembersget_info_profile_secondary_emails record { @@ -1231,13 +1227,13 @@ public type CreateFolderHeaders record { }; public type inline_response_200_14 record { - inline_response_200_15_metadata metadata?; + inline_response_200_14_metadata metadata?; }; public type inline_response_200_17 record { string client_modified?; string content_hash?; - inline_response_200_31_file_lock_info file_lock_info?; + inline_response_200_11_metadata_file_lock_info file_lock_info?; boolean has_explicit_shared_members?; string id?; boolean is_downloadable?; @@ -1247,7 +1243,7 @@ public type inline_response_200_17 record { file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; - inline_response_200_31_sharing_info sharing_info?; + inline_response_200_11_metadata_sharing_info sharing_info?; decimal size?; }; @@ -1353,14 +1349,9 @@ public type teamgroupsget_info_access_type record { }; public type inline_response_200_71_policies record { - inline_response_200_77_team_office_addin_policy emm_state?; - inline_response_200_77_team_office_addin_policy office_addin?; - inline_response_200_77_team_sharing_policies sharing?; -}; - -public type accountset_profile_photo_photo record { - string \.tag?; - string base64_data?; + inline_response_200_71_policies_emm_state emm_state?; + inline_response_200_71_policies_emm_state office_addin?; + inline_response_200_71_policies_sharing sharing?; }; public type filesupload_sessionfinish_batch_entries record { @@ -1438,6 +1429,24 @@ public type sharing_check_job_status_body record { string async_job_id?; }; +public type inline_response_200_11_metadata record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_11_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + file_propertiespropertiesadd_property_groups[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_11_metadata_sharing_info sharing_info?; + decimal size?; +}; + # Represents the Headers record for the operation: getSpaceUsage public type GetSpaceUsageHeaders record { string? dropbox\-api\-path\-root?; @@ -1588,7 +1597,7 @@ public type inline_response_200_22 record { public type inline_response_200_21 record { string link?; - inline_response_200_21_metadata metadata?; + inline_response_200_18_file_metadata metadata?; }; public type inline_response_200_24 record { @@ -1596,14 +1605,14 @@ public type inline_response_200_24 record { }; public type inline_response_200_23 record { - inline_response_200_21_metadata file_metadata?; + inline_response_200_18_file_metadata file_metadata?; }; public type inline_response_200_20 record { string \.tag?; string client_modified?; string content_hash?; - inline_response_200_31_file_lock_info file_lock_info?; + inline_response_200_11_metadata_file_lock_info file_lock_info?; boolean has_explicit_shared_members?; string id?; boolean is_downloadable?; @@ -1613,7 +1622,7 @@ public type inline_response_200_20 record { file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; - inline_response_200_31_sharing_info sharing_info?; + inline_response_200_11_metadata_sharing_info sharing_info?; decimal size?; }; @@ -1670,7 +1679,7 @@ public type inline_response_200_28 record { string \.tag?; string client_modified?; string content_hash?; - inline_response_200_31_file_lock_info file_lock_info?; + inline_response_200_11_metadata_file_lock_info file_lock_info?; boolean has_explicit_shared_members?; string id?; boolean is_downloadable?; @@ -1680,12 +1689,12 @@ public type inline_response_200_28 record { file_propertiespropertiesadd_property_groups[] property_groups?; string rev?; string server_modified?; - inline_response_200_31_sharing_info sharing_info?; + inline_response_200_11_metadata_sharing_info sharing_info?; decimal size?; }; public type inline_response_200_27 record { - inline_response_200_21_metadata[] entries?; + inline_response_200_18_file_metadata[] entries?; boolean is_deleted?; }; @@ -1758,6 +1767,10 @@ public type inline_response_200_56 record { sharingadd_file_member_result status?; }; +public type inline_response_200_71_policies_sharing_shared_folder_join_policy record { + string \.tag?; +}; + public type inline_response_200_51 record { string async_job_id?; inline_response_200_51_group_info group_info?; @@ -1773,7 +1786,7 @@ public type inline_response_200_53 record { string activation_time?; string end_date?; string id?; - inline_response_200_55_members members?; + inline_response_200_53_members members?; string name?; string start_date?; teamgroupsget_info_profile_status status?; @@ -1805,8 +1818,8 @@ public type UnshareFileHeaders record { public type inline_response_200_77_team record { string id?; string name?; - inline_response_200_77_team_office_addin_policy office_addin_policy?; - inline_response_200_77_team_sharing_policies sharing_policies?; + inline_response_200_71_policies_emm_state office_addin_policy?; + inline_response_200_71_policies_sharing sharing_policies?; }; public type inline_response_200_59 record { @@ -1829,7 +1842,7 @@ public type list_folder_members_continue_body record { public type inline_response_200_9_file_requests record { string created?; - inline_response_200_9_deadline deadline?; + inline_response_200_8_deadline deadline?; string destination?; decimal file_count?; string id?; @@ -2031,6 +2044,11 @@ public type members_unsuspend_body record { members_send_welcome_email_body user?; }; +public type Photo record { + string \.tag?; + string base64_data?; +}; + # Represents the Headers record for the operation: export public type ExportHeaders record { string? dropbox\-api\-path\-root?; @@ -2099,20 +2117,20 @@ public type inline_response_200_65 record { public type inline_response_200_68 record { string \.tag?; - inline_response_200_68_content_sync_settings[] content_sync_settings?; + inline_response_200_67_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; teamgroupsget_info_profile_status status?; - inline_response_200_68_sync_setting sync_setting?; + inline_response_200_67_sync_setting sync_setting?; string team_folder_id?; }; public type inline_response_200_67 record { - inline_response_200_68_content_sync_settings[] content_sync_settings?; + inline_response_200_67_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; teamgroupsget_info_profile_status status?; - inline_response_200_68_sync_setting sync_setting?; + inline_response_200_67_sync_setting sync_setting?; string team_folder_id?; }; @@ -2160,10 +2178,6 @@ public type copy_reference_get_body record { string path?; }; -public type inline_response_200_77_team_sharing_policies_shared_folder_join_policy record { - string \.tag?; -}; - public type token_from_oauth1_body record { string oauth1_token?; string oauth1_token_secret?; @@ -2195,6 +2209,10 @@ public type list_folder_get_latest_cursor_body record { boolean recursive?; }; +public type inline_response_200_71_policies_emm_state record { + string \.tag?; +}; + public type sharinglist_file_membersbatch_result_members_users record { sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inherited?; @@ -2330,12 +2348,6 @@ public type inline_response_200_35_link_metadata_audience_options record { string \.tag?; }; -public type inline_response_200_77_team_sharing_policies record { - inline_response_200_77_team_sharing_policies_shared_folder_join_policy shared_folder_join_policy?; - sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; - inline_response_200_77_team_sharing_policies_shared_link_create_policy shared_link_create_policy?; -}; - public type sharing_remove_file_member_2_body record { string file?; sharingadd_file_member_members member?; @@ -2472,7 +2484,7 @@ public type teamgroupsget_info_profile_name record { public type inline_response_200_16_entries record { string \.tag?; - inline_response_200_30_metadata_metadata metadata?; + inline_response_200_11_metadata metadata?; }; public type teamgroupsget_info_profile record { @@ -2547,24 +2559,6 @@ public type members_set_admin_permissions_body record { members_send_welcome_email_body user?; }; -public type inline_response_200_30_metadata_metadata record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_31_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_31_sharing_info sharing_info?; - decimal size?; -}; - public type teamgroupsget_info_profile_status record { string \.tag?; }; @@ -2624,13 +2618,20 @@ public type files_copy_v2_body record { string to_path?; }; +public type inline_response_200_14_metadata_sharing_info record { + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; +}; + public type job_status_check_body record { string async_job_id?; }; public type inline_response_200_30_metadata record { string \.tag?; - inline_response_200_30_metadata_metadata metadata?; + inline_response_200_11_metadata metadata?; }; # Represents the Headers record for the operation: createFolderBatchCheck @@ -2735,7 +2736,7 @@ public type inline_response_200_55_policies record { string activation_time?; string end_date?; string id?; - inline_response_200_55_members members?; + inline_response_200_53_members members?; string name?; string start_date?; teamgroupsget_info_profile_status status?; @@ -2765,12 +2766,6 @@ public type sharing_share_folder_body record { string shared_link_policy?; }; -public type inline_response_200_31_sharing_info record { - string modified_by?; - string parent_shared_folder_id?; - boolean read_only?; -}; - # Represents the Headers record for the operation: uploadSessionFinishBatchCheck public type UploadSessionFinishBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2810,13 +2805,21 @@ public type files_delete_v2_body record { string path?; }; -public type inline_response_200_15_metadata record { +public type inline_response_200_18_file_metadata record { + string client_modified?; + string content_hash?; + inline_response_200_11_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; string id?; + boolean is_downloadable?; string name?; string path_display?; string path_lower?; file_propertiespropertiesadd_property_groups[] property_groups?; - inline_response_200_15_metadata_sharing_info sharing_info?; + string rev?; + string server_modified?; + inline_response_200_11_metadata_sharing_info sharing_info?; + decimal size?; }; # Represents the Headers record for the operation: copyBatch @@ -2850,11 +2853,6 @@ public type list_continue_body_1 record { string cursor?; }; -public type inline_response_200_9_deadline record { - inline_response_200_9_deadline_allow_late_uploads allow_late_uploads?; - string deadline?; -}; - public type inline_response_200_63_results record { string \.tag?; string not_found?; @@ -2880,10 +2878,6 @@ public type inline_response_200_18_export_metadata record { decimal size?; }; -public type inline_response_200_77_team_office_addin_policy record { - string \.tag?; -}; - public type list_continue_body_4 record { string cursor?; }; @@ -2962,11 +2956,11 @@ public type inline_response_200_70_has_team_shared_dropbox record { }; public type inline_response_200_69_team_folders record { - inline_response_200_68_content_sync_settings[] content_sync_settings?; + inline_response_200_67_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; teamgroupsget_info_profile_status status?; - inline_response_200_68_sync_setting sync_setting?; + inline_response_200_67_sync_setting sync_setting?; string team_folder_id?; }; @@ -3000,7 +2994,7 @@ public type ProxyConfig record {| public type inline_response_200_15_entries record { string \.tag?; - inline_response_200_15_metadata metadata?; + inline_response_200_14_metadata metadata?; }; public type copy_batch_check_v2_body record { @@ -3021,6 +3015,12 @@ public type sharing_transfer_folder_body record { string to_dropbox_id?; }; +public type inline_response_200_71_policies_sharing record { + inline_response_200_71_policies_sharing_shared_folder_join_policy shared_folder_join_policy?; + sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; + inline_response_200_71_policies_sharing_shared_link_create_policy shared_link_create_policy?; +}; + # Represents the Headers record for the operation: app public type AppHeaders record { string? dropbox\-api\-path\-root?; diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index 6d71e27..4c384d4 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -28,20 +28,10 @@ "operationId": "setProfilePhoto", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -51,17 +41,7 @@ "type": "object", "properties": { "photo": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "base64_data" - }, - "base64_data": { - "type": "string", - "example": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - } - } + "$ref": "#/components/schemas/Photo" } } }, @@ -123,20 +103,10 @@ "operationId": "tokenFromOauth1", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -211,20 +181,10 @@ "operationId": "tokenRevoke", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -244,20 +204,10 @@ "operationId": "app", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -327,20 +277,10 @@ "operationId": "user", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -410,20 +350,10 @@ "operationId": "deleteManualContacts", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -443,20 +373,10 @@ "operationId": "deleteManualContactsBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -508,20 +428,10 @@ "operationId": "propertiesAdd", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -619,20 +529,10 @@ "operationId": "propertiesOverwrite", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -730,20 +630,10 @@ "operationId": "propertiesRemove", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -798,20 +688,10 @@ "operationId": "propertiesSearch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -1026,20 +906,10 @@ "operationId": "propertiesSearchContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -1205,20 +1075,10 @@ "operationId": "propertiesUpdate", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -1432,20 +1292,10 @@ "operationId": "templatesAddForUser", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -1672,20 +1522,10 @@ "operationId": "templatesGetForUser", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -1859,20 +1699,10 @@ "operationId": "templatesListForUser", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -1970,20 +1800,10 @@ "operationId": "templatesRemoveForUser", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -2139,20 +1959,10 @@ "operationId": "templatesUpdateForUser", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -2266,20 +2076,10 @@ "operationId": "count", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -2327,20 +2127,10 @@ "operationId": "create", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -2491,20 +2281,10 @@ "operationId": "delete", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -2709,20 +2489,10 @@ "operationId": "deleteAllClosed", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -2895,20 +2665,10 @@ "operationId": "get", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -3032,20 +2792,10 @@ "operationId": "list", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -3250,20 +3000,10 @@ "operationId": "listContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -3468,20 +3208,10 @@ "operationId": "update", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -3642,28 +3372,13 @@ "operationId": "copy", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -3915,28 +3630,13 @@ "operationId": "copyBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -4258,28 +3958,13 @@ "operationId": "copyBatchCheck", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -4573,20 +4258,10 @@ "operationId": "copyReferenceGet", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -4828,20 +4503,10 @@ "operationId": "copyReferenceSave", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -5078,28 +4743,13 @@ "operationId": "createFolder", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -5279,28 +4929,13 @@ "operationId": "createFolderBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -5543,28 +5178,13 @@ "operationId": "createFolderBatchCheck", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -5789,28 +5409,13 @@ "operationId": "delete1", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -6042,28 +5647,13 @@ "operationId": "deleteBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -6374,28 +5964,13 @@ "operationId": "deleteBatchCheck", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -6697,28 +6272,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -6924,20 +6484,10 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -7098,28 +6648,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -7346,20 +6881,10 @@ "operationId": "getFileLockBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -7707,28 +7232,13 @@ "operationId": "getMetadata", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -7976,28 +7486,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -8195,20 +7690,10 @@ "operationId": "getTemporaryLink", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -8440,20 +7925,10 @@ "operationId": "getTemporaryUploadLink", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -8563,28 +8038,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -8789,28 +8249,13 @@ "operationId": "getThumbnailBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -9134,28 +8579,13 @@ "operationId": "listFolder", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -9525,28 +8955,13 @@ "operationId": "listFolderContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -9886,28 +9301,13 @@ "operationId": "listFolderGetLatestCursor", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -10007,28 +9407,13 @@ "operationId": "listFolderLongpoll", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -10103,28 +9488,13 @@ "operationId": "listRevisions", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -10407,20 +9777,10 @@ "operationId": "lockFileBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -10768,28 +10128,13 @@ "operationId": "move", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -11041,28 +10386,13 @@ "operationId": "moveBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -11389,28 +10719,13 @@ "operationId": "moveBatchCheck", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -11704,28 +11019,13 @@ "operationId": "permanentlyDelete", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -11767,28 +11067,13 @@ "operationId": "restore", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -12013,20 +11298,10 @@ "operationId": "saveUrl", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -12256,20 +11531,10 @@ "operationId": "saveUrlCheckJobStatus", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -12339,20 +11604,10 @@ "operationId": "search", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -12660,20 +11915,10 @@ "operationId": "searchContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -12976,28 +12221,13 @@ "operationId": "unlockFileBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -13353,28 +12583,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -13580,28 +12795,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -13629,28 +12829,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -13848,28 +13033,13 @@ "operationId": "uploadSessionFinishBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -14219,28 +13389,13 @@ "operationId": "uploadSessionFinishBatchCheck", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -14527,28 +13682,13 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -14596,28 +13736,13 @@ "operationId": "addFileMember", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -14775,28 +13900,13 @@ "operationId": "addFolderMember", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -14909,28 +14019,13 @@ "operationId": "checkJobStatus", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -15000,28 +14095,13 @@ "operationId": "checkRemoveMemberJobStatus", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -15091,28 +14171,13 @@ "operationId": "checkShareJobStatus", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -15402,28 +14467,13 @@ "operationId": "getFileMetadata", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -15627,20 +14677,10 @@ "operationId": "getFileMetadataBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -15915,28 +14955,13 @@ "operationId": "getFolderMetadata", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -16235,20 +15260,10 @@ } }, { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -16406,20 +15421,10 @@ "operationId": "getSharedLinkMetadata", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -16604,28 +15609,13 @@ "operationId": "listFileMembers", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -16988,20 +15978,10 @@ "operationId": "listFileMembersBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -17470,20 +16450,10 @@ "operationId": "listFileMembersContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -17836,28 +16806,13 @@ "operationId": "listFolderMembersContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -18194,20 +17149,10 @@ "operationId": "listFolders", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -18573,20 +17518,10 @@ "operationId": "listFoldersContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -18946,20 +17881,10 @@ "operationId": "listMountableFolders", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -19325,20 +18250,10 @@ "operationId": "listMountableFoldersContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -19698,28 +18613,13 @@ "operationId": "listReceivedFiles", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -19975,20 +18875,10 @@ "operationId": "listReceivedFilesContinue", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -20238,20 +19128,10 @@ "operationId": "listSharedLinks", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -20483,20 +19363,10 @@ "operationId": "modifySharedLinkSettings", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -20703,20 +19573,10 @@ "operationId": "mountFolder", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -21001,28 +19861,13 @@ "operationId": "relinquishFileMembership", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -21064,20 +19909,10 @@ "operationId": "relinquishFolderMembership", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -21152,28 +19987,13 @@ "operationId": "removeFileMember2", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -21260,28 +20080,13 @@ "operationId": "removeFolderMember", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -21378,28 +20183,13 @@ "operationId": "revokeSharedLink", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -21441,20 +20231,10 @@ "operationId": "setAccessInheritance", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -21749,28 +20529,13 @@ "operationId": "shareFolder", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -22085,28 +20850,13 @@ "operationId": "transferFolder", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -22153,28 +20903,13 @@ "operationId": "unmountFolder", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -22216,28 +20951,13 @@ "operationId": "unshareFile", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -22279,28 +20999,13 @@ "operationId": "unshareFolder", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -22375,28 +21080,13 @@ "operationId": "updateFileMember", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -22481,28 +21171,13 @@ "operationId": "updateFolderMember", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -22587,28 +21262,13 @@ "operationId": "updateFolderPolicy", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "requestBody": { @@ -30669,17 +29329,7 @@ "type": "object", "properties": { "photo": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "base64_data" - }, - "base64_data": { - "type": "string", - "example": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - } - } + "$ref": "#/components/schemas/Photo" }, "user": { "type": "object", @@ -34499,20 +33149,10 @@ "operationId": "featuresGetValues1", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -34643,20 +33283,10 @@ "operationId": "getAccount", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -34783,20 +33413,10 @@ "operationId": "getAccountBatch", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "requestBody": { @@ -34955,28 +33575,13 @@ "operationId": "getCurrentAccount", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" }, { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectAdmin" } ], "responses": { @@ -35202,20 +33807,10 @@ "operationId": "getSpaceUsage", "parameters": [ { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } + "$ref": "#/components/parameters/DropboxApiPathRoot" }, { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } + "$ref": "#/components/parameters/DropboxApiSelectUser" } ], "responses": { @@ -35272,6 +33867,47 @@ } }, "components": { + "schemas": { + "Photo": { + "type": "object", + "properties": { + ".tag": { + "type": "string", + "example": "base64_data" + }, + "base64_data": { + "type": "string", + "example": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" + } + } + } + }, + "parameters": { + "DropboxApiPathRoot": { + "name": "dropbox-api-path-root", + "in": "header", + "schema": { + "type": "string", + "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + } + }, + "DropboxApiSelectUser": { + "name": "dropbox-api-select-user", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + }, + "DropboxApiSelectAdmin": { + "name": "dropbox-api-select-admin", + "in": "header", + "schema": { + "type": "string", + "example": "dbmid:FDFSVF-DFSDF" + } + } + }, "securitySchemes": { "bearerAuth": { "type": "http", @@ -35351,4 +33987,4 @@ "description": "This namespace contains endpoints and data types for user management.\n" } ] -} +} \ No newline at end of file From d493a13d05452ba59229250af208178ebdc318b1 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Tue, 29 Oct 2024 01:02:27 +0530 Subject: [PATCH 11/15] Use named schemes in OpenAPI spec --- ballerina/client.bal | 318 +- ballerina/types.bal | 1736 +- docs/spec/openapi.json | 33990 --------------------------------------- docs/spec/openapi.yaml | 16368 +++++++++++++++++++ 4 files changed, 17395 insertions(+), 35017 deletions(-) delete mode 100644 docs/spec/openapi.json create mode 100644 docs/spec/openapi.yaml diff --git a/ballerina/client.bal b/ballerina/client.bal index 62ac88f..d5453bb 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -109,7 +109,7 @@ public isolated client class Client { return; } - resource isolated function post 'check/app(check_app_body payload, AppHeaders headers = {}) returns inline_response_200_2|error { + resource isolated function post 'check/app(CheckAppRequest payload, AppHeaders headers = {}) returns inline_response_200|error { string resourcePath = string `/check/app`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -118,7 +118,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post 'check/user(check_user_body payload, UserHeaders headers = {}) returns inline_response_200_2|error { + resource isolated function post 'check/user(CheckUserRequest payload, UserHeaders headers = {}) returns inline_response_200|error { string resourcePath = string `/check/user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -131,7 +131,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - set_profile_photo response - resource isolated function post account/set_profile_photo(account_set_profile_photo_body payload, SetProfilePhotoHeaders headers = {}) returns inline_response_200|error { + resource isolated function post account/set_profile_photo(SetProfilePhotoRequest payload, SetProfilePhotoHeaders headers = {}) returns SetProfilePhotoResponse|error { string resourcePath = string `/account/set_profile_photo`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -144,7 +144,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - token/from_oauth1 response - resource isolated function post auth/token/from_oauth1(token_from_oauth1_body payload, TokenFromOauth1Headers headers = {}) returns inline_response_200_1|error { + resource isolated function post auth/token/from_oauth1(TokenFromOauth1Request payload, TokenFromOauth1Headers headers = {}) returns TokenFromOauth1Response|error { string resourcePath = string `/auth/token/from_oauth1`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -176,7 +176,7 @@ public isolated client class Client { # delete_manual_contacts_batch # # + headers - Headers to be sent with the request - resource isolated function post contacts/delete_manual_contacts_batch(contacts_delete_manual_contacts_batch_body payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { + resource isolated function post contacts/delete_manual_contacts_batch(DeleteManualContactsBatchRequest payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { string resourcePath = string `/contacts/delete_manual_contacts_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -188,7 +188,7 @@ public isolated client class Client { # properties/add # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/add(properties_add_body payload, PropertiesAddHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/add(AddPropertiesRequest payload, PropertiesAddHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/add`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -200,7 +200,7 @@ public isolated client class Client { # properties/overwrite # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/overwrite(properties_overwrite_body payload, PropertiesOverwriteHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/overwrite(OverwritePropertiesRequest payload, PropertiesOverwriteHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/overwrite`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -212,7 +212,7 @@ public isolated client class Client { # properties/remove # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/remove(properties_remove_body payload, PropertiesRemoveHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/remove(RemovePropertiesRequest payload, PropertiesRemoveHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/remove`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -225,7 +225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - properties/search response - resource isolated function post file_properties/properties/search(properties_search_body payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_3|error { + resource isolated function post file_properties/properties/search(SearchPropertiesRequest payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_1|error { string resourcePath = string `/file_properties/properties/search`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -234,7 +234,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_properties/properties/search/'continue(search_continue_body payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_3|error { + resource isolated function post file_properties/properties/search/'continue(SearchPropertiesContinueRequest payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_1|error { string resourcePath = string `/file_properties/properties/search/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -246,7 +246,7 @@ public isolated client class Client { # properties/update # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/update(properties_update_body payload, PropertiesUpdateHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/update(UpdatePropertiesRequest payload, PropertiesUpdateHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -259,7 +259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_team response - resource isolated function post file_properties/templates/add_for_team(templates_add_for_team_body payload, map headers = {}) returns inline_response_200_4|error { + resource isolated function post file_properties/templates/add_for_team(AddTemplateForTeam payload, map headers = {}) returns inline_response_200_2|error { string resourcePath = string `/file_properties/templates/add_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -271,7 +271,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_user response - resource isolated function post file_properties/templates/add_for_user(templates_add_for_user_body payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_4|error { + resource isolated function post file_properties/templates/add_for_user(AddTemplateForUser payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_2|error { string resourcePath = string `/file_properties/templates/add_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -284,7 +284,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_team response - resource isolated function post file_properties/templates/get_for_team(templates_get_for_team_body payload, map headers = {}) returns inline_response_200_5|error { + resource isolated function post file_properties/templates/get_for_team(GetTemplateForTeam payload, map headers = {}) returns inline_response_200_3|error { string resourcePath = string `/file_properties/templates/get_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -296,7 +296,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_user response - resource isolated function post file_properties/templates/get_for_user(templates_get_for_user_body payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_5|error { + resource isolated function post file_properties/templates/get_for_user(GetTemplateForUserRequest payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_3|error { string resourcePath = string `/file_properties/templates/get_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -309,7 +309,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_team response - resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_6|error { + resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_4|error { string resourcePath = string `/file_properties/templates/list_for_team`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -319,7 +319,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_user response - resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_6|error { + resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_4|error { string resourcePath = string `/file_properties/templates/list_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -329,7 +329,7 @@ public isolated client class Client { # templates/remove_for_team # # + headers - Headers to be sent with the request - resource isolated function post file_properties/templates/remove_for_team(templates_remove_for_team_body payload, map headers = {}) returns error? { + resource isolated function post file_properties/templates/remove_for_team(RemoveTemplateForTeamRequest payload, map headers = {}) returns error? { string resourcePath = string `/file_properties/templates/remove_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -340,7 +340,7 @@ public isolated client class Client { # templates/remove_for_user # # + headers - Headers to be sent with the request - resource isolated function post file_properties/templates/remove_for_user(templates_remove_for_user_body payload, TemplatesRemoveForUserHeaders headers = {}) returns error? { + resource isolated function post file_properties/templates/remove_for_user(TemplateId payload, TemplatesRemoveForUserHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/templates/remove_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -353,7 +353,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_team response - resource isolated function post file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns templates_remove_for_user_body|error { + resource isolated function post file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -365,7 +365,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_user response - resource isolated function post file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns templates_remove_for_user_body|error { + resource isolated function post file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -378,7 +378,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - count response - resource isolated function post file_requests/count(CountHeaders headers = {}) returns inline_response_200_7|error { + resource isolated function post file_requests/count(CountHeaders headers = {}) returns inline_response_200_5|error { string resourcePath = string `/file_requests/count`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -389,7 +389,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create response - resource isolated function post file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_6|error { string resourcePath = string `/file_requests/create`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -402,7 +402,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_9|error { + resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_7|error { string resourcePath = string `/file_requests/delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -415,7 +415,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_all_closed response - resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_9|error { + resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_7|error { string resourcePath = string `/file_requests/delete_all_closed`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -426,7 +426,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get response - resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_6|error { string resourcePath = string `/file_requests/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -435,7 +435,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_8|error { string resourcePath = string `/file_requests/list/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -448,7 +448,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list response - resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_8|error { string resourcePath = string `/file_requests/list_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -461,7 +461,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update response - resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_6|error { string resourcePath = string `/file_requests/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -474,7 +474,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch/check response - resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/copy_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -487,7 +487,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch response - resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/copy_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -500,7 +500,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/get response - resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_13|error { + resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_11|error { string resourcePath = string `/files/copy_reference/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -513,7 +513,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/save response - resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_11|error { + resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/copy_reference/save`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -526,7 +526,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy response - resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_11|error { + resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/copy_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -539,7 +539,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder_batch response - resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_13|error { string resourcePath = string `/files/create_folder_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -548,7 +548,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_13|error { string resourcePath = string `/files/create_folder_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -561,7 +561,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder response - resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_14|error { + resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/files/create_folder_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -574,7 +574,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_batch response - resource isolated function post files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_16|error { + resource isolated function post files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_14|error { string resourcePath = string `/files/delete_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -583,7 +583,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_16|error { + resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_14|error { string resourcePath = string `/files/delete_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -596,7 +596,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_11|error { + resource isolated function post files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/delete_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -609,7 +609,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - download response - resource isolated function post files/download(DownloadHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/download(DownloadHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/download`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -620,7 +620,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - download_zip response - resource isolated function post files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_14|error { + resource isolated function post files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/files/download_zip`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -631,7 +631,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - export response - resource isolated function post files/export(ExportHeaders headers = {}) returns inline_response_200_18|error { + resource isolated function post files/export(ExportHeaders headers = {}) returns inline_response_200_16|error { string resourcePath = string `/files/export`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -642,7 +642,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_lock_batch response - resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_19|error { + resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/files/get_file_lock_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -655,7 +655,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_metadata response - resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_20|error { + resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_18|error { string resourcePath = string `/files/get_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -668,7 +668,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_preview response - resource isolated function post files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/get_preview`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -679,7 +679,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_link response - resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_21|error { + resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_19|error { string resourcePath = string `/files/get_temporary_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -692,7 +692,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_upload_link response - resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_22|error { + resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_20|error { string resourcePath = string `/files/get_temporary_upload_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -705,7 +705,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail_batch response - resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_24|error { + resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_22|error { string resourcePath = string `/files/get_thumbnail_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -718,7 +718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail response - resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_23|error { + resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_21|error { string resourcePath = string `/files/get_thumbnail_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -729,7 +729,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder response - resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_25|error { + resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_23|error { string resourcePath = string `/files/list_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -738,7 +738,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_25|error { + resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_23|error { string resourcePath = string `/files/list_folder/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -764,7 +764,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder/longpoll response - resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_26|error { + resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_24|error { string resourcePath = string `/files/list_folder/longpoll`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -777,7 +777,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_revisions response - resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_27|error { + resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_25|error { string resourcePath = string `/files/list_revisions`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -790,7 +790,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - lock_file_batch response - resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_19|error { + resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/files/lock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -803,7 +803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch/check response - resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/move_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -816,7 +816,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch response - resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/move_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -829,7 +829,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move response - resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_11|error { + resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/move_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -854,7 +854,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - restore response - resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/restore`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -867,7 +867,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url response - resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_28|error { + resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_26|error { string resourcePath = string `/files/save_url`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -880,7 +880,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url/check_job_status response - resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { + resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_27|error { string resourcePath = string `/files/save_url/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -893,7 +893,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search/continue response - resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_30|error { + resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_28|error { string resourcePath = string `/files/search/continue_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -906,7 +906,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search response - resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_30|error { + resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_28|error { string resourcePath = string `/files/search_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -919,7 +919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unlock_file_batch response - resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_19|error { + resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/files/unlock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -932,14 +932,14 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload response - resource isolated function post files/upload(UploadHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/upload(UploadHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/upload`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_32|error { + resource isolated function post files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_30|error { string resourcePath = string `/files/upload_session/start`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -960,7 +960,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload_session/finish response - resource isolated function post files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/upload_session/finish`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -971,7 +971,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload_session/finish_batch response - resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_31|error { + resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_29|error { string resourcePath = string `/files/upload_session/finish_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -980,7 +980,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_31|error { + resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_29|error { string resourcePath = string `/files/upload_session/finish_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -993,7 +993,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - add_file_member response - resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_33[]|error { + resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_31[]|error { string resourcePath = string `/sharing/add_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1018,7 +1018,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_job_status response - resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { + resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_27|error { string resourcePath = string `/sharing/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1031,7 +1031,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_remove_member_job_status response - resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_34|error { + resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_32|error { string resourcePath = string `/sharing/check_remove_member_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1044,7 +1044,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_share_job_status response - resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_35|error { + resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_33|error { string resourcePath = string `/sharing/check_share_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1057,7 +1057,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata response - resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_36|error { + resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_34|error { string resourcePath = string `/sharing/get_file_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1070,7 +1070,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata/batch response - resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_37[]|error { + resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_35[]|error { string resourcePath = string `/sharing/get_file_metadata/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1083,7 +1083,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_folder_metadata response - resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_36|error { string resourcePath = string `/sharing/get_folder_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1096,7 +1096,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_shared_link_file response - resource isolated function post sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_39|error { + resource isolated function post sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_37|error { string resourcePath = string `/sharing/get_shared_link_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1107,7 +1107,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_shared_link_metadata response - resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_39|error { + resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_37|error { string resourcePath = string `/sharing/get_shared_link_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1120,7 +1120,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members response - resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_40|error { + resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_38|error { string resourcePath = string `/sharing/list_file_members`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1129,7 +1129,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_40|error { + resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_38|error { string resourcePath = string `/sharing/list_file_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1142,7 +1142,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members/batch response - resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_41[]|error { + resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_39[]|error { string resourcePath = string `/sharing/list_file_members/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1151,7 +1151,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_42|error { + resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_40|error { string resourcePath = string `/sharing/list_folder_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1164,7 +1164,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folders response - resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1173,7 +1173,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1186,7 +1186,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_mountable_folders response - resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_mountable_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1195,7 +1195,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_mountable_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1208,7 +1208,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_received_files response - resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_44|error { + resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_42|error { string resourcePath = string `/sharing/list_received_files`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1217,7 +1217,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_44|error { + resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_42|error { string resourcePath = string `/sharing/list_received_files/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1230,7 +1230,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_shared_links response - resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_45|error { + resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_43|error { string resourcePath = string `/sharing/list_shared_links`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1243,7 +1243,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - modify_shared_link_settings response - resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_39|error { + resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_37|error { string resourcePath = string `/sharing/modify_shared_link_settings`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1256,7 +1256,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - mount_folder response - resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_36|error { string resourcePath = string `/sharing/mount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1281,7 +1281,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - relinquish_folder_membership response - resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_34|error { + resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_32|error { string resourcePath = string `/sharing/relinquish_folder_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1294,7 +1294,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_file_member_2 response - resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_46|error { + resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_44|error { string resourcePath = string `/sharing/remove_file_member_2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1307,7 +1307,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_folder_member response - resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_47|error { + resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_45|error { string resourcePath = string `/sharing/remove_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1332,7 +1332,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - set_access_inheritance response - resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_35|error { + resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_33|error { string resourcePath = string `/sharing/set_access_inheritance`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1345,7 +1345,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - share_folder response - resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_35|error { + resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_33|error { string resourcePath = string `/sharing/share_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1394,7 +1394,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unshare_folder response - resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_34|error { + resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_32|error { string resourcePath = string `/sharing/unshare_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1433,7 +1433,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update_folder_policy response - resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_36|error { string resourcePath = string `/sharing/update_folder_policy`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1489,7 +1489,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_70|error { + resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_68|error { string resourcePath = string `/team/features/get_values`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1501,7 +1501,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_info response - resource isolated function post team/get_info(map headers = {}) returns inline_response_200_71|error { + resource isolated function post team/get_info(map headers = {}) returns inline_response_200_69|error { string resourcePath = string `/team/get_info`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -1511,7 +1511,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/create response - resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_48|error { + resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_46|error { string resourcePath = string `/team/groups/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1523,7 +1523,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/delete response - resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/groups/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1535,7 +1535,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/get_info response - resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_49[]|error { + resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_47[]|error { string resourcePath = string `/team/groups/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1547,7 +1547,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/job_status/get response - resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/groups/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1559,7 +1559,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/list response - resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_50|error { + resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_48|error { string resourcePath = string `/team/groups/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1567,7 +1567,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_50|error { + resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_48|error { string resourcePath = string `/team/groups/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1579,7 +1579,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/add response - resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_51|error { + resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_49|error { string resourcePath = string `/team/groups/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1591,7 +1591,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/list response - resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_52|error { + resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_50|error { string resourcePath = string `/team/groups/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1599,7 +1599,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_52|error { + resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_50|error { string resourcePath = string `/team/groups/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1611,7 +1611,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/remove response - resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_51|error { + resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_49|error { string resourcePath = string `/team/groups/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1623,7 +1623,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/set_access_type response - resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_49[]|error { + resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_47[]|error { string resourcePath = string `/team/groups/members/set_access_type`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1635,7 +1635,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/update response - resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_48|error { + resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_46|error { string resourcePath = string `/team/groups/update`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1647,7 +1647,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/create_policy response - resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_53|error { + resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/team/legal_holds/create_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1659,7 +1659,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/get_policy response - resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_53|error { + resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/team/legal_holds/get_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1671,7 +1671,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions response - resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_54|error { + resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_52|error { string resourcePath = string `/team/legal_holds/list_held_revisions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1683,7 +1683,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions_continue response - resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_54|error { + resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_52|error { string resourcePath = string `/team/legal_holds/list_held_revisions_continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1695,7 +1695,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_policies response - resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_55|error { + resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_53|error { string resourcePath = string `/team/legal_holds/list_policies`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1718,7 +1718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/update_policy response - resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_53|error { + resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/team/legal_holds/update_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1771,7 +1771,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/add response - resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_56|error { + resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_54|error { string resourcePath = string `/team/member_space_limits/excluded_users/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1783,7 +1783,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/list response - resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_57|error { + resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_55|error { string resourcePath = string `/team/member_space_limits/excluded_users/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1791,7 +1791,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_57|error { + resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_55|error { string resourcePath = string `/team/member_space_limits/excluded_users/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1803,7 +1803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/remove response - resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_56|error { + resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_54|error { string resourcePath = string `/team/member_space_limits/excluded_users/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1815,7 +1815,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/get_custom_quota response - resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { string resourcePath = string `/team/member_space_limits/get_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1827,7 +1827,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/remove_custom_quota response - resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { string resourcePath = string `/team/member_space_limits/remove_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1839,7 +1839,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/set_custom_quota response - resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { string resourcePath = string `/team/member_space_limits/set_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1851,7 +1851,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add response - resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_58|error { + resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_56|error { string resourcePath = string `/team/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1863,7 +1863,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add/job_status/get response - resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_58|error { + resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_56|error { string resourcePath = string `/team/members/add/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1875,7 +1875,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/delete_profile_photo response - resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/team/members/delete_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1887,7 +1887,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/get_info response - resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_60[]|error { + resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_58[]|error { string resourcePath = string `/team/members/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1899,7 +1899,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/list response - resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_61|error { + resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_59|error { string resourcePath = string `/team/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1907,7 +1907,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_61|error { + resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_59|error { string resourcePath = string `/team/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1919,7 +1919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/move_former_member_files response - resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/move_former_member_files`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1927,7 +1927,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/move_former_member_files/job_status/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1950,7 +1950,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove response - resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1962,7 +1962,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove/job_status/get response - resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/remove/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1974,7 +1974,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/add response - resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_62|error { + resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_60|error { string resourcePath = string `/team/members/secondary_emails/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1986,7 +1986,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/delete response - resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_63|error { + resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_61|error { string resourcePath = string `/team/members/secondary_emails/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1998,7 +1998,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/resend_verification_emails response - resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_64|error { + resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_62|error { string resourcePath = string `/team/members/secondary_emails/resend_verification_emails`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2021,7 +2021,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_admin_permissions response - resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_65|error { + resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_63|error { string resourcePath = string `/team/members/set_admin_permissions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2033,7 +2033,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile response - resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/team/members/set_profile`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2045,7 +2045,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile_photo response - resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/team/members/set_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2079,7 +2079,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - namespaces/list response - resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_66|error { + resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_64|error { string resourcePath = string `/team/namespaces/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2087,7 +2087,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_66|error { + resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_64|error { string resourcePath = string `/team/namespaces/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2139,7 +2139,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/activate response - resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/activate`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2151,7 +2151,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/archive response - resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_68|error { + resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_66|error { string resourcePath = string `/team/team_folder/archive`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2159,7 +2159,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_68|error { + resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_66|error { string resourcePath = string `/team/team_folder/archive/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2171,7 +2171,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/create response - resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2194,7 +2194,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/list response - resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_69|error { + resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/team/team_folder/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2202,7 +2202,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_69|error { + resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/team/team_folder/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2225,7 +2225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/rename response - resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/rename`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2237,7 +2237,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/update_sync_settings response - resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/update_sync_settings`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2249,7 +2249,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - token/get_authenticated_admin response - resource isolated function post team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_72|error { + resource isolated function post team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_70|error { string resourcePath = string `/team/token/get_authenticated_admin`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -2259,7 +2259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_events response - resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_73|error { + resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_71|error { string resourcePath = string `/team_log/get_events`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2267,7 +2267,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_73|error { + resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_71|error { string resourcePath = string `/team_log/get_events/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2279,7 +2279,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_74|error { + resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_72|error { string resourcePath = string `/users/features/get_values`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2292,7 +2292,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account response - resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_75|error { + resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_73|error { string resourcePath = string `/users/get_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2305,7 +2305,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account_batch response - resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_76[]|error { + resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_74[]|error { string resourcePath = string `/users/get_account_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2318,7 +2318,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_current_account response - resource isolated function post users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_77|error { + resource isolated function post users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_75|error { string resourcePath = string `/users/get_current_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2329,7 +2329,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_space_usage response - resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_78|error { + resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_76|error { string resourcePath = string `/users/get_space_usage`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; diff --git a/ballerina/types.bal b/ballerina/types.bal index 540ae23..b4d8831 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -26,10 +26,30 @@ public type CreateFolderBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type PropertyGroup record { + PropertyField[] fields?; + string template_id?; +}; + public type finish_batch_check_body record { string async_job_id?; }; +public type inline_response_200_41_entries record { + inline_response_200_33_access_inheritance access_inheritance?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inside_team_folder?; + boolean is_team_folder?; + inline_response_200_33_link_metadata link_metadata?; + string name?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string shared_folder_id?; + string time_invited?; +}; + # Represents the Headers record for the operation: checkRemoveMemberJobStatus public type CheckRemoveMemberJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -51,22 +71,15 @@ public type sharinglist_file_membersbatch_result_members_user record { string team_member_id?; }; -public type inline_response_200_30_matches record { - inline_response_200_30_metadata metadata?; -}; - public type list_folder_longpoll_body record { string cursor?; decimal timeout?; }; -public type inline_response_200_73_event_category record { - string \.tag?; -}; - -public type file_propertiespropertiessearch_mode record { - string \.tag?; - string field_name?; +public type inline_response_200_9_metadata_file_lock_info record { + string created?; + boolean is_lockholder?; + string lockholder_name?; }; public type sharingget_file_metadatabatch_result_policy record { @@ -76,23 +89,26 @@ public type sharingget_file_metadatabatch_result_policy record { sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; }; -public type inline_response_200_8_deadline record { - inline_response_200_8_deadline_allow_late_uploads allow_late_uploads?; - string deadline?; -}; - -public type inline_response_200_39_team_member_info record { - string display_name?; - string member_id?; - sharingget_file_metadatabatch_result_owner_team team_info?; -}; - public type groups_create_body record { boolean add_creator_as_owner?; string group_external_id?; string group_name?; }; +public type inline_response_200_43_links record { + string \.tag?; + string client_modified?; + string id?; + inline_response_200_37_link_permissions link_permissions?; + string name?; + string path_lower?; + string rev?; + string server_modified?; + decimal size?; + inline_response_200_37_team_member_info team_member_info?; + string url?; +}; + public type legal_holds_update_policy_body record { string id?; string[] members?; @@ -102,16 +118,21 @@ public type delete_batch_check_body record { string async_job_id?; }; -public type inline_response_200_73_path record { - string contextual?; - inline_response_200_73_path_namespace_relative namespace_relative?; -}; - public type teammemberssecondary_emailsadd_new_secondary_emails record { string[] secondary_emails?; teamgroupsmembersadd_user user?; }; +public type inline_response_200_72_values record { + string \.tag?; + inline_response_200_72_paper_as_files paper_as_files?; +}; + +public type inline_response_200_59_members record { + teammembersget_info_profile profile?; + teammembersget_info_role role?; +}; + public type sharingadd_file_member_result record { string \.tag?; }; @@ -173,21 +194,22 @@ public type SetProfilePhotoHeaders record { string? dropbox\-api\-select\-user?; }; -public type templates_remove_for_team_body record { - string template_id?; -}; - public type file_requests_get_body record { string id?; }; public type templates_update_for_user_body record { - file_propertiestemplatesadd_for_team_fields[] add_fields?; + PropertyFieldTemplate[] add_fields?; string description?; string name?; string template_id?; }; +public type inline_response_200_71_origin record { + inline_response_200_71_origin_access_method access_method?; + inline_response_200_71_origin_geo_location geo_location?; +}; + public type team_folder_permanently_delete_body record { string team_folder_id?; }; @@ -210,7 +232,7 @@ public type files_list_folder_body record { }; public type templates_update_for_team_body record { - file_propertiestemplatesadd_for_team_fields[] add_fields?; + PropertyFieldTemplate[] add_fields?; string description?; string name?; string template_id?; @@ -226,14 +248,16 @@ public type PropertiesRemoveHeaders record { string? dropbox\-api\-select\-user?; }; -public type templates_remove_for_user_body record { - string template_id?; -}; - public type list_folders_continue_body record { string cursor?; }; +public type inline_response_200_16_export_metadata record { + string export_hash?; + string name?; + decimal size?; +}; + # Provides settings related to HTTP/1.x protocol. public type ClientHttp1Settings record {| # Specifies whether to reuse a connection for multiple requests @@ -249,11 +273,22 @@ public type sharingadd_file_member_members record { string email?; }; -public type inline_response_200_42_users record { - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inherited?; - anydata[] permissions?; - sharinglist_file_membersbatch_result_members_user user?; +public type inline_response_200_29_entries record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type teamteam_folderupdate_sync_settings_content_sync_settings record { @@ -261,18 +296,41 @@ public type teamteam_folderupdate_sync_settings_content_sync_settings record { string sync_setting?; }; +public type inline_response_200_71_actor_user_team record { + string display_name?; +}; + # Represents the Headers record for the operation: getTemporaryLink public type GetTemporaryLinkHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type AddTemplateForTeam record { + string description?; + PropertyFieldTemplate[] fields?; + string name?; +}; + +public type inline_response_200_61_results_1 record { + string \.tag?; + inline_response_200_61_results[] results?; + members_send_welcome_email_body user?; +}; + public type sharing_update_folder_member_body record { string access_level?; sharingadd_file_member_members member?; string shared_folder_id?; }; +public type inline_response_200_71_details record { + string \.tag?; + inline_response_200_71_details_shared_content_access_level shared_content_access_level?; + string shared_content_link?; + inline_response_200_71_actor_user shared_content_owner?; +}; + # Represents the Headers record for the operation: getThumbnailBatch public type GetThumbnailBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -280,6 +338,10 @@ public type GetThumbnailBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type DeleteManualContactsBatchRequest record { + string[] email_addresses?; +}; + public type sharingadd_folder_member_members record { string access_level?; sharingadd_folder_member_member member?; @@ -291,18 +353,17 @@ public type ListFileMembersContinueHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_62_results record { + string \.tag?; + string success?; +}; + # Represents the Headers record for the operation: getTemporaryUploadLink public type GetTemporaryUploadLinkHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_62_results record { - string \.tag?; - teamgroupsget_info_profile_secondary_emails success?; - string unavailable?; -}; - public type file_requests_update_body record { file_requestsupdate_deadline deadline?; string destination?; @@ -332,10 +393,6 @@ public type sharingget_file_metadatabatch_result_policy_acl_update_policy record string \.tag?; }; -public type inline_response_200_8_deadline_allow_late_uploads record { - string \.tag?; -}; - # Represents the Headers record for the operation: permanentlyDelete public type PermanentlyDeleteHeaders record { string? dropbox\-api\-path\-root?; @@ -353,6 +410,11 @@ public type sharinglist_file_membersbatch_result_members record { sharinglist_file_membersbatch_result_members_users[] users?; }; +public type inline_response_200_33_link_metadata_link_permissions record { + inline_response_200_33_link_metadata_action action?; + boolean allow?; +}; + public type team_folder_list_body record { decimal 'limit?; }; @@ -366,6 +428,12 @@ public type list_folder_continue_body record { string cursor?; }; +public type inline_response_200_56_complete record { + string \.tag?; + teammembersget_info_profile profile?; + teammembersget_info_role role?; +}; + # Represents the Headers record for the operation: listMountableFolders public type ListMountableFoldersHeaders record { string? dropbox\-api\-path\-root?; @@ -377,20 +445,6 @@ public type sharing_get_file_metadata_body record { string file?; }; -public type inline_response_200_14_metadata record { - string id?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - inline_response_200_14_metadata_sharing_info sharing_info?; -}; - -public type inline_response_200_67_content_sync_settings record { - string id?; - inline_response_200_67_sync_setting sync_setting?; -}; - public type file_requests_delete_body record { string[] ids?; }; @@ -407,13 +461,6 @@ public type members_set_profile_body record { members_send_welcome_email_body user?; }; -public type inline_response_200_73_origin_geo_location record { - string city?; - string country?; - string ip_address?; - string region?; -}; - # Represents the Headers record for the operation: transferFolder public type TransferFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -421,8 +468,8 @@ public type TransferFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type contacts_delete_manual_contacts_batch_body record { - string[] email_addresses?; +public type inline_response_200_69_policies_sharing_shared_link_create_policy record { + string \.tag?; }; public type filesget_file_lock_batch_entries record { @@ -433,11 +480,6 @@ public type files_get_temporary_link_body record { string path?; }; -public type inline_response_200_74_paper_as_files record { - string \.tag?; - boolean enabled?; -}; - public type teamgroupsmembersadd_user record { string \.tag?; string team_member_id?; @@ -463,12 +505,6 @@ public type sharinglist_file_membersbatch_result_members_group record { boolean same_team?; }; -public type inline_response_200_11_metadata_sharing_info record { - string modified_by?; - string parent_shared_folder_id?; - boolean read_only?; -}; - public type excluded_users_list_body record { decimal 'limit?; }; @@ -498,6 +534,33 @@ public type list_continue_body record { string cursor?; }; +public type inline_response_200_67_team_folders record { + inline_response_200_65_content_sync_settings[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + teamgroupsget_info_profile_status status?; + inline_response_200_65_sync_setting sync_setting?; + string team_folder_id?; +}; + +public type inline_response_200_23_entries record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_23_sharing_info sharing_info?; + decimal size?; +}; + public type sharing_get_folder_metadata_body record { anydata[] actions?; string shared_folder_id?; @@ -521,16 +584,6 @@ public type AddFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_77_account_type record { - string \.tag?; -}; - -public type inline_response_200_19_entries record { - string \.tag?; - inline_response_200_19_lock 'lock?; - inline_response_200_11_metadata metadata?; -}; - # Represents the Headers record for the operation: checkJobStatus public type CheckJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -538,13 +591,11 @@ public type CheckJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_66_namespace_type record { - string \.tag?; -}; - -public type inline_response_200_53_members record { - decimal permanently_deleted_users?; - string[] team_member_ids?; +public type inline_response_200_75_team record { + string id?; + string name?; + inline_response_200_69_policies_emm_state office_addin_policy?; + inline_response_200_69_policies_sharing sharing_policies?; }; public type members_suspend_body record { @@ -565,12 +616,6 @@ public type legal_holds_create_policy_body record { string start_date?; }; -public type inline_response_200_11_metadata_file_lock_info record { - string created?; - boolean is_lockholder?; - string lockholder_name?; -}; - # Represents the Headers record for the operation: move public type MoveHeaders record { string? dropbox\-api\-path\-root?; @@ -578,25 +623,36 @@ public type MoveHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_44_entries record { - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; -}; - public type sharing_relinquish_folder_membership_body record { boolean leave_a_copy?; string shared_folder_id?; }; +public type inline_response_200_23_sharing_info record { + string modified_by?; + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; +}; + +public type inline_response_200_9_metadata_sharing_info record { + string modified_by?; + string parent_shared_folder_id?; + boolean read_only?; +}; + +public type SearchPropertiesMode record { + string \.tag?; + string field_name?; +}; + +public type inline_response_200_75_root_info record { + string \.tag?; + string home_namespace_id?; + string root_namespace_id?; +}; + # Represents the Headers record for the operation: getAccountBatch public type GetAccountBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -611,18 +667,20 @@ public type filesget_temporary_upload_link_commit_info record { boolean strict_conflict?; }; +public type TokenFromOauth1Response record { + string oauth2_token?; +}; + public type members_add_body record { groups_delete_body group?; teamgroupsmembersadd_members[] members?; boolean return_members?; }; -public type templates_get_for_team_body record { - string template_id?; -}; - -public type inline_response_200_73_actor_user_team record { +public type inline_response_200_37_team_member_info record { string display_name?; + string member_id?; + sharingget_file_metadatabatch_result_owner_team team_info?; }; # Represents the Headers record for the operation: deleteBatch @@ -639,10 +697,6 @@ public type UnmountFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_5_type record { - string \.tag?; -}; - public type files_get_file_lock_batch_body record { filesget_file_lock_batch_entries[] entries?; }; @@ -658,6 +712,10 @@ public type PropertiesAddHeaders record { string? dropbox\-api\-select\-user?; }; +public type CheckAppRequest record { + string query?; +}; + # Represents the Headers record for the operation: copyReferenceGet public type CopyReferenceGetHeaders record { string? dropbox\-api\-path\-root?; @@ -690,17 +748,16 @@ public type groups_update_body record { boolean return_members?; }; -public type inline_response_200_54_entries record { - string author_email?; - string author_member_id?; - teamgroupsget_info_profile_status author_member_status?; - string content_hash?; - string file_type?; - string new_filename?; - string original_file_path?; - string original_revision_id?; - string server_modified?; - decimal size?; +public type PropertyFieldTemplate record { + string description?; + string name?; + string 'type?; +}; + +public type inline_response_200_3_fields record { + string description?; + string name?; + inline_response_200_3_type 'type?; }; public type team_folder_activate_body record { @@ -712,10 +769,17 @@ public type members_add_body_1 record { teammembersadd_new_members[] new_members?; }; -# Represents the Headers record for the operation: templatesGetForUser -public type TemplatesGetForUserHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; +public type inline_response_200_40_users record { + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inherited?; + anydata[] permissions?; + sharinglist_file_membersbatch_result_members_user user?; +}; + +# Represents the Headers record for the operation: templatesGetForUser +public type TemplatesGetForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; public type sharing_list_received_files_body record { @@ -742,35 +806,6 @@ public type LockFileBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type file_propertiespropertiesadd_fields record { - string name?; - string value?; -}; - -public type inline_response_200_64_results_1 record { - string \.tag?; - inline_response_200_64_results[] results?; - members_send_welcome_email_body user?; -}; - -public type inline_response_200_31_entries record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; -}; - # Represents the Headers record for the operation: getFileMetadataBatch public type GetFileMetadataBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -795,38 +830,45 @@ public type sharingadd_folder_member_member record { string email?; }; -public type inline_response_200_25_entries record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_25_sharing_info sharing_info?; - decimal size?; -}; - # Represents the Headers record for the operation: templatesUpdateForUser public type TemplatesUpdateForUserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type inline_response_200_42_entries record { + sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; +}; + public type list_mountable_folders_continue_body record { string cursor?; }; -public type file_propertiestemplatesadd_for_team_fields record { - string description?; - string name?; - string 'type?; +public type OverwritePropertiesRequest record { + string path?; + PropertyGroup[] property_groups?; +}; + +public type inline_response_200_69_policies record { + inline_response_200_69_policies_emm_state emm_state?; + inline_response_200_69_policies_emm_state office_addin?; + inline_response_200_69_policies_sharing sharing?; +}; + +public type inline_response_200_61_results record { + string \.tag?; + string not_found?; + string success?; }; public type sharinglist_file_membersbatch_result_members_invitees record { @@ -836,8 +878,8 @@ public type sharinglist_file_membersbatch_result_members_invitees record { anydata[] permissions?; }; -public type search_continue_body record { - string cursor?; +public type GetTemplateForTeam record { + string template_id?; }; public type member_space_limits_get_custom_quota_body record { @@ -850,7 +892,6 @@ public type legal_holds_list_policies_body record { public type inline_response_200_62_results_1 record { string \.tag?; - members_send_welcome_email_body invalid_user?; inline_response_200_62_results[] results?; members_send_welcome_email_body user?; }; @@ -874,10 +915,28 @@ public type RelinquishFolderMembershipHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_events record { + inline_response_200_71_actor actor?; + inline_response_200_71_assets[] assets?; + inline_response_200_71_actor_user context?; + inline_response_200_71_details details?; + inline_response_200_71_event_category event_category?; + inline_response_200_71_event_type event_type?; + boolean involve_non_team_member?; + inline_response_200_71_origin origin?; + inline_response_200_71_participants[] participants?; + string timestamp?; +}; + public type teammembersget_info_role record { string \.tag?; }; +public type PropertyField record { + string name?; + string value?; +}; + # Represents the Headers record for the operation: listFolderLongpoll public type ListFolderLongpollHeaders record { string? dropbox\-api\-path\-root?; @@ -885,6 +944,11 @@ public type ListFolderLongpollHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_13_entries record { + string \.tag?; + inline_response_200_12_metadata metadata?; +}; + public type team_folder_create_body record { string name?; string sync_setting?; @@ -909,39 +973,20 @@ public type secondary_emails_delete_body record { teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_delete?; }; -public type inline_response_200_73_user record { - string \.tag?; - string account_id?; - string display_name?; - string email?; - string member_external_id?; - inline_response_200_73_actor_user_team team?; - string team_member_id?; -}; - # Represents the Headers record for the operation: list public type ListHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_35_link_metadata_action record { - string \.tag?; +public type inline_response_200_71_path_namespace_relative record { + boolean is_shared_namespace?; + string ns_id?; + string relative_path?; }; -public type inline_response_200_43_entries record { - inline_response_200_35_access_inheritance access_inheritance?; - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inside_team_folder?; - boolean is_team_folder?; - inline_response_200_35_link_metadata link_metadata?; - string name?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string shared_folder_id?; - string time_invited?; +public type inline_response_200_64_namespace_type record { + string \.tag?; }; # Represents the Headers record for the operation: uploadSessionStart @@ -952,9 +997,15 @@ public type UploadSessionStartHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_73_origin_access_method record { - string \.tag?; - inline_response_200_73_origin_access_method_end_user end_user?; +public type SearchPropertiesContinueRequest record { + string cursor?; +}; + +public type inline_response_200_1_matches record { + string id?; + boolean is_deleted?; + string path?; + PropertyGroup[] property_groups?; }; public type members_remove_body record { @@ -970,20 +1021,6 @@ public type UpdateFileMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_73_actor_user record { - string \.tag?; - string account_id?; - string display_name?; - string email?; - string member_external_id?; - inline_response_200_73_actor_user_team team?; - string team_member_id?; -}; - -public type inline_response_200_71_policies_sharing_shared_link_create_policy record { - string \.tag?; -}; - public type sharing_unshare_file_body record { string file?; }; @@ -994,12 +1031,6 @@ public type ListReceivedFilesContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_24_entries record { - string \.tag?; - inline_response_200_18_file_metadata metadata?; - string thumbnail?; -}; - public type sharing_add_file_member_body record { string access_level?; boolean add_message_as_comment?; @@ -1009,6 +1040,12 @@ public type sharing_add_file_member_body record { boolean quiet?; }; +public type inline_response_200_69_policies_sharing record { + inline_response_200_69_policies_sharing_shared_folder_join_policy shared_folder_join_policy?; + sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; + inline_response_200_69_policies_sharing_shared_link_create_policy shared_link_create_policy?; +}; + # Represents the Headers record for the operation: removeFileMember2 public type RemoveFileMember2Headers record { string? dropbox\-api\-path\-root?; @@ -1027,7 +1064,7 @@ public type sharing_modify_shared_link_settings_body record { }; public type inline_response_200_9 record { - inline_response_200_9_file_requests[] file_requests?; + inline_response_200_9_metadata metadata?; }; public type teamfeaturesget_values_features record { @@ -1035,22 +1072,17 @@ public type teamfeaturesget_values_features record { }; public type inline_response_200_5 record { - string description?; - inline_response_200_5_fields[] fields?; - string name?; -}; - -public type inline_response_200_6 record { - string[] template_ids?; + decimal file_request_count?; }; -public type inline_response_200_7 record { - decimal file_request_count?; +public type inline_response_200_72_paper_as_files record { + string \.tag?; + boolean enabled?; }; -public type inline_response_200_8 record { +public type inline_response_200_6 record { string created?; - inline_response_200_8_deadline deadline?; + inline_response_200_6_deadline deadline?; string destination?; decimal file_count?; string id?; @@ -1059,6 +1091,16 @@ public type inline_response_200_8 record { string url?; }; +public type inline_response_200_7 record { + inline_response_200_7_file_requests[] file_requests?; +}; + +public type inline_response_200_8 record { + string cursor?; + inline_response_200_7_file_requests[] file_requests?; + boolean has_more?; +}; + # Represents the Headers record for the operation: updateFolderPolicy public type UpdateFolderPolicyHeaders record { string? dropbox\-api\-path\-root?; @@ -1066,21 +1108,8 @@ public type UpdateFolderPolicyHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_77_root_info record { - string \.tag?; - string home_namespace_id?; - string root_namespace_id?; -}; - -public type inline_response_200_39_link_permissions record { - boolean can_revoke?; - inline_response_200_35_link_metadata_audience_options resolved_visibility?; - inline_response_200_39_link_permissions_revoke_failure_reason revoke_failure_reason?; -}; - -public type properties_overwrite_body record { - string path?; - file_propertiespropertiesadd_property_groups[] property_groups?; +public type GetTemplateForUserRequest record { + string template_id?; }; public type sharing_update_folder_policy_body record { @@ -1102,20 +1131,12 @@ public type sharing_list_file_members_body record { decimal 'limit?; }; -public type inline_response_200_67_sync_setting record { - string \.tag?; -}; - # Represents the Headers record for the operation: saveUrl public type SaveUrlHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type account_set_profile_photo_body record { - Photo photo?; -}; - public type sharing_update_file_member_body record { string access_level?; string file?; @@ -1128,15 +1149,17 @@ public type teamgroupsget_info_profile_secondary_emails record { }; public type inline_response_200_1 record { - string oauth2_token?; + inline_response_200_1_matches[] matches?; }; public type inline_response_200_2 record { - string result?; + string template_id?; }; public type inline_response_200_3 record { - inline_response_200_3_matches[] matches?; + string description?; + inline_response_200_3_fields[] fields?; + string name?; }; public type files_copy_batch_v2_body record { @@ -1145,7 +1168,7 @@ public type files_copy_batch_v2_body record { }; public type inline_response_200_4 record { - string template_id?; + string[] template_ids?; }; public type members_set_profile_photo_body record { @@ -1154,32 +1177,48 @@ public type members_set_profile_photo_body record { }; public type inline_response_200_11 record { - inline_response_200_11_metadata metadata?; + string copy_reference?; + string expires?; + inline_response_200_9_metadata metadata?; +}; + +public type members_recover_body record { + teamgroupsmembersadd_user user?; }; public type inline_response_200_10 record { - string cursor?; - inline_response_200_9_file_requests[] file_requests?; - boolean has_more?; + string \.tag?; + inline_response_200_10_entries[] entries?; }; -public type members_recover_body record { - teamgroupsmembersadd_user user?; +public type inline_response_200_64_namespaces record { + string name?; + string namespace_id?; + inline_response_200_64_namespace_type namespace_type?; + string team_member_id?; }; public type inline_response_200_13 record { - string copy_reference?; - string expires?; - inline_response_200_11_metadata metadata?; + string \.tag?; + inline_response_200_13_entries[] entries?; }; public type inline_response_200_12 record { + inline_response_200_12_metadata metadata?; +}; + +public type inline_response_200_68_upload_api_rate_limit record { + string \.tag?; + decimal 'limit?; +}; + +public type inline_response_200_33_access_inheritance record { string \.tag?; - inline_response_200_12_entries[] entries?; }; public type inline_response_200_19 record { - inline_response_200_19_entries[] entries?; + string link?; + inline_response_200_16_file_metadata metadata?; }; public type files_list_revisions_body record { @@ -1188,9 +1227,22 @@ public type files_list_revisions_body record { string path?; }; -public type inline_response_200_61_members record { - teammembersget_info_profile profile?; - teammembersget_info_role role?; +public type inline_response_200_18 record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; # Represents the Headers record for the operation: user @@ -1199,14 +1251,21 @@ public type UserHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_18 record { - inline_response_200_18_export_metadata export_metadata?; - inline_response_200_18_file_metadata file_metadata?; -}; - -public type inline_response_200_12_entries record { - string \.tag?; - inline_response_200_11_metadata success?; +public type inline_response_200_15 record { + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type teammembersget_info_profile_secondary_emails record { @@ -1214,11 +1273,6 @@ public type teammembersget_info_profile_secondary_emails record { boolean is_verified?; }; -public type inline_response_200_15 record { - string \.tag?; - inline_response_200_15_entries[] entries?; -}; - # Represents the Headers record for the operation: createFolder public type CreateFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -1227,39 +1281,35 @@ public type CreateFolderHeaders record { }; public type inline_response_200_14 record { - inline_response_200_14_metadata metadata?; + string \.tag?; + inline_response_200_14_entries[] entries?; }; public type inline_response_200_17 record { - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; + inline_response_200_17_entries[] entries?; +}; + +public type AddTemplateForUser record { + string description?; + PropertyFieldTemplate[] fields?; string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; }; public type inline_response_200_16 record { - string \.tag?; - inline_response_200_16_entries[] entries?; + inline_response_200_16_export_metadata export_metadata?; + inline_response_200_16_file_metadata file_metadata?; }; -public type inline_response_200_35_access_inheritance record { - string \.tag?; +public type inline_response_200_48_groups record { + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; }; -public type inline_response_200_63_results_1 record { +public type inline_response_200_71_origin_access_method_end_user record { string \.tag?; - inline_response_200_63_results[] results?; - members_send_welcome_email_body user?; + string session_id?; }; # Represents the Headers record for the operation: deleteManualContacts @@ -1280,17 +1330,9 @@ public type SearchHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_78_allocation record { - string \.tag?; - decimal allocated?; -}; - -public type inline_response_200_25_sharing_info record { - string modified_by?; - boolean no_access?; - string parent_shared_folder_id?; - boolean read_only?; - boolean traverse_only?; +public type TokenFromOauth1Request record { + string oauth1_token?; + string oauth1_token_secret?; }; public type sharing_check_remove_member_job_status_body record { @@ -1326,6 +1368,10 @@ public type sharingget_file_metadatabatch_result record { string time_invited?; }; +public type inline_response_200_71_event_category record { + string \.tag?; +}; + # Represents the Headers record for the operation: unshareFolder public type UnshareFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -1333,6 +1379,14 @@ public type UnshareFolderHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_assets record { + string \.tag?; + string display_name?; + string file_id?; + decimal file_size?; + inline_response_200_71_path path?; +}; + # Represents the Headers record for the operation: listFileMembers public type ListFileMembersHeaders record { string? dropbox\-api\-path\-root?; @@ -1348,33 +1402,18 @@ public type teamgroupsget_info_access_type record { string \.tag?; }; -public type inline_response_200_71_policies record { - inline_response_200_71_policies_emm_state emm_state?; - inline_response_200_71_policies_emm_state office_addin?; - inline_response_200_71_policies_sharing sharing?; -}; - public type filesupload_sessionfinish_batch_entries record { filesget_temporary_upload_link_commit_info 'commit?; filesupload_sessionfinish_batch_cursor cursor?; }; public type inline_response_200_33 record { - sharingadd_file_member_members member?; - sharingadd_file_member_result result?; -}; - -public type inline_response_200_32 record { - string session_id?; -}; - -public type inline_response_200_35 record { string \.tag?; - inline_response_200_35_access_inheritance access_inheritance?; + inline_response_200_33_access_inheritance access_inheritance?; sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; - inline_response_200_35_link_metadata link_metadata?; + inline_response_200_33_link_metadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; @@ -1384,13 +1423,37 @@ public type inline_response_200_35 record { string time_invited?; }; +public type inline_response_200_32 record { + string \.tag?; +}; + +public type inline_response_200_35 record { + string file?; + sharingget_file_metadatabatch_result result?; +}; + public type groups_delete_body record { string \.tag?; string group_id?; }; -public type inline_response_200_34 record { +public type inline_response_200_71_participants record { string \.tag?; + inline_response_200_71_user user?; +}; + +public type inline_response_200_34 record { + sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; }; public type members_get_info_body record { @@ -1402,20 +1465,12 @@ public type secondary_emails_resend_verification_emails_body record { }; public type inline_response_200_31 record { - string \.tag?; - inline_response_200_31_entries[] entries?; -}; - -public type inline_response_200_50_groups record { - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; + sharingadd_file_member_members member?; + sharingadd_file_member_result result?; }; public type inline_response_200_30 record { - boolean has_more?; - inline_response_200_30_matches[] matches?; + string session_id?; }; # Represents the Headers record for the operation: deleteBatchCheck @@ -1429,22 +1484,8 @@ public type sharing_check_job_status_body record { string async_job_id?; }; -public type inline_response_200_11_metadata record { +public type inline_response_200_69_policies_sharing_shared_folder_join_policy record { string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; }; # Represents the Headers record for the operation: getSpaceUsage @@ -1453,65 +1494,39 @@ public type GetSpaceUsageHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_73_details record { - string \.tag?; - inline_response_200_73_details_shared_content_access_level shared_content_access_level?; - string shared_content_link?; - inline_response_200_73_actor_user shared_content_owner?; -}; - public type team_folder_update_sync_settings_body record { teamteam_folderupdate_sync_settings_content_sync_settings[] content_sync_settings?; string sync_setting?; string team_folder_id?; }; -# Represents the Headers record for the operation: shareFolder -public type ShareFolderHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-admin?; - string? dropbox\-api\-select\-user?; -}; - public type inline_response_200_37 record { - string file?; - sharingget_file_metadatabatch_result result?; -}; - -public type inline_response_200_36 record { - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; -}; - -public type inline_response_200_39 record { string \.tag?; string client_modified?; string id?; - inline_response_200_39_link_permissions link_permissions?; + inline_response_200_37_link_permissions link_permissions?; string name?; string path_lower?; string rev?; string server_modified?; decimal size?; - inline_response_200_39_team_member_info team_member_info?; + inline_response_200_37_team_member_info team_member_info?; string url?; }; -public type inline_response_200_38 record { - inline_response_200_35_access_inheritance access_inheritance?; +# Represents the Headers record for the operation: shareFolder +public type ShareFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_36 record { + inline_response_200_33_access_inheritance access_inheritance?; sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; - inline_response_200_35_link_metadata link_metadata?; + inline_response_200_33_link_metadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; @@ -1521,18 +1536,19 @@ public type inline_response_200_38 record { string time_invited?; }; -public type properties_remove_body record { - string path?; - string[] property_template_ids?; +public type inline_response_200_39 record { + string file?; + sharinglist_file_membersbatch_result result?; }; -public type legal_holds_list_held_revisions_body record { - string id?; +public type inline_response_200_38 record { + sharinglist_file_membersbatch_result_members_groups[] groups?; + sharinglist_file_membersbatch_result_members_invitees[] invitees?; + sharinglist_file_membersbatch_result_members_users[] users?; }; -public type inline_response_200_74_values record { - string \.tag?; - inline_response_200_74_paper_as_files paper_as_files?; +public type legal_holds_list_held_revisions_body record { + string id?; }; public type files_create_folder_batch_body record { @@ -1551,6 +1567,12 @@ public type files_lock_file_batch_body record { filesget_file_lock_batch_entries[] entries?; }; +public type inline_response_200_60_results record { + string \.tag?; + teamgroupsget_info_profile_secondary_emails success?; + string unavailable?; +}; + public type groups_get_info_body record { string \.tag?; string[] group_ids?; @@ -1592,38 +1614,25 @@ public type ConnectionConfig record {| |}; public type inline_response_200_22 record { - string link?; + inline_response_200_22_entries[] entries?; }; public type inline_response_200_21 record { - string link?; - inline_response_200_18_file_metadata metadata?; + inline_response_200_16_file_metadata file_metadata?; }; public type inline_response_200_24 record { - inline_response_200_24_entries[] entries?; + boolean changes?; }; public type inline_response_200_23 record { - inline_response_200_18_file_metadata file_metadata?; + string cursor?; + inline_response_200_23_entries[] entries?; + boolean has_more?; }; public type inline_response_200_20 record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; + string link?; }; public type file_requestscreate_deadline record { @@ -1631,12 +1640,6 @@ public type file_requestscreate_deadline record { string deadline?; }; -public type inline_response_200_70_values record { - string \.tag?; - inline_response_200_70_has_team_shared_dropbox has_team_shared_dropbox?; - inline_response_200_70_upload_api_rate_limit upload_api_rate_limit?; -}; - public type files_delete_batch_body record { files_delete_v2_body[] entries?; }; @@ -1656,6 +1659,7 @@ public type Delete1Headers record { public type inline_response_200_29 record { string \.tag?; + inline_response_200_29_entries[] entries?; }; public type files_get_metadata_body record { @@ -1666,41 +1670,35 @@ public type files_get_metadata_body record { }; public type inline_response_200_26 record { - boolean changes?; -}; - -public type inline_response_200_25 record { - string cursor?; - inline_response_200_25_entries[] entries?; - boolean has_more?; -}; - -public type inline_response_200_28 record { string \.tag?; string client_modified?; string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; boolean has_explicit_shared_members?; string id?; boolean is_downloadable?; string name?; string path_display?; string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; + PropertyGroup[] property_groups?; string rev?; string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; + inline_response_200_9_metadata_sharing_info sharing_info?; decimal size?; }; -public type inline_response_200_27 record { - inline_response_200_18_file_metadata[] entries?; +public type inline_response_200_25 record { + inline_response_200_16_file_metadata[] entries?; boolean is_deleted?; }; -public type inline_response_200_73_event_type record { +public type inline_response_200_28 record { + boolean has_more?; + inline_response_200_28_matches[] matches?; +}; + +public type inline_response_200_27 record { string \.tag?; - string description?; }; public type files_get_temporary_upload_link_body record { @@ -1708,11 +1706,6 @@ public type files_get_temporary_upload_link_body record { decimal duration?; }; -public type inline_response_200_73_actor record { - string \.tag?; - inline_response_200_73_actor_user user?; -}; - public type members_delete_profile_photo_body record { teamgroupsmembersadd_user user?; }; @@ -1742,54 +1735,48 @@ public type sharingget_file_metadatabatch_result_policy_resolved_member_policy r string \.tag?; }; -public type inline_response_200_55 record { - inline_response_200_55_policies[] policies?; -}; - -public type inline_response_200_54 record { - inline_response_200_54_entries[] entries?; - boolean has_more?; +public type inline_response_200_65_sync_setting record { + string \.tag?; }; -public type inline_response_200_57 record { +public type inline_response_200_55 record { string cursor?; boolean has_more?; anydata[] users?; }; -public type file_propertiespropertiessearch_queries record { - string logical_operator?; - file_propertiespropertiessearch_mode mode?; - string query?; +public type inline_response_200_54 record { + sharingadd_file_member_result status?; }; -public type inline_response_200_56 record { - sharingadd_file_member_result status?; +public type inline_response_200_57 record { + teammembersget_info_profile profile?; + teammembersget_info_role role?; }; -public type inline_response_200_71_policies_sharing_shared_folder_join_policy record { +public type inline_response_200_56 record { string \.tag?; + inline_response_200_56_complete[] complete?; }; public type inline_response_200_51 record { - string async_job_id?; - inline_response_200_51_group_info group_info?; + string activation_time?; + string end_date?; + string id?; + inline_response_200_51_members members?; + string name?; + string start_date?; + teamgroupsget_info_profile_status status?; }; public type inline_response_200_50 record { string cursor?; - inline_response_200_50_groups[] groups?; boolean has_more?; + anydata[] members?; }; public type inline_response_200_53 record { - string activation_time?; - string end_date?; - string id?; - inline_response_200_53_members members?; - string name?; - string start_date?; - teamgroupsget_info_profile_status status?; + inline_response_200_53_policies[] policies?; }; public type file_requestsupdate_deadline record { @@ -1799,9 +1786,13 @@ public type file_requestsupdate_deadline record { }; public type inline_response_200_52 record { - string cursor?; + inline_response_200_52_entries[] entries?; boolean has_more?; - anydata[] members?; +}; + +public type AddPropertiesRequest record { + string path?; + PropertyGroup[] property_groups?; }; public type sharing_revoke_shared_link_body record { @@ -1815,21 +1806,20 @@ public type UnshareFileHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_77_team record { - string id?; - string name?; - inline_response_200_71_policies_emm_state office_addin_policy?; - inline_response_200_71_policies_sharing sharing_policies?; +public type inline_response_200_59 record { + string cursor?; + boolean has_more?; + inline_response_200_59_members[] members?; }; -public type inline_response_200_59 record { +public type inline_response_200_58 record { + string \.tag?; teammembersget_info_profile profile?; teammembersget_info_role role?; }; -public type inline_response_200_58 record { +public type inline_response_200_33_link_metadata_action record { string \.tag?; - inline_response_200_58_complete[] complete?; }; public type files_permanently_delete_body record { @@ -1840,17 +1830,6 @@ public type list_folder_members_continue_body record { string cursor?; }; -public type inline_response_200_9_file_requests record { - string created?; - inline_response_200_8_deadline deadline?; - string destination?; - decimal file_count?; - string id?; - boolean is_open?; - string title?; - string url?; -}; - # Represents the Headers record for the operation: checkShareJobStatus public type CheckShareJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -1858,10 +1837,12 @@ public type CheckShareJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_60 record { +public type inline_response_200_69_policies_emm_state record { string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; +}; + +public type inline_response_200_60 record { + inline_response_200_60_results_1[] results?; }; public type team_log_get_events_body record { @@ -1874,23 +1855,27 @@ public type sharingget_file_metadatabatch_result_policy_member_policy record { }; public type inline_response_200_44 record { - string cursor?; - inline_response_200_44_entries[] entries?; + string \.tag?; }; public type inline_response_200_43 record { string cursor?; - inline_response_200_43_entries[] entries?; + boolean has_more?; + inline_response_200_43_links[] links?; }; public type inline_response_200_46 record { - string \.tag?; + decimal created?; + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + teamgroupsget_info_members[] members?; }; public type inline_response_200_45 record { - string cursor?; - boolean has_more?; - inline_response_200_45_links[] links?; + string \.tag?; + string async_job_id?; }; public type members_send_welcome_email_body record { @@ -1899,24 +1884,34 @@ public type members_send_welcome_email_body record { }; public type inline_response_200_40 record { + string cursor?; sharinglist_file_membersbatch_result_members_groups[] groups?; sharinglist_file_membersbatch_result_members_invitees[] invitees?; - sharinglist_file_membersbatch_result_members_users[] users?; + inline_response_200_40_users[] users?; }; public type inline_response_200_42 record { string cursor?; - sharinglist_file_membersbatch_result_members_groups[] groups?; - sharinglist_file_membersbatch_result_members_invitees[] invitees?; - inline_response_200_42_users[] users?; + inline_response_200_42_entries[] entries?; }; public type inline_response_200_41 record { - string file?; - sharinglist_file_membersbatch_result result?; + string cursor?; + inline_response_200_41_entries[] entries?; }; public type inline_response_200_48 record { + string cursor?; + inline_response_200_48_groups[] groups?; + boolean has_more?; +}; + +public type inline_response_200_17_lock record { + inline_response_200_17_lock_content content?; +}; + +public type inline_response_200_47 record { + string \.tag?; decimal created?; string group_id?; sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; @@ -1925,32 +1920,43 @@ public type inline_response_200_48 record { teamgroupsget_info_members[] members?; }; -public type inline_response_200_47 record { +public type inline_response_200_17_entries record { string \.tag?; - string async_job_id?; + inline_response_200_17_lock 'lock?; + inline_response_200_9_metadata metadata?; }; public type inline_response_200_49 record { - string \.tag?; - decimal created?; - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; - teamgroupsget_info_members[] members?; + string async_job_id?; + inline_response_200_49_group_info group_info?; }; -public type properties_search_body record { - file_propertiespropertiessearch_queries[] queries?; - string template_filter?; +public type inline_response_200_51_members record { + decimal permanently_deleted_users?; + string[] team_member_ids?; }; -public type inline_response_200_73_assets record { - string \.tag?; - string display_name?; - string file_id?; - decimal file_size?; - inline_response_200_73_path path?; +public type inline_response_200_53_policies record { + string activation_time?; + string end_date?; + string id?; + inline_response_200_51_members members?; + string name?; + string start_date?; + teamgroupsget_info_profile_status status?; +}; + +public type inline_response_200_71_path record { + string contextual?; + inline_response_200_71_path_namespace_relative namespace_relative?; +}; + +public type inline_response_200_33_link_metadata record { + inline_response_200_33_link_metadata_audience_options[] audience_options?; + inline_response_200_33_link_metadata_audience_options current_audience?; + inline_response_200_33_link_metadata_link_permissions[] link_permissions?; + boolean password_protected?; + string url?; }; public type file_requests_create_body record { @@ -1960,35 +1966,9 @@ public type file_requests_create_body record { string title?; }; -public type inline_response_200_73_participants record { - string \.tag?; - inline_response_200_73_user user?; -}; - -public type inline_response_200_77 record { - string account_id?; - inline_response_200_77_account_type account_type?; - string country?; - boolean disabled?; - string email?; - boolean email_verified?; - boolean is_paired?; - string locale?; - teamgroupsget_info_profile_name name?; - string referral_link?; - inline_response_200_77_root_info root_info?; - inline_response_200_77_team team?; - string team_member_id?; -}; - public type inline_response_200_76 record { - string account_id?; - boolean disabled?; - string email?; - boolean email_verified?; - boolean is_teammate?; - teamgroupsget_info_profile_name name?; - string profile_photo_url?; + inline_response_200_76_allocation allocation?; + decimal used?; }; # Represents the Headers record for the operation: tokenFromOauth1 @@ -1997,22 +1977,23 @@ public type TokenFromOauth1Headers record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_78 record { - inline_response_200_78_allocation allocation?; - decimal used?; -}; - -public type inline_response_200_73 record { - string cursor?; - inline_response_200_73_events[] events?; - boolean has_more?; +public type inline_response_200_7_file_requests record { + string created?; + inline_response_200_6_deadline deadline?; + string destination?; + decimal file_count?; + string id?; + boolean is_open?; + string title?; + string url?; }; -public type inline_response_200_72 record { - teammembersget_info_profile admin_profile?; +public type SearchPropertiesRequest record { + SearchPropertiesQuery[] queries?; + string template_filter?; }; -public type inline_response_200_75 record { +public type inline_response_200_73 record { string account_id?; boolean disabled?; string email?; @@ -2022,16 +2003,38 @@ public type inline_response_200_75 record { string profile_photo_url?; }; +public type inline_response_200_72 record { + inline_response_200_72_values[] values?; +}; + public type file_requests_list_v2_body record { decimal 'limit?; }; -public type inline_response_200_74 record { - inline_response_200_74_values[] values?; +public type inline_response_200_75 record { + string account_id?; + inline_response_200_75_account_type account_type?; + string country?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_paired?; + string locale?; + teamgroupsget_info_profile_name name?; + string referral_link?; + inline_response_200_75_root_info root_info?; + inline_response_200_75_team team?; + string team_member_id?; }; -public type inline_response_200_73_details_shared_content_access_level record { - string \.tag?; +public type inline_response_200_74 record { + string account_id?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_teammate?; + teamgroupsget_info_profile_name name?; + string profile_photo_url?; }; # Represents the Headers record for the operation: propertiesSearchContinue @@ -2057,13 +2060,11 @@ public type ExportHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_51_group_info record { - decimal created?; - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; - teamgroupsget_info_members[] members?; +public type inline_response_200_17_lock_content record { + string \.tag?; + string created?; + string lock_holder_account_id?; + string lock_holder_team_id?; }; public type users_get_account_body record { @@ -2100,9 +2101,13 @@ public type GetMetadataHeaders record { }; public type inline_response_200_66 record { - string cursor?; - boolean has_more?; - inline_response_200_66_namespaces[] namespaces?; + string \.tag?; + inline_response_200_65_content_sync_settings[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + teamgroupsget_info_profile_status status?; + inline_response_200_65_sync_setting sync_setting?; + string team_folder_id?; }; public type team_folder_rename_body record { @@ -2111,84 +2116,71 @@ public type team_folder_rename_body record { }; public type inline_response_200_65 record { - teammembersget_info_role role?; - string team_member_id?; -}; - -public type inline_response_200_68 record { - string \.tag?; - inline_response_200_67_content_sync_settings[] content_sync_settings?; + inline_response_200_65_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; teamgroupsget_info_profile_status status?; - inline_response_200_67_sync_setting sync_setting?; + inline_response_200_65_sync_setting sync_setting?; string team_folder_id?; }; +public type inline_response_200_68 record { + inline_response_200_68_values[] values?; +}; + public type inline_response_200_67 record { - inline_response_200_67_content_sync_settings[] content_sync_settings?; - boolean is_team_shared_dropbox?; - string name?; - teamgroupsget_info_profile_status status?; - inline_response_200_67_sync_setting sync_setting?; - string team_folder_id?; + string cursor?; + boolean has_more?; + inline_response_200_67_team_folders[] team_folders?; }; public type inline_response_200_62 record { inline_response_200_62_results_1[] results?; }; -public type inline_response_200_61 record { - string cursor?; - boolean has_more?; - inline_response_200_61_members[] members?; -}; - public type sharing_list_mountable_folders_body record { anydata[] actions?; decimal 'limit?; }; +public type inline_response_200_61 record { + inline_response_200_61_results_1[] results?; +}; + public type inline_response_200_64 record { - inline_response_200_64_results_1[] results?; + string cursor?; + boolean has_more?; + inline_response_200_64_namespaces[] namespaces?; }; public type inline_response_200_63 record { - inline_response_200_63_results_1[] results?; + teammembersget_info_role role?; + string team_member_id?; }; -public type inline_response_200_70_upload_api_rate_limit record { +public type inline_response_200_60_results_1 record { string \.tag?; - decimal 'limit?; -}; - -public type file_propertiespropertiesupdate_update_property_groups record { - file_propertiespropertiesadd_fields[] add_or_update_fields?; - anydata[] remove_fields?; - string template_id?; + members_send_welcome_email_body invalid_user?; + inline_response_200_60_results[] results?; + members_send_welcome_email_body user?; }; public type inline_response_200_69 record { - string cursor?; - boolean has_more?; - inline_response_200_69_team_folders[] team_folders?; + string name?; + decimal num_licensed_users?; + decimal num_provisioned_users?; + inline_response_200_69_policies policies?; + string team_id?; }; public type copy_reference_get_body record { string path?; }; -public type token_from_oauth1_body record { - string oauth1_token?; - string oauth1_token_secret?; -}; - public type inline_response_200_71 record { - string name?; - decimal num_licensed_users?; - decimal num_provisioned_users?; - inline_response_200_71_policies policies?; - string team_id?; + string cursor?; + inline_response_200_71_events[] events?; + boolean has_more?; }; public type save_url_check_job_status_body record { @@ -2196,7 +2188,12 @@ public type save_url_check_job_status_body record { }; public type inline_response_200_70 record { - inline_response_200_70_values[] values?; + teammembersget_info_profile admin_profile?; +}; + +public type inline_response_200_14_entries record { + string \.tag?; + inline_response_200_9_metadata metadata?; }; public type list_folder_get_latest_cursor_body record { @@ -2209,10 +2206,6 @@ public type list_folder_get_latest_cursor_body record { boolean recursive?; }; -public type inline_response_200_71_policies_emm_state record { - string \.tag?; -}; - public type sharinglist_file_membersbatch_result_members_users record { sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inherited?; @@ -2222,6 +2215,18 @@ public type sharinglist_file_membersbatch_result_members_users record { sharinglist_file_membersbatch_result_members_user user?; }; +public type SearchPropertiesQuery record { + string logical_operator?; + SearchPropertiesMode mode?; + string query?; +}; + +public type inline_response_200_37_link_permissions record { + boolean can_revoke?; + inline_response_200_33_link_metadata_audience_options resolved_visibility?; + inline_response_200_37_link_permissions_revoke_failure_reason revoke_failure_reason?; +}; + public type job_status_get_body record { string async_job_id?; }; @@ -2239,6 +2244,11 @@ public type sharinglist_file_membersbatch_result record { sharinglist_file_membersbatch_result_members members?; }; +public type UpdatePropertiesRequest record { + string path?; + PropertyGroupsUpdate[] update_property_groups?; +}; + public type sharinglist_file_membersbatch_result_members_access_type record { string \.tag?; }; @@ -2247,16 +2257,25 @@ public type groups_list_body record { decimal 'limit?; }; +public type inline_response_200_71_user record { + string \.tag?; + string account_id?; + string display_name?; + string email?; + string member_external_id?; + inline_response_200_71_actor_user_team team?; + string team_member_id?; +}; + +public type inline_response_200_3_type record { + string \.tag?; +}; + public type members_list_body_1 record { boolean include_removed?; decimal 'limit?; }; -public type inline_response_200_73_origin record { - inline_response_200_73_origin_access_method access_method?; - inline_response_200_73_origin_geo_location geo_location?; -}; - # Represents the Headers record for the operation: getAccount public type GetAccountHeaders record { string? dropbox\-api\-path\-root?; @@ -2280,6 +2299,10 @@ public type users_get_account_batch_body record { string[] account_ids?; }; +public type SetProfilePhotoResponse record { + string profile_photo_url?; +}; + public type legal_holds_release_policy_body record { string id?; }; @@ -2290,25 +2313,16 @@ public type members_move_former_member_files_body record { teamgroupsmembersadd_user user?; }; -public type templates_add_for_user_body record { - string description?; - file_propertiestemplatesadd_for_team_fields[] fields?; - string name?; -}; - -public type sharing_unmount_folder_body record { - string shared_folder_id?; +public type inline_response_200_71_details_shared_content_access_level record { + string \.tag?; }; -public type templates_add_for_team_body record { - string description?; - file_propertiestemplatesadd_for_team_fields[] fields?; - string name?; +public type inline_response_200_6_deadline_allow_late_uploads record { + string \.tag?; }; -public type properties_update_body record { - string path?; - file_propertiespropertiesupdate_update_property_groups[] update_property_groups?; +public type sharing_unmount_folder_body record { + string shared_folder_id?; }; # Represents the Headers record for the operation: templatesAddForUser @@ -2327,25 +2341,13 @@ public type members_list_body record { decimal 'limit?; }; -public type inline_response_200_35_link_metadata_link_permissions record { - inline_response_200_35_link_metadata_action action?; - boolean allow?; -}; - -public type inline_response_200_64_results record { - string \.tag?; - string success?; -}; - -public type inline_response_200_19_lock_content record { - string \.tag?; - string created?; - string lock_holder_account_id?; - string lock_holder_team_id?; -}; - -public type inline_response_200_35_link_metadata_audience_options record { - string \.tag?; +public type inline_response_200_49_group_info record { + decimal created?; + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + teamgroupsget_info_members[] members?; }; public type sharing_remove_file_member_2_body record { @@ -2369,17 +2371,14 @@ public type teammembersget_info_profile record { string team_member_id?; }; -public type inline_response_200_5_fields record { - string description?; - string name?; - inline_response_200_5_type 'type?; +public type SetProfilePhotoRequest record { + Photo photo?; }; -public type inline_response_200_3_matches record { - string id?; - boolean is_deleted?; - string path?; - file_propertiespropertiesadd_property_groups[] property_groups?; +public type inline_response_200_22_entries record { + string \.tag?; + inline_response_200_16_file_metadata metadata?; + string thumbnail?; }; public type list_file_members_batch_body record { @@ -2391,6 +2390,16 @@ public type features_get_values_body_1 record { usersfeaturesget_values_features[] features?; }; +public type PropertyGroupsUpdate record { + PropertyField[] add_or_update_fields?; + anydata[] remove_fields?; + string template_id?; +}; + +public type RemoveTemplateForTeamRequest record { + string template_id?; +}; + # Represents the Headers record for the operation: listRevisions public type ListRevisionsHeaders record { string? dropbox\-api\-path\-root?; @@ -2407,15 +2416,8 @@ public type filesupload_sessionfinish_batch_cursor record { string session_id?; }; -public type inline_response_200_73_origin_access_method_end_user record { - string \.tag?; - string session_id?; -}; - -public type inline_response_200_73_path_namespace_relative record { - boolean is_shared_namespace?; - string ns_id?; - string relative_path?; +public type inline_response_200_28_matches record { + inline_response_200_28_metadata metadata?; }; public type copy_reference_save_body record { @@ -2436,20 +2438,6 @@ public type PropertiesOverwriteHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_45_links record { - string \.tag?; - string client_modified?; - string id?; - inline_response_200_39_link_permissions link_permissions?; - string name?; - string path_lower?; - string rev?; - string server_modified?; - decimal size?; - inline_response_200_39_team_member_info team_member_info?; - string url?; -}; - # Represents the Headers record for the operation: unlockFileBatch public type UnlockFileBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2457,6 +2445,11 @@ public type UnlockFileBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_68_has_team_shared_dropbox record { + string \.tag?; + boolean has_team_shared_dropbox?; +}; + # Represents the Headers record for the operation: listFileMembersBatch public type ListFileMembersBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2482,11 +2475,6 @@ public type teamgroupsget_info_profile_name record { string surname?; }; -public type inline_response_200_16_entries record { - string \.tag?; - inline_response_200_11_metadata metadata?; -}; - public type teamgroupsget_info_profile record { string account_id?; string email?; @@ -2517,10 +2505,6 @@ public type team_folder_archive_body record { string team_folder_id?; }; -public type inline_response_200_39_link_permissions_revoke_failure_reason record { - string \.tag?; -}; - # Represents the Headers record for the operation: removeFolderMember public type RemoveFolderMemberHeaders record { string? dropbox\-api\-path\-root?; @@ -2528,23 +2512,46 @@ public type RemoveFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_10_entries record { + string \.tag?; + inline_response_200_9_metadata success?; +}; + public type sharing_unshare_folder_body record { boolean leave_a_copy?; string shared_folder_id?; }; -public type inline_response_200_35_link_metadata record { - inline_response_200_35_link_metadata_audience_options[] audience_options?; - inline_response_200_35_link_metadata_audience_options current_audience?; - inline_response_200_35_link_metadata_link_permissions[] link_permissions?; - boolean password_protected?; - string url?; +public type CheckUserRequest record { + string query?; +}; + +public type inline_response_200_12_metadata_sharing_info record { + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; +}; + +public type inline_response_200_71_actor_user record { + string \.tag?; + string account_id?; + string display_name?; + string email?; + string member_external_id?; + inline_response_200_71_actor_user_team team?; + string team_member_id?; }; public type legal_holds_list_held_revisions_continue_body record { string id?; }; +public type inline_response_200_71_actor record { + string \.tag?; + inline_response_200_71_actor_user user?; +}; + public type list_received_files_continue_body record { string cursor?; }; @@ -2559,6 +2566,12 @@ public type members_set_admin_permissions_body record { members_send_welcome_email_body user?; }; +public type inline_response_200_68_values record { + string \.tag?; + inline_response_200_68_has_team_shared_dropbox has_team_shared_dropbox?; + inline_response_200_68_upload_api_rate_limit upload_api_rate_limit?; +}; + public type teamgroupsget_info_profile_status record { string \.tag?; }; @@ -2589,10 +2602,6 @@ public type devices_list_member_devices_body record { string team_member_id?; }; -public type check_app_body record { - string query?; -}; - # Represents the Headers record for the operation: copyBatchCheck public type CopyBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2618,22 +2627,10 @@ public type files_copy_v2_body record { string to_path?; }; -public type inline_response_200_14_metadata_sharing_info record { - boolean no_access?; - string parent_shared_folder_id?; - boolean read_only?; - boolean traverse_only?; -}; - public type job_status_check_body record { string async_job_id?; }; -public type inline_response_200_30_metadata record { - string \.tag?; - inline_response_200_11_metadata metadata?; -}; - # Represents the Headers record for the operation: createFolderBatchCheck public type CreateFolderBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2641,6 +2638,13 @@ public type CreateFolderBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_origin_geo_location record { + string city?; + string country?; + string ip_address?; + string region?; +}; + # Represents the Headers record for the operation: get public type GetHeaders record { string? dropbox\-api\-path\-root?; @@ -2662,25 +2666,21 @@ public type UploadSessionAppendHeaders record { string? dropbox\-api\-select\-user?; }; -public type properties_add_body record { - string path?; - file_propertiespropertiesadd_property_groups[] property_groups?; -}; - public type sharing_relinquish_file_membership_body record { string file?; }; -public type check_user_body record { - string query?; -}; - public type devices_revoke_device_session_body record { string \.tag?; string session_id?; string team_member_id?; }; +public type inline_response_200_71_origin_access_method record { + string \.tag?; + inline_response_200_71_origin_access_method_end_user end_user?; +}; + # Represents the Headers record for the operation: saveUrlCheckJobStatus public type SaveUrlCheckJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -2732,20 +2732,23 @@ public type GetSharedLinkMetadataHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_55_policies record { - string activation_time?; - string end_date?; - string id?; - inline_response_200_53_members members?; - string name?; - string start_date?; - teamgroupsget_info_profile_status status?; -}; - public type sharing_check_share_job_status_body record { string async_job_id?; }; +public type inline_response_200_52_entries record { + string author_email?; + string author_member_id?; + teamgroupsget_info_profile_status author_member_status?; + string content_hash?; + string file_type?; + string new_filename?; + string original_file_path?; + string original_revision_id?; + string server_modified?; + decimal size?; +}; + public type create_folder_batch_check_body record { string async_job_id?; }; @@ -2757,6 +2760,11 @@ public type MoveBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_event_type record { + string \.tag?; + string description?; +}; + public type sharing_share_folder_body record { string access_inheritance?; string acl_update_policy?; @@ -2789,13 +2797,6 @@ public type UploadSessionFinishHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_66_namespaces record { - string name?; - string namespace_id?; - inline_response_200_66_namespace_type namespace_type?; - string team_member_id?; -}; - public type sharinglist_file_membersbatch_result_members_invitee record { string \.tag?; string email?; @@ -2805,23 +2806,6 @@ public type files_delete_v2_body record { string path?; }; -public type inline_response_200_18_file_metadata record { - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; -}; - # Represents the Headers record for the operation: copyBatch public type CopyBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2829,6 +2813,10 @@ public type CopyBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_37_link_permissions_revoke_failure_reason record { + string \.tag?; +}; + # Represents the Headers record for the operation: relinquishFileMembership public type RelinquishFileMembershipHeaders record { string? dropbox\-api\-path\-root?; @@ -2836,31 +2824,22 @@ public type RelinquishFileMembershipHeaders record { string? dropbox\-api\-select\-user?; }; -public type file_propertiespropertiesadd_property_groups record { - file_propertiespropertiesadd_fields[] fields?; - string template_id?; -}; - -public type templates_get_for_user_body record { - string template_id?; -}; - -public type inline_response_200_19_lock record { - inline_response_200_19_lock_content content?; -}; - public type list_continue_body_1 record { string cursor?; }; -public type inline_response_200_63_results record { +public type usersfeaturesget_values_features record { string \.tag?; - string not_found?; - string success?; }; -public type usersfeaturesget_values_features record { +public type inline_response_200_6_deadline record { + inline_response_200_6_deadline_allow_late_uploads allow_late_uploads?; + string deadline?; +}; + +public type inline_response_200_76_allocation record { string \.tag?; + decimal allocated?; }; public type filescopy_batch_v2_entries record { @@ -2872,12 +2851,6 @@ public type list_continue_body_5 record { string cursor?; }; -public type inline_response_200_18_export_metadata record { - string export_hash?; - string name?; - decimal size?; -}; - public type list_continue_body_4 record { string cursor?; }; @@ -2890,6 +2863,11 @@ public type list_continue_body_2 record { string cursor?; }; +public type inline_response_200_28_metadata record { + string \.tag?; + inline_response_200_9_metadata metadata?; +}; + # Represents the Headers record for the operation: getFolderMetadata public type GetFolderMetadataHeaders record { string? dropbox\-api\-path\-root?; @@ -2907,6 +2885,11 @@ public type sharingmodify_shared_link_settings_settings record { string requested_visibility?; }; +public type inline_response_200_65_content_sync_settings record { + string id?; + inline_response_200_65_sync_setting sync_setting?; +}; + # Represents the Headers record for the operation: uploadSessionFinishBatch public type UploadSessionFinishBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2915,7 +2898,7 @@ public type UploadSessionFinishBatchHeaders record { }; public type inline_response_200 record { - string profile_photo_url?; + string result?; }; # Represents the Headers record for the operation: templatesListForUser @@ -2944,24 +2927,47 @@ public type devices_revoke_device_session_batch_body record { devices_revoke_device_session_body[] revoke_devices?; }; -public type inline_response_200_58_complete record { +public type TemplateId record { + string template_id?; +}; + +public type inline_response_200_75_account_type record { string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; }; -public type inline_response_200_70_has_team_shared_dropbox record { +public type RemovePropertiesRequest record { + string path?; + string[] property_template_ids?; +}; + +public type inline_response_200_12_metadata record { + string id?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + inline_response_200_12_metadata_sharing_info sharing_info?; +}; + +public type inline_response_200_33_link_metadata_audience_options record { string \.tag?; - boolean has_team_shared_dropbox?; }; -public type inline_response_200_69_team_folders record { - inline_response_200_67_content_sync_settings[] content_sync_settings?; - boolean is_team_shared_dropbox?; +public type inline_response_200_16_file_metadata record { + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; string name?; - teamgroupsget_info_profile_status status?; - inline_response_200_67_sync_setting sync_setting?; - string team_folder_id?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type filesget_thumbnail_batch_entries record { @@ -2992,9 +2998,22 @@ public type ProxyConfig record {| string password = ""; |}; -public type inline_response_200_15_entries record { +public type inline_response_200_9_metadata record { string \.tag?; - inline_response_200_14_metadata metadata?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type copy_batch_check_v2_body record { @@ -3015,27 +3034,8 @@ public type sharing_transfer_folder_body record { string to_dropbox_id?; }; -public type inline_response_200_71_policies_sharing record { - inline_response_200_71_policies_sharing_shared_folder_join_policy shared_folder_join_policy?; - sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; - inline_response_200_71_policies_sharing_shared_link_create_policy shared_link_create_policy?; -}; - # Represents the Headers record for the operation: app public type AppHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; - -public type inline_response_200_73_events record { - inline_response_200_73_actor actor?; - inline_response_200_73_assets[] assets?; - inline_response_200_73_actor_user context?; - inline_response_200_73_details details?; - inline_response_200_73_event_category event_category?; - inline_response_200_73_event_type event_type?; - boolean involve_non_team_member?; - inline_response_200_73_origin origin?; - inline_response_200_73_participants[] participants?; - string timestamp?; -}; diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json deleted file mode 100644 index 4c384d4..0000000 --- a/docs/spec/openapi.json +++ /dev/null @@ -1,33990 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Dropbox API Reference", - "description": "The powerful, yet simple, Dropbox API allows you to manage and control content and team settings programmatically and extend Dropbox capabilities in new and powerful ways. This is a collection that includes requests to all endpoints in the Dropbox API. \n\nThe Dropbox API is divided in two groups of endpoints: User Endpoints and Business Endpoints. Operations that would most likely be executed by a user, such as file operations, are in the User Endpoints folder. Operations that would most likely be executed by a team administrator, such as adding users to groups, live in the Business Endpoints folder. \n\nIf you are new to Dropbox Business and Team Administration, please have a look at the [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). \n\nIf you want more information on how to use our API please refer to our [Developer Portal](https://www.dropbox.com/developers). \n\n# What's in the collection?\n\nThe endpoints are organized in the following folders:\n* account\n* auth\n* check\n* contacts\n* file_properties\n* file_requests\n* files\n* sharing\n* team\n* team_log\n* users\n\n# Authorization\n\n## OAuth 2.0 for API Access\nDropbox uses OAuth 2.0, an open specification, to authorize access to data. To get an OAuth token from Dropbox to enable Postman to access your Dropbox account via the API you’ll need to create a new app on the DBX Platform.\n\n## Creating an App on the DBX Platform\nNavigate to https://www.dropbox.com/developers/apps and select “Create app” \n1. Choose an API \n2. Choose the type of access you need \n3. Give your app a name \n4. Choose the Dropbox account that will own your app \n\nFor reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) \n\n## Generating an Access Token\nOnce you select “Create app” a page will load that displays information about your newly created app. To generate an access token scroll down to “OAuth 2” and click “Generate” beneath “Generated access token.” The token will display as a long string of characters. Copy this token for use with the Postman Collection.\n\n## Adding an Access Token to the requests\nIn the Postman client, click on the three dots to the right of the collection name to \"View more actions.\"\n\n![Screenshot of adding access token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1)\n\nThen, click \"Edit.\"\n\nClick on the \"Variables\" tab and, in the row for the `access_token` variable, paste your access token in the `CURRENT VALUE` column. The default value is `your-access-token-here`.\n\n![Screenshot of adding access token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1)\n\nFor information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/.\n\n# Notes\n* Dropbox also has a Postman Collection in the API Network to help administrators with team management workflows. It is called [Dropbox Team Admin Workflows](). \n\n", - "version": "1.0.0", - "contact": {} - }, - "servers": [ - { - "url": "https://api.dropboxapi.com/2" - }, - { - "url": "https://content.dropboxapi.com/2" - }, - { - "url": "https://notify.dropboxapi.com/2" - } - ], - "paths": { - "/account/set_profile_photo": { - "post": { - "tags": [ - "account" - ], - "summary": "set_profile_photo", - "description": "[set_profile_photo](https://www.dropbox.com/developers/documentation/http/documentation#account-set_profile_photo)\n\nscope: `account_info.write`\n\nSets a user's profile photo.", - "operationId": "setProfilePhoto", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "photo": { - "$ref": "#/components/schemas/Photo" - } - } - }, - "examples": { - "set_profile_photo": { - "value": { - "photo": { - ".tag": "base64_data", - "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "set_profile_photo response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - }, - "examples": { - "set_profile_photo response": { - "value": { - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - } - } - } - } - } - } - }, - "/auth/token/from_oauth1": { - "post": { - "tags": [ - "auth" - ], - "summary": "token/from_oauth1", - "description": "[token/from_oauth1](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-from_oauth1)\n\nscope: `None`\n\nCreates an OAuth 2.0 access token from the supplied OAuth 1.0 access token.", - "operationId": "tokenFromOauth1", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "oauth1_token": { - "type": "string", - "example": "qievr8hamyg6ndck" - }, - "oauth1_token_secret": { - "type": "string", - "example": "qomoftv0472git7" - } - } - }, - "examples": { - "token/from_oauth1": { - "value": { - "oauth1_token": "qievr8hamyg6ndck", - "oauth1_token_secret": "qomoftv0472git7" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "token/from_oauth1 response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "oauth2_token": { - "type": "string", - "example": "9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn" - } - } - }, - "examples": { - "token/from_oauth1 response": { - "value": { - "oauth2_token": "9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn" - } - } - } - } - } - } - } - } - }, - "/auth/token/revoke": { - "post": { - "tags": [ - "auth" - ], - "summary": "token/revoke", - "description": "[token/revoke](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke)\n\nscope: `None`\n\nDisables the access token used to authenticate the call.", - "operationId": "tokenRevoke", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/check/app": { - "post": { - "tags": [ - "check" - ], - "summary": "app", - "description": "[app](https://www.dropbox.com/developers/documentation/http/documentation#check-app)\n\nscope: `None`\n\nThis endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid.", - "operationId": "app", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "query": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "app": { - "value": { - "query": "foo" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "app response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "app response": { - "value": { - "result": "foo" - } - } - } - } - } - } - } - } - }, - "/check/user": { - "post": { - "tags": [ - "check" - ], - "summary": "user", - "description": "[user](https://www.dropbox.com/developers/documentation/http/documentation#check-user)\n\nscope: `None`\n\nThis endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the access token is valid.", - "operationId": "user", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "query": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "user": { - "value": { - "query": "foo" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "user response": { - "value": { - "result": "foo" - } - } - } - } - } - } - } - } - }, - "/contacts/delete_manual_contacts": { - "post": { - "tags": [ - "contacts" - ], - "summary": "delete_manual_contacts", - "description": "[delete_manual_contacts](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts)\n\nscope: `contacts.write`\n\nRemoves all manually added contacts. You'll still keep contacts who are on your team or who you imported. New contacts will be added when you share.", - "operationId": "deleteManualContacts", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/contacts/delete_manual_contacts_batch": { - "post": { - "tags": [ - "contacts" - ], - "summary": "delete_manual_contacts_batch", - "description": "[delete_manual_contacts_batch](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts_batch)\n\nscope: `contacts.write`\n\nRemoves manually added contacts from the given list.", - "operationId": "deleteManualContactsBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "email_addresses": { - "type": "array", - "items": { - "type": "string", - "example": "contactemailaddress1@domain.com" - }, - "example": [ - "contactemailaddress1@domain.com", - "contactemailaddress2@domain.com" - ] - } - } - }, - "examples": { - "delete_manual_contacts_batch": { - "value": { - "email_addresses": [ - "contactemailaddress1@domain.com", - "contactemailaddress2@domain.com" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/add": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/add", - "description": "[properties/add](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add)\n\nscope: `files.metadata.write`\n\nAdd property groups to a Dropbox file. See `templates/add_for_user` or `templates/add_for_team` to create new templates.", - "operationId": "propertiesAdd", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "examples": { - "properties/add": { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/overwrite": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/overwrite", - "description": "[properties/overwrite](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite)\n\nscope: `files.metadata.write`\n\nOverwrite property groups associated with a file. This endpoint should be used instead of `properties/update` when property groups are being updated via a \"snapshot\" instead of via a \"delta\". In other words, this endpoint will delete all omitted fields from a property group, whereas `properties/update` will only delete fields that are explicitly marked for deletion.", - "operationId": "propertiesOverwrite", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "examples": { - "properties/overwrite": { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/remove": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/remove", - "description": "[properties/remove](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove)\n\nscope: `files.metadata.write`\n\nPermanently removes the specified property group from the file. To remove specific property field key value pairs, see `properties/update`. To update a template, see `templates/update_for_user` or `templates/update_for_team`. To remove a template, see `templates/remove_for_user` or `templates/remove_for_team`.", - "operationId": "propertiesRemove", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_template_ids": { - "type": "array", - "items": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "example": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - }, - "examples": { - "properties/remove": { - "value": { - "path": "/my_awesome/word.docx", - "property_template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/search": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/search", - "description": "[properties/search](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search)\n\nscope: `files.metadata.read`\n\nSearch across property templates for particular property field values.", - "operationId": "propertiesSearch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "logical_operator": { - "type": "string", - "example": "or_operator" - }, - "mode": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "field_name" - }, - "field_name": { - "type": "string", - "example": "Security" - } - } - }, - "query": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "logical_operator": "or_operator", - "mode": { - ".tag": "field_name", - "field_name": "Security" - }, - "query": "Confidential" - } - ] - }, - "template_filter": { - "type": "string", - "example": "filter_none" - } - } - }, - "examples": { - "properties/search": { - "value": { - "queries": [ - { - "logical_operator": "or_operator", - "mode": { - ".tag": "field_name", - "field_name": "Security" - }, - "query": "Confidential" - } - ], - "template_filter": "filter_none" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "properties/search response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "is_deleted": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - }, - "examples": { - "properties/search response": { - "value": { - "matches": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - } - } - } - } - } - } - }, - "/file_properties/properties/search/continue": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/search/continue", - "description": "[properties/search/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue)\n\nscope: `files.metadata.read`\n\nOnce a cursor has been retrieved from `properties/search`, use this to paginate through all search results.", - "operationId": "propertiesSearchContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "properties/search/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "properties/search/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "is_deleted": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - }, - "examples": { - "properties/search/continue response": { - "value": { - "matches": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - } - } - } - } - } - } - }, - "/file_properties/properties/update": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/update", - "description": "[properties/update](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update)\n\nscope: `files.metadata.write`\n\nAdd, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of `properties/overwrite` when property groups are being updated via a \"delta\" instead of via a \"snapshot\" . In other words, this endpoint will not delete any omitted fields from a property group, whereas `properties/overwrite` will delete any fields that are omitted from a property group.", - "operationId": "propertiesUpdate", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "update_property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "add_or_update_fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "remove_fields": { - "type": "array", - "items": {}, - "example": [] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "add_or_update_fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "remove_fields": [], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "examples": { - "properties/update": { - "value": { - "path": "/my_awesome/word.docx", - "update_property_groups": [ - { - "add_or_update_fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "remove_fields": [], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/templates/add_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/add_for_team", - "description": "[templates/add_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-add_for_team)\n\nscope: `files.team_metadata.write`\n\nAdd a template associated with a team. See `properties/add` to add properties to a file or folder.\nNote: this endpoint will create team-owned templates.", - "operationId": "templatesAddForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/add_for_team": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "name": "Security" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/add_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/add_for_team response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/add_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/add_for_user", - "description": "[templates/add_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user)\n\nscope: `files.metadata.write`\n\nAdd a template associated with a user. See `properties/add` to add properties to a file. This endpoint can't be called on a team member or admin's behalf.", - "operationId": "templatesAddForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/add_for_user": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "name": "Security" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/add_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/add_for_user response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - } - } - }, - "/file_properties/templates/get_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/get_for_team", - "description": "[templates/get_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-get_for_team)\n\nscope: `files.team_metadata.write`\n\nGet the schema for a specified template.", - "operationId": "templatesGetForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/get_for_team": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/get_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "string" - } - } - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/get_for_team response": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ], - "name": "Security" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/get_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/get_for_user", - "description": "[templates/get_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user)\n\nscope: `files.metadata.read`\n\nGet the schema for a specified template. This endpoint can't be called on a team member or admin's behalf.", - "operationId": "templatesGetForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/get_for_user": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/get_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "string" - } - } - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/get_for_user response": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ], - "name": "Security" - } - } - } - } - } - } - } - } - }, - "/file_properties/templates/list_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/list_for_team", - "description": "[templates/list_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-list_for_team)\n\nscope: `files.team_metadata.write`\n\nGet the template identifiers for a team. To get the schema of each template use `templates/get_for_team`.", - "operationId": "templatesListForTeam", - "responses": { - "200": { - "description": "templates/list_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_ids": { - "type": "array", - "items": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "example": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - }, - "examples": { - "templates/list_for_team response": { - "value": { - "template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/list_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/list_for_user", - "description": "[templates/list_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user)\n\nscope: `files.metadata.read`\n\nGet the template identifiers for a team. To get the schema of each template use `templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf.", - "operationId": "templatesListForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "templates/list_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_ids": { - "type": "array", - "items": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "example": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - }, - "examples": { - "templates/list_for_user response": { - "value": { - "template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - } - } - } - } - } - } - }, - "/file_properties/templates/remove_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/remove_for_team", - "description": "[templates/remove_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-remove_for_team)\n\nscope: `files.team_metadata.write`\n\nPermanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.", - "operationId": "templatesRemoveForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/remove_for_team": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/remove_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/remove_for_user", - "description": "[templates/remove_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user)\n\nscope: `files.metadata.write`\n\nPermanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.", - "operationId": "templatesRemoveForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/remove_for_user": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/templates/update_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/update_for_team", - "description": "[templates/update_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-update_for_team)\n\nscope: `files.team_metadata.write`\n\nUpdate a template associated with a team. This route can update the template name, the template description and add optional properties to templates.", - "operationId": "templatesUpdateForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add_fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "description": { - "type": "string", - "example": "These properties will describe how confidential this file or folder is." - }, - "name": { - "type": "string", - "example": "New Security Template Name" - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_team": { - "value": { - "add_fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "description": "These properties will describe how confidential this file or folder is.", - "name": "New Security Template Name", - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/update_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_team response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/update_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/update_for_user", - "description": "[templates/update_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user)\n\nscope: `files.metadata.write`\n\nUpdate a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf.", - "operationId": "templatesUpdateForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add_fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "description": { - "type": "string", - "example": "These properties will describe how confidential this file or folder is." - }, - "name": { - "type": "string", - "example": "New Security Template Name" - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_user": { - "value": { - "add_fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "description": "These properties will describe how confidential this file or folder is.", - "name": "New Security Template Name", - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/update_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_user response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - } - } - }, - "/file_requests/count": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "count", - "description": "[count](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-count)\n\nscope: `file_requests.read`\n\nReturns the total number of file requests owned by this user. Includes both open and closed file requests.", - "operationId": "count", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "count response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_request_count": { - "type": "number", - "example": 15 - } - } - }, - "examples": { - "count response": { - "value": { - "file_request_count": 15 - } - } - } - } - } - } - } - } - }, - "/file_requests/create": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "create", - "description": "[create](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create)\n\nscope: `file_requests.write`\n\nCreates a file request for this user.", - "operationId": "create", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "string", - "example": "seven_days" - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - } - } - }, - "examples": { - "create": { - "value": { - "deadline": { - "allow_late_uploads": "seven_days", - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "open": true, - "title": "Homework submission" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "create response": { - "value": { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - } - } - } - }, - "/file_requests/delete": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "delete", - "description": "[delete](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete)\n\nscope: `file_requests.write`\n\nDelete a batch of closed file requests.", - "operationId": "delete", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ids": { - "type": "array", - "items": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "example": [ - "oaCAVmEyrqYnkZX9955Y", - "BaZmehYoXMPtaRmfTbSG" - ] - } - } - }, - "examples": { - "delete": { - "value": { - "ids": [ - "oaCAVmEyrqYnkZX9955Y", - "BaZmehYoXMPtaRmfTbSG" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - }, - "examples": { - "delete response": { - "value": { - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - } - } - } - } - } - } - }, - "/file_requests/delete_all_closed": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "delete_all_closed", - "description": "[delete_all_closed](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete_all_closed)\n\nscope: `file_requests.write`\n\nDelete all closed file requests owned by this user.", - "operationId": "deleteAllClosed", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "delete_all_closed response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - }, - "examples": { - "delete_all_closed response": { - "value": { - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - } - } - } - } - } - } - }, - "/file_requests/get": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "get", - "description": "[get](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get)\n\nscope: `file_requests.read`\n\nReturns the specified file request.", - "operationId": "get", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "get": { - "value": { - "id": "oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "get response": { - "value": { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - } - } - } - }, - "/file_requests/list_v2": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "list", - "description": "[list](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list)\n\nscope: `file_requests.read`\n\nReturns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.", - "operationId": "list", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 1000 - } - } - }, - "examples": { - "list": { - "value": { - "limit": 1000 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - }, - "has_more": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ], - "has_more": true - } - } - } - } - } - } - } - } - }, - "/file_requests/list/continue": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "list/continue", - "description": "[list/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list-continue)\n\nscope: `file_requests.read`\n\nOnce a cursor has been retrieved from `list:2`, use this to paginate through all file requests. The cursor must come from a previous call to `list:2` or `list/continue`.", - "operationId": "listContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - }, - "has_more": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ], - "has_more": true - } - } - } - } - } - } - } - } - }, - "/file_requests/update": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "update", - "description": "[update](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-update)\n\nscope: `file_requests.write`\n\nUpdate a file request.", - "operationId": "update", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deadline": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "update" - }, - "allow_late_uploads": { - "type": "string", - "example": "seven_days" - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - } - } - }, - "examples": { - "update": { - "value": { - "deadline": { - ".tag": "update", - "allow_late_uploads": "seven_days", - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "id": "oaCAVmEyrqYnkZX9955Y", - "open": true, - "title": "Homework submission" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "update response": { - "value": { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - } - } - } - }, - "/files/copy_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "copy", - "description": "[copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy)\n\nscope: `files.content.write`\n\nCopy a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be copied.", - "operationId": "copy", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allow_ownership_transfer": { - "type": "boolean", - "example": false - }, - "allow_shared_folder": { - "type": "boolean", - "example": false - }, - "autorename": { - "type": "boolean", - "example": false - }, - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "examples": { - "copy": { - "value": { - "allow_ownership_transfer": false, - "allow_shared_folder": false, - "autorename": false, - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "copy response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/copy_batch_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_batch", - "description": "[copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch)\n\nscope: `files.content.write`\n\nCopy multiple files or folders to different locations at once in the user's Dropbox.\nThis route will replace `copy_batch:1`. The main difference is this route will return status for each entry, while `copy_batch:1` raises failure if any entry fails.\nThis route will either finish synchronously, or return a job ID and do the async copy job in background. Please use `copy_batch/check:2` to check the job status.", - "operationId": "copyBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": false - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "example": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - }, - "examples": { - "copy_batch": { - "value": { - "autorename": false, - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "copy_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/copy_batch/check_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_batch/check", - "description": "[copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `copy_batch:2`. It returns list of results for each entry.", - "operationId": "copyBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "copy_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "copy_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/copy_reference/get": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_reference/get", - "description": "[copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get)\n\nscope: `files.content.write`\n\nGet a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to `copy_reference/save`.", - "operationId": "copyReferenceGet", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/video.mp4" - } - } - }, - "examples": { - "copy_reference/get": { - "value": { - "path": "/video.mp4" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_reference/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "copy_reference": { - "type": "string", - "example": "z1X6ATl6aWtzOGq0c3g5Ng" - }, - "expires": { - "type": "string", - "example": "2045-05-12T15:50:38Z" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "copy_reference/get response": { - "value": { - "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", - "expires": "2045-05-12T15:50:38Z", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/copy_reference/save": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_reference/save", - "description": "[copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save)\n\nscope: `files.content.write`\n\nSave a copy reference returned by `copy_reference/get` to the user's Dropbox.", - "operationId": "copyReferenceSave", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "copy_reference": { - "type": "string", - "example": "z1X6ATl6aWtzOGq0c3g5Ng" - }, - "path": { - "type": "string", - "example": "/video.mp4" - } - } - }, - "examples": { - "copy_reference/save": { - "value": { - "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", - "path": "/video.mp4" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_reference/save response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "copy_reference/save response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/create_folder_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "create_folder", - "description": "[create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder)\n\nscope: `files.content.write`\n\nCreate a folder at a given path.", - "operationId": "createFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math" - } - } - }, - "examples": { - "create_folder": { - "value": { - "autorename": false, - "path": "/Homework/math" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "examples": { - "create_folder response": { - "value": { - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - } - } - } - } - } - } - } - }, - "/files/create_folder_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "create_folder_batch", - "description": "[create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch)\n\nscope: `files.content.write`\n\nCreate multiple folders at once.\nThis route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the `CreateFolderBatchArg.force_async` flag. Use `create_folder_batch/check` to check the job status.", - "operationId": "createFolderBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": false - }, - "force_async": { - "type": "boolean", - "example": false - }, - "paths": { - "type": "array", - "items": { - "type": "string", - "example": "/Homework/math" - }, - "example": [ - "/Homework/math" - ] - } - } - }, - "examples": { - "create_folder_batch": { - "value": { - "autorename": false, - "force_async": false, - "paths": [ - "/Homework/math" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create_folder_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - }, - "examples": { - "create_folder_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/create_folder_batch/check": { - "post": { - "tags": [ - "files" - ], - "summary": "create_folder_batch/check", - "description": "[create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `create_folder_batch`. If success, it returns list of result for each entry.", - "operationId": "createFolderBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "create_folder_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create_folder_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - }, - "examples": { - "create_folder_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/delete_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "delete", - "description": "[delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete)\n\nscope: `files.content.write`\n\nDelete the file or folder at a given path.\nIf the path is a folder, all its contents will be deleted too.\nA successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding `FileMetadata` or `FolderMetadata` for the item at time of deletion, and not a `DeletedMetadata` object.", - "operationId": "delete1", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - } - } - }, - "examples": { - "delete": { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "delete response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/delete_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "delete_batch", - "description": "[delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch)\n\nscope: `files.content.write`\n\nDelete multiple files/folders at once.\nThis route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use `delete_batch/check` to check the job status.", - "operationId": "deleteBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - } - } - }, - "example": [ - { - "path": "/Homework/math/Prime_Numbers.txt" - } - ] - } - } - }, - "examples": { - "delete_batch": { - "value": { - "entries": [ - { - "path": "/Homework/math/Prime_Numbers.txt" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "delete_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/delete_batch/check": { - "post": { - "tags": [ - "files" - ], - "summary": "delete_batch/check", - "description": "[delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `delete_batch`. If success, it returns list of result for each entry.", - "operationId": "deleteBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "delete_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "delete_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/download": { - "post": { - "tags": [ - "files" - ], - "summary": "download", - "description": "[download](https://www.dropbox.com/developers/documentation/http/documentation#files-download)\n\nscope: `files.content.read`\n\nDownload a file from a user's Dropbox.", - "operationId": "download", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math/Prime_Numbers.txt\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "download response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "download response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/download_zip": { - "post": { - "tags": [ - "files" - ], - "summary": "download_zip", - "description": "[download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip)\n\nscope: `files.content.read`\n\nDownload a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size.", - "operationId": "downloadZip", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "download_zip response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "examples": { - "download_zip response": { - "value": { - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - } - } - } - } - } - } - } - }, - "/files/export": { - "post": { - "tags": [ - "files" - ], - "summary": "export", - "description": "[export](https://www.dropbox.com/developers/documentation/http/documentation#files-export)\n\nscope: `files.content.read`\n\nExport a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose `ExportResult.file_metadata` has `ExportInfo.export_as` populated.", - "operationId": "export", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math/Prime_Numbers.gsheet\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "export response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "export_metadata": { - "type": "object", - "properties": { - "export_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "name": { - "type": "string", - "example": "Prime_Numbers.xlsx" - }, - "size": { - "type": "number", - "example": 7189 - } - } - }, - "file_metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "export response": { - "value": { - "export_metadata": { - "export_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "name": "Prime_Numbers.xlsx", - "size": 7189 - }, - "file_metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/get_file_lock_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "get_file_lock_batch", - "description": "[get_file_lock_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_file_lock_batch)\n\nscope: `files.content.read`\n\nReturn the lock metadata for the given list of paths.", - "operationId": "getFileLockBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/John Doe/sample/test.pdf" - } - } - }, - "example": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - }, - "examples": { - "get_file_lock_batch": { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_file_lock_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "lock": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "single_user" - }, - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "lock_holder_account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "lock_holder_team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - } - } - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "get_file_lock_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/get_metadata": { - "post": { - "tags": [ - "files" - ], - "summary": "get_metadata", - "description": "[get_metadata](https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata)\n\nscope: `files.metadata.read`\n\nReturns the metadata for a file or folder.\nNote: Metadata for the root folder is unsupported.", - "operationId": "getMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_deleted": { - "type": "boolean", - "example": false - }, - "include_has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "include_media_info": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math" - } - } - }, - "examples": { - "get_metadata": { - "value": { - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_media_info": false, - "path": "/Homework/math" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "get_metadata response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/get_preview": { - "post": { - "tags": [ - "files" - ], - "summary": "get_preview", - "description": "[get_preview](https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview)\n\nscope: `files.content.read`\n\nGet a preview for a file.\nCurrently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf.\nHTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx.\nOther formats will return an unsupported extension error.", - "operationId": "getPreview", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/word.docx\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "get_preview response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "get_preview response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/get_temporary_link": { - "post": { - "tags": [ - "files" - ], - "summary": "get_temporary_link", - "description": "[get_temporary_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link)\n\nscope: `files.content.read`\n\nGet a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type.", - "operationId": "getTemporaryLink", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/video.mp4" - } - } - }, - "examples": { - "get_temporary_link": { - "value": { - "path": "/video.mp4" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_temporary_link response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "link": { - "type": "string", - "example": "https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2" - }, - "metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "get_temporary_link response": { - "value": { - "link": "https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2", - "metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/get_temporary_upload_link": { - "post": { - "tags": [ - "files" - ], - "summary": "get_temporary_upload_link", - "description": "[get_temporary_upload_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_upload_link)\n\nscope: `files.content.write`\n\nGet a one-time use temporary upload link to upload a file to a Dropbox location.\n\nThis endpoint acts as a delayed `upload`. The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the `CommitInfo` previously provided to `get_temporary_upload_link` but evaluated only upon consumption. Hence, errors stemming from invalid `CommitInfo` with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time.\n\nThe POST request on the temporary upload link must have its Content-Type set to \"application/octet-stream\".\n\nExample temporary upload link consumption request:\n\ncurl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND\n--header \"Content-Type: application/octet-stream\"\n--data-binary @local_file.txt\n\nA successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format.\n\nExample succesful temporary upload link consumption response:\n{\"content-hash\": \"599d71033d700ac892a0e48fa61b125d2f5994\"}\n\nAn unsuccessful temporary upload link consumption request returns any of the following status codes:\n\nHTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid.\nHTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened.\nHTTP 410 Gone: The temporary upload link is expired or consumed.\n\nExample unsuccessful temporary upload link consumption response:\nTemporary upload link has been recently consumed.", - "operationId": "getTemporaryUploadLink", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "commit_info": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": true - }, - "mode": { - "type": "string", - "example": "add" - }, - "mute": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math/Matrices.txt" - }, - "strict_conflict": { - "type": "boolean", - "example": false - } - } - }, - "duration": { - "type": "number", - "example": 3600 - } - } - }, - "examples": { - "get_temporary_upload_link": { - "value": { - "commit_info": { - "autorename": true, - "mode": "add", - "mute": false, - "path": "/Homework/math/Matrices.txt", - "strict_conflict": false - }, - "duration": 3600 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_temporary_upload_link response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "link": { - "type": "string", - "example": "https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND" - } - } - }, - "examples": { - "get_temporary_upload_link response": { - "value": { - "link": "https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND" - } - } - } - } - } - } - } - } - }, - "/files/get_thumbnail_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "get_thumbnail", - "description": "[get_thumbnail](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail)\n\nscope: `files.content.read`\n\nGet a thumbnail for a file.", - "operationId": "getThumbnail", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"resource\": {\n \".tag\": \"path\", \n \"path\": \"/a.docx\"\n }, \n \"format\": \"jpeg\", \n \"size\": \"w64h64\", \n \"mode\": \"strict\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "get_thumbnail response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "get_thumbnail response": { - "value": { - "file_metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/get_thumbnail_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "get_thumbnail_batch", - "description": "[get_thumbnail_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch)\n\nscope: `files.content.read`\n\nGet thumbnails for a list of images. We allow up to 25 thumbnails in a single batch.\nThis method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.", - "operationId": "getThumbnailBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "format": { - "type": "string", - "example": "jpeg" - }, - "mode": { - "type": "string", - "example": "strict" - }, - "path": { - "type": "string", - "example": "/image.jpg" - }, - "size": { - "type": "string", - "example": "w64h64" - } - } - }, - "example": [ - { - "format": "jpeg", - "mode": "strict", - "path": "/image.jpg", - "size": "w64h64" - } - ] - } - } - }, - "examples": { - "get_thumbnail_batch": { - "value": { - "entries": [ - { - "format": "jpeg", - "mode": "strict", - "path": "/image.jpg", - "size": "w64h64" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_thumbnail_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "thumbnail": { - "type": "string", - "example": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - "thumbnail": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" - } - ] - } - } - }, - "examples": { - "get_thumbnail_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - "thumbnail": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" - } - ] - } - } - } - } - } - } - } - } - }, - "/files/list_folder": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder", - "description": "[list_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder)\n\nscope: `files.metadata.read`\n\nStarts returning the contents of a folder. If the result's `ListFolderResult.has_more` field is `true`, call `list_folder/continue` with the returned `ListFolderResult.cursor` to retrieve more entries.\nIf you're using `ListFolderArg.recursive` set to `true` to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync:\nFor each `FileMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children.\nFor each `FolderMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's `FolderSharingInfo.read_only` and set all its children's read-only statuses to match.\nFor each `DeletedMetadata`, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry.\nNote: `auth.RateLimitError` may be returned if multiple `list_folder` or `list_folder/continue` calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.", - "operationId": "listFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_deleted": { - "type": "boolean", - "example": false - }, - "include_has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "include_media_info": { - "type": "boolean", - "example": false - }, - "include_mounted_folders": { - "type": "boolean", - "example": true - }, - "include_non_downloadable_files": { - "type": "boolean", - "example": true - }, - "path": { - "type": "string", - "example": "/Homework/math" - }, - "recursive": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder": { - "value": { - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_media_info": false, - "include_mounted_folders": true, - "include_non_downloadable_files": true, - "path": "/Homework/math", - "recursive": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/files/list_folder/continue": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder/continue", - "description": "[list_folder/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue)\n\nscope: `files.metadata.read`\n\nOnce a cursor has been retrieved from `list_folder`, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for `list_folder`.", - "operationId": "listFolderContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folder/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/files/list_folder/get_latest_cursor": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder/get_latest_cursor", - "description": "[list_folder/get_latest_cursor](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-get_latest_cursor)\n\nscope: `files.metadata.read`\n\nA way to quickly get a cursor for the folder's state. Unlike `list_folder`, `list_folder/get_latest_cursor` doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.", - "operationId": "listFolderGetLatestCursor", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_deleted": { - "type": "boolean", - "example": false - }, - "include_has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "include_media_info": { - "type": "boolean", - "example": false - }, - "include_mounted_folders": { - "type": "boolean", - "example": true - }, - "include_non_downloadable_files": { - "type": "boolean", - "example": true - }, - "path": { - "type": "string", - "example": "/Homework/math" - }, - "recursive": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder/get_latest_cursor": { - "value": { - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_media_info": false, - "include_mounted_folders": true, - "include_non_downloadable_files": true, - "path": "/Homework/math", - "recursive": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder/get_latest_cursor response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folder/get_latest_cursor response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - } - } - } - }, - "/files/list_folder/longpoll": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder/longpoll", - "description": "[list_folder/longpoll](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-longpoll)\n\nscope: `files.metadata.read`\n\nA longpoll endpoint to wait for changes on an account. In conjunction with `list_folder/continue`, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps. If you're looking for server-side notifications, check out our [webhooks documentation](https://www.dropbox.com/developers/reference/webhooks).", - "operationId": "listFolderLongpoll", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "timeout": { - "type": "number", - "example": 30 - } - } - }, - "examples": { - "list_folder/longpoll": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "timeout": 30 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder/longpoll response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "changes": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "list_folder/longpoll response": { - "value": { - "changes": true - } - } - } - } - } - } - } - } - }, - "/files/list_revisions": { - "post": { - "tags": [ - "files" - ], - "summary": "list_revisions", - "description": "[list_revisions](https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions)\n\nscope: `files.metadata.read`\n\nReturns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately.\nIn the `ListRevisionsMode.path` (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to `ListRevisionsMode.id`. The `ListRevisionsMode.id` mode is useful to retrieve revisions for a given file across moves or renames.", - "operationId": "listRevisions", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 10 - }, - "mode": { - "type": "string", - "example": "path" - }, - "path": { - "type": "string", - "example": "/root/word.docx" - } - } - }, - "examples": { - "list_revisions": { - "value": { - "limit": 10, - "mode": "path", - "path": "/root/word.docx" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_revisions response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - }, - "is_deleted": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_revisions response": { - "value": { - "entries": [ - { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ], - "is_deleted": false - } - } - } - } - } - } - } - } - }, - "/files/lock_file_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "lock_file_batch", - "description": "[lock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-lock_file_batch)\n\nscope: `files.content.write`\n\nLock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.", - "operationId": "lockFileBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/John Doe/sample/test.pdf" - } - } - }, - "example": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - }, - "examples": { - "lock_file_batch": { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "lock_file_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "lock": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "single_user" - }, - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "lock_holder_account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "lock_holder_team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - } - } - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "lock_file_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/move_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "move", - "description": "[move](https://www.dropbox.com/developers/documentation/http/documentation#files-move)\n\nscope: `files.content.write`\n\nMove a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be moved.\nNote that we do not currently support case-only renaming.", - "operationId": "move", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allow_ownership_transfer": { - "type": "boolean", - "example": false - }, - "allow_shared_folder": { - "type": "boolean", - "example": false - }, - "autorename": { - "type": "boolean", - "example": false - }, - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "examples": { - "move": { - "value": { - "allow_ownership_transfer": false, - "allow_shared_folder": false, - "autorename": false, - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "move response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "move response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/move_batch_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "move_batch", - "description": "[move_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch)\n\nscope: `files.content.write`\n\nMove multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming.\nThis route will replace `move_batch:1`. The main difference is this route will return status for each entry, while `move_batch:1` raises failure if any entry fails.\nThis route will either finish synchronously, or return a job ID and do the async move job in background. Please use `move_batch/check:2` to check the job status.", - "operationId": "moveBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allow_ownership_transfer": { - "type": "boolean", - "example": false - }, - "autorename": { - "type": "boolean", - "example": false - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "example": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - }, - "examples": { - "move_batch": { - "value": { - "allow_ownership_transfer": false, - "autorename": false, - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "move_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "move_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/move_batch/check_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "move_batch/check", - "description": "[move_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `move_batch:2`. It returns list of results for each entry.", - "operationId": "moveBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "move_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "move_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "move_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/permanently_delete": { - "post": { - "tags": [ - "files" - ], - "summary": "permanently_delete", - "description": "[permanently_delete](https://www.dropbox.com/developers/documentation/http/documentation#files-permanently_delete)\n\nscope: `files.permanent_delete`\n\nPermanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).\nNote: This endpoint is only available for Dropbox Business apps.", - "operationId": "permanentlyDelete", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - } - } - }, - "examples": { - "permanently_delete": { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/files/restore": { - "post": { - "tags": [ - "files" - ], - "summary": "restore", - "description": "[restore](https://www.dropbox.com/developers/documentation/http/documentation#files-restore)\n\nscope: `files.content.write`\n\nRestore a specific revision of a file to the given path.", - "operationId": "restore", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/root/word.docx" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - } - } - }, - "examples": { - "restore": { - "value": { - "path": "/root/word.docx", - "rev": "a1c10ce0dd78" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "restore response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "restore response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/save_url": { - "post": { - "tags": [ - "files" - ], - "summary": "save_url", - "description": "[save_url](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url)\n\nscope: `files.content.write`\n\nSave the data from a specified URL into a file in user's Dropbox.\nNote that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail.\nIf the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).", - "operationId": "saveUrl", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/a.txt" - }, - "url": { - "type": "string", - "example": "http://example.com/a.txt" - } - } - }, - "examples": { - "save_url": { - "value": { - "path": "/a.txt", - "url": "http://example.com/a.txt" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "save_url response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "save_url response": { - "value": { - ".tag": "complete", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/save_url/check_job_status": { - "post": { - "tags": [ - "files" - ], - "summary": "save_url/check_job_status", - "description": "[save_url/check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url-check_job_status)\n\nscope: `files.content.write`\n\nCheck the status of a `save_url` job.", - "operationId": "saveUrlCheckJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "save_url/check_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "save_url/check_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "in_progress" - } - } - }, - "examples": { - "save_url/check_job_status response": { - "value": { - ".tag": "in_progress" - } - } - } - } - } - } - } - } - }, - "/files/search_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "search", - "description": "[search](https://www.dropbox.com/developers/documentation/http/documentation#files-search)\n\nscope: `files.metadata.read`\n\nSearches for files and folders.\nNote: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches.\nRecent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.", - "operationId": "search", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_highlights": { - "type": "boolean", - "example": false - }, - "query": { - "type": "string", - "example": "cat" - } - } - }, - "examples": { - "search": { - "value": { - "include_highlights": false, - "query": "cat" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "search response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "has_more": { - "type": "boolean", - "example": false - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "metadata" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - } - } - }, - "example": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - }, - "examples": { - "search response": { - "value": { - "has_more": false, - "matches": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/search/continue_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "search/continue", - "description": "[search/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-search-continue)\n\nscope: `files.metadata.read`\n\nFetches the next page of search results returned from `search:2`.\nNote: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches.\nRecent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.", - "operationId": "searchContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "search/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "search/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "has_more": { - "type": "boolean", - "example": false - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "metadata" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - } - } - }, - "example": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - }, - "examples": { - "search/continue response": { - "value": { - "has_more": false, - "matches": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/unlock_file_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "unlock_file_batch", - "description": "[unlock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-unlock_file_batch)\n\nscope: `files.content.write`\n\nUnlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.", - "operationId": "unlockFileBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/John Doe/sample/test.pdf" - } - } - }, - "example": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - }, - "examples": { - "unlock_file_batch": { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "unlock_file_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "lock": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "single_user" - }, - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "lock_holder_account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "lock_holder_team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - } - } - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "unlock_file_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/upload": { - "post": { - "tags": [ - "files" - ], - "summary": "upload", - "description": "[upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload)\n\nscope: `files.content.write`\n\nCreate a new file with the contents provided in the request.\nDo not use this to upload a file larger than 150 MB. Instead, create an upload session with `upload_session/start`.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "upload", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\": false\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "upload response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "upload response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/upload_session/append_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/append", - "description": "[upload_session/append](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append)\n\nscope: `files.content.write`\n\nAppend more data to an upload session.\nWhen the parameter close is set, this call will close the session.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionAppend", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\", \n \"offset\": 0\n }, \n \"close\": false\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/files/upload_session/finish": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/finish", - "description": "[upload_session/finish](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish)\n\nscope: `files.content.write`\n\nFinish an upload session and save the uploaded data to the given file path.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionFinish", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\", \n \"offset\": 0\n }, \n \"commit\": {\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\": false\n }\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "upload_session/finish response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "upload_session/finish response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/upload_session/finish_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/finish_batch", - "description": "[upload_session/finish_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch)\n\nscope: `files.content.write`\n\nThis route helps you commit many files at once into a user's Dropbox. Use `upload_session/start` and `upload_session/append:2` to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling `upload_session/finish`, use this route to finish all your upload sessions in a single request.\n`UploadSessionStartArg.close` or `UploadSessionAppendArg.close` needs to be true for the last `upload_session/start` or `upload_session/append:2` call. The maximum size of a file one can upload to an upload session is 350 GB.\nThis route will return a job_id immediately and do the async commit job in background. Use `upload_session/finish_batch/check` to check the job status.\nFor the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionFinishBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "commit": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": true - }, - "mode": { - "type": "string", - "example": "add" - }, - "mute": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math/Matrices.txt" - }, - "strict_conflict": { - "type": "boolean", - "example": false - } - } - }, - "cursor": { - "type": "object", - "properties": { - "offset": { - "type": "number", - "example": 0 - }, - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - } - } - } - } - }, - "example": [ - { - "commit": { - "autorename": true, - "mode": "add", - "mute": false, - "path": "/Homework/math/Matrices.txt", - "strict_conflict": false - }, - "cursor": { - "offset": 0, - "session_id": "1234faaf0678bcde" - } - } - ] - } - } - }, - "examples": { - "upload_session/finish_batch": { - "value": { - "entries": [ - { - "commit": { - "autorename": true, - "mode": "add", - "mute": false, - "path": "/Homework/math/Matrices.txt", - "strict_conflict": false - }, - "cursor": { - "offset": 0, - "session_id": "1234faaf0678bcde" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "upload_session/finish_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - }, - "examples": { - "upload_session/finish_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - } - } - } - } - } - } - }, - "/files/upload_session/finish_batch/check": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/finish_batch/check", - "description": "[upload_session/finish_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `upload_session/finish_batch`. If success, it returns list of result for each entry.", - "operationId": "uploadSessionFinishBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "upload_session/finish_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "upload_session/finish_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - }, - "examples": { - "upload_session/finish_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - } - } - } - } - } - } - }, - "/files/upload_session/start": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/start", - "description": "[upload_session/start](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start)\n\nscope: `files.content.write`\n\nUpload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. This call starts a new upload session with the given data. You can then use `upload_session/append:2` to add more data and `upload_session/finish` to save all the data to a file in Dropbox.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nAn upload session can be used for a maximum of 48 hours. Attempting to use an `UploadSessionStartResult.session_id` with `upload_session/append:2` or `upload_session/finish` more than 48 hours after its creation will return a `UploadSessionLookupError.not_found`.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionStart", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"close\": false\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "upload_session/start response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - } - } - }, - "examples": { - "upload_session/start response": { - "value": { - "session_id": "1234faaf0678bcde" - } - } - } - } - } - } - } - } - }, - "/sharing/add_file_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "add_file_member", - "description": "[add_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member)\n\nscope: `sharing.write`\n\nAdds specified members to a file.", - "operationId": "addFileMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "viewer" - }, - "add_message_as_comment": { - "type": "boolean", - "example": false - }, - "custom_message": { - "type": "string", - "example": "This is a custom message about ACME.doc" - }, - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "example": [ - { - ".tag": "email", - "email": "justin@example.com" - } - ] - }, - "quiet": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "add_file_member": { - "value": { - "access_level": "viewer", - "add_message_as_comment": false, - "custom_message": "This is a custom message about ACME.doc", - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "members": [ - { - ".tag": "email", - "email": "justin@example.com" - } - ], - "quiet": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "add_file_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "result": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - } - } - } - } - }, - "example": [ - { - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "result": { - ".tag": "success" - } - } - ] - }, - "examples": { - "add_file_member response": { - "value": [ - { - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "result": { - ".tag": "success" - } - } - ] - } - } - } - } - } - } - } - }, - "/sharing/add_folder_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "add_folder_member", - "description": "[add_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.\nFor the new member to get access to all the functionality for this folder, you will need to call `mount_folder` on their behalf.", - "operationId": "addFolderMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "custom_message": { - "type": "string", - "example": "Documentation for launch day" - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "editor" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "dropbox_id": { - "type": "string", - "example": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - } - } - }, - "example": [ - { - "access_level": "editor", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - }, - { - "access_level": "viewer", - "member": { - ".tag": "dropbox_id", - "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - ] - }, - "quiet": { - "type": "boolean", - "example": false - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "add_folder_member": { - "value": { - "custom_message": "Documentation for launch day", - "members": [ - { - "access_level": "editor", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - }, - { - "access_level": "viewer", - "member": { - ".tag": "dropbox_id", - "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - ], - "quiet": false, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/check_job_status": { - "post": { - "tags": [ - "sharing" - ], - "summary": "check_job_status", - "description": "[check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job.", - "operationId": "checkJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "check_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "check_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "in_progress" - } - } - }, - "examples": { - "check_job_status response": { - "value": { - ".tag": "in_progress" - } - } - } - } - } - } - } - } - }, - "/sharing/check_remove_member_job_status": { - "post": { - "tags": [ - "sharing" - ], - "summary": "check_remove_member_job_status", - "description": "[check_remove_member_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job for sharing a folder.", - "operationId": "checkRemoveMemberJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "check_remove_member_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "check_remove_member_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "check_remove_member_job_status response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/sharing/check_share_job_status": { - "post": { - "tags": [ - "sharing" - ], - "summary": "check_share_job_status", - "description": "[check_share_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_share_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job for sharing a folder.", - "operationId": "checkShareJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "check_share_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "check_share_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "check_share_job_status response": { - "value": { - ".tag": "complete", - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/get_file_metadata": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_file_metadata", - "description": "[get_file_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata)\n\nscope: `sharing.read`\n\nReturns shared file metadata.", - "operationId": "getFileMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - }, - "examples": { - "get_file_metadata": { - "value": { - "actions": [], - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_file_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "get_file_metadata response": { - "value": { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/get_file_metadata/batch": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_file_metadata/batch", - "description": "[get_file_metadata/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch)\n\nscope: `sharing.read`\n\nReturns shared file metadata.", - "operationId": "getFileMetadataBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "files": { - "type": "array", - "items": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "example": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ] - } - } - }, - "examples": { - "get_file_metadata/batch": { - "value": { - "actions": [], - "files": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_file_metadata/batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "result": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "metadata" - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - } - } - }, - "example": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "metadata", - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - } - ] - }, - "examples": { - "get_file_metadata/batch response": { - "value": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "metadata", - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - } - ] - } - } - } - } - } - } - } - }, - "/sharing/get_folder_metadata": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_folder_metadata", - "description": "[get_folder_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata)\n\nscope: `sharing.read`\n\nReturns shared folder metadata by its folder ID.", - "operationId": "getFolderMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "get_folder_metadata": { - "value": { - "actions": [], - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_folder_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "get_folder_metadata response": { - "value": { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/get_shared_link_file": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_shared_link_file", - "description": "[get_shared_link_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file)\n\nscope: `sharing.read`\n\nDownload the shared link's file from a user's Dropbox.", - "operationId": "getSharedLinkFile", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"url\": \"https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0\", \n \"path\": \"/Prime_Numbers.txt\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "get_shared_link_file response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "get_shared_link_file response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - } - } - } - }, - "/sharing/get_shared_link_metadata": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_shared_link_metadata", - "description": "[get_shared_link_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_metadata)\n\nscope: `sharing.read`\n\nGet the shared link's metadata.", - "operationId": "getSharedLinkMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Prime_Numbers.txt" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "get_shared_link_metadata": { - "value": { - "path": "/Prime_Numbers.txt", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_shared_link_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "get_shared_link_metadata response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - } - } - } - }, - "/sharing/list_file_members": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_file_members", - "description": "[list_file_members](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members)\n\nscope: `sharing.read`\n\nUse to obtain the members who have been invited to a file, both inherited and uninherited members.", - "operationId": "listFileMembers", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "include_inherited": { - "type": "boolean", - "example": true - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_file_members": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "include_inherited": true, - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_file_members response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "platform_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "unknown" - } - } - }, - "time_last_seen": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - }, - "examples": { - "list_file_members response": { - "value": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_file_members/batch": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_file_members/batch", - "description": "[list_file_members/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch)\n\nscope: `sharing.read`\n\nGet members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.\nInherited users and groups are not included in the result, and permissions are not returned for this endpoint.", - "operationId": "listFileMembersBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "files": { - "type": "array", - "items": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "example": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ] - }, - "limit": { - "type": "number", - "example": 10 - } - } - }, - "examples": { - "list_file_members/batch": { - "value": { - "files": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ], - "limit": 10 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_file_members/batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "result": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "result" - }, - "member_count": { - "type": "number", - "example": 3 - }, - "members": { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "platform_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "unknown" - } - } - }, - "time_last_seen": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - }, - "example": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "result", - "member_count": 3, - "members": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - ] - }, - "examples": { - "list_file_members/batch response": { - "value": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "result", - "member_count": 3, - "members": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - ] - } - } - } - } - } - } - } - }, - "/sharing/list_file_members/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_file_members/continue", - "description": "[list_file_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_file_members` or `list_file_members/batch`, use this to paginate through all shared file members.", - "operationId": "listFileMembersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_file_members/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_file_members/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "platform_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "unknown" - } - } - }, - "time_last_seen": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - }, - "examples": { - "list_file_members/continue response": { - "value": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_folder_members/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_folder_members/continue", - "description": "[list_folder_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_folder_members`, use this to paginate through all shared folder members.", - "operationId": "listFolderMembersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folder_members/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder_members/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - }, - "examples": { - "list_folder_members/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_folders": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_folders", - "description": "[list_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders)\n\nscope: `sharing.read`\n\nReturn the list of all shared folders the current user has access to.", - "operationId": "listFolders", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_folders": { - "value": { - "actions": [], - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folders response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_folders response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_folders/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_folders/continue", - "description": "[list_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_folders`, use this to paginate through all shared folders. The cursor must come from a previous call to `list_folders` or `list_folders/continue`.", - "operationId": "listFoldersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folders/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folders/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_folders/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_mountable_folders": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_mountable_folders", - "description": "[list_mountable_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders)\n\nscope: `sharing.read`\n\nReturn the list of all shared folders the current user can mount or unmount.", - "operationId": "listMountableFolders", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_mountable_folders": { - "value": { - "actions": [], - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_mountable_folders response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_mountable_folders response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_mountable_folders/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_mountable_folders/continue", - "description": "[list_mountable_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_mountable_folders`, use this to paginate through all mountable shared folders. The cursor must come from a previous call to `list_mountable_folders` or `list_mountable_folders/continue`.", - "operationId": "listMountableFoldersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_mountable_folders/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_mountable_folders/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_mountable_folders/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_received_files": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_received_files", - "description": "[list_received_files](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files)\n\nscope: `sharing.read`\n\nReturns a list of all files shared with current user.\n Does not include files the user has received via shared folders, and does not include unclaimed invitations.", - "operationId": "listReceivedFiles", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_received_files": { - "value": { - "actions": [], - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_received_files response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_received_files response": { - "value": { - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ", - "entries": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_received_files/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_received_files/continue", - "description": "[list_received_files/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue)\n\nscope: `sharing.read`\n\nGet more results with a cursor from `list_received_files`.", - "operationId": "listReceivedFilesContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId" - } - } - }, - "examples": { - "list_received_files/continue": { - "value": { - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_received_files/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_received_files/continue response": { - "value": { - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ", - "entries": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_shared_links": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_shared_links", - "description": "[list_shared_links](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links)\n\nscope: `sharing.read`\n\nList shared links of this user.\nIf no path is given, returns a list of all shared links for the current user.\nIf a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.", - "operationId": "listSharedLinks", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_shared_links": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_shared_links response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": true - }, - "links": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "example": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - ] - } - } - }, - "examples": { - "list_shared_links response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true, - "links": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/modify_shared_link_settings": { - "post": { - "tags": [ - "sharing" - ], - "summary": "modify_shared_link_settings", - "description": "[modify_shared_link_settings](https://www.dropbox.com/developers/documentation/http/documentation#sharing-modify_shared_link_settings)\n\nscope: `sharing.write`\n\nModify the shared link's settings.\nIf the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the `LinkPermissions.resolved_visibility` of the returned `SharedLinkMetadata` will reflect the actual visibility of the shared link and the `LinkPermissions.requested_visibility` will reflect the requested visibility.", - "operationId": "modifySharedLinkSettings", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "remove_expiration": { - "type": "boolean", - "example": false - }, - "settings": { - "type": "object", - "properties": { - "access": { - "type": "string", - "example": "viewer" - }, - "audience": { - "type": "string", - "example": "public" - }, - "requested_visibility": { - "type": "string", - "example": "public" - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "modify_shared_link_settings": { - "value": { - "remove_expiration": false, - "settings": { - "access": "viewer", - "audience": "public", - "requested_visibility": "public" - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "modify_shared_link_settings response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "modify_shared_link_settings response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - } - } - } - }, - "/sharing/mount_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "mount_folder", - "description": "[mount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder)\n\nscope: `sharing.write`\n\nThe current user mounts the designated folder.\nMount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.", - "operationId": "mountFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "mount_folder": { - "value": { - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "mount_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "mount_folder response": { - "value": { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/relinquish_file_membership": { - "post": { - "tags": [ - "sharing" - ], - "summary": "relinquish_file_membership", - "description": "[relinquish_file_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership)\n\nscope: `sharing.write`\n\nThe current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.", - "operationId": "relinquishFileMembership", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - }, - "examples": { - "relinquish_file_membership": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/relinquish_folder_membership": { - "post": { - "tags": [ - "sharing" - ], - "summary": "relinquish_folder_membership", - "description": "[relinquish_folder_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership)\n\nscope: `sharing.write`\n\nThe current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder.\nThis will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.", - "operationId": "relinquishFolderMembership", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "leave_a_copy": { - "type": "boolean", - "example": false - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "relinquish_folder_membership": { - "value": { - "leave_a_copy": false, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "relinquish_folder_membership response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "relinquish_folder_membership response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/sharing/remove_file_member_2": { - "post": { - "tags": [ - "sharing" - ], - "summary": "remove_file_member_2", - "description": "[remove_file_member_2](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2)\n\nscope: `sharing.write`\n\nRemoves a specified member from the file.", - "operationId": "removeFileMember2", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - } - } - }, - "examples": { - "remove_file_member_2": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "remove_file_member_2 response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "examples": { - "remove_file_member_2 response": { - "value": { - ".tag": "other" - } - } - } - } - } - } - } - } - }, - "/sharing/remove_folder_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "remove_folder_member", - "description": "[remove_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.", - "operationId": "removeFolderMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "leave_a_copy": { - "type": "boolean", - "example": false - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "remove_folder_member": { - "value": { - "leave_a_copy": false, - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "remove_folder_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "async_job_id" - }, - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "remove_folder_member response": { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - } - } - } - }, - "/sharing/revoke_shared_link": { - "post": { - "tags": [ - "sharing" - ], - "summary": "revoke_shared_link", - "description": "[revoke_shared_link](https://www.dropbox.com/developers/documentation/http/documentation#sharing-revoke_shared_link)\n\nscope: `sharing.write`\n\nRevoke a shared link.\nNote that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the `list_shared_links` with the file as the `ListSharedLinksArg.path` argument.", - "operationId": "revokeSharedLink", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "revoke_shared_link": { - "value": { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/set_access_inheritance": { - "post": { - "tags": [ - "sharing" - ], - "summary": "set_access_inheritance", - "description": "[set_access_inheritance](https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance)\n\nscope: `sharing.write`\n\nChange the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root.\nIf a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder.", - "operationId": "setAccessInheritance", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "string", - "example": "inherit" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "set_access_inheritance": { - "value": { - "access_inheritance": "inherit", - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "set_access_inheritance response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "set_access_inheritance response": { - "value": { - ".tag": "complete", - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/share_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "share_folder", - "description": "[share_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-share_folder)\n\nscope: `sharing.write`\n\nShare a folder with collaborators.\nMost sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`.\nIf a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder.", - "operationId": "shareFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "string", - "example": "inherit" - }, - "acl_update_policy": { - "type": "string", - "example": "editors" - }, - "force_async": { - "type": "boolean", - "example": false - }, - "member_policy": { - "type": "string", - "example": "team" - }, - "path": { - "type": "string", - "example": "/example/workspace" - }, - "shared_link_policy": { - "type": "string", - "example": "members" - } - } - }, - "examples": { - "share_folder": { - "value": { - "access_inheritance": "inherit", - "acl_update_policy": "editors", - "force_async": false, - "member_policy": "team", - "path": "/example/workspace", - "shared_link_policy": "members" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "share_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "share_folder response": { - "value": { - ".tag": "complete", - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/transfer_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "transfer_folder", - "description": "[transfer_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder)\n\nscope: `sharing.write`\n\nTransfer ownership of a shared folder to a member of the shared folder.\nUser must have `AccessLevel.owner` access to the shared folder to perform a transfer.", - "operationId": "transferFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "to_dropbox_id": { - "type": "string", - "example": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - }, - "examples": { - "transfer_folder": { - "value": { - "shared_folder_id": "84528192421", - "to_dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/unmount_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "unmount_folder", - "description": "[unmount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder)\n\nscope: `sharing.write`\n\nThe current user unmounts the designated folder. They can re-mount the folder at a later time using `mount_folder`.", - "operationId": "unmountFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "unmount_folder": { - "value": { - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/unshare_file": { - "post": { - "tags": [ - "sharing" - ], - "summary": "unshare_file", - "description": "[unshare_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_file)\n\nscope: `sharing.write`\n\nRemove all members from this file. Does not remove inherited members.", - "operationId": "unshareFile", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - }, - "examples": { - "unshare_file": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/unshare_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "unshare_folder", - "description": "[unshare_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_folder)\n\nscope: `sharing.write`\n\nAllows a shared folder owner to unshare the folder.\nYou'll need to call `check_job_status` to determine if the action has completed successfully.", - "operationId": "unshareFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "leave_a_copy": { - "type": "boolean", - "example": false - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "unshare_folder": { - "value": { - "leave_a_copy": false, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "unshare_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "unshare_folder response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/sharing/update_file_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "update_file_member", - "description": "[update_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member)\n\nscope: `sharing.write`\n\nChanges a member's access on a shared file.", - "operationId": "updateFileMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "viewer" - }, - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - } - } - }, - "examples": { - "update_file_member": { - "value": { - "access_level": "viewer", - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update_file_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "update_file_member response": { - "value": {} - } - } - } - } - } - } - } - }, - "/sharing/update_folder_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "update_folder_member", - "description": "[update_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor of a shared folder to update another member's permissions.", - "operationId": "updateFolderMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "editor" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "update_folder_member": { - "value": { - "access_level": "editor", - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update_folder_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "update_folder_member response": { - "value": {} - } - } - } - } - } - } - } - }, - "/sharing/update_folder_policy": { - "post": { - "tags": [ - "sharing" - ], - "summary": "update_folder_policy", - "description": "[update_folder_policy](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy)\n\nscope: `sharing.write`\n\nUpdate the sharing policies for a shared folder.\nUser must have `AccessLevel.owner` access to the shared folder to update its policies.", - "operationId": "updateFolderPolicy", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "string", - "example": "owner" - }, - "member_policy": { - "type": "string", - "example": "team" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "shared_link_policy": { - "type": "string", - "example": "members" - } - } - }, - "examples": { - "update_folder_policy": { - "value": { - "acl_update_policy": "owner", - "member_policy": "team", - "shared_folder_id": "84528192421", - "shared_link_policy": "members" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update_folder_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "update_folder_policy response": { - "value": { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/team/devices/list_member_devices": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/list_member_devices", - "description": "[devices/list_member_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_member_devices)\n\nscope: `sessions.list`\n\nList all device sessions of a team's member.", - "operationId": "devicesListMemberDevices", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_desktop_clients": { - "type": "boolean", - "example": true - }, - "include_mobile_clients": { - "type": "boolean", - "example": true - }, - "include_web_sessions": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - }, - "examples": { - "devices/list_member_devices": { - "value": { - "include_desktop_clients": true, - "include_mobile_clients": true, - "include_web_sessions": true, - "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/devices/list_members_devices": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/list_members_devices", - "description": "[devices/list_members_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_members_devices)\n\nscope: `sessions.list`\n\nList all device sessions of a team.\nPermission : Team member file access.", - "operationId": "devicesListMembersDevices", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "devices/list_members_devices": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/devices/revoke_device_session": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/revoke_device_session", - "description": "[devices/revoke_device_session](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session)\n\nscope: `sessions.modify`\n\nRevoke a device session of a team's member.", - "operationId": "devicesRevokeDeviceSession", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web_session" - }, - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - }, - "examples": { - "devices/revoke_device_session": { - "value": { - ".tag": "web_session", - "session_id": "1234faaf0678bcde", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/devices/revoke_device_session_batch": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/revoke_device_session_batch", - "description": "[devices/revoke_device_session_batch](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session_batch)\n\nscope: `sessions.modify`\n\nRevoke a list of device sessions of team members.", - "operationId": "devicesRevokeDeviceSessionBatch", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "revoke_devices": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web_session" - }, - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - }, - "example": [ - { - ".tag": "web_session", - "session_id": "1234faaf0678bcde", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - ] - } - } - }, - "examples": { - "devices/revoke_device_session_batch": { - "value": { - "revoke_devices": [ - { - ".tag": "web_session", - "session_id": "1234faaf0678bcde", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/groups/create": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/create", - "description": "[groups/create](https://www.dropbox.com/developers/documentation/http/teams#team-groups-create)\n\nscope: `groups.write`\n\nCreates a new, empty group, with a requested name.\nPermission : Team member management.", - "operationId": "groupsCreate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add_creator_as_owner": { - "type": "boolean", - "example": false - }, - "group_external_id": { - "type": "string", - "example": "group-134" - }, - "group_name": { - "type": "string", - "example": "Europe sales" - } - } - }, - "examples": { - "groups/create": { - "value": { - "add_creator_as_owner": false, - "group_external_id": "group-134", - "group_name": "Europe sales" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/create response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "examples": { - "groups/create response": { - "value": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/groups/delete": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/delete", - "description": "[groups/delete](https://www.dropbox.com/developers/documentation/http/teams#team-groups-delete)\n\nscope: `groups.write`\n\nDeletes a group.\nThe group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nPermission : Team member management.", - "operationId": "groupsDelete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "examples": { - "groups/delete": { - "value": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "groups/delete response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/groups/get_info": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/get_info", - "description": "[groups/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-groups-get_info)\n\nscope: `groups.read`\n\nRetrieves information about one or more groups. Note that the optional field `GroupFullInfo.members` is not returned for system-managed groups.\nPermission : Team Information.", - "operationId": "groupsGetInfo", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_ids" - }, - "group_ids": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c", - "g:111111147abcd6000000000222222c" - ] - } - } - }, - "examples": { - "groups/get_info": { - "value": { - ".tag": "group_ids", - "group_ids": [ - "g:e2db7665347abcd600000000001a2b3c", - "g:111111147abcd6000000000222222c" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/get_info response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_info" - }, - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "example": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - }, - "examples": { - "groups/get_info response": { - "value": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - } - } - } - } - } - } - } - }, - "/team/groups/job_status/get": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/job_status/get", - "description": "[groups/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-groups-job_status-get)\n\nscope: `groups.write`\n\nOnce an async_job_id is returned from `groups/delete`, `groups/members/add` , or `groups/members/remove` use this method to poll the status of granting/revoking group members' access to group-owned resources.\nPermission : Team member management.", - "operationId": "groupsJobStatusGet", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "groups/job_status/get": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/job_status/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "groups/job_status/get response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/groups/list": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/list", - "description": "[groups/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list)\n\nscope: `groups.read`\n\nLists groups on a team.\nPermission : Team Information.", - "operationId": "groupsList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "groups/list": { - "value": { - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "member_count": { - "type": "number", - "example": 10 - } - } - }, - "example": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "groups/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "groups": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/groups/list/continue": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/list/continue", - "description": "[groups/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list-continue)\n\nscope: `groups.read`\n\nOnce a cursor has been retrieved from `groups/list`, use this to paginate through all groups.\nPermission : Team Information.", - "operationId": "groupsListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "groups/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "member_count": { - "type": "number", - "example": 10 - } - } - }, - "example": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "groups/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "groups": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/groups/members/add": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/add", - "description": "[groups/members/add](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-add)\n\nscope: `groups.write`\n\nAdds members to a group.\nThe members are added immediately. However the granting of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nPermission : Team member management.", - "operationId": "groupsMembersAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "string", - "example": "member" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "access_type": "member", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - }, - "return_members": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "groups/members/add": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "members": [ - { - "access_type": "member", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ], - "return_members": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "99988877733388" - }, - "group_info": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - }, - "examples": { - "groups/members/add response": { - "value": { - "async_job_id": "99988877733388", - "group_info": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "/team/groups/members/list": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/list", - "description": "[groups/members/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list)\n\nscope: `groups.read`\n\nLists members of a group.\nPermission : Team Information.", - "operationId": "groupsMembersList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "groups/members/list": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "members": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "groups/members/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "members": [] - } - } - } - } - } - } - } - } - }, - "/team/groups/members/list/continue": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/list/continue", - "description": "[groups/members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list-continue)\n\nscope: `groups.read`\n\nOnce a cursor has been retrieved from `groups/members/list`, use this to paginate through all members of the group.\nPermission : Team information.", - "operationId": "groupsMembersListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "groups/members/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "members": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "groups/members/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "members": [] - } - } - } - } - } - } - } - } - }, - "/team/groups/members/remove": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/remove", - "description": "[groups/members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-remove)\n\nscope: `groups.write`\n\nRemoves members from a group.\nThe members are removed immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nThis method permits removing the only owner of a group, even in cases where this is not possible via the web client.\nPermission : Team member management.", - "operationId": "groupsMembersRemove", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "return_members": { - "type": "boolean", - "example": true - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "groups/members/remove": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "return_members": true, - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/remove response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "99988877733388" - }, - "group_info": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - }, - "examples": { - "groups/members/remove response": { - "value": { - "async_job_id": "99988877733388", - "group_info": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "/team/groups/members/set_access_type": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/set_access_type", - "description": "[groups/members/set_access_type](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-set_access_type)\n\nscope: `groups.write`\n\nSets a member's access type in a group.\nPermission : Team member management.", - "operationId": "groupsMembersSetAccessType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_type": { - "type": "string", - "example": "member" - }, - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "return_members": { - "type": "boolean", - "example": true - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "groups/members/set_access_type": { - "value": { - "access_type": "member", - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "return_members": true, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/set_access_type response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_info" - }, - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "example": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - }, - "examples": { - "groups/members/set_access_type response": { - "value": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - } - } - } - } - } - } - } - }, - "/team/groups/update": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/update", - "description": "[groups/update](https://www.dropbox.com/developers/documentation/http/teams#team-groups-update)\n\nscope: `groups.write`\n\nUpdates a group's name and/or external ID.\nPermission : Team member management.", - "operationId": "groupsUpdate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "new_group_external_id": { - "type": "string", - "example": "sales-234" - }, - "new_group_management_type": { - "type": "string", - "example": "company_managed" - }, - "new_group_name": { - "type": "string", - "example": "Europe west sales" - }, - "return_members": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "groups/update": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "new_group_external_id": "sales-234", - "new_group_management_type": "company_managed", - "new_group_name": "Europe west sales", - "return_members": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/update response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "examples": { - "groups/update response": { - "value": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/create_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/create_policy", - "description": "[legal_holds/create_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-create_policy)\n\nscope: `team_data.member`\n\nCreates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsCreatePolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "members": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - }, - "example": [ - "dbmid:FDFSVF-DFSDF" - ] - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - } - } - }, - "examples": { - "legal_holds/create_policy": { - "value": { - "end_date": "2017-12-31T00:00:00Z", - "members": [ - "dbmid:FDFSVF-DFSDF" - ], - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/create_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "examples": { - "legal_holds/create_policy response": { - "value": { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/get_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/get_policy", - "description": "[legal_holds/get_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-get_policy)\n\nscope: `team_data.member`\n\nGets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsGetPolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/get_policy": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/get_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "examples": { - "legal_holds/get_policy response": { - "value": { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/list_held_revisions": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/list_held_revisions", - "description": "[legal_holds/list_held_revisions](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions)\n\nscope: `team_data.member`\n\nList the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsListHeldRevisions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/list_held_revisions": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/list_held_revisions response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "author_email": { - "type": "string", - "example": "a@a.com" - }, - "author_member_id": { - "type": "string", - "example": "dbmid:abcd1234abcd1234abcd1234abcd1234a23" - }, - "author_member_status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "content_hash": { - "type": "string", - "example": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234" - }, - "file_type": { - "type": "string", - "example": "Document" - }, - "new_filename": { - "type": "string", - "example": "111_222.pdf" - }, - "original_file_path": { - "type": "string", - "example": "/a.pdf" - }, - "original_revision_id": { - "type": "string", - "example": "ab2rij4i5ojgfd" - }, - "server_modified": { - "type": "string", - "example": "2019-08-12T12:08:52Z" - }, - "size": { - "type": "number", - "example": 3 - } - } - }, - "example": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "legal_holds/list_held_revisions response": { - "value": { - "entries": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/list_held_revisions_continue": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/list_held_revisions_continue", - "description": "[legal_holds/list_held_revisions_continue](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions_continue)\n\nscope: `team_data.member`\n\nContinue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsListHeldRevisionsContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/list_held_revisions_continue": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/list_held_revisions_continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "author_email": { - "type": "string", - "example": "a@a.com" - }, - "author_member_id": { - "type": "string", - "example": "dbmid:abcd1234abcd1234abcd1234abcd1234a23" - }, - "author_member_status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "content_hash": { - "type": "string", - "example": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234" - }, - "file_type": { - "type": "string", - "example": "Document" - }, - "new_filename": { - "type": "string", - "example": "111_222.pdf" - }, - "original_file_path": { - "type": "string", - "example": "/a.pdf" - }, - "original_revision_id": { - "type": "string", - "example": "ab2rij4i5ojgfd" - }, - "server_modified": { - "type": "string", - "example": "2019-08-12T12:08:52Z" - }, - "size": { - "type": "number", - "example": 3 - } - } - }, - "example": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "legal_holds/list_held_revisions_continue response": { - "value": { - "entries": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/list_policies": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/list_policies", - "description": "[legal_holds/list_policies](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_policies)\n\nscope: `team_data.member`\n\nLists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsListPolicies", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_released": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "legal_holds/list_policies": { - "value": { - "include_released": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/list_policies response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "policies": { - "type": "array", - "items": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "example": [ - { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - ] - } - } - }, - "examples": { - "legal_holds/list_policies response": { - "value": { - "policies": [ - { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/release_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/release_policy", - "description": "[legal_holds/release_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-release_policy)\n\nscope: `team_data.member`\n\nReleases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsReleasePolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/release_policy": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/legal_holds/update_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/update_policy", - "description": "[legal_holds/update_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-update_policy)\n\nscope: `team_data.member`\n\nUpdates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsUpdatePolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - }, - "example": [ - "dbmid:FDFSVF-DFSDF" - ] - } - } - }, - "examples": { - "legal_holds/update_policy": { - "value": { - "id": "pid_dbhid:abcd1234", - "members": [ - "dbmid:FDFSVF-DFSDF" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/update_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "examples": { - "legal_holds/update_policy response": { - "value": { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - } - } - } - } - } - } - } - }, - "/team/linked_apps/list_member_linked_apps": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/list_member_linked_apps", - "description": "[linked_apps/list_member_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_member_linked_apps)\n\nscope: `sessions.list`\n\nList all linked applications of the team member.\nNote, this endpoint does not list any team-linked applications.", - "operationId": "linkedAppsListMemberLinkedApps", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_member_id": { - "type": "string", - "example": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - }, - "examples": { - "linked_apps/list_member_linked_apps": { - "value": { - "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/linked_apps/list_members_linked_apps": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/list_members_linked_apps", - "description": "[linked_apps/list_members_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_members_linked_apps)\n\nscope: `sessions.list`\n\nList all applications linked to the team members' accounts.\nNote, this endpoint does not list any team-linked applications.", - "operationId": "linkedAppsListMembersLinkedApps", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "linked_apps/list_members_linked_apps": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/linked_apps/revoke_linked_app": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/revoke_linked_app", - "description": "[linked_apps/revoke_linked_app](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app)\n\nscope: `sessions.modify`\n\nRevoke a linked application of the team member.", - "operationId": "linkedAppsRevokeLinkedApp", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "linked_apps/revoke_linked_app": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/linked_apps/revoke_linked_app_batch": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/revoke_linked_app_batch", - "description": "[linked_apps/revoke_linked_app_batch](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app_batch)\n\nscope: `sessions.modify`\n\nRevoke a list of linked applications of the team members.", - "operationId": "linkedAppsRevokeLinkedAppBatch", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "linked_apps/revoke_linked_app_batch": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/member_space_limits/excluded_users/add": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/add", - "description": "[member_space_limits/excluded_users/add](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-add)\n\nscope: `members.write`\n\nAdd users to member space limits excluded users list.", - "operationId": "memberSpaceLimitsExcludedUsersAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/excluded_users/add": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - } - } - } - } - }, - "examples": { - "member_space_limits/excluded_users/add response": { - "value": { - "status": { - ".tag": "success" - } - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/excluded_users/list": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/list", - "description": "[member_space_limits/excluded_users/list](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list)\n\nscope: `members.read`\n\nList member space limits excluded users.", - "operationId": "memberSpaceLimitsExcludedUsersList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "member_space_limits/excluded_users/list": { - "value": { - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "users": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "member_space_limits/excluded_users/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "users": [] - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/excluded_users/list/continue": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/list/continue", - "description": "[member_space_limits/excluded_users/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list-continue)\n\nscope: `members.read`\n\nContinue listing member space limits excluded users.", - "operationId": "memberSpaceLimitsExcludedUsersListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "member_space_limits/excluded_users/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "users": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "member_space_limits/excluded_users/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "users": [] - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/excluded_users/remove": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/remove", - "description": "[member_space_limits/excluded_users/remove](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-remove)\n\nscope: `members.write`\n\nRemove users from member space limits excluded users list.", - "operationId": "memberSpaceLimitsExcludedUsersRemove", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/excluded_users/remove": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/remove response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - } - } - } - } - }, - "examples": { - "member_space_limits/excluded_users/remove response": { - "value": { - "status": { - ".tag": "success" - } - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/get_custom_quota": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/get_custom_quota", - "description": "[member_space_limits/get_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-get_custom_quota)\n\nscope: `members.read`\n\nGet users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.", - "operationId": "memberSpaceLimitsGetCustomQuota", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/get_custom_quota": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/get_custom_quota response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "example": [ - { - ".tag": "other" - } - ] - }, - "examples": { - "member_space_limits/get_custom_quota response": { - "value": [ - { - ".tag": "other" - } - ] - } - } - } - } - } - } - } - }, - "/team/member_space_limits/remove_custom_quota": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/remove_custom_quota", - "description": "[member_space_limits/remove_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-remove_custom_quota)\n\nscope: `members.write`\n\nRemove users custom quota. A maximum of 1000 members can be specified in a single call.", - "operationId": "memberSpaceLimitsRemoveCustomQuota", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/remove_custom_quota": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/remove_custom_quota response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "example": [ - { - ".tag": "other" - } - ] - }, - "examples": { - "member_space_limits/remove_custom_quota response": { - "value": [ - { - ".tag": "other" - } - ] - } - } - } - } - } - } - } - }, - "/team/member_space_limits/set_custom_quota": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/set_custom_quota", - "description": "[member_space_limits/set_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-set_custom_quota)\n\nscope: `members.read`\n\nSet users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.", - "operationId": "memberSpaceLimitsSetCustomQuota", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users_and_quotas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quota_gb": { - "type": "number", - "example": 30 - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "quota_gb": 30, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "member_space_limits/set_custom_quota": { - "value": { - "users_and_quotas": [ - { - "quota_gb": 30, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/set_custom_quota response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "example": [ - { - ".tag": "other" - } - ] - }, - "examples": { - "member_space_limits/set_custom_quota response": { - "value": [ - { - ".tag": "other" - } - ] - } - } - } - } - } - } - } - }, - "/team/members/add": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/add", - "description": "[members/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-add)\n\nscope: `members.write`\n\nAdds members to a team.\nPermission : Team member management\nA maximum of 20 members can be specified in a single call.\nIf no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.\nIf a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.\nTeam member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.", - "operationId": "membersAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "force_async": { - "type": "boolean", - "example": false - }, - "new_members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "member_email": { - "type": "string", - "example": "tom.s@company.com" - }, - "member_external_id": { - "type": "string", - "example": "company_id:342432" - }, - "member_given_name": { - "type": "string", - "example": "Tom" - }, - "member_surname": { - "type": "string", - "example": "Silverstone" - }, - "role": { - "type": "string", - "example": "member_only" - }, - "send_welcome_email": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "member_email": "tom.s@company.com", - "member_external_id": "company_id:342432", - "member_given_name": "Tom", - "member_surname": "Silverstone", - "role": "member_only", - "send_welcome_email": true - } - ] - } - } - }, - "examples": { - "members/add": { - "value": { - "force_async": false, - "new_members": [ - { - "member_email": "tom.s@company.com", - "member_external_id": "company_id:342432", - "member_given_name": "Tom", - "member_surname": "Silverstone", - "role": "member_only", - "send_welcome_email": true - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "complete": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/add response": { - "value": { - ".tag": "complete", - "complete": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/add/job_status/get": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/add/job_status/get", - "description": "[members/add/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-add-job_status-get)\n\nscope: `members.write`\n\nOnce an async_job_id is returned from `members/add` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", - "operationId": "membersAddJobStatusGet", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "members/add/job_status/get": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/add/job_status/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "complete": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/add/job_status/get response": { - "value": { - ".tag": "complete", - "complete": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/delete_profile_photo": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/delete_profile_photo", - "description": "[members/delete_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-delete_profile_photo)\n\nscope: `members.write`\n\nDeletes a team member's profile photo.\nPermission : Team member management.", - "operationId": "membersDeleteProfilePhoto", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/delete_profile_photo": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/delete_profile_photo response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "examples": { - "members/delete_profile_photo response": { - "value": { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - } - } - } - } - } - } - } - }, - "/team/members/get_info": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/get_info", - "description": "[members/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-members-get_info)\n\nscope: `members.read`\n\nReturns information about multiple team members.\nPermission : Team information\nThis endpoint will return `MembersGetInfoItem.id_not_found`, for IDs (or emails) that cannot be matched to a valid team member.", - "operationId": "membersGetInfo", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "members/get_info": { - "value": { - "members": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/get_info response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_info" - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - ".tag": "member_info", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - }, - "examples": { - "members/get_info response": { - "value": [ - { - ".tag": "member_info", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - }, - "/team/members/list": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/list", - "description": "[members/list](https://www.dropbox.com/developers/documentation/http/teams#team-members-list)\n\nscope: `members.read`\n\nLists members of a team.\nPermission : Team information.", - "operationId": "membersList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_removed": { - "type": "boolean", - "example": false - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "members/list": { - "value": { - "include_removed": false, - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": true - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true, - "members": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/list/continue": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/list/continue", - "description": "[members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-members-list-continue)\n\nscope: `members.read`\n\nOnce a cursor has been retrieved from `members/list`, use this to paginate through all team members.\nPermission : Team information.", - "operationId": "membersListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "members/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": true - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true, - "members": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/move_former_member_files": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/move_former_member_files", - "description": "[members/move_former_member_files](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files)\n\nscope: `members.write`\n\nMoves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/move_former_member_files/job_status/check`.\nPermission : Team member management.", - "operationId": "membersMoveFormerMemberFiles", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "transfer_admin_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "transfer_dest_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/move_former_member_files": { - "value": { - "transfer_admin_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "transfer_dest_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/move_former_member_files response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/move_former_member_files response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/move_former_member_files/job_status/check": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/move_former_member_files/job_status/check", - "description": "[members/move_former_member_files/job_status/check](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files-job_status-check)\n\nscope: `members.write`\n\nOnce an async_job_id is returned from `members/move_former_member_files` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", - "operationId": "membersMoveFormerMemberFilesJobStatusCheck", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "members/move_former_member_files/job_status/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/move_former_member_files/job_status/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/move_former_member_files/job_status/check response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/recover": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/recover", - "description": "[members/recover](https://www.dropbox.com/developers/documentation/http/teams#team-members-recover)\n\nscope: `members.delete`\n\nRecover a deleted member.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", - "operationId": "membersRecover", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/recover": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/members/remove": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/remove", - "description": "[members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove)\n\nscope: `members.delete`\n\nRemoves a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.\nAccounts can be recovered via `members/recover` for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling `members/add` while a user is still recoverable on your team will return with `MemberAddResult.user_already_on_team`.\nAccounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams).\nThis endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/remove/job_status/get`.", - "operationId": "membersRemove", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "keep_account": { - "type": "boolean", - "example": false - }, - "retain_team_shares": { - "type": "boolean", - "example": false - }, - "transfer_admin_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "transfer_dest_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "wipe_data": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "members/remove": { - "value": { - "keep_account": false, - "retain_team_shares": false, - "transfer_admin_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "transfer_dest_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "wipe_data": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/remove response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/remove response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/remove/job_status/get": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/remove/job_status/get", - "description": "[members/remove/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove-job_status-get)\n\nscope: `members.delete`\n\nOnce an async_job_id is returned from `members/remove` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", - "operationId": "membersRemoveJobStatusGet", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "members/remove/job_status/get": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/remove/job_status/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/remove/job_status/get response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/secondary_emails/add": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/secondary_emails/add", - "description": "[members/secondary_emails/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-add)\n\nscope: `members.write`\n\nAdd secondary emails to users.\nPermission : Team member management.\nEmails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.", - "operationId": "membersSecondaryEmailsAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "new_secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "secondary_emails": { - "type": "array", - "items": { - "type": "string", - "example": "bob2@hotmail.com" - }, - "example": [ - "bob2@hotmail.com", - "bob@inst.gov" - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/add": { - "value": { - "new_secondary_emails": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/secondary_emails/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "invalid_user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "unavailable": { - "type": "string", - "example": "alice@example.com" - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - "email": "apple@orange.com", - "is_verified": true - } - }, - { - ".tag": "unavailable", - "unavailable": "alice@example.com" - } - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": { - "email": "apple@orange.com", - "is_verified": true - } - }, - { - ".tag": "unavailable", - "unavailable": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - }, - { - ".tag": "invalid_user", - "invalid_user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/add response": { - "value": { - "results": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": { - "email": "apple@orange.com", - "is_verified": true - } - }, - { - ".tag": "unavailable", - "unavailable": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - }, - { - ".tag": "invalid_user", - "invalid_user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/secondary_emails/delete": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/secondary_emails/delete", - "description": "[members/secondary_emails/delete](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-delete)\n\nscope: `members.write`\n\nDelete secondary emails from users\nPermission : Team member management.\nUsers will be notified of deletions of verified secondary emails at both the secondary email and their primary email.", - "operationId": "membersSecondaryEmailsDelete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "emails_to_delete": { - "type": "array", - "items": { - "type": "object", - "properties": { - "secondary_emails": { - "type": "array", - "items": { - "type": "string", - "example": "bob2@hotmail.com" - }, - "example": [ - "bob2@hotmail.com", - "bob@inst.gov" - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/delete": { - "value": { - "emails_to_delete": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/secondary_emails/delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "not_found": { - "type": "string", - "example": "alic@example.com" - }, - "success": { - "type": "string", - "example": "alice@example.com" - } - } - }, - "example": [ - { - ".tag": "success", - "success": "alice@example.com" - }, - { - ".tag": "not_found", - "not_found": "alic@example.com" - } - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - }, - { - ".tag": "not_found", - "not_found": "alic@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/delete response": { - "value": { - "results": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - }, - { - ".tag": "not_found", - "not_found": "alic@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/secondary_emails/resend_verification_emails": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/secondary_emails/resend_verification_emails", - "description": "[members/secondary_emails/resend_verification_emails](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-resend_verification_emails)\n\nscope: `members.write`\n\nResend secondary email verification emails.\nPermission : Team member management.", - "operationId": "membersSecondaryEmailsResendVerificationEmails", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "emails_to_resend": { - "type": "array", - "items": { - "type": "object", - "properties": { - "secondary_emails": { - "type": "array", - "items": { - "type": "string", - "example": "bob2@hotmail.com" - }, - "example": [ - "bob2@hotmail.com", - "bob@inst.gov" - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/resend_verification_emails": { - "value": { - "emails_to_resend": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/secondary_emails/resend_verification_emails response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "string", - "example": "alice@example.com" - } - } - }, - "example": [ - { - ".tag": "success", - "success": "alice@example.com" - } - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/resend_verification_emails response": { - "value": { - "results": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/send_welcome_email": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/send_welcome_email", - "description": "[members/send_welcome_email](https://www.dropbox.com/developers/documentation/http/teams#team-members-send_welcome_email)\n\nscope: `members.write`\n\nSends welcome email to pending team member.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.\nNo-op if team member is not pending.", - "operationId": "membersSendWelcomeEmail", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "examples": { - "members/send_welcome_email": { - "value": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/members/set_admin_permissions": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/set_admin_permissions", - "description": "[members/set_admin_permissions](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_admin_permissions)\n\nscope: `members.write`\n\nUpdates a team member's permissions.\nPermission : Team member management.", - "operationId": "membersSetAdminPermissions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "new_role": { - "type": "string", - "example": "member_only" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/set_admin_permissions": { - "value": { - "new_role": "member_only", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/set_admin_permissions response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:9978889" - } - } - }, - "examples": { - "members/set_admin_permissions response": { - "value": { - "role": { - ".tag": "member_only" - }, - "team_member_id": "dbmid:9978889" - } - } - } - } - } - } - } - } - }, - "/team/members/set_profile": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/set_profile", - "description": "[members/set_profile](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile)\n\nscope: `members.write`\n\nUpdates a team member's profile.\nPermission : Team member management.", - "operationId": "membersSetProfile", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "new_email": { - "type": "string", - "example": "t.smith@domain.com" - }, - "new_surname": { - "type": "string", - "example": "Smith" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/set_profile": { - "value": { - "new_email": "t.smith@domain.com", - "new_surname": "Smith", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/set_profile response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "examples": { - "members/set_profile response": { - "value": { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - } - } - } - } - } - } - } - }, - "/team/members/set_profile_photo": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/set_profile_photo", - "description": "[members/set_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile_photo)\n\nscope: `members.write`\n\nUpdates a team member's profile photo.\nPermission : Team member management.", - "operationId": "membersSetProfilePhoto", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "photo": { - "$ref": "#/components/schemas/Photo" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/set_profile_photo": { - "value": { - "photo": { - ".tag": "base64_data", - "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - }, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/set_profile_photo response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "examples": { - "members/set_profile_photo response": { - "value": { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - } - } - } - } - } - } - } - }, - "/team/members/suspend": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/suspend", - "description": "[members/suspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-suspend)\n\nscope: `members.write`\n\nSuspend a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", - "operationId": "membersSuspend", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "wipe_data": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "members/suspend": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "wipe_data": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/members/unsuspend": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/unsuspend", - "description": "[members/unsuspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-unsuspend)\n\nscope: `members.write`\n\nUnsuspend a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", - "operationId": "membersUnsuspend", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/unsuspend": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/namespaces/list": { - "post": { - "tags": [ - "team", - "namespaces" - ], - "summary": "namespaces/list", - "description": "[namespaces/list](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list)\n\nscope: `team_data.member`\n\nReturns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.", - "operationId": "namespacesList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 1 - } - } - }, - "examples": { - "namespaces/list": { - "value": { - "limit": 1 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "namespaces/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "namespaces": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Marketing" - }, - "namespace_id": { - "type": "string", - "example": "123456789" - }, - "namespace_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_folder" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - }, - "example": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - }, - "examples": { - "namespaces/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "namespaces": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/namespaces/list/continue": { - "post": { - "tags": [ - "team", - "namespaces" - ], - "summary": "namespaces/list/continue", - "description": "[namespaces/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list-continue)\n\nscope: `team_data.member`\n\nOnce a cursor has been retrieved from `namespaces/list`, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.", - "operationId": "namespacesListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "namespaces/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "namespaces/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "namespaces": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Marketing" - }, - "namespace_id": { - "type": "string", - "example": "123456789" - }, - "namespace_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_folder" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - }, - "example": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - }, - "examples": { - "namespaces/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "namespaces": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/reports/get_activity": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_activity", - "description": "[reports/get_activity](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_activity)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's user activity.", - "operationId": "reportsGetActivity", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_activity": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/reports/get_devices": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_devices", - "description": "[reports/get_devices](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_devices)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's linked devices.", - "operationId": "reportsGetDevices", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_devices": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/reports/get_membership": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_membership", - "description": "[reports/get_membership](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_membership)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's membership.", - "operationId": "reportsGetMembership", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_membership": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/reports/get_storage": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_storage", - "description": "[reports/get_storage](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_storage)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's storage usage.", - "operationId": "reportsGetStorage", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_storage": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/team_folder/activate": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/activate", - "description": "[team_folder/activate](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-activate)\n\nscope: `team_data.team_space`\n\nSets an archived team folder's status to active.\nPermission : Team member file access.", - "operationId": "teamFolderActivate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/activate": { - "value": { - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/activate response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/activate response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/archive": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/archive", - "description": "[team_folder/archive](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive)\n\nscope: `team_data.team_space`\n\nSets an active team folder's status to archived and removes all folder and file members.\nPermission : Team member file access.", - "operationId": "teamFolderArchive", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "force_async_off": { - "type": "boolean", - "example": false - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/archive": { - "value": { - "force_async_off": false, - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/archive response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/archive response": { - "value": { - ".tag": "complete", - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/archive/check": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/archive/check", - "description": "[team_folder/archive/check](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive-check)\n\nscope: `team_data.team_space`\n\nReturns the status of an asynchronous job for archiving a team folder.\nPermission : Team member file access.", - "operationId": "teamFolderArchiveCheck", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "team_folder/archive/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/archive/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/archive/check response": { - "value": { - ".tag": "complete", - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/create": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/create", - "description": "[team_folder/create](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-create)\n\nscope: `team_data.team_space`\n\nCreates a new, active, team folder with no members.\nPermission : Team member file access.", - "operationId": "teamFolderCreate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Marketing" - }, - "sync_setting": { - "type": "string", - "example": "not_synced" - } - } - }, - "examples": { - "team_folder/create": { - "value": { - "name": "Marketing", - "sync_setting": "not_synced" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/create response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/create response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/get_info": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/get_info", - "description": "[team_folder/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-get_info)\n\nscope: `team_data.team_space`\n\nRetrieves metadata for team folders.\nPermission : Team member file access.", - "operationId": "teamFolderGetInfo", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_folder_ids": { - "type": "array", - "items": { - "type": "string", - "example": "947182" - }, - "example": [ - "947182", - "5819424", - "852307532" - ] - } - } - }, - "examples": { - "team_folder/get_info": { - "value": { - "team_folder_ids": [ - "947182", - "5819424", - "852307532" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/team_folder/list": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/list", - "description": "[team_folder/list](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list)\n\nscope: `team_data.team_space`\n\nLists all team folders.\nPermission : Team member file access.", - "operationId": "teamFolderList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "team_folder/list": { - "value": { - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "team_folders": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "example": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - }, - "examples": { - "team_folder/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "team_folders": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/team_folder/list/continue": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/list/continue", - "description": "[team_folder/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list-continue)\n\nscope: `team_data.team_space`\n\nOnce a cursor has been retrieved from `team_folder/list`, use this to paginate through all team folders.\nPermission : Team member file access.", - "operationId": "teamFolderListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "team_folder/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "team_folders": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "example": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - }, - "examples": { - "team_folder/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "team_folders": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/team_folder/permanently_delete": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/permanently_delete", - "description": "[team_folder/permanently_delete](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-permanently_delete)\n\nscope: `team_data.team_space`\n\nPermanently deletes an archived team folder.\nPermission : Team member file access.", - "operationId": "teamFolderPermanentlyDelete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/permanently_delete": { - "value": { - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/team_folder/rename": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/rename", - "description": "[team_folder/rename](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-rename)\n\nscope: `team_data.team_space`\n\nChanges an active team folder's name.\nPermission : Team member file access.", - "operationId": "teamFolderRename", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Sales" - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/rename": { - "value": { - "name": "Sales", - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/rename response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/rename response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/update_sync_settings": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/update_sync_settings", - "description": "[team_folder/update_sync_settings](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-update_sync_settings)\n\nscope: `team_data.team_space`\n\nUpdates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.", - "operationId": "teamFolderUpdateSyncSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "string", - "example": "not_synced" - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": "not_synced" - } - ] - }, - "sync_setting": { - "type": "string", - "example": "not_synced" - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/update_sync_settings": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": "not_synced" - } - ], - "sync_setting": "not_synced", - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/update_sync_settings response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/update_sync_settings response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/features/get_values": { - "post": { - "tags": [ - "team" - ], - "summary": "features/get_values", - "description": "[features/get_values](https://www.dropbox.com/developers/documentation/http/teams#team-features-get_values)\n\nscope: `team_info.read`\n\nGet the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features.\nPermission : Team information.", - "operationId": "featuresGetValues", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "upload_api_rate_limit" - } - } - }, - "example": [ - { - ".tag": "upload_api_rate_limit" - }, - { - ".tag": "has_team_shared_dropbox" - } - ] - } - } - }, - "examples": { - "features/get_values": { - "value": { - "features": [ - { - ".tag": "upload_api_rate_limit" - }, - { - ".tag": "has_team_shared_dropbox" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "features/get_values response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "upload_api_rate_limit" - }, - "has_team_shared_dropbox": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "has_team_shared_dropbox" - }, - "has_team_shared_dropbox": { - "type": "boolean", - "example": false - } - } - }, - "upload_api_rate_limit": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "limit" - }, - "limit": { - "type": "number", - "example": 25000 - } - } - } - } - }, - "example": [ - { - ".tag": "upload_api_rate_limit", - "upload_api_rate_limit": { - ".tag": "limit", - "limit": 25000 - } - }, - { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": false - } - } - ] - } - } - }, - "examples": { - "features/get_values response": { - "value": { - "values": [ - { - ".tag": "upload_api_rate_limit", - "upload_api_rate_limit": { - ".tag": "limit", - "limit": 25000 - } - }, - { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": false - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/get_info": { - "post": { - "tags": [ - "team" - ], - "summary": "get_info", - "description": "[get_info](https://www.dropbox.com/developers/documentation/http/teams#team-get_info)\n\nscope: `team_info.read`\n\nRetrieves information about a team.", - "operationId": "getInfo", - "responses": { - "200": { - "description": "get_info response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Dropbox Inc." - }, - "num_licensed_users": { - "type": "number", - "example": 5 - }, - "num_provisioned_users": { - "type": "number", - "example": 2 - }, - "policies": { - "type": "object", - "properties": { - "emm_state": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "disabled" - } - } - }, - "office_addin": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "disabled" - } - } - }, - "sharing": { - "type": "object", - "properties": { - "shared_folder_join_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "from_anyone" - } - } - }, - "shared_folder_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_create_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_only" - } - } - } - } - } - } - }, - "team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - }, - "examples": { - "get_info response": { - "value": { - "name": "Dropbox Inc.", - "num_licensed_users": 5, - "num_provisioned_users": 2, - "policies": { - "emm_state": { - ".tag": "disabled" - }, - "office_addin": { - ".tag": "disabled" - }, - "sharing": { - "shared_folder_join_policy": { - ".tag": "from_anyone" - }, - "shared_folder_member_policy": { - ".tag": "team" - }, - "shared_link_create_policy": { - ".tag": "team_only" - } - } - }, - "team_id": "dbtid:1234abcd" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/team/token/get_authenticated_admin": { - "post": { - "tags": [ - "team" - ], - "summary": "token/get_authenticated_admin", - "description": "[token/get_authenticated_admin](https://www.dropbox.com/developers/documentation/http/teams#team-token-get_authenticated_admin)\n\nscope: `team_info.read`\n\nReturns the member profile of the admin who generated the team access token used to make the call.", - "operationId": "tokenGetAuthenticatedAdmin", - "responses": { - "200": { - "description": "token/get_authenticated_admin response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "admin_profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - } - } - }, - "examples": { - "token/get_authenticated_admin response": { - "value": { - "admin_profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - } - } - } - } - } - } - } - } - } - }, - "/team_log/get_events": { - "post": { - "tags": [ - "team_log" - ], - "summary": "get_events", - "description": "[get_events](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events)\n\nscope: `events.read`\n\nRetrieves team events. If the result's `GetTeamEventsResult.has_more` field is `true`, call `get_events/continue` with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll `get_events/continue` for new events.\nMany attributes note 'may be missing due to historical data gap'.\nNote that the file_operations category and & analogous paper events are not available on all Dropbox Business [plans](http://www.dropbox.com/business/plans-comparison). Use [features/get_values](http://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) to check for this feature.\nPermission : Team Auditing.", - "operationId": "getEvents", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "category": { - "type": "string", - "example": "groups" - }, - "limit": { - "type": "number", - "example": 50 - } - } - }, - "examples": { - "get_events": { - "value": { - "category": "groups", - "limit": 50 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_events response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "events": { - "type": "array", - "items": { - "type": "object", - "properties": { - "actor": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "assets": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "display_name": { - "type": "string", - "example": "reports.xls" - }, - "file_id": { - "type": "string", - "example": "id:jQKLsZFQImAAAAAAEZAAQt" - }, - "file_size": { - "type": "number", - "example": 4 - }, - "path": { - "type": "object", - "properties": { - "contextual": { - "type": "string", - "example": "/Contract Work/Draft" - }, - "namespace_relative": { - "type": "object", - "properties": { - "is_shared_namespace": { - "type": "boolean", - "example": false - }, - "ns_id": { - "type": "string", - "example": "1234" - }, - "relative_path": { - "type": "string", - "example": "/Contract Work/Draft" - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ] - }, - "context": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - }, - "details": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download_details" - }, - "shared_content_access_level": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer_no_comment" - } - } - }, - "shared_content_link": { - "type": "string", - "example": "abc" - }, - "shared_content_owner": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "event_category": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "tfa" - } - } - }, - "event_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download" - }, - "description": { - "type": "string", - "example": "(sharing) Downloaded shared file/folder" - } - } - }, - "involve_non_team_member": { - "type": "boolean", - "example": true - }, - "origin": { - "type": "object", - "properties": { - "access_method": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "end_user" - }, - "end_user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web" - }, - "session_id": { - "type": "string", - "example": "dbwsid:123456789012345678901234567890123456789" - } - } - } - } - }, - "geo_location": { - "type": "object", - "properties": { - "city": { - "type": "string", - "example": "San Francisco" - }, - "country": { - "type": "string", - "example": "US" - }, - "ip_address": { - "type": "string", - "example": "45.56.78.100" - }, - "region": { - "type": "string", - "example": "California" - } - } - } - } - }, - "participants": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw" - }, - "display_name": { - "type": "string", - "example": "Jane Smith" - }, - "email": { - "type": "string", - "example": "jane_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "example": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ] - }, - "timestamp": { - "type": "string", - "example": "2017-01-25T15:51:30Z" - } - } - }, - "example": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "get_events response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "events": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ], - "has_more": false - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/team_log/get_events/continue": { - "post": { - "tags": [ - "team_log" - ], - "summary": "get_events/continue", - "description": "[get_events/continue](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events-continue)\n\nscope: `events.read`\n\nOnce a cursor has been retrieved from `get_events`, use this to paginate through all events.\nPermission : Team Auditing.", - "operationId": "getEventsContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "get_events/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_events/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "events": { - "type": "array", - "items": { - "type": "object", - "properties": { - "actor": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "assets": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "display_name": { - "type": "string", - "example": "reports.xls" - }, - "file_id": { - "type": "string", - "example": "id:jQKLsZFQImAAAAAAEZAAQt" - }, - "file_size": { - "type": "number", - "example": 4 - }, - "path": { - "type": "object", - "properties": { - "contextual": { - "type": "string", - "example": "/Contract Work/Draft" - }, - "namespace_relative": { - "type": "object", - "properties": { - "is_shared_namespace": { - "type": "boolean", - "example": false - }, - "ns_id": { - "type": "string", - "example": "1234" - }, - "relative_path": { - "type": "string", - "example": "/Contract Work/Draft" - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ] - }, - "context": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - }, - "details": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download_details" - }, - "shared_content_access_level": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer_no_comment" - } - } - }, - "shared_content_link": { - "type": "string", - "example": "abc" - }, - "shared_content_owner": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "event_category": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "tfa" - } - } - }, - "event_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download" - }, - "description": { - "type": "string", - "example": "(sharing) Downloaded shared file/folder" - } - } - }, - "involve_non_team_member": { - "type": "boolean", - "example": true - }, - "origin": { - "type": "object", - "properties": { - "access_method": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "end_user" - }, - "end_user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web" - }, - "session_id": { - "type": "string", - "example": "dbwsid:123456789012345678901234567890123456789" - } - } - } - } - }, - "geo_location": { - "type": "object", - "properties": { - "city": { - "type": "string", - "example": "San Francisco" - }, - "country": { - "type": "string", - "example": "US" - }, - "ip_address": { - "type": "string", - "example": "45.56.78.100" - }, - "region": { - "type": "string", - "example": "California" - } - } - } - } - }, - "participants": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw" - }, - "display_name": { - "type": "string", - "example": "Jane Smith" - }, - "email": { - "type": "string", - "example": "jane_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "example": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ] - }, - "timestamp": { - "type": "string", - "example": "2017-01-25T15:51:30Z" - } - } - }, - "example": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "get_events/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "events": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ], - "has_more": false - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/users/features/get_values": { - "post": { - "tags": [ - "users" - ], - "summary": "features/get_values", - "description": "[features/get_values](https://www.dropbox.com/developers/documentation/http/documentation#users-features-get_values)\n\nscope: `account_info.read`\n\nGet a list of feature values that may be configured for the current account.", - "operationId": "featuresGetValues1", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "paper_as_files" - } - } - }, - "example": [ - { - ".tag": "paper_as_files" - }, - { - ".tag": "file_locking" - } - ] - } - } - }, - "examples": { - "features/get_values": { - "value": { - "features": [ - { - ".tag": "paper_as_files" - }, - { - ".tag": "file_locking" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "features/get_values response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "paper_as_files" - }, - "paper_as_files": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "enabled" - }, - "enabled": { - "type": "boolean", - "example": true - } - } - } - } - }, - "example": [ - { - ".tag": "paper_as_files", - "paper_as_files": { - ".tag": "enabled", - "enabled": true - } - } - ] - } - } - }, - "examples": { - "features/get_values response": { - "value": { - "values": [ - { - ".tag": "paper_as_files", - "paper_as_files": { - ".tag": "enabled", - "enabled": true - } - } - ] - } - } - } - } - } - } - } - } - }, - "/users/get_account": { - "post": { - "tags": [ - "users" - ], - "summary": "get_account", - "description": "[get_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account)\n\nscope: `sharing.read`\n\nGet information about a user's account.", - "operationId": "getAccount", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - } - } - }, - "examples": { - "get_account": { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_account response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "disabled": { - "type": "boolean", - "example": false - }, - "email": { - "type": "string", - "example": "franz@dropbox.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "is_teammate": { - "type": "boolean", - "example": false - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - }, - "examples": { - "get_account response": { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_teammate": false, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - } - } - } - } - } - } - }, - "/users/get_account_batch": { - "post": { - "tags": [ - "users" - ], - "summary": "get_account_batch", - "description": "[get_account_batch](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account_batch)\n\nscope: `sharing.read`\n\nGet information about multiple user accounts. At most 300 accounts may be queried per request.", - "operationId": "getAccountBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "example": [ - "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ" - ] - } - } - }, - "examples": { - "get_account_batch": { - "value": { - "account_ids": [ - "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_account_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "disabled": { - "type": "boolean", - "example": false - }, - "email": { - "type": "string", - "example": "franz@dropbox.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "is_teammate": { - "type": "boolean", - "example": false - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - }, - "example": [ - { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_teammate": false, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - ] - }, - "examples": { - "get_account_batch response": { - "value": [ - { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_teammate": false, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - ] - } - } - } - } - } - } - } - }, - "/users/get_current_account": { - "post": { - "tags": [ - "users" - ], - "summary": "get_current_account", - "description": "[get_current_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account)\n\nscope: `account_info.read`\n\nGet information about the current user's account.", - "operationId": "getCurrentAccount", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "get_current_account response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "account_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "business" - } - } - }, - "country": { - "type": "string", - "example": "US" - }, - "disabled": { - "type": "boolean", - "example": false - }, - "email": { - "type": "string", - "example": "franz@dropbox.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "is_paired": { - "type": "boolean", - "example": true - }, - "locale": { - "type": "string", - "example": "en" - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "referral_link": { - "type": "string", - "example": "https://db.tt/ZITNuhtI" - }, - "root_info": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "home_namespace_id": { - "type": "string", - "example": "3235641" - }, - "root_namespace_id": { - "type": "string", - "example": "3235641" - } - } - }, - "team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - }, - "office_addin_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "disabled" - } - } - }, - "sharing_policies": { - "type": "object", - "properties": { - "shared_folder_join_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "from_anyone" - } - } - }, - "shared_folder_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_create_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_only" - } - } - } - } - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - }, - "examples": { - "get_current_account response": { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "account_type": { - ".tag": "business" - }, - "country": "US", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_paired": true, - "locale": "en", - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "referral_link": "https://db.tt/ZITNuhtI", - "root_info": { - ".tag": "user", - "home_namespace_id": "3235641", - "root_namespace_id": "3235641" - }, - "team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc.", - "office_addin_policy": { - ".tag": "disabled" - }, - "sharing_policies": { - "shared_folder_join_policy": { - ".tag": "from_anyone" - }, - "shared_folder_member_policy": { - ".tag": "team" - }, - "shared_link_create_policy": { - ".tag": "team_only" - } - } - }, - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - } - } - } - } - } - } - }, - "/users/get_space_usage": { - "post": { - "tags": [ - "users" - ], - "summary": "get_space_usage", - "description": "[get_space_usage](https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage)\n\nscope: `account_info.read`\n\nGet the space usage information for the current user's account.", - "operationId": "getSpaceUsage", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "get_space_usage response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allocation": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "individual" - }, - "allocated": { - "type": "number", - "example": 10000000000 - } - } - }, - "used": { - "type": "number", - "example": 314159265 - } - } - }, - "examples": { - "get_space_usage response": { - "value": { - "allocation": { - ".tag": "individual", - "allocated": 10000000000 - }, - "used": 314159265 - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "Photo": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "base64_data" - }, - "base64_data": { - "type": "string", - "example": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - } - } - } - }, - "parameters": { - "DropboxApiPathRoot": { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } - }, - "DropboxApiSelectUser": { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - }, - "DropboxApiSelectAdmin": { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "securitySchemes": { - "bearerAuth": { - "type": "http", - "scheme": "bearer" - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "tags": [ - { - "name": "account" - }, - { - "name": "auth" - }, - { - "name": "check" - }, - { - "name": "contacts" - }, - { - "name": "file_properties", - "description": "This namespace contains helpers for property and template metadata endpoints.\n\nThese endpoints enable you to tag arbitrary key/value data to Dropbox files.\n\nThe most basic unit in this namespace is the :type:`PropertyField`. These fields encapsulate the actual key/value data.\n\nFields are added to a Dropbox file using a :type:`PropertyGroup`. Property groups contain a reference to a Dropbox file and a :type:`PropertyGroupTemplate`. Property groups are uniquely identified by the combination of their associated Dropbox file and template.\n\nThe :type:`PropertyGroupTemplate` is a way of restricting the possible key names and value types of the data within a property group. The possible key names and value types are explicitly enumerated using :type:`PropertyFieldTemplate` objects.\n\nYou can think of a property group template as a class definition for a particular key/value metadata object, and the property groups themselves as the instantiations of these objects.\n\nTemplates are owned either by a user/app pair or team/app pair. Templates and their associated properties can't be accessed by any app other than the app that created them, and even then, only when the app is linked with the owner of the template (either a user or team).\n\nUser-owned templates are accessed via the user-auth file_properties/templates/*_for_user endpoints, while team-owned templates are accessed via the team-auth file_properties/templates/*_for_team endpoints. Properties associated with either type of template can be accessed via the user-auth properties/* endpoints.\n\nFinally, properties can be accessed from a number of endpoints that return metadata, including `files/get_metadata`, and `files/list_folder`. Properties can also be added during upload, using `files/upload`.\n" - }, - { - "name": "file_requests", - "description": "This namespace contains endpoints and data types for file request operations.\n" - }, - { - "name": "files", - "description": "This namespace contains endpoints and data types for basic file operations.\n" - }, - { - "name": "sharing", - "description": "This namespace contains endpoints and data types for creating and managing shared links and shared folders.\n" - }, - { - "name": "team" - }, - { - "name": "devices" - }, - { - "name": "groups" - }, - { - "name": "legal_holds" - }, - { - "name": "linked_apps" - }, - { - "name": "member_space_limits" - }, - { - "name": "members" - }, - { - "name": "namespaces" - }, - { - "name": "reports" - }, - { - "name": "team_folder" - }, - { - "name": "team_log" - }, - { - "name": "users", - "description": "This namespace contains endpoints and data types for user management.\n" - } - ] -} \ No newline at end of file diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml new file mode 100644 index 0000000..42dfab8 --- /dev/null +++ b/docs/spec/openapi.yaml @@ -0,0 +1,16368 @@ +openapi: 3.0.3 +info: + title: Dropbox API Reference + description: "The powerful, yet simple, Dropbox API allows you to manage and control\ + \ content and team settings programmatically and extend Dropbox capabilities in\ + \ new and powerful ways. This is a collection that includes requests to all endpoints\ + \ in the Dropbox API. \n\nThe Dropbox API is divided in two groups of endpoints:\ + \ User Endpoints and Business Endpoints. Operations that would most likely be\ + \ executed by a user, such as file operations, are in the User Endpoints folder.\ + \ Operations that would most likely be executed by a team administrator, such\ + \ as adding users to groups, live in the Business Endpoints folder. \n\nIf you\ + \ are new to Dropbox Business and Team Administration, please have a look at the\ + \ [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide).\ + \ \n\nIf you want more information on how to use our API please refer to our [Developer\ + \ Portal](https://www.dropbox.com/developers). \n\n# What's in the collection?\n\ + \nThe endpoints are organized in the following folders:\n* account\n* auth\n*\ + \ check\n* contacts\n* file_properties\n* file_requests\n* files\n* sharing\n\ + * team\n* team_log\n* users\n\n# Authorization\n\n## OAuth 2.0 for API Access\n\ + Dropbox uses OAuth 2.0, an open specification, to authorize access to data. To\ + \ get an OAuth token from Dropbox to enable Postman to access your Dropbox account\ + \ via the API you’ll need to create a new app on the DBX Platform.\n\n## Creating\ + \ an App on the DBX Platform\nNavigate to https://www.dropbox.com/developers/apps\ + \ and select “Create app” \n1. Choose an API \n2. Choose the type of access you\ + \ need \n3. Give your app a name \n4. Choose the Dropbox account that will own\ + \ your app \n\nFor reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide)\ + \ \n\n## Generating an Access Token\nOnce you select “Create app” a page will\ + \ load that displays information about your newly created app. To generate an\ + \ access token scroll down to “OAuth 2” and click “Generate” beneath “Generated\ + \ access token.” The token will display as a long string of characters. Copy this\ + \ token for use with the Postman Collection.\n\n## Adding an Access Token to the\ + \ requests\nIn the Postman client, click on the three dots to the right of the\ + \ collection name to \"View more actions.\"\n\n![Screenshot of adding access token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1)\n\ + \nThen, click \"Edit.\"\n\nClick on the \"Variables\" tab and, in the row for\ + \ the `access_token` variable, paste your access token in the `CURRENT VALUE`\ + \ column. The default value is `your-access-token-here`.\n\n![Screenshot of adding\ + \ access token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1)\n\ + \nFor information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/.\n\ + \n# Notes\n* Dropbox also has a Postman Collection in the API Network to help\ + \ administrators with team management workflows. It is called [Dropbox Team Admin\ + \ Workflows](). \n\n" + contact: {} + version: 1.0.0 +servers: +- url: https://api.dropboxapi.com/2 +- url: https://content.dropboxapi.com/2 +- url: https://notify.dropboxapi.com/2 +security: +- bearerAuth: [] +tags: +- name: account +- name: auth +- name: check +- name: contacts +- name: file_properties + description: | + This namespace contains helpers for property and template metadata endpoints. + + These endpoints enable you to tag arbitrary key/value data to Dropbox files. + + The most basic unit in this namespace is the :type:`PropertyField`. These fields encapsulate the actual key/value data. + + Fields are added to a Dropbox file using a :type:`PropertyGroup`. Property groups contain a reference to a Dropbox file and a :type:`PropertyGroupTemplate`. Property groups are uniquely identified by the combination of their associated Dropbox file and template. + + The :type:`PropertyGroupTemplate` is a way of restricting the possible key names and value types of the data within a property group. The possible key names and value types are explicitly enumerated using :type:`PropertyFieldTemplate` objects. + + You can think of a property group template as a class definition for a particular key/value metadata object, and the property groups themselves as the instantiations of these objects. + + Templates are owned either by a user/app pair or team/app pair. Templates and their associated properties can't be accessed by any app other than the app that created them, and even then, only when the app is linked with the owner of the template (either a user or team). + + User-owned templates are accessed via the user-auth file_properties/templates/*_for_user endpoints, while team-owned templates are accessed via the team-auth file_properties/templates/*_for_team endpoints. Properties associated with either type of template can be accessed via the user-auth properties/* endpoints. + + Finally, properties can be accessed from a number of endpoints that return metadata, including `files/get_metadata`, and `files/list_folder`. Properties can also be added during upload, using `files/upload`. +- name: file_requests + description: | + This namespace contains endpoints and data types for file request operations. +- name: files + description: | + This namespace contains endpoints and data types for basic file operations. +- name: sharing + description: | + This namespace contains endpoints and data types for creating and managing shared links and shared folders. +- name: team +- name: devices +- name: groups +- name: legal_holds +- name: linked_apps +- name: member_space_limits +- name: members +- name: namespaces +- name: reports +- name: team_folder +- name: team_log +- name: users + description: | + This namespace contains endpoints and data types for user management. +paths: + /account/set_profile_photo: + post: + tags: + - account + summary: set_profile_photo + description: |- + [set_profile_photo](https://www.dropbox.com/developers/documentation/http/documentation#account-set_profile_photo) + + scope: `account_info.write` + + Sets a user's profile photo. + operationId: setProfilePhoto + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetProfilePhotoRequest' + examples: + set_profile_photo: + value: + photo: + ".tag": base64_data + base64_data: SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + responses: + "200": + description: set_profile_photo response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/SetProfilePhotoResponse' + examples: + set_profile_photo response: + value: + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /auth/token/from_oauth1: + post: + tags: + - auth + summary: token/from_oauth1 + description: |- + [token/from_oauth1](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-from_oauth1) + + scope: `None` + + Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token. + operationId: tokenFromOauth1 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TokenFromOauth1Request' + examples: + token/from_oauth1: + value: + oauth1_token: qievr8hamyg6ndck + oauth1_token_secret: qomoftv0472git7 + responses: + "200": + description: token/from_oauth1 response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/TokenFromOauth1Response' + examples: + token/from_oauth1 response: + value: + oauth2_token: 9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn + /auth/token/revoke: + post: + tags: + - auth + summary: token/revoke + description: |- + [token/revoke](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke) + + scope: `None` + + Disables the access token used to authenticate the call. + operationId: tokenRevoke + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: "" + /check/app: + post: + tags: + - check + summary: app + description: |- + [app](https://www.dropbox.com/developers/documentation/http/documentation#check-app) + + scope: `None` + + This endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid. + operationId: app + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckAppRequest' + examples: + app: + value: + query: foo + responses: + "200": + description: app response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200' + examples: + app response: + value: + result: foo + /check/user: + post: + tags: + - check + summary: user + description: |- + [user](https://www.dropbox.com/developers/documentation/http/documentation#check-user) + + scope: `None` + + This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the access token is valid. + operationId: user + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckUserRequest' + examples: + user: + value: + query: foo + responses: + "200": + description: user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200' + examples: + user response: + value: + result: foo + /contacts/delete_manual_contacts: + post: + tags: + - contacts + summary: delete_manual_contacts + description: |- + [delete_manual_contacts](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts) + + scope: `contacts.write` + + Removes all manually added contacts. You'll still keep contacts who are on your team or who you imported. New contacts will be added when you share. + operationId: deleteManualContacts + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: "" + /contacts/delete_manual_contacts_batch: + post: + tags: + - contacts + summary: delete_manual_contacts_batch + description: |- + [delete_manual_contacts_batch](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts_batch) + + scope: `contacts.write` + + Removes manually added contacts from the given list. + operationId: deleteManualContactsBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteManualContactsBatchRequest' + examples: + delete_manual_contacts_batch: + value: + email_addresses: + - contactemailaddress1@domain.com + - contactemailaddress2@domain.com + responses: + "200": + description: "" + /file_properties/properties/add: + post: + tags: + - file_properties + summary: properties/add + description: |- + [properties/add](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add) + + scope: `files.metadata.write` + + Add property groups to a Dropbox file. See `templates/add_for_user` or `templates/add_for_team` to create new templates. + operationId: propertiesAdd + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddPropertiesRequest' + examples: + properties/add: + value: + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/properties/overwrite: + post: + tags: + - file_properties + summary: properties/overwrite + description: |- + [properties/overwrite](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite) + + scope: `files.metadata.write` + + Overwrite property groups associated with a file. This endpoint should be used instead of `properties/update` when property groups are being updated via a "snapshot" instead of via a "delta". In other words, this endpoint will delete all omitted fields from a property group, whereas `properties/update` will only delete fields that are explicitly marked for deletion. + operationId: propertiesOverwrite + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OverwritePropertiesRequest' + examples: + properties/overwrite: + value: + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/properties/remove: + post: + tags: + - file_properties + summary: properties/remove + description: |- + [properties/remove](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove) + + scope: `files.metadata.write` + + Permanently removes the specified property group from the file. To remove specific property field key value pairs, see `properties/update`. To update a template, see `templates/update_for_user` or `templates/update_for_team`. To remove a template, see `templates/remove_for_user` or `templates/remove_for_team`. + operationId: propertiesRemove + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemovePropertiesRequest' + examples: + properties/remove: + value: + path: /my_awesome/word.docx + property_template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/properties/search: + post: + tags: + - file_properties + summary: properties/search + description: |- + [properties/search](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search) + + scope: `files.metadata.read` + + Search across property templates for particular property field values. + operationId: propertiesSearch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchPropertiesRequest' + examples: + properties/search: + value: + queries: + - logical_operator: or_operator + mode: + ".tag": field_name + field_name: Security + query: Confidential + template_filter: filter_none + responses: + "200": + description: properties/search response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_1' + examples: + properties/search response: + value: + matches: + - id: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: false + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/properties/search/continue: + post: + tags: + - file_properties + summary: properties/search/continue + description: |- + [properties/search/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue) + + scope: `files.metadata.read` + + Once a cursor has been retrieved from `properties/search`, use this to paginate through all search results. + operationId: propertiesSearchContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchPropertiesContinueRequest' + examples: + properties/search/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: properties/search/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_1' + examples: + properties/search/continue response: + value: + matches: + - id: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: false + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/properties/update: + post: + tags: + - file_properties + summary: properties/update + description: |- + [properties/update](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update) + + scope: `files.metadata.write` + + Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of `properties/overwrite` when property groups are being updated via a "delta" instead of via a "snapshot" . In other words, this endpoint will not delete any omitted fields from a property group, whereas `properties/overwrite` will delete any fields that are omitted from a property group. + operationId: propertiesUpdate + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePropertiesRequest' + examples: + properties/update: + value: + path: /my_awesome/word.docx + update_property_groups: + - add_or_update_fields: + - name: Security Policy + value: Confidential + remove_fields: [] + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/templates/add_for_team: + post: + tags: + - file_properties + summary: templates/add_for_team + description: |- + [templates/add_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-add_for_team) + + scope: `files.team_metadata.write` + + Add a template associated with a team. See `properties/add` to add properties to a file or folder. + Note: this endpoint will create team-owned templates. + operationId: templatesAddForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddTemplateForTeam' + examples: + templates/add_for_team: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + name: Security + responses: + "200": + description: templates/add_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_2' + examples: + templates/add_for_team response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + /file_properties/templates/add_for_user: + post: + tags: + - file_properties + summary: templates/add_for_user + description: |- + [templates/add_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user) + + scope: `files.metadata.write` + + Add a template associated with a user. See `properties/add` to add properties to a file. This endpoint can't be called on a team member or admin's behalf. + operationId: templatesAddForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddTemplateForUser' + examples: + templates/add_for_user: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + name: Security + responses: + "200": + description: templates/add_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_2' + examples: + templates/add_for_user response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/templates/get_for_team: + post: + tags: + - file_properties + summary: templates/get_for_team + description: |- + [templates/get_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-get_for_team) + + scope: `files.team_metadata.write` + + Get the schema for a specified template. + operationId: templatesGetForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetTemplateForTeam' + examples: + templates/get_for_team: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/get_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_3' + examples: + templates/get_for_team response: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: + ".tag": string + name: Security + security: + - bearerAuth: [] + /file_properties/templates/get_for_user: + post: + tags: + - file_properties + summary: templates/get_for_user + description: |- + [templates/get_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user) + + scope: `files.metadata.read` + + Get the schema for a specified template. This endpoint can't be called on a team member or admin's behalf. + operationId: templatesGetForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetTemplateForUserRequest' + examples: + templates/get_for_user: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/get_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_3' + examples: + templates/get_for_user response: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: + ".tag": string + name: Security + /file_properties/templates/list_for_team: + post: + tags: + - file_properties + summary: templates/list_for_team + description: |- + [templates/list_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-list_for_team) + + scope: `files.team_metadata.write` + + Get the template identifiers for a team. To get the schema of each template use `templates/get_for_team`. + operationId: templatesListForTeam + responses: + "200": + description: templates/list_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_4' + examples: + templates/list_for_team response: + value: + template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + /file_properties/templates/list_for_user: + post: + tags: + - file_properties + summary: templates/list_for_user + description: |- + [templates/list_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user) + + scope: `files.metadata.read` + + Get the template identifiers for a team. To get the schema of each template use `templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf. + operationId: templatesListForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: templates/list_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_4' + examples: + templates/list_for_user response: + value: + template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/templates/remove_for_team: + post: + tags: + - file_properties + summary: templates/remove_for_team + description: |- + [templates/remove_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-remove_for_team) + + scope: `files.team_metadata.write` + + Permanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone. + operationId: templatesRemoveForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveTemplateForTeamRequest' + examples: + templates/remove_for_team: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + security: + - bearerAuth: [] + /file_properties/templates/remove_for_user: + post: + tags: + - file_properties + summary: templates/remove_for_user + description: |- + [templates/remove_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user) + + scope: `files.metadata.write` + + Permanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone. + operationId: templatesRemoveForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateId' + examples: + templates/remove_for_user: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/templates/update_for_team: + post: + tags: + - file_properties + summary: templates/update_for_team + description: |- + [templates/update_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-update_for_team) + + scope: `files.team_metadata.write` + + Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates. + operationId: templatesUpdateForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/templates_update_for_team_body' + examples: + templates/update_for_team: + value: + add_fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + description: These properties will describe how confidential this + file or folder is. + name: New Security Template Name + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/update_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateId' + examples: + templates/update_for_team response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + /file_properties/templates/update_for_user: + post: + tags: + - file_properties + summary: templates/update_for_user + description: |- + [templates/update_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user) + + scope: `files.metadata.write` + + Update a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf. + operationId: templatesUpdateForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/templates_update_for_user_body' + examples: + templates/update_for_user: + value: + add_fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + description: These properties will describe how confidential this + file or folder is. + name: New Security Template Name + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/update_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateId' + examples: + templates/update_for_user response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_requests/count: + post: + tags: + - file_requests + summary: count + description: |- + [count](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-count) + + scope: `file_requests.read` + + Returns the total number of file requests owned by this user. Includes both open and closed file requests. + operationId: count + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: count response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_5' + examples: + count response: + value: + file_request_count: 15 + /file_requests/create: + post: + tags: + - file_requests + summary: create + description: |- + [create](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create) + + scope: `file_requests.write` + + Creates a file request for this user. + operationId: create + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_create_body' + examples: + create: + value: + deadline: + allow_late_uploads: seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + open: true + title: Homework submission + responses: + "200": + description: create response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_6' + examples: + create response: + value: + created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + /file_requests/delete: + post: + tags: + - file_requests + summary: delete + description: |- + [delete](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete) + + scope: `file_requests.write` + + Delete a batch of closed file requests. + operationId: delete + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_delete_body' + examples: + delete: + value: + ids: + - oaCAVmEyrqYnkZX9955Y + - BaZmehYoXMPtaRmfTbSG + responses: + "200": + description: delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_7' + examples: + delete response: + value: + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + /file_requests/delete_all_closed: + post: + tags: + - file_requests + summary: delete_all_closed + description: |- + [delete_all_closed](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete_all_closed) + + scope: `file_requests.write` + + Delete all closed file requests owned by this user. + operationId: deleteAllClosed + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: delete_all_closed response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_7' + examples: + delete_all_closed response: + value: + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + /file_requests/get: + post: + tags: + - file_requests + summary: get + description: |- + [get](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get) + + scope: `file_requests.read` + + Returns the specified file request. + operationId: get + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_get_body' + examples: + get: + value: + id: oaCAVmEyrqYnkZX9955Y + responses: + "200": + description: get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_6' + examples: + get response: + value: + created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + /file_requests/list_v2: + post: + tags: + - file_requests + summary: list + description: |- + [list](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list) + + scope: `file_requests.read` + + Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder. + operationId: list + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_list_v2_body' + examples: + list: + value: + limit: 1000 + responses: + "200": + description: list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_8' + examples: + list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + has_more: true + /file_requests/list/continue: + post: + tags: + - file_requests + summary: list/continue + description: |- + [list/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list-continue) + + scope: `file_requests.read` + + Once a cursor has been retrieved from `list:2`, use this to paginate through all file requests. The cursor must come from a previous call to `list:2` or `list/continue`. + operationId: listContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body' + examples: + list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_8' + examples: + list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + has_more: true + /file_requests/update: + post: + tags: + - file_requests + summary: update + description: |- + [update](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-update) + + scope: `file_requests.write` + + Update a file request. + operationId: update + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_update_body' + examples: + update: + value: + deadline: + ".tag": update + allow_late_uploads: seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + id: oaCAVmEyrqYnkZX9955Y + open: true + title: Homework submission + responses: + "200": + description: update response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_6' + examples: + update response: + value: + created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + /files/copy_v2: + post: + tags: + - files + summary: copy + description: |- + [copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy) + + scope: `files.content.write` + + Copy a file or folder to a different location in the user's Dropbox. + If the source path is a folder all its contents will be copied. + operationId: copy + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_copy_v2_body' + examples: + copy: + value: + allow_ownership_transfer: false + allow_shared_folder: false + autorename: false + from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: copy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + copy response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_batch_v2: + post: + tags: + - files + summary: copy_batch + description: |- + [copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch) + + scope: `files.content.write` + + Copy multiple files or folders to different locations at once in the user's Dropbox. + This route will replace `copy_batch:1`. The main difference is this route will return status for each entry, while `copy_batch:1` raises failure if any entry fails. + This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use `copy_batch/check:2` to check the job status. + operationId: copyBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_copy_batch_v2_body' + examples: + copy_batch: + value: + autorename: false + entries: + - from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: copy_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + copy_batch response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_batch/check_v2: + post: + tags: + - files + summary: copy_batch/check + description: |- + [copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `copy_batch:2`. It returns list of results for each entry. + operationId: copyBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/copy_batch_check_v2_body' + examples: + copy_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: copy_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + copy_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_reference/get: + post: + tags: + - files + summary: copy_reference/get + description: |- + [copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get) + + scope: `files.content.write` + + Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to `copy_reference/save`. + operationId: copyReferenceGet + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/copy_reference_get_body' + examples: + copy_reference/get: + value: + path: /video.mp4 + responses: + "200": + description: copy_reference/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_11' + examples: + copy_reference/get response: + value: + copy_reference: z1X6ATl6aWtzOGq0c3g5Ng + expires: 2045-05-12T15:50:38Z + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_reference/save: + post: + tags: + - files + summary: copy_reference/save + description: |- + [copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save) + + scope: `files.content.write` + + Save a copy reference returned by `copy_reference/get` to the user's Dropbox. + operationId: copyReferenceSave + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/copy_reference_save_body' + examples: + copy_reference/save: + value: + copy_reference: z1X6ATl6aWtzOGq0c3g5Ng + path: /video.mp4 + responses: + "200": + description: copy_reference/save response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + copy_reference/save response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/create_folder_v2: + post: + tags: + - files + summary: create_folder + description: |- + [create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder) + + scope: `files.content.write` + + Create a folder at a given path. + operationId: createFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_create_folder_v2_body' + examples: + create_folder: + value: + autorename: false + path: /Homework/math + responses: + "200": + description: create_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_12' + examples: + create_folder response: + value: + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/create_folder_batch: + post: + tags: + - files + summary: create_folder_batch + description: |- + [create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch) + + scope: `files.content.write` + + Create multiple folders at once. + This route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the `CreateFolderBatchArg.force_async` flag. Use `create_folder_batch/check` to check the job status. + operationId: createFolderBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_create_folder_batch_body' + examples: + create_folder_batch: + value: + autorename: false + force_async: false + paths: + - /Homework/math + responses: + "200": + description: create_folder_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_13' + examples: + create_folder_batch response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/create_folder_batch/check: + post: + tags: + - files + summary: create_folder_batch/check + description: |- + [create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `create_folder_batch`. If success, it returns list of result for each entry. + operationId: createFolderBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/create_folder_batch_check_body' + examples: + create_folder_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: create_folder_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_13' + examples: + create_folder_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/delete_v2: + post: + tags: + - files + summary: delete + description: |- + [delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete) + + scope: `files.content.write` + + Delete the file or folder at a given path. + If the path is a folder, all its contents will be deleted too. + A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding `FileMetadata` or `FolderMetadata` for the item at time of deletion, and not a `DeletedMetadata` object. + operationId: delete1 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_delete_v2_body' + examples: + delete: + value: + path: /Homework/math/Prime_Numbers.txt + responses: + "200": + description: delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + delete response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/delete_batch: + post: + tags: + - files + summary: delete_batch + description: |- + [delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch) + + scope: `files.content.write` + + Delete multiple files/folders at once. + This route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use `delete_batch/check` to check the job status. + operationId: deleteBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_delete_batch_body' + examples: + delete_batch: + value: + entries: + - path: /Homework/math/Prime_Numbers.txt + responses: + "200": + description: delete_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_14' + examples: + delete_batch response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/delete_batch/check: + post: + tags: + - files + summary: delete_batch/check + description: |- + [delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `delete_batch`. If success, it returns list of result for each entry. + operationId: deleteBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/delete_batch_check_body' + examples: + delete_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: delete_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_14' + examples: + delete_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/download: + post: + tags: + - files + summary: download + description: |- + [download](https://www.dropbox.com/developers/documentation/http/documentation#files-download) + + scope: `files.content.read` + + Download a file from a user's Dropbox. + operationId: download + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/Homework/math/Prime_Numbers.txt" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: download response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + download response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/download_zip: + post: + tags: + - files + summary: download_zip + description: |- + [download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip) + + scope: `files.content.read` + + Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size. + operationId: downloadZip + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/Homework/math" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: download_zip response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_12' + examples: + download_zip response: + value: + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/export: + post: + tags: + - files + summary: export + description: |- + [export](https://www.dropbox.com/developers/documentation/http/documentation#files-export) + + scope: `files.content.read` + + Export a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose `ExportResult.file_metadata` has `ExportInfo.export_as` populated. + operationId: export + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/Homework/math/Prime_Numbers.gsheet" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: export response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_16' + examples: + export response: + value: + export_metadata: + export_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + name: Prime_Numbers.xlsx + size: 7189 + file_metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_file_lock_batch: + post: + tags: + - files + summary: get_file_lock_batch + description: |- + [get_file_lock_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_file_lock_batch) + + scope: `files.content.read` + + Return the lock metadata for the given list of paths. + operationId: getFileLockBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_file_lock_batch_body' + examples: + get_file_lock_batch: + value: + entries: + - path: /John Doe/sample/test.pdf + responses: + "200": + description: get_file_lock_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_17' + examples: + get_file_lock_batch response: + value: + entries: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_metadata: + post: + tags: + - files + summary: get_metadata + description: |- + [get_metadata](https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata) + + scope: `files.metadata.read` + + Returns the metadata for a file or folder. + Note: Metadata for the root folder is unsupported. + operationId: getMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_metadata_body' + examples: + get_metadata: + value: + include_deleted: false + include_has_explicit_shared_members: false + include_media_info: false + path: /Homework/math + responses: + "200": + description: get_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_18' + examples: + get_metadata response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_preview: + post: + tags: + - files + summary: get_preview + description: |- + [get_preview](https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview) + + scope: `files.content.read` + + Get a preview for a file. + Currently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. + HTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. + Other formats will return an unsupported extension error. + operationId: getPreview + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/word.docx" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: get_preview response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + get_preview response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_temporary_link: + post: + tags: + - files + summary: get_temporary_link + description: |- + [get_temporary_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link) + + scope: `files.content.read` + + Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type. + operationId: getTemporaryLink + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_temporary_link_body' + examples: + get_temporary_link: + value: + path: /video.mp4 + responses: + "200": + description: get_temporary_link response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_19' + examples: + get_temporary_link response: + value: + link: https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 + metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_temporary_upload_link: + post: + tags: + - files + summary: get_temporary_upload_link + description: |- + [get_temporary_upload_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_upload_link) + + scope: `files.content.write` + + Get a one-time use temporary upload link to upload a file to a Dropbox location. + + This endpoint acts as a delayed `upload`. The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the `CommitInfo` previously provided to `get_temporary_upload_link` but evaluated only upon consumption. Hence, errors stemming from invalid `CommitInfo` with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time. + + The POST request on the temporary upload link must have its Content-Type set to "application/octet-stream". + + Example temporary upload link consumption request: + + curl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + --header "Content-Type: application/octet-stream" + --data-binary @local_file.txt + + A successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format. + + Example succesful temporary upload link consumption response: + {"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"} + + An unsuccessful temporary upload link consumption request returns any of the following status codes: + + HTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid. + HTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened. + HTTP 410 Gone: The temporary upload link is expired or consumed. + + Example unsuccessful temporary upload link consumption response: + Temporary upload link has been recently consumed. + operationId: getTemporaryUploadLink + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_temporary_upload_link_body' + examples: + get_temporary_upload_link: + value: + commit_info: + autorename: true + mode: add + mute: false + path: /Homework/math/Matrices.txt + strict_conflict: false + duration: 3600 + responses: + "200": + description: get_temporary_upload_link response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_20' + examples: + get_temporary_upload_link response: + value: + link: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + /files/get_thumbnail_v2: + post: + tags: + - files + summary: get_thumbnail + description: |- + [get_thumbnail](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail) + + scope: `files.content.read` + + Get a thumbnail for a file. + operationId: getThumbnail + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"resource\": {\n \".tag\": \"path\", \n \ + \ \"path\": \"/a.docx\"\n }, \n \"format\": \"jpeg\", \n \"size\"\ + : \"w64h64\", \n \"mode\": \"strict\"\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: get_thumbnail response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_21' + examples: + get_thumbnail response: + value: + file_metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_thumbnail_batch: + post: + tags: + - files + summary: get_thumbnail_batch + description: |- + [get_thumbnail_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch) + + scope: `files.content.read` + + Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch. + This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail. + operationId: getThumbnailBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_thumbnail_batch_body' + examples: + get_thumbnail_batch: + value: + entries: + - format: jpeg + mode: strict + path: /image.jpg + size: w64h64 + responses: + "200": + description: get_thumbnail_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_22' + examples: + get_thumbnail_batch response: + value: + entries: + - ".tag": success + metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= + /files/list_folder: + post: + tags: + - files + summary: list_folder + description: |- + [list_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder) + + scope: `files.metadata.read` + + Starts returning the contents of a folder. If the result's `ListFolderResult.has_more` field is `true`, call `list_folder/continue` with the returned `ListFolderResult.cursor` to retrieve more entries. + If you're using `ListFolderArg.recursive` set to `true` to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync: + For each `FileMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children. + For each `FolderMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's `FolderSharingInfo.read_only` and set all its children's read-only statuses to match. + For each `DeletedMetadata`, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry. + Note: `auth.RateLimitError` may be returned if multiple `list_folder` or `list_folder/continue` calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes. + operationId: listFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_list_folder_body' + examples: + list_folder: + value: + include_deleted: false + include_has_explicit_shared_members: false + include_media_info: false + include_mounted_folders: true + include_non_downloadable_files: true + path: /Homework/math + recursive: false + responses: + "200": + description: list_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_23' + examples: + list_folder response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + - ".tag": folder + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + has_more: false + /files/list_folder/continue: + post: + tags: + - files + summary: list_folder/continue + description: |- + [list_folder/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue) + + scope: `files.metadata.read` + + Once a cursor has been retrieved from `list_folder`, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for `list_folder`. + operationId: listFolderContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_continue_body' + examples: + list_folder/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_folder/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_23' + examples: + list_folder/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + - ".tag": folder + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + has_more: false + /files/list_folder/get_latest_cursor: + post: + tags: + - files + summary: list_folder/get_latest_cursor + description: |- + [list_folder/get_latest_cursor](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-get_latest_cursor) + + scope: `files.metadata.read` + + A way to quickly get a cursor for the folder's state. Unlike `list_folder`, `list_folder/get_latest_cursor` doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox. + operationId: listFolderGetLatestCursor + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_get_latest_cursor_body' + examples: + list_folder/get_latest_cursor: + value: + include_deleted: false + include_has_explicit_shared_members: false + include_media_info: false + include_mounted_folders: true + include_non_downloadable_files: true + path: /Homework/math + recursive: false + responses: + "200": + description: list_folder/get_latest_cursor response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_continue_body' + examples: + list_folder/get_latest_cursor response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /files/list_folder/longpoll: + post: + tags: + - files + summary: list_folder/longpoll + description: |- + [list_folder/longpoll](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-longpoll) + + scope: `files.metadata.read` + + A longpoll endpoint to wait for changes on an account. In conjunction with `list_folder/continue`, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps. If you're looking for server-side notifications, check out our [webhooks documentation](https://www.dropbox.com/developers/reference/webhooks). + operationId: listFolderLongpoll + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_longpoll_body' + examples: + list_folder/longpoll: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + timeout: 30 + responses: + "200": + description: list_folder/longpoll response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_24' + examples: + list_folder/longpoll response: + value: + changes: true + /files/list_revisions: + post: + tags: + - files + summary: list_revisions + description: |- + [list_revisions](https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions) + + scope: `files.metadata.read` + + Returns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately. + In the `ListRevisionsMode.path` (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to `ListRevisionsMode.id`. The `ListRevisionsMode.id` mode is useful to retrieve revisions for a given file across moves or renames. + operationId: listRevisions + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_list_revisions_body' + examples: + list_revisions: + value: + limit: 10 + mode: path + path: /root/word.docx + responses: + "200": + description: list_revisions response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_25' + examples: + list_revisions response: + value: + entries: + - client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + is_deleted: false + /files/lock_file_batch: + post: + tags: + - files + summary: lock_file_batch + description: |- + [lock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-lock_file_batch) + + scope: `files.content.write` + + Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation. + operationId: lockFileBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_lock_file_batch_body' + examples: + lock_file_batch: + value: + entries: + - path: /John Doe/sample/test.pdf + responses: + "200": + description: lock_file_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_17' + examples: + lock_file_batch response: + value: + entries: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/move_v2: + post: + tags: + - files + summary: move + description: |- + [move](https://www.dropbox.com/developers/documentation/http/documentation#files-move) + + scope: `files.content.write` + + Move a file or folder to a different location in the user's Dropbox. + If the source path is a folder all its contents will be moved. + Note that we do not currently support case-only renaming. + operationId: move + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_move_v2_body' + examples: + move: + value: + allow_ownership_transfer: false + allow_shared_folder: false + autorename: false + from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: move response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + move response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/move_batch_v2: + post: + tags: + - files + summary: move_batch + description: |- + [move_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch) + + scope: `files.content.write` + + Move multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming. + This route will replace `move_batch:1`. The main difference is this route will return status for each entry, while `move_batch:1` raises failure if any entry fails. + This route will either finish synchronously, or return a job ID and do the async move job in background. Please use `move_batch/check:2` to check the job status. + operationId: moveBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_move_batch_v2_body' + examples: + move_batch: + value: + allow_ownership_transfer: false + autorename: false + entries: + - from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: move_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + move_batch response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/move_batch/check_v2: + post: + tags: + - files + summary: move_batch/check + description: |- + [move_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `move_batch:2`. It returns list of results for each entry. + operationId: moveBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/move_batch_check_v2_body' + examples: + move_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: move_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + move_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/permanently_delete: + post: + tags: + - files + summary: permanently_delete + description: |- + [permanently_delete](https://www.dropbox.com/developers/documentation/http/documentation#files-permanently_delete) + + scope: `files.permanent_delete` + + Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40). + Note: This endpoint is only available for Dropbox Business apps. + operationId: permanentlyDelete + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_permanently_delete_body' + examples: + permanently_delete: + value: + path: /Homework/math/Prime_Numbers.txt + responses: + "200": + description: "" + /files/restore: + post: + tags: + - files + summary: restore + description: |- + [restore](https://www.dropbox.com/developers/documentation/http/documentation#files-restore) + + scope: `files.content.write` + + Restore a specific revision of a file to the given path. + operationId: restore + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_restore_body' + examples: + restore: + value: + path: /root/word.docx + rev: a1c10ce0dd78 + responses: + "200": + description: restore response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + restore response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/save_url: + post: + tags: + - files + summary: save_url + description: |- + [save_url](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url) + + scope: `files.content.write` + + Save the data from a specified URL into a file in user's Dropbox. + Note that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail. + If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt). + operationId: saveUrl + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_save_url_body' + examples: + save_url: + value: + path: /a.txt + url: http://example.com/a.txt + responses: + "200": + description: save_url response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_26' + examples: + save_url response: + value: + ".tag": complete + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/save_url/check_job_status: + post: + tags: + - files + summary: save_url/check_job_status + description: |- + [save_url/check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url-check_job_status) + + scope: `files.content.write` + + Check the status of a `save_url` job. + operationId: saveUrlCheckJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/save_url_check_job_status_body' + examples: + save_url/check_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: save_url/check_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_27' + examples: + save_url/check_job_status response: + value: + ".tag": in_progress + /files/search_v2: + post: + tags: + - files + summary: search + description: |- + [search](https://www.dropbox.com/developers/documentation/http/documentation#files-search) + + scope: `files.metadata.read` + + Searches for files and folders. + Note: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches. + Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned. + operationId: search + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_search_v2_body' + examples: + search: + value: + include_highlights: false + query: cat + responses: + "200": + description: search response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_28' + examples: + search response: + value: + has_more: false + matches: + - metadata: + ".tag": metadata + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/search/continue_v2: + post: + tags: + - files + summary: search/continue + description: |- + [search/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-search-continue) + + scope: `files.metadata.read` + + Fetches the next page of search results returned from `search:2`. + Note: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches. + Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned. + operationId: searchContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/search_continue_v2_body' + examples: + search/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: search/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_28' + examples: + search/continue response: + value: + has_more: false + matches: + - metadata: + ".tag": metadata + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/unlock_file_batch: + post: + tags: + - files + summary: unlock_file_batch + description: |- + [unlock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-unlock_file_batch) + + scope: `files.content.write` + + Unlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation. + operationId: unlockFileBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_unlock_file_batch_body' + examples: + unlock_file_batch: + value: + entries: + - path: /John Doe/sample/test.pdf + responses: + "200": + description: unlock_file_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_17' + examples: + unlock_file_batch response: + value: + entries: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload: + post: + tags: + - files + summary: upload + description: |- + [upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload) + + scope: `files.content.write` + + Create a new file with the contents provided in the request. + Do not use this to upload a file larger than 150 MB. Instead, create an upload session with `upload_session/start`. + Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: upload + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\"\ + : \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"\ + strict_conflict\": false\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: upload response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + upload response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/append_v2: + post: + tags: + - files + summary: upload_session/append + description: |- + [upload_session/append](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append) + + scope: `files.content.write` + + Append more data to an upload session. + When the parameter close is set, this call will close the session. + A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB. + Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionAppend + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\"\ + , \n \"offset\": 0\n }, \n \"close\": false\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: "" + /files/upload_session/finish: + post: + tags: + - files + summary: upload_session/finish + description: |- + [upload_session/finish](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish) + + scope: `files.content.write` + + Finish an upload session and save the uploaded data to the given file path. + A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB. + Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionFinish + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\"\ + , \n \"offset\": 0\n }, \n \"commit\": {\n \"path\"\ + : \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \ + \ \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\"\ + : false\n }\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: upload_session/finish response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + upload_session/finish response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/finish_batch: + post: + tags: + - files + summary: upload_session/finish_batch + description: |- + [upload_session/finish_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch) + + scope: `files.content.write` + + This route helps you commit many files at once into a user's Dropbox. Use `upload_session/start` and `upload_session/append:2` to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling `upload_session/finish`, use this route to finish all your upload sessions in a single request. + `UploadSessionStartArg.close` or `UploadSessionAppendArg.close` needs to be true for the last `upload_session/start` or `upload_session/append:2` call. The maximum size of a file one can upload to an upload session is 350 GB. + This route will return a job_id immediately and do the async commit job in background. Use `upload_session/finish_batch/check` to check the job status. + For the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request. + Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionFinishBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/upload_session_finish_batch_body' + examples: + upload_session/finish_batch: + value: + entries: + - commit: + autorename: true + mode: add + mute: false + path: /Homework/math/Matrices.txt + strict_conflict: false + cursor: + offset: 0 + session_id: 1234faaf0678bcde + responses: + "200": + description: upload_session/finish_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_29' + examples: + upload_session/finish_batch response: + value: + ".tag": complete + entries: + - ".tag": success + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/finish_batch/check: + post: + tags: + - files + summary: upload_session/finish_batch/check + description: |- + [upload_session/finish_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `upload_session/finish_batch`. If success, it returns list of result for each entry. + operationId: uploadSessionFinishBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/finish_batch_check_body' + examples: + upload_session/finish_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: upload_session/finish_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_29' + examples: + upload_session/finish_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/start: + post: + tags: + - files + summary: upload_session/start + description: |- + [upload_session/start](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start) + + scope: `files.content.write` + + Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. This call starts a new upload session with the given data. You can then use `upload_session/append:2` to add more data and `upload_session/finish` to save all the data to a file in Dropbox. + A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB. + An upload session can be used for a maximum of 48 hours. Attempting to use an `UploadSessionStartResult.session_id` with `upload_session/append:2` or `upload_session/finish` more than 48 hours after its creation will return a `UploadSessionLookupError.not_found`. + Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionStart + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "close": false + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: upload_session/start response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_30' + examples: + upload_session/start response: + value: + session_id: 1234faaf0678bcde + /sharing/add_file_member: + post: + tags: + - sharing + summary: add_file_member + description: |- + [add_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member) + + scope: `sharing.write` + + Adds specified members to a file. + operationId: addFileMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_add_file_member_body' + examples: + add_file_member: + value: + access_level: viewer + add_message_as_comment: false + custom_message: This is a custom message about ACME.doc + file: id:3kmLmQFnf1AAAAAAAAAAAw + members: + - ".tag": email + email: justin@example.com + quiet: false + responses: + "200": + description: add_file_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - member: + ".tag": email + email: justin@example.com + result: + ".tag": success + items: + $ref: '#/components/schemas/inline_response_200_31' + examples: + add_file_member response: + value: + - member: + ".tag": email + email: justin@example.com + result: + ".tag": success + /sharing/add_folder_member: + post: + tags: + - sharing + summary: add_folder_member + description: |- + [add_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member) + + scope: `sharing.write` + + Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member. + For the new member to get access to all the functionality for this folder, you will need to call `mount_folder` on their behalf. + operationId: addFolderMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_add_folder_member_body' + examples: + add_folder_member: + value: + custom_message: Documentation for launch day + members: + - access_level: editor + member: + ".tag": email + email: justin@example.com + - access_level: viewer + member: + ".tag": dropbox_id + dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + quiet: false + shared_folder_id: "84528192421" + responses: + "200": + description: "" + /sharing/check_job_status: + post: + tags: + - sharing + summary: check_job_status + description: |- + [check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status) + + scope: `sharing.write` + + Returns the status of an asynchronous job. + operationId: checkJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_check_job_status_body' + examples: + check_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: check_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_27' + examples: + check_job_status response: + value: + ".tag": in_progress + /sharing/check_remove_member_job_status: + post: + tags: + - sharing + summary: check_remove_member_job_status + description: |- + [check_remove_member_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status) + + scope: `sharing.write` + + Returns the status of an asynchronous job for sharing a folder. + operationId: checkRemoveMemberJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_check_remove_member_job_status_body' + examples: + check_remove_member_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: check_remove_member_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + check_remove_member_job_status response: + value: + ".tag": complete + /sharing/check_share_job_status: + post: + tags: + - sharing + summary: check_share_job_status + description: |- + [check_share_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_share_job_status) + + scope: `sharing.write` + + Returns the status of an asynchronous job for sharing a folder. + operationId: checkShareJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_check_share_job_status_body' + examples: + check_share_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: check_share_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_33' + examples: + check_share_job_status response: + value: + ".tag": complete + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/get_file_metadata: + post: + tags: + - sharing + summary: get_file_metadata + description: |- + [get_file_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata) + + scope: `sharing.read` + + Returns shared file metadata. + operationId: getFileMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_get_file_metadata_body' + examples: + get_file_metadata: + value: + actions: [] + file: id:3kmLmQFnf1AAAAAAAAAAAw + responses: + "200": + description: get_file_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_34' + examples: + get_file_metadata response: + value: + access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/get_file_metadata/batch: + post: + tags: + - sharing + summary: get_file_metadata/batch + description: |- + [get_file_metadata/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch) + + scope: `sharing.read` + + Returns shared file metadata. + operationId: getFileMetadataBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/get_file_metadata_batch_body' + examples: + get_file_metadata/batch: + value: + actions: [] + files: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + responses: + "200": + description: get_file_metadata/batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": metadata + access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + items: + $ref: '#/components/schemas/inline_response_200_35' + examples: + get_file_metadata/batch response: + value: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": metadata + access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/get_folder_metadata: + post: + tags: + - sharing + summary: get_folder_metadata + description: |- + [get_folder_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata) + + scope: `sharing.read` + + Returns shared folder metadata by its folder ID. + operationId: getFolderMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_get_folder_metadata_body' + examples: + get_folder_metadata: + value: + actions: [] + shared_folder_id: "84528192421" + responses: + "200": + description: get_folder_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_36' + examples: + get_folder_metadata response: + value: + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/get_shared_link_file: + post: + tags: + - sharing + summary: get_shared_link_file + description: |- + [get_shared_link_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file) + + scope: `sharing.read` + + Download the shared link's file from a user's Dropbox. + operationId: getSharedLinkFile + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"url\": \"https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0\"\ + , \n \"path\": \"/Prime_Numbers.txt\"\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: get_shared_link_file response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_37' + examples: + get_shared_link_file response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/get_shared_link_metadata: + post: + tags: + - sharing + summary: get_shared_link_metadata + description: |- + [get_shared_link_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_metadata) + + scope: `sharing.read` + + Get the shared link's metadata. + operationId: getSharedLinkMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_get_shared_link_metadata_body' + examples: + get_shared_link_metadata: + value: + path: /Prime_Numbers.txt + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + responses: + "200": + description: get_shared_link_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_37' + examples: + get_shared_link_metadata response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/list_file_members: + post: + tags: + - sharing + summary: list_file_members + description: |- + [list_file_members](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members) + + scope: `sharing.read` + + Use to obtain the members who have been invited to a file, both inherited and uninherited members. + operationId: listFileMembers + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_file_members_body' + examples: + list_file_members: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + include_inherited: true + limit: 100 + responses: + "200": + description: list_file_members response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_38' + examples: + list_file_members response: + value: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_file_members/batch: + post: + tags: + - sharing + summary: list_file_members/batch + description: |- + [list_file_members/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch) + + scope: `sharing.read` + + Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint. + Inherited users and groups are not included in the result, and permissions are not returned for this endpoint. + operationId: listFileMembersBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_file_members_batch_body' + examples: + list_file_members/batch: + value: + files: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + limit: 10 + responses: + "200": + description: list_file_members/batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": result + member_count: 3 + members: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/inline_response_200_39' + examples: + list_file_members/batch response: + value: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": result + member_count: 3 + members: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_file_members/continue: + post: + tags: + - sharing + summary: list_file_members/continue + description: |- + [list_file_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_file_members` or `list_file_members/batch`, use this to paginate through all shared file members. + operationId: listFileMembersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_file_members_continue_body' + examples: + list_file_members/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_file_members/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_38' + examples: + list_file_members/continue response: + value: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_folder_members/continue: + post: + tags: + - sharing + summary: list_folder_members/continue + description: |- + [list_folder_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_folder_members`, use this to paginate through all shared folder members. + operationId: listFolderMembersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_members_continue_body' + examples: + list_folder_members/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_folder_members/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_40' + examples: + list_folder_members/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_folders: + post: + tags: + - sharing + summary: list_folders + description: |- + [list_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders) + + scope: `sharing.read` + + Return the list of all shared folders the current user has access to. + operationId: listFolders + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_folders_body' + examples: + list_folders: + value: + actions: [] + limit: 100 + responses: + "200": + description: list_folders response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_folders response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_folders/continue: + post: + tags: + - sharing + summary: list_folders/continue + description: |- + [list_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_folders`, use this to paginate through all shared folders. The cursor must come from a previous call to `list_folders` or `list_folders/continue`. + operationId: listFoldersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folders_continue_body' + examples: + list_folders/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_folders/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_folders/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_mountable_folders: + post: + tags: + - sharing + summary: list_mountable_folders + description: |- + [list_mountable_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders) + + scope: `sharing.read` + + Return the list of all shared folders the current user can mount or unmount. + operationId: listMountableFolders + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_mountable_folders_body' + examples: + list_mountable_folders: + value: + actions: [] + limit: 100 + responses: + "200": + description: list_mountable_folders response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_mountable_folders response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_mountable_folders/continue: + post: + tags: + - sharing + summary: list_mountable_folders/continue + description: |- + [list_mountable_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_mountable_folders`, use this to paginate through all mountable shared folders. The cursor must come from a previous call to `list_mountable_folders` or `list_mountable_folders/continue`. + operationId: listMountableFoldersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_mountable_folders_continue_body' + examples: + list_mountable_folders/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_mountable_folders/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_mountable_folders/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_received_files: + post: + tags: + - sharing + summary: list_received_files + description: |- + [list_received_files](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files) + + scope: `sharing.read` + + Returns a list of all files shared with current user. + Does not include files the user has received via shared folders, and does not include unclaimed invitations. + operationId: listReceivedFiles + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_received_files_body' + examples: + list_received_files: + value: + actions: [] + limit: 100 + responses: + "200": + description: list_received_files response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_42' + examples: + list_received_files response: + value: + cursor: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + entries: + - access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/list_received_files/continue: + post: + tags: + - sharing + summary: list_received_files/continue + description: |- + [list_received_files/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue) + + scope: `sharing.read` + + Get more results with a cursor from `list_received_files`. + operationId: listReceivedFilesContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_received_files_continue_body' + examples: + list_received_files/continue: + value: + cursor: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId + responses: + "200": + description: list_received_files/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_42' + examples: + list_received_files/continue response: + value: + cursor: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + entries: + - access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/list_shared_links: + post: + tags: + - sharing + summary: list_shared_links + description: |- + [list_shared_links](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links) + + scope: `sharing.read` + + List shared links of this user. + If no path is given, returns a list of all shared links for the current user. + If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true. + operationId: listSharedLinks + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_shared_links_body' + examples: + list_shared_links: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_shared_links response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_43' + examples: + list_shared_links response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + links: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/modify_shared_link_settings: + post: + tags: + - sharing + summary: modify_shared_link_settings + description: |- + [modify_shared_link_settings](https://www.dropbox.com/developers/documentation/http/documentation#sharing-modify_shared_link_settings) + + scope: `sharing.write` + + Modify the shared link's settings. + If the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the `LinkPermissions.resolved_visibility` of the returned `SharedLinkMetadata` will reflect the actual visibility of the shared link and the `LinkPermissions.requested_visibility` will reflect the requested visibility. + operationId: modifySharedLinkSettings + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_modify_shared_link_settings_body' + examples: + modify_shared_link_settings: + value: + remove_expiration: false + settings: + access: viewer + audience: public + requested_visibility: public + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + responses: + "200": + description: modify_shared_link_settings response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_37' + examples: + modify_shared_link_settings response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/mount_folder: + post: + tags: + - sharing + summary: mount_folder + description: |- + [mount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder) + + scope: `sharing.write` + + The current user mounts the designated folder. + Mount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox. + operationId: mountFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_mount_folder_body' + examples: + mount_folder: + value: + shared_folder_id: "84528192421" + responses: + "200": + description: mount_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_36' + examples: + mount_folder response: + value: + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/relinquish_file_membership: + post: + tags: + - sharing + summary: relinquish_file_membership + description: |- + [relinquish_file_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership) + + scope: `sharing.write` + + The current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder. + operationId: relinquishFileMembership + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_relinquish_file_membership_body' + examples: + relinquish_file_membership: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + responses: + "200": + description: "" + /sharing/relinquish_folder_membership: + post: + tags: + - sharing + summary: relinquish_folder_membership + description: |- + [relinquish_folder_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership) + + scope: `sharing.write` + + The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder. + This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true. + operationId: relinquishFolderMembership + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_relinquish_folder_membership_body' + examples: + relinquish_folder_membership: + value: + leave_a_copy: false + shared_folder_id: "84528192421" + responses: + "200": + description: relinquish_folder_membership response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + relinquish_folder_membership response: + value: + ".tag": complete + /sharing/remove_file_member_2: + post: + tags: + - sharing + summary: remove_file_member_2 + description: |- + [remove_file_member_2](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2) + + scope: `sharing.write` + + Removes a specified member from the file. + operationId: removeFileMember2 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_remove_file_member_2_body' + examples: + remove_file_member_2: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + member: + ".tag": email + email: justin@example.com + responses: + "200": + description: remove_file_member_2 response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_44' + examples: + remove_file_member_2 response: + value: + ".tag": other + /sharing/remove_folder_member: + post: + tags: + - sharing + summary: remove_folder_member + description: |- + [remove_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member) + + scope: `sharing.write` + + Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member. + operationId: removeFolderMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_remove_folder_member_body' + examples: + remove_folder_member: + value: + leave_a_copy: false + member: + ".tag": email + email: justin@example.com + shared_folder_id: "84528192421" + responses: + "200": + description: remove_folder_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_45' + examples: + remove_folder_member response: + value: + ".tag": async_job_id + async_job_id: 34g93hh34h04y384084 + /sharing/revoke_shared_link: + post: + tags: + - sharing + summary: revoke_shared_link + description: |- + [revoke_shared_link](https://www.dropbox.com/developers/documentation/http/documentation#sharing-revoke_shared_link) + + scope: `sharing.write` + + Revoke a shared link. + Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the `list_shared_links` with the file as the `ListSharedLinksArg.path` argument. + operationId: revokeSharedLink + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_revoke_shared_link_body' + examples: + revoke_shared_link: + value: + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + responses: + "200": + description: "" + /sharing/set_access_inheritance: + post: + tags: + - sharing + summary: set_access_inheritance + description: |- + [set_access_inheritance](https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance) + + scope: `sharing.write` + + Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root. + If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder. + operationId: setAccessInheritance + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_set_access_inheritance_body' + examples: + set_access_inheritance: + value: + access_inheritance: inherit + shared_folder_id: "84528192421" + responses: + "200": + description: set_access_inheritance response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_33' + examples: + set_access_inheritance response: + value: + ".tag": complete + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/share_folder: + post: + tags: + - sharing + summary: share_folder + description: |- + [share_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-share_folder) + + scope: `sharing.write` + + Share a folder with collaborators. + Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`. + If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder. + operationId: shareFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_share_folder_body' + examples: + share_folder: + value: + access_inheritance: inherit + acl_update_policy: editors + force_async: false + member_policy: team + path: /example/workspace + shared_link_policy: members + responses: + "200": + description: share_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_33' + examples: + share_folder response: + value: + ".tag": complete + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/transfer_folder: + post: + tags: + - sharing + summary: transfer_folder + description: |- + [transfer_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder) + + scope: `sharing.write` + + Transfer ownership of a shared folder to a member of the shared folder. + User must have `AccessLevel.owner` access to the shared folder to perform a transfer. + operationId: transferFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_transfer_folder_body' + examples: + transfer_folder: + value: + shared_folder_id: "84528192421" + to_dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + responses: + "200": + description: "" + /sharing/unmount_folder: + post: + tags: + - sharing + summary: unmount_folder + description: |- + [unmount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder) + + scope: `sharing.write` + + The current user unmounts the designated folder. They can re-mount the folder at a later time using `mount_folder`. + operationId: unmountFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_unmount_folder_body' + examples: + unmount_folder: + value: + shared_folder_id: "84528192421" + responses: + "200": + description: "" + /sharing/unshare_file: + post: + tags: + - sharing + summary: unshare_file + description: |- + [unshare_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_file) + + scope: `sharing.write` + + Remove all members from this file. Does not remove inherited members. + operationId: unshareFile + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_unshare_file_body' + examples: + unshare_file: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + responses: + "200": + description: "" + /sharing/unshare_folder: + post: + tags: + - sharing + summary: unshare_folder + description: |- + [unshare_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_folder) + + scope: `sharing.write` + + Allows a shared folder owner to unshare the folder. + You'll need to call `check_job_status` to determine if the action has completed successfully. + operationId: unshareFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_unshare_folder_body' + examples: + unshare_folder: + value: + leave_a_copy: false + shared_folder_id: "84528192421" + responses: + "200": + description: unshare_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + unshare_folder response: + value: + ".tag": complete + /sharing/update_file_member: + post: + tags: + - sharing + summary: update_file_member + description: |- + [update_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member) + + scope: `sharing.write` + + Changes a member's access on a shared file. + operationId: updateFileMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_update_file_member_body' + examples: + update_file_member: + value: + access_level: viewer + file: id:3kmLmQFnf1AAAAAAAAAAAw + member: + ".tag": email + email: justin@example.com + responses: + "200": + description: update_file_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: object + properties: {} + examples: + update_file_member response: + value: {} + /sharing/update_folder_member: + post: + tags: + - sharing + summary: update_folder_member + description: |- + [update_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member) + + scope: `sharing.write` + + Allows an owner or editor of a shared folder to update another member's permissions. + operationId: updateFolderMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_update_folder_member_body' + examples: + update_folder_member: + value: + access_level: editor + member: + ".tag": email + email: justin@example.com + shared_folder_id: "84528192421" + responses: + "200": + description: update_folder_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: object + properties: {} + examples: + update_folder_member response: + value: {} + /sharing/update_folder_policy: + post: + tags: + - sharing + summary: update_folder_policy + description: |- + [update_folder_policy](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy) + + scope: `sharing.write` + + Update the sharing policies for a shared folder. + User must have `AccessLevel.owner` access to the shared folder to update its policies. + operationId: updateFolderPolicy + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_update_folder_policy_body' + examples: + update_folder_policy: + value: + acl_update_policy: owner + member_policy: team + shared_folder_id: "84528192421" + shared_link_policy: members + responses: + "200": + description: update_folder_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_36' + examples: + update_folder_policy response: + value: + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /team/devices/list_member_devices: + post: + tags: + - team + - devices + summary: devices/list_member_devices + description: |- + [devices/list_member_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_member_devices) + + scope: `sessions.list` + + List all device sessions of a team's member. + operationId: devicesListMemberDevices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/devices_list_member_devices_body' + examples: + devices/list_member_devices: + value: + include_desktop_clients: true + include_mobile_clients: true + include_web_sessions: true + team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + responses: + "200": + description: "" + /team/devices/list_members_devices: + post: + tags: + - team + - devices + summary: devices/list_members_devices + description: |- + [devices/list_members_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_members_devices) + + scope: `sessions.list` + + List all device sessions of a team. + Permission : Team member file access. + operationId: devicesListMembersDevices + requestBody: + content: + text/plain: + examples: + devices/list_members_devices: + value: "" + responses: + "200": + description: "" + /team/devices/revoke_device_session: + post: + tags: + - team + - devices + summary: devices/revoke_device_session + description: |- + [devices/revoke_device_session](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session) + + scope: `sessions.modify` + + Revoke a device session of a team's member. + operationId: devicesRevokeDeviceSession + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/devices_revoke_device_session_body' + examples: + devices/revoke_device_session: + value: + ".tag": web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + responses: + "200": + description: "" + /team/devices/revoke_device_session_batch: + post: + tags: + - team + - devices + summary: devices/revoke_device_session_batch + description: |- + [devices/revoke_device_session_batch](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session_batch) + + scope: `sessions.modify` + + Revoke a list of device sessions of team members. + operationId: devicesRevokeDeviceSessionBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/devices_revoke_device_session_batch_body' + examples: + devices/revoke_device_session_batch: + value: + revoke_devices: + - ".tag": web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + responses: + "200": + description: "" + /team/groups/create: + post: + tags: + - team + - groups + summary: groups/create + description: |- + [groups/create](https://www.dropbox.com/developers/documentation/http/teams#team-groups-create) + + scope: `groups.write` + + Creates a new, empty group, with a requested name. + Permission : Team member management. + operationId: groupsCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_create_body' + examples: + groups/create: + value: + add_creator_as_owner: false + group_external_id: group-134 + group_name: Europe sales + responses: + "200": + description: groups/create response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_46' + examples: + groups/create response: + value: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/delete: + post: + tags: + - team + - groups + summary: groups/delete + description: |- + [groups/delete](https://www.dropbox.com/developers/documentation/http/teams#team-groups-delete) + + scope: `groups.write` + + Deletes a group. + The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed. + Permission : Team member management. + operationId: groupsDelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_delete_body' + examples: + groups/delete: + value: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + responses: + "200": + description: groups/delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + groups/delete response: + value: + ".tag": complete + /team/groups/get_info: + post: + tags: + - team + - groups + summary: groups/get_info + description: |- + [groups/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-groups-get_info) + + scope: `groups.read` + + Retrieves information about one or more groups. Note that the optional field `GroupFullInfo.members` is not returned for system-managed groups. + Permission : Team Information. + operationId: groupsGetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_get_info_body' + examples: + groups/get_info: + value: + ".tag": group_ids + group_ids: + - g:e2db7665347abcd600000000001a2b3c + - g:111111147abcd6000000000222222c + responses: + "200": + description: groups/get_info response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/inline_response_200_47' + examples: + groups/get_info response: + value: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/job_status/get: + post: + tags: + - team + - groups + summary: groups/job_status/get + description: |- + [groups/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-groups-job_status-get) + + scope: `groups.write` + + Once an async_job_id is returned from `groups/delete`, `groups/members/add` , or `groups/members/remove` use this method to poll the status of granting/revoking group members' access to group-owned resources. + Permission : Team member management. + operationId: groupsJobStatusGet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_get_body' + examples: + groups/job_status/get: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: groups/job_status/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + groups/job_status/get response: + value: + ".tag": complete + /team/groups/list: + post: + tags: + - team + - groups + summary: groups/list + description: |- + [groups/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list) + + scope: `groups.read` + + Lists groups on a team. + Permission : Team Information. + operationId: groupsList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_list_body' + examples: + groups/list: + value: + limit: 100 + responses: + "200": + description: groups/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_48' + examples: + groups/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + - group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + member_count: 10 + has_more: false + /team/groups/list/continue: + post: + tags: + - team + - groups + summary: groups/list/continue + description: |- + [groups/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list-continue) + + scope: `groups.read` + + Once a cursor has been retrieved from `groups/list`, use this to paginate through all groups. + Permission : Team Information. + operationId: groupsListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_1' + examples: + groups/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: groups/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_48' + examples: + groups/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + - group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + member_count: 10 + has_more: false + /team/groups/members/add: + post: + tags: + - team + - groups + summary: groups/members/add + description: |- + [groups/members/add](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-add) + + scope: `groups.write` + + Adds members to a group. + The members are added immediately. However the granting of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed. + Permission : Team member management. + operationId: groupsMembersAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_add_body' + examples: + groups/members/add: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + members: + - access_type: member + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + return_members: true + responses: + "200": + description: groups/members/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_49' + examples: + groups/members/add response: + value: + async_job_id: "99988877733388" + group_info: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/members/list: + post: + tags: + - team + - groups + summary: groups/members/list + description: |- + [groups/members/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list) + + scope: `groups.read` + + Lists members of a group. + Permission : Team Information. + operationId: groupsMembersList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_list_body' + examples: + groups/members/list: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + limit: 100 + responses: + "200": + description: groups/members/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_50' + examples: + groups/members/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + members: [] + /team/groups/members/list/continue: + post: + tags: + - team + - groups + summary: groups/members/list/continue + description: |- + [groups/members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list-continue) + + scope: `groups.read` + + Once a cursor has been retrieved from `groups/members/list`, use this to paginate through all members of the group. + Permission : Team information. + operationId: groupsMembersListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_2' + examples: + groups/members/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: groups/members/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_50' + examples: + groups/members/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + members: [] + /team/groups/members/remove: + post: + tags: + - team + - groups + summary: groups/members/remove + description: |- + [groups/members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-remove) + + scope: `groups.write` + + Removes members from a group. + The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed. + This method permits removing the only owner of a group, even in cases where this is not possible via the web client. + Permission : Team member management. + operationId: groupsMembersRemove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_remove_body' + examples: + groups/members/remove: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + return_members: true + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: groups/members/remove response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_49' + examples: + groups/members/remove response: + value: + async_job_id: "99988877733388" + group_info: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/members/set_access_type: + post: + tags: + - team + - groups + summary: groups/members/set_access_type + description: |- + [groups/members/set_access_type](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-set_access_type) + + scope: `groups.write` + + Sets a member's access type in a group. + Permission : Team member management. + operationId: groupsMembersSetAccessType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_access_type_body' + examples: + groups/members/set_access_type: + value: + access_type: member + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + return_members: true + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: groups/members/set_access_type response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/inline_response_200_47' + examples: + groups/members/set_access_type response: + value: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/update: + post: + tags: + - team + - groups + summary: groups/update + description: |- + [groups/update](https://www.dropbox.com/developers/documentation/http/teams#team-groups-update) + + scope: `groups.write` + + Updates a group's name and/or external ID. + Permission : Team member management. + operationId: groupsUpdate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_update_body' + examples: + groups/update: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + new_group_external_id: sales-234 + new_group_management_type: company_managed + new_group_name: Europe west sales + return_members: true + responses: + "200": + description: groups/update response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_46' + examples: + groups/update response: + value: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/legal_holds/create_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/create_policy + description: |- + [legal_holds/create_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-create_policy) + + scope: `team_data.member` + + Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsCreatePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_create_policy_body' + examples: + legal_holds/create_policy: + value: + end_date: 2017-12-31T00:00:00Z + members: + - dbmid:FDFSVF-DFSDF + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + responses: + "200": + description: legal_holds/create_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_51' + examples: + legal_holds/create_policy response: + value: + activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/legal_holds/get_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/get_policy + description: |- + [legal_holds/get_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-get_policy) + + scope: `team_data.member` + + Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsGetPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_get_policy_body' + examples: + legal_holds/get_policy: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: legal_holds/get_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_51' + examples: + legal_holds/get_policy response: + value: + activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/legal_holds/list_held_revisions: + post: + tags: + - team + - legal_holds + summary: legal_holds/list_held_revisions + description: |- + [legal_holds/list_held_revisions](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions) + + scope: `team_data.member` + + List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsListHeldRevisions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_list_held_revisions_body' + examples: + legal_holds/list_held_revisions: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: legal_holds/list_held_revisions response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_52' + examples: + legal_holds/list_held_revisions response: + value: + entries: + - author_email: a@a.com + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + ".tag": active + content_hash: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: Document + new_filename: 111_222.pdf + original_file_path: /a.pdf + original_revision_id: ab2rij4i5ojgfd + server_modified: 2019-08-12T12:08:52Z + size: 3 + has_more: false + /team/legal_holds/list_held_revisions_continue: + post: + tags: + - team + - legal_holds + summary: legal_holds/list_held_revisions_continue + description: |- + [legal_holds/list_held_revisions_continue](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions_continue) + + scope: `team_data.member` + + Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsListHeldRevisionsContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_list_held_revisions_continue_body' + examples: + legal_holds/list_held_revisions_continue: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: legal_holds/list_held_revisions_continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_52' + examples: + legal_holds/list_held_revisions_continue response: + value: + entries: + - author_email: a@a.com + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + ".tag": active + content_hash: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: Document + new_filename: 111_222.pdf + original_file_path: /a.pdf + original_revision_id: ab2rij4i5ojgfd + server_modified: 2019-08-12T12:08:52Z + size: 3 + has_more: false + /team/legal_holds/list_policies: + post: + tags: + - team + - legal_holds + summary: legal_holds/list_policies + description: |- + [legal_holds/list_policies](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_policies) + + scope: `team_data.member` + + Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsListPolicies + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_list_policies_body' + examples: + legal_holds/list_policies: + value: + include_released: false + responses: + "200": + description: legal_holds/list_policies response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_53' + examples: + legal_holds/list_policies response: + value: + policies: + - activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/legal_holds/release_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/release_policy + description: |- + [legal_holds/release_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-release_policy) + + scope: `team_data.member` + + Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsReleasePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_release_policy_body' + examples: + legal_holds/release_policy: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: "" + /team/legal_holds/update_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/update_policy + description: |- + [legal_holds/update_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-update_policy) + + scope: `team_data.member` + + Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsUpdatePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_update_policy_body' + examples: + legal_holds/update_policy: + value: + id: pid_dbhid:abcd1234 + members: + - dbmid:FDFSVF-DFSDF + responses: + "200": + description: legal_holds/update_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_51' + examples: + legal_holds/update_policy response: + value: + activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/linked_apps/list_member_linked_apps: + post: + tags: + - team + - linked_apps + summary: linked_apps/list_member_linked_apps + description: |- + [linked_apps/list_member_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_member_linked_apps) + + scope: `sessions.list` + + List all linked applications of the team member. + Note, this endpoint does not list any team-linked applications. + operationId: linkedAppsListMemberLinkedApps + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/linked_apps_list_member_linked_apps_body' + examples: + linked_apps/list_member_linked_apps: + value: + team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + responses: + "200": + description: "" + /team/linked_apps/list_members_linked_apps: + post: + tags: + - team + - linked_apps + summary: linked_apps/list_members_linked_apps + description: |- + [linked_apps/list_members_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_members_linked_apps) + + scope: `sessions.list` + + List all applications linked to the team members' accounts. + Note, this endpoint does not list any team-linked applications. + operationId: linkedAppsListMembersLinkedApps + requestBody: + content: + text/plain: + examples: + linked_apps/list_members_linked_apps: + value: "" + responses: + "200": + description: "" + /team/linked_apps/revoke_linked_app: + post: + tags: + - team + - linked_apps + summary: linked_apps/revoke_linked_app + description: |- + [linked_apps/revoke_linked_app](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app) + + scope: `sessions.modify` + + Revoke a linked application of the team member. + operationId: linkedAppsRevokeLinkedApp + requestBody: + content: + text/plain: + examples: + linked_apps/revoke_linked_app: + value: "" + responses: + "200": + description: "" + /team/linked_apps/revoke_linked_app_batch: + post: + tags: + - team + - linked_apps + summary: linked_apps/revoke_linked_app_batch + description: |- + [linked_apps/revoke_linked_app_batch](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app_batch) + + scope: `sessions.modify` + + Revoke a list of linked applications of the team members. + operationId: linkedAppsRevokeLinkedAppBatch + requestBody: + content: + text/plain: + examples: + linked_apps/revoke_linked_app_batch: + value: "" + responses: + "200": + description: "" + /team/member_space_limits/excluded_users/add: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/add + description: |- + [member_space_limits/excluded_users/add](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-add) + + scope: `members.write` + + Add users to member space limits excluded users list. + operationId: memberSpaceLimitsExcludedUsersAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/excluded_users_add_body' + examples: + member_space_limits/excluded_users/add: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/excluded_users/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_54' + examples: + member_space_limits/excluded_users/add response: + value: + status: + ".tag": success + /team/member_space_limits/excluded_users/list: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/list + description: |- + [member_space_limits/excluded_users/list](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list) + + scope: `members.read` + + List member space limits excluded users. + operationId: memberSpaceLimitsExcludedUsersList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/excluded_users_list_body' + examples: + member_space_limits/excluded_users/list: + value: + limit: 100 + responses: + "200": + description: member_space_limits/excluded_users/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_55' + examples: + member_space_limits/excluded_users/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + users: [] + /team/member_space_limits/excluded_users/list/continue: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/list/continue + description: |- + [member_space_limits/excluded_users/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list-continue) + + scope: `members.read` + + Continue listing member space limits excluded users. + operationId: memberSpaceLimitsExcludedUsersListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_3' + examples: + member_space_limits/excluded_users/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: member_space_limits/excluded_users/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_55' + examples: + member_space_limits/excluded_users/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + users: [] + /team/member_space_limits/excluded_users/remove: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/remove + description: |- + [member_space_limits/excluded_users/remove](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-remove) + + scope: `members.write` + + Remove users from member space limits excluded users list. + operationId: memberSpaceLimitsExcludedUsersRemove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/excluded_users_remove_body' + examples: + member_space_limits/excluded_users/remove: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/excluded_users/remove response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_54' + examples: + member_space_limits/excluded_users/remove response: + value: + status: + ".tag": success + /team/member_space_limits/get_custom_quota: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/get_custom_quota + description: |- + [member_space_limits/get_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-get_custom_quota) + + scope: `members.read` + + Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call. + operationId: memberSpaceLimitsGetCustomQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/member_space_limits_get_custom_quota_body' + examples: + member_space_limits/get_custom_quota: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/get_custom_quota response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": other + items: + $ref: '#/components/schemas/inline_response_200_44' + examples: + member_space_limits/get_custom_quota response: + value: + - ".tag": other + /team/member_space_limits/remove_custom_quota: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/remove_custom_quota + description: |- + [member_space_limits/remove_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-remove_custom_quota) + + scope: `members.write` + + Remove users custom quota. A maximum of 1000 members can be specified in a single call. + operationId: memberSpaceLimitsRemoveCustomQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/member_space_limits_remove_custom_quota_body' + examples: + member_space_limits/remove_custom_quota: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/remove_custom_quota response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": other + items: + $ref: '#/components/schemas/inline_response_200_44' + examples: + member_space_limits/remove_custom_quota response: + value: + - ".tag": other + /team/member_space_limits/set_custom_quota: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/set_custom_quota + description: |- + [member_space_limits/set_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-set_custom_quota) + + scope: `members.read` + + Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call. + operationId: memberSpaceLimitsSetCustomQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/member_space_limits_set_custom_quota_body' + examples: + member_space_limits/set_custom_quota: + value: + users_and_quotas: + - quota_gb: 30 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/set_custom_quota response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": other + items: + $ref: '#/components/schemas/inline_response_200_44' + examples: + member_space_limits/set_custom_quota response: + value: + - ".tag": other + /team/members/add: + post: + tags: + - team + - members + summary: members/add + description: |- + [members/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-add) + + scope: `members.write` + + Adds members to a team. + Permission : Team member management + A maximum of 20 members can be specified in a single call. + If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. + If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. + Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'. + operationId: membersAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_add_body_1' + examples: + members/add: + value: + force_async: false + new_members: + - member_email: tom.s@company.com + member_external_id: company_id:342432 + member_given_name: Tom + member_surname: Silverstone + role: member_only + send_welcome_email: true + responses: + "200": + description: members/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_56' + examples: + members/add response: + value: + ".tag": complete + complete: + - ".tag": success + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/add/job_status/get: + post: + tags: + - team + - members + summary: members/add/job_status/get + description: |- + [members/add/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-add-job_status-get) + + scope: `members.write` + + Once an async_job_id is returned from `members/add` , use this to poll the status of the asynchronous request. + Permission : Team member management. + operationId: membersAddJobStatusGet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_get_body_1' + examples: + members/add/job_status/get: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: members/add/job_status/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_56' + examples: + members/add/job_status/get response: + value: + ".tag": complete + complete: + - ".tag": success + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/delete_profile_photo: + post: + tags: + - team + - members + summary: members/delete_profile_photo + description: |- + [members/delete_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-delete_profile_photo) + + scope: `members.write` + + Deletes a team member's profile photo. + Permission : Team member management. + operationId: membersDeleteProfilePhoto + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_delete_profile_photo_body' + examples: + members/delete_profile_photo: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/delete_profile_photo response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_57' + examples: + members/delete_profile_photo response: + value: + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/get_info: + post: + tags: + - team + - members + summary: members/get_info + description: |- + [members/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-members-get_info) + + scope: `members.read` + + Returns information about multiple team members. + Permission : Team information + This endpoint will return `MembersGetInfoItem.id_not_found`, for IDs (or emails) that cannot be matched to a valid team member. + operationId: membersGetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_get_info_body' + examples: + members/get_info: + value: + members: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/get_info response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": member_info + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + items: + $ref: '#/components/schemas/inline_response_200_58' + examples: + members/get_info response: + value: + - ".tag": member_info + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/list: + post: + tags: + - team + - members + summary: members/list + description: |- + [members/list](https://www.dropbox.com/developers/documentation/http/teams#team-members-list) + + scope: `members.read` + + Lists members of a team. + Permission : Team information. + operationId: membersList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_list_body_1' + examples: + members/list: + value: + include_removed: false + limit: 100 + responses: + "200": + description: members/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_59' + examples: + members/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + members: + - profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/list/continue: + post: + tags: + - team + - members + summary: members/list/continue + description: |- + [members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-members-list-continue) + + scope: `members.read` + + Once a cursor has been retrieved from `members/list`, use this to paginate through all team members. + Permission : Team information. + operationId: membersListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_4' + examples: + members/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: members/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_59' + examples: + members/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + members: + - profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/move_former_member_files: + post: + tags: + - team + - members + summary: members/move_former_member_files + description: |- + [members/move_former_member_files](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files) + + scope: `members.write` + + Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/move_former_member_files/job_status/check`. + Permission : Team member management. + operationId: membersMoveFormerMemberFiles + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_move_former_member_files_body' + examples: + members/move_former_member_files: + value: + transfer_admin_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + transfer_dest_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/move_former_member_files response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/move_former_member_files response: + value: + ".tag": complete + /team/members/move_former_member_files/job_status/check: + post: + tags: + - team + - members + summary: members/move_former_member_files/job_status/check + description: |- + [members/move_former_member_files/job_status/check](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files-job_status-check) + + scope: `members.write` + + Once an async_job_id is returned from `members/move_former_member_files` , use this to poll the status of the asynchronous request. + Permission : Team member management. + operationId: membersMoveFormerMemberFilesJobStatusCheck + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_check_body' + examples: + members/move_former_member_files/job_status/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: members/move_former_member_files/job_status/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/move_former_member_files/job_status/check response: + value: + ".tag": complete + /team/members/recover: + post: + tags: + - team + - members + summary: members/recover + description: |- + [members/recover](https://www.dropbox.com/developers/documentation/http/teams#team-members-recover) + + scope: `members.delete` + + Recover a deleted member. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + operationId: membersRecover + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_recover_body' + examples: + members/recover: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: "" + /team/members/remove: + post: + tags: + - team + - members + summary: members/remove + description: |- + [members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove) + + scope: `members.delete` + + Removes a member from a team. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + Accounts can be recovered via `members/recover` for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling `members/add` while a user is still recoverable on your team will return with `MemberAddResult.user_already_on_team`. + Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams). + This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/remove/job_status/get`. + operationId: membersRemove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_remove_body_1' + examples: + members/remove: + value: + keep_account: false + retain_team_shares: false + transfer_admin_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + transfer_dest_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + wipe_data: true + responses: + "200": + description: members/remove response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/remove response: + value: + ".tag": complete + /team/members/remove/job_status/get: + post: + tags: + - team + - members + summary: members/remove/job_status/get + description: |- + [members/remove/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove-job_status-get) + + scope: `members.delete` + + Once an async_job_id is returned from `members/remove` , use this to poll the status of the asynchronous request. + Permission : Team member management. + operationId: membersRemoveJobStatusGet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_get_body_2' + examples: + members/remove/job_status/get: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: members/remove/job_status/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/remove/job_status/get response: + value: + ".tag": complete + /team/members/secondary_emails/add: + post: + tags: + - team + - members + summary: members/secondary_emails/add + description: |- + [members/secondary_emails/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-add) + + scope: `members.write` + + Add secondary emails to users. + Permission : Team member management. + Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent. + operationId: membersSecondaryEmailsAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondary_emails_add_body' + examples: + members/secondary_emails/add: + value: + new_secondary_emails: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/secondary_emails/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_60' + examples: + members/secondary_emails/add response: + value: + results: + - ".tag": success + results: + - ".tag": success + success: + email: apple@orange.com + is_verified: true + - ".tag": unavailable + unavailable: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + - ".tag": invalid_user + invalid_user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + /team/members/secondary_emails/delete: + post: + tags: + - team + - members + summary: members/secondary_emails/delete + description: |- + [members/secondary_emails/delete](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-delete) + + scope: `members.write` + + Delete secondary emails from users + Permission : Team member management. + Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email. + operationId: membersSecondaryEmailsDelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondary_emails_delete_body' + examples: + members/secondary_emails/delete: + value: + emails_to_delete: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/secondary_emails/delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_61' + examples: + members/secondary_emails/delete response: + value: + results: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + - ".tag": not_found + not_found: alic@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + /team/members/secondary_emails/resend_verification_emails: + post: + tags: + - team + - members + summary: members/secondary_emails/resend_verification_emails + description: |- + [members/secondary_emails/resend_verification_emails](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-resend_verification_emails) + + scope: `members.write` + + Resend secondary email verification emails. + Permission : Team member management. + operationId: membersSecondaryEmailsResendVerificationEmails + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondary_emails_resend_verification_emails_body' + examples: + members/secondary_emails/resend_verification_emails: + value: + emails_to_resend: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/secondary_emails/resend_verification_emails response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_62' + examples: + members/secondary_emails/resend_verification_emails response: + value: + results: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + /team/members/send_welcome_email: + post: + tags: + - team + - members + summary: members/send_welcome_email + description: |- + [members/send_welcome_email](https://www.dropbox.com/developers/documentation/http/teams#team-members-send_welcome_email) + + scope: `members.write` + + Sends welcome email to pending team member. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + No-op if team member is not pending. + operationId: membersSendWelcomeEmail + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_send_welcome_email_body' + examples: + members/send_welcome_email: + value: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: "" + /team/members/set_admin_permissions: + post: + tags: + - team + - members + summary: members/set_admin_permissions + description: |- + [members/set_admin_permissions](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_admin_permissions) + + scope: `members.write` + + Updates a team member's permissions. + Permission : Team member management. + operationId: membersSetAdminPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_admin_permissions_body' + examples: + members/set_admin_permissions: + value: + new_role: member_only + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/set_admin_permissions response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_63' + examples: + members/set_admin_permissions response: + value: + role: + ".tag": member_only + team_member_id: dbmid:9978889 + /team/members/set_profile: + post: + tags: + - team + - members + summary: members/set_profile + description: |- + [members/set_profile](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile) + + scope: `members.write` + + Updates a team member's profile. + Permission : Team member management. + operationId: membersSetProfile + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_profile_body' + examples: + members/set_profile: + value: + new_email: t.smith@domain.com + new_surname: Smith + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/set_profile response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_57' + examples: + members/set_profile response: + value: + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/set_profile_photo: + post: + tags: + - team + - members + summary: members/set_profile_photo + description: |- + [members/set_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile_photo) + + scope: `members.write` + + Updates a team member's profile photo. + Permission : Team member management. + operationId: membersSetProfilePhoto + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_profile_photo_body' + examples: + members/set_profile_photo: + value: + photo: + ".tag": base64_data + base64_data: SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/set_profile_photo response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_57' + examples: + members/set_profile_photo response: + value: + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/suspend: + post: + tags: + - team + - members + summary: members/suspend + description: |- + [members/suspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-suspend) + + scope: `members.write` + + Suspend a member from a team. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + operationId: membersSuspend + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_suspend_body' + examples: + members/suspend: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + wipe_data: false + responses: + "200": + description: "" + /team/members/unsuspend: + post: + tags: + - team + - members + summary: members/unsuspend + description: |- + [members/unsuspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-unsuspend) + + scope: `members.write` + + Unsuspend a member from a team. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + operationId: membersUnsuspend + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_unsuspend_body' + examples: + members/unsuspend: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: "" + /team/namespaces/list: + post: + tags: + - team + - namespaces + summary: namespaces/list + description: |- + [namespaces/list](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list) + + scope: `team_data.member` + + Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list. + operationId: namespacesList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/namespaces_list_body' + examples: + namespaces/list: + value: + limit: 1 + responses: + "200": + description: namespaces/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_64' + examples: + namespaces/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + namespaces: + - name: Marketing + namespace_id: "123456789" + namespace_type: + ".tag": shared_folder + - name: Franz Ferdinand + namespace_id: "123456789" + namespace_type: + ".tag": team_member_folder + team_member_id: dbmid:1234567 + /team/namespaces/list/continue: + post: + tags: + - team + - namespaces + summary: namespaces/list/continue + description: |- + [namespaces/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list-continue) + + scope: `team_data.member` + + Once a cursor has been retrieved from `namespaces/list`, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list. + operationId: namespacesListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_5' + examples: + namespaces/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: namespaces/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_64' + examples: + namespaces/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + namespaces: + - name: Marketing + namespace_id: "123456789" + namespace_type: + ".tag": shared_folder + - name: Franz Ferdinand + namespace_id: "123456789" + namespace_type: + ".tag": team_member_folder + team_member_id: dbmid:1234567 + /team/reports/get_activity: + post: + tags: + - team + - reports + summary: reports/get_activity + description: |- + [reports/get_activity](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_activity) + + scope: `team_info.read` + + Retrieves reporting data about a team's user activity. + operationId: reportsGetActivity + requestBody: + content: + text/plain: + examples: + reports/get_activity: + value: "" + responses: + "200": + description: "" + /team/reports/get_devices: + post: + tags: + - team + - reports + summary: reports/get_devices + description: |- + [reports/get_devices](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_devices) + + scope: `team_info.read` + + Retrieves reporting data about a team's linked devices. + operationId: reportsGetDevices + requestBody: + content: + text/plain: + examples: + reports/get_devices: + value: "" + responses: + "200": + description: "" + /team/reports/get_membership: + post: + tags: + - team + - reports + summary: reports/get_membership + description: |- + [reports/get_membership](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_membership) + + scope: `team_info.read` + + Retrieves reporting data about a team's membership. + operationId: reportsGetMembership + requestBody: + content: + text/plain: + examples: + reports/get_membership: + value: "" + responses: + "200": + description: "" + /team/reports/get_storage: + post: + tags: + - team + - reports + summary: reports/get_storage + description: |- + [reports/get_storage](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_storage) + + scope: `team_info.read` + + Retrieves reporting data about a team's storage usage. + operationId: reportsGetStorage + requestBody: + content: + text/plain: + examples: + reports/get_storage: + value: "" + responses: + "200": + description: "" + /team/team_folder/activate: + post: + tags: + - team + - team_folder + summary: team_folder/activate + description: |- + [team_folder/activate](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-activate) + + scope: `team_data.team_space` + + Sets an archived team folder's status to active. + Permission : Team member file access. + operationId: teamFolderActivate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_activate_body' + examples: + team_folder/activate: + value: + team_folder_id: "123456789" + responses: + "200": + description: team_folder/activate response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/activate response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/archive: + post: + tags: + - team + - team_folder + summary: team_folder/archive + description: |- + [team_folder/archive](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive) + + scope: `team_data.team_space` + + Sets an active team folder's status to archived and removes all folder and file members. + Permission : Team member file access. + operationId: teamFolderArchive + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_archive_body' + examples: + team_folder/archive: + value: + force_async_off: false + team_folder_id: "123456789" + responses: + "200": + description: team_folder/archive response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_66' + examples: + team_folder/archive response: + value: + ".tag": complete + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/archive/check: + post: + tags: + - team + - team_folder + summary: team_folder/archive/check + description: |- + [team_folder/archive/check](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive-check) + + scope: `team_data.team_space` + + Returns the status of an asynchronous job for archiving a team folder. + Permission : Team member file access. + operationId: teamFolderArchiveCheck + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/archive_check_body' + examples: + team_folder/archive/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: team_folder/archive/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_66' + examples: + team_folder/archive/check response: + value: + ".tag": complete + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/create: + post: + tags: + - team + - team_folder + summary: team_folder/create + description: |- + [team_folder/create](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-create) + + scope: `team_data.team_space` + + Creates a new, active, team folder with no members. + Permission : Team member file access. + operationId: teamFolderCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_create_body' + examples: + team_folder/create: + value: + name: Marketing + sync_setting: not_synced + responses: + "200": + description: team_folder/create response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/create response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/get_info: + post: + tags: + - team + - team_folder + summary: team_folder/get_info + description: |- + [team_folder/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-get_info) + + scope: `team_data.team_space` + + Retrieves metadata for team folders. + Permission : Team member file access. + operationId: teamFolderGetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_get_info_body' + examples: + team_folder/get_info: + value: + team_folder_ids: + - "947182" + - "5819424" + - "852307532" + responses: + "200": + description: "" + /team/team_folder/list: + post: + tags: + - team + - team_folder + summary: team_folder/list + description: |- + [team_folder/list](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list) + + scope: `team_data.team_space` + + Lists all team folders. + Permission : Team member file access. + operationId: teamFolderList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_list_body' + examples: + team_folder/list: + value: + limit: 100 + responses: + "200": + description: team_folder/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_67' + examples: + team_folder/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + team_folders: + - content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/list/continue: + post: + tags: + - team + - team_folder + summary: team_folder/list/continue + description: |- + [team_folder/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list-continue) + + scope: `team_data.team_space` + + Once a cursor has been retrieved from `team_folder/list`, use this to paginate through all team folders. + Permission : Team member file access. + operationId: teamFolderListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_6' + examples: + team_folder/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: team_folder/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_67' + examples: + team_folder/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + team_folders: + - content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/permanently_delete: + post: + tags: + - team + - team_folder + summary: team_folder/permanently_delete + description: |- + [team_folder/permanently_delete](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-permanently_delete) + + scope: `team_data.team_space` + + Permanently deletes an archived team folder. + Permission : Team member file access. + operationId: teamFolderPermanentlyDelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_permanently_delete_body' + examples: + team_folder/permanently_delete: + value: + team_folder_id: "123456789" + responses: + "200": + description: "" + /team/team_folder/rename: + post: + tags: + - team + - team_folder + summary: team_folder/rename + description: |- + [team_folder/rename](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-rename) + + scope: `team_data.team_space` + + Changes an active team folder's name. + Permission : Team member file access. + operationId: teamFolderRename + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_rename_body' + examples: + team_folder/rename: + value: + name: Sales + team_folder_id: "123456789" + responses: + "200": + description: team_folder/rename response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/rename response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/update_sync_settings: + post: + tags: + - team + - team_folder + summary: team_folder/update_sync_settings + description: |- + [team_folder/update_sync_settings](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-update_sync_settings) + + scope: `team_data.team_space` + + Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled. + operationId: teamFolderUpdateSyncSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_update_sync_settings_body' + examples: + team_folder/update_sync_settings: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: not_synced + sync_setting: not_synced + team_folder_id: "123456789" + responses: + "200": + description: team_folder/update_sync_settings response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/update_sync_settings response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/features/get_values: + post: + tags: + - team + summary: features/get_values + description: |- + [features/get_values](https://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) + + scope: `team_info.read` + + Get the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features. + Permission : Team information. + operationId: featuresGetValues + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/features_get_values_body' + examples: + features/get_values: + value: + features: + - ".tag": upload_api_rate_limit + - ".tag": has_team_shared_dropbox + responses: + "200": + description: features/get_values response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_68' + examples: + features/get_values response: + value: + values: + - ".tag": upload_api_rate_limit + upload_api_rate_limit: + ".tag": limit + limit: 25000 + - ".tag": has_team_shared_dropbox + has_team_shared_dropbox: + ".tag": has_team_shared_dropbox + has_team_shared_dropbox: false + /team/get_info: + post: + tags: + - team + summary: get_info + description: |- + [get_info](https://www.dropbox.com/developers/documentation/http/teams#team-get_info) + + scope: `team_info.read` + + Retrieves information about a team. + operationId: getInfo + responses: + "200": + description: get_info response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_69' + examples: + get_info response: + value: + name: Dropbox Inc. + num_licensed_users: 5 + num_provisioned_users: 2 + policies: + emm_state: + ".tag": disabled + office_addin: + ".tag": disabled + sharing: + shared_folder_join_policy: + ".tag": from_anyone + shared_folder_member_policy: + ".tag": team + shared_link_create_policy: + ".tag": team_only + team_id: dbtid:1234abcd + security: + - bearerAuth: [] + /team/token/get_authenticated_admin: + post: + tags: + - team + summary: token/get_authenticated_admin + description: |- + [token/get_authenticated_admin](https://www.dropbox.com/developers/documentation/http/teams#team-token-get_authenticated_admin) + + scope: `team_info.read` + + Returns the member profile of the admin who generated the team access token used to make the call. + operationId: tokenGetAuthenticatedAdmin + responses: + "200": + description: token/get_authenticated_admin response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_70' + examples: + token/get_authenticated_admin response: + value: + admin_profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + /team_log/get_events: + post: + tags: + - team_log + summary: get_events + description: |- + [get_events](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events) + + scope: `events.read` + + Retrieves team events. If the result's `GetTeamEventsResult.has_more` field is `true`, call `get_events/continue` with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll `get_events/continue` for new events. + Many attributes note 'may be missing due to historical data gap'. + Note that the file_operations category and & analogous paper events are not available on all Dropbox Business [plans](http://www.dropbox.com/business/plans-comparison). Use [features/get_values](http://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) to check for this feature. + Permission : Team Auditing. + operationId: getEvents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_log_get_events_body' + examples: + get_events: + value: + category: groups + limit: 50 + responses: + "200": + description: get_events response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_71' + examples: + get_events response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + events: + - actor: + ".tag": user + user: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + assets: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + context: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + details: + ".tag": shared_content_download_details + shared_content_access_level: + ".tag": viewer_no_comment + shared_content_link: abc + shared_content_owner: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + event_category: + ".tag": tfa + event_type: + ".tag": shared_content_download + description: (sharing) Downloaded shared file/folder + involve_non_team_member: true + origin: + access_method: + ".tag": end_user + end_user: + ".tag": web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + city: San Francisco + country: US + ip_address: 45.56.78.100 + region: California + participants: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + timestamp: 2017-01-25T15:51:30Z + has_more: false + security: + - bearerAuth: [] + /team_log/get_events/continue: + post: + tags: + - team_log + summary: get_events/continue + description: |- + [get_events/continue](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events-continue) + + scope: `events.read` + + Once a cursor has been retrieved from `get_events`, use this to paginate through all events. + Permission : Team Auditing. + operationId: getEventsContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/get_events_continue_body' + examples: + get_events/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: get_events/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_71' + examples: + get_events/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + events: + - actor: + ".tag": user + user: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + assets: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + context: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + details: + ".tag": shared_content_download_details + shared_content_access_level: + ".tag": viewer_no_comment + shared_content_link: abc + shared_content_owner: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + event_category: + ".tag": tfa + event_type: + ".tag": shared_content_download + description: (sharing) Downloaded shared file/folder + involve_non_team_member: true + origin: + access_method: + ".tag": end_user + end_user: + ".tag": web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + city: San Francisco + country: US + ip_address: 45.56.78.100 + region: California + participants: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + timestamp: 2017-01-25T15:51:30Z + has_more: false + security: + - bearerAuth: [] + /users/features/get_values: + post: + tags: + - users + summary: features/get_values + description: |- + [features/get_values](https://www.dropbox.com/developers/documentation/http/documentation#users-features-get_values) + + scope: `account_info.read` + + Get a list of feature values that may be configured for the current account. + operationId: featuresGetValues1 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/features_get_values_body_1' + examples: + features/get_values: + value: + features: + - ".tag": paper_as_files + - ".tag": file_locking + responses: + "200": + description: features/get_values response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_72' + examples: + features/get_values response: + value: + values: + - ".tag": paper_as_files + paper_as_files: + ".tag": enabled + enabled: true + /users/get_account: + post: + tags: + - users + summary: get_account + description: |- + [get_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account) + + scope: `sharing.read` + + Get information about a user's account. + operationId: getAccount + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/users_get_account_body' + examples: + get_account: + value: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + responses: + "200": + description: get_account response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_73' + examples: + get_account response: + value: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: false + email: franz@dropbox.com + email_verified: true + is_teammate: false + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /users/get_account_batch: + post: + tags: + - users + summary: get_account_batch + description: |- + [get_account_batch](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account_batch) + + scope: `sharing.read` + + Get information about multiple user accounts. At most 300 accounts may be queried per request. + operationId: getAccountBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/users_get_account_batch_body' + examples: + get_account_batch: + value: + account_ids: + - dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + - dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ + responses: + "200": + description: get_account_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: false + email: franz@dropbox.com + email_verified: true + is_teammate: false + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + items: + $ref: '#/components/schemas/inline_response_200_74' + examples: + get_account_batch response: + value: + - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: false + email: franz@dropbox.com + email_verified: true + is_teammate: false + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /users/get_current_account: + post: + tags: + - users + summary: get_current_account + description: |- + [get_current_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account) + + scope: `account_info.read` + + Get information about the current user's account. + operationId: getCurrentAccount + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: get_current_account response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_75' + examples: + get_current_account response: + value: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + account_type: + ".tag": business + country: US + disabled: false + email: franz@dropbox.com + email_verified: true + is_paired: true + locale: en + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + referral_link: https://db.tt/ZITNuhtI + root_info: + ".tag": user + home_namespace_id: "3235641" + root_namespace_id: "3235641" + team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + office_addin_policy: + ".tag": disabled + sharing_policies: + shared_folder_join_policy: + ".tag": from_anyone + shared_folder_member_policy: + ".tag": team + shared_link_create_policy: + ".tag": team_only + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + /users/get_space_usage: + post: + tags: + - users + summary: get_space_usage + description: |- + [get_space_usage](https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage) + + scope: `account_info.read` + + Get the space usage information for the current user's account. + operationId: getSpaceUsage + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: get_space_usage response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_76' + examples: + get_space_usage response: + value: + allocation: + ".tag": individual + allocated: 10000000000 + used: 314159265 +components: + schemas: + Photo: + type: object + properties: + ".tag": + type: string + example: base64_data + base64_data: + type: string + example: SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + SetProfilePhotoRequest: + type: object + properties: + photo: + $ref: '#/components/schemas/Photo' + SetProfilePhotoResponse: + type: object + properties: + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + TokenFromOauth1Request: + type: object + properties: + oauth1_token: + type: string + example: qievr8hamyg6ndck + oauth1_token_secret: + type: string + example: qomoftv0472git7 + TokenFromOauth1Response: + type: object + properties: + oauth2_token: + type: string + example: 9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn + CheckAppRequest: + type: object + properties: + query: + type: string + example: foo + inline_response_200: + type: object + properties: + result: + type: string + example: foo + CheckUserRequest: + type: object + properties: + query: + type: string + example: foo + DeleteManualContactsBatchRequest: + type: object + properties: + email_addresses: + type: array + example: + - contactemailaddress1@domain.com + - contactemailaddress2@domain.com + items: + type: string + example: contactemailaddress1@domain.com + PropertyField: + type: object + properties: + name: + type: string + example: Security Policy + value: + type: string + example: Confidential + PropertyGroup: + type: object + properties: + fields: + type: array + example: + - name: Security Policy + value: Confidential + items: + $ref: '#/components/schemas/PropertyField' + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + AddPropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + OverwritePropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + RemovePropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + property_template_ids: + type: array + example: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + SearchPropertiesMode: + type: object + properties: + ".tag": + type: string + example: field_name + field_name: + type: string + example: Security + SearchPropertiesQuery: + type: object + properties: + logical_operator: + type: string + example: or_operator + mode: + $ref: '#/components/schemas/SearchPropertiesMode' + query: + type: string + example: Confidential + SearchPropertiesRequest: + type: object + properties: + queries: + type: array + example: + - logical_operator: or_operator + mode: + ".tag": field_name + field_name: Security + query: Confidential + items: + $ref: '#/components/schemas/SearchPropertiesQuery' + template_filter: + type: string + example: filter_none + inline_response_200_1: + type: object + properties: + matches: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: false + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/inline_response_200_1_matches' + SearchPropertiesContinueRequest: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + PropertyGroupsUpdate: + type: object + properties: + add_or_update_fields: + type: array + example: + - name: Security Policy + value: Confidential + items: + $ref: '#/components/schemas/PropertyField' + remove_fields: + type: array + example: [] + items: {} + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + UpdatePropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + update_property_groups: + type: array + example: + - add_or_update_fields: + - name: Security Policy + value: Confidential + remove_fields: [] + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroupsUpdate' + PropertyFieldTemplate: + type: object + properties: + description: + type: string + example: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: + type: string + example: Security Policy + type: + type: string + example: string + AddTemplateForTeam: + type: object + properties: + description: + type: string + example: These properties describe how confidential this file or folder + is. + fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + name: + type: string + example: Security + inline_response_200_2: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + AddTemplateForUser: + type: object + properties: + description: + type: string + example: These properties describe how confidential this file or folder + is. + fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + name: + type: string + example: Security + GetTemplateForTeam: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + inline_response_200_3: + type: object + properties: + description: + type: string + example: These properties describe how confidential this file or folder + is. + fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: + ".tag": string + items: + $ref: '#/components/schemas/inline_response_200_3_fields' + name: + type: string + example: Security + GetTemplateForUserRequest: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + inline_response_200_4: + type: object + properties: + template_ids: + type: array + example: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + RemoveTemplateForTeamRequest: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + TemplateId: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + templates_update_for_team_body: + type: object + properties: + add_fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + description: + type: string + example: These properties will describe how confidential this file or folder + is. + name: + type: string + example: New Security Template Name + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + templates_update_for_user_body: + type: object + properties: + add_fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + description: + type: string + example: These properties will describe how confidential this file or folder + is. + name: + type: string + example: New Security Template Name + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + inline_response_200_5: + type: object + properties: + file_request_count: + type: number + example: 15 + file_requestscreate_deadline: + type: object + properties: + allow_late_uploads: + type: string + example: seven_days + deadline: + type: string + example: 2020-10-12T17:00:00Z + file_requests_create_body: + type: object + properties: + deadline: + $ref: '#/components/schemas/file_requestscreate_deadline' + destination: + type: string + example: /File Requests/Homework + open: + type: boolean + example: true + title: + type: string + example: Homework submission + inline_response_200_6: + type: object + properties: + created: + type: string + example: 2015-10-05T17:00:00Z + deadline: + $ref: '#/components/schemas/inline_response_200_6_deadline' + destination: + type: string + example: /File Requests/Homework + file_count: + type: number + example: 3 + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + is_open: + type: boolean + example: true + title: + type: string + example: Homework submission + url: + type: string + example: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + file_requests_delete_body: + type: object + properties: + ids: + type: array + example: + - oaCAVmEyrqYnkZX9955Y + - BaZmehYoXMPtaRmfTbSG + items: + type: string + example: oaCAVmEyrqYnkZX9955Y + inline_response_200_7: + type: object + properties: + file_requests: + type: array + example: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + items: + $ref: '#/components/schemas/inline_response_200_7_file_requests' + file_requests_get_body: + type: object + properties: + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + file_requests_list_v2_body: + type: object + properties: + limit: + type: number + example: 1000 + inline_response_200_8: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requests: + type: array + example: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + items: + $ref: '#/components/schemas/inline_response_200_7_file_requests' + has_more: + type: boolean + example: true + list_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requestsupdate_deadline: + type: object + properties: + ".tag": + type: string + example: update + allow_late_uploads: + type: string + example: seven_days + deadline: + type: string + example: 2020-10-12T17:00:00Z + file_requests_update_body: + type: object + properties: + deadline: + $ref: '#/components/schemas/file_requestsupdate_deadline' + destination: + type: string + example: /File Requests/Homework + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + open: + type: boolean + example: true + title: + type: string + example: Homework submission + files_copy_v2_body: + type: object + properties: + allow_ownership_transfer: + type: boolean + example: false + allow_shared_folder: + type: boolean + example: false + autorename: + type: boolean + example: false + from_path: + type: string + example: /Homework/math + to_path: + type: string + example: /Homework/algebra + inline_response_200_9: + type: object + properties: + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + filescopy_batch_v2_entries: + type: object + properties: + from_path: + type: string + example: /Homework/math + to_path: + type: string + example: /Homework/algebra + files_copy_batch_v2_body: + type: object + properties: + autorename: + type: boolean + example: false + entries: + type: array + example: + - from_path: /Homework/math + to_path: /Homework/algebra + items: + $ref: '#/components/schemas/filescopy_batch_v2_entries' + inline_response_200_10: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_10_entries' + copy_batch_check_v2_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + copy_reference_get_body: + type: object + properties: + path: + type: string + example: /video.mp4 + inline_response_200_11: + type: object + properties: + copy_reference: + type: string + example: z1X6ATl6aWtzOGq0c3g5Ng + expires: + type: string + example: 2045-05-12T15:50:38Z + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + copy_reference_save_body: + type: object + properties: + copy_reference: + type: string + example: z1X6ATl6aWtzOGq0c3g5Ng + path: + type: string + example: /video.mp4 + files_create_folder_v2_body: + type: object + properties: + autorename: + type: boolean + example: false + path: + type: string + example: /Homework/math + inline_response_200_12: + type: object + properties: + metadata: + $ref: '#/components/schemas/inline_response_200_12_metadata' + files_create_folder_batch_body: + type: object + properties: + autorename: + type: boolean + example: false + force_async: + type: boolean + example: false + paths: + type: array + example: + - /Homework/math + items: + type: string + example: /Homework/math + inline_response_200_13: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + items: + $ref: '#/components/schemas/inline_response_200_13_entries' + create_folder_batch_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + files_delete_v2_body: + type: object + properties: + path: + type: string + example: /Homework/math/Prime_Numbers.txt + files_delete_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /Homework/math/Prime_Numbers.txt + items: + $ref: '#/components/schemas/files_delete_v2_body' + inline_response_200_14: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_14_entries' + delete_batch_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_15: + type: object + properties: + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_16: + type: object + properties: + export_metadata: + $ref: '#/components/schemas/inline_response_200_16_export_metadata' + file_metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + filesget_file_lock_batch_entries: + type: object + properties: + path: + type: string + example: /John Doe/sample/test.pdf + files_get_file_lock_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /John Doe/sample/test.pdf + items: + $ref: '#/components/schemas/filesget_file_lock_batch_entries' + inline_response_200_17: + type: object + properties: + entries: + type: array + example: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_17_entries' + files_get_metadata_body: + type: object + properties: + include_deleted: + type: boolean + example: false + include_has_explicit_shared_members: + type: boolean + example: false + include_media_info: + type: boolean + example: false + path: + type: string + example: /Homework/math + inline_response_200_18: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + files_get_temporary_link_body: + type: object + properties: + path: + type: string + example: /video.mp4 + inline_response_200_19: + type: object + properties: + link: + type: string + example: https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 + metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + filesget_temporary_upload_link_commit_info: + type: object + properties: + autorename: + type: boolean + example: true + mode: + type: string + example: add + mute: + type: boolean + example: false + path: + type: string + example: /Homework/math/Matrices.txt + strict_conflict: + type: boolean + example: false + files_get_temporary_upload_link_body: + type: object + properties: + commit_info: + $ref: '#/components/schemas/filesget_temporary_upload_link_commit_info' + duration: + type: number + example: 3600 + inline_response_200_20: + type: object + properties: + link: + type: string + example: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + inline_response_200_21: + type: object + properties: + file_metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + filesget_thumbnail_batch_entries: + type: object + properties: + format: + type: string + example: jpeg + mode: + type: string + example: strict + path: + type: string + example: /image.jpg + size: + type: string + example: w64h64 + files_get_thumbnail_batch_body: + type: object + properties: + entries: + type: array + example: + - format: jpeg + mode: strict + path: /image.jpg + size: w64h64 + items: + $ref: '#/components/schemas/filesget_thumbnail_batch_entries' + inline_response_200_22: + type: object + properties: + entries: + type: array + example: + - ".tag": success + metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= + items: + $ref: '#/components/schemas/inline_response_200_22_entries' + files_list_folder_body: + type: object + properties: + include_deleted: + type: boolean + example: false + include_has_explicit_shared_members: + type: boolean + example: false + include_media_info: + type: boolean + example: false + include_mounted_folders: + type: boolean + example: true + include_non_downloadable_files: + type: boolean + example: true + path: + type: string + example: /Homework/math + recursive: + type: boolean + example: false + inline_response_200_23: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + type: array + example: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + - ".tag": folder + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + items: + $ref: '#/components/schemas/inline_response_200_23_entries' + has_more: + type: boolean + example: false + list_folder_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + list_folder_get_latest_cursor_body: + type: object + properties: + include_deleted: + type: boolean + example: false + include_has_explicit_shared_members: + type: boolean + example: false + include_media_info: + type: boolean + example: false + include_mounted_folders: + type: boolean + example: true + include_non_downloadable_files: + type: boolean + example: true + path: + type: string + example: /Homework/math + recursive: + type: boolean + example: false + list_folder_longpoll_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + timeout: + type: number + example: 30 + inline_response_200_24: + type: object + properties: + changes: + type: boolean + example: true + files_list_revisions_body: + type: object + properties: + limit: + type: number + example: 10 + mode: + type: string + example: path + path: + type: string + example: /root/word.docx + inline_response_200_25: + type: object + properties: + entries: + type: array + example: + - client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + is_deleted: + type: boolean + example: false + files_lock_file_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /John Doe/sample/test.pdf + items: + $ref: '#/components/schemas/filesget_file_lock_batch_entries' + files_move_v2_body: + type: object + properties: + allow_ownership_transfer: + type: boolean + example: false + allow_shared_folder: + type: boolean + example: false + autorename: + type: boolean + example: false + from_path: + type: string + example: /Homework/math + to_path: + type: string + example: /Homework/algebra + files_move_batch_v2_body: + type: object + properties: + allow_ownership_transfer: + type: boolean + example: false + autorename: + type: boolean + example: false + entries: + type: array + example: + - from_path: /Homework/math + to_path: /Homework/algebra + items: + $ref: '#/components/schemas/filescopy_batch_v2_entries' + move_batch_check_v2_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + files_permanently_delete_body: + type: object + properties: + path: + type: string + example: /Homework/math/Prime_Numbers.txt + files_restore_body: + type: object + properties: + path: + type: string + example: /root/word.docx + rev: + type: string + example: a1c10ce0dd78 + files_save_url_body: + type: object + properties: + path: + type: string + example: /a.txt + url: + type: string + example: http://example.com/a.txt + inline_response_200_26: + type: object + properties: + ".tag": + type: string + example: complete + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + save_url_check_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_27: + type: object + properties: + ".tag": + type: string + example: in_progress + files_search_v2_body: + type: object + properties: + include_highlights: + type: boolean + example: false + query: + type: string + example: cat + inline_response_200_28: + type: object + properties: + has_more: + type: boolean + example: false + matches: + type: array + example: + - metadata: + ".tag": metadata + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_28_matches' + search_continue_v2_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + files_unlock_file_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /John Doe/sample/test.pdf + items: + $ref: '#/components/schemas/filesget_file_lock_batch_entries' + filesupload_sessionfinish_batch_cursor: + type: object + properties: + offset: + type: number + example: 0 + session_id: + type: string + example: 1234faaf0678bcde + filesupload_sessionfinish_batch_entries: + type: object + properties: + commit: + $ref: '#/components/schemas/filesget_temporary_upload_link_commit_info' + cursor: + $ref: '#/components/schemas/filesupload_sessionfinish_batch_cursor' + upload_session_finish_batch_body: + type: object + properties: + entries: + type: array + example: + - commit: + autorename: true + mode: add + mute: false + path: /Homework/math/Matrices.txt + strict_conflict: false + cursor: + offset: 0 + session_id: 1234faaf0678bcde + items: + $ref: '#/components/schemas/filesupload_sessionfinish_batch_entries' + inline_response_200_29: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_29_entries' + finish_batch_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_30: + type: object + properties: + session_id: + type: string + example: 1234faaf0678bcde + sharingadd_file_member_members: + type: object + properties: + ".tag": + type: string + example: email + email: + type: string + example: justin@example.com + sharing_add_file_member_body: + type: object + properties: + access_level: + type: string + example: viewer + add_message_as_comment: + type: boolean + example: false + custom_message: + type: string + example: This is a custom message about ACME.doc + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + members: + type: array + example: + - ".tag": email + email: justin@example.com + items: + $ref: '#/components/schemas/sharingadd_file_member_members' + quiet: + type: boolean + example: false + sharingadd_file_member_result: + type: object + properties: + ".tag": + type: string + example: success + inline_response_200_31: + type: object + properties: + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + result: + $ref: '#/components/schemas/sharingadd_file_member_result' + sharingadd_folder_member_member: + type: object + properties: + ".tag": + type: string + example: email + dropbox_id: + type: string + example: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + email: + type: string + example: justin@example.com + sharingadd_folder_member_members: + type: object + properties: + access_level: + type: string + example: editor + member: + $ref: '#/components/schemas/sharingadd_folder_member_member' + sharing_add_folder_member_body: + type: object + properties: + custom_message: + type: string + example: Documentation for launch day + members: + type: array + example: + - access_level: editor + member: + ".tag": email + email: justin@example.com + - access_level: viewer + member: + ".tag": dropbox_id + dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + items: + $ref: '#/components/schemas/sharingadd_folder_member_members' + quiet: + type: boolean + example: false + shared_folder_id: + type: string + example: "84528192421" + sharing_check_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + sharing_check_remove_member_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_32: + type: object + properties: + ".tag": + type: string + example: complete + sharing_check_share_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_33: + type: object + properties: + ".tag": + type: string + example: complete + access_inheritance: + $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inside_team_folder: + type: boolean + example: false + is_team_folder: + type: boolean + example: false + link_metadata: + $ref: '#/components/schemas/inline_response_200_33_link_metadata' + name: + type: string + example: dir + path_lower: + type: string + example: /dir + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: + type: string + example: "84528192421" + time_invited: + type: string + example: 2016-01-20T00:00:00Z + sharing_get_file_metadata_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + inline_response_200_34: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + id: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + name: + type: string + example: file.txt + owner_display_names: + type: array + example: + - Jane Doe + items: + type: string + example: Jane Doe + owner_team: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + path_display: + type: string + example: /dir/file.txt + path_lower: + type: string + example: /dir/file.txt + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: + type: string + example: 2016-01-20T00:00:00Z + get_file_metadata_batch_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + files: + type: array + example: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + items: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + sharingget_file_metadatabatch_result_access_type: + type: object + properties: + ".tag": + type: string + example: viewer + sharingget_file_metadatabatch_result_owner_team: + type: object + properties: + id: + type: string + example: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: + type: string + example: "Acme, Inc." + sharingget_file_metadatabatch_result_policy_acl_update_policy: + type: object + properties: + ".tag": + type: string + example: owner + sharingget_file_metadatabatch_result_policy_member_policy: + type: object + properties: + ".tag": + type: string + example: anyone + sharingget_file_metadatabatch_result_policy_resolved_member_policy: + type: object + properties: + ".tag": + type: string + example: team + sharingget_file_metadatabatch_result_policy: + type: object + properties: + acl_update_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + member_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' + resolved_member_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_resolved_member_policy' + shared_link_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' + sharingget_file_metadatabatch_result: + type: object + properties: + ".tag": + type: string + example: metadata + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + id: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + name: + type: string + example: file.txt + owner_display_names: + type: array + example: + - Jane Doe + items: + type: string + example: Jane Doe + owner_team: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + path_display: + type: string + example: /dir/file.txt + path_lower: + type: string + example: /dir/file.txt + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_35: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + result: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result' + sharing_get_folder_metadata_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + shared_folder_id: + type: string + example: "84528192421" + inline_response_200_36: + type: object + properties: + access_inheritance: + $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inside_team_folder: + type: boolean + example: false + is_team_folder: + type: boolean + example: false + link_metadata: + $ref: '#/components/schemas/inline_response_200_33_link_metadata' + name: + type: string + example: dir + path_lower: + type: string + example: /dir + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: + type: string + example: "84528192421" + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_37: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + $ref: '#/components/schemas/inline_response_200_37_link_permissions' + name: + type: string + example: Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + size: + type: number + example: 7212 + team_member_info: + $ref: '#/components/schemas/inline_response_200_37_team_member_info' + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_get_shared_link_metadata_body: + type: object + properties: + path: + type: string + example: /Prime_Numbers.txt + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_list_file_members_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + include_inherited: + type: boolean + example: true + limit: + type: number + example: 100 + inline_response_200_38: + type: object + properties: + groups: + type: array + example: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + invitees: + type: array + example: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + users: + type: array + example: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_users' + list_file_members_batch_body: + type: object + properties: + files: + type: array + example: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + items: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + limit: + type: number + example: 10 + sharinglist_file_membersbatch_result_members_access_type: + type: object + properties: + ".tag": + type: string + example: editor + sharinglist_file_membersbatch_result_members_group_group_management_type: + type: object + properties: + ".tag": + type: string + example: user_managed + sharinglist_file_membersbatch_result_members_group: + type: object + properties: + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: Test group + group_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + is_member: + type: boolean + example: false + is_owner: + type: boolean + example: false + member_count: + type: number + example: 10 + same_team: + type: boolean + example: true + sharinglist_file_membersbatch_result_members_groups: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_access_type' + group: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + sharinglist_file_membersbatch_result_members_invitee: + type: object + properties: + ".tag": + type: string + example: email + email: + type: string + example: jessica@example.com + sharinglist_file_membersbatch_result_members_invitees: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + invitee: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitee' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + sharinglist_file_membersbatch_result_members_platform_type: + type: object + properties: + ".tag": + type: string + example: unknown + sharinglist_file_membersbatch_result_members_user: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: + type: string + example: Robert Smith + email: + type: string + example: bob@example.com + same_team: + type: boolean + example: true + team_member_id: + type: string + example: dbmid:abcd1234 + sharinglist_file_membersbatch_result_members_users: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + platform_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_platform_type' + time_last_seen: + type: string + example: 2016-01-20T00:00:00Z + user: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_user' + sharinglist_file_membersbatch_result_members: + type: object + properties: + groups: + type: array + example: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + invitees: + type: array + example: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + users: + type: array + example: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_users' + sharinglist_file_membersbatch_result: + type: object + properties: + ".tag": + type: string + example: result + member_count: + type: number + example: 3 + members: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members' + inline_response_200_39: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + result: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result' + list_file_members_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + list_folder_members_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + inline_response_200_40: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + type: array + example: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + invitees: + type: array + example: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + users: + type: array + example: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/inline_response_200_40_users' + sharing_list_folders_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + limit: + type: number + example: 100 + inline_response_200_41: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + type: array + example: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + link_metadata: + audience_options: + - ".tag": public + - ".tag": team + - ".tag": members + current_audience: + ".tag": public + link_permissions: + - action: + ".tag": change_audience + allow: true + password_protected: false + url: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + items: + $ref: '#/components/schemas/inline_response_200_41_entries' + list_folders_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + sharing_list_mountable_folders_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + limit: + type: number + example: 100 + list_mountable_folders_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + sharing_list_received_files_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + limit: + type: number + example: 100 + inline_response_200_42: + type: object + properties: + cursor: + type: string + example: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + entries: + type: array + example: + - access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + owner_display_names: + - Jane Doe + owner_team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + path_display: /dir/file.txt + path_lower: /dir/file.txt + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + items: + $ref: '#/components/schemas/inline_response_200_42_entries' + list_received_files_continue_body: + type: object + properties: + cursor: + type: string + example: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId + sharing_list_shared_links_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + inline_response_200_43: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: true + links: + type: array + example: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + items: + $ref: '#/components/schemas/inline_response_200_43_links' + sharingmodify_shared_link_settings_settings: + type: object + properties: + access: + type: string + example: viewer + audience: + type: string + example: public + requested_visibility: + type: string + example: public + sharing_modify_shared_link_settings_body: + type: object + properties: + remove_expiration: + type: boolean + example: false + settings: + $ref: '#/components/schemas/sharingmodify_shared_link_settings_settings' + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_mount_folder_body: + type: object + properties: + shared_folder_id: + type: string + example: "84528192421" + sharing_relinquish_file_membership_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + sharing_relinquish_folder_membership_body: + type: object + properties: + leave_a_copy: + type: boolean + example: false + shared_folder_id: + type: string + example: "84528192421" + sharing_remove_file_member_2_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + inline_response_200_44: + type: object + properties: + ".tag": + type: string + example: other + sharing_remove_folder_member_body: + type: object + properties: + leave_a_copy: + type: boolean + example: false + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + shared_folder_id: + type: string + example: "84528192421" + inline_response_200_45: + type: object + properties: + ".tag": + type: string + example: async_job_id + async_job_id: + type: string + example: 34g93hh34h04y384084 + sharing_revoke_shared_link_body: + type: object + properties: + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_set_access_inheritance_body: + type: object + properties: + access_inheritance: + type: string + example: inherit + shared_folder_id: + type: string + example: "84528192421" + sharing_share_folder_body: + type: object + properties: + access_inheritance: + type: string + example: inherit + acl_update_policy: + type: string + example: editors + force_async: + type: boolean + example: false + member_policy: + type: string + example: team + path: + type: string + example: /example/workspace + shared_link_policy: + type: string + example: members + sharing_transfer_folder_body: + type: object + properties: + shared_folder_id: + type: string + example: "84528192421" + to_dropbox_id: + type: string + example: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + sharing_unmount_folder_body: + type: object + properties: + shared_folder_id: + type: string + example: "84528192421" + sharing_unshare_file_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + sharing_unshare_folder_body: + type: object + properties: + leave_a_copy: + type: boolean + example: false + shared_folder_id: + type: string + example: "84528192421" + sharing_update_file_member_body: + type: object + properties: + access_level: + type: string + example: viewer + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + sharing_update_folder_member_body: + type: object + properties: + access_level: + type: string + example: editor + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + shared_folder_id: + type: string + example: "84528192421" + sharing_update_folder_policy_body: + type: object + properties: + acl_update_policy: + type: string + example: owner + member_policy: + type: string + example: team + shared_folder_id: + type: string + example: "84528192421" + shared_link_policy: + type: string + example: members + devices_list_member_devices_body: + type: object + properties: + include_desktop_clients: + type: boolean + example: true + include_mobile_clients: + type: boolean + example: true + include_web_sessions: + type: boolean + example: true + team_member_id: + type: string + example: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + devices_revoke_device_session_body: + type: object + properties: + ".tag": + type: string + example: web_session + session_id: + type: string + example: 1234faaf0678bcde + team_member_id: + type: string + example: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + devices_revoke_device_session_batch_body: + type: object + properties: + revoke_devices: + type: array + example: + - ".tag": web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + items: + $ref: '#/components/schemas/devices_revoke_device_session_body' + groups_create_body: + type: object + properties: + add_creator_as_owner: + type: boolean + example: false + group_external_id: + type: string + example: group-134 + group_name: + type: string + example: Europe sales + inline_response_200_46: + type: object + properties: + created: + type: number + example: 1447255518000 + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: project launch + member_count: + type: number + example: 5 + members: + type: array + example: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/teamgroupsget_info_members' + groups_delete_body: + type: object + properties: + ".tag": + type: string + example: group_id + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + groups_get_info_body: + type: object + properties: + ".tag": + type: string + example: group_ids + group_ids: + type: array + example: + - g:e2db7665347abcd600000000001a2b3c + - g:111111147abcd6000000000222222c + items: + type: string + example: g:e2db7665347abcd600000000001a2b3c + teamgroupsget_info_access_type: + type: object + properties: + ".tag": + type: string + example: member + teamgroupsget_info_profile_membership_type: + type: object + properties: + ".tag": + type: string + example: full + teamgroupsget_info_profile_name: + type: object + properties: + abbreviated_name: + type: string + example: FF + display_name: + type: string + example: Franz Ferdinand (Personal) + familiar_name: + type: string + example: Franz + given_name: + type: string + example: Franz + surname: + type: string + example: Ferdinand + teamgroupsget_info_profile_secondary_emails: + type: object + properties: + email: + type: string + example: apple@orange.com + is_verified: + type: boolean + example: true + teamgroupsget_info_profile_status: + type: object + properties: + ".tag": + type: string + example: active + teamgroupsget_info_profile: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: + type: string + example: mary@lamb.com + email_verified: + type: boolean + example: true + joined_on: + type: string + example: 2015-05-12T15:50:38Z + membership_type: + $ref: '#/components/schemas/teamgroupsget_info_profile_membership_type' + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + type: array + example: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + items: + $ref: '#/components/schemas/teamgroupsget_info_profile_secondary_emails' + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + team_member_id: + type: string + example: dbmid:1234567 + teamgroupsget_info_members: + type: object + properties: + access_type: + $ref: '#/components/schemas/teamgroupsget_info_access_type' + profile: + $ref: '#/components/schemas/teamgroupsget_info_profile' + inline_response_200_47: + type: object + properties: + ".tag": + type: string + example: group_info + created: + type: number + example: 1447255518000 + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: project launch + member_count: + type: number + example: 5 + members: + type: array + example: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/teamgroupsget_info_members' + job_status_get_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + groups_list_body: + type: object + properties: + limit: + type: number + example: 100 + inline_response_200_48: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + type: array + example: + - group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + member_count: 10 + items: + $ref: '#/components/schemas/inline_response_200_48_groups' + has_more: + type: boolean + example: false + list_continue_body_1: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + teamgroupsmembersadd_user: + type: object + properties: + ".tag": + type: string + example: team_member_id + team_member_id: + type: string + example: dbmid:efgh5678 + teamgroupsmembersadd_members: + type: object + properties: + access_type: + type: string + example: member + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + members_add_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + members: + type: array + example: + - access_type: member + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_members' + return_members: + type: boolean + example: true + inline_response_200_49: + type: object + properties: + async_job_id: + type: string + example: "99988877733388" + group_info: + $ref: '#/components/schemas/inline_response_200_49_group_info' + members_list_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + limit: + type: number + example: 100 + inline_response_200_50: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + members: + type: array + example: [] + items: {} + list_continue_body_2: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + members_remove_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + return_members: + type: boolean + example: true + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + members_set_access_type_body: + type: object + properties: + access_type: + type: string + example: member + group: + $ref: '#/components/schemas/groups_delete_body' + return_members: + type: boolean + example: true + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + groups_update_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + new_group_external_id: + type: string + example: sales-234 + new_group_management_type: + type: string + example: company_managed + new_group_name: + type: string + example: Europe west sales + return_members: + type: boolean + example: true + legal_holds_create_policy_body: + type: object + properties: + end_date: + type: string + example: 2017-12-31T00:00:00Z + members: + type: array + example: + - dbmid:FDFSVF-DFSDF + items: + type: string + example: dbmid:FDFSVF-DFSDF + name: + type: string + example: acme cfo policy + start_date: + type: string + example: 2016-01-01T00:00:00Z + inline_response_200_51: + type: object + properties: + activation_time: + type: string + example: 2016-01-20T00:00:10Z + end_date: + type: string + example: 2017-12-31T00:00:00Z + id: + type: string + example: pid_dbhid:abcd1234 + members: + $ref: '#/components/schemas/inline_response_200_51_members' + name: + type: string + example: acme cfo policy + start_date: + type: string + example: 2016-01-01T00:00:00Z + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + legal_holds_get_policy_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + legal_holds_list_held_revisions_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + inline_response_200_52: + type: object + properties: + entries: + type: array + example: + - author_email: a@a.com + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + ".tag": active + content_hash: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: Document + new_filename: 111_222.pdf + original_file_path: /a.pdf + original_revision_id: ab2rij4i5ojgfd + server_modified: 2019-08-12T12:08:52Z + size: 3 + items: + $ref: '#/components/schemas/inline_response_200_52_entries' + has_more: + type: boolean + example: false + legal_holds_list_held_revisions_continue_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + legal_holds_list_policies_body: + type: object + properties: + include_released: + type: boolean + example: false + inline_response_200_53: + type: object + properties: + policies: + type: array + example: + - activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + items: + $ref: '#/components/schemas/inline_response_200_53_policies' + legal_holds_release_policy_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + legal_holds_update_policy_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + members: + type: array + example: + - dbmid:FDFSVF-DFSDF + items: + type: string + example: dbmid:FDFSVF-DFSDF + linked_apps_list_member_linked_apps_body: + type: object + properties: + team_member_id: + type: string + example: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + excluded_users_add_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + inline_response_200_54: + type: object + properties: + status: + $ref: '#/components/schemas/sharingadd_file_member_result' + excluded_users_list_body: + type: object + properties: + limit: + type: number + example: 100 + inline_response_200_55: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + users: + type: array + example: [] + items: {} + list_continue_body_3: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + excluded_users_remove_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + member_space_limits_get_custom_quota_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + member_space_limits_remove_custom_quota_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + teammember_space_limitsset_custom_quota_users_and_quotas: + type: object + properties: + quota_gb: + type: number + example: 30 + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + member_space_limits_set_custom_quota_body: + type: object + properties: + users_and_quotas: + type: array + example: + - quota_gb: 30 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammember_space_limitsset_custom_quota_users_and_quotas' + teammembersadd_new_members: + type: object + properties: + member_email: + type: string + example: tom.s@company.com + member_external_id: + type: string + example: company_id:342432 + member_given_name: + type: string + example: Tom + member_surname: + type: string + example: Silverstone + role: + type: string + example: member_only + send_welcome_email: + type: boolean + example: true + members_add_body_1: + type: object + properties: + force_async: + type: boolean + example: false + new_members: + type: array + example: + - member_email: tom.s@company.com + member_external_id: company_id:342432 + member_given_name: Tom + member_surname: Silverstone + role: member_only + send_welcome_email: true + items: + $ref: '#/components/schemas/teammembersadd_new_members' + inline_response_200_56: + type: object + properties: + ".tag": + type: string + example: complete + complete: + type: array + example: + - ".tag": success + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + items: + $ref: '#/components/schemas/inline_response_200_56_complete' + job_status_get_body_1: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + members_delete_profile_photo_body: + type: object + properties: + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + inline_response_200_57: + type: object + properties: + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + members_get_info_body: + type: object + properties: + members: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + teammembersget_info_profile_secondary_emails: + type: object + properties: + email: + type: string + example: grape@strawberry.com + is_verified: + type: boolean + example: false + teammembersget_info_profile: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: + type: string + example: tami@seagull.com + email_verified: + type: boolean + example: false + external_id: + type: string + example: "244423" + groups: + type: array + example: + - g:e2db7665347abcd600000000001a2b3c + items: + type: string + example: g:e2db7665347abcd600000000001a2b3c + joined_on: + type: string + example: 2015-05-12T15:50:38Z + member_folder_id: + type: string + example: "20" + membership_type: + $ref: '#/components/schemas/teamgroupsget_info_profile_membership_type' + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + type: array + example: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + items: + $ref: '#/components/schemas/teammembersget_info_profile_secondary_emails' + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + team_member_id: + type: string + example: dbmid:FDFSVF-DFSDF + teammembersget_info_role: + type: object + properties: + ".tag": + type: string + example: member_only + inline_response_200_58: + type: object + properties: + ".tag": + type: string + example: member_info + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + members_list_body_1: + type: object + properties: + include_removed: + type: boolean + example: false + limit: + type: number + example: 100 + inline_response_200_59: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: true + members: + type: array + example: + - profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + items: + $ref: '#/components/schemas/inline_response_200_59_members' + list_continue_body_4: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + members_move_former_member_files_body: + type: object + properties: + transfer_admin_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + transfer_dest_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + job_status_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + members_recover_body: + type: object + properties: + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + members_remove_body_1: + type: object + properties: + keep_account: + type: boolean + example: false + retain_team_shares: + type: boolean + example: false + transfer_admin_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + transfer_dest_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + wipe_data: + type: boolean + example: true + job_status_get_body_2: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + teammemberssecondary_emailsadd_new_secondary_emails: + type: object + properties: + secondary_emails: + type: array + example: + - bob2@hotmail.com + - bob@inst.gov + items: + type: string + example: bob2@hotmail.com + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + secondary_emails_add_body: + type: object + properties: + new_secondary_emails: + type: array + example: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + inline_response_200_60: + type: object + properties: + results: + type: array + example: + - ".tag": success + results: + - ".tag": success + success: + email: apple@orange.com + is_verified: true + - ".tag": unavailable + unavailable: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + - ".tag": invalid_user + invalid_user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/inline_response_200_60_results_1' + secondary_emails_delete_body: + type: object + properties: + emails_to_delete: + type: array + example: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + inline_response_200_61: + type: object + properties: + results: + type: array + example: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + - ".tag": not_found + not_found: alic@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/inline_response_200_61_results_1' + secondary_emails_resend_verification_emails_body: + type: object + properties: + emails_to_resend: + type: array + example: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + inline_response_200_62: + type: object + properties: + results: + type: array + example: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/inline_response_200_62_results_1' + members_send_welcome_email_body: + type: object + properties: + ".tag": + type: string + example: team_member_id + team_member_id: + type: string + example: dbmid:efgh5678 + members_set_admin_permissions_body: + type: object + properties: + new_role: + type: string + example: member_only + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_63: + type: object + properties: + role: + $ref: '#/components/schemas/teammembersget_info_role' + team_member_id: + type: string + example: dbmid:9978889 + members_set_profile_body: + type: object + properties: + new_email: + type: string + example: t.smith@domain.com + new_surname: + type: string + example: Smith + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + members_set_profile_photo_body: + type: object + properties: + photo: + $ref: '#/components/schemas/Photo' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + members_suspend_body: + type: object + properties: + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + wipe_data: + type: boolean + example: false + members_unsuspend_body: + type: object + properties: + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + namespaces_list_body: + type: object + properties: + limit: + type: number + example: 1 + inline_response_200_64: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + namespaces: + type: array + example: + - name: Marketing + namespace_id: "123456789" + namespace_type: + ".tag": shared_folder + - name: Franz Ferdinand + namespace_id: "123456789" + namespace_type: + ".tag": team_member_folder + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/inline_response_200_64_namespaces' + list_continue_body_5: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + team_folder_activate_body: + type: object + properties: + team_folder_id: + type: string + example: "123456789" + inline_response_200_65: + type: object + properties: + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + items: + $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + is_team_shared_dropbox: + type: boolean + example: false + name: + type: string + example: Marketing + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + team_folder_id: + type: string + example: "123456789" + team_folder_archive_body: + type: object + properties: + force_async_off: + type: boolean + example: false + team_folder_id: + type: string + example: "123456789" + inline_response_200_66: + type: object + properties: + ".tag": + type: string + example: complete + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + items: + $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + is_team_shared_dropbox: + type: boolean + example: false + name: + type: string + example: Marketing + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + team_folder_id: + type: string + example: "123456789" + archive_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + team_folder_create_body: + type: object + properties: + name: + type: string + example: Marketing + sync_setting: + type: string + example: not_synced + team_folder_get_info_body: + type: object + properties: + team_folder_ids: + type: array + example: + - "947182" + - "5819424" + - "852307532" + items: + type: string + example: "947182" + team_folder_list_body: + type: object + properties: + limit: + type: number + example: 100 + inline_response_200_67: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + team_folders: + type: array + example: + - content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + items: + $ref: '#/components/schemas/inline_response_200_67_team_folders' + list_continue_body_6: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + team_folder_permanently_delete_body: + type: object + properties: + team_folder_id: + type: string + example: "123456789" + team_folder_rename_body: + type: object + properties: + name: + type: string + example: Sales + team_folder_id: + type: string + example: "123456789" + teamteam_folderupdate_sync_settings_content_sync_settings: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + type: string + example: not_synced + team_folder_update_sync_settings_body: + type: object + properties: + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: not_synced + items: + $ref: '#/components/schemas/teamteam_folderupdate_sync_settings_content_sync_settings' + sync_setting: + type: string + example: not_synced + team_folder_id: + type: string + example: "123456789" + teamfeaturesget_values_features: + type: object + properties: + ".tag": + type: string + example: upload_api_rate_limit + features_get_values_body: + type: object + properties: + features: + type: array + example: + - ".tag": upload_api_rate_limit + - ".tag": has_team_shared_dropbox + items: + $ref: '#/components/schemas/teamfeaturesget_values_features' + inline_response_200_68: + type: object + properties: + values: + type: array + example: + - ".tag": upload_api_rate_limit + upload_api_rate_limit: + ".tag": limit + limit: 25000 + - ".tag": has_team_shared_dropbox + has_team_shared_dropbox: + ".tag": has_team_shared_dropbox + has_team_shared_dropbox: false + items: + $ref: '#/components/schemas/inline_response_200_68_values' + inline_response_200_69: + type: object + properties: + name: + type: string + example: Dropbox Inc. + num_licensed_users: + type: number + example: 5 + num_provisioned_users: + type: number + example: 2 + policies: + $ref: '#/components/schemas/inline_response_200_69_policies' + team_id: + type: string + example: dbtid:1234abcd + inline_response_200_70: + type: object + properties: + admin_profile: + $ref: '#/components/schemas/teammembersget_info_profile' + team_log_get_events_body: + type: object + properties: + category: + type: string + example: groups + limit: + type: number + example: 50 + inline_response_200_71: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + events: + type: array + example: + - actor: + ".tag": user + user: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + assets: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + context: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + details: + ".tag": shared_content_download_details + shared_content_access_level: + ".tag": viewer_no_comment + shared_content_link: abc + shared_content_owner: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + event_category: + ".tag": tfa + event_type: + ".tag": shared_content_download + description: (sharing) Downloaded shared file/folder + involve_non_team_member: true + origin: + access_method: + ".tag": end_user + end_user: + ".tag": web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + city: San Francisco + country: US + ip_address: 45.56.78.100 + region: California + participants: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + timestamp: 2017-01-25T15:51:30Z + items: + $ref: '#/components/schemas/inline_response_200_71_events' + has_more: + type: boolean + example: false + get_events_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + usersfeaturesget_values_features: + type: object + properties: + ".tag": + type: string + example: paper_as_files + features_get_values_body_1: + type: object + properties: + features: + type: array + example: + - ".tag": paper_as_files + - ".tag": file_locking + items: + $ref: '#/components/schemas/usersfeaturesget_values_features' + inline_response_200_72: + type: object + properties: + values: + type: array + example: + - ".tag": paper_as_files + paper_as_files: + ".tag": enabled + enabled: true + items: + $ref: '#/components/schemas/inline_response_200_72_values' + users_get_account_body: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + inline_response_200_73: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: + type: boolean + example: false + email: + type: string + example: franz@dropbox.com + email_verified: + type: boolean + example: true + is_teammate: + type: boolean + example: false + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + users_get_account_batch_body: + type: object + properties: + account_ids: + type: array + example: + - dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + - dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ + items: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + inline_response_200_74: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: + type: boolean + example: false + email: + type: string + example: franz@dropbox.com + email_verified: + type: boolean + example: true + is_teammate: + type: boolean + example: false + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + inline_response_200_75: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + account_type: + $ref: '#/components/schemas/inline_response_200_75_account_type' + country: + type: string + example: US + disabled: + type: boolean + example: false + email: + type: string + example: franz@dropbox.com + email_verified: + type: boolean + example: true + is_paired: + type: boolean + example: true + locale: + type: string + example: en + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + referral_link: + type: string + example: https://db.tt/ZITNuhtI + root_info: + $ref: '#/components/schemas/inline_response_200_75_root_info' + team: + $ref: '#/components/schemas/inline_response_200_75_team' + team_member_id: + type: string + example: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + inline_response_200_76: + type: object + properties: + allocation: + $ref: '#/components/schemas/inline_response_200_76_allocation' + used: + type: number + example: 314159265 + inline_response_200_1_matches: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: + type: boolean + example: false + path: + type: string + example: /my_awesome/word.docx + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + inline_response_200_3_type: + type: object + properties: + ".tag": + type: string + example: string + inline_response_200_3_fields: + type: object + properties: + description: + type: string + example: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: + type: string + example: Security Policy + type: + $ref: '#/components/schemas/inline_response_200_3_type' + inline_response_200_6_deadline_allow_late_uploads: + type: object + properties: + ".tag": + type: string + example: seven_days + inline_response_200_6_deadline: + type: object + properties: + allow_late_uploads: + $ref: '#/components/schemas/inline_response_200_6_deadline_allow_late_uploads' + deadline: + type: string + example: 2020-10-12T17:00:00Z + inline_response_200_7_file_requests: + type: object + properties: + created: + type: string + example: 2015-10-05T17:00:00Z + deadline: + $ref: '#/components/schemas/inline_response_200_6_deadline' + destination: + type: string + example: /File Requests/Homework + file_count: + type: number + example: 3 + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + is_open: + type: boolean + example: true + title: + type: string + example: Homework submission + url: + type: string + example: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + inline_response_200_9_metadata_file_lock_info: + type: object + properties: + created: + type: string + example: 2015-05-12T15:50:38Z + is_lockholder: + type: boolean + example: true + lockholder_name: + type: string + example: Imaginary User + inline_response_200_9_metadata_sharing_info: + type: object + properties: + modified_by: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: + type: string + example: "84528192421" + read_only: + type: boolean + example: true + inline_response_200_9_metadata: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_10_entries: + type: object + properties: + ".tag": + type: string + example: success + success: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_12_metadata_sharing_info: + type: object + properties: + no_access: + type: boolean + example: false + parent_shared_folder_id: + type: string + example: "84528192421" + read_only: + type: boolean + example: false + traverse_only: + type: boolean + example: false + inline_response_200_12_metadata: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXz + name: + type: string + example: math + path_display: + type: string + example: /Homework/math + path_lower: + type: string + example: /homework/math + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + sharing_info: + $ref: '#/components/schemas/inline_response_200_12_metadata_sharing_info' + inline_response_200_13_entries: + type: object + properties: + ".tag": + type: string + example: success + metadata: + $ref: '#/components/schemas/inline_response_200_12_metadata' + inline_response_200_14_entries: + type: object + properties: + ".tag": + type: string + example: success + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_16_export_metadata: + type: object + properties: + export_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + name: + type: string + example: Prime_Numbers.xlsx + size: + type: number + example: 7189 + inline_response_200_16_file_metadata: + type: object + properties: + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_17_lock_content: + type: object + properties: + ".tag": + type: string + example: single_user + created: + type: string + example: 2015-05-12T15:50:38Z + lock_holder_account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: + type: string + example: dbtid:1234abcd + inline_response_200_17_lock: + type: object + properties: + content: + $ref: '#/components/schemas/inline_response_200_17_lock_content' + inline_response_200_17_entries: + type: object + properties: + ".tag": + type: string + example: success + lock: + $ref: '#/components/schemas/inline_response_200_17_lock' + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_22_entries: + type: object + properties: + ".tag": + type: string + example: success + metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + thumbnail: + type: string + example: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= + inline_response_200_23_sharing_info: + type: object + properties: + modified_by: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + no_access: + type: boolean + example: false + parent_shared_folder_id: + type: string + example: "84528192421" + read_only: + type: boolean + example: true + traverse_only: + type: boolean + example: false + inline_response_200_23_entries: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_23_sharing_info' + size: + type: number + example: 7212 + inline_response_200_28_metadata: + type: object + properties: + ".tag": + type: string + example: metadata + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_28_matches: + type: object + properties: + metadata: + $ref: '#/components/schemas/inline_response_200_28_metadata' + inline_response_200_29_entries: + type: object + properties: + ".tag": + type: string + example: success + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_33_access_inheritance: + type: object + properties: + ".tag": + type: string + example: inherit + inline_response_200_33_link_metadata_audience_options: + type: object + properties: + ".tag": + type: string + example: public + inline_response_200_33_link_metadata_action: + type: object + properties: + ".tag": + type: string + example: change_audience + inline_response_200_33_link_metadata_link_permissions: + type: object + properties: + action: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_action' + allow: + type: boolean + example: true + inline_response_200_33_link_metadata: + type: object + properties: + audience_options: + type: array + example: + - ".tag": public + - ".tag": team + - ".tag": members + items: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + current_audience: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + link_permissions: + type: array + example: + - action: + ".tag": change_audience + allow: true + items: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_link_permissions' + password_protected: + type: boolean + example: false + url: + type: string + example: "" + inline_response_200_37_link_permissions_revoke_failure_reason: + type: object + properties: + ".tag": + type: string + example: owner_only + inline_response_200_37_link_permissions: + type: object + properties: + can_revoke: + type: boolean + example: false + resolved_visibility: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + revoke_failure_reason: + $ref: '#/components/schemas/inline_response_200_37_link_permissions_revoke_failure_reason' + inline_response_200_37_team_member_info: + type: object + properties: + display_name: + type: string + example: Roger Rabbit + member_id: + type: string + example: dbmid:abcd1234 + team_info: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + inline_response_200_40_users: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + user: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_user' + inline_response_200_41_entries: + type: object + properties: + access_inheritance: + $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inside_team_folder: + type: boolean + example: false + is_team_folder: + type: boolean + example: false + link_metadata: + $ref: '#/components/schemas/inline_response_200_33_link_metadata' + name: + type: string + example: dir + path_lower: + type: string + example: /dir + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: + type: string + example: "84528192421" + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_42_entries: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + id: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + name: + type: string + example: file.txt + owner_display_names: + type: array + example: + - Jane Doe + items: + type: string + example: Jane Doe + owner_team: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + path_display: + type: string + example: /dir/file.txt + path_lower: + type: string + example: /dir/file.txt + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_43_links: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + $ref: '#/components/schemas/inline_response_200_37_link_permissions' + name: + type: string + example: Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + size: + type: number + example: 7212 + team_member_info: + $ref: '#/components/schemas/inline_response_200_37_team_member_info' + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + inline_response_200_48_groups: + type: object + properties: + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: Test group + member_count: + type: number + example: 10 + inline_response_200_49_group_info: + type: object + properties: + created: + type: number + example: 1447255518000 + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: project launch + member_count: + type: number + example: 5 + members: + type: array + example: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/teamgroupsget_info_members' + inline_response_200_51_members: + type: object + properties: + permanently_deleted_users: + type: number + example: 2 + team_member_ids: + type: array + example: + - dbmid:efgh5678 + items: + type: string + example: dbmid:efgh5678 + inline_response_200_52_entries: + type: object + properties: + author_email: + type: string + example: a@a.com + author_member_id: + type: string + example: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + content_hash: + type: string + example: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: + type: string + example: Document + new_filename: + type: string + example: 111_222.pdf + original_file_path: + type: string + example: /a.pdf + original_revision_id: + type: string + example: ab2rij4i5ojgfd + server_modified: + type: string + example: 2019-08-12T12:08:52Z + size: + type: number + example: 3 + inline_response_200_53_policies: + type: object + properties: + activation_time: + type: string + example: 2016-01-20T00:00:10Z + end_date: + type: string + example: 2017-12-31T00:00:00Z + id: + type: string + example: pid_dbhid:abcd1234 + members: + $ref: '#/components/schemas/inline_response_200_51_members' + name: + type: string + example: acme cfo policy + start_date: + type: string + example: 2016-01-01T00:00:00Z + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + inline_response_200_56_complete: + type: object + properties: + ".tag": + type: string + example: success + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + inline_response_200_59_members: + type: object + properties: + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + inline_response_200_60_results: + type: object + properties: + ".tag": + type: string + example: success + success: + $ref: '#/components/schemas/teamgroupsget_info_profile_secondary_emails' + unavailable: + type: string + example: alice@example.com + inline_response_200_60_results_1: + type: object + properties: + ".tag": + type: string + example: success + invalid_user: + $ref: '#/components/schemas/members_send_welcome_email_body' + results: + type: array + example: + - ".tag": success + success: + email: apple@orange.com + is_verified: true + - ".tag": unavailable + unavailable: alice@example.com + items: + $ref: '#/components/schemas/inline_response_200_60_results' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_61_results: + type: object + properties: + ".tag": + type: string + example: success + not_found: + type: string + example: alic@example.com + success: + type: string + example: alice@example.com + inline_response_200_61_results_1: + type: object + properties: + ".tag": + type: string + example: success + results: + type: array + example: + - ".tag": success + success: alice@example.com + - ".tag": not_found + not_found: alic@example.com + items: + $ref: '#/components/schemas/inline_response_200_61_results' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_62_results: + type: object + properties: + ".tag": + type: string + example: success + success: + type: string + example: alice@example.com + inline_response_200_62_results_1: + type: object + properties: + ".tag": + type: string + example: success + results: + type: array + example: + - ".tag": success + success: alice@example.com + items: + $ref: '#/components/schemas/inline_response_200_62_results' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_64_namespace_type: + type: object + properties: + ".tag": + type: string + example: shared_folder + inline_response_200_64_namespaces: + type: object + properties: + name: + type: string + example: Marketing + namespace_id: + type: string + example: "123456789" + namespace_type: + $ref: '#/components/schemas/inline_response_200_64_namespace_type' + team_member_id: + type: string + example: dbmid:1234567 + inline_response_200_65_sync_setting: + type: object + properties: + ".tag": + type: string + example: default + inline_response_200_65_content_sync_settings: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + inline_response_200_67_team_folders: + type: object + properties: + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + items: + $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + is_team_shared_dropbox: + type: boolean + example: false + name: + type: string + example: Marketing + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + team_folder_id: + type: string + example: "123456789" + inline_response_200_68_has_team_shared_dropbox: + type: object + properties: + ".tag": + type: string + example: has_team_shared_dropbox + has_team_shared_dropbox: + type: boolean + example: false + inline_response_200_68_upload_api_rate_limit: + type: object + properties: + ".tag": + type: string + example: limit + limit: + type: number + example: 25000 + inline_response_200_68_values: + type: object + properties: + ".tag": + type: string + example: upload_api_rate_limit + has_team_shared_dropbox: + $ref: '#/components/schemas/inline_response_200_68_has_team_shared_dropbox' + upload_api_rate_limit: + $ref: '#/components/schemas/inline_response_200_68_upload_api_rate_limit' + inline_response_200_69_policies_emm_state: + type: object + properties: + ".tag": + type: string + example: disabled + inline_response_200_69_policies_sharing_shared_folder_join_policy: + type: object + properties: + ".tag": + type: string + example: from_anyone + inline_response_200_69_policies_sharing_shared_link_create_policy: + type: object + properties: + ".tag": + type: string + example: team_only + inline_response_200_69_policies_sharing: + type: object + properties: + shared_folder_join_policy: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing_shared_folder_join_policy' + shared_folder_member_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_resolved_member_policy' + shared_link_create_policy: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing_shared_link_create_policy' + inline_response_200_69_policies: + type: object + properties: + emm_state: + $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + office_addin: + $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + sharing: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing' + inline_response_200_71_actor_user_team: + type: object + properties: + display_name: + type: string + example: A Team + inline_response_200_71_actor_user: + type: object + properties: + ".tag": + type: string + example: team_member + account_id: + type: string + example: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: + type: string + example: John Smith + email: + type: string + example: john_smith@acmecorp.com + member_external_id: + type: string + example: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + $ref: '#/components/schemas/inline_response_200_71_actor_user_team' + team_member_id: + type: string + example: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + inline_response_200_71_actor: + type: object + properties: + ".tag": + type: string + example: user + user: + $ref: '#/components/schemas/inline_response_200_71_actor_user' + inline_response_200_71_path_namespace_relative: + type: object + properties: + is_shared_namespace: + type: boolean + example: false + ns_id: + type: string + example: "1234" + relative_path: + type: string + example: /Contract Work/Draft + inline_response_200_71_path: + type: object + properties: + contextual: + type: string + example: /Contract Work/Draft + namespace_relative: + $ref: '#/components/schemas/inline_response_200_71_path_namespace_relative' + inline_response_200_71_assets: + type: object + properties: + ".tag": + type: string + example: file + display_name: + type: string + example: reports.xls + file_id: + type: string + example: id:jQKLsZFQImAAAAAAEZAAQt + file_size: + type: number + example: 4 + path: + $ref: '#/components/schemas/inline_response_200_71_path' + inline_response_200_71_details_shared_content_access_level: + type: object + properties: + ".tag": + type: string + example: viewer_no_comment + inline_response_200_71_details: + type: object + properties: + ".tag": + type: string + example: shared_content_download_details + shared_content_access_level: + $ref: '#/components/schemas/inline_response_200_71_details_shared_content_access_level' + shared_content_link: + type: string + example: abc + shared_content_owner: + $ref: '#/components/schemas/inline_response_200_71_actor_user' + inline_response_200_71_event_category: + type: object + properties: + ".tag": + type: string + example: tfa + inline_response_200_71_event_type: + type: object + properties: + ".tag": + type: string + example: shared_content_download + description: + type: string + example: (sharing) Downloaded shared file/folder + inline_response_200_71_origin_access_method_end_user: + type: object + properties: + ".tag": + type: string + example: web + session_id: + type: string + example: dbwsid:123456789012345678901234567890123456789 + inline_response_200_71_origin_access_method: + type: object + properties: + ".tag": + type: string + example: end_user + end_user: + $ref: '#/components/schemas/inline_response_200_71_origin_access_method_end_user' + inline_response_200_71_origin_geo_location: + type: object + properties: + city: + type: string + example: San Francisco + country: + type: string + example: US + ip_address: + type: string + example: 45.56.78.100 + region: + type: string + example: California + inline_response_200_71_origin: + type: object + properties: + access_method: + $ref: '#/components/schemas/inline_response_200_71_origin_access_method' + geo_location: + $ref: '#/components/schemas/inline_response_200_71_origin_geo_location' + inline_response_200_71_user: + type: object + properties: + ".tag": + type: string + example: team_member + account_id: + type: string + example: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: + type: string + example: Jane Smith + email: + type: string + example: jane_smith@acmecorp.com + member_external_id: + type: string + example: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + $ref: '#/components/schemas/inline_response_200_71_actor_user_team' + team_member_id: + type: string + example: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + inline_response_200_71_participants: + type: object + properties: + ".tag": + type: string + example: user + user: + $ref: '#/components/schemas/inline_response_200_71_user' + inline_response_200_71_events: + type: object + properties: + actor: + $ref: '#/components/schemas/inline_response_200_71_actor' + assets: + type: array + example: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + items: + $ref: '#/components/schemas/inline_response_200_71_assets' + context: + $ref: '#/components/schemas/inline_response_200_71_actor_user' + details: + $ref: '#/components/schemas/inline_response_200_71_details' + event_category: + $ref: '#/components/schemas/inline_response_200_71_event_category' + event_type: + $ref: '#/components/schemas/inline_response_200_71_event_type' + involve_non_team_member: + type: boolean + example: true + origin: + $ref: '#/components/schemas/inline_response_200_71_origin' + participants: + type: array + example: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + items: + $ref: '#/components/schemas/inline_response_200_71_participants' + timestamp: + type: string + example: 2017-01-25T15:51:30Z + inline_response_200_72_paper_as_files: + type: object + properties: + ".tag": + type: string + example: enabled + enabled: + type: boolean + example: true + inline_response_200_72_values: + type: object + properties: + ".tag": + type: string + example: paper_as_files + paper_as_files: + $ref: '#/components/schemas/inline_response_200_72_paper_as_files' + inline_response_200_75_account_type: + type: object + properties: + ".tag": + type: string + example: business + inline_response_200_75_root_info: + type: object + properties: + ".tag": + type: string + example: user + home_namespace_id: + type: string + example: "3235641" + root_namespace_id: + type: string + example: "3235641" + inline_response_200_75_team: + type: object + properties: + id: + type: string + example: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: + type: string + example: "Acme, Inc." + office_addin_policy: + $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + sharing_policies: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing' + inline_response_200_76_allocation: + type: object + properties: + ".tag": + type: string + example: individual + allocated: + type: number + example: 10000000000 + parameters: + DropboxApiPathRoot: + name: dropbox-api-path-root + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + DropboxApiSelectUser: + name: dropbox-api-select-user + in: header + required: false + style: simple + explode: false + schema: + type: string + example: dbmid:FDFSVF-DFSDF + DropboxApiSelectAdmin: + name: dropbox-api-select-admin + in: header + required: false + style: simple + explode: false + schema: + type: string + example: dbmid:FDFSVF-DFSDF + securitySchemes: + bearerAuth: + type: http + scheme: bearer From 75b03142526cd3f207d477f7b157b251c7ceb277 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Tue, 29 Oct 2024 02:11:17 +0530 Subject: [PATCH 12/15] Prefer named schemas over inline schemas --- ballerina/client.bal | 302 +++---- ballerina/types.bal | 1909 +++++++++++++++++++--------------------- docs/spec/openapi.yaml | 1126 ++++++++++-------------- 3 files changed, 1502 insertions(+), 1835 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index d5453bb..c27d979 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -109,7 +109,7 @@ public isolated client class Client { return; } - resource isolated function post 'check/app(CheckAppRequest payload, AppHeaders headers = {}) returns inline_response_200|error { + resource isolated function post 'check/app(CheckAppRequest payload, AppHeaders headers = {}) returns EchoResult|error { string resourcePath = string `/check/app`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -118,7 +118,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post 'check/user(CheckUserRequest payload, UserHeaders headers = {}) returns inline_response_200|error { + resource isolated function post 'check/user(CheckUserRequest payload, UserHeaders headers = {}) returns EchoResult|error { string resourcePath = string `/check/user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -225,7 +225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - properties/search response - resource isolated function post file_properties/properties/search(SearchPropertiesRequest payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_1|error { + resource isolated function post file_properties/properties/search(SearchPropertiesRequest payload, PropertiesSearchHeaders headers = {}) returns SearchPropertiesResponse|error { string resourcePath = string `/file_properties/properties/search`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -234,7 +234,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_properties/properties/search/'continue(SearchPropertiesContinueRequest payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_1|error { + resource isolated function post file_properties/properties/search/'continue(SearchPropertiesContinueRequest payload, PropertiesSearchContinueHeaders headers = {}) returns SearchPropertiesResponse|error { string resourcePath = string `/file_properties/properties/search/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -259,7 +259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_team response - resource isolated function post file_properties/templates/add_for_team(AddTemplateForTeam payload, map headers = {}) returns inline_response_200_2|error { + resource isolated function post file_properties/templates/add_for_team(AddTemplateForTeam payload, map headers = {}) returns AddTemplateResponse|error { string resourcePath = string `/file_properties/templates/add_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -271,7 +271,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_user response - resource isolated function post file_properties/templates/add_for_user(AddTemplateForUser payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_2|error { + resource isolated function post file_properties/templates/add_for_user(AddTemplateForUser payload, TemplatesAddForUserHeaders headers = {}) returns AddTemplateResponse|error { string resourcePath = string `/file_properties/templates/add_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -284,7 +284,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_team response - resource isolated function post file_properties/templates/get_for_team(GetTemplateForTeam payload, map headers = {}) returns inline_response_200_3|error { + resource isolated function post file_properties/templates/get_for_team(GetTemplateForTeam payload, map headers = {}) returns GetTemplateResponse|error { string resourcePath = string `/file_properties/templates/get_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -296,7 +296,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_user response - resource isolated function post file_properties/templates/get_for_user(GetTemplateForUserRequest payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_3|error { + resource isolated function post file_properties/templates/get_for_user(GetTemplateForUserRequest payload, TemplatesGetForUserHeaders headers = {}) returns GetTemplateResponse|error { string resourcePath = string `/file_properties/templates/get_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -309,7 +309,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_team response - resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_4|error { + resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns ListTemplatesResponse|error { string resourcePath = string `/file_properties/templates/list_for_team`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -319,7 +319,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_user response - resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_4|error { + resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns ListTemplatesResponse|error { string resourcePath = string `/file_properties/templates/list_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -353,7 +353,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_team response - resource isolated function post file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns TemplateId|error { + resource isolated function post file_properties/templates/update_for_team(UpdateTemplateForTeamRequest payload, map headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -365,7 +365,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_user response - resource isolated function post file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns TemplateId|error { + resource isolated function post file_properties/templates/update_for_user(UpdateTemplateForUserRequest payload, TemplatesUpdateForUserHeaders headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -378,7 +378,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - count response - resource isolated function post file_requests/count(CountHeaders headers = {}) returns inline_response_200_5|error { + resource isolated function post file_requests/count(CountHeaders headers = {}) returns FileRequestCount|error { string resourcePath = string `/file_requests/count`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -389,7 +389,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create response - resource isolated function post file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_6|error { + resource isolated function post file_requests/create(CreateFileRequestRequest payload, CreateHeaders headers = {}) returns FileRequest|error { string resourcePath = string `/file_requests/create`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -402,7 +402,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_7|error { + resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns DeleteFileRequestsResponse|error { string resourcePath = string `/file_requests/delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -415,7 +415,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_all_closed response - resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_7|error { + resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns DeleteFileRequestsResponse|error { string resourcePath = string `/file_requests/delete_all_closed`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -426,7 +426,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get response - resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_6|error { + resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns FileRequest|error { string resourcePath = string `/file_requests/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -435,7 +435,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns ListFileRequestsResponse|error { string resourcePath = string `/file_requests/list/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -448,7 +448,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list response - resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns ListFileRequestsResponse|error { string resourcePath = string `/file_requests/list_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -461,7 +461,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update response - resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_6|error { + resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns FileRequest|error { string resourcePath = string `/file_requests/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -474,7 +474,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch/check response - resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns RelocationBatchV2Response|error { string resourcePath = string `/files/copy_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -487,7 +487,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch response - resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns RelocationBatchV2Response|error { string resourcePath = string `/files/copy_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -500,7 +500,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/get response - resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_11|error { + resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns GetCopyReferenceResponse|error { string resourcePath = string `/files/copy_reference/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -513,7 +513,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/save response - resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_9|error { + resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns MetadataResponse|error { string resourcePath = string `/files/copy_reference/save`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -526,7 +526,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy response - resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_9|error { + resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns MetadataResponse|error { string resourcePath = string `/files/copy_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -539,7 +539,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder_batch response - resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_13|error { + resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns CreateFolderBatchResponse|error { string resourcePath = string `/files/create_folder_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -548,7 +548,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_13|error { + resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns CreateFolderBatchResponse|error { string resourcePath = string `/files/create_folder_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -561,7 +561,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder response - resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns FolderMetadataResponse|error { string resourcePath = string `/files/create_folder_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -574,7 +574,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_batch response - resource isolated function post files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_14|error { + resource isolated function post files/delete_batch(DeleteFilesBatchRequest payload, DeleteBatchHeaders headers = {}) returns DeleteBatchResponse|error { string resourcePath = string `/files/delete_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -583,7 +583,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_14|error { + resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns DeleteBatchResponse|error { string resourcePath = string `/files/delete_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -596,7 +596,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_9|error { + resource isolated function post files/delete_v2(FilePath payload, Delete1Headers headers = {}) returns MetadataResponse|error { string resourcePath = string `/files/delete_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -609,7 +609,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - download response - resource isolated function post files/download(DownloadHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/download(DownloadHeaders headers = {}) returns FileMetadata|error { string resourcePath = string `/files/download`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -620,7 +620,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - download_zip response - resource isolated function post files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/download_zip(DownloadZipHeaders headers = {}) returns FolderMetadataResponse|error { string resourcePath = string `/files/download_zip`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -631,7 +631,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - export response - resource isolated function post files/export(ExportHeaders headers = {}) returns inline_response_200_16|error { + resource isolated function post files/export(ExportHeaders headers = {}) returns ExportFileResponse|error { string resourcePath = string `/files/export`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -642,7 +642,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_lock_batch response - resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns LockFileBatchResult|error { string resourcePath = string `/files/get_file_lock_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -655,7 +655,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_metadata response - resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_18|error { + resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns GetMetadataResponse|error { string resourcePath = string `/files/get_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -668,7 +668,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_preview response - resource isolated function post files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/get_preview(GetPreviewHeaders headers = {}) returns FileMetadata|error { string resourcePath = string `/files/get_preview`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -679,7 +679,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_link response - resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_19|error { + resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns GetTemporaryLinkResponse|error { string resourcePath = string `/files/get_temporary_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -692,7 +692,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_upload_link response - resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_20|error { + resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns GetTemporaryUploadLinkResponse|error { string resourcePath = string `/files/get_temporary_upload_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -705,7 +705,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail_batch response - resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_22|error { + resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns GetThumbnailBatchResponse|error { string resourcePath = string `/files/get_thumbnail_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -718,7 +718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail response - resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_21|error { + resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns GetThumbnailResponse|error { string resourcePath = string `/files/get_thumbnail_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -729,7 +729,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder response - resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_23|error { + resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns ListFolderResponse|error { string resourcePath = string `/files/list_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -738,7 +738,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_23|error { + resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns ListFolderResponse|error { string resourcePath = string `/files/list_folder/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -764,7 +764,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder/longpoll response - resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_24|error { + resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns ListFolderLongpollResult|error { string resourcePath = string `/files/list_folder/longpoll`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -777,7 +777,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_revisions response - resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_25|error { + resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns ListRevisionsResult|error { string resourcePath = string `/files/list_revisions`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -790,7 +790,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - lock_file_batch response - resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns LockFileBatchResult|error { string resourcePath = string `/files/lock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -803,7 +803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch/check response - resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns RelocationBatchV2Response|error { string resourcePath = string `/files/move_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -816,7 +816,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch response - resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns RelocationBatchV2Response|error { string resourcePath = string `/files/move_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -829,7 +829,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move response - resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_9|error { + resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns MetadataResponse|error { string resourcePath = string `/files/move_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -854,7 +854,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - restore response - resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns FileMetadata|error { string resourcePath = string `/files/restore`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -867,7 +867,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url response - resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_26|error { + resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns SaveUrlResult|error { string resourcePath = string `/files/save_url`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -880,7 +880,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url/check_job_status response - resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_27|error { + resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns CheckJobStatusResponse|error { string resourcePath = string `/files/save_url/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -893,7 +893,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search/continue response - resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_28|error { + resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns SearchFilesResponse|error { string resourcePath = string `/files/search/continue_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -906,7 +906,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search response - resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_28|error { + resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns SearchFilesResponse|error { string resourcePath = string `/files/search_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -919,7 +919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unlock_file_batch response - resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns LockFileBatchResult|error { string resourcePath = string `/files/unlock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -932,14 +932,14 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload response - resource isolated function post files/upload(UploadHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/upload(UploadHeaders headers = {}) returns FileMetadata|error { string resourcePath = string `/files/upload`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_30|error { + resource isolated function post files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns UploadSessionStartResult|error { string resourcePath = string `/files/upload_session/start`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -960,7 +960,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload_session/finish response - resource isolated function post files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns FileMetadata|error { string resourcePath = string `/files/upload_session/finish`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -971,7 +971,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload_session/finish_batch response - resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_29|error { + resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns UploadSessionFinishBatchResult|error { string resourcePath = string `/files/upload_session/finish_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -980,7 +980,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_29|error { + resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns UploadSessionFinishBatchResult|error { string resourcePath = string `/files/upload_session/finish_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -993,7 +993,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - add_file_member response - resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_31[]|error { + resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns FileMemberActionResult[]|error { string resourcePath = string `/sharing/add_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1018,7 +1018,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_job_status response - resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_27|error { + resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns CheckJobStatusResponse|error { string resourcePath = string `/sharing/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1031,7 +1031,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_remove_member_job_status response - resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_32|error { + resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/sharing/check_remove_member_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1044,7 +1044,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_share_job_status response - resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_33|error { + resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns ShareFolderResponse|error { string resourcePath = string `/sharing/check_share_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1057,7 +1057,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata response - resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_34|error { + resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns GetFileMetadataResponse|error { string resourcePath = string `/sharing/get_file_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1070,7 +1070,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata/batch response - resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_35[]|error { + resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns GetFileMetadataIndicidualResult[]|error { string resourcePath = string `/sharing/get_file_metadata/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1083,7 +1083,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_folder_metadata response - resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_36|error { + resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns SharedFolderMetadata|error { string resourcePath = string `/sharing/get_folder_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1096,7 +1096,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_shared_link_file response - resource isolated function post sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_37|error { + resource isolated function post sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns SharedLinkMetadata|error { string resourcePath = string `/sharing/get_shared_link_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1107,7 +1107,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_shared_link_metadata response - resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_37|error { + resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns SharedLinkMetadata|error { string resourcePath = string `/sharing/get_shared_link_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1120,7 +1120,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members response - resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns SharedFileMembers|error { string resourcePath = string `/sharing/list_file_members`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1129,7 +1129,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns SharedFileMembers|error { string resourcePath = string `/sharing/list_file_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1142,7 +1142,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members/batch response - resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_39[]|error { + resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns ListFileMembersIndividualResult[]|error { string resourcePath = string `/sharing/list_file_members/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1151,7 +1151,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_40|error { + resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns SharedFolderMembers|error { string resourcePath = string `/sharing/list_folder_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1164,7 +1164,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folders response - resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_41|error { + resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1173,7 +1173,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_41|error { + resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1186,7 +1186,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_mountable_folders response - resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_41|error { + resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_mountable_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1195,7 +1195,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_41|error { + resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_mountable_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1208,7 +1208,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_received_files response - resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_42|error { + resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns ListReceivedFilesResponse|error { string resourcePath = string `/sharing/list_received_files`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1217,7 +1217,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_42|error { + resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns ListReceivedFilesResponse|error { string resourcePath = string `/sharing/list_received_files/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1230,7 +1230,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_shared_links response - resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns ListSharedLinksResult|error { string resourcePath = string `/sharing/list_shared_links`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1243,7 +1243,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - modify_shared_link_settings response - resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_37|error { + resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns SharedLinkMetadata|error { string resourcePath = string `/sharing/modify_shared_link_settings`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1256,7 +1256,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - mount_folder response - resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_36|error { + resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns SharedFolderMetadata|error { string resourcePath = string `/sharing/mount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1281,7 +1281,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - relinquish_folder_membership response - resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_32|error { + resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/sharing/relinquish_folder_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1294,7 +1294,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_file_member_2 response - resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_44|error { + resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns CustomQuotaResponse|error { string resourcePath = string `/sharing/remove_file_member_2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1307,7 +1307,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_folder_member response - resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_45|error { + resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns LaunchResultBase|error { string resourcePath = string `/sharing/remove_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1332,7 +1332,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - set_access_inheritance response - resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_33|error { + resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns ShareFolderResponse|error { string resourcePath = string `/sharing/set_access_inheritance`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1345,7 +1345,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - share_folder response - resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_33|error { + resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns ShareFolderResponse|error { string resourcePath = string `/sharing/share_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1381,7 +1381,7 @@ public isolated client class Client { # unshare_file # # + headers - Headers to be sent with the request - resource isolated function post sharing/unshare_file(sharing_unshare_file_body payload, UnshareFileHeaders headers = {}) returns error? { + resource isolated function post sharing/unshare_file(UnshareFileRequest payload, UnshareFileHeaders headers = {}) returns error? { string resourcePath = string `/sharing/unshare_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1394,7 +1394,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unshare_folder response - resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_32|error { + resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/sharing/unshare_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1433,7 +1433,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update_folder_policy response - resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_36|error { + resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns SharedFolderMetadata|error { string resourcePath = string `/sharing/update_folder_policy`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1489,7 +1489,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_68|error { + resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns FeaturesGetValuesResponse|error { string resourcePath = string `/team/features/get_values`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1501,7 +1501,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_info response - resource isolated function post team/get_info(map headers = {}) returns inline_response_200_69|error { + resource isolated function post team/get_info(map headers = {}) returns TeamGetInfoResponse|error { string resourcePath = string `/team/get_info`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -1511,7 +1511,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/create response - resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_46|error { + resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns GroupFullInfo|error { string resourcePath = string `/team/groups/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1523,7 +1523,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/delete response - resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_32|error { + resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/groups/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1535,7 +1535,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/get_info response - resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_47[]|error { + resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns GroupsGetInfoItem[]|error { string resourcePath = string `/team/groups/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1547,7 +1547,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/job_status/get response - resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_32|error { + resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/groups/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1559,7 +1559,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/list response - resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_48|error { + resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns GroupsListResult|error { string resourcePath = string `/team/groups/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1567,7 +1567,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_48|error { + resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns GroupsListResult|error { string resourcePath = string `/team/groups/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1579,7 +1579,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/add response - resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_49|error { + resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns GroupMembersChangeResult|error { string resourcePath = string `/team/groups/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1591,7 +1591,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/list response - resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_50|error { + resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns MembersListV2Result|error { string resourcePath = string `/team/groups/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1599,7 +1599,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_50|error { + resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns MembersListV2Result|error { string resourcePath = string `/team/groups/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1611,7 +1611,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/remove response - resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_49|error { + resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns GroupMembersChangeResult|error { string resourcePath = string `/team/groups/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1623,7 +1623,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/set_access_type response - resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_47[]|error { + resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns GroupsGetInfoItem[]|error { string resourcePath = string `/team/groups/members/set_access_type`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1635,7 +1635,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/update response - resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_46|error { + resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns GroupFullInfo|error { string resourcePath = string `/team/groups/update`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1647,7 +1647,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/create_policy response - resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_51|error { + resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns LegalHoldPolicy|error { string resourcePath = string `/team/legal_holds/create_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1659,7 +1659,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/get_policy response - resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_51|error { + resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns LegalHoldPolicy|error { string resourcePath = string `/team/legal_holds/get_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1671,7 +1671,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions response - resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_52|error { + resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns LegalHoldsListHeldRevisionResult|error { string resourcePath = string `/team/legal_holds/list_held_revisions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1683,7 +1683,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions_continue response - resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_52|error { + resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns LegalHoldsListHeldRevisionResult|error { string resourcePath = string `/team/legal_holds/list_held_revisions_continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1695,7 +1695,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_policies response - resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_53|error { + resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns LegalHoldsListPoliciesResult|error { string resourcePath = string `/team/legal_holds/list_policies`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1718,7 +1718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/update_policy response - resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_51|error { + resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns LegalHoldPolicy|error { string resourcePath = string `/team/legal_holds/update_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1771,7 +1771,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/add response - resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_54|error { + resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns ExcludedUsersUpdateResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1783,7 +1783,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/list response - resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_55|error { + resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns ExcludedUsersListResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1791,7 +1791,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_55|error { + resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns ExcludedUsersListResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1803,7 +1803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/remove response - resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_54|error { + resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns ExcludedUsersUpdateResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1815,7 +1815,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/get_custom_quota response - resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { + resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns CustomQuotaResponse[]|error { string resourcePath = string `/team/member_space_limits/get_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1827,7 +1827,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/remove_custom_quota response - resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { + resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns CustomQuotaResponse[]|error { string resourcePath = string `/team/member_space_limits/remove_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1839,7 +1839,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/set_custom_quota response - resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { + resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns CustomQuotaResponse[]|error { string resourcePath = string `/team/member_space_limits/set_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1851,7 +1851,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add response - resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_56|error { + resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns MembersAddResult|error { string resourcePath = string `/team/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1863,7 +1863,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add/job_status/get response - resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_56|error { + resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns MembersAddResult|error { string resourcePath = string `/team/members/add/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1875,7 +1875,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/delete_profile_photo response - resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_57|error { + resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns TeamMemberInfoV2Result|error { string resourcePath = string `/team/members/delete_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1887,7 +1887,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/get_info response - resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_58[]|error { + resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns MembersGetInfoItem[]|error { string resourcePath = string `/team/members/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1899,7 +1899,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/list response - resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns MembersListResult|error { string resourcePath = string `/team/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1907,7 +1907,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns MembersListResult|error { string resourcePath = string `/team/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1919,7 +1919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/move_former_member_files response - resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_32|error { + resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/move_former_member_files`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1927,7 +1927,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_32|error { + resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/move_former_member_files/job_status/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1950,7 +1950,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove response - resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_32|error { + resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1962,7 +1962,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove/job_status/get response - resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_32|error { + resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/remove/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1974,7 +1974,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/add response - resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_60|error { + resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns AddSecondaryEmailsResult|error { string resourcePath = string `/team/members/secondary_emails/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1986,7 +1986,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/delete response - resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_61|error { + resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns DeleteSecondaryEmailsResult|error { string resourcePath = string `/team/members/secondary_emails/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1998,7 +1998,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/resend_verification_emails response - resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_62|error { + resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns ResendVerificationEmailResult|error { string resourcePath = string `/team/members/secondary_emails/resend_verification_emails`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2021,7 +2021,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_admin_permissions response - resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_63|error { + resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns SetAdminPermissionsResult|error { string resourcePath = string `/team/members/set_admin_permissions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2033,7 +2033,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile response - resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_57|error { + resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns TeamMemberInfoV2Result|error { string resourcePath = string `/team/members/set_profile`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2045,7 +2045,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile_photo response - resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_57|error { + resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns TeamMemberInfoV2Result|error { string resourcePath = string `/team/members/set_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2079,7 +2079,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - namespaces/list response - resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_64|error { + resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns TeamNamespacesListResult|error { string resourcePath = string `/team/namespaces/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2087,7 +2087,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_64|error { + resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns TeamNamespacesListResult|error { string resourcePath = string `/team/namespaces/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2139,7 +2139,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/activate response - resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_65|error { + resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/activate`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2151,7 +2151,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/archive response - resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_66|error { + resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns TeamFolderArchiveResponse|error { string resourcePath = string `/team/team_folder/archive`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2159,7 +2159,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_66|error { + resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns TeamFolderArchiveResponse|error { string resourcePath = string `/team/team_folder/archive/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2171,7 +2171,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/create response - resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_65|error { + resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2194,7 +2194,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/list response - resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns TeamFolderListResult|error { string resourcePath = string `/team/team_folder/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2202,7 +2202,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns TeamFolderListResult|error { string resourcePath = string `/team/team_folder/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2225,7 +2225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/rename response - resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_65|error { + resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/rename`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2237,7 +2237,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/update_sync_settings response - resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_65|error { + resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/update_sync_settings`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2249,7 +2249,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - token/get_authenticated_admin response - resource isolated function post team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_70|error { + resource isolated function post team/token/get_authenticated_admin(map headers = {}) returns TokenGetAuthenticatedAdminResult|error { string resourcePath = string `/team/token/get_authenticated_admin`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -2259,7 +2259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_events response - resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_71|error { + resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns GetTeamEventsResult|error { string resourcePath = string `/team_log/get_events`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2267,7 +2267,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_71|error { + resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns GetTeamEventsResult|error { string resourcePath = string `/team_log/get_events/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2279,7 +2279,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_72|error { + resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns UserFeaturesGetValuesResult|error { string resourcePath = string `/users/features/get_values`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2292,7 +2292,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account response - resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_73|error { + resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns BasicAccount|error { string resourcePath = string `/users/get_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2305,7 +2305,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account_batch response - resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_74[]|error { + resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns BasicAccount[]|error { string resourcePath = string `/users/get_account_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2318,7 +2318,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_current_account response - resource isolated function post users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_75|error { + resource isolated function post users/get_current_account(GetCurrentAccountHeaders headers = {}) returns FullAccount|error { string resourcePath = string `/users/get_current_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2329,7 +2329,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_space_usage response - resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_76|error { + resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns GetSpaceUsageResponse|error { string resourcePath = string `/users/get_space_usage`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; diff --git a/ballerina/types.bal b/ballerina/types.bal index b4d8831..d94711d 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -35,21 +35,6 @@ public type finish_batch_check_body record { string async_job_id?; }; -public type inline_response_200_41_entries record { - inline_response_200_33_access_inheritance access_inheritance?; - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inside_team_folder?; - boolean is_team_folder?; - inline_response_200_33_link_metadata link_metadata?; - string name?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string shared_folder_id?; - string time_invited?; -}; - # Represents the Headers record for the operation: checkRemoveMemberJobStatus public type CheckRemoveMemberJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -71,44 +56,36 @@ public type sharinglist_file_membersbatch_result_members_user record { string team_member_id?; }; -public type list_folder_longpoll_body record { +public type MembersListV2Result record { string cursor?; - decimal timeout?; + boolean has_more?; + anydata[] members?; }; -public type inline_response_200_9_metadata_file_lock_info record { - string created?; - boolean is_lockholder?; - string lockholder_name?; +public type list_folder_longpoll_body record { + string cursor?; + decimal timeout?; }; public type sharingget_file_metadatabatch_result_policy record { sharingget_file_metadatabatch_result_policy_acl_update_policy acl_update_policy?; sharingget_file_metadatabatch_result_policy_member_policy member_policy?; - sharingget_file_metadatabatch_result_policy_resolved_member_policy resolved_member_policy?; + SharedFolderMemberPolicy resolved_member_policy?; sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; }; +public type ListSharedLinksResult record { + string cursor?; + boolean has_more?; + SharedLinkMetadata[] links?; +}; + public type groups_create_body record { boolean add_creator_as_owner?; string group_external_id?; string group_name?; }; -public type inline_response_200_43_links record { - string \.tag?; - string client_modified?; - string id?; - inline_response_200_37_link_permissions link_permissions?; - string name?; - string path_lower?; - string rev?; - string server_modified?; - decimal size?; - inline_response_200_37_team_member_info team_member_info?; - string url?; -}; - public type legal_holds_update_policy_body record { string id?; string[] members?; @@ -123,20 +100,29 @@ public type teammemberssecondary_emailsadd_new_secondary_emails record { teamgroupsmembersadd_user user?; }; -public type inline_response_200_72_values record { +public type GetTeamEventsResult record { + string cursor?; + TeamEvent[] events?; + boolean has_more?; +}; + +public type sharingadd_file_member_result record { string \.tag?; - inline_response_200_72_paper_as_files paper_as_files?; }; -public type inline_response_200_59_members record { - teammembersget_info_profile profile?; - teammembersget_info_role role?; +public type ContentSyncSetting record { + string id?; + SyncSetting sync_setting?; }; -public type sharingadd_file_member_result record { +public type GracePeriod record { string \.tag?; }; +public type ListFolderLongpollResult record { + boolean changes?; +}; + public type member_space_limits_set_custom_quota_body record { teammember_space_limitsset_custom_quota_users_and_quotas[] users_and_quotas?; }; @@ -148,11 +134,19 @@ public type MoveBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type PropertyFieldTemplateTypeAsReponse record { + string \.tag?; +}; + public type sharing_list_folders_body record { anydata[] actions?; decimal 'limit?; }; +public type AddTemplateResponse record { + string template_id?; +}; + public type sharingget_file_metadatabatch_result_owner_team record { string id?; string name?; @@ -176,6 +170,24 @@ public type job_status_get_body_2 record { string async_job_id?; }; +public type SaveUrlResult record { + string \.tag?; + string client_modified?; + string content_hash?; + FileLockInfo file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + MetadataSharingInfo sharing_info?; + decimal size?; +}; + public type files_search_v2_body record { boolean include_highlights?; string query?; @@ -188,26 +200,34 @@ public type GetSharedLinkFileHeaders record { string? dropbox\-api\-select\-user?; }; +public type LegalHoldPolicyAsResponse record { + string activation_time?; + string end_date?; + string id?; + MembersInfo members?; + string name?; + string start_date?; + teamgroupsget_info_profile_status status?; +}; + # Represents the Headers record for the operation: setProfilePhoto public type SetProfilePhotoHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type file_requests_get_body record { - string id?; -}; - -public type templates_update_for_user_body record { - PropertyFieldTemplate[] add_fields?; +public type GetTemplateResponse record { string description?; + PropertyFieldTemplateAsResponse[] fields?; string name?; - string template_id?; }; -public type inline_response_200_71_origin record { - inline_response_200_71_origin_access_method access_method?; - inline_response_200_71_origin_geo_location geo_location?; +public type file_requests_get_body record { + string id?; +}; + +public type EmmStateOrOfficeAddinPolicy record { + string \.tag?; }; public type team_folder_permanently_delete_body record { @@ -231,13 +251,6 @@ public type files_list_folder_body record { boolean recursive?; }; -public type templates_update_for_team_body record { - PropertyFieldTemplate[] add_fields?; - string description?; - string name?; - string template_id?; -}; - public type sharing_list_shared_links_body record { string cursor?; }; @@ -252,12 +265,6 @@ public type list_folders_continue_body record { string cursor?; }; -public type inline_response_200_16_export_metadata record { - string export_hash?; - string name?; - decimal size?; -}; - # Provides settings related to HTTP/1.x protocol. public type ClientHttp1Settings record {| # Specifies whether to reuse a connection for multiple requests @@ -273,33 +280,11 @@ public type sharingadd_file_member_members record { string email?; }; -public type inline_response_200_29_entries record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_9_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_9_metadata_sharing_info sharing_info?; - decimal size?; -}; - public type teamteam_folderupdate_sync_settings_content_sync_settings record { string id?; string sync_setting?; }; -public type inline_response_200_71_actor_user_team record { - string display_name?; -}; - # Represents the Headers record for the operation: getTemporaryLink public type GetTemporaryLinkHeaders record { string? dropbox\-api\-path\-root?; @@ -312,25 +297,12 @@ public type AddTemplateForTeam record { string name?; }; -public type inline_response_200_61_results_1 record { - string \.tag?; - inline_response_200_61_results[] results?; - members_send_welcome_email_body user?; -}; - public type sharing_update_folder_member_body record { string access_level?; sharingadd_file_member_members member?; string shared_folder_id?; }; -public type inline_response_200_71_details record { - string \.tag?; - inline_response_200_71_details_shared_content_access_level shared_content_access_level?; - string shared_content_link?; - inline_response_200_71_actor_user shared_content_owner?; -}; - # Represents the Headers record for the operation: getThumbnailBatch public type GetThumbnailBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -353,9 +325,18 @@ public type ListFileMembersContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_62_results record { +public type UserFeatureValue record { string \.tag?; - string success?; + PaperAsFilesValue paper_as_files?; +}; + +public type LinkAudience record { + string \.tag?; +}; + +public type AccessMethodLogInfo record { + string \.tag?; + SessionLogInfo end_user?; }; # Represents the Headers record for the operation: getTemporaryUploadLink @@ -389,6 +370,11 @@ public type ListMountableFoldersContinueHeaders record { string? dropbox\-api\-select\-user?; }; +public type ListFoldersResult record { + string cursor?; + SharedFolderMetadata[] entries?; +}; + public type sharingget_file_metadatabatch_result_policy_acl_update_policy record { string \.tag?; }; @@ -400,6 +386,10 @@ public type PermanentlyDeleteHeaders record { string? dropbox\-api\-select\-user?; }; +public type ExcludedUsersUpdateResult record { + sharingadd_file_member_result status?; +}; + public type get_events_continue_body record { string cursor?; }; @@ -410,28 +400,59 @@ public type sharinglist_file_membersbatch_result_members record { sharinglist_file_membersbatch_result_members_users[] users?; }; -public type inline_response_200_33_link_metadata_link_permissions record { - inline_response_200_33_link_metadata_action action?; - boolean allow?; +public type FileRequestAsResponse record { + string created?; + FileRequestDeadlineWithTag deadline?; + string destination?; + decimal file_count?; + string id?; + boolean is_open?; + string title?; + string url?; }; public type team_folder_list_body record { decimal 'limit?; }; +public type ExportFileResponseMetadata record { + string export_hash?; + string name?; + decimal size?; +}; + public type teamgroupsget_info_members record { teamgroupsget_info_access_type access_type?; teamgroupsget_info_profile profile?; }; -public type list_folder_continue_body record { +public type MetadataV2 record { + string \.tag?; + MetadataAsResponse metadata?; +}; + +public type TeamFolderListResult record { string cursor?; + boolean has_more?; + TeamFolderMetadata[] team_folders?; +}; + +public type SharedLinkMetadataLinkPermissions record { + boolean can_revoke?; + LinkAudience resolved_visibility?; + SharedLinkAccessFailureReason revoke_failure_reason?; }; -public type inline_response_200_56_complete record { +public type NamespaceType record { string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; +}; + +public type list_folder_continue_body record { + string cursor?; +}; + +public type TeamLogInfo record { + string display_name?; }; # Represents the Headers record for the operation: listMountableFolders @@ -440,11 +461,32 @@ public type ListMountableFoldersHeaders record { string? dropbox\-api\-select\-user?; }; +public type SetAdminPermissionsResult record { + teammembersget_info_role role?; + string team_member_id?; +}; + +public type PaperAsFilesValue record { + string \.tag?; + boolean enabled?; +}; + public type sharing_get_file_metadata_body record { anydata[] actions?; string file?; }; +public type FileRequest record { + string created?; + FileRequestDeadlineWithTag deadline?; + string destination?; + decimal file_count?; + string id?; + boolean is_open?; + string title?; + string url?; +}; + public type file_requests_delete_body record { string[] ids?; }; @@ -468,10 +510,6 @@ public type TransferFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_69_policies_sharing_shared_link_create_policy record { - string \.tag?; -}; - public type filesget_file_lock_batch_entries record { string path?; }; @@ -480,16 +518,54 @@ public type files_get_temporary_link_body record { string path?; }; +public type ParticipantLogInfo record { + string \.tag?; + UserLogInfo user?; +}; + +public type MetadataAsResponse record { + string \.tag?; + string client_modified?; + string content_hash?; + FileLockInfo file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + MetadataSharingInfo sharing_info?; + decimal size?; +}; + +public type GetThumbnailBatchResponse record { + GetThumbnailBatchResultEntry[] entries?; +}; + public type teamgroupsmembersadd_user record { string \.tag?; string team_member_id?; }; +public type SharedLinkAccessFailureReason record { + string \.tag?; +}; + public type files_save_url_body record { string path?; string url?; }; +public type UpdateTemplateForTeamRequest record { + PropertyFieldTemplate[] add_fields?; + string description?; + string name?; + string template_id?; +}; + public type archive_check_body record { string async_job_id?; }; @@ -534,33 +610,6 @@ public type list_continue_body record { string cursor?; }; -public type inline_response_200_67_team_folders record { - inline_response_200_65_content_sync_settings[] content_sync_settings?; - boolean is_team_shared_dropbox?; - string name?; - teamgroupsget_info_profile_status status?; - inline_response_200_65_sync_setting sync_setting?; - string team_folder_id?; -}; - -public type inline_response_200_23_entries record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_9_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_23_sharing_info sharing_info?; - decimal size?; -}; - public type sharing_get_folder_metadata_body record { anydata[] actions?; string shared_folder_id?; @@ -584,29 +633,53 @@ public type AddFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; -# Represents the Headers record for the operation: checkJobStatus -public type CheckJobStatusHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-admin?; - string? dropbox\-api\-select\-user?; +public type GroupMembersChangeResult record { + string async_job_id?; + GroupFullInfo group_info?; }; -public type inline_response_200_75_team record { - string id?; - string name?; - inline_response_200_69_policies_emm_state office_addin_policy?; - inline_response_200_69_policies_sharing sharing_policies?; +public type SyncSetting record { + string \.tag?; }; -public type members_suspend_body record { - members_send_welcome_email_body user?; - boolean wipe_data?; +public type UploadSessionFinishBatchResult record { + string \.tag?; + UploadSessionFinishBatchResultEntry[] entries?; }; -# Represents the Headers record for the operation: propertiesSearch -public type PropertiesSearchHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; +public type FolderSharingInfo record { + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; +}; + +public type TeamNamespacesListResult record { + string cursor?; + boolean has_more?; + NamespaceMetadata[] namespaces?; +}; + +public type SharedLinkCreatePolicy record { + string \.tag?; +}; + +# Represents the Headers record for the operation: checkJobStatus +public type CheckJobStatusHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type members_suspend_body record { + members_send_welcome_email_body user?; + boolean wipe_data?; +}; + +# Represents the Headers record for the operation: propertiesSearch +public type PropertiesSearchHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; public type legal_holds_create_policy_body record { @@ -623,34 +696,44 @@ public type MoveHeaders record { string? dropbox\-api\-select\-user?; }; +public type TeamMemberPolicies record { + EmmStateOrOfficeAddinPolicy emm_state?; + EmmStateOrOfficeAddinPolicy office_addin?; + TeamSharingPolicies sharing?; +}; + public type sharing_relinquish_folder_membership_body record { boolean leave_a_copy?; string shared_folder_id?; }; -public type inline_response_200_23_sharing_info record { - string modified_by?; - boolean no_access?; - string parent_shared_folder_id?; - boolean read_only?; - boolean traverse_only?; +public type GetCopyReferenceResponse record { + string copy_reference?; + string expires?; + MetadataAsResponse metadata?; }; -public type inline_response_200_9_metadata_sharing_info record { - string modified_by?; - string parent_shared_folder_id?; - boolean read_only?; +public type LegalHoldHeldRevisionMetadata record { + string author_email?; + string author_member_id?; + teamgroupsget_info_profile_status author_member_status?; + string content_hash?; + string file_type?; + string new_filename?; + string original_file_path?; + string original_revision_id?; + string server_modified?; + decimal size?; }; -public type SearchPropertiesMode record { +public type SessionLogInfo record { string \.tag?; - string field_name?; + string session_id?; }; -public type inline_response_200_75_root_info record { +public type SearchPropertiesMode record { string \.tag?; - string home_namespace_id?; - string root_namespace_id?; + string field_name?; }; # Represents the Headers record for the operation: getAccountBatch @@ -659,6 +742,11 @@ public type GetAccountBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type GetTemporaryLinkResponse record { + string link?; + FileMetadata metadata?; +}; + public type filesget_temporary_upload_link_commit_info record { boolean autorename?; string mode?; @@ -677,12 +765,6 @@ public type members_add_body record { boolean return_members?; }; -public type inline_response_200_37_team_member_info record { - string display_name?; - string member_id?; - sharingget_file_metadatabatch_result_owner_team team_info?; -}; - # Represents the Headers record for the operation: deleteBatch public type DeleteBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -733,6 +815,13 @@ public type namespaces_list_body record { decimal 'limit?; }; +public type NamespaceMetadata record { + string name?; + string namespace_id?; + NamespaceType namespace_type?; + string team_member_id?; +}; + # Represents the Headers record for the operation: listReceivedFiles public type ListReceivedFilesHeaders record { string? dropbox\-api\-path\-root?; @@ -748,16 +837,19 @@ public type groups_update_body record { boolean return_members?; }; -public type PropertyFieldTemplate record { - string description?; - string name?; - string 'type?; +public type CustomQuotaResponse record { + string \.tag?; }; -public type inline_response_200_3_fields record { +public type CreateFolderBatchResponse record { + string \.tag?; + CreateFolderBatchResponseEntry[] entries?; +}; + +public type PropertyFieldTemplate record { string description?; string name?; - inline_response_200_3_type 'type?; + string 'type?; }; public type team_folder_activate_body record { @@ -769,19 +861,25 @@ public type members_add_body_1 record { teammembersadd_new_members[] new_members?; }; -public type inline_response_200_40_users record { - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inherited?; - anydata[] permissions?; - sharinglist_file_membersbatch_result_members_user user?; -}; - # Represents the Headers record for the operation: templatesGetForUser public type TemplatesGetForUserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type ExportFileResponse record { + ExportFileResponseMetadata export_metadata?; + FileMetadata file_metadata?; +}; + +public type GetThumbnailResponse record { + FileMetadata file_metadata?; +}; + +public type GetTemporaryUploadLinkResponse record { + string link?; +}; + public type sharing_list_received_files_body record { anydata[] actions?; decimal 'limit?; @@ -796,6 +894,12 @@ public type teammembersadd_new_members record { boolean send_welcome_email?; }; +public type RootInfo record { + string \.tag?; + string home_namespace_id?; + string root_namespace_id?; +}; + public type legal_holds_get_policy_body record { string id?; }; @@ -812,6 +916,14 @@ public type GetFileMetadataBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type EventCategory record { + string \.tag?; +}; + +public type LegalHoldsListPoliciesResult record { + LegalHoldPolicyAsResponse[] policies?; +}; + # Represents the Headers record for the operation: featuresGetValues1 public type FeaturesGetValues1Headers record { string? dropbox\-api\-path\-root?; @@ -824,51 +936,78 @@ public type CopyReferenceSaveHeaders record { string? dropbox\-api\-select\-user?; }; +public type GroupsGetInfoItem record { + string \.tag?; + decimal created?; + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + teamgroupsget_info_members[] members?; +}; + public type sharingadd_folder_member_member record { string \.tag?; string dropbox_id?; string email?; }; +public type TeamSharingPolicies record { + SharedFolderJoinPolicy shared_folder_join_policy?; + SharedFolderMemberPolicy shared_folder_member_policy?; + SharedLinkCreatePolicy shared_link_create_policy?; +}; + # Represents the Headers record for the operation: templatesUpdateForUser public type TemplatesUpdateForUserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_42_entries record { - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; +public type ShareFolderResponse record { + string \.tag?; + AccessInheritance access_inheritance?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inside_team_folder?; + boolean is_team_folder?; + SharedContentLinkMetadata link_metadata?; string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; string path_lower?; anydata[] permissions?; sharingget_file_metadatabatch_result_policy policy?; string preview_url?; + string shared_folder_id?; string time_invited?; }; +public type AssetLogInfo record { + string \.tag?; + string display_name?; + string file_id?; + decimal file_size?; + PathLogInfo path?; +}; + public type list_mountable_folders_continue_body record { string cursor?; }; +public type SharedFileMembers record { + sharinglist_file_membersbatch_result_members_groups[] groups?; + sharinglist_file_membersbatch_result_members_invitees[] invitees?; + sharinglist_file_membersbatch_result_members_users[] users?; +}; + public type OverwritePropertiesRequest record { string path?; PropertyGroup[] property_groups?; }; -public type inline_response_200_69_policies record { - inline_response_200_69_policies_emm_state emm_state?; - inline_response_200_69_policies_emm_state office_addin?; - inline_response_200_69_policies_sharing sharing?; -}; - -public type inline_response_200_61_results record { - string \.tag?; - string not_found?; - string success?; +public type UserMembershipInfo record { + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inherited?; + anydata[] permissions?; + sharinglist_file_membersbatch_result_members_user user?; }; public type sharinglist_file_membersbatch_result_members_invitees record { @@ -882,6 +1021,10 @@ public type GetTemplateForTeam record { string template_id?; }; +public type ResendVerificationEmailResult record { + UserResendResult[] results?; +}; + public type member_space_limits_get_custom_quota_body record { teamgroupsmembersadd_user[] users?; }; @@ -890,10 +1033,8 @@ public type legal_holds_list_policies_body record { boolean include_released?; }; -public type inline_response_200_62_results_1 record { - string \.tag?; - inline_response_200_62_results[] results?; - members_send_welcome_email_body user?; +public type UserFeaturesGetValuesResult record { + UserFeatureValue[] values?; }; # Represents the Headers record for the operation: getFileLockBatch @@ -915,23 +1056,24 @@ public type RelinquishFolderMembershipHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_71_events record { - inline_response_200_71_actor actor?; - inline_response_200_71_assets[] assets?; - inline_response_200_71_actor_user context?; - inline_response_200_71_details details?; - inline_response_200_71_event_category event_category?; - inline_response_200_71_event_type event_type?; - boolean involve_non_team_member?; - inline_response_200_71_origin origin?; - inline_response_200_71_participants[] participants?; - string timestamp?; +public type FileRequestCount record { + decimal file_request_count?; +}; + +public type FeatureValue record { + string \.tag?; + HasTeamSharedDropboxValue has_team_shared_dropbox?; + UploadApiRateLimitValue upload_api_rate_limit?; }; public type teammembersget_info_role record { string \.tag?; }; +public type FeaturesGetValuesResponse record { + FeatureValue[] values?; +}; + public type PropertyField record { string name?; string value?; @@ -944,11 +1086,6 @@ public type ListFolderLongpollHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_13_entries record { - string \.tag?; - inline_response_200_12_metadata metadata?; -}; - public type team_folder_create_body record { string name?; string sync_setting?; @@ -973,20 +1110,48 @@ public type secondary_emails_delete_body record { teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_delete?; }; +public type FullAccount record { + string account_id?; + AccountType account_type?; + string country?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_paired?; + string locale?; + teamgroupsget_info_profile_name name?; + string referral_link?; + RootInfo root_info?; + FullTeam team?; + string team_member_id?; +}; + +public type EchoResult record { + string result?; +}; + +public type TeamMemberInfoV2Result record { + teammembersget_info_profile profile?; + teammembersget_info_role role?; +}; + # Represents the Headers record for the operation: list public type ListHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_71_path_namespace_relative record { - boolean is_shared_namespace?; - string ns_id?; - string relative_path?; +public type EventType record { + string \.tag?; + string description?; }; -public type inline_response_200_64_namespace_type record { - string \.tag?; +public type SharedContentLinkMetadata record { + LinkAudience[] audience_options?; + LinkAudience current_audience?; + LinkPermission[] link_permissions?; + boolean password_protected?; + string url?; }; # Represents the Headers record for the operation: uploadSessionStart @@ -1001,13 +1166,6 @@ public type SearchPropertiesContinueRequest record { string cursor?; }; -public type inline_response_200_1_matches record { - string id?; - boolean is_deleted?; - string path?; - PropertyGroup[] property_groups?; -}; - public type members_remove_body record { groups_delete_body group?; boolean return_members?; @@ -1021,16 +1179,25 @@ public type UpdateFileMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharing_unshare_file_body record { - string file?; -}; - # Represents the Headers record for the operation: listReceivedFilesContinue public type ListReceivedFilesContinueHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type TeamEvent record { + ActorLogInfo actor?; + AssetLogInfo[] assets?; + UserLogInfo context?; + EventDetails details?; + EventCategory event_category?; + EventType event_type?; + boolean involve_non_team_member?; + OriginLogInfo origin?; + ParticipantLogInfo[] participants?; + string timestamp?; +}; + public type sharing_add_file_member_body record { string access_level?; boolean add_message_as_comment?; @@ -1040,12 +1207,6 @@ public type sharing_add_file_member_body record { boolean quiet?; }; -public type inline_response_200_69_policies_sharing record { - inline_response_200_69_policies_sharing_shared_folder_join_policy shared_folder_join_policy?; - sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; - inline_response_200_69_policies_sharing_shared_link_create_policy shared_link_create_policy?; -}; - # Represents the Headers record for the operation: removeFileMember2 public type RemoveFileMember2Headers record { string? dropbox\-api\-path\-root?; @@ -1053,6 +1214,10 @@ public type RemoveFileMember2Headers record { string? dropbox\-api\-select\-user?; }; +public type AccessInheritance record { + string \.tag?; +}; + public type move_batch_check_v2_body record { string async_job_id?; }; @@ -1063,49 +1228,30 @@ public type sharing_modify_shared_link_settings_body record { string url?; }; -public type inline_response_200_9 record { - inline_response_200_9_metadata metadata?; -}; - public type teamfeaturesget_values_features record { string \.tag?; }; -public type inline_response_200_5 record { - decimal file_request_count?; +# Represents the Headers record for the operation: updateFolderPolicy +public type UpdateFolderPolicyHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -public type inline_response_200_72_paper_as_files record { +public type LockFileResultEntry record { string \.tag?; - boolean enabled?; -}; - -public type inline_response_200_6 record { - string created?; - inline_response_200_6_deadline deadline?; - string destination?; - decimal file_count?; - string id?; - boolean is_open?; - string title?; - string url?; -}; - -public type inline_response_200_7 record { - inline_response_200_7_file_requests[] file_requests?; + FileLock 'lock?; + MetadataAsResponse metadata?; }; -public type inline_response_200_8 record { - string cursor?; - inline_response_200_7_file_requests[] file_requests?; - boolean has_more?; +public type UploadSessionStartResult record { + string session_id?; }; -# Represents the Headers record for the operation: updateFolderPolicy -public type UpdateFolderPolicyHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-admin?; - string? dropbox\-api\-select\-user?; +public type LaunchResultBase record { + string \.tag?; + string async_job_id?; }; public type GetTemplateForUserRequest record { @@ -1143,23 +1289,41 @@ public type sharing_update_file_member_body record { sharingadd_file_member_members member?; }; +public type MemberAddResult record { + string \.tag?; + teammembersget_info_profile profile?; + teammembersget_info_role role?; +}; + public type teamgroupsget_info_profile_secondary_emails record { string email?; boolean is_verified?; }; -public type inline_response_200_1 record { - inline_response_200_1_matches[] matches?; -}; - -public type inline_response_200_2 record { - string template_id?; +public type SharedFolderMetadata record { + AccessInheritance access_inheritance?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inside_team_folder?; + boolean is_team_folder?; + SharedContentLinkMetadata link_metadata?; + string name?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string shared_folder_id?; + string time_invited?; }; -public type inline_response_200_3 record { - string description?; - inline_response_200_3_fields[] fields?; - string name?; +public type UnshareFileRequest record { + string file?; +}; + +public type CreateFileRequestRequest record { + FileRequestDeadline deadline?; + string destination?; + boolean open?; + string title?; }; public type files_copy_batch_v2_body record { @@ -1167,8 +1331,9 @@ public type files_copy_batch_v2_body record { filescopy_batch_v2_entries[] entries?; }; -public type inline_response_200_4 record { - string[] template_ids?; +public type CopyBatchResponseEntries record { + string \.tag?; + MetadataAsResponse success?; }; public type members_set_profile_photo_body record { @@ -1176,49 +1341,14 @@ public type members_set_profile_photo_body record { members_send_welcome_email_body user?; }; -public type inline_response_200_11 record { - string copy_reference?; - string expires?; - inline_response_200_9_metadata metadata?; -}; - public type members_recover_body record { teamgroupsmembersadd_user user?; }; -public type inline_response_200_10 record { - string \.tag?; - inline_response_200_10_entries[] entries?; -}; - -public type inline_response_200_64_namespaces record { - string name?; - string namespace_id?; - inline_response_200_64_namespace_type namespace_type?; - string team_member_id?; -}; - -public type inline_response_200_13 record { - string \.tag?; - inline_response_200_13_entries[] entries?; -}; - -public type inline_response_200_12 record { - inline_response_200_12_metadata metadata?; -}; - -public type inline_response_200_68_upload_api_rate_limit record { - string \.tag?; - decimal 'limit?; -}; - -public type inline_response_200_33_access_inheritance record { - string \.tag?; -}; - -public type inline_response_200_19 record { - string link?; - inline_response_200_16_file_metadata metadata?; +public type TeamMemberInfo record { + string display_name?; + string member_id?; + sharingget_file_metadatabatch_result_owner_team team_info?; }; public type files_list_revisions_body record { @@ -1227,45 +1357,16 @@ public type files_list_revisions_body record { string path?; }; -public type inline_response_200_18 record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_9_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_9_metadata_sharing_info sharing_info?; - decimal size?; -}; - # Represents the Headers record for the operation: user public type UserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_15 record { - string client_modified?; - string content_hash?; - inline_response_200_9_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_9_metadata_sharing_info sharing_info?; - decimal size?; +public type FileLockInfo record { + string created?; + boolean is_lockholder?; + string lockholder_name?; }; public type teammembersget_info_profile_secondary_emails record { @@ -1280,13 +1381,9 @@ public type CreateFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_14 record { +public type MembersAddResult record { string \.tag?; - inline_response_200_14_entries[] entries?; -}; - -public type inline_response_200_17 record { - inline_response_200_17_entries[] entries?; + MemberAddResult[] complete?; }; public type AddTemplateForUser record { @@ -1295,21 +1392,15 @@ public type AddTemplateForUser record { string name?; }; -public type inline_response_200_16 record { - inline_response_200_16_export_metadata export_metadata?; - inline_response_200_16_file_metadata file_metadata?; -}; - -public type inline_response_200_48_groups record { - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; +public type ListRevisionsResult record { + FileMetadata[] entries?; + boolean is_deleted?; }; -public type inline_response_200_71_origin_access_method_end_user record { - string \.tag?; - string session_id?; +public type GroupsListResult record { + string cursor?; + GroupSummary[] groups?; + boolean has_more?; }; # Represents the Headers record for the operation: deleteManualContacts @@ -1318,6 +1409,20 @@ public type DeleteManualContactsHeaders record { string? dropbox\-api\-select\-user?; }; +public type SharedLinkMetadata record { + string \.tag?; + string client_modified?; + string id?; + SharedLinkMetadataLinkPermissions link_permissions?; + string name?; + string path_lower?; + string rev?; + string server_modified?; + decimal size?; + TeamMemberInfo team_member_info?; + string url?; +}; + # Represents the Headers record for the operation: count public type CountHeaders record { string? dropbox\-api\-path\-root?; @@ -1330,6 +1435,15 @@ public type SearchHeaders record { string? dropbox\-api\-select\-user?; }; +public type DeleteBatchResponse record { + string \.tag?; + DeleteBatchResultEntry[] entries?; +}; + +public type SharedFolderJoinPolicy record { + string \.tag?; +}; + public type TokenFromOauth1Request record { string oauth1_token?; string oauth1_token_secret?; @@ -1368,10 +1482,19 @@ public type sharingget_file_metadatabatch_result record { string time_invited?; }; -public type inline_response_200_71_event_category record { +public type SearchPropertiesResponse record { + SearchProperties[] matches?; +}; + +public type AccountType record { string \.tag?; }; +public type GetFileMetadataIndicidualResult record { + string file?; + sharingget_file_metadatabatch_result result?; +}; + # Represents the Headers record for the operation: unshareFolder public type UnshareFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -1379,12 +1502,9 @@ public type UnshareFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_71_assets record { +public type SpaceAllocation record { string \.tag?; - string display_name?; - string file_id?; - decimal file_size?; - inline_response_200_71_path path?; + decimal allocated?; }; # Represents the Headers record for the operation: listFileMembers @@ -1407,55 +1527,11 @@ public type filesupload_sessionfinish_batch_entries record { filesupload_sessionfinish_batch_cursor cursor?; }; -public type inline_response_200_33 record { - string \.tag?; - inline_response_200_33_access_inheritance access_inheritance?; - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inside_team_folder?; - boolean is_team_folder?; - inline_response_200_33_link_metadata link_metadata?; - string name?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string shared_folder_id?; - string time_invited?; -}; - -public type inline_response_200_32 record { - string \.tag?; -}; - -public type inline_response_200_35 record { - string file?; - sharingget_file_metadatabatch_result result?; -}; - public type groups_delete_body record { string \.tag?; string group_id?; }; -public type inline_response_200_71_participants record { - string \.tag?; - inline_response_200_71_user user?; -}; - -public type inline_response_200_34 record { - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; -}; - public type members_get_info_body record { teamgroupsmembersadd_user[] members?; }; @@ -1464,13 +1540,17 @@ public type secondary_emails_resend_verification_emails_body record { teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_resend?; }; -public type inline_response_200_31 record { - sharingadd_file_member_members member?; - sharingadd_file_member_result result?; +public type PropertyFieldTemplateAsResponse record { + string description?; + string name?; + PropertyFieldTemplateTypeAsReponse 'type?; }; -public type inline_response_200_30 record { - string session_id?; +public type FileLockContent record { + string \.tag?; + string created?; + string lock_holder_account_id?; + string lock_holder_team_id?; }; # Represents the Headers record for the operation: deleteBatchCheck @@ -1484,10 +1564,6 @@ public type sharing_check_job_status_body record { string async_job_id?; }; -public type inline_response_200_69_policies_sharing_shared_folder_join_policy record { - string \.tag?; -}; - # Represents the Headers record for the operation: getSpaceUsage public type GetSpaceUsageHeaders record { string? dropbox\-api\-path\-root?; @@ -1500,20 +1576,6 @@ public type team_folder_update_sync_settings_body record { string team_folder_id?; }; -public type inline_response_200_37 record { - string \.tag?; - string client_modified?; - string id?; - inline_response_200_37_link_permissions link_permissions?; - string name?; - string path_lower?; - string rev?; - string server_modified?; - decimal size?; - inline_response_200_37_team_member_info team_member_info?; - string url?; -}; - # Represents the Headers record for the operation: shareFolder public type ShareFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -1521,30 +1583,17 @@ public type ShareFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_36 record { - inline_response_200_33_access_inheritance access_inheritance?; - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inside_team_folder?; - boolean is_team_folder?; - inline_response_200_33_link_metadata link_metadata?; - string name?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string shared_folder_id?; - string time_invited?; -}; - -public type inline_response_200_39 record { - string file?; - sharinglist_file_membersbatch_result result?; +public type DeleteFileRequestsResponse record { + FileRequestAsResponse[] file_requests?; }; -public type inline_response_200_38 record { - sharinglist_file_membersbatch_result_members_groups[] groups?; - sharinglist_file_membersbatch_result_members_invitees[] invitees?; - sharinglist_file_membersbatch_result_members_users[] users?; +public type GroupFullInfo record { + decimal created?; + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + teamgroupsget_info_members[] members?; }; public type legal_holds_list_held_revisions_body record { @@ -1567,15 +1616,15 @@ public type files_lock_file_batch_body record { filesget_file_lock_batch_entries[] entries?; }; -public type inline_response_200_60_results record { +public type groups_get_info_body record { string \.tag?; - teamgroupsget_info_profile_secondary_emails success?; - string unavailable?; + string[] group_ids?; }; -public type groups_get_info_body record { +public type MembersGetInfoItem record { string \.tag?; - string[] group_ids?; + teammembersget_info_profile profile?; + teammembersget_info_role role?; }; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. @@ -1613,35 +1662,13 @@ public type ConnectionConfig record {| boolean validation = true; |}; -public type inline_response_200_22 record { - inline_response_200_22_entries[] entries?; -}; - -public type inline_response_200_21 record { - inline_response_200_16_file_metadata file_metadata?; -}; - -public type inline_response_200_24 record { - boolean changes?; -}; - -public type inline_response_200_23 record { - string cursor?; - inline_response_200_23_entries[] entries?; - boolean has_more?; -}; - -public type inline_response_200_20 record { - string link?; -}; - -public type file_requestscreate_deadline record { - string allow_late_uploads?; - string deadline?; +public type DeleteBatchResultEntry record { + string \.tag?; + MetadataAsResponse metadata?; }; -public type files_delete_batch_body record { - files_delete_v2_body[] entries?; +public type CheckJobStatusResponse record { + string \.tag?; }; # Represents the Headers record for the operation: create @@ -1657,11 +1684,6 @@ public type Delete1Headers record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_29 record { - string \.tag?; - inline_response_200_29_entries[] entries?; -}; - public type files_get_metadata_body record { boolean include_deleted?; boolean include_has_explicit_shared_members?; @@ -1669,38 +1691,6 @@ public type files_get_metadata_body record { string path?; }; -public type inline_response_200_26 record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_9_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_9_metadata_sharing_info sharing_info?; - decimal size?; -}; - -public type inline_response_200_25 record { - inline_response_200_16_file_metadata[] entries?; - boolean is_deleted?; -}; - -public type inline_response_200_28 record { - boolean has_more?; - inline_response_200_28_matches[] matches?; -}; - -public type inline_response_200_27 record { - string \.tag?; -}; - public type files_get_temporary_upload_link_body record { filesget_temporary_upload_link_commit_info commit_info?; decimal duration?; @@ -1731,63 +1721,40 @@ public type DownloadHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharingget_file_metadatabatch_result_policy_resolved_member_policy record { - string \.tag?; +public type FileRequestDeadlineWithTag record { + GracePeriod allow_late_uploads?; + string deadline?; }; -public type inline_response_200_65_sync_setting record { +public type file_requestsupdate_deadline record { string \.tag?; + string allow_late_uploads?; + string deadline?; }; -public type inline_response_200_55 record { - string cursor?; - boolean has_more?; - anydata[] users?; -}; - -public type inline_response_200_54 record { - sharingadd_file_member_result status?; +public type UserAddResult record { + string \.tag?; + members_send_welcome_email_body invalid_user?; + AddSecondaryEmailResult[] results?; + members_send_welcome_email_body user?; }; -public type inline_response_200_57 record { - teammembersget_info_profile profile?; - teammembersget_info_role role?; -}; - -public type inline_response_200_56 record { +public type Metadata record { string \.tag?; - inline_response_200_56_complete[] complete?; -}; - -public type inline_response_200_51 record { - string activation_time?; - string end_date?; + string client_modified?; + string content_hash?; + FileLockInfo file_lock_info?; + boolean has_explicit_shared_members?; string id?; - inline_response_200_51_members members?; + boolean is_downloadable?; string name?; - string start_date?; - teamgroupsget_info_profile_status status?; -}; - -public type inline_response_200_50 record { - string cursor?; - boolean has_more?; - anydata[] members?; -}; - -public type inline_response_200_53 record { - inline_response_200_53_policies[] policies?; -}; - -public type file_requestsupdate_deadline record { - string \.tag?; - string allow_late_uploads?; - string deadline?; -}; - -public type inline_response_200_52 record { - inline_response_200_52_entries[] entries?; - boolean has_more?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + SharingInfo sharing_info?; + decimal size?; }; public type AddPropertiesRequest record { @@ -1806,26 +1773,25 @@ public type UnshareFileHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_59 record { - string cursor?; - boolean has_more?; - inline_response_200_59_members[] members?; -}; - -public type inline_response_200_58 record { - string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; -}; - -public type inline_response_200_33_link_metadata_action record { +public type DeleteSecondaryEmailResult record { string \.tag?; + string not_found?; + string success?; }; public type files_permanently_delete_body record { string path?; }; +public type TeamFolderMetadata record { + ContentSyncSetting[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + teamgroupsget_info_profile_status status?; + SyncSetting sync_setting?; + string team_folder_id?; +}; + public type list_folder_members_continue_body record { string cursor?; }; @@ -1837,138 +1803,90 @@ public type CheckShareJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_69_policies_emm_state record { - string \.tag?; -}; - -public type inline_response_200_60 record { - inline_response_200_60_results_1[] results?; -}; - public type team_log_get_events_body record { string category?; decimal 'limit?; }; -public type sharingget_file_metadatabatch_result_policy_member_policy record { - string \.tag?; -}; - -public type inline_response_200_44 record { - string \.tag?; +public type TeamGetInfoResponse record { + string name?; + decimal num_licensed_users?; + decimal num_provisioned_users?; + TeamMemberPolicies policies?; + string team_id?; }; -public type inline_response_200_43 record { +public type ExcludedUsersListResult record { string cursor?; boolean has_more?; - inline_response_200_43_links[] links?; + anydata[] users?; }; -public type inline_response_200_46 record { - decimal created?; - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; - teamgroupsget_info_members[] members?; +public type sharingget_file_metadatabatch_result_policy_member_policy record { + string \.tag?; }; -public type inline_response_200_45 record { - string \.tag?; - string async_job_id?; +public type SearchProperties record { + string id?; + boolean is_deleted?; + string path?; + PropertyGroup[] property_groups?; }; -public type members_send_welcome_email_body record { +public type UserLogInfo record { string \.tag?; + string account_id?; + string display_name?; + string email?; + string member_external_id?; + TeamLogInfo team?; string team_member_id?; }; -public type inline_response_200_40 record { - string cursor?; - sharinglist_file_membersbatch_result_members_groups[] groups?; - sharinglist_file_membersbatch_result_members_invitees[] invitees?; - inline_response_200_40_users[] users?; +public type members_send_welcome_email_body record { + string \.tag?; + string team_member_id?; }; -public type inline_response_200_42 record { - string cursor?; - inline_response_200_42_entries[] entries?; +public type ResendSecondaryEmailResult record { + string \.tag?; + string success?; }; -public type inline_response_200_41 record { - string cursor?; - inline_response_200_41_entries[] entries?; +public type GetFileMetadataResponse record { + sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; }; -public type inline_response_200_48 record { - string cursor?; - inline_response_200_48_groups[] groups?; +public type SearchFilesResponse record { boolean has_more?; + SearchMatch[] matches?; }; -public type inline_response_200_17_lock record { - inline_response_200_17_lock_content content?; -}; - -public type inline_response_200_47 record { - string \.tag?; - decimal created?; +public type GroupSummary record { string group_id?; sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; string group_name?; decimal member_count?; - teamgroupsget_info_members[] members?; -}; - -public type inline_response_200_17_entries record { - string \.tag?; - inline_response_200_17_lock 'lock?; - inline_response_200_9_metadata metadata?; -}; - -public type inline_response_200_49 record { - string async_job_id?; - inline_response_200_49_group_info group_info?; -}; - -public type inline_response_200_51_members record { - decimal permanently_deleted_users?; - string[] team_member_ids?; -}; - -public type inline_response_200_53_policies record { - string activation_time?; - string end_date?; - string id?; - inline_response_200_51_members members?; - string name?; - string start_date?; - teamgroupsget_info_profile_status status?; }; -public type inline_response_200_71_path record { - string contextual?; - inline_response_200_71_path_namespace_relative namespace_relative?; -}; - -public type inline_response_200_33_link_metadata record { - inline_response_200_33_link_metadata_audience_options[] audience_options?; - inline_response_200_33_link_metadata_audience_options current_audience?; - inline_response_200_33_link_metadata_link_permissions[] link_permissions?; - boolean password_protected?; - string url?; -}; - -public type file_requests_create_body record { - file_requestscreate_deadline deadline?; - string destination?; - boolean open?; - string title?; +public type TokenGetAuthenticatedAdminResult record { + teammembersget_info_profile admin_profile?; }; -public type inline_response_200_76 record { - inline_response_200_76_allocation allocation?; - decimal used?; +public type ListFolderResponse record { + string cursor?; + Metadata[] entries?; + boolean has_more?; }; # Represents the Headers record for the operation: tokenFromOauth1 @@ -1977,64 +1895,24 @@ public type TokenFromOauth1Headers record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_7_file_requests record { - string created?; - inline_response_200_6_deadline deadline?; - string destination?; - decimal file_count?; - string id?; - boolean is_open?; - string title?; - string url?; -}; - public type SearchPropertiesRequest record { SearchPropertiesQuery[] queries?; string template_filter?; }; -public type inline_response_200_73 record { - string account_id?; - boolean disabled?; - string email?; - boolean email_verified?; - boolean is_teammate?; - teamgroupsget_info_profile_name name?; - string profile_photo_url?; -}; - -public type inline_response_200_72 record { - inline_response_200_72_values[] values?; +public type GetThumbnailBatchResultEntry record { + string \.tag?; + FileMetadata metadata?; + string thumbnail?; }; public type file_requests_list_v2_body record { decimal 'limit?; }; -public type inline_response_200_75 record { - string account_id?; - inline_response_200_75_account_type account_type?; - string country?; - boolean disabled?; - string email?; - boolean email_verified?; - boolean is_paired?; - string locale?; - teamgroupsget_info_profile_name name?; - string referral_link?; - inline_response_200_75_root_info root_info?; - inline_response_200_75_team team?; - string team_member_id?; -}; - -public type inline_response_200_74 record { - string account_id?; - boolean disabled?; - string email?; - boolean email_verified?; - boolean is_teammate?; - teamgroupsget_info_profile_name name?; - string profile_photo_url?; +public type RelocationBatchV2Response record { + string \.tag?; + CopyBatchResponseEntries[] entries?; }; # Represents the Headers record for the operation: propertiesSearchContinue @@ -2060,13 +1938,6 @@ public type ExportHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_17_lock_content record { - string \.tag?; - string created?; - string lock_holder_account_id?; - string lock_holder_team_id?; -}; - public type users_get_account_body record { string account_id?; }; @@ -2077,6 +1948,20 @@ public type SearchContinueHeaders record { string? dropbox\-api\-select\-user?; }; +public type CreateFolderBatchResponseEntry record { + string \.tag?; + FolderMetadata metadata?; +}; + +public type SharedFolderMemberPolicy record { + string \.tag?; +}; + +public type UploadApiRateLimitValue record { + string \.tag?; + decimal 'limit?; +}; + # Represents the Headers record for the operation: getFileMetadata public type GetFileMetadataHeaders record { string? dropbox\-api\-path\-root?; @@ -2084,6 +1969,12 @@ public type GetFileMetadataHeaders record { string? dropbox\-api\-select\-user?; }; +public type UserResendResult record { + string \.tag?; + ResendSecondaryEmailResult[] results?; + members_send_welcome_email_body user?; +}; + public type teammember_space_limitsset_custom_quota_users_and_quotas record { decimal quota_gb?; teamgroupsmembersadd_user user?; @@ -2093,6 +1984,23 @@ public type team_folder_get_info_body record { string[] team_folder_ids?; }; +public type BasicAccount record { + string account_id?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_teammate?; + teamgroupsget_info_profile_name name?; + string profile_photo_url?; +}; + +public type FullTeam record { + string id?; + string name?; + EmmStateOrOfficeAddinPolicy office_addin_policy?; + TeamSharingPolicies sharing_policies?; +}; + # Represents the Headers record for the operation: getMetadata public type GetMetadataHeaders record { string? dropbox\-api\-path\-root?; @@ -2100,42 +2008,14 @@ public type GetMetadataHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_66 record { - string \.tag?; - inline_response_200_65_content_sync_settings[] content_sync_settings?; - boolean is_team_shared_dropbox?; - string name?; - teamgroupsget_info_profile_status status?; - inline_response_200_65_sync_setting sync_setting?; - string team_folder_id?; -}; - public type team_folder_rename_body record { string name?; string team_folder_id?; }; -public type inline_response_200_65 record { - inline_response_200_65_content_sync_settings[] content_sync_settings?; - boolean is_team_shared_dropbox?; - string name?; - teamgroupsget_info_profile_status status?; - inline_response_200_65_sync_setting sync_setting?; - string team_folder_id?; -}; - -public type inline_response_200_68 record { - inline_response_200_68_values[] values?; -}; - -public type inline_response_200_67 record { - string cursor?; - boolean has_more?; - inline_response_200_67_team_folders[] team_folders?; -}; - -public type inline_response_200_62 record { - inline_response_200_62_results_1[] results?; +public type OriginLogInfo record { + AccessMethodLogInfo access_method?; + GeoLocationLogInfo geo_location?; }; public type sharing_list_mountable_folders_body record { @@ -2143,57 +2023,49 @@ public type sharing_list_mountable_folders_body record { decimal 'limit?; }; -public type inline_response_200_61 record { - inline_response_200_61_results_1[] results?; -}; - -public type inline_response_200_64 record { - string cursor?; - boolean has_more?; - inline_response_200_64_namespaces[] namespaces?; -}; - -public type inline_response_200_63 record { - teammembersget_info_role role?; - string team_member_id?; +public type SharedFileMetadata record { + sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; }; -public type inline_response_200_60_results_1 record { +public type EventDetails record { string \.tag?; - members_send_welcome_email_body invalid_user?; - inline_response_200_60_results[] results?; - members_send_welcome_email_body user?; -}; - -public type inline_response_200_69 record { - string name?; - decimal num_licensed_users?; - decimal num_provisioned_users?; - inline_response_200_69_policies policies?; - string team_id?; + SharedContentAccessLevel shared_content_access_level?; + string shared_content_link?; + UserLogInfo shared_content_owner?; }; public type copy_reference_get_body record { string path?; }; -public type inline_response_200_71 record { +public type GetSpaceUsageResponse record { + SpaceAllocation allocation?; + decimal used?; +}; + +public type MembersListResult record { string cursor?; - inline_response_200_71_events[] events?; boolean has_more?; + TeamMemberInfoV2Result[] members?; }; public type save_url_check_job_status_body record { string async_job_id?; }; -public type inline_response_200_70 record { - teammembersget_info_profile admin_profile?; -}; - -public type inline_response_200_14_entries record { +public type HasTeamSharedDropboxValue record { string \.tag?; - inline_response_200_9_metadata metadata?; + boolean has_team_shared_dropbox?; }; public type list_folder_get_latest_cursor_body record { @@ -2221,10 +2093,14 @@ public type SearchPropertiesQuery record { string query?; }; -public type inline_response_200_37_link_permissions record { - boolean can_revoke?; - inline_response_200_33_link_metadata_audience_options resolved_visibility?; - inline_response_200_37_link_permissions_revoke_failure_reason revoke_failure_reason?; +public type TeamFolderArchiveResponse record { + string \.tag?; + ContentSyncSetting[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + teamgroupsget_info_profile_status status?; + SyncSetting sync_setting?; + string team_folder_id?; }; public type job_status_get_body record { @@ -2246,31 +2122,17 @@ public type sharinglist_file_membersbatch_result record { public type UpdatePropertiesRequest record { string path?; - PropertyGroupsUpdate[] update_property_groups?; -}; - -public type sharinglist_file_membersbatch_result_members_access_type record { - string \.tag?; -}; - -public type groups_list_body record { - decimal 'limit?; -}; - -public type inline_response_200_71_user record { - string \.tag?; - string account_id?; - string display_name?; - string email?; - string member_external_id?; - inline_response_200_71_actor_user_team team?; - string team_member_id?; + PropertyGroupsUpdate[] update_property_groups?; }; -public type inline_response_200_3_type record { +public type sharinglist_file_membersbatch_result_members_access_type record { string \.tag?; }; +public type groups_list_body record { + decimal 'limit?; +}; + public type members_list_body_1 record { boolean include_removed?; decimal 'limit?; @@ -2282,6 +2144,10 @@ public type GetAccountHeaders record { string? dropbox\-api\-select\-user?; }; +public type SearchMatch record { + MetadataV2 metadata?; +}; + # Represents the Headers record for the operation: deleteAllClosed public type DeleteAllClosedHeaders record { string? dropbox\-api\-path\-root?; @@ -2295,6 +2161,11 @@ public type members_set_access_type_body record { teamgroupsmembersadd_user user?; }; +public type LinkPermission record { + LinkAction action?; + boolean allow?; +}; + public type users_get_account_batch_body record { string[] account_ids?; }; @@ -2313,18 +2184,55 @@ public type members_move_former_member_files_body record { teamgroupsmembersadd_user user?; }; -public type inline_response_200_71_details_shared_content_access_level record { +public type DeleteFilesBatchRequest record { + FilePath[] entries?; +}; + +public type UploadSessionFinishBatchResultEntry record { + string \.tag?; + string client_modified?; + string content_hash?; + FileLockInfo file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + MetadataSharingInfo sharing_info?; + decimal size?; +}; + +public type UserDeleteResult record { string \.tag?; + DeleteSecondaryEmailResult[] results?; + members_send_welcome_email_body user?; }; -public type inline_response_200_6_deadline_allow_late_uploads record { +public type AddSecondaryEmailResult record { string \.tag?; + teamgroupsget_info_profile_secondary_emails success?; + string unavailable?; +}; + +public type LockFileBatchResult record { + LockFileResultEntry[] entries?; }; public type sharing_unmount_folder_body record { string shared_folder_id?; }; +public type UpdateTemplateForUserRequest record { + PropertyFieldTemplate[] add_fields?; + string description?; + string name?; + string template_id?; +}; + # Represents the Headers record for the operation: templatesAddForUser public type TemplatesAddForUserHeaders record { string? dropbox\-api\-path\-root?; @@ -2341,15 +2249,6 @@ public type members_list_body record { decimal 'limit?; }; -public type inline_response_200_49_group_info record { - decimal created?; - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; - teamgroupsget_info_members[] members?; -}; - public type sharing_remove_file_member_2_body record { string file?; sharingadd_file_member_members member?; @@ -2375,12 +2274,6 @@ public type SetProfilePhotoRequest record { Photo photo?; }; -public type inline_response_200_22_entries record { - string \.tag?; - inline_response_200_16_file_metadata metadata?; - string thumbnail?; -}; - public type list_file_members_batch_body record { string[] files?; decimal 'limit?; @@ -2396,6 +2289,10 @@ public type PropertyGroupsUpdate record { string template_id?; }; +public type FileLock record { + FileLockContent content?; +}; + public type RemoveTemplateForTeamRequest record { string template_id?; }; @@ -2416,10 +2313,6 @@ public type filesupload_sessionfinish_batch_cursor record { string session_id?; }; -public type inline_response_200_28_matches record { - inline_response_200_28_metadata metadata?; -}; - public type copy_reference_save_body record { string copy_reference?; string path?; @@ -2432,6 +2325,11 @@ public type ListFolderHeaders record { string? dropbox\-api\-select\-user?; }; +public type ActorLogInfo record { + string \.tag?; + UserLogInfo user?; +}; + # Represents the Headers record for the operation: propertiesOverwrite public type PropertiesOverwriteHeaders record { string? dropbox\-api\-path\-root?; @@ -2445,11 +2343,6 @@ public type UnlockFileBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_68_has_team_shared_dropbox record { - string \.tag?; - boolean has_team_shared_dropbox?; -}; - # Represents the Headers record for the operation: listFileMembersBatch public type ListFileMembersBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2505,6 +2398,17 @@ public type team_folder_archive_body record { string team_folder_id?; }; +public type FileRequestDeadline record { + string allow_late_uploads?; + string deadline?; +}; + +public type MetadataSharingInfo record { + string modified_by?; + string parent_shared_folder_id?; + boolean read_only?; +}; + # Represents the Headers record for the operation: removeFolderMember public type RemoveFolderMemberHeaders record { string? dropbox\-api\-path\-root?; @@ -2512,11 +2416,6 @@ public type RemoveFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_10_entries record { - string \.tag?; - inline_response_200_9_metadata success?; -}; - public type sharing_unshare_folder_body record { boolean leave_a_copy?; string shared_folder_id?; @@ -2526,30 +2425,16 @@ public type CheckUserRequest record { string query?; }; -public type inline_response_200_12_metadata_sharing_info record { - boolean no_access?; - string parent_shared_folder_id?; - boolean read_only?; - boolean traverse_only?; -}; - -public type inline_response_200_71_actor_user record { - string \.tag?; - string account_id?; - string display_name?; - string email?; - string member_external_id?; - inline_response_200_71_actor_user_team team?; - string team_member_id?; -}; - public type legal_holds_list_held_revisions_continue_body record { string id?; }; -public type inline_response_200_71_actor record { +public type SharedContentAccessLevel record { string \.tag?; - inline_response_200_71_actor_user user?; +}; + +public type AddSecondaryEmailsResult record { + UserAddResult[] results?; }; public type list_received_files_continue_body record { @@ -2566,10 +2451,13 @@ public type members_set_admin_permissions_body record { members_send_welcome_email_body user?; }; -public type inline_response_200_68_values record { +public type PathLogInfo record { + string contextual?; + NamespaceRelativePathLogInfo namespace_relative?; +}; + +public type GenericResponseWithTag record { string \.tag?; - inline_response_200_68_has_team_shared_dropbox has_team_shared_dropbox?; - inline_response_200_68_upload_api_rate_limit upload_api_rate_limit?; }; public type teamgroupsget_info_profile_status record { @@ -2582,6 +2470,13 @@ public type MountFolderHeaders record { string? dropbox\-api\-select\-user?; }; +public type SharedFolderMembers record { + string cursor?; + sharinglist_file_membersbatch_result_members_groups[] groups?; + sharinglist_file_membersbatch_result_members_invitees[] invitees?; + UserMembershipInfo[] users?; +}; + # Represents the Headers record for the operation: listFolderContinue public type ListFolderContinueHeaders record { string? dropbox\-api\-path\-root?; @@ -2631,6 +2526,10 @@ public type job_status_check_body record { string async_job_id?; }; +public type FolderMetadataResponse record { + FolderMetadata metadata?; +}; + # Represents the Headers record for the operation: createFolderBatchCheck public type CreateFolderBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2638,11 +2537,14 @@ public type CreateFolderBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_71_origin_geo_location record { - string city?; - string country?; - string ip_address?; - string region?; +public type LegalHoldPolicy record { + string activation_time?; + string end_date?; + string id?; + MembersInfo members?; + string name?; + string start_date?; + teamgroupsget_info_profile_status status?; }; # Represents the Headers record for the operation: get @@ -2676,11 +2578,6 @@ public type devices_revoke_device_session_body record { string team_member_id?; }; -public type inline_response_200_71_origin_access_method record { - string \.tag?; - inline_response_200_71_origin_access_method_end_user end_user?; -}; - # Represents the Headers record for the operation: saveUrlCheckJobStatus public type SaveUrlCheckJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -2715,6 +2612,23 @@ public type ListFolderGetLatestCursorHeaders record { string? dropbox\-api\-select\-user?; }; +public type FileMetadata record { + string client_modified?; + string content_hash?; + FileLockInfo file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + MetadataSharingInfo sharing_info?; + decimal size?; +}; + # Represents the Headers record for the operation: updateFolderMember public type UpdateFolderMemberHeaders record { string? dropbox\-api\-path\-root?; @@ -2736,19 +2650,6 @@ public type sharing_check_share_job_status_body record { string async_job_id?; }; -public type inline_response_200_52_entries record { - string author_email?; - string author_member_id?; - teamgroupsget_info_profile_status author_member_status?; - string content_hash?; - string file_type?; - string new_filename?; - string original_file_path?; - string original_revision_id?; - string server_modified?; - decimal size?; -}; - public type create_folder_batch_check_body record { string async_job_id?; }; @@ -2760,11 +2661,6 @@ public type MoveBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_71_event_type record { - string \.tag?; - string description?; -}; - public type sharing_share_folder_body record { string access_inheritance?; string acl_update_policy?; @@ -2781,6 +2677,10 @@ public type UploadSessionFinishBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; +public type LinkAction record { + string \.tag?; +}; + public type features_get_values_body record { teamfeaturesget_values_features[] features?; }; @@ -2789,6 +2689,11 @@ public type sharing_mount_folder_body record { string shared_folder_id?; }; +public type FileMemberActionResult record { + sharingadd_file_member_members member?; + sharingadd_file_member_result result?; +}; + # Represents the Headers record for the operation: uploadSessionFinish public type UploadSessionFinishHeaders record { string? dropbox\-api\-path\-root?; @@ -2797,13 +2702,22 @@ public type UploadSessionFinishHeaders record { string? dropbox\-api\-select\-user?; }; +public type MembersInfo record { + decimal permanently_deleted_users?; + string[] team_member_ids?; +}; + public type sharinglist_file_membersbatch_result_members_invitee record { string \.tag?; string email?; }; -public type files_delete_v2_body record { - string path?; +public type SharingInfo record { + string modified_by?; + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; }; # Represents the Headers record for the operation: copyBatch @@ -2813,8 +2727,9 @@ public type CopyBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_37_link_permissions_revoke_failure_reason record { - string \.tag?; +public type ListFileMembersIndividualResult record { + string file?; + sharinglist_file_membersbatch_result result?; }; # Represents the Headers record for the operation: relinquishFileMembership @@ -2828,18 +2743,19 @@ public type list_continue_body_1 record { string cursor?; }; -public type usersfeaturesget_values_features record { - string \.tag?; +public type ListFileRequestsResponse record { + string cursor?; + FileRequestAsResponse[] file_requests?; + boolean has_more?; }; -public type inline_response_200_6_deadline record { - inline_response_200_6_deadline_allow_late_uploads allow_late_uploads?; - string deadline?; +public type usersfeaturesget_values_features record { + string \.tag?; }; -public type inline_response_200_76_allocation record { - string \.tag?; - decimal allocated?; +public type LegalHoldsListHeldRevisionResult record { + LegalHoldHeldRevisionMetadata[] entries?; + boolean has_more?; }; public type filescopy_batch_v2_entries record { @@ -2863,11 +2779,6 @@ public type list_continue_body_2 record { string cursor?; }; -public type inline_response_200_28_metadata record { - string \.tag?; - inline_response_200_9_metadata metadata?; -}; - # Represents the Headers record for the operation: getFolderMetadata public type GetFolderMetadataHeaders record { string? dropbox\-api\-path\-root?; @@ -2875,6 +2786,10 @@ public type GetFolderMetadataHeaders record { string? dropbox\-api\-select\-user?; }; +public type ListTemplatesResponse record { + string[] template_ids?; +}; + public type linked_apps_list_member_linked_apps_body record { string team_member_id?; }; @@ -2885,9 +2800,26 @@ public type sharingmodify_shared_link_settings_settings record { string requested_visibility?; }; -public type inline_response_200_65_content_sync_settings record { +public type GetMetadataResponse record { + string \.tag?; + string client_modified?; + string content_hash?; + FileLockInfo file_lock_info?; + boolean has_explicit_shared_members?; string id?; - inline_response_200_65_sync_setting sync_setting?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + MetadataSharingInfo sharing_info?; + decimal size?; +}; + +public type MetadataResponse record { + MetadataAsResponse metadata?; }; # Represents the Headers record for the operation: uploadSessionFinishBatch @@ -2897,10 +2829,6 @@ public type UploadSessionFinishBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200 record { - string result?; -}; - # Represents the Headers record for the operation: templatesListForUser public type TemplatesListForUserHeaders record { string? dropbox\-api\-path\-root?; @@ -2911,6 +2839,12 @@ public type list_continue_body_6 record { string cursor?; }; +public type NamespaceRelativePathLogInfo record { + boolean is_shared_namespace?; + string ns_id?; + string relative_path?; +}; + public type sharinglist_file_membersbatch_result_members_platform_type record { string \.tag?; }; @@ -2931,8 +2865,8 @@ public type TemplateId record { string template_id?; }; -public type inline_response_200_75_account_type record { - string \.tag?; +public type FilePath record { + string path?; }; public type RemovePropertiesRequest record { @@ -2940,36 +2874,6 @@ public type RemovePropertiesRequest record { string[] property_template_ids?; }; -public type inline_response_200_12_metadata record { - string id?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - inline_response_200_12_metadata_sharing_info sharing_info?; -}; - -public type inline_response_200_33_link_metadata_audience_options record { - string \.tag?; -}; - -public type inline_response_200_16_file_metadata record { - string client_modified?; - string content_hash?; - inline_response_200_9_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_9_metadata_sharing_info sharing_info?; - decimal size?; -}; - public type filesget_thumbnail_batch_entries record { string format?; string mode?; @@ -2985,6 +2889,15 @@ public type GetThumbnailHeaders record { string? dropbox\-api\-select\-user?; }; +public type FolderMetadata record { + string id?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + FolderSharingInfo sharing_info?; +}; + # Proxy server configurations to be used with the HTTP client endpoint. public type ProxyConfig record {| # Host name of the proxy server @@ -2998,22 +2911,20 @@ public type ProxyConfig record {| string password = ""; |}; -public type inline_response_200_9_metadata record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_9_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_9_metadata_sharing_info sharing_info?; - decimal size?; +public type GeoLocationLogInfo record { + string city?; + string country?; + string ip_address?; + string region?; +}; + +public type ListReceivedFilesResponse record { + string cursor?; + SharedFileMetadata[] entries?; +}; + +public type DeleteSecondaryEmailsResult record { + UserDeleteResult[] results?; }; public type copy_batch_check_v2_body record { diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml index 42dfab8..55a4d51 100644 --- a/docs/spec/openapi.yaml +++ b/docs/spec/openapi.yaml @@ -236,7 +236,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200' + $ref: '#/components/schemas/EchoResult' examples: app response: value: @@ -278,7 +278,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200' + $ref: '#/components/schemas/EchoResult' examples: user response: value: @@ -466,7 +466,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_1' + $ref: '#/components/schemas/SearchPropertiesResponse' examples: properties/search response: value: @@ -516,7 +516,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_1' + $ref: '#/components/schemas/SearchPropertiesResponse' examples: properties/search/continue response: value: @@ -605,7 +605,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_2' + $ref: '#/components/schemas/AddTemplateResponse' examples: templates/add_for_team response: value: @@ -657,7 +657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_2' + $ref: '#/components/schemas/AddTemplateResponse' examples: templates/add_for_user response: value: @@ -696,7 +696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_3' + $ref: '#/components/schemas/GetTemplateResponse' examples: templates/get_for_team response: value: @@ -749,7 +749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_3' + $ref: '#/components/schemas/GetTemplateResponse' examples: templates/get_for_user response: value: @@ -788,7 +788,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_4' + $ref: '#/components/schemas/ListTemplatesResponse' examples: templates/list_for_team response: value: @@ -824,7 +824,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_4' + $ref: '#/components/schemas/ListTemplatesResponse' examples: templates/list_for_user response: value: @@ -899,7 +899,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/templates_update_for_team_body' + $ref: '#/components/schemas/UpdateTemplateForTeamRequest' examples: templates/update_for_team: value: @@ -952,7 +952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/templates_update_for_user_body' + $ref: '#/components/schemas/UpdateTemplateForUserRequest' examples: templates/update_for_user: value: @@ -1012,7 +1012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_5' + $ref: '#/components/schemas/FileRequestCount' examples: count response: value: @@ -1036,7 +1036,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/file_requests_create_body' + $ref: '#/components/schemas/CreateFileRequestRequest' examples: create: value: @@ -1059,7 +1059,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_6' + $ref: '#/components/schemas/FileRequest' examples: create response: value: @@ -1113,7 +1113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_7' + $ref: '#/components/schemas/DeleteFileRequestsResponse' examples: delete response: value: @@ -1173,7 +1173,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_7' + $ref: '#/components/schemas/DeleteFileRequestsResponse' examples: delete_all_closed response: value: @@ -1242,7 +1242,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_6' + $ref: '#/components/schemas/FileRequest' examples: get response: value: @@ -1294,7 +1294,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_8' + $ref: '#/components/schemas/ListFileRequestsResponse' examples: list response: value: @@ -1365,7 +1365,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_8' + $ref: '#/components/schemas/ListFileRequestsResponse' examples: list/continue response: value: @@ -1443,7 +1443,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_6' + $ref: '#/components/schemas/FileRequest' examples: update response: value: @@ -1501,7 +1501,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/MetadataResponse' examples: copy response: value: @@ -1574,7 +1574,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_10' + $ref: '#/components/schemas/RelocationBatchV2Response' examples: copy_batch response: value: @@ -1645,7 +1645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_10' + $ref: '#/components/schemas/RelocationBatchV2Response' examples: copy_batch/check response: value: @@ -1715,7 +1715,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_11' + $ref: '#/components/schemas/GetCopyReferenceResponse' examples: copy_reference/get response: value: @@ -1785,7 +1785,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/MetadataResponse' examples: copy_reference/save response: value: @@ -1854,7 +1854,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_12' + $ref: '#/components/schemas/FolderMetadataResponse' examples: create_folder response: value: @@ -1915,7 +1915,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' + $ref: '#/components/schemas/CreateFolderBatchResponse' examples: create_folder_batch response: value: @@ -1975,7 +1975,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' + $ref: '#/components/schemas/CreateFolderBatchResponse' examples: create_folder_batch/check response: value: @@ -2019,7 +2019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_delete_v2_body' + $ref: '#/components/schemas/FilePath' examples: delete: value: @@ -2037,7 +2037,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/MetadataResponse' examples: delete response: value: @@ -2088,7 +2088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_delete_batch_body' + $ref: '#/components/schemas/DeleteFilesBatchRequest' examples: delete_batch: value: @@ -2107,7 +2107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_14' + $ref: '#/components/schemas/DeleteBatchResponse' examples: delete_batch response: value: @@ -2178,7 +2178,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_14' + $ref: '#/components/schemas/DeleteBatchResponse' examples: delete_batch/check response: value: @@ -2251,7 +2251,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/FileMetadata' examples: download response: value: @@ -2318,7 +2318,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_12' + $ref: '#/components/schemas/FolderMetadataResponse' examples: download_zip response: value: @@ -2377,7 +2377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_16' + $ref: '#/components/schemas/ExportFileResponse' examples: export response: value: @@ -2448,7 +2448,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_17' + $ref: '#/components/schemas/LockFileBatchResult' examples: get_file_lock_batch response: value: @@ -2528,7 +2528,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_18' + $ref: '#/components/schemas/GetMetadataResponse' examples: get_metadata response: value: @@ -2600,7 +2600,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/FileMetadata' examples: get_preview response: value: @@ -2665,7 +2665,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_19' + $ref: '#/components/schemas/GetTemporaryLinkResponse' examples: get_temporary_link response: value: @@ -2762,7 +2762,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_20' + $ref: '#/components/schemas/GetTemporaryUploadLinkResponse' examples: get_temporary_upload_link response: value: @@ -2806,7 +2806,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_21' + $ref: '#/components/schemas/GetThumbnailResponse' examples: get_thumbnail response: value: @@ -2878,7 +2878,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_22' + $ref: '#/components/schemas/GetThumbnailBatchResponse' examples: get_thumbnail_batch response: value: @@ -2959,7 +2959,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_23' + $ref: '#/components/schemas/ListFolderResponse' examples: list_folder response: value: @@ -3044,7 +3044,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_23' + $ref: '#/components/schemas/ListFolderResponse' examples: list_folder/continue response: value: @@ -3179,7 +3179,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_24' + $ref: '#/components/schemas/ListFolderLongpollResult' examples: list_folder/longpoll response: value: @@ -3225,7 +3225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_25' + $ref: '#/components/schemas/ListRevisionsResult' examples: list_revisions response: value: @@ -3293,7 +3293,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_17' + $ref: '#/components/schemas/LockFileBatchResult' examples: lock_file_batch response: value: @@ -3375,7 +3375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/MetadataResponse' examples: move response: value: @@ -3449,7 +3449,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_10' + $ref: '#/components/schemas/RelocationBatchV2Response' examples: move_batch response: value: @@ -3520,7 +3520,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_10' + $ref: '#/components/schemas/RelocationBatchV2Response' examples: move_batch/check response: value: @@ -3621,7 +3621,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/FileMetadata' examples: restore response: value: @@ -3689,7 +3689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_26' + $ref: '#/components/schemas/SaveUrlResult' examples: save_url response: value: @@ -3755,7 +3755,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_27' + $ref: '#/components/schemas/CheckJobStatusResponse' examples: save_url/check_job_status response: value: @@ -3800,7 +3800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_28' + $ref: '#/components/schemas/SearchFilesResponse' examples: search response: value: @@ -3873,7 +3873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_28' + $ref: '#/components/schemas/SearchFilesResponse' examples: search/continue response: value: @@ -3946,7 +3946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_17' + $ref: '#/components/schemas/LockFileBatchResult' examples: unlock_file_batch response: value: @@ -4025,7 +4025,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/FileMetadata' examples: upload response: value: @@ -4127,7 +4127,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/FileMetadata' examples: upload_session/finish response: value: @@ -4206,7 +4206,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_29' + $ref: '#/components/schemas/UploadSessionFinishBatchResult' examples: upload_session/finish_batch response: value: @@ -4275,7 +4275,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_29' + $ref: '#/components/schemas/UploadSessionFinishBatchResult' examples: upload_session/finish_batch/check response: value: @@ -4349,7 +4349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_30' + $ref: '#/components/schemas/UploadSessionStartResult' examples: upload_session/start response: value: @@ -4407,7 +4407,7 @@ paths: result: ".tag": success items: - $ref: '#/components/schemas/inline_response_200_31' + $ref: '#/components/schemas/FileMemberActionResult' examples: add_file_member response: value: @@ -4494,7 +4494,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_27' + $ref: '#/components/schemas/CheckJobStatusResponse' examples: check_job_status response: value: @@ -4537,7 +4537,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: check_remove_member_job_status response: value: @@ -4580,7 +4580,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_33' + $ref: '#/components/schemas/ShareFolderResponse' examples: check_share_job_status response: value: @@ -4658,7 +4658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_34' + $ref: '#/components/schemas/GetFileMetadataResponse' examples: get_file_metadata response: value: @@ -4754,7 +4754,7 @@ paths: preview_url: https://www.dropbox.com/scl/fi/fir9vjelf time_invited: 2016-01-20T00:00:00Z items: - $ref: '#/components/schemas/inline_response_200_35' + $ref: '#/components/schemas/GetFileMetadataIndicidualResult' examples: get_file_metadata/batch response: value: @@ -4823,7 +4823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_36' + $ref: '#/components/schemas/SharedFolderMetadata' examples: get_folder_metadata response: value: @@ -4898,7 +4898,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_37' + $ref: '#/components/schemas/SharedLinkMetadata' examples: get_shared_link_file response: value: @@ -4961,7 +4961,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_37' + $ref: '#/components/schemas/SharedLinkMetadata' examples: get_shared_link_metadata response: value: @@ -5026,7 +5026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_38' + $ref: '#/components/schemas/SharedFileMembers' examples: list_file_members response: value: @@ -5155,7 +5155,7 @@ paths: same_team: true team_member_id: dbmid:abcd1234 items: - $ref: '#/components/schemas/inline_response_200_39' + $ref: '#/components/schemas/ListFileMembersIndividualResult' examples: list_file_members/batch response: value: @@ -5239,7 +5239,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_38' + $ref: '#/components/schemas/SharedFileMembers' examples: list_file_members/continue response: value: @@ -5319,7 +5319,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_40' + $ref: '#/components/schemas/SharedFolderMembers' examples: list_folder_members/continue response: value: @@ -5397,7 +5397,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_41' + $ref: '#/components/schemas/ListFoldersResult' examples: list_folders response: value: @@ -5474,7 +5474,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_41' + $ref: '#/components/schemas/ListFoldersResult' examples: list_folders/continue response: value: @@ -5552,7 +5552,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_41' + $ref: '#/components/schemas/ListFoldersResult' examples: list_mountable_folders response: value: @@ -5629,7 +5629,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_41' + $ref: '#/components/schemas/ListFoldersResult' examples: list_mountable_folders/continue response: value: @@ -5709,7 +5709,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_42' + $ref: '#/components/schemas/ListReceivedFilesResponse' examples: list_received_files response: value: @@ -5775,7 +5775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_42' + $ref: '#/components/schemas/ListReceivedFilesResponse' examples: list_received_files/continue response: value: @@ -5843,7 +5843,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_43' + $ref: '#/components/schemas/ListSharedLinksResult' examples: list_shared_links response: value: @@ -5914,7 +5914,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_37' + $ref: '#/components/schemas/SharedLinkMetadata' examples: modify_shared_link_settings response: value: @@ -5977,7 +5977,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_36' + $ref: '#/components/schemas/SharedFolderMetadata' examples: mount_folder response: value: @@ -6082,7 +6082,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: relinquish_folder_membership response: value: @@ -6128,7 +6128,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_44' + $ref: '#/components/schemas/CustomQuotaResponse' examples: remove_file_member_2 response: value: @@ -6175,7 +6175,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_45' + $ref: '#/components/schemas/LaunchResultBase' examples: remove_folder_member response: value: @@ -6249,7 +6249,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_33' + $ref: '#/components/schemas/ShareFolderResponse' examples: set_access_inheritance response: value: @@ -6333,7 +6333,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_33' + $ref: '#/components/schemas/ShareFolderResponse' examples: share_folder response: value: @@ -6450,7 +6450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_unshare_file_body' + $ref: '#/components/schemas/UnshareFileRequest' examples: unshare_file: value: @@ -6498,7 +6498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: unshare_folder response: value: @@ -6639,7 +6639,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_36' + $ref: '#/components/schemas/SharedFolderMetadata' examples: update_folder_policy response: value: @@ -6821,7 +6821,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_46' + $ref: '#/components/schemas/GroupFullInfo' examples: groups/create response: value: @@ -6896,7 +6896,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: groups/delete response: value: @@ -6977,7 +6977,7 @@ paths: ".tag": active team_member_id: dbmid:1234567 items: - $ref: '#/components/schemas/inline_response_200_47' + $ref: '#/components/schemas/GroupsGetInfoItem' examples: groups/get_info response: value: @@ -7051,7 +7051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: groups/job_status/get response: value: @@ -7092,7 +7092,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_48' + $ref: '#/components/schemas/GroupsListResult' examples: groups/list response: value: @@ -7140,7 +7140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_48' + $ref: '#/components/schemas/GroupsListResult' examples: groups/list/continue response: value: @@ -7197,7 +7197,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_49' + $ref: '#/components/schemas/GroupMembersChangeResult' examples: groups/members/add response: value: @@ -7275,7 +7275,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_50' + $ref: '#/components/schemas/MembersListV2Result' examples: groups/members/list response: value: @@ -7318,7 +7318,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_50' + $ref: '#/components/schemas/MembersListV2Result' examples: groups/members/list/continue response: value: @@ -7369,7 +7369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_49' + $ref: '#/components/schemas/GroupMembersChangeResult' examples: groups/members/remove response: value: @@ -7488,7 +7488,7 @@ paths: ".tag": active team_member_id: dbmid:1234567 items: - $ref: '#/components/schemas/inline_response_200_47' + $ref: '#/components/schemas/GroupsGetInfoItem' examples: groups/members/set_access_type response: value: @@ -7568,7 +7568,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_46' + $ref: '#/components/schemas/GroupFullInfo' examples: groups/update response: value: @@ -7645,7 +7645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_51' + $ref: '#/components/schemas/LegalHoldPolicy' examples: legal_holds/create_policy response: value: @@ -7696,7 +7696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_51' + $ref: '#/components/schemas/LegalHoldPolicy' examples: legal_holds/get_policy response: value: @@ -7747,7 +7747,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_52' + $ref: '#/components/schemas/LegalHoldsListHeldRevisionResult' examples: legal_holds/list_held_revisions response: value: @@ -7800,7 +7800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_52' + $ref: '#/components/schemas/LegalHoldsListHeldRevisionResult' examples: legal_holds/list_held_revisions_continue response: value: @@ -7853,7 +7853,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_53' + $ref: '#/components/schemas/LegalHoldsListPoliciesResult' examples: legal_holds/list_policies response: value: @@ -7933,7 +7933,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_51' + $ref: '#/components/schemas/LegalHoldPolicy' examples: legal_holds/update_policy response: value: @@ -8078,7 +8078,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_54' + $ref: '#/components/schemas/ExcludedUsersUpdateResult' examples: member_space_limits/excluded_users/add response: value: @@ -8119,7 +8119,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_55' + $ref: '#/components/schemas/ExcludedUsersListResult' examples: member_space_limits/excluded_users/list response: value: @@ -8161,7 +8161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_55' + $ref: '#/components/schemas/ExcludedUsersListResult' examples: member_space_limits/excluded_users/list/continue response: value: @@ -8205,7 +8205,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_54' + $ref: '#/components/schemas/ExcludedUsersUpdateResult' examples: member_space_limits/excluded_users/remove response: value: @@ -8252,7 +8252,7 @@ paths: example: - ".tag": other items: - $ref: '#/components/schemas/inline_response_200_44' + $ref: '#/components/schemas/CustomQuotaResponse' examples: member_space_limits/get_custom_quota response: value: @@ -8298,7 +8298,7 @@ paths: example: - ".tag": other items: - $ref: '#/components/schemas/inline_response_200_44' + $ref: '#/components/schemas/CustomQuotaResponse' examples: member_space_limits/remove_custom_quota response: value: @@ -8346,7 +8346,7 @@ paths: example: - ".tag": other items: - $ref: '#/components/schemas/inline_response_200_44' + $ref: '#/components/schemas/CustomQuotaResponse' examples: member_space_limits/set_custom_quota response: value: @@ -8398,7 +8398,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_56' + $ref: '#/components/schemas/MembersAddResult' examples: members/add response: value: @@ -8469,7 +8469,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_56' + $ref: '#/components/schemas/MembersAddResult' examples: members/add/job_status/get response: value: @@ -8542,7 +8542,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_57' + $ref: '#/components/schemas/TeamMemberInfoV2Result' examples: members/delete_profile_photo response: value: @@ -8645,7 +8645,7 @@ paths: role: ".tag": member_only items: - $ref: '#/components/schemas/inline_response_200_58' + $ref: '#/components/schemas/MembersGetInfoItem' examples: members/get_info response: value: @@ -8715,7 +8715,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_59' + $ref: '#/components/schemas/MembersListResult' examples: members/list response: value: @@ -8786,7 +8786,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_59' + $ref: '#/components/schemas/MembersListResult' examples: members/list/continue response: value: @@ -8865,7 +8865,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: members/move_former_member_files response: value: @@ -8906,7 +8906,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: members/move_former_member_files/job_status/check response: value: @@ -8991,7 +8991,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: members/remove response: value: @@ -9032,7 +9032,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/GenericResponseWithTag' examples: members/remove/job_status/get response: value: @@ -9080,7 +9080,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_60' + $ref: '#/components/schemas/AddSecondaryEmailsResult' examples: members/secondary_emails/add response: value: @@ -9143,7 +9143,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_61' + $ref: '#/components/schemas/DeleteSecondaryEmailsResult' examples: members/secondary_emails/delete response: value: @@ -9199,7 +9199,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_62' + $ref: '#/components/schemas/ResendVerificationEmailResult' examples: members/secondary_emails/resend_verification_emails response: value: @@ -9279,7 +9279,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_63' + $ref: '#/components/schemas/SetAdminPermissionsResult' examples: members/set_admin_permissions response: value: @@ -9326,7 +9326,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_57' + $ref: '#/components/schemas/TeamMemberInfoV2Result' examples: members/set_profile response: value: @@ -9399,7 +9399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_57' + $ref: '#/components/schemas/TeamMemberInfoV2Result' examples: members/set_profile_photo response: value: @@ -9525,7 +9525,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_64' + $ref: '#/components/schemas/TeamNamespacesListResult' examples: namespaces/list response: value: @@ -9576,7 +9576,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_64' + $ref: '#/components/schemas/TeamNamespacesListResult' examples: namespaces/list/continue response: value: @@ -9716,7 +9716,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_65' + $ref: '#/components/schemas/TeamFolderMetadata' examples: team_folder/activate response: value: @@ -9768,7 +9768,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_66' + $ref: '#/components/schemas/TeamFolderArchiveResponse' examples: team_folder/archive response: value: @@ -9820,7 +9820,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_66' + $ref: '#/components/schemas/TeamFolderArchiveResponse' examples: team_folder/archive/check response: value: @@ -9873,7 +9873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_65' + $ref: '#/components/schemas/TeamFolderMetadata' examples: team_folder/create response: value: @@ -9953,7 +9953,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_67' + $ref: '#/components/schemas/TeamFolderListResult' examples: team_folder/list response: value: @@ -10007,7 +10007,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_67' + $ref: '#/components/schemas/TeamFolderListResult' examples: team_folder/list/continue response: value: @@ -10088,7 +10088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_65' + $ref: '#/components/schemas/TeamFolderMetadata' examples: team_folder/rename response: value: @@ -10142,7 +10142,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_65' + $ref: '#/components/schemas/TeamFolderMetadata' examples: team_folder/update_sync_settings response: value: @@ -10194,7 +10194,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_68' + $ref: '#/components/schemas/FeaturesGetValuesResponse' examples: features/get_values response: value: @@ -10232,7 +10232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_69' + $ref: '#/components/schemas/TeamGetInfoResponse' examples: get_info response: value: @@ -10279,7 +10279,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_70' + $ref: '#/components/schemas/TokenGetAuthenticatedAdminResult' examples: token/get_authenticated_admin response: value: @@ -10347,7 +10347,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_71' + $ref: '#/components/schemas/GetTeamEventsResult' examples: get_events response: value: @@ -10465,7 +10465,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_71' + $ref: '#/components/schemas/GetTeamEventsResult' examples: get_events/continue response: value: @@ -10587,7 +10587,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_72' + $ref: '#/components/schemas/UserFeaturesGetValuesResult' examples: features/get_values response: value: @@ -10633,7 +10633,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_73' + $ref: '#/components/schemas/BasicAccount' examples: get_account response: value: @@ -10703,7 +10703,7 @@ paths: surname: Ferdinand profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 items: - $ref: '#/components/schemas/inline_response_200_74' + $ref: '#/components/schemas/BasicAccount' examples: get_account_batch response: value: @@ -10748,7 +10748,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_75' + $ref: '#/components/schemas/FullAccount' examples: get_current_account response: value: @@ -10813,7 +10813,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_76' + $ref: '#/components/schemas/GetSpaceUsageResponse' examples: get_space_usage response: value: @@ -10864,7 +10864,7 @@ components: query: type: string example: foo - inline_response_200: + EchoResult: type: object properties: result: @@ -10988,7 +10988,7 @@ components: template_filter: type: string example: filter_none - inline_response_200_1: + SearchPropertiesResponse: type: object properties: matches: @@ -11003,7 +11003,7 @@ components: value: Confidential template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa items: - $ref: '#/components/schemas/inline_response_200_1_matches' + $ref: '#/components/schemas/SearchProperties' SearchPropertiesContinueRequest: type: object properties: @@ -11077,7 +11077,7 @@ components: name: type: string example: Security - inline_response_200_2: + AddTemplateResponse: type: object properties: template_id: @@ -11109,7 +11109,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - inline_response_200_3: + GetTemplateResponse: type: object properties: description: @@ -11126,7 +11126,7 @@ components: type: ".tag": string items: - $ref: '#/components/schemas/inline_response_200_3_fields' + $ref: '#/components/schemas/PropertyFieldTemplateAsResponse' name: type: string example: Security @@ -11136,7 +11136,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - inline_response_200_4: + ListTemplatesResponse: type: object properties: template_ids: @@ -11158,7 +11158,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - templates_update_for_team_body: + UpdateTemplateForTeamRequest: type: object properties: add_fields: @@ -11181,7 +11181,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - templates_update_for_user_body: + UpdateTemplateForUserRequest: type: object properties: add_fields: @@ -11204,13 +11204,13 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - inline_response_200_5: + FileRequestCount: type: object properties: file_request_count: type: number example: 15 - file_requestscreate_deadline: + FileRequestDeadline: type: object properties: allow_late_uploads: @@ -11219,11 +11219,11 @@ components: deadline: type: string example: 2020-10-12T17:00:00Z - file_requests_create_body: + CreateFileRequestRequest: type: object properties: deadline: - $ref: '#/components/schemas/file_requestscreate_deadline' + $ref: '#/components/schemas/FileRequestDeadline' destination: type: string example: /File Requests/Homework @@ -11233,14 +11233,14 @@ components: title: type: string example: Homework submission - inline_response_200_6: + FileRequest: type: object properties: created: type: string example: 2015-10-05T17:00:00Z deadline: - $ref: '#/components/schemas/inline_response_200_6_deadline' + $ref: '#/components/schemas/FileRequestDeadlineWithTag' destination: type: string example: /File Requests/Homework @@ -11270,7 +11270,7 @@ components: items: type: string example: oaCAVmEyrqYnkZX9955Y - inline_response_200_7: + DeleteFileRequestsResponse: type: object properties: file_requests: @@ -11304,7 +11304,7 @@ components: title: Wedding photo submission url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T items: - $ref: '#/components/schemas/inline_response_200_7_file_requests' + $ref: '#/components/schemas/FileRequestAsResponse' file_requests_get_body: type: object properties: @@ -11317,7 +11317,7 @@ components: limit: type: number example: 1000 - inline_response_200_8: + ListFileRequestsResponse: type: object properties: cursor: @@ -11354,7 +11354,7 @@ components: title: Wedding photo submission url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T items: - $ref: '#/components/schemas/inline_response_200_7_file_requests' + $ref: '#/components/schemas/FileRequestAsResponse' has_more: type: boolean example: true @@ -11411,11 +11411,11 @@ components: to_path: type: string example: /Homework/algebra - inline_response_200_9: + MetadataResponse: type: object properties: metadata: - $ref: '#/components/schemas/inline_response_200_9_metadata' + $ref: '#/components/schemas/MetadataAsResponse' filescopy_batch_v2_entries: type: object properties: @@ -11438,7 +11438,7 @@ components: to_path: /Homework/algebra items: $ref: '#/components/schemas/filescopy_batch_v2_entries' - inline_response_200_10: + RelocationBatchV2Response: type: object properties: ".tag": @@ -11475,7 +11475,7 @@ components: read_only: true size: 7212 items: - $ref: '#/components/schemas/inline_response_200_10_entries' + $ref: '#/components/schemas/CopyBatchResponseEntries' copy_batch_check_v2_body: type: object properties: @@ -11488,7 +11488,7 @@ components: path: type: string example: /video.mp4 - inline_response_200_11: + GetCopyReferenceResponse: type: object properties: copy_reference: @@ -11498,7 +11498,7 @@ components: type: string example: 2045-05-12T15:50:38Z metadata: - $ref: '#/components/schemas/inline_response_200_9_metadata' + $ref: '#/components/schemas/MetadataAsResponse' copy_reference_save_body: type: object properties: @@ -11517,11 +11517,11 @@ components: path: type: string example: /Homework/math - inline_response_200_12: + FolderMetadataResponse: type: object properties: metadata: - $ref: '#/components/schemas/inline_response_200_12_metadata' + $ref: '#/components/schemas/FolderMetadata' files_create_folder_batch_body: type: object properties: @@ -11538,7 +11538,7 @@ components: items: type: string example: /Homework/math - inline_response_200_13: + CreateFolderBatchResponse: type: object properties: ".tag": @@ -11564,20 +11564,20 @@ components: read_only: false traverse_only: false items: - $ref: '#/components/schemas/inline_response_200_13_entries' + $ref: '#/components/schemas/CreateFolderBatchResponseEntry' create_folder_batch_check_body: type: object properties: async_job_id: type: string example: 34g93hh34h04y384084 - files_delete_v2_body: + FilePath: type: object properties: path: type: string example: /Homework/math/Prime_Numbers.txt - files_delete_batch_body: + DeleteFilesBatchRequest: type: object properties: entries: @@ -11585,8 +11585,8 @@ components: example: - path: /Homework/math/Prime_Numbers.txt items: - $ref: '#/components/schemas/files_delete_v2_body' - inline_response_200_14: + $ref: '#/components/schemas/FilePath' + DeleteBatchResponse: type: object properties: ".tag": @@ -11623,14 +11623,14 @@ components: read_only: true size: 7212 items: - $ref: '#/components/schemas/inline_response_200_14_entries' + $ref: '#/components/schemas/DeleteBatchResultEntry' delete_batch_check_body: type: object properties: async_job_id: type: string example: 34g93hh34h04y384084 - inline_response_200_15: + FileMetadata: type: object properties: client_modified: @@ -11640,7 +11640,7 @@ components: type: string example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 file_lock_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + $ref: '#/components/schemas/FileLockInfo' has_explicit_shared_members: type: boolean example: false @@ -11675,17 +11675,17 @@ components: type: string example: 2015-05-12T15:50:38Z sharing_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + $ref: '#/components/schemas/MetadataSharingInfo' size: type: number example: 7212 - inline_response_200_16: + ExportFileResponse: type: object properties: export_metadata: - $ref: '#/components/schemas/inline_response_200_16_export_metadata' + $ref: '#/components/schemas/ExportFileResponseMetadata' file_metadata: - $ref: '#/components/schemas/inline_response_200_16_file_metadata' + $ref: '#/components/schemas/FileMetadata' filesget_file_lock_batch_entries: type: object properties: @@ -11701,7 +11701,7 @@ components: - path: /John Doe/sample/test.pdf items: $ref: '#/components/schemas/filesget_file_lock_batch_entries' - inline_response_200_17: + LockFileBatchResult: type: object properties: entries: @@ -11741,7 +11741,7 @@ components: read_only: true size: 7212 items: - $ref: '#/components/schemas/inline_response_200_17_entries' + $ref: '#/components/schemas/LockFileResultEntry' files_get_metadata_body: type: object properties: @@ -11757,7 +11757,7 @@ components: path: type: string example: /Homework/math - inline_response_200_18: + GetMetadataResponse: type: object properties: ".tag": @@ -11770,7 +11770,7 @@ components: type: string example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 file_lock_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + $ref: '#/components/schemas/FileLockInfo' has_explicit_shared_members: type: boolean example: false @@ -11805,7 +11805,7 @@ components: type: string example: 2015-05-12T15:50:38Z sharing_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + $ref: '#/components/schemas/MetadataSharingInfo' size: type: number example: 7212 @@ -11815,14 +11815,14 @@ components: path: type: string example: /video.mp4 - inline_response_200_19: + GetTemporaryLinkResponse: type: object properties: link: type: string example: https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 metadata: - $ref: '#/components/schemas/inline_response_200_16_file_metadata' + $ref: '#/components/schemas/FileMetadata' filesget_temporary_upload_link_commit_info: type: object properties: @@ -11849,17 +11849,17 @@ components: duration: type: number example: 3600 - inline_response_200_20: + GetTemporaryUploadLinkResponse: type: object properties: link: type: string example: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND - inline_response_200_21: + GetThumbnailResponse: type: object properties: file_metadata: - $ref: '#/components/schemas/inline_response_200_16_file_metadata' + $ref: '#/components/schemas/FileMetadata' filesget_thumbnail_batch_entries: type: object properties: @@ -11887,7 +11887,7 @@ components: size: w64h64 items: $ref: '#/components/schemas/filesget_thumbnail_batch_entries' - inline_response_200_22: + GetThumbnailBatchResponse: type: object properties: entries: @@ -11921,7 +11921,7 @@ components: size: 7212 thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= items: - $ref: '#/components/schemas/inline_response_200_22_entries' + $ref: '#/components/schemas/GetThumbnailBatchResultEntry' files_list_folder_body: type: object properties: @@ -11946,7 +11946,7 @@ components: recursive: type: boolean example: false - inline_response_200_23: + ListFolderResponse: type: object properties: cursor: @@ -11996,7 +11996,7 @@ components: read_only: false traverse_only: false items: - $ref: '#/components/schemas/inline_response_200_23_entries' + $ref: '#/components/schemas/Metadata' has_more: type: boolean example: false @@ -12039,7 +12039,7 @@ components: timeout: type: number example: 30 - inline_response_200_24: + ListFolderLongpollResult: type: object properties: changes: @@ -12057,7 +12057,7 @@ components: path: type: string example: /root/word.docx - inline_response_200_25: + ListRevisionsResult: type: object properties: entries: @@ -12088,7 +12088,7 @@ components: read_only: true size: 7212 items: - $ref: '#/components/schemas/inline_response_200_16_file_metadata' + $ref: '#/components/schemas/FileMetadata' is_deleted: type: boolean example: false @@ -12165,7 +12165,7 @@ components: url: type: string example: http://example.com/a.txt - inline_response_200_26: + SaveUrlResult: type: object properties: ".tag": @@ -12178,7 +12178,7 @@ components: type: string example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 file_lock_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + $ref: '#/components/schemas/FileLockInfo' has_explicit_shared_members: type: boolean example: false @@ -12213,7 +12213,7 @@ components: type: string example: 2015-05-12T15:50:38Z sharing_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + $ref: '#/components/schemas/MetadataSharingInfo' size: type: number example: 7212 @@ -12223,7 +12223,7 @@ components: async_job_id: type: string example: 34g93hh34h04y384084 - inline_response_200_27: + CheckJobStatusResponse: type: object properties: ".tag": @@ -12238,7 +12238,7 @@ components: query: type: string example: cat - inline_response_200_28: + SearchFilesResponse: type: object properties: has_more: @@ -12276,7 +12276,7 @@ components: read_only: true size: 7212 items: - $ref: '#/components/schemas/inline_response_200_28_matches' + $ref: '#/components/schemas/SearchMatch' search_continue_v2_body: type: object properties: @@ -12325,7 +12325,7 @@ components: session_id: 1234faaf0678bcde items: $ref: '#/components/schemas/filesupload_sessionfinish_batch_entries' - inline_response_200_29: + UploadSessionFinishBatchResult: type: object properties: ".tag": @@ -12360,14 +12360,14 @@ components: read_only: true size: 7212 items: - $ref: '#/components/schemas/inline_response_200_29_entries' + $ref: '#/components/schemas/UploadSessionFinishBatchResultEntry' finish_batch_check_body: type: object properties: async_job_id: type: string example: 34g93hh34h04y384084 - inline_response_200_30: + UploadSessionStartResult: type: object properties: session_id: @@ -12413,7 +12413,7 @@ components: ".tag": type: string example: success - inline_response_200_31: + FileMemberActionResult: type: object properties: member: @@ -12477,7 +12477,7 @@ components: async_job_id: type: string example: 34g93hh34h04y384084 - inline_response_200_32: + GenericResponseWithTag: type: object properties: ".tag": @@ -12489,14 +12489,14 @@ components: async_job_id: type: string example: 34g93hh34h04y384084 - inline_response_200_33: + ShareFolderResponse: type: object properties: ".tag": type: string example: complete access_inheritance: - $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + $ref: '#/components/schemas/AccessInheritance' access_type: $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' is_inside_team_folder: @@ -12506,7 +12506,7 @@ components: type: boolean example: false link_metadata: - $ref: '#/components/schemas/inline_response_200_33_link_metadata' + $ref: '#/components/schemas/SharedContentLinkMetadata' name: type: string example: dir @@ -12538,7 +12538,7 @@ components: file: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw - inline_response_200_34: + GetFileMetadataResponse: type: object properties: access_type: @@ -12618,7 +12618,7 @@ components: ".tag": type: string example: anyone - sharingget_file_metadatabatch_result_policy_resolved_member_policy: + SharedFolderMemberPolicy: type: object properties: ".tag": @@ -12632,7 +12632,7 @@ components: member_policy: $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' resolved_member_policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_resolved_member_policy' + $ref: '#/components/schemas/SharedFolderMemberPolicy' shared_link_policy: $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' sharingget_file_metadatabatch_result: @@ -12676,7 +12676,7 @@ components: time_invited: type: string example: 2016-01-20T00:00:00Z - inline_response_200_35: + GetFileMetadataIndicidualResult: type: object properties: file: @@ -12694,11 +12694,11 @@ components: shared_folder_id: type: string example: "84528192421" - inline_response_200_36: + SharedFolderMetadata: type: object properties: access_inheritance: - $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + $ref: '#/components/schemas/AccessInheritance' access_type: $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' is_inside_team_folder: @@ -12708,7 +12708,7 @@ components: type: boolean example: false link_metadata: - $ref: '#/components/schemas/inline_response_200_33_link_metadata' + $ref: '#/components/schemas/SharedContentLinkMetadata' name: type: string example: dir @@ -12730,7 +12730,7 @@ components: time_invited: type: string example: 2016-01-20T00:00:00Z - inline_response_200_37: + SharedLinkMetadata: type: object properties: ".tag": @@ -12743,7 +12743,7 @@ components: type: string example: id:a4ayc_80_OEAAAAAAAAAXw link_permissions: - $ref: '#/components/schemas/inline_response_200_37_link_permissions' + $ref: '#/components/schemas/SharedLinkMetadataLinkPermissions' name: type: string example: Prime_Numbers.txt @@ -12760,7 +12760,7 @@ components: type: number example: 7212 team_member_info: - $ref: '#/components/schemas/inline_response_200_37_team_member_info' + $ref: '#/components/schemas/TeamMemberInfo' url: type: string example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 @@ -12785,7 +12785,7 @@ components: limit: type: number example: 100 - inline_response_200_38: + SharedFileMembers: type: object properties: groups: @@ -13033,7 +13033,7 @@ components: example: 3 members: $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members' - inline_response_200_39: + ListFileMembersIndividualResult: type: object properties: file: @@ -13053,7 +13053,7 @@ components: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - inline_response_200_40: + SharedFolderMembers: type: object properties: cursor: @@ -13105,7 +13105,7 @@ components: same_team: true team_member_id: dbmid:abcd1234 items: - $ref: '#/components/schemas/inline_response_200_40_users' + $ref: '#/components/schemas/UserMembershipInfo' sharing_list_folders_body: type: object properties: @@ -13116,7 +13116,7 @@ components: limit: type: number example: 100 - inline_response_200_41: + ListFoldersResult: type: object properties: cursor: @@ -13160,7 +13160,7 @@ components: shared_folder_id: "84528192421" time_invited: 2016-01-20T00:00:00Z items: - $ref: '#/components/schemas/inline_response_200_41_entries' + $ref: '#/components/schemas/SharedFolderMetadata' list_folders_continue_body: type: object properties: @@ -13193,7 +13193,7 @@ components: limit: type: number example: 100 - inline_response_200_42: + ListReceivedFilesResponse: type: object properties: cursor: @@ -13226,7 +13226,7 @@ components: preview_url: https://www.dropbox.com/scl/fi/fir9vjelf time_invited: 2016-01-20T00:00:00Z items: - $ref: '#/components/schemas/inline_response_200_42_entries' + $ref: '#/components/schemas/SharedFileMetadata' list_received_files_continue_body: type: object properties: @@ -13239,7 +13239,7 @@ components: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - inline_response_200_43: + ListSharedLinksResult: type: object properties: cursor: @@ -13273,7 +13273,7 @@ components: name: "Acme, Inc." url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 items: - $ref: '#/components/schemas/inline_response_200_43_links' + $ref: '#/components/schemas/SharedLinkMetadata' sharingmodify_shared_link_settings_settings: type: object properties: @@ -13326,7 +13326,7 @@ components: example: id:3kmLmQFnf1AAAAAAAAAAAw member: $ref: '#/components/schemas/sharingadd_file_member_members' - inline_response_200_44: + CustomQuotaResponse: type: object properties: ".tag": @@ -13343,7 +13343,7 @@ components: shared_folder_id: type: string example: "84528192421" - inline_response_200_45: + LaunchResultBase: type: object properties: ".tag": @@ -13403,7 +13403,7 @@ components: shared_folder_id: type: string example: "84528192421" - sharing_unshare_file_body: + UnshareFileRequest: type: object properties: file: @@ -13505,7 +13505,7 @@ components: group_name: type: string example: Europe sales - inline_response_200_46: + GroupFullInfo: type: object properties: created: @@ -13666,7 +13666,7 @@ components: $ref: '#/components/schemas/teamgroupsget_info_access_type' profile: $ref: '#/components/schemas/teamgroupsget_info_profile' - inline_response_200_47: + GroupsGetInfoItem: type: object properties: ".tag": @@ -13729,7 +13729,7 @@ components: limit: type: number example: 100 - inline_response_200_48: + GroupsListResult: type: object properties: cursor: @@ -13744,7 +13744,7 @@ components: group_name: Test group member_count: 10 items: - $ref: '#/components/schemas/inline_response_200_48_groups' + $ref: '#/components/schemas/GroupSummary' has_more: type: boolean example: false @@ -13788,14 +13788,14 @@ components: return_members: type: boolean example: true - inline_response_200_49: + GroupMembersChangeResult: type: object properties: async_job_id: type: string example: "99988877733388" group_info: - $ref: '#/components/schemas/inline_response_200_49_group_info' + $ref: '#/components/schemas/GroupFullInfo' members_list_body: type: object properties: @@ -13804,7 +13804,7 @@ components: limit: type: number example: 100 - inline_response_200_50: + MembersListV2Result: type: object properties: cursor: @@ -13887,7 +13887,7 @@ components: start_date: type: string example: 2016-01-01T00:00:00Z - inline_response_200_51: + LegalHoldPolicy: type: object properties: activation_time: @@ -13900,7 +13900,7 @@ components: type: string example: pid_dbhid:abcd1234 members: - $ref: '#/components/schemas/inline_response_200_51_members' + $ref: '#/components/schemas/MembersInfo' name: type: string example: acme cfo policy @@ -13921,7 +13921,7 @@ components: id: type: string example: pid_dbhid:abcd1234 - inline_response_200_52: + LegalHoldsListHeldRevisionResult: type: object properties: entries: @@ -13939,7 +13939,7 @@ components: server_modified: 2019-08-12T12:08:52Z size: 3 items: - $ref: '#/components/schemas/inline_response_200_52_entries' + $ref: '#/components/schemas/LegalHoldHeldRevisionMetadata' has_more: type: boolean example: false @@ -13955,7 +13955,7 @@ components: include_released: type: boolean example: false - inline_response_200_53: + LegalHoldsListPoliciesResult: type: object properties: policies: @@ -13973,7 +13973,7 @@ components: status: ".tag": active items: - $ref: '#/components/schemas/inline_response_200_53_policies' + $ref: '#/components/schemas/LegalHoldPolicyAsResponse' legal_holds_release_policy_body: type: object properties: @@ -14009,7 +14009,7 @@ components: team_member_id: dbmid:efgh5678 items: $ref: '#/components/schemas/teamgroupsmembersadd_user' - inline_response_200_54: + ExcludedUsersUpdateResult: type: object properties: status: @@ -14020,7 +14020,7 @@ components: limit: type: number example: 100 - inline_response_200_55: + ExcludedUsersListResult: type: object properties: cursor: @@ -14127,7 +14127,7 @@ components: send_welcome_email: true items: $ref: '#/components/schemas/teammembersadd_new_members' - inline_response_200_56: + MembersAddResult: type: object properties: ".tag": @@ -14166,7 +14166,7 @@ components: role: ".tag": member_only items: - $ref: '#/components/schemas/inline_response_200_56_complete' + $ref: '#/components/schemas/MemberAddResult' job_status_get_body_1: type: object properties: @@ -14178,7 +14178,7 @@ components: properties: user: $ref: '#/components/schemas/teamgroupsmembersadd_user' - inline_response_200_57: + TeamMemberInfoV2Result: type: object properties: profile: @@ -14259,7 +14259,7 @@ components: ".tag": type: string example: member_only - inline_response_200_58: + MembersGetInfoItem: type: object properties: ".tag": @@ -14278,7 +14278,7 @@ components: limit: type: number example: 100 - inline_response_200_59: + MembersListResult: type: object properties: cursor: @@ -14319,7 +14319,7 @@ components: role: ".tag": member_only items: - $ref: '#/components/schemas/inline_response_200_59_members' + $ref: '#/components/schemas/TeamMemberInfoV2Result' list_continue_body_4: type: object properties: @@ -14397,7 +14397,7 @@ components: team_member_id: dbmid:efgh5678 items: $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' - inline_response_200_60: + AddSecondaryEmailsResult: type: object properties: results: @@ -14419,7 +14419,7 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/inline_response_200_60_results_1' + $ref: '#/components/schemas/UserAddResult' secondary_emails_delete_body: type: object properties: @@ -14434,7 +14434,7 @@ components: team_member_id: dbmid:efgh5678 items: $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' - inline_response_200_61: + DeleteSecondaryEmailsResult: type: object properties: results: @@ -14450,7 +14450,7 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/inline_response_200_61_results_1' + $ref: '#/components/schemas/UserDeleteResult' secondary_emails_resend_verification_emails_body: type: object properties: @@ -14465,7 +14465,7 @@ components: team_member_id: dbmid:efgh5678 items: $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' - inline_response_200_62: + ResendVerificationEmailResult: type: object properties: results: @@ -14479,7 +14479,7 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/inline_response_200_62_results_1' + $ref: '#/components/schemas/UserResendResult' members_send_welcome_email_body: type: object properties: @@ -14497,7 +14497,7 @@ components: example: member_only user: $ref: '#/components/schemas/members_send_welcome_email_body' - inline_response_200_63: + SetAdminPermissionsResult: type: object properties: role: @@ -14542,7 +14542,7 @@ components: limit: type: number example: 1 - inline_response_200_64: + TeamNamespacesListResult: type: object properties: cursor: @@ -14564,7 +14564,7 @@ components: ".tag": team_member_folder team_member_id: dbmid:1234567 items: - $ref: '#/components/schemas/inline_response_200_64_namespaces' + $ref: '#/components/schemas/NamespaceMetadata' list_continue_body_5: type: object properties: @@ -14577,7 +14577,7 @@ components: team_folder_id: type: string example: "123456789" - inline_response_200_65: + TeamFolderMetadata: type: object properties: content_sync_settings: @@ -14587,7 +14587,7 @@ components: sync_setting: ".tag": default items: - $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + $ref: '#/components/schemas/ContentSyncSetting' is_team_shared_dropbox: type: boolean example: false @@ -14597,7 +14597,7 @@ components: status: $ref: '#/components/schemas/teamgroupsget_info_profile_status' sync_setting: - $ref: '#/components/schemas/inline_response_200_65_sync_setting' + $ref: '#/components/schemas/SyncSetting' team_folder_id: type: string example: "123456789" @@ -14610,7 +14610,7 @@ components: team_folder_id: type: string example: "123456789" - inline_response_200_66: + TeamFolderArchiveResponse: type: object properties: ".tag": @@ -14623,7 +14623,7 @@ components: sync_setting: ".tag": default items: - $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + $ref: '#/components/schemas/ContentSyncSetting' is_team_shared_dropbox: type: boolean example: false @@ -14633,7 +14633,7 @@ components: status: $ref: '#/components/schemas/teamgroupsget_info_profile_status' sync_setting: - $ref: '#/components/schemas/inline_response_200_65_sync_setting' + $ref: '#/components/schemas/SyncSetting' team_folder_id: type: string example: "123456789" @@ -14670,7 +14670,7 @@ components: limit: type: number example: 100 - inline_response_200_67: + TeamFolderListResult: type: object properties: cursor: @@ -14694,7 +14694,7 @@ components: ".tag": default team_folder_id: "123456789" items: - $ref: '#/components/schemas/inline_response_200_67_team_folders' + $ref: '#/components/schemas/TeamFolderMetadata' list_continue_body_6: type: object properties: @@ -14757,7 +14757,7 @@ components: - ".tag": has_team_shared_dropbox items: $ref: '#/components/schemas/teamfeaturesget_values_features' - inline_response_200_68: + FeaturesGetValuesResponse: type: object properties: values: @@ -14772,8 +14772,8 @@ components: ".tag": has_team_shared_dropbox has_team_shared_dropbox: false items: - $ref: '#/components/schemas/inline_response_200_68_values' - inline_response_200_69: + $ref: '#/components/schemas/FeatureValue' + TeamGetInfoResponse: type: object properties: name: @@ -14786,11 +14786,11 @@ components: type: number example: 2 policies: - $ref: '#/components/schemas/inline_response_200_69_policies' + $ref: '#/components/schemas/TeamMemberPolicies' team_id: type: string example: dbtid:1234abcd - inline_response_200_70: + TokenGetAuthenticatedAdminResult: type: object properties: admin_profile: @@ -14804,7 +14804,7 @@ components: limit: type: number example: 50 - inline_response_200_71: + GetTeamEventsResult: type: object properties: cursor: @@ -14888,7 +14888,7 @@ components: team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q timestamp: 2017-01-25T15:51:30Z items: - $ref: '#/components/schemas/inline_response_200_71_events' + $ref: '#/components/schemas/TeamEvent' has_more: type: boolean example: false @@ -14914,7 +14914,7 @@ components: - ".tag": file_locking items: $ref: '#/components/schemas/usersfeaturesget_values_features' - inline_response_200_72: + UserFeaturesGetValuesResult: type: object properties: values: @@ -14925,14 +14925,14 @@ components: ".tag": enabled enabled: true items: - $ref: '#/components/schemas/inline_response_200_72_values' + $ref: '#/components/schemas/UserFeatureValue' users_get_account_body: type: object properties: account_id: type: string example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - inline_response_200_73: + BasicAccount: type: object properties: account_id: @@ -14966,37 +14966,14 @@ components: items: type: string example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - inline_response_200_74: - type: object - properties: - account_id: - type: string - example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - disabled: - type: boolean - example: false - email: - type: string - example: franz@dropbox.com - email_verified: - type: boolean - example: true - is_teammate: - type: boolean - example: false - name: - $ref: '#/components/schemas/teamgroupsget_info_profile_name' - profile_photo_url: - type: string - example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - inline_response_200_75: + FullAccount: type: object properties: account_id: type: string example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc account_type: - $ref: '#/components/schemas/inline_response_200_75_account_type' + $ref: '#/components/schemas/AccountType' country: type: string example: US @@ -15021,21 +14998,21 @@ components: type: string example: https://db.tt/ZITNuhtI root_info: - $ref: '#/components/schemas/inline_response_200_75_root_info' + $ref: '#/components/schemas/RootInfo' team: - $ref: '#/components/schemas/inline_response_200_75_team' + $ref: '#/components/schemas/FullTeam' team_member_id: type: string example: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU - inline_response_200_76: + GetSpaceUsageResponse: type: object properties: allocation: - $ref: '#/components/schemas/inline_response_200_76_allocation' + $ref: '#/components/schemas/SpaceAllocation' used: type: number example: 314159265 - inline_response_200_1_matches: + SearchProperties: type: object properties: id: @@ -15056,13 +15033,13 @@ components: template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa items: $ref: '#/components/schemas/PropertyGroup' - inline_response_200_3_type: + PropertyFieldTemplateTypeAsReponse: type: object properties: ".tag": type: string example: string - inline_response_200_3_fields: + PropertyFieldTemplateAsResponse: type: object properties: description: @@ -15074,29 +15051,29 @@ components: type: string example: Security Policy type: - $ref: '#/components/schemas/inline_response_200_3_type' - inline_response_200_6_deadline_allow_late_uploads: + $ref: '#/components/schemas/PropertyFieldTemplateTypeAsReponse' + GracePeriod: type: object properties: ".tag": type: string example: seven_days - inline_response_200_6_deadline: + FileRequestDeadlineWithTag: type: object properties: allow_late_uploads: - $ref: '#/components/schemas/inline_response_200_6_deadline_allow_late_uploads' + $ref: '#/components/schemas/GracePeriod' deadline: type: string example: 2020-10-12T17:00:00Z - inline_response_200_7_file_requests: + FileRequestAsResponse: type: object properties: created: type: string example: 2015-10-05T17:00:00Z deadline: - $ref: '#/components/schemas/inline_response_200_6_deadline' + $ref: '#/components/schemas/FileRequestDeadlineWithTag' destination: type: string example: /File Requests/Homework @@ -15115,7 +15092,7 @@ components: url: type: string example: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - inline_response_200_9_metadata_file_lock_info: + FileLockInfo: type: object properties: created: @@ -15127,7 +15104,7 @@ components: lockholder_name: type: string example: Imaginary User - inline_response_200_9_metadata_sharing_info: + MetadataSharingInfo: type: object properties: modified_by: @@ -15139,7 +15116,7 @@ components: read_only: type: boolean example: true - inline_response_200_9_metadata: + MetadataAsResponse: type: object properties: ".tag": @@ -15152,7 +15129,7 @@ components: type: string example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 file_lock_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + $ref: '#/components/schemas/FileLockInfo' has_explicit_shared_members: type: boolean example: false @@ -15187,19 +15164,19 @@ components: type: string example: 2015-05-12T15:50:38Z sharing_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + $ref: '#/components/schemas/MetadataSharingInfo' size: type: number example: 7212 - inline_response_200_10_entries: + CopyBatchResponseEntries: type: object properties: ".tag": type: string example: success success: - $ref: '#/components/schemas/inline_response_200_9_metadata' - inline_response_200_12_metadata_sharing_info: + $ref: '#/components/schemas/MetadataAsResponse' + FolderSharingInfo: type: object properties: no_access: @@ -15214,7 +15191,7 @@ components: traverse_only: type: boolean example: false - inline_response_200_12_metadata: + FolderMetadata: type: object properties: id: @@ -15239,24 +15216,24 @@ components: items: $ref: '#/components/schemas/PropertyGroup' sharing_info: - $ref: '#/components/schemas/inline_response_200_12_metadata_sharing_info' - inline_response_200_13_entries: + $ref: '#/components/schemas/FolderSharingInfo' + CreateFolderBatchResponseEntry: type: object properties: ".tag": type: string example: success metadata: - $ref: '#/components/schemas/inline_response_200_12_metadata' - inline_response_200_14_entries: + $ref: '#/components/schemas/FolderMetadata' + DeleteBatchResultEntry: type: object properties: ".tag": type: string example: success metadata: - $ref: '#/components/schemas/inline_response_200_9_metadata' - inline_response_200_16_export_metadata: + $ref: '#/components/schemas/MetadataAsResponse' + ExportFileResponseMetadata: type: object properties: export_hash: @@ -15268,56 +15245,7 @@ components: size: type: number example: 7189 - inline_response_200_16_file_metadata: - type: object - properties: - client_modified: - type: string - example: 2015-05-12T15:50:38Z - content_hash: - type: string - example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' - has_explicit_shared_members: - type: boolean - example: false - id: - type: string - example: id:a4ayc_80_OEAAAAAAAAAXw - is_downloadable: - type: boolean - example: true - name: - type: string - example: Prime_Numbers.txt - path_display: - type: string - example: /Homework/math/Prime_Numbers.txt - path_lower: - type: string - example: /homework/math/prime_numbers.txt - property_groups: - type: array - example: - - fields: - - name: Security Policy - value: Confidential - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - items: - $ref: '#/components/schemas/PropertyGroup' - rev: - type: string - example: a1c10ce0dd78 - server_modified: - type: string - example: 2015-05-12T15:50:38Z - sharing_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' - size: - type: number - example: 7212 - inline_response_200_17_lock_content: + FileLockContent: type: object properties: ".tag": @@ -15332,33 +15260,33 @@ components: lock_holder_team_id: type: string example: dbtid:1234abcd - inline_response_200_17_lock: + FileLock: type: object properties: content: - $ref: '#/components/schemas/inline_response_200_17_lock_content' - inline_response_200_17_entries: + $ref: '#/components/schemas/FileLockContent' + LockFileResultEntry: type: object properties: ".tag": type: string example: success lock: - $ref: '#/components/schemas/inline_response_200_17_lock' + $ref: '#/components/schemas/FileLock' metadata: - $ref: '#/components/schemas/inline_response_200_9_metadata' - inline_response_200_22_entries: + $ref: '#/components/schemas/MetadataAsResponse' + GetThumbnailBatchResultEntry: type: object properties: ".tag": type: string example: success metadata: - $ref: '#/components/schemas/inline_response_200_16_file_metadata' + $ref: '#/components/schemas/FileMetadata' thumbnail: type: string example: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= - inline_response_200_23_sharing_info: + SharingInfo: type: object properties: modified_by: @@ -15376,7 +15304,7 @@ components: traverse_only: type: boolean example: false - inline_response_200_23_entries: + Metadata: type: object properties: ".tag": @@ -15389,7 +15317,7 @@ components: type: string example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 file_lock_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + $ref: '#/components/schemas/FileLockInfo' has_explicit_shared_members: type: boolean example: false @@ -15424,24 +15352,24 @@ components: type: string example: 2015-05-12T15:50:38Z sharing_info: - $ref: '#/components/schemas/inline_response_200_23_sharing_info' + $ref: '#/components/schemas/SharingInfo' size: type: number example: 7212 - inline_response_200_28_metadata: + MetadataV2: type: object properties: ".tag": type: string example: metadata metadata: - $ref: '#/components/schemas/inline_response_200_9_metadata' - inline_response_200_28_matches: + $ref: '#/components/schemas/MetadataAsResponse' + SearchMatch: type: object properties: metadata: - $ref: '#/components/schemas/inline_response_200_28_metadata' - inline_response_200_29_entries: + $ref: '#/components/schemas/MetadataV2' + UploadSessionFinishBatchResultEntry: type: object properties: ".tag": @@ -15454,7 +15382,7 @@ components: type: string example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 file_lock_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + $ref: '#/components/schemas/FileLockInfo' has_explicit_shared_members: type: boolean example: false @@ -15489,37 +15417,37 @@ components: type: string example: 2015-05-12T15:50:38Z sharing_info: - $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + $ref: '#/components/schemas/MetadataSharingInfo' size: type: number example: 7212 - inline_response_200_33_access_inheritance: + AccessInheritance: type: object properties: ".tag": type: string example: inherit - inline_response_200_33_link_metadata_audience_options: + LinkAudience: type: object properties: ".tag": type: string example: public - inline_response_200_33_link_metadata_action: + LinkAction: type: object properties: ".tag": type: string example: change_audience - inline_response_200_33_link_metadata_link_permissions: + LinkPermission: type: object properties: action: - $ref: '#/components/schemas/inline_response_200_33_link_metadata_action' + $ref: '#/components/schemas/LinkAction' allow: type: boolean example: true - inline_response_200_33_link_metadata: + SharedContentLinkMetadata: type: object properties: audience_options: @@ -15529,9 +15457,9 @@ components: - ".tag": team - ".tag": members items: - $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + $ref: '#/components/schemas/LinkAudience' current_audience: - $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + $ref: '#/components/schemas/LinkAudience' link_permissions: type: array example: @@ -15539,30 +15467,30 @@ components: ".tag": change_audience allow: true items: - $ref: '#/components/schemas/inline_response_200_33_link_metadata_link_permissions' + $ref: '#/components/schemas/LinkPermission' password_protected: type: boolean example: false url: type: string example: "" - inline_response_200_37_link_permissions_revoke_failure_reason: + SharedLinkAccessFailureReason: type: object properties: ".tag": type: string example: owner_only - inline_response_200_37_link_permissions: + SharedLinkMetadataLinkPermissions: type: object properties: can_revoke: type: boolean example: false resolved_visibility: - $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + $ref: '#/components/schemas/LinkAudience' revoke_failure_reason: - $ref: '#/components/schemas/inline_response_200_37_link_permissions_revoke_failure_reason' - inline_response_200_37_team_member_info: + $ref: '#/components/schemas/SharedLinkAccessFailureReason' + TeamMemberInfo: type: object properties: display_name: @@ -15573,7 +15501,7 @@ components: example: dbmid:abcd1234 team_info: $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' - inline_response_200_40_users: + UserMembershipInfo: type: object properties: access_type: @@ -15587,43 +15515,7 @@ components: items: {} user: $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_user' - inline_response_200_41_entries: - type: object - properties: - access_inheritance: - $ref: '#/components/schemas/inline_response_200_33_access_inheritance' - access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' - is_inside_team_folder: - type: boolean - example: false - is_team_folder: - type: boolean - example: false - link_metadata: - $ref: '#/components/schemas/inline_response_200_33_link_metadata' - name: - type: string - example: dir - path_lower: - type: string - example: /dir - permissions: - type: array - example: [] - items: {} - policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' - preview_url: - type: string - example: https://www.dropbox.com/scl/fo/fir9vjelf - shared_folder_id: - type: string - example: "84528192421" - time_invited: - type: string - example: 2016-01-20T00:00:00Z - inline_response_200_42_entries: + SharedFileMetadata: type: object properties: access_type: @@ -15661,41 +15553,7 @@ components: time_invited: type: string example: 2016-01-20T00:00:00Z - inline_response_200_43_links: - type: object - properties: - ".tag": - type: string - example: file - client_modified: - type: string - example: 2015-05-12T15:50:38Z - id: - type: string - example: id:a4ayc_80_OEAAAAAAAAAXw - link_permissions: - $ref: '#/components/schemas/inline_response_200_37_link_permissions' - name: - type: string - example: Prime_Numbers.txt - path_lower: - type: string - example: /homework/math/prime_numbers.txt - rev: - type: string - example: a1c10ce0dd78 - server_modified: - type: string - example: 2015-05-12T15:50:38Z - size: - type: number - example: 7212 - team_member_info: - $ref: '#/components/schemas/inline_response_200_37_team_member_info' - url: - type: string - example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - inline_response_200_48_groups: + GroupSummary: type: object properties: group_id: @@ -15709,55 +15567,7 @@ components: member_count: type: number example: 10 - inline_response_200_49_group_info: - type: object - properties: - created: - type: number - example: 1447255518000 - group_id: - type: string - example: g:e2db7665347abcd600000000001a2b3c - group_management_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' - group_name: - type: string - example: project launch - member_count: - type: number - example: 5 - members: - type: array - example: - - access_type: - ".tag": member - profile: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - email: mary@lamb.com - email_verified: true - joined_on: 2015-05-12T15:50:38Z - membership_type: - ".tag": full - name: - abbreviated_name: FF - display_name: Franz Ferdinand (Personal) - familiar_name: Franz - given_name: Franz - surname: Ferdinand - profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - secondary_emails: - - email: apple@orange.com - is_verified: true - - email: banana@honeydew.com - is_verified: true - - email: grape@strawberry.com - is_verified: false - status: - ".tag": active - team_member_id: dbmid:1234567 - items: - $ref: '#/components/schemas/teamgroupsget_info_members' - inline_response_200_51_members: + MembersInfo: type: object properties: permanently_deleted_users: @@ -15770,7 +15580,7 @@ components: items: type: string example: dbmid:efgh5678 - inline_response_200_52_entries: + LegalHoldHeldRevisionMetadata: type: object properties: author_email: @@ -15802,7 +15612,7 @@ components: size: type: number example: 3 - inline_response_200_53_policies: + LegalHoldPolicyAsResponse: type: object properties: activation_time: @@ -15815,7 +15625,7 @@ components: type: string example: pid_dbhid:abcd1234 members: - $ref: '#/components/schemas/inline_response_200_51_members' + $ref: '#/components/schemas/MembersInfo' name: type: string example: acme cfo policy @@ -15824,7 +15634,7 @@ components: example: 2016-01-01T00:00:00Z status: $ref: '#/components/schemas/teamgroupsget_info_profile_status' - inline_response_200_56_complete: + MemberAddResult: type: object properties: ".tag": @@ -15834,14 +15644,7 @@ components: $ref: '#/components/schemas/teammembersget_info_profile' role: $ref: '#/components/schemas/teammembersget_info_role' - inline_response_200_59_members: - type: object - properties: - profile: - $ref: '#/components/schemas/teammembersget_info_profile' - role: - $ref: '#/components/schemas/teammembersget_info_role' - inline_response_200_60_results: + AddSecondaryEmailResult: type: object properties: ".tag": @@ -15852,7 +15655,7 @@ components: unavailable: type: string example: alice@example.com - inline_response_200_60_results_1: + UserAddResult: type: object properties: ".tag": @@ -15870,10 +15673,10 @@ components: - ".tag": unavailable unavailable: alice@example.com items: - $ref: '#/components/schemas/inline_response_200_60_results' + $ref: '#/components/schemas/AddSecondaryEmailResult' user: $ref: '#/components/schemas/members_send_welcome_email_body' - inline_response_200_61_results: + DeleteSecondaryEmailResult: type: object properties: ".tag": @@ -15885,7 +15688,7 @@ components: success: type: string example: alice@example.com - inline_response_200_61_results_1: + UserDeleteResult: type: object properties: ".tag": @@ -15899,10 +15702,10 @@ components: - ".tag": not_found not_found: alic@example.com items: - $ref: '#/components/schemas/inline_response_200_61_results' + $ref: '#/components/schemas/DeleteSecondaryEmailResult' user: $ref: '#/components/schemas/members_send_welcome_email_body' - inline_response_200_62_results: + ResendSecondaryEmailResult: type: object properties: ".tag": @@ -15911,7 +15714,7 @@ components: success: type: string example: alice@example.com - inline_response_200_62_results_1: + UserResendResult: type: object properties: ".tag": @@ -15923,16 +15726,16 @@ components: - ".tag": success success: alice@example.com items: - $ref: '#/components/schemas/inline_response_200_62_results' + $ref: '#/components/schemas/ResendSecondaryEmailResult' user: $ref: '#/components/schemas/members_send_welcome_email_body' - inline_response_200_64_namespace_type: + NamespaceType: type: object properties: ".tag": type: string example: shared_folder - inline_response_200_64_namespaces: + NamespaceMetadata: type: object properties: name: @@ -15942,49 +15745,25 @@ components: type: string example: "123456789" namespace_type: - $ref: '#/components/schemas/inline_response_200_64_namespace_type' + $ref: '#/components/schemas/NamespaceType' team_member_id: type: string example: dbmid:1234567 - inline_response_200_65_sync_setting: + SyncSetting: type: object properties: ".tag": type: string example: default - inline_response_200_65_content_sync_settings: + ContentSyncSetting: type: object properties: id: type: string example: id:a4ayc_80_OEAAAAAAAAAXw sync_setting: - $ref: '#/components/schemas/inline_response_200_65_sync_setting' - inline_response_200_67_team_folders: - type: object - properties: - content_sync_settings: - type: array - example: - - id: id:a4ayc_80_OEAAAAAAAAAXw - sync_setting: - ".tag": default - items: - $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' - is_team_shared_dropbox: - type: boolean - example: false - name: - type: string - example: Marketing - status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' - sync_setting: - $ref: '#/components/schemas/inline_response_200_65_sync_setting' - team_folder_id: - type: string - example: "123456789" - inline_response_200_68_has_team_shared_dropbox: + $ref: '#/components/schemas/SyncSetting' + HasTeamSharedDropboxValue: type: object properties: ".tag": @@ -15993,7 +15772,7 @@ components: has_team_shared_dropbox: type: boolean example: false - inline_response_200_68_upload_api_rate_limit: + UploadApiRateLimitValue: type: object properties: ".tag": @@ -16002,59 +15781,59 @@ components: limit: type: number example: 25000 - inline_response_200_68_values: + FeatureValue: type: object properties: ".tag": type: string example: upload_api_rate_limit has_team_shared_dropbox: - $ref: '#/components/schemas/inline_response_200_68_has_team_shared_dropbox' + $ref: '#/components/schemas/HasTeamSharedDropboxValue' upload_api_rate_limit: - $ref: '#/components/schemas/inline_response_200_68_upload_api_rate_limit' - inline_response_200_69_policies_emm_state: + $ref: '#/components/schemas/UploadApiRateLimitValue' + EmmStateOrOfficeAddinPolicy: type: object properties: ".tag": type: string example: disabled - inline_response_200_69_policies_sharing_shared_folder_join_policy: + SharedFolderJoinPolicy: type: object properties: ".tag": type: string example: from_anyone - inline_response_200_69_policies_sharing_shared_link_create_policy: + SharedLinkCreatePolicy: type: object properties: ".tag": type: string example: team_only - inline_response_200_69_policies_sharing: + TeamSharingPolicies: type: object properties: shared_folder_join_policy: - $ref: '#/components/schemas/inline_response_200_69_policies_sharing_shared_folder_join_policy' + $ref: '#/components/schemas/SharedFolderJoinPolicy' shared_folder_member_policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_resolved_member_policy' + $ref: '#/components/schemas/SharedFolderMemberPolicy' shared_link_create_policy: - $ref: '#/components/schemas/inline_response_200_69_policies_sharing_shared_link_create_policy' - inline_response_200_69_policies: + $ref: '#/components/schemas/SharedLinkCreatePolicy' + TeamMemberPolicies: type: object properties: emm_state: - $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + $ref: '#/components/schemas/EmmStateOrOfficeAddinPolicy' office_addin: - $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + $ref: '#/components/schemas/EmmStateOrOfficeAddinPolicy' sharing: - $ref: '#/components/schemas/inline_response_200_69_policies_sharing' - inline_response_200_71_actor_user_team: + $ref: '#/components/schemas/TeamSharingPolicies' + TeamLogInfo: type: object properties: display_name: type: string example: A Team - inline_response_200_71_actor_user: + UserLogInfo: type: object properties: ".tag": @@ -16073,19 +15852,19 @@ components: type: string example: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 team: - $ref: '#/components/schemas/inline_response_200_71_actor_user_team' + $ref: '#/components/schemas/TeamLogInfo' team_member_id: type: string example: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - inline_response_200_71_actor: + ActorLogInfo: type: object properties: ".tag": type: string example: user user: - $ref: '#/components/schemas/inline_response_200_71_actor_user' - inline_response_200_71_path_namespace_relative: + $ref: '#/components/schemas/UserLogInfo' + NamespaceRelativePathLogInfo: type: object properties: is_shared_namespace: @@ -16097,15 +15876,15 @@ components: relative_path: type: string example: /Contract Work/Draft - inline_response_200_71_path: + PathLogInfo: type: object properties: contextual: type: string example: /Contract Work/Draft namespace_relative: - $ref: '#/components/schemas/inline_response_200_71_path_namespace_relative' - inline_response_200_71_assets: + $ref: '#/components/schemas/NamespaceRelativePathLogInfo' + AssetLogInfo: type: object properties: ".tag": @@ -16121,33 +15900,33 @@ components: type: number example: 4 path: - $ref: '#/components/schemas/inline_response_200_71_path' - inline_response_200_71_details_shared_content_access_level: + $ref: '#/components/schemas/PathLogInfo' + SharedContentAccessLevel: type: object properties: ".tag": type: string example: viewer_no_comment - inline_response_200_71_details: + EventDetails: type: object properties: ".tag": type: string example: shared_content_download_details shared_content_access_level: - $ref: '#/components/schemas/inline_response_200_71_details_shared_content_access_level' + $ref: '#/components/schemas/SharedContentAccessLevel' shared_content_link: type: string example: abc shared_content_owner: - $ref: '#/components/schemas/inline_response_200_71_actor_user' - inline_response_200_71_event_category: + $ref: '#/components/schemas/UserLogInfo' + EventCategory: type: object properties: ".tag": type: string example: tfa - inline_response_200_71_event_type: + EventType: type: object properties: ".tag": @@ -16156,7 +15935,7 @@ components: description: type: string example: (sharing) Downloaded shared file/folder - inline_response_200_71_origin_access_method_end_user: + SessionLogInfo: type: object properties: ".tag": @@ -16165,15 +15944,15 @@ components: session_id: type: string example: dbwsid:123456789012345678901234567890123456789 - inline_response_200_71_origin_access_method: + AccessMethodLogInfo: type: object properties: ".tag": type: string example: end_user end_user: - $ref: '#/components/schemas/inline_response_200_71_origin_access_method_end_user' - inline_response_200_71_origin_geo_location: + $ref: '#/components/schemas/SessionLogInfo' + GeoLocationLogInfo: type: object properties: city: @@ -16188,49 +15967,26 @@ components: region: type: string example: California - inline_response_200_71_origin: + OriginLogInfo: type: object properties: access_method: - $ref: '#/components/schemas/inline_response_200_71_origin_access_method' + $ref: '#/components/schemas/AccessMethodLogInfo' geo_location: - $ref: '#/components/schemas/inline_response_200_71_origin_geo_location' - inline_response_200_71_user: - type: object - properties: - ".tag": - type: string - example: team_member - account_id: - type: string - example: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw - display_name: - type: string - example: Jane Smith - email: - type: string - example: jane_smith@acmecorp.com - member_external_id: - type: string - example: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 - team: - $ref: '#/components/schemas/inline_response_200_71_actor_user_team' - team_member_id: - type: string - example: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q - inline_response_200_71_participants: + $ref: '#/components/schemas/GeoLocationLogInfo' + ParticipantLogInfo: type: object properties: ".tag": type: string example: user user: - $ref: '#/components/schemas/inline_response_200_71_user' - inline_response_200_71_events: + $ref: '#/components/schemas/UserLogInfo' + TeamEvent: type: object properties: actor: - $ref: '#/components/schemas/inline_response_200_71_actor' + $ref: '#/components/schemas/ActorLogInfo' assets: type: array example: @@ -16245,20 +16001,20 @@ components: ns_id: "1234" relative_path: /Contract Work/Draft items: - $ref: '#/components/schemas/inline_response_200_71_assets' + $ref: '#/components/schemas/AssetLogInfo' context: - $ref: '#/components/schemas/inline_response_200_71_actor_user' + $ref: '#/components/schemas/UserLogInfo' details: - $ref: '#/components/schemas/inline_response_200_71_details' + $ref: '#/components/schemas/EventDetails' event_category: - $ref: '#/components/schemas/inline_response_200_71_event_category' + $ref: '#/components/schemas/EventCategory' event_type: - $ref: '#/components/schemas/inline_response_200_71_event_type' + $ref: '#/components/schemas/EventType' involve_non_team_member: type: boolean example: true origin: - $ref: '#/components/schemas/inline_response_200_71_origin' + $ref: '#/components/schemas/OriginLogInfo' participants: type: array example: @@ -16273,11 +16029,11 @@ components: display_name: A Team team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q items: - $ref: '#/components/schemas/inline_response_200_71_participants' + $ref: '#/components/schemas/ParticipantLogInfo' timestamp: type: string example: 2017-01-25T15:51:30Z - inline_response_200_72_paper_as_files: + PaperAsFilesValue: type: object properties: ".tag": @@ -16286,21 +16042,21 @@ components: enabled: type: boolean example: true - inline_response_200_72_values: + UserFeatureValue: type: object properties: ".tag": type: string example: paper_as_files paper_as_files: - $ref: '#/components/schemas/inline_response_200_72_paper_as_files' - inline_response_200_75_account_type: + $ref: '#/components/schemas/PaperAsFilesValue' + AccountType: type: object properties: ".tag": type: string example: business - inline_response_200_75_root_info: + RootInfo: type: object properties: ".tag": @@ -16312,7 +16068,7 @@ components: root_namespace_id: type: string example: "3235641" - inline_response_200_75_team: + FullTeam: type: object properties: id: @@ -16322,10 +16078,10 @@ components: type: string example: "Acme, Inc." office_addin_policy: - $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + $ref: '#/components/schemas/EmmStateOrOfficeAddinPolicy' sharing_policies: - $ref: '#/components/schemas/inline_response_200_69_policies_sharing' - inline_response_200_76_allocation: + $ref: '#/components/schemas/TeamSharingPolicies' + SpaceAllocation: type: object properties: ".tag": From be57b277338359d9beb77617f7341139e884b15a Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Tue, 29 Oct 2024 12:02:26 +0530 Subject: [PATCH 13/15] Clean up --- build-config/resources/Ballerina.toml | 4 ++-- docs/spec/sanitations.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/build-config/resources/Ballerina.toml b/build-config/resources/Ballerina.toml index 1e7237d..7a7d521 100644 --- a/build-config/resources/Ballerina.toml +++ b/build-config/resources/Ballerina.toml @@ -5,8 +5,8 @@ name = "dropbox" version = "@toml.version@" license = ["Apache-2.0"] authors = ["Ballerina"] -keywords = [] # TODO: Add keywords -# icon = "icon.png" # TODO: Add icon +keywords = ["Content & Files/File Management & Storage", "Cost/Free"] +icon = "icon.png" repository = "https://github.com/ballerina-platform/module-ballerinax-dropbox" [build-options] diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 96c4dbb..3787be0 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -9,7 +9,6 @@ This document records the sanitation done on top of the official OpenAPI specifi The OpenAPI specification is obtained from https://www.postman.com/dropbox-api/dropbox-s-public-workspace/collection/q1zdtug/dropbox-api-reference. These changes are done in order to improve the overall usability, and as workarounds for some known language limitations. -[//]: # (TODO: Add sanitation details) 1. **Change the `url` property of the `servers` object**: - **Original**: 1. `https://api.dropboxapi.com`, @@ -20,6 +19,7 @@ These changes are done in order to improve the overall usability, and as workaro 2. `https://content.dropboxapi.com/2` 3. `https://notify.dropboxapi.com/2` - **Reason**: This change is made to ensure that all API paths are relative to the versioned base URL (`/2`), which improves the consistency and usability of the APIs. + 2. **Update API Paths**: - **Original**: Paths included the version prefix in each endpoint (e.g., `/2/files/list_folder`). - **Updated**: Paths are modified to remove the version prefix from the endpoints, as it is now included in the base URL. For example: From fefd8feff0d89a3f6eaf68305b09685ec51d7897 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Wed, 30 Oct 2024 09:56:29 +0530 Subject: [PATCH 14/15] Name schemas in same fashion as Dropbox --- ballerina/client.bal | 340 +++---- ballerina/types.bal | 1935 ++++++++++++++++++---------------------- docs/spec/openapi.yaml | 1508 ++++++++++++------------------- 3 files changed, 1599 insertions(+), 2184 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index c27d979..2182e70 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -109,7 +109,7 @@ public isolated client class Client { return; } - resource isolated function post 'check/app(CheckAppRequest payload, AppHeaders headers = {}) returns EchoResult|error { + resource isolated function post 'check/app(EchoArg payload, AppHeaders headers = {}) returns EchoResult|error { string resourcePath = string `/check/app`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -118,7 +118,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post 'check/user(CheckUserRequest payload, UserHeaders headers = {}) returns EchoResult|error { + resource isolated function post 'check/user(EchoArg payload, UserHeaders headers = {}) returns EchoResult|error { string resourcePath = string `/check/user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -131,7 +131,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - set_profile_photo response - resource isolated function post account/set_profile_photo(SetProfilePhotoRequest payload, SetProfilePhotoHeaders headers = {}) returns SetProfilePhotoResponse|error { + resource isolated function post account/set_profile_photo(SetProfilePhotoArg payload, SetProfilePhotoHeaders headers = {}) returns SetProfilePhotoResult|error { string resourcePath = string `/account/set_profile_photo`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -144,7 +144,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - token/from_oauth1 response - resource isolated function post auth/token/from_oauth1(TokenFromOauth1Request payload, TokenFromOauth1Headers headers = {}) returns TokenFromOauth1Response|error { + resource isolated function post auth/token/from_oauth1(TokenFromOauth1Arg payload, TokenFromOauth1Headers headers = {}) returns TokenFromOauth1Result|error { string resourcePath = string `/auth/token/from_oauth1`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -176,7 +176,7 @@ public isolated client class Client { # delete_manual_contacts_batch # # + headers - Headers to be sent with the request - resource isolated function post contacts/delete_manual_contacts_batch(DeleteManualContactsBatchRequest payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { + resource isolated function post contacts/delete_manual_contacts_batch(DeleteManualContactsArg payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { string resourcePath = string `/contacts/delete_manual_contacts_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -188,7 +188,7 @@ public isolated client class Client { # properties/add # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/add(AddPropertiesRequest payload, PropertiesAddHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/add(AddPropertiesArg payload, PropertiesAddHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/add`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -200,7 +200,7 @@ public isolated client class Client { # properties/overwrite # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/overwrite(OverwritePropertiesRequest payload, PropertiesOverwriteHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/overwrite(OverwritePropertyGroupArg payload, PropertiesOverwriteHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/overwrite`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -212,7 +212,7 @@ public isolated client class Client { # properties/remove # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/remove(RemovePropertiesRequest payload, PropertiesRemoveHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/remove(RemovePropertiesArg payload, PropertiesRemoveHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/remove`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -225,7 +225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - properties/search response - resource isolated function post file_properties/properties/search(SearchPropertiesRequest payload, PropertiesSearchHeaders headers = {}) returns SearchPropertiesResponse|error { + resource isolated function post file_properties/properties/search(PropertiesSearchArg payload, PropertiesSearchHeaders headers = {}) returns PropertiesSearchResult|error { string resourcePath = string `/file_properties/properties/search`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -234,7 +234,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_properties/properties/search/'continue(SearchPropertiesContinueRequest payload, PropertiesSearchContinueHeaders headers = {}) returns SearchPropertiesResponse|error { + resource isolated function post file_properties/properties/search/'continue(PropertiesSearchContinueArg payload, PropertiesSearchContinueHeaders headers = {}) returns PropertiesSearchResult|error { string resourcePath = string `/file_properties/properties/search/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -246,7 +246,7 @@ public isolated client class Client { # properties/update # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/update(UpdatePropertiesRequest payload, PropertiesUpdateHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/update(UpdatePropertiesArg payload, PropertiesUpdateHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -259,7 +259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_team response - resource isolated function post file_properties/templates/add_for_team(AddTemplateForTeam payload, map headers = {}) returns AddTemplateResponse|error { + resource isolated function post file_properties/templates/add_for_team(AddTemplateArg payload, map headers = {}) returns AddTemplateResult|error { string resourcePath = string `/file_properties/templates/add_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -271,7 +271,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_user response - resource isolated function post file_properties/templates/add_for_user(AddTemplateForUser payload, TemplatesAddForUserHeaders headers = {}) returns AddTemplateResponse|error { + resource isolated function post file_properties/templates/add_for_user(AddTemplateArg payload, TemplatesAddForUserHeaders headers = {}) returns AddTemplateResult|error { string resourcePath = string `/file_properties/templates/add_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -284,7 +284,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_team response - resource isolated function post file_properties/templates/get_for_team(GetTemplateForTeam payload, map headers = {}) returns GetTemplateResponse|error { + resource isolated function post file_properties/templates/get_for_team(GetTemplateArg payload, map headers = {}) returns GetTemplateResult|error { string resourcePath = string `/file_properties/templates/get_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -296,7 +296,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_user response - resource isolated function post file_properties/templates/get_for_user(GetTemplateForUserRequest payload, TemplatesGetForUserHeaders headers = {}) returns GetTemplateResponse|error { + resource isolated function post file_properties/templates/get_for_user(GetTemplateArg payload, TemplatesGetForUserHeaders headers = {}) returns GetTemplateResult|error { string resourcePath = string `/file_properties/templates/get_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -309,7 +309,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_team response - resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns ListTemplatesResponse|error { + resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns ListTemplateResult|error { string resourcePath = string `/file_properties/templates/list_for_team`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -319,7 +319,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_user response - resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns ListTemplatesResponse|error { + resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns ListTemplateResult|error { string resourcePath = string `/file_properties/templates/list_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -329,7 +329,7 @@ public isolated client class Client { # templates/remove_for_team # # + headers - Headers to be sent with the request - resource isolated function post file_properties/templates/remove_for_team(RemoveTemplateForTeamRequest payload, map headers = {}) returns error? { + resource isolated function post file_properties/templates/remove_for_team(RemoveTemplateArg payload, map headers = {}) returns error? { string resourcePath = string `/file_properties/templates/remove_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -353,7 +353,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_team response - resource isolated function post file_properties/templates/update_for_team(UpdateTemplateForTeamRequest payload, map headers = {}) returns TemplateId|error { + resource isolated function post file_properties/templates/update_for_team(UpdateTemplateArg payload, map headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -365,7 +365,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_user response - resource isolated function post file_properties/templates/update_for_user(UpdateTemplateForUserRequest payload, TemplatesUpdateForUserHeaders headers = {}) returns TemplateId|error { + resource isolated function post file_properties/templates/update_for_user(UpdateTemplateArg payload, TemplatesUpdateForUserHeaders headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -378,7 +378,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - count response - resource isolated function post file_requests/count(CountHeaders headers = {}) returns FileRequestCount|error { + resource isolated function post file_requests/count(CountHeaders headers = {}) returns CountFileRequestsResult|error { string resourcePath = string `/file_requests/count`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -389,7 +389,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create response - resource isolated function post file_requests/create(CreateFileRequestRequest payload, CreateHeaders headers = {}) returns FileRequest|error { + resource isolated function post file_requests/create(CreateFileRequestArgs payload, CreateHeaders headers = {}) returns FileRequest|error { string resourcePath = string `/file_requests/create`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -402,7 +402,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns DeleteFileRequestsResponse|error { + resource isolated function post file_requests/delete(DeleteFileRequestArgs payload, DeleteHeaders headers = {}) returns DeleteFileRequestsResult|error { string resourcePath = string `/file_requests/delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -415,7 +415,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_all_closed response - resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns DeleteFileRequestsResponse|error { + resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns DeleteFileRequestsResult|error { string resourcePath = string `/file_requests/delete_all_closed`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -426,7 +426,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get response - resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns FileRequest|error { + resource isolated function post file_requests/get(GetFileRequestArgs payload, GetHeaders headers = {}) returns FileRequest|error { string resourcePath = string `/file_requests/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -435,7 +435,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns ListFileRequestsResponse|error { + resource isolated function post file_requests/list/'continue(ListFileRequestsContinueArg payload, ListContinueHeaders headers = {}) returns ListFileRequestsV2Result|error { string resourcePath = string `/file_requests/list/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -448,7 +448,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list response - resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns ListFileRequestsResponse|error { + resource isolated function post file_requests/list_v2(ListFileRequestsArg payload, ListHeaders headers = {}) returns ListFileRequestsV2Result|error { string resourcePath = string `/file_requests/list_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -461,7 +461,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update response - resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns FileRequest|error { + resource isolated function post file_requests/update(UpdateFileRequestArgs payload, UpdateHeaders headers = {}) returns FileRequest|error { string resourcePath = string `/file_requests/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -474,7 +474,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch/check response - resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns RelocationBatchV2Response|error { + resource isolated function post files/copy_batch/check_v2(PollArg payload, CopyBatchCheckHeaders headers = {}) returns RelocationBatchV2Result|error { string resourcePath = string `/files/copy_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -487,7 +487,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch response - resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns RelocationBatchV2Response|error { + resource isolated function post files/copy_batch_v2(RelocationBatchArgBase payload, CopyBatchHeaders headers = {}) returns RelocationBatchV2Result|error { string resourcePath = string `/files/copy_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -500,7 +500,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/get response - resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns GetCopyReferenceResponse|error { + resource isolated function post files/copy_reference/get(GetCopyReferenceArg payload, CopyReferenceGetHeaders headers = {}) returns GetCopyReferenceResult|error { string resourcePath = string `/files/copy_reference/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -513,7 +513,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/save response - resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns MetadataResponse|error { + resource isolated function post files/copy_reference/save(SaveCopyReferenceArg payload, CopyReferenceSaveHeaders headers = {}) returns MetadataResult|error { string resourcePath = string `/files/copy_reference/save`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -526,7 +526,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy response - resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns MetadataResponse|error { + resource isolated function post files/copy_v2(RelocationArg payload, CopyHeaders headers = {}) returns MetadataResult|error { string resourcePath = string `/files/copy_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -539,7 +539,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder_batch response - resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns CreateFolderBatchResponse|error { + resource isolated function post files/create_folder_batch(CreateFolderBatchArg payload, CreateFolderBatchHeaders headers = {}) returns CreateFolderBatchResult|error { string resourcePath = string `/files/create_folder_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -548,7 +548,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns CreateFolderBatchResponse|error { + resource isolated function post files/create_folder_batch/'check(PollArg payload, CreateFolderBatchCheckHeaders headers = {}) returns CreateFolderBatchResult|error { string resourcePath = string `/files/create_folder_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -561,7 +561,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder response - resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns FolderMetadataResponse|error { + resource isolated function post files/create_folder_v2(CreateFolderArg payload, CreateFolderHeaders headers = {}) returns FolderMetadataResponse|error { string resourcePath = string `/files/create_folder_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -574,7 +574,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_batch response - resource isolated function post files/delete_batch(DeleteFilesBatchRequest payload, DeleteBatchHeaders headers = {}) returns DeleteBatchResponse|error { + resource isolated function post files/delete_batch(DeleteBatchArg payload, DeleteBatchHeaders headers = {}) returns DeleteBatchResult|error { string resourcePath = string `/files/delete_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -583,7 +583,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns DeleteBatchResponse|error { + resource isolated function post files/delete_batch/'check(PollArg payload, DeleteBatchCheckHeaders headers = {}) returns DeleteBatchResult|error { string resourcePath = string `/files/delete_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -596,7 +596,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post files/delete_v2(FilePath payload, Delete1Headers headers = {}) returns MetadataResponse|error { + resource isolated function post files/delete_v2(DeleteArg payload, Delete1Headers headers = {}) returns MetadataResult|error { string resourcePath = string `/files/delete_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -631,7 +631,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - export response - resource isolated function post files/export(ExportHeaders headers = {}) returns ExportFileResponse|error { + resource isolated function post files/export(ExportHeaders headers = {}) returns ExportResult|error { string resourcePath = string `/files/export`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -642,7 +642,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_lock_batch response - resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns LockFileBatchResult|error { + resource isolated function post files/get_file_lock_batch(LockFileBatchArg payload, GetFileLockBatchHeaders headers = {}) returns LockFileBatchResult|error { string resourcePath = string `/files/get_file_lock_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -655,7 +655,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_metadata response - resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns GetMetadataResponse|error { + resource isolated function post files/get_metadata(GetMetadataArg payload, GetMetadataHeaders headers = {}) returns Metadata|error { string resourcePath = string `/files/get_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -679,7 +679,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_link response - resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns GetTemporaryLinkResponse|error { + resource isolated function post files/get_temporary_link(GetTemporaryLinkArg payload, GetTemporaryLinkHeaders headers = {}) returns GetTemporaryLinkResult|error { string resourcePath = string `/files/get_temporary_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -692,7 +692,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_upload_link response - resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns GetTemporaryUploadLinkResponse|error { + resource isolated function post files/get_temporary_upload_link(GetTemporaryUploadLinkArg payload, GetTemporaryUploadLinkHeaders headers = {}) returns GetTemporaryUploadLinkResult|error { string resourcePath = string `/files/get_temporary_upload_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -705,7 +705,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail_batch response - resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns GetThumbnailBatchResponse|error { + resource isolated function post files/get_thumbnail_batch(GetThumbnailBatchArg payload, GetThumbnailBatchHeaders headers = {}) returns GetThumbnailBatchResult|error { string resourcePath = string `/files/get_thumbnail_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -718,7 +718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail response - resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns GetThumbnailResponse|error { + resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns PreviewResult|error { string resourcePath = string `/files/get_thumbnail_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -729,7 +729,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder response - resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns ListFolderResponse|error { + resource isolated function post files/list_folder(ListFolderArg payload, ListFolderHeaders headers = {}) returns ListFolderResult|error { string resourcePath = string `/files/list_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -738,7 +738,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns ListFolderResponse|error { + resource isolated function post files/list_folder/'continue(ListFolderContinueArg payload, ListFolderContinueHeaders headers = {}) returns ListFolderResult|error { string resourcePath = string `/files/list_folder/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -751,7 +751,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder/get_latest_cursor response - resource isolated function post files/list_folder/get_latest_cursor(list_folder_get_latest_cursor_body payload, ListFolderGetLatestCursorHeaders headers = {}) returns list_folder_continue_body|error { + resource isolated function post files/list_folder/get_latest_cursor(ListFolderArg payload, ListFolderGetLatestCursorHeaders headers = {}) returns ListFolderContinueArg|error { string resourcePath = string `/files/list_folder/get_latest_cursor`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -764,7 +764,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder/longpoll response - resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns ListFolderLongpollResult|error { + resource isolated function post files/list_folder/longpoll(ListFolderLongpollArg payload, ListFolderLongpollHeaders headers = {}) returns ListFolderLongpollResult|error { string resourcePath = string `/files/list_folder/longpoll`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -777,7 +777,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_revisions response - resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns ListRevisionsResult|error { + resource isolated function post files/list_revisions(ListRevisionsArg payload, ListRevisionsHeaders headers = {}) returns ListRevisionsResult|error { string resourcePath = string `/files/list_revisions`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -790,7 +790,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - lock_file_batch response - resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns LockFileBatchResult|error { + resource isolated function post files/lock_file_batch(LockFileBatchArg payload, LockFileBatchHeaders headers = {}) returns LockFileBatchResult|error { string resourcePath = string `/files/lock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -803,7 +803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch/check response - resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns RelocationBatchV2Response|error { + resource isolated function post files/move_batch/check_v2(PollArg payload, MoveBatchCheckHeaders headers = {}) returns RelocationBatchV2Result|error { string resourcePath = string `/files/move_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -816,7 +816,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch response - resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns RelocationBatchV2Response|error { + resource isolated function post files/move_batch_v2(MoveBatchArg payload, MoveBatchHeaders headers = {}) returns RelocationBatchV2Result|error { string resourcePath = string `/files/move_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -829,7 +829,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move response - resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns MetadataResponse|error { + resource isolated function post files/move_v2(RelocationArg payload, MoveHeaders headers = {}) returns MetadataResult|error { string resourcePath = string `/files/move_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -841,7 +841,7 @@ public isolated client class Client { # permanently_delete # # + headers - Headers to be sent with the request - resource isolated function post files/permanently_delete(files_permanently_delete_body payload, PermanentlyDeleteHeaders headers = {}) returns error? { + resource isolated function post files/permanently_delete(DeleteArg payload, PermanentlyDeleteHeaders headers = {}) returns error? { string resourcePath = string `/files/permanently_delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -854,7 +854,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - restore response - resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns FileMetadata|error { + resource isolated function post files/restore(RestoreArg payload, RestoreHeaders headers = {}) returns FileMetadata|error { string resourcePath = string `/files/restore`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -867,7 +867,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url response - resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns SaveUrlResult|error { + resource isolated function post files/save_url(SaveUrlArg payload, SaveUrlHeaders headers = {}) returns SaveUrlResult|error { string resourcePath = string `/files/save_url`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -880,7 +880,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url/check_job_status response - resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns CheckJobStatusResponse|error { + resource isolated function post files/save_url/check_job_status(PollArg payload, SaveUrlCheckJobStatusHeaders headers = {}) returns CheckJobStatusResponse|error { string resourcePath = string `/files/save_url/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -893,7 +893,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search/continue response - resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns SearchFilesResponse|error { + resource isolated function post files/search/continue_v2(SearchV2ContinueArg payload, SearchContinueHeaders headers = {}) returns SearchV2Result|error { string resourcePath = string `/files/search/continue_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -906,7 +906,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search response - resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns SearchFilesResponse|error { + resource isolated function post files/search_v2(SearchV2Arg payload, SearchHeaders headers = {}) returns SearchV2Result|error { string resourcePath = string `/files/search_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -919,7 +919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unlock_file_batch response - resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns LockFileBatchResult|error { + resource isolated function post files/unlock_file_batch(UnlockFileBatchArg payload, UnlockFileBatchHeaders headers = {}) returns LockFileBatchResult|error { string resourcePath = string `/files/unlock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -971,7 +971,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload_session/finish_batch response - resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns UploadSessionFinishBatchResult|error { + resource isolated function post files/upload_session/finish_batch(UploadSessionFinishBatchArg payload, UploadSessionFinishBatchHeaders headers = {}) returns UploadSessionFinishBatchResult|error { string resourcePath = string `/files/upload_session/finish_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -980,7 +980,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns UploadSessionFinishBatchResult|error { + resource isolated function post files/upload_session/finish_batch/'check(PollArg payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns UploadSessionFinishBatchResult|error { string resourcePath = string `/files/upload_session/finish_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -993,7 +993,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - add_file_member response - resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns FileMemberActionResult[]|error { + resource isolated function post sharing/add_file_member(AddFileMemberArgs payload, AddFileMemberHeaders headers = {}) returns FileMemberActionResult[]|error { string resourcePath = string `/sharing/add_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1005,7 +1005,7 @@ public isolated client class Client { # add_folder_member # # + headers - Headers to be sent with the request - resource isolated function post sharing/add_folder_member(sharing_add_folder_member_body payload, AddFolderMemberHeaders headers = {}) returns error? { + resource isolated function post sharing/add_folder_member(AddFolderMemberArg payload, AddFolderMemberHeaders headers = {}) returns error? { string resourcePath = string `/sharing/add_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1018,7 +1018,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_job_status response - resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns CheckJobStatusResponse|error { + resource isolated function post sharing/check_job_status(PollArg payload, CheckJobStatusHeaders headers = {}) returns CheckJobStatusResponse|error { string resourcePath = string `/sharing/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1031,7 +1031,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_remove_member_job_status response - resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns GenericResponseWithTag|error { + resource isolated function post sharing/check_remove_member_job_status(PollArg payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/sharing/check_remove_member_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1044,7 +1044,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_share_job_status response - resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns ShareFolderResponse|error { + resource isolated function post sharing/check_share_job_status(PollArg payload, CheckShareJobStatusHeaders headers = {}) returns ShareFolderResponse|error { string resourcePath = string `/sharing/check_share_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1057,7 +1057,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata response - resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns GetFileMetadataResponse|error { + resource isolated function post sharing/get_file_metadata(GetFileMetadataArg payload, GetFileMetadataHeaders headers = {}) returns SharedFileMetadata|error { string resourcePath = string `/sharing/get_file_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1070,7 +1070,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata/batch response - resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns GetFileMetadataIndicidualResult[]|error { + resource isolated function post sharing/get_file_metadata/batch(GetFileMetadataBatchArg payload, GetFileMetadataBatchHeaders headers = {}) returns GetFileMetadataIndividualResult[]|error { string resourcePath = string `/sharing/get_file_metadata/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1083,7 +1083,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_folder_metadata response - resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns SharedFolderMetadata|error { + resource isolated function post sharing/get_folder_metadata(GetMetadataArgs payload, GetFolderMetadataHeaders headers = {}) returns SharedFolderMetadata|error { string resourcePath = string `/sharing/get_folder_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1107,7 +1107,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_shared_link_metadata response - resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns SharedLinkMetadata|error { + resource isolated function post sharing/get_shared_link_metadata(GetSharedLinkMetadataArg payload, GetSharedLinkMetadataHeaders headers = {}) returns SharedLinkMetadata|error { string resourcePath = string `/sharing/get_shared_link_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1120,7 +1120,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members response - resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns SharedFileMembers|error { + resource isolated function post sharing/list_file_members(ListFileMembersArg payload, ListFileMembersHeaders headers = {}) returns SharedFileMembers|error { string resourcePath = string `/sharing/list_file_members`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1129,7 +1129,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns SharedFileMembers|error { + resource isolated function post sharing/list_file_members/'continue(ListFileMembersContinueArg payload, ListFileMembersContinueHeaders headers = {}) returns SharedFileMembers|error { string resourcePath = string `/sharing/list_file_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1142,7 +1142,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members/batch response - resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns ListFileMembersIndividualResult[]|error { + resource isolated function post sharing/list_file_members/batch(ListFileMembersBatchArg payload, ListFileMembersBatchHeaders headers = {}) returns ListFileMembersIndividualResult[]|error { string resourcePath = string `/sharing/list_file_members/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1151,7 +1151,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns SharedFolderMembers|error { + resource isolated function post sharing/list_folder_members/'continue(ListFolderMembersContinueArg payload, ListFolderMembersContinueHeaders headers = {}) returns SharedFolderMembers|error { string resourcePath = string `/sharing/list_folder_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1164,7 +1164,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folders response - resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns ListFoldersResult|error { + resource isolated function post sharing/list_folders(ListFoldersArgs payload, ListFoldersHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1173,7 +1173,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns ListFoldersResult|error { + resource isolated function post sharing/list_folders/'continue(ListFoldersContinueArg payload, ListFoldersContinueHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1186,7 +1186,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_mountable_folders response - resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns ListFoldersResult|error { + resource isolated function post sharing/list_mountable_folders(ListFoldersArgs payload, ListMountableFoldersHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_mountable_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1195,7 +1195,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns ListFoldersResult|error { + resource isolated function post sharing/list_mountable_folders/'continue(ListFoldersContinueArg payload, ListMountableFoldersContinueHeaders headers = {}) returns ListFoldersResult|error { string resourcePath = string `/sharing/list_mountable_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1208,7 +1208,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_received_files response - resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns ListReceivedFilesResponse|error { + resource isolated function post sharing/list_received_files(ListFilesArg payload, ListReceivedFilesHeaders headers = {}) returns ListFilesResult|error { string resourcePath = string `/sharing/list_received_files`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1217,7 +1217,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns ListReceivedFilesResponse|error { + resource isolated function post sharing/list_received_files/'continue(ListFilesContinueArg payload, ListReceivedFilesContinueHeaders headers = {}) returns ListFilesResult|error { string resourcePath = string `/sharing/list_received_files/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1230,7 +1230,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_shared_links response - resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns ListSharedLinksResult|error { + resource isolated function post sharing/list_shared_links(ListSharedLinksArg payload, ListSharedLinksHeaders headers = {}) returns ListSharedLinksResult|error { string resourcePath = string `/sharing/list_shared_links`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1243,7 +1243,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - modify_shared_link_settings response - resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns SharedLinkMetadata|error { + resource isolated function post sharing/modify_shared_link_settings(ModifySharedLinkSettingsArgs payload, ModifySharedLinkSettingsHeaders headers = {}) returns SharedLinkMetadata|error { string resourcePath = string `/sharing/modify_shared_link_settings`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1256,7 +1256,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - mount_folder response - resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns SharedFolderMetadata|error { + resource isolated function post sharing/mount_folder(MountFolderArg payload, MountFolderHeaders headers = {}) returns SharedFolderMetadata|error { string resourcePath = string `/sharing/mount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1268,7 +1268,7 @@ public isolated client class Client { # relinquish_file_membership # # + headers - Headers to be sent with the request - resource isolated function post sharing/relinquish_file_membership(sharing_relinquish_file_membership_body payload, RelinquishFileMembershipHeaders headers = {}) returns error? { + resource isolated function post sharing/relinquish_file_membership(RelinquishFileMembershipArg payload, RelinquishFileMembershipHeaders headers = {}) returns error? { string resourcePath = string `/sharing/relinquish_file_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1281,7 +1281,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - relinquish_folder_membership response - resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns GenericResponseWithTag|error { + resource isolated function post sharing/relinquish_folder_membership(RelinquishFolderMembershipArg payload, RelinquishFolderMembershipHeaders headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/sharing/relinquish_folder_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1294,7 +1294,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_file_member_2 response - resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns CustomQuotaResponse|error { + resource isolated function post sharing/remove_file_member_2(RemoveFileMemberArg payload, RemoveFileMember2Headers headers = {}) returns CustomQuotaResponse|error { string resourcePath = string `/sharing/remove_file_member_2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1307,7 +1307,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_folder_member response - resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns LaunchResultBase|error { + resource isolated function post sharing/remove_folder_member(RemoveFolderMemberArg payload, RemoveFolderMemberHeaders headers = {}) returns LaunchResultBase|error { string resourcePath = string `/sharing/remove_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1319,7 +1319,7 @@ public isolated client class Client { # revoke_shared_link # # + headers - Headers to be sent with the request - resource isolated function post sharing/revoke_shared_link(sharing_revoke_shared_link_body payload, RevokeSharedLinkHeaders headers = {}) returns error? { + resource isolated function post sharing/revoke_shared_link(RevokeSharedLinkArg payload, RevokeSharedLinkHeaders headers = {}) returns error? { string resourcePath = string `/sharing/revoke_shared_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1332,7 +1332,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - set_access_inheritance response - resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns ShareFolderResponse|error { + resource isolated function post sharing/set_access_inheritance(SetAccessInheritanceArg payload, SetAccessInheritanceHeaders headers = {}) returns ShareFolderResponse|error { string resourcePath = string `/sharing/set_access_inheritance`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1345,7 +1345,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - share_folder response - resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns ShareFolderResponse|error { + resource isolated function post sharing/share_folder(ShareFolderArg payload, ShareFolderHeaders headers = {}) returns ShareFolderResponse|error { string resourcePath = string `/sharing/share_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1357,7 +1357,7 @@ public isolated client class Client { # transfer_folder # # + headers - Headers to be sent with the request - resource isolated function post sharing/transfer_folder(sharing_transfer_folder_body payload, TransferFolderHeaders headers = {}) returns error? { + resource isolated function post sharing/transfer_folder(TransferFolderArg payload, TransferFolderHeaders headers = {}) returns error? { string resourcePath = string `/sharing/transfer_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1369,7 +1369,7 @@ public isolated client class Client { # unmount_folder # # + headers - Headers to be sent with the request - resource isolated function post sharing/unmount_folder(sharing_unmount_folder_body payload, UnmountFolderHeaders headers = {}) returns error? { + resource isolated function post sharing/unmount_folder(UnmountFolderArg payload, UnmountFolderHeaders headers = {}) returns error? { string resourcePath = string `/sharing/unmount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1381,7 +1381,7 @@ public isolated client class Client { # unshare_file # # + headers - Headers to be sent with the request - resource isolated function post sharing/unshare_file(UnshareFileRequest payload, UnshareFileHeaders headers = {}) returns error? { + resource isolated function post sharing/unshare_file(UnshareFileArg payload, UnshareFileHeaders headers = {}) returns error? { string resourcePath = string `/sharing/unshare_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1394,7 +1394,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unshare_folder response - resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns GenericResponseWithTag|error { + resource isolated function post sharing/unshare_folder(UnshareFolderArg payload, UnshareFolderHeaders headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/sharing/unshare_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1407,7 +1407,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update_file_member response - resource isolated function post sharing/update_file_member(sharing_update_file_member_body payload, UpdateFileMemberHeaders headers = {}) returns record {}|error { + resource isolated function post sharing/update_file_member(UpdateFileMemberArgs payload, UpdateFileMemberHeaders headers = {}) returns record {}|error { string resourcePath = string `/sharing/update_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1420,7 +1420,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update_folder_member response - resource isolated function post sharing/update_folder_member(sharing_update_folder_member_body payload, UpdateFolderMemberHeaders headers = {}) returns record {}|error { + resource isolated function post sharing/update_folder_member(UpdateFolderMemberArg payload, UpdateFolderMemberHeaders headers = {}) returns record {}|error { string resourcePath = string `/sharing/update_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1433,7 +1433,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update_folder_policy response - resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns SharedFolderMetadata|error { + resource isolated function post sharing/update_folder_policy(UpdateFolderPolicyArg payload, UpdateFolderPolicyHeaders headers = {}) returns SharedFolderMetadata|error { string resourcePath = string `/sharing/update_folder_policy`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1445,7 +1445,7 @@ public isolated client class Client { # devices/list_member_devices # # + headers - Headers to be sent with the request - resource isolated function post team/devices/list_member_devices(devices_list_member_devices_body payload, map headers = {}) returns error? { + resource isolated function post team/devices/list_member_devices(ListMemberDevicesArg payload, map headers = {}) returns error? { string resourcePath = string `/team/devices/list_member_devices`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1466,7 +1466,7 @@ public isolated client class Client { # devices/revoke_device_session # # + headers - Headers to be sent with the request - resource isolated function post team/devices/revoke_device_session(devices_revoke_device_session_body payload, map headers = {}) returns error? { + resource isolated function post team/devices/revoke_device_session(RevokeDeviceSessionArg payload, map headers = {}) returns error? { string resourcePath = string `/team/devices/revoke_device_session`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1477,7 +1477,7 @@ public isolated client class Client { # devices/revoke_device_session_batch # # + headers - Headers to be sent with the request - resource isolated function post team/devices/revoke_device_session_batch(devices_revoke_device_session_batch_body payload, map headers = {}) returns error? { + resource isolated function post team/devices/revoke_device_session_batch(RevokeDeviceSessionBatchArg payload, map headers = {}) returns error? { string resourcePath = string `/team/devices/revoke_device_session_batch`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1489,7 +1489,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns FeaturesGetValuesResponse|error { + resource isolated function post team/features/get_values(FeaturesGetValuesBatchArg payload, map headers = {}) returns FeaturesGetValuesBatchResult|error { string resourcePath = string `/team/features/get_values`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1501,7 +1501,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_info response - resource isolated function post team/get_info(map headers = {}) returns TeamGetInfoResponse|error { + resource isolated function post team/get_info(map headers = {}) returns TeamGetInfoResult|error { string resourcePath = string `/team/get_info`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -1511,7 +1511,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/create response - resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns GroupFullInfo|error { + resource isolated function post team/groups/create(GroupCreateArg payload, map headers = {}) returns GroupFullInfo|error { string resourcePath = string `/team/groups/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1523,7 +1523,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/delete response - resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns GenericResponseWithTag|error { + resource isolated function post team/groups/delete(GroupSelector payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/groups/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1535,7 +1535,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/get_info response - resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns GroupsGetInfoItem[]|error { + resource isolated function post team/groups/get_info(GroupsSelector payload, map headers = {}) returns GroupsGetInfoItem[]|error { string resourcePath = string `/team/groups/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1547,7 +1547,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/job_status/get response - resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns GenericResponseWithTag|error { + resource isolated function post team/groups/job_status/get(PollArg payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/groups/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1559,7 +1559,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/list response - resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns GroupsListResult|error { + resource isolated function post team/groups/list(GroupsListArg payload, map headers = {}) returns GroupsListResult|error { string resourcePath = string `/team/groups/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1567,7 +1567,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns GroupsListResult|error { + resource isolated function post team/groups/list/'continue(GroupsListContinueArg payload, map headers = {}) returns GroupsListResult|error { string resourcePath = string `/team/groups/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1579,7 +1579,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/add response - resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns GroupMembersChangeResult|error { + resource isolated function post team/groups/members/add(GroupMembersAddArg payload, map headers = {}) returns GroupMembersChangeResult|error { string resourcePath = string `/team/groups/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1591,7 +1591,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/list response - resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns MembersListV2Result|error { + resource isolated function post team/groups/members/list(GroupsMembersListArg payload, map headers = {}) returns MembersListV2Result|error { string resourcePath = string `/team/groups/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1599,7 +1599,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns MembersListV2Result|error { + resource isolated function post team/groups/members/list/'continue(GroupsMembersListContinueArg payload, map headers = {}) returns MembersListV2Result|error { string resourcePath = string `/team/groups/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1611,7 +1611,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/remove response - resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns GroupMembersChangeResult|error { + resource isolated function post team/groups/members/remove(GroupMembersRemoveArg payload, map headers = {}) returns GroupMembersChangeResult|error { string resourcePath = string `/team/groups/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1623,7 +1623,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/set_access_type response - resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns GroupsGetInfoItem[]|error { + resource isolated function post team/groups/members/set_access_type(GroupMembersSetAccessTypeArg payload, map headers = {}) returns GroupsGetInfoItem[]|error { string resourcePath = string `/team/groups/members/set_access_type`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1635,7 +1635,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/update response - resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns GroupFullInfo|error { + resource isolated function post team/groups/update(GroupUpdateArgs payload, map headers = {}) returns GroupFullInfo|error { string resourcePath = string `/team/groups/update`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1647,7 +1647,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/create_policy response - resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns LegalHoldPolicy|error { + resource isolated function post team/legal_holds/create_policy(LegalHoldsPolicyCreateArg payload, map headers = {}) returns LegalHoldPolicy|error { string resourcePath = string `/team/legal_holds/create_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1659,7 +1659,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/get_policy response - resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns LegalHoldPolicy|error { + resource isolated function post team/legal_holds/get_policy(LegalHoldsGetPolicyArg payload, map headers = {}) returns LegalHoldPolicy|error { string resourcePath = string `/team/legal_holds/get_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1671,7 +1671,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions response - resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns LegalHoldsListHeldRevisionResult|error { + resource isolated function post team/legal_holds/list_held_revisions(LegalHoldsListHeldRevisionsArg payload, map headers = {}) returns LegalHoldsListHeldRevisionResult|error { string resourcePath = string `/team/legal_holds/list_held_revisions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1683,7 +1683,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions_continue response - resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns LegalHoldsListHeldRevisionResult|error { + resource isolated function post team/legal_holds/list_held_revisions_continue(LegalHoldsListHeldRevisionsContinueArg payload, map headers = {}) returns LegalHoldsListHeldRevisionResult|error { string resourcePath = string `/team/legal_holds/list_held_revisions_continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1695,7 +1695,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_policies response - resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns LegalHoldsListPoliciesResult|error { + resource isolated function post team/legal_holds/list_policies(LegalHoldsListPoliciesArg payload, map headers = {}) returns LegalHoldsListPoliciesResult|error { string resourcePath = string `/team/legal_holds/list_policies`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1706,7 +1706,7 @@ public isolated client class Client { # legal_holds/release_policy # # + headers - Headers to be sent with the request - resource isolated function post team/legal_holds/release_policy(legal_holds_release_policy_body payload, map headers = {}) returns error? { + resource isolated function post team/legal_holds/release_policy(LegalHoldsPolicyReleaseArg payload, map headers = {}) returns error? { string resourcePath = string `/team/legal_holds/release_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1718,7 +1718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/update_policy response - resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns LegalHoldPolicy|error { + resource isolated function post team/legal_holds/update_policy(LegalHoldsPolicyUpdateArg payload, map headers = {}) returns LegalHoldPolicy|error { string resourcePath = string `/team/legal_holds/update_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1729,7 +1729,7 @@ public isolated client class Client { # linked_apps/list_member_linked_apps # # + headers - Headers to be sent with the request - resource isolated function post team/linked_apps/list_member_linked_apps(linked_apps_list_member_linked_apps_body payload, map headers = {}) returns error? { + resource isolated function post team/linked_apps/list_member_linked_apps(ListMemberAppsArg payload, map headers = {}) returns error? { string resourcePath = string `/team/linked_apps/list_member_linked_apps`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1771,7 +1771,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/add response - resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns ExcludedUsersUpdateResult|error { + resource isolated function post team/member_space_limits/excluded_users/add(ExcludedUsersUpdateArg payload, map headers = {}) returns ExcludedUsersUpdateResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1783,7 +1783,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/list response - resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns ExcludedUsersListResult|error { + resource isolated function post team/member_space_limits/excluded_users/list(ExcludedUsersListArg payload, map headers = {}) returns ExcludedUsersListResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1791,7 +1791,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns ExcludedUsersListResult|error { + resource isolated function post team/member_space_limits/excluded_users/list/'continue(ExcludedUsersListContinueArg payload, map headers = {}) returns ExcludedUsersListResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1803,7 +1803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/remove response - resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns ExcludedUsersUpdateResult|error { + resource isolated function post team/member_space_limits/excluded_users/remove(ExcludedUsersUpdateArg payload, map headers = {}) returns ExcludedUsersUpdateResult|error { string resourcePath = string `/team/member_space_limits/excluded_users/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1815,7 +1815,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/get_custom_quota response - resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns CustomQuotaResponse[]|error { + resource isolated function post team/member_space_limits/get_custom_quota(CustomQuotaUsersArg payload, map headers = {}) returns CustomQuotaResponse[]|error { string resourcePath = string `/team/member_space_limits/get_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1827,7 +1827,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/remove_custom_quota response - resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns CustomQuotaResponse[]|error { + resource isolated function post team/member_space_limits/remove_custom_quota(CustomQuotaUsersArg payload, map headers = {}) returns CustomQuotaResponse[]|error { string resourcePath = string `/team/member_space_limits/remove_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1839,7 +1839,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/set_custom_quota response - resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns CustomQuotaResponse[]|error { + resource isolated function post team/member_space_limits/set_custom_quota(SetCustomQuotaArg payload, map headers = {}) returns CustomQuotaResponse[]|error { string resourcePath = string `/team/member_space_limits/set_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1851,7 +1851,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add response - resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns MembersAddResult|error { + resource isolated function post team/members/add(MembersAddV2Arg payload, map headers = {}) returns MembersAddResult|error { string resourcePath = string `/team/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1863,7 +1863,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add/job_status/get response - resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns MembersAddResult|error { + resource isolated function post team/members/add/job_status/get(PollArg payload, map headers = {}) returns MembersAddResult|error { string resourcePath = string `/team/members/add/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1875,7 +1875,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/delete_profile_photo response - resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns TeamMemberInfoV2Result|error { + resource isolated function post team/members/delete_profile_photo(MembersDeleteProfilePhotoArg payload, map headers = {}) returns TeamMemberInfoV2Result|error { string resourcePath = string `/team/members/delete_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1887,7 +1887,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/get_info response - resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns MembersGetInfoItem[]|error { + resource isolated function post team/members/get_info(MembersGetInfoV2Arg payload, map headers = {}) returns MembersGetInfoItem[]|error { string resourcePath = string `/team/members/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1899,7 +1899,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/list response - resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns MembersListResult|error { + resource isolated function post team/members/list(MembersListArg payload, map headers = {}) returns MembersListResult|error { string resourcePath = string `/team/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1907,7 +1907,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns MembersListResult|error { + resource isolated function post team/members/list/'continue(MembersListContinueArg payload, map headers = {}) returns MembersListResult|error { string resourcePath = string `/team/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1919,7 +1919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/move_former_member_files response - resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns GenericResponseWithTag|error { + resource isolated function post team/members/move_former_member_files(MembersDataTransferArg payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/move_former_member_files`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1927,7 +1927,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns GenericResponseWithTag|error { + resource isolated function post team/members/move_former_member_files/job_status/'check(PollArg payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/move_former_member_files/job_status/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1938,7 +1938,7 @@ public isolated client class Client { # members/recover # # + headers - Headers to be sent with the request - resource isolated function post team/members/recover(members_recover_body payload, map headers = {}) returns error? { + resource isolated function post team/members/recover(MembersRecoverArg payload, map headers = {}) returns error? { string resourcePath = string `/team/members/recover`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1950,7 +1950,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove response - resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns GenericResponseWithTag|error { + resource isolated function post team/members/remove(MembersRemoveArg payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1962,7 +1962,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove/job_status/get response - resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns GenericResponseWithTag|error { + resource isolated function post team/members/remove/job_status/get(PollArg payload, map headers = {}) returns GenericResponseWithTag|error { string resourcePath = string `/team/members/remove/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1974,7 +1974,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/add response - resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns AddSecondaryEmailsResult|error { + resource isolated function post team/members/secondary_emails/add(AddSecondaryEmailsArg payload, map headers = {}) returns AddSecondaryEmailsResult|error { string resourcePath = string `/team/members/secondary_emails/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1986,7 +1986,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/delete response - resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns DeleteSecondaryEmailsResult|error { + resource isolated function post team/members/secondary_emails/delete(DeleteSecondaryEmailsArg payload, map headers = {}) returns DeleteSecondaryEmailsResult|error { string resourcePath = string `/team/members/secondary_emails/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1998,7 +1998,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/resend_verification_emails response - resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns ResendVerificationEmailResult|error { + resource isolated function post team/members/secondary_emails/resend_verification_emails(ResendVerificationEmailArg payload, map headers = {}) returns ResendVerificationEmailResult|error { string resourcePath = string `/team/members/secondary_emails/resend_verification_emails`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2009,7 +2009,7 @@ public isolated client class Client { # members/send_welcome_email # # + headers - Headers to be sent with the request - resource isolated function post team/members/send_welcome_email(members_send_welcome_email_body payload, map headers = {}) returns error? { + resource isolated function post team/members/send_welcome_email(UserSelectorArg payload, map headers = {}) returns error? { string resourcePath = string `/team/members/send_welcome_email`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2021,7 +2021,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_admin_permissions response - resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns SetAdminPermissionsResult|error { + resource isolated function post team/members/set_admin_permissions(MembersSetPermissions2Arg payload, map headers = {}) returns MembersSetPermissionsResult|error { string resourcePath = string `/team/members/set_admin_permissions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2033,7 +2033,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile response - resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns TeamMemberInfoV2Result|error { + resource isolated function post team/members/set_profile(MembersSetProfileArg payload, map headers = {}) returns TeamMemberInfoV2Result|error { string resourcePath = string `/team/members/set_profile`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2045,7 +2045,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile_photo response - resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns TeamMemberInfoV2Result|error { + resource isolated function post team/members/set_profile_photo(MembersSetProfilePhotoArg payload, map headers = {}) returns TeamMemberInfoV2Result|error { string resourcePath = string `/team/members/set_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2056,7 +2056,7 @@ public isolated client class Client { # members/suspend # # + headers - Headers to be sent with the request - resource isolated function post team/members/suspend(members_suspend_body payload, map headers = {}) returns error? { + resource isolated function post team/members/suspend(MembersDeactivateArg payload, map headers = {}) returns error? { string resourcePath = string `/team/members/suspend`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2067,7 +2067,7 @@ public isolated client class Client { # members/unsuspend # # + headers - Headers to be sent with the request - resource isolated function post team/members/unsuspend(members_unsuspend_body payload, map headers = {}) returns error? { + resource isolated function post team/members/unsuspend(MembersUnsuspendArg payload, map headers = {}) returns error? { string resourcePath = string `/team/members/unsuspend`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2079,7 +2079,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - namespaces/list response - resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns TeamNamespacesListResult|error { + resource isolated function post team/namespaces/list(TeamNamespacesListArg payload, map headers = {}) returns TeamNamespacesListResult|error { string resourcePath = string `/team/namespaces/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2087,7 +2087,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns TeamNamespacesListResult|error { + resource isolated function post team/namespaces/list/'continue(TeamNamespacesListContinueArg payload, map headers = {}) returns TeamNamespacesListResult|error { string resourcePath = string `/team/namespaces/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2139,7 +2139,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/activate response - resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns TeamFolderMetadata|error { + resource isolated function post team/team_folder/activate(TeamFolderIdArg payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/activate`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2151,7 +2151,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/archive response - resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns TeamFolderArchiveResponse|error { + resource isolated function post team/team_folder/archive(TeamFolderArchiveArg payload, map headers = {}) returns TeamFolderArchiveResponse|error { string resourcePath = string `/team/team_folder/archive`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2159,7 +2159,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns TeamFolderArchiveResponse|error { + resource isolated function post team/team_folder/archive/'check(PollArg payload, map headers = {}) returns TeamFolderArchiveResponse|error { string resourcePath = string `/team/team_folder/archive/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2171,7 +2171,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/create response - resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns TeamFolderMetadata|error { + resource isolated function post team/team_folder/create(TeamFolderCreateArg payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2182,7 +2182,7 @@ public isolated client class Client { # team_folder/get_info # # + headers - Headers to be sent with the request - resource isolated function post team/team_folder/get_info(team_folder_get_info_body payload, map headers = {}) returns error? { + resource isolated function post team/team_folder/get_info(TeamFolderIdListArg payload, map headers = {}) returns error? { string resourcePath = string `/team/team_folder/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2194,7 +2194,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/list response - resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns TeamFolderListResult|error { + resource isolated function post team/team_folder/list(TeamFolderListArg payload, map headers = {}) returns TeamFolderListResult|error { string resourcePath = string `/team/team_folder/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2202,7 +2202,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns TeamFolderListResult|error { + resource isolated function post team/team_folder/list/'continue(TeamFolderListContinueArg payload, map headers = {}) returns TeamFolderListResult|error { string resourcePath = string `/team/team_folder/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2213,7 +2213,7 @@ public isolated client class Client { # team_folder/permanently_delete # # + headers - Headers to be sent with the request - resource isolated function post team/team_folder/permanently_delete(team_folder_permanently_delete_body payload, map headers = {}) returns error? { + resource isolated function post team/team_folder/permanently_delete(TeamFolderIdArg payload, map headers = {}) returns error? { string resourcePath = string `/team/team_folder/permanently_delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2225,7 +2225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/rename response - resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns TeamFolderMetadata|error { + resource isolated function post team/team_folder/rename(TeamFolderRenameArg payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/rename`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2237,7 +2237,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/update_sync_settings response - resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns TeamFolderMetadata|error { + resource isolated function post team/team_folder/update_sync_settings(TeamFolderUpdateSyncSettingsArg payload, map headers = {}) returns TeamFolderMetadata|error { string resourcePath = string `/team/team_folder/update_sync_settings`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2259,7 +2259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_events response - resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns GetTeamEventsResult|error { + resource isolated function post team_log/get_events(GetTeamEventsArg payload, map headers = {}) returns GetTeamEventsResult|error { string resourcePath = string `/team_log/get_events`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2267,7 +2267,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns GetTeamEventsResult|error { + resource isolated function post team_log/get_events/'continue(GetTeamEventsContinueArg payload, map headers = {}) returns GetTeamEventsResult|error { string resourcePath = string `/team_log/get_events/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2279,7 +2279,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns UserFeaturesGetValuesResult|error { + resource isolated function post users/features/get_values(UserFeaturesGetValuesBatchArg payload, FeaturesGetValues1Headers headers = {}) returns UserFeaturesGetValuesResult|error { string resourcePath = string `/users/features/get_values`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2292,7 +2292,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account response - resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns BasicAccount|error { + resource isolated function post users/get_account(GetAccountArg payload, GetAccountHeaders headers = {}) returns BasicAccount|error { string resourcePath = string `/users/get_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2305,7 +2305,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account_batch response - resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns BasicAccount[]|error { + resource isolated function post users/get_account_batch(GetAccountBatchArg payload, GetAccountBatchHeaders headers = {}) returns BasicAccount[]|error { string resourcePath = string `/users/get_account_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2329,7 +2329,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_space_usage response - resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns GetSpaceUsageResponse|error { + resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns SpaceUsage|error { string resourcePath = string `/users/get_space_usage`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; diff --git a/ballerina/types.bal b/ballerina/types.bal index d94711d..afcb7a2 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -19,6 +19,10 @@ import ballerina/http; +public type UnlockFileBatchArg record { + LockFileArg[] entries?; +}; + # Represents the Headers record for the operation: createFolderBatch public type CreateFolderBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -31,8 +35,13 @@ public type PropertyGroup record { string template_id?; }; -public type finish_batch_check_body record { - string async_job_id?; +public type SpaceUsage record { + SpaceAllocation allocation?; + decimal used?; +}; + +public type ListTemplateResult record { + string[] template_ids?; }; # Represents the Headers record for the operation: checkRemoveMemberJobStatus @@ -42,18 +51,25 @@ public type CheckRemoveMemberJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; +public type ListFileRequestsV2Result record { + string cursor?; + FileRequestAsResponse[] file_requests?; + boolean has_more?; +}; + +public type RelocationPath record { + string from_path?; + string to_path?; +}; + # Represents the Headers record for the operation: listContinue public type ListContinueHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type sharinglist_file_membersbatch_result_members_user record { - string account_id?; - string display_name?; - string email?; - boolean same_team?; - string team_member_id?; +public type GroupAccessType record { + string \.tag?; }; public type MembersListV2Result record { @@ -62,16 +78,9 @@ public type MembersListV2Result record { anydata[] members?; }; -public type list_folder_longpoll_body record { - string cursor?; - decimal timeout?; -}; - -public type sharingget_file_metadatabatch_result_policy record { - sharingget_file_metadatabatch_result_policy_acl_update_policy acl_update_policy?; - sharingget_file_metadatabatch_result_policy_member_policy member_policy?; - SharedFolderMemberPolicy resolved_member_policy?; - sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; +public type RemoveFileMemberArg record { + string file?; + MemberSelector member?; }; public type ListSharedLinksResult record { @@ -80,24 +89,17 @@ public type ListSharedLinksResult record { SharedLinkMetadata[] links?; }; -public type groups_create_body record { - boolean add_creator_as_owner?; - string group_external_id?; - string group_name?; -}; - -public type legal_holds_update_policy_body record { - string id?; - string[] members?; -}; - -public type delete_batch_check_body record { - string async_job_id?; +public type MembersGetInfoV2Arg record { + UserSelectorArg[] members?; }; -public type teammemberssecondary_emailsadd_new_secondary_emails record { - string[] secondary_emails?; - teamgroupsmembersadd_user user?; +public type AddFileMemberArgs record { + string access_level?; + boolean add_message_as_comment?; + string custom_message?; + string file?; + MemberSelector[] members?; + boolean quiet?; }; public type GetTeamEventsResult record { @@ -106,10 +108,6 @@ public type GetTeamEventsResult record { boolean has_more?; }; -public type sharingadd_file_member_result record { - string \.tag?; -}; - public type ContentSyncSetting record { string id?; SyncSetting sync_setting?; @@ -123,10 +121,6 @@ public type ListFolderLongpollResult record { boolean changes?; }; -public type member_space_limits_set_custom_quota_body record { - teammember_space_limitsset_custom_quota_users_and_quotas[] users_and_quotas?; -}; - # Represents the Headers record for the operation: moveBatch public type MoveBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -134,40 +128,35 @@ public type MoveBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type PropertyFieldTemplateTypeAsReponse record { - string \.tag?; -}; - -public type sharing_list_folders_body record { - anydata[] actions?; - decimal 'limit?; +public type RevokeDeviceSessionBatchArg record { + RevokeDeviceSessionArg[] revoke_devices?; }; -public type AddTemplateResponse record { - string template_id?; +public type PropertyFieldTemplateTypeAsReponse record { + string \.tag?; }; -public type sharingget_file_metadatabatch_result_owner_team record { - string id?; - string name?; +public type PropertiesSearchQuery record { + string logical_operator?; + PropertiesSearchMode mode?; + string query?; }; -public type job_status_get_body_1 record { - string async_job_id?; +public type GetAccountBatchArg record { + string[] account_ids?; }; -public type sharinglist_file_membersbatch_result_members_group_group_management_type record { - string \.tag?; +public type MembersUnsuspendArg record { + UserSelectorArg user?; }; -public type sharing_remove_folder_member_body record { - boolean leave_a_copy?; - sharingadd_file_member_members member?; - string shared_folder_id?; +public type DeleteFileRequestsResult record { + FileRequestAsResponse[] file_requests?; }; -public type job_status_get_body_2 record { - string async_job_id?; +public type ContentSyncSettingArg record { + string id?; + string sync_setting?; }; public type SaveUrlResult record { @@ -188,11 +177,6 @@ public type SaveUrlResult record { decimal size?; }; -public type files_search_v2_body record { - boolean include_highlights?; - string query?; -}; - # Represents the Headers record for the operation: getSharedLinkFile public type GetSharedLinkFileHeaders record { string? dropbox\-api\-path\-root?; @@ -207,7 +191,11 @@ public type LegalHoldPolicyAsResponse record { MembersInfo members?; string name?; string start_date?; - teamgroupsget_info_profile_status status?; + TeamMemberStatus status?; +}; + +public type ListFilesContinueArg record { + string cursor?; }; # Represents the Headers record for the operation: setProfilePhoto @@ -216,43 +204,36 @@ public type SetProfilePhotoHeaders record { string? dropbox\-api\-select\-user?; }; -public type GetTemplateResponse record { - string description?; - PropertyFieldTemplateAsResponse[] fields?; - string name?; -}; - -public type file_requests_get_body record { - string id?; -}; - public type EmmStateOrOfficeAddinPolicy record { string \.tag?; }; -public type team_folder_permanently_delete_body record { +public type TeamFolderUpdateSyncSettingsArg record { + ContentSyncSettingArg[] content_sync_settings?; + string sync_setting?; string team_folder_id?; }; -public type sharinglist_file_membersbatch_result_members_groups record { - sharinglist_file_membersbatch_result_members_access_type access_type?; - sharinglist_file_membersbatch_result_members_group group?; - boolean is_inherited?; +public type SharedFileMetadataWithTag record { + string \.tag?; + AccessLevel access_type?; + string id?; + string name?; + string[] owner_display_names?; + Team owner_team?; + string path_display?; + string path_lower?; anydata[] permissions?; + FolderPolicy policy?; + string preview_url?; + string time_invited?; }; -public type files_list_folder_body record { - boolean include_deleted?; - boolean include_has_explicit_shared_members?; - boolean include_media_info?; - boolean include_mounted_folders?; - boolean include_non_downloadable_files?; - string path?; - boolean recursive?; -}; - -public type sharing_list_shared_links_body record { - string cursor?; +public type GroupInfos record { + AccessLevel access_type?; + GroupInfo group?; + boolean is_inherited?; + anydata[] permissions?; }; # Represents the Headers record for the operation: propertiesRemove @@ -261,8 +242,8 @@ public type PropertiesRemoveHeaders record { string? dropbox\-api\-select\-user?; }; -public type list_folders_continue_body record { - string cursor?; +public type RevokeSharedLinkArg record { + string url?; }; # Provides settings related to HTTP/1.x protocol. @@ -275,14 +256,13 @@ public type ClientHttp1Settings record {| ProxyConfig proxy?; |}; -public type sharingadd_file_member_members record { - string \.tag?; - string email?; +public type GetFileMetadataArg record { + anydata[] actions?; + string file?; }; -public type teamteam_folderupdate_sync_settings_content_sync_settings record { - string id?; - string sync_setting?; +public type AddSecondaryEmailsArg record { + UserSecondaryEmailsArg[] new_secondary_emails?; }; # Represents the Headers record for the operation: getTemporaryLink @@ -291,16 +271,17 @@ public type GetTemporaryLinkHeaders record { string? dropbox\-api\-select\-user?; }; -public type AddTemplateForTeam record { - string description?; - PropertyFieldTemplate[] fields?; - string name?; +public type ListRevisionsArg record { + decimal 'limit?; + string mode?; + string path?; }; -public type sharing_update_folder_member_body record { - string access_level?; - sharingadd_file_member_members member?; - string shared_folder_id?; +public type ListMemberDevicesArg record { + boolean include_desktop_clients?; + boolean include_mobile_clients?; + boolean include_web_sessions?; + string team_member_id?; }; # Represents the Headers record for the operation: getThumbnailBatch @@ -310,13 +291,8 @@ public type GetThumbnailBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type DeleteManualContactsBatchRequest record { - string[] email_addresses?; -}; - -public type sharingadd_folder_member_members record { - string access_level?; - sharingadd_folder_member_member member?; +public type ListFileMembersContinueArg record { + string cursor?; }; # Represents the Headers record for the operation: listFileMembersContinue @@ -345,23 +321,8 @@ public type GetTemporaryUploadLinkHeaders record { string? dropbox\-api\-select\-user?; }; -public type file_requests_update_body record { - file_requestsupdate_deadline deadline?; - string destination?; - string id?; - boolean open?; - string title?; -}; - -public type secondary_emails_add_body record { - teammemberssecondary_emailsadd_new_secondary_emails[] new_secondary_emails?; -}; - -public type sharing_add_folder_member_body record { - string custom_message?; - sharingadd_folder_member_members[] members?; - boolean quiet?; - string shared_folder_id?; +public type UnshareFileArg record { + string file?; }; # Represents the Headers record for the operation: listMountableFoldersContinue @@ -375,8 +336,15 @@ public type ListFoldersResult record { SharedFolderMetadata[] entries?; }; -public type sharingget_file_metadatabatch_result_policy_acl_update_policy record { - string \.tag?; +public type MoveBatchArg record { + boolean allow_ownership_transfer?; + boolean autorename?; + RelocationPath[] entries?; +}; + +public type PropertiesSearchArg record { + PropertiesSearchQuery[] queries?; + string template_filter?; }; # Represents the Headers record for the operation: permanentlyDelete @@ -387,17 +355,7 @@ public type PermanentlyDeleteHeaders record { }; public type ExcludedUsersUpdateResult record { - sharingadd_file_member_result status?; -}; - -public type get_events_continue_body record { - string cursor?; -}; - -public type sharinglist_file_membersbatch_result_members record { - sharinglist_file_membersbatch_result_members_groups[] groups?; - sharinglist_file_membersbatch_result_members_invitees[] invitees?; - sharinglist_file_membersbatch_result_members_users[] users?; + FileMemberActionIndividualResult status?; }; public type FileRequestAsResponse record { @@ -411,19 +369,15 @@ public type FileRequestAsResponse record { string url?; }; -public type team_folder_list_body record { - decimal 'limit?; -}; - -public type ExportFileResponseMetadata record { - string export_hash?; - string name?; - decimal size?; -}; - -public type teamgroupsget_info_members record { - teamgroupsget_info_access_type access_type?; - teamgroupsget_info_profile profile?; +public type GroupInfo record { + string group_id?; + GroupManagementType group_management_type?; + string group_name?; + GroupManagementType group_type?; + boolean is_member?; + boolean is_owner?; + decimal member_count?; + boolean same_team?; }; public type MetadataV2 record { @@ -437,6 +391,20 @@ public type TeamFolderListResult record { TeamFolderMetadata[] team_folders?; }; +public type TransferFolderArg record { + string shared_folder_id?; + string to_dropbox_id?; +}; + +public type GroupMemberInfo record { + GroupAccessType access_type?; + MemberProfile profile?; +}; + +public type AccessLevel record { + string \.tag?; +}; + public type SharedLinkMetadataLinkPermissions record { boolean can_revoke?; LinkAudience resolved_visibility?; @@ -447,10 +415,6 @@ public type NamespaceType record { string \.tag?; }; -public type list_folder_continue_body record { - string cursor?; -}; - public type TeamLogInfo record { string display_name?; }; @@ -461,21 +425,11 @@ public type ListMountableFoldersHeaders record { string? dropbox\-api\-select\-user?; }; -public type SetAdminPermissionsResult record { - teammembersget_info_role role?; - string team_member_id?; -}; - public type PaperAsFilesValue record { string \.tag?; boolean enabled?; }; -public type sharing_get_file_metadata_body record { - anydata[] actions?; - string file?; -}; - public type FileRequest record { string created?; FileRequestDeadlineWithTag deadline?; @@ -487,8 +441,18 @@ public type FileRequest record { string url?; }; -public type file_requests_delete_body record { - string[] ids?; +public type ExcludedUsersListArg record { + decimal 'limit?; +}; + +public type MembersAddV2Arg record { + boolean force_async?; + MemberAddV2Arg[] new_members?; +}; + +public type MembersSetPermissionsResult record { + AdminTier role?; + string team_member_id?; }; # Represents the Headers record for the operation: listFolders @@ -497,10 +461,10 @@ public type ListFoldersHeaders record { string? dropbox\-api\-select\-user?; }; -public type members_set_profile_body record { - string new_email?; - string new_surname?; - members_send_welcome_email_body user?; +public type GroupCreateArg record { + boolean add_creator_as_owner?; + string group_external_id?; + string group_name?; }; # Represents the Headers record for the operation: transferFolder @@ -510,14 +474,6 @@ public type TransferFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type filesget_file_lock_batch_entries record { - string path?; -}; - -public type files_get_temporary_link_body record { - string path?; -}; - public type ParticipantLogInfo record { string \.tag?; UserLogInfo user?; @@ -541,12 +497,11 @@ public type MetadataAsResponse record { decimal size?; }; -public type GetThumbnailBatchResponse record { - GetThumbnailBatchResultEntry[] entries?; -}; - -public type teamgroupsmembersadd_user record { - string \.tag?; +public type UserInfo record { + string account_id?; + string display_name?; + string email?; + boolean same_team?; string team_member_id?; }; @@ -554,37 +509,10 @@ public type SharedLinkAccessFailureReason record { string \.tag?; }; -public type files_save_url_body record { - string path?; - string url?; -}; - -public type UpdateTemplateForTeamRequest record { - PropertyFieldTemplate[] add_fields?; - string description?; - string name?; +public type RemoveTemplateArg record { string template_id?; }; -public type archive_check_body record { - string async_job_id?; -}; - -public type sharinglist_file_membersbatch_result_members_group record { - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_type?; - boolean is_member?; - boolean is_owner?; - decimal member_count?; - boolean same_team?; -}; - -public type excluded_users_list_body record { - decimal 'limit?; -}; - # Represents the Headers record for the operation: listFoldersContinue public type ListFoldersContinueHeaders record { string? dropbox\-api\-path\-root?; @@ -598,21 +526,10 @@ public type GetCurrentAccountHeaders record { string? dropbox\-api\-select\-user?; }; -public type member_space_limits_remove_custom_quota_body record { - teamgroupsmembersadd_user[] users?; -}; - -public type files_get_thumbnail_batch_body record { - filesget_thumbnail_batch_entries[] entries?; -}; - -public type list_continue_body record { - string cursor?; -}; - -public type sharing_get_folder_metadata_body record { - anydata[] actions?; - string shared_folder_id?; +public type PropertyGroupUpdate record { + PropertyField[] add_or_update_fields?; + anydata[] remove_fields?; + string template_id?; }; # Represents the Headers record for the operation: propertiesUpdate @@ -621,11 +538,6 @@ public type PropertiesUpdateHeaders record { string? dropbox\-api\-select\-user?; }; -public type files_create_folder_v2_body record { - boolean autorename?; - string path?; -}; - # Represents the Headers record for the operation: addFolderMember public type AddFolderMemberHeaders record { string? dropbox\-api\-path\-root?; @@ -642,6 +554,10 @@ public type SyncSetting record { string \.tag?; }; +public type SetCustomQuotaArg record { + UserCustomQuotaArg[] users_and_quotas?; +}; + public type UploadSessionFinishBatchResult record { string \.tag?; UploadSessionFinishBatchResultEntry[] entries?; @@ -660,6 +576,11 @@ public type TeamNamespacesListResult record { NamespaceMetadata[] namespaces?; }; +public type TeamFolderArchiveArg record { + boolean force_async_off?; + string team_folder_id?; +}; + public type SharedLinkCreatePolicy record { string \.tag?; }; @@ -671,9 +592,8 @@ public type CheckJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type members_suspend_body record { - members_send_welcome_email_body user?; - boolean wipe_data?; +public type ListMemberAppsArg record { + string team_member_id?; }; # Represents the Headers record for the operation: propertiesSearch @@ -682,11 +602,10 @@ public type PropertiesSearchHeaders record { string? dropbox\-api\-select\-user?; }; -public type legal_holds_create_policy_body record { - string end_date?; - string[] members?; +public type ExportMetadata record { + string export_hash?; string name?; - string start_date?; + decimal size?; }; # Represents the Headers record for the operation: move @@ -702,21 +621,14 @@ public type TeamMemberPolicies record { TeamSharingPolicies sharing?; }; -public type sharing_relinquish_folder_membership_body record { - boolean leave_a_copy?; - string shared_folder_id?; -}; - -public type GetCopyReferenceResponse record { - string copy_reference?; - string expires?; - MetadataAsResponse metadata?; +public type ResendVerificationEmailArg record { + UserSecondaryEmailsArg[] emails_to_resend?; }; public type LegalHoldHeldRevisionMetadata record { string author_email?; string author_member_id?; - teamgroupsget_info_profile_status author_member_status?; + TeamMemberStatus author_member_status?; string content_hash?; string file_type?; string new_filename?; @@ -731,38 +643,18 @@ public type SessionLogInfo record { string session_id?; }; -public type SearchPropertiesMode record { - string \.tag?; - string field_name?; -}; - # Represents the Headers record for the operation: getAccountBatch public type GetAccountBatchHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type GetTemporaryLinkResponse record { - string link?; - FileMetadata metadata?; -}; - -public type filesget_temporary_upload_link_commit_info record { - boolean autorename?; - string mode?; - boolean mute?; - string path?; - boolean strict_conflict?; -}; - -public type TokenFromOauth1Response record { - string oauth2_token?; +public type ExcludedUsersUpdateArg record { + UserSelectorArg[] users?; }; -public type members_add_body record { - groups_delete_body group?; - teamgroupsmembersadd_members[] members?; - boolean return_members?; +public type FeaturesGetValuesBatchResult record { + FeatureValue[] values?; }; # Represents the Headers record for the operation: deleteBatch @@ -779,13 +671,24 @@ public type UnmountFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type files_get_file_lock_batch_body record { - filesget_file_lock_batch_entries[] entries?; +public type TokenFromOauth1Result record { + string oauth2_token?; }; -public type files_restore_body record { - string path?; - string rev?; +public type AdminTier record { + string \.tag?; +}; + +public type TeamFolderIdListArg record { + string[] team_folder_ids?; +}; + +public type GetFileRequestArgs record { + string id?; +}; + +public type DeleteFileRequestArgs record { + string[] ids?; }; # Represents the Headers record for the operation: propertiesAdd @@ -794,10 +697,6 @@ public type PropertiesAddHeaders record { string? dropbox\-api\-select\-user?; }; -public type CheckAppRequest record { - string query?; -}; - # Represents the Headers record for the operation: copyReferenceGet public type CopyReferenceGetHeaders record { string? dropbox\-api\-path\-root?; @@ -811,10 +710,6 @@ public type RevokeSharedLinkHeaders record { string? dropbox\-api\-select\-user?; }; -public type namespaces_list_body record { - decimal 'limit?; -}; - public type NamespaceMetadata record { string name?; string namespace_id?; @@ -822,6 +717,11 @@ public type NamespaceMetadata record { string team_member_id?; }; +public type UploadSessionCursor record { + decimal offset?; + string session_id?; +}; + # Represents the Headers record for the operation: listReceivedFiles public type ListReceivedFilesHeaders record { string? dropbox\-api\-path\-root?; @@ -829,36 +729,23 @@ public type ListReceivedFilesHeaders record { string? dropbox\-api\-select\-user?; }; -public type groups_update_body record { - groups_delete_body group?; - string new_group_external_id?; - string new_group_management_type?; - string new_group_name?; - boolean return_members?; -}; - public type CustomQuotaResponse record { string \.tag?; }; -public type CreateFolderBatchResponse record { - string \.tag?; - CreateFolderBatchResponseEntry[] entries?; -}; - public type PropertyFieldTemplate record { string description?; string name?; string 'type?; }; -public type team_folder_activate_body record { - string team_folder_id?; +public type GroupsListContinueArg record { + string cursor?; }; -public type members_add_body_1 record { - boolean force_async?; - teammembersadd_new_members[] new_members?; +public type ListFilesResult record { + string cursor?; + SharedFileMetadata[] entries?; }; # Represents the Headers record for the operation: templatesGetForUser @@ -867,31 +754,15 @@ public type TemplatesGetForUserHeaders record { string? dropbox\-api\-select\-user?; }; -public type ExportFileResponse record { - ExportFileResponseMetadata export_metadata?; - FileMetadata file_metadata?; -}; - -public type GetThumbnailResponse record { - FileMetadata file_metadata?; -}; - -public type GetTemporaryUploadLinkResponse record { - string link?; -}; - -public type sharing_list_received_files_body record { - anydata[] actions?; - decimal 'limit?; +public type RevokeDeviceSessionArg record { + string \.tag?; + string session_id?; + string team_member_id?; }; -public type teammembersadd_new_members record { - string member_email?; - string member_external_id?; - string member_given_name?; - string member_surname?; - string role?; - boolean send_welcome_email?; +public type CreateFolderBatchResult record { + string \.tag?; + CreateFolderBatchResultEntry[] entries?; }; public type RootInfo record { @@ -900,8 +771,10 @@ public type RootInfo record { string root_namespace_id?; }; -public type legal_holds_get_policy_body record { - string id?; +public type GetCopyReferenceResult record { + string copy_reference?; + string expires?; + MetadataAsResponse metadata?; }; # Represents the Headers record for the operation: lockFileBatch @@ -910,12 +783,35 @@ public type LockFileBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type TeamFolderListArg record { + decimal 'limit?; +}; + +public type UpdateFileRequestDeadline record { + string \.tag?; + string allow_late_uploads?; + string deadline?; +}; + +public type EchoArg record { + string query?; +}; + # Represents the Headers record for the operation: getFileMetadataBatch public type GetFileMetadataBatchHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type ExportResult record { + ExportMetadata export_metadata?; + FileMetadata file_metadata?; +}; + +public type GetAccountArg record { + string account_id?; +}; + public type EventCategory record { string \.tag?; }; @@ -940,16 +836,10 @@ public type GroupsGetInfoItem record { string \.tag?; decimal created?; string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + GroupManagementType group_management_type?; string group_name?; decimal member_count?; - teamgroupsget_info_members[] members?; -}; - -public type sharingadd_folder_member_member record { - string \.tag?; - string dropbox_id?; - string email?; + GroupMemberInfo[] members?; }; public type TeamSharingPolicies record { @@ -967,14 +857,14 @@ public type TemplatesUpdateForUserHeaders record { public type ShareFolderResponse record { string \.tag?; AccessInheritance access_inheritance?; - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + AclUpdatePolicy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; SharedContentLinkMetadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; + FolderPolicy policy?; string preview_url?; string shared_folder_id?; string time_invited?; @@ -988,49 +878,38 @@ public type AssetLogInfo record { PathLogInfo path?; }; -public type list_mountable_folders_continue_body record { - string cursor?; -}; - public type SharedFileMembers record { - sharinglist_file_membersbatch_result_members_groups[] groups?; - sharinglist_file_membersbatch_result_members_invitees[] invitees?; - sharinglist_file_membersbatch_result_members_users[] users?; + GroupInfos[] groups?; + InviteeMembershipInfo[] invitees?; + UserFileMembershipInfo[] users?; }; -public type OverwritePropertiesRequest record { - string path?; - PropertyGroup[] property_groups?; +public type MemberSelector record { + string \.tag?; + string dropbox_id?; + string email?; }; -public type UserMembershipInfo record { - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inherited?; - anydata[] permissions?; - sharinglist_file_membersbatch_result_members_user user?; +public type AddFolderMemberArg record { + string custom_message?; + AddMember[] members?; + boolean quiet?; + string shared_folder_id?; }; -public type sharinglist_file_membersbatch_result_members_invitees record { - sharingget_file_metadatabatch_result_access_type access_type?; - sharinglist_file_membersbatch_result_members_invitee invitee?; +public type UserMembershipInfo record { + AclUpdatePolicy access_type?; boolean is_inherited?; anydata[] permissions?; -}; - -public type GetTemplateForTeam record { - string template_id?; + UserInfo user?; }; public type ResendVerificationEmailResult record { UserResendResult[] results?; }; -public type member_space_limits_get_custom_quota_body record { - teamgroupsmembersadd_user[] users?; -}; - -public type legal_holds_list_policies_body record { - boolean include_released?; +public type ListFileRequestsContinueArg record { + string cursor?; }; public type UserFeaturesGetValuesResult record { @@ -1043,6 +922,11 @@ public type GetFileLockBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type UserSelectorArg record { + string \.tag?; + string team_member_id?; +}; + # Represents the Headers record for the operation: downloadZip public type DownloadZipHeaders record { string? dropbox\-api\-path\-root?; @@ -1056,22 +940,25 @@ public type RelinquishFolderMembershipHeaders record { string? dropbox\-api\-select\-user?; }; -public type FileRequestCount record { - decimal file_request_count?; +public type LegalHoldsListHeldRevisionsArg record { + string id?; }; -public type FeatureValue record { - string \.tag?; - HasTeamSharedDropboxValue has_team_shared_dropbox?; - UploadApiRateLimitValue upload_api_rate_limit?; +public type PropertiesSearchResult record { + SearchProperties[] matches?; }; -public type teammembersget_info_role record { - string \.tag?; +public type ThumbnailArg record { + string format?; + string mode?; + string path?; + string size?; }; -public type FeaturesGetValuesResponse record { - FeatureValue[] values?; +public type FeatureValue record { + string \.tag?; + HasTeamSharedDropboxValue has_team_shared_dropbox?; + UploadApiRateLimitValue upload_api_rate_limit?; }; public type PropertyField record { @@ -1086,9 +973,9 @@ public type ListFolderLongpollHeaders record { string? dropbox\-api\-select\-user?; }; -public type team_folder_create_body record { - string name?; - string sync_setting?; +public type UnshareFolderArg record { + boolean leave_a_copy?; + string shared_folder_id?; }; # Represents the Headers record for the operation: tokenRevoke @@ -1097,17 +984,8 @@ public type TokenRevokeHeaders record { string? dropbox\-api\-select\-user?; }; -public type members_remove_body_1 record { - boolean keep_account?; - boolean retain_team_shares?; - teamgroupsmembersadd_user transfer_admin_id?; - teamgroupsmembersadd_user transfer_dest_id?; - teamgroupsmembersadd_user user?; - boolean wipe_data?; -}; - -public type secondary_emails_delete_body record { - teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_delete?; +public type PlatformType record { + string \.tag?; }; public type FullAccount record { @@ -1119,7 +997,7 @@ public type FullAccount record { boolean email_verified?; boolean is_paired?; string locale?; - teamgroupsget_info_profile_name name?; + Name name?; string referral_link?; RootInfo root_info?; FullTeam team?; @@ -1130,9 +1008,13 @@ public type EchoResult record { string result?; }; +public type TeamFolderListContinueArg record { + string cursor?; +}; + public type TeamMemberInfoV2Result record { - teammembersget_info_profile profile?; - teammembersget_info_role role?; + TeamMemberProfile profile?; + AdminTier role?; }; # Represents the Headers record for the operation: list @@ -1141,6 +1023,10 @@ public type ListHeaders record { string? dropbox\-api\-select\-user?; }; +public type LegalHoldsListPoliciesArg record { + boolean include_released?; +}; + public type EventType record { string \.tag?; string description?; @@ -1154,6 +1040,11 @@ public type SharedContentLinkMetadata record { string url?; }; +public type ListFolderLongpollArg record { + string cursor?; + decimal timeout?; +}; + # Represents the Headers record for the operation: uploadSessionStart public type UploadSessionStartHeaders record { string? dropbox\-api\-path\-root?; @@ -1162,16 +1053,6 @@ public type UploadSessionStartHeaders record { string? dropbox\-api\-select\-user?; }; -public type SearchPropertiesContinueRequest record { - string cursor?; -}; - -public type members_remove_body record { - groups_delete_body group?; - boolean return_members?; - teamgroupsmembersadd_user[] users?; -}; - # Represents the Headers record for the operation: updateFileMember public type UpdateFileMemberHeaders record { string? dropbox\-api\-path\-root?; @@ -1179,6 +1060,11 @@ public type UpdateFileMemberHeaders record { string? dropbox\-api\-select\-user?; }; +public type CreateFolderBatchResultEntry record { + string \.tag?; + FolderMetadata metadata?; +}; + # Represents the Headers record for the operation: listReceivedFilesContinue public type ListReceivedFilesContinueHeaders record { string? dropbox\-api\-path\-root?; @@ -1198,13 +1084,8 @@ public type TeamEvent record { string timestamp?; }; -public type sharing_add_file_member_body record { - string access_level?; - boolean add_message_as_comment?; - string custom_message?; - string file?; - sharingadd_file_member_members[] members?; - boolean quiet?; +public type GetTemporaryLinkArg record { + string path?; }; # Represents the Headers record for the operation: removeFileMember2 @@ -1218,18 +1099,17 @@ public type AccessInheritance record { string \.tag?; }; -public type move_batch_check_v2_body record { - string async_job_id?; +public type TeamNamespacesListContinueArg record { + string cursor?; }; -public type sharing_modify_shared_link_settings_body record { - boolean remove_expiration?; - sharingmodify_shared_link_settings_settings settings?; - string url?; +public type GetTeamEventsContinueArg record { + string cursor?; }; -public type teamfeaturesget_values_features record { - string \.tag?; +public type ListFilesArg record { + anydata[] actions?; + decimal 'limit?; }; # Represents the Headers record for the operation: updateFolderPolicy @@ -1254,107 +1134,77 @@ public type LaunchResultBase record { string async_job_id?; }; -public type GetTemplateForUserRequest record { - string template_id?; -}; - -public type sharing_update_folder_policy_body record { - string acl_update_policy?; - string member_policy?; - string shared_folder_id?; - string shared_link_policy?; -}; - # Represents the Headers record for the operation: modifySharedLinkSettings public type ModifySharedLinkSettingsHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type sharing_list_file_members_body record { - string file?; - boolean include_inherited?; - decimal 'limit?; -}; - # Represents the Headers record for the operation: saveUrl public type SaveUrlHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type sharing_update_file_member_body record { - string access_level?; - string file?; - sharingadd_file_member_members member?; -}; - public type MemberAddResult record { string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; -}; - -public type teamgroupsget_info_profile_secondary_emails record { - string email?; - boolean is_verified?; + TeamMemberProfile profile?; + AdminTier role?; }; public type SharedFolderMetadata record { AccessInheritance access_inheritance?; - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + AclUpdatePolicy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; SharedContentLinkMetadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; + FolderPolicy policy?; string preview_url?; string shared_folder_id?; string time_invited?; }; -public type UnshareFileRequest record { - string file?; +public type UploadSessionFinishArg record { + CommitInfo 'commit?; + UploadSessionCursor cursor?; }; -public type CreateFileRequestRequest record { - FileRequestDeadline deadline?; - string destination?; - boolean open?; - string title?; +public type CopyBatchResponseEntries record { + string \.tag?; + MetadataAsResponse success?; }; -public type files_copy_batch_v2_body record { - boolean autorename?; - filescopy_batch_v2_entries[] entries?; +public type GroupMembersAddArg record { + GroupSelector group?; + MemberAccess[] members?; + boolean return_members?; }; -public type CopyBatchResponseEntries record { - string \.tag?; - MetadataAsResponse success?; +public type TokenFromOauth1Arg record { + string oauth1_token?; + string oauth1_token_secret?; }; -public type members_set_profile_photo_body record { - Photo photo?; - members_send_welcome_email_body user?; +public type GetFileMetadataIndividualResult record { + string file?; + SharedFileMetadataWithTag result?; +}; + +public type TeamMembershipType record { + string \.tag?; }; -public type members_recover_body record { - teamgroupsmembersadd_user user?; +public type LegalHoldsPolicyReleaseArg record { + string id?; }; public type TeamMemberInfo record { string display_name?; string member_id?; - sharingget_file_metadatabatch_result_owner_team team_info?; -}; - -public type files_list_revisions_body record { - decimal 'limit?; - string mode?; - string path?; + Team team_info?; }; # Represents the Headers record for the operation: user @@ -1369,9 +1219,8 @@ public type FileLockInfo record { string lockholder_name?; }; -public type teammembersget_info_profile_secondary_emails record { - string email?; - boolean is_verified?; +public type GetTemporaryUploadLinkResult record { + string link?; }; # Represents the Headers record for the operation: createFolder @@ -1386,29 +1235,98 @@ public type MembersAddResult record { MemberAddResult[] complete?; }; -public type AddTemplateForUser record { - string description?; - PropertyFieldTemplate[] fields?; - string name?; -}; - public type ListRevisionsResult record { FileMetadata[] entries?; boolean is_deleted?; }; +public type GetTemporaryUploadLinkArg record { + CommitInfo commit_info?; + decimal duration?; +}; + +public type PropertiesSearchMode record { + string \.tag?; + string field_name?; +}; + +public type GroupUpdateArgs record { + GroupSelector group?; + string new_group_external_id?; + string new_group_management_type?; + string new_group_name?; + boolean return_members?; +}; + +public type RelocationArg record { + boolean allow_ownership_transfer?; + boolean allow_shared_folder?; + boolean autorename?; + string from_path?; + string to_path?; +}; + +public type TeamMemberProfile record { + string account_id?; + string email?; + boolean email_verified?; + string external_id?; + string[] groups?; + string joined_on?; + string member_folder_id?; + TeamMembershipType membership_type?; + Name name?; + string profile_photo_url?; + SecondaryEmail[] secondary_emails?; + TeamMemberStatus status?; + string team_member_id?; +}; + +public type RestoreArg record { + string path?; + string rev?; +}; + public type GroupsListResult record { string cursor?; GroupSummary[] groups?; boolean has_more?; }; +public type ListFolderResult record { + string cursor?; + Metadata[] entries?; + boolean has_more?; +}; + +public type ListFoldersArgs record { + anydata[] actions?; + decimal 'limit?; +}; + +public type GroupsMembersListArg record { + GroupSelector group?; + decimal 'limit?; +}; + # Represents the Headers record for the operation: deleteManualContacts public type DeleteManualContactsHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type CommitInfo record { + boolean autorename?; + string mode?; + boolean mute?; + string path?; + boolean strict_conflict?; +}; + +public type MemberPolicy record { + string \.tag?; +}; + public type SharedLinkMetadata record { string \.tag?; string client_modified?; @@ -1423,6 +1341,10 @@ public type SharedLinkMetadata record { string url?; }; +public type GetThumbnailBatchArg record { + ThumbnailArg[] entries?; +}; + # Represents the Headers record for the operation: count public type CountHeaders record { string? dropbox\-api\-path\-root?; @@ -1435,30 +1357,27 @@ public type SearchHeaders record { string? dropbox\-api\-select\-user?; }; -public type DeleteBatchResponse record { +public type SharedFolderJoinPolicy record { string \.tag?; - DeleteBatchResultEntry[] entries?; }; -public type SharedFolderJoinPolicy record { - string \.tag?; +public type CreateFolderArg record { + boolean autorename?; + string path?; }; -public type TokenFromOauth1Request record { - string oauth1_token?; - string oauth1_token_secret?; +public type RemovePropertiesArg record { + string path?; + string[] property_template_ids?; }; -public type sharing_check_remove_member_job_status_body record { - string async_job_id?; +public type UserFeaturesGetValuesBatchArg record { + UserFeature[] features?; }; -public type files_move_v2_body record { - boolean allow_ownership_transfer?; - boolean allow_shared_folder?; - boolean autorename?; - string from_path?; - string to_path?; +public type SetAccessInheritanceArg record { + string access_inheritance?; + string shared_folder_id?; }; # Represents the Headers record for the operation: delete @@ -1467,32 +1386,19 @@ public type DeleteHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharingget_file_metadatabatch_result record { +public type AccountType record { string \.tag?; - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; }; -public type SearchPropertiesResponse record { - SearchProperties[] matches?; -}; - -public type AccountType record { - string \.tag?; +public type InviteeMembershipInfo record { + AccessLevel access_type?; + InviteeInfo invitee?; + boolean is_inherited?; + anydata[] permissions?; }; -public type GetFileMetadataIndicidualResult record { - string file?; - sharingget_file_metadatabatch_result result?; +public type GetTemplateArg record { + string template_id?; }; # Represents the Headers record for the operation: unshareFolder @@ -1502,11 +1408,27 @@ public type UnshareFolderHeaders record { string? dropbox\-api\-select\-user?; }; +public type CustomQuotaUsersArg record { + UserSelectorArg[] users?; +}; + +public type DeleteSecondaryEmailsArg record { + UserSecondaryEmailsArg[] emails_to_delete?; +}; + public type SpaceAllocation record { string \.tag?; decimal allocated?; }; +public type UpdateFileRequestArgs record { + UpdateFileRequestDeadline deadline?; + string destination?; + string id?; + boolean open?; + string title?; +}; + # Represents the Headers record for the operation: listFileMembers public type ListFileMembersHeaders record { string? dropbox\-api\-path\-root?; @@ -1514,30 +1436,12 @@ public type ListFileMembersHeaders record { string? dropbox\-api\-select\-user?; }; -public type teamgroupsget_info_profile_membership_type record { - string \.tag?; -}; - -public type teamgroupsget_info_access_type record { - string \.tag?; -}; - -public type filesupload_sessionfinish_batch_entries record { - filesget_temporary_upload_link_commit_info 'commit?; - filesupload_sessionfinish_batch_cursor cursor?; -}; - -public type groups_delete_body record { +public type AclUpdatePolicy record { string \.tag?; - string group_id?; }; -public type members_get_info_body record { - teamgroupsmembersadd_user[] members?; -}; - -public type secondary_emails_resend_verification_emails_body record { - teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_resend?; +public type SetProfilePhotoResult record { + string profile_photo_url?; }; public type PropertyFieldTemplateAsResponse record { @@ -1560,8 +1464,8 @@ public type DeleteBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharing_check_job_status_body record { - string async_job_id?; +public type RelinquishFileMembershipArg record { + string file?; }; # Represents the Headers record for the operation: getSpaceUsage @@ -1570,12 +1474,6 @@ public type GetSpaceUsageHeaders record { string? dropbox\-api\-select\-user?; }; -public type team_folder_update_sync_settings_body record { - teamteam_folderupdate_sync_settings_content_sync_settings[] content_sync_settings?; - string sync_setting?; - string team_folder_id?; -}; - # Represents the Headers record for the operation: shareFolder public type ShareFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -1583,27 +1481,26 @@ public type ShareFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type DeleteFileRequestsResponse record { - FileRequestAsResponse[] file_requests?; +public type Feature record { + string \.tag?; +}; + +public type GroupsListArg record { + decimal 'limit?; }; public type GroupFullInfo record { decimal created?; string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + GroupManagementType group_management_type?; string group_name?; decimal member_count?; - teamgroupsget_info_members[] members?; + GroupMemberInfo[] members?; }; -public type legal_holds_list_held_revisions_body record { - string id?; -}; - -public type files_create_folder_batch_body record { - boolean autorename?; - boolean force_async?; - string[] paths?; +public type AddMember record { + string access_level?; + MemberSelector member?; }; # Represents the Headers record for the operation: setAccessInheritance @@ -1612,19 +1509,16 @@ public type SetAccessInheritanceHeaders record { string? dropbox\-api\-select\-user?; }; -public type files_lock_file_batch_body record { - filesget_file_lock_batch_entries[] entries?; -}; - -public type groups_get_info_body record { - string \.tag?; - string[] group_ids?; +public type ListFileMembersArg record { + string file?; + boolean include_inherited?; + decimal 'limit?; }; public type MembersGetInfoItem record { string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; + TeamMemberProfile profile?; + AdminTier role?; }; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. @@ -1671,6 +1565,19 @@ public type CheckJobStatusResponse record { string \.tag?; }; +public type ListFileMembersBatchArg record { + string[] files?; + decimal 'limit?; +}; + +public type MembersRecoverArg record { + UserSelectorArg user?; +}; + +public type ExcludedUsersListContinueArg record { + string cursor?; +}; + # Represents the Headers record for the operation: create public type CreateHeaders record { string? dropbox\-api\-path\-root?; @@ -1684,20 +1591,31 @@ public type Delete1Headers record { string? dropbox\-api\-select\-user?; }; -public type files_get_metadata_body record { - boolean include_deleted?; - boolean include_has_explicit_shared_members?; - boolean include_media_info?; +public type MountFolderArg record { + string shared_folder_id?; +}; + +public type FeaturesGetValuesBatchArg record { + Feature[] features?; +}; + +public type ShareFolderArg record { + string access_inheritance?; + string acl_update_policy?; + boolean force_async?; + string member_policy?; string path?; + string shared_link_policy?; }; -public type files_get_temporary_upload_link_body record { - filesget_temporary_upload_link_commit_info commit_info?; - decimal duration?; +public type MembersDataTransferArg record { + UserSelectorArg transfer_admin_id?; + UserSelectorArg transfer_dest_id?; + UserSelectorArg user?; }; -public type members_delete_profile_photo_body record { - teamgroupsmembersadd_user user?; +public type LegalHoldsGetPolicyArg record { + string id?; }; # Represents the Headers record for the operation: upload @@ -1708,11 +1626,6 @@ public type UploadHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharing_get_shared_link_metadata_body record { - string path?; - string url?; -}; - # Represents the Headers record for the operation: download public type DownloadHeaders record { string? dropbox\-api\-path\-root?; @@ -1726,17 +1639,32 @@ public type FileRequestDeadlineWithTag record { string deadline?; }; -public type file_requestsupdate_deadline record { - string \.tag?; - string allow_late_uploads?; - string deadline?; +public type DeleteManualContactsArg record { + string[] email_addresses?; +}; + +public type GetMetadataArg record { + boolean include_deleted?; + boolean include_has_explicit_shared_members?; + boolean include_media_info?; + string path?; +}; + +public type ListFolderArg record { + boolean include_deleted?; + boolean include_has_explicit_shared_members?; + boolean include_media_info?; + boolean include_mounted_folders?; + boolean include_non_downloadable_files?; + string path?; + boolean recursive?; }; public type UserAddResult record { string \.tag?; - members_send_welcome_email_body invalid_user?; + UserSelectorArg invalid_user?; AddSecondaryEmailResult[] results?; - members_send_welcome_email_body user?; + UserSelectorArg user?; }; public type Metadata record { @@ -1757,15 +1685,6 @@ public type Metadata record { decimal size?; }; -public type AddPropertiesRequest record { - string path?; - PropertyGroup[] property_groups?; -}; - -public type sharing_revoke_shared_link_body record { - string url?; -}; - # Represents the Headers record for the operation: unshareFile public type UnshareFileHeaders record { string? dropbox\-api\-path\-root?; @@ -1779,23 +1698,15 @@ public type DeleteSecondaryEmailResult record { string success?; }; -public type files_permanently_delete_body record { - string path?; -}; - public type TeamFolderMetadata record { ContentSyncSetting[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; - teamgroupsget_info_profile_status status?; + TeamMemberStatus status?; SyncSetting sync_setting?; string team_folder_id?; }; -public type list_folder_members_continue_body record { - string cursor?; -}; - # Represents the Headers record for the operation: checkShareJobStatus public type CheckShareJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -1803,17 +1714,14 @@ public type CheckShareJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type team_log_get_events_body record { - string category?; - decimal 'limit?; +public type UserSecondaryEmailsArg record { + string[] secondary_emails?; + UserSelectorArg user?; }; -public type TeamGetInfoResponse record { +public type Team record { + string id?; string name?; - decimal num_licensed_users?; - decimal num_provisioned_users?; - TeamMemberPolicies policies?; - string team_id?; }; public type ExcludedUsersListResult record { @@ -1822,8 +1730,9 @@ public type ExcludedUsersListResult record { anydata[] users?; }; -public type sharingget_file_metadatabatch_result_policy_member_policy record { - string \.tag?; +public type TeamFolderCreateArg record { + string name?; + string sync_setting?; }; public type SearchProperties record { @@ -1843,9 +1752,12 @@ public type UserLogInfo record { string team_member_id?; }; -public type members_send_welcome_email_body record { - string \.tag?; - string team_member_id?; +public type TeamGetInfoResult record { + string name?; + decimal num_licensed_users?; + decimal num_provisioned_users?; + TeamMemberPolicies policies?; + string team_id?; }; public type ResendSecondaryEmailResult record { @@ -1853,40 +1765,50 @@ public type ResendSecondaryEmailResult record { string success?; }; -public type GetFileMetadataResponse record { - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; +public type AddTemplateResult record { + string template_id?; }; -public type SearchFilesResponse record { - boolean has_more?; - SearchMatch[] matches?; +public type ListFolderMembersContinueArg record { + string cursor?; +}; + +public type UpdatePropertiesArg record { + string path?; + PropertyGroupUpdate[] update_property_groups?; +}; + +public type MemberAddV2Arg record { + string member_email?; + string member_external_id?; + string member_given_name?; + string member_surname?; + string role?; + boolean send_welcome_email?; +}; + +public type MetadataResult record { + MetadataAsResponse metadata?; +}; + +public type PollArg record { + string async_job_id?; }; public type GroupSummary record { string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + GroupManagementType group_management_type?; string group_name?; decimal member_count?; }; public type TokenGetAuthenticatedAdminResult record { - teammembersget_info_profile admin_profile?; + TeamMemberProfile admin_profile?; }; -public type ListFolderResponse record { - string cursor?; - Metadata[] entries?; - boolean has_more?; +public type GetTemporaryLinkResult record { + string link?; + FileMetadata metadata?; }; # Represents the Headers record for the operation: tokenFromOauth1 @@ -1895,24 +1817,14 @@ public type TokenFromOauth1Headers record { string? dropbox\-api\-select\-user?; }; -public type SearchPropertiesRequest record { - SearchPropertiesQuery[] queries?; - string template_filter?; -}; - public type GetThumbnailBatchResultEntry record { string \.tag?; FileMetadata metadata?; string thumbnail?; }; -public type file_requests_list_v2_body record { - decimal 'limit?; -}; - -public type RelocationBatchV2Response record { - string \.tag?; - CopyBatchResponseEntries[] entries?; +public type SearchV2ContinueArg record { + string cursor?; }; # Represents the Headers record for the operation: propertiesSearchContinue @@ -1921,10 +1833,6 @@ public type PropertiesSearchContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type members_unsuspend_body record { - members_send_welcome_email_body user?; -}; - public type Photo record { string \.tag?; string base64_data?; @@ -1938,8 +1846,12 @@ public type ExportHeaders record { string? dropbox\-api\-select\-user?; }; -public type users_get_account_body record { - string account_id?; +public type Name record { + string abbreviated_name?; + string display_name?; + string familiar_name?; + string given_name?; + string surname?; }; # Represents the Headers record for the operation: searchContinue @@ -1948,11 +1860,6 @@ public type SearchContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type CreateFolderBatchResponseEntry record { - string \.tag?; - FolderMetadata metadata?; -}; - public type SharedFolderMemberPolicy record { string \.tag?; }; @@ -1962,6 +1869,10 @@ public type UploadApiRateLimitValue record { decimal 'limit?; }; +public type GetCopyReferenceArg record { + string path?; +}; + # Represents the Headers record for the operation: getFileMetadata public type GetFileMetadataHeaders record { string? dropbox\-api\-path\-root?; @@ -1972,16 +1883,13 @@ public type GetFileMetadataHeaders record { public type UserResendResult record { string \.tag?; ResendSecondaryEmailResult[] results?; - members_send_welcome_email_body user?; + UserSelectorArg user?; }; -public type teammember_space_limitsset_custom_quota_users_and_quotas record { - decimal quota_gb?; - teamgroupsmembersadd_user user?; -}; - -public type team_folder_get_info_body record { - string[] team_folder_ids?; +public type ListFileMembersCountResult record { + string \.tag?; + decimal member_count?; + SharedFileMembers members?; }; public type BasicAccount record { @@ -1990,10 +1898,21 @@ public type BasicAccount record { string email?; boolean email_verified?; boolean is_teammate?; - teamgroupsget_info_profile_name name?; + Name name?; string profile_photo_url?; }; +public type DeleteArg record { + string path?; +}; + +public type UpdateTemplateArg record { + PropertyFieldTemplate[] add_fields?; + string description?; + string name?; + string template_id?; +}; + public type FullTeam record { string id?; string name?; @@ -2008,31 +1927,27 @@ public type GetMetadataHeaders record { string? dropbox\-api\-select\-user?; }; -public type team_folder_rename_body record { - string name?; - string team_folder_id?; -}; - public type OriginLogInfo record { AccessMethodLogInfo access_method?; GeoLocationLogInfo geo_location?; }; -public type sharing_list_mountable_folders_body record { - anydata[] actions?; - decimal 'limit?; +public type GroupMembersRemoveArg record { + GroupSelector group?; + boolean return_members?; + UserSelectorArg[] users?; }; public type SharedFileMetadata record { - sharingget_file_metadatabatch_result_access_type access_type?; + AccessLevel access_type?; string id?; string name?; string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; + Team owner_team?; string path_display?; string path_lower?; anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; + FolderPolicy policy?; string preview_url?; string time_invited?; }; @@ -2044,13 +1959,8 @@ public type EventDetails record { UserLogInfo shared_content_owner?; }; -public type copy_reference_get_body record { - string path?; -}; - -public type GetSpaceUsageResponse record { - SpaceAllocation allocation?; - decimal used?; +public type TeamMemberStatus record { + string \.tag?; }; public type MembersListResult record { @@ -2059,8 +1969,8 @@ public type MembersListResult record { TeamMemberInfoV2Result[] members?; }; -public type save_url_check_job_status_body record { - string async_job_id?; +public type LegalHoldsListHeldRevisionsContinueArg record { + string id?; }; public type HasTeamSharedDropboxValue record { @@ -2068,29 +1978,24 @@ public type HasTeamSharedDropboxValue record { boolean has_team_shared_dropbox?; }; -public type list_folder_get_latest_cursor_body record { - boolean include_deleted?; - boolean include_has_explicit_shared_members?; - boolean include_media_info?; - boolean include_mounted_folders?; - boolean include_non_downloadable_files?; - string path?; - boolean recursive?; +public type LegalHoldsPolicyCreateArg record { + string end_date?; + string[] members?; + string name?; + string start_date?; }; -public type sharinglist_file_membersbatch_result_members_users record { - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inherited?; - anydata[] permissions?; - sharinglist_file_membersbatch_result_members_platform_type platform_type?; - string time_last_seen?; - sharinglist_file_membersbatch_result_members_user user?; +public type GetFileMetadataBatchArg record { + anydata[] actions?; + string[] files?; }; -public type SearchPropertiesQuery record { - string logical_operator?; - SearchPropertiesMode mode?; - string query?; +public type ListFolderContinueArg record { + string cursor?; +}; + +public type TeamNamespacesListArg record { + decimal 'limit?; }; public type TeamFolderArchiveResponse record { @@ -2098,15 +2003,11 @@ public type TeamFolderArchiveResponse record { ContentSyncSetting[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; - teamgroupsget_info_profile_status status?; + TeamMemberStatus status?; SyncSetting sync_setting?; string team_folder_id?; }; -public type job_status_get_body record { - string async_job_id?; -}; - # Represents the Headers record for the operation: restore public type RestoreHeaders record { string? dropbox\-api\-path\-root?; @@ -2114,26 +2015,27 @@ public type RestoreHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharinglist_file_membersbatch_result record { - string \.tag?; - decimal member_count?; - sharinglist_file_membersbatch_result_members members?; +public type UpdateFileMemberArgs record { + string access_level?; + string file?; + MemberSelector member?; }; -public type UpdatePropertiesRequest record { - string path?; - PropertyGroupsUpdate[] update_property_groups?; +public type UserCustomQuotaArg record { + decimal quota_gb?; + UserSelectorArg user?; }; -public type sharinglist_file_membersbatch_result_members_access_type record { +public type GroupsSelector record { string \.tag?; + string[] group_ids?; }; -public type groups_list_body record { - decimal 'limit?; +public type PropertiesSearchContinueArg record { + string cursor?; }; -public type members_list_body_1 record { +public type MembersListArg record { boolean include_removed?; decimal 'limit?; }; @@ -2154,11 +2056,9 @@ public type DeleteAllClosedHeaders record { string? dropbox\-api\-select\-user?; }; -public type members_set_access_type_body record { - string access_type?; - groups_delete_body group?; - boolean return_members?; - teamgroupsmembersadd_user user?; +public type SearchV2Result record { + boolean has_more?; + SearchMatch[] matches?; }; public type LinkPermission record { @@ -2166,26 +2066,15 @@ public type LinkPermission record { boolean allow?; }; -public type users_get_account_batch_body record { - string[] account_ids?; -}; - -public type SetProfilePhotoResponse record { - string profile_photo_url?; -}; - -public type legal_holds_release_policy_body record { - string id?; -}; - -public type members_move_former_member_files_body record { - teamgroupsmembersadd_user transfer_admin_id?; - teamgroupsmembersadd_user transfer_dest_id?; - teamgroupsmembersadd_user user?; +public type RelocationBatchArgBase record { + boolean autorename?; + RelocationPath[] entries?; }; -public type DeleteFilesBatchRequest record { - FilePath[] entries?; +public type RemoveFolderMemberArg record { + boolean leave_a_copy?; + MemberSelector member?; + string shared_folder_id?; }; public type UploadSessionFinishBatchResultEntry record { @@ -2206,15 +2095,25 @@ public type UploadSessionFinishBatchResultEntry record { decimal size?; }; +public type LockFileArg record { + string path?; +}; + +public type AddTemplateArg record { + string description?; + PropertyFieldTemplate[] fields?; + string name?; +}; + public type UserDeleteResult record { string \.tag?; DeleteSecondaryEmailResult[] results?; - members_send_welcome_email_body user?; + UserSelectorArg user?; }; public type AddSecondaryEmailResult record { string \.tag?; - teamgroupsget_info_profile_secondary_emails success?; + SecondaryEmail success?; string unavailable?; }; @@ -2222,81 +2121,32 @@ public type LockFileBatchResult record { LockFileResultEntry[] entries?; }; -public type sharing_unmount_folder_body record { - string shared_folder_id?; -}; - -public type UpdateTemplateForUserRequest record { - PropertyFieldTemplate[] add_fields?; - string description?; - string name?; - string template_id?; -}; - # Represents the Headers record for the operation: templatesAddForUser public type TemplatesAddForUserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type sharing_set_access_inheritance_body record { - string access_inheritance?; - string shared_folder_id?; -}; - -public type members_list_body record { - groups_delete_body group?; - decimal 'limit?; -}; - -public type sharing_remove_file_member_2_body record { - string file?; - sharingadd_file_member_members member?; -}; - -public type teammembersget_info_profile record { - string account_id?; - string email?; - boolean email_verified?; - string external_id?; - string[] groups?; - string joined_on?; - string member_folder_id?; - teamgroupsget_info_profile_membership_type membership_type?; - teamgroupsget_info_profile_name name?; - string profile_photo_url?; - teammembersget_info_profile_secondary_emails[] secondary_emails?; - teamgroupsget_info_profile_status status?; - string team_member_id?; +public type GroupMembersSetAccessTypeArg record { + string access_type?; + GroupSelector group?; + boolean return_members?; + UserSelectorArg user?; }; -public type SetProfilePhotoRequest record { - Photo photo?; +public type RelocationBatchV2Result record { + string \.tag?; + CopyBatchResponseEntries[] entries?; }; -public type list_file_members_batch_body record { - string[] files?; +public type ListFileRequestsArg record { decimal 'limit?; }; -public type features_get_values_body_1 record { - usersfeaturesget_values_features[] features?; -}; - -public type PropertyGroupsUpdate record { - PropertyField[] add_or_update_fields?; - anydata[] remove_fields?; - string template_id?; -}; - public type FileLock record { FileLockContent content?; }; -public type RemoveTemplateForTeamRequest record { - string template_id?; -}; - # Represents the Headers record for the operation: listRevisions public type ListRevisionsHeaders record { string? dropbox\-api\-path\-root?; @@ -2304,18 +2154,17 @@ public type ListRevisionsHeaders record { string? dropbox\-api\-select\-user?; }; -public type excluded_users_add_body record { - teamgroupsmembersadd_user[] users?; +public type InviteeInfo record { + string \.tag?; + string email?; }; -public type filesupload_sessionfinish_batch_cursor record { - decimal offset?; - string session_id?; +public type ListFoldersContinueArg record { + string cursor?; }; -public type copy_reference_save_body record { - string copy_reference?; - string path?; +public type PreviewResult record { + FileMetadata file_metadata?; }; # Represents the Headers record for the operation: listFolder @@ -2349,8 +2198,9 @@ public type ListFileMembersBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type search_continue_v2_body record { - string cursor?; +public type GetMetadataArgs record { + anydata[] actions?; + string shared_folder_id?; }; # Represents the Headers record for the operation: addFileMember @@ -2360,44 +2210,49 @@ public type AddFileMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type teamgroupsget_info_profile_name record { - string abbreviated_name?; - string display_name?; - string familiar_name?; - string given_name?; - string surname?; -}; - -public type teamgroupsget_info_profile record { - string account_id?; - string email?; - boolean email_verified?; - string joined_on?; - teamgroupsget_info_profile_membership_type membership_type?; - teamgroupsget_info_profile_name name?; - string profile_photo_url?; - teamgroupsget_info_profile_secondary_emails[] secondary_emails?; - teamgroupsget_info_profile_status status?; - string team_member_id?; -}; - +public type RelinquishFolderMembershipArg record { + boolean leave_a_copy?; + string shared_folder_id?; +}; + # Represents the Headers record for the operation: templatesRemoveForUser public type TemplatesRemoveForUserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type TeamFolderRenameArg record { + string name?; + string team_folder_id?; +}; + # Represents the Headers record for the operation: listSharedLinks public type ListSharedLinksHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type team_folder_archive_body record { - boolean force_async_off?; +public type GroupManagementType record { + string \.tag?; +}; + +public type TeamFolderIdArg record { string team_folder_id?; }; +public type UserFileMembershipInfo record { + AclUpdatePolicy access_type?; + boolean is_inherited?; + anydata[] permissions?; + PlatformType platform_type?; + string time_last_seen?; + UserInfo user?; +}; + +public type CountFileRequestsResult record { + decimal file_request_count?; +}; + public type FileRequestDeadline record { string allow_late_uploads?; string deadline?; @@ -2409,6 +2264,12 @@ public type MetadataSharingInfo record { boolean read_only?; }; +public type UpdateFolderMemberArg record { + string access_level?; + MemberSelector member?; + string shared_folder_id?; +}; + # Represents the Headers record for the operation: removeFolderMember public type RemoveFolderMemberHeaders record { string? dropbox\-api\-path\-root?; @@ -2416,17 +2277,12 @@ public type RemoveFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharing_unshare_folder_body record { - boolean leave_a_copy?; - string shared_folder_id?; -}; - -public type CheckUserRequest record { - string query?; +public type DeleteBatchArg record { + DeleteArg[] entries?; }; -public type legal_holds_list_held_revisions_continue_body record { - string id?; +public type GroupsMembersListContinueArg record { + string cursor?; }; public type SharedContentAccessLevel record { @@ -2437,18 +2293,10 @@ public type AddSecondaryEmailsResult record { UserAddResult[] results?; }; -public type list_received_files_continue_body record { - string cursor?; -}; - -public type teamgroupsmembersadd_members record { - string access_type?; - teamgroupsmembersadd_user user?; -}; - -public type members_set_admin_permissions_body record { - string new_role?; - members_send_welcome_email_body user?; +public type MembersSetProfileArg record { + string new_email?; + string new_surname?; + UserSelectorArg user?; }; public type PathLogInfo record { @@ -2456,11 +2304,17 @@ public type PathLogInfo record { NamespaceRelativePathLogInfo namespace_relative?; }; -public type GenericResponseWithTag record { +public type FileMemberActionIndividualResult record { string \.tag?; }; -public type teamgroupsget_info_profile_status record { +public type CreateFolderBatchArg record { + boolean autorename?; + boolean force_async?; + string[] paths?; +}; + +public type GenericResponseWithTag record { string \.tag?; }; @@ -2470,10 +2324,14 @@ public type MountFolderHeaders record { string? dropbox\-api\-select\-user?; }; +public type MembersDeleteProfilePhotoArg record { + UserSelectorArg user?; +}; + public type SharedFolderMembers record { string cursor?; - sharinglist_file_membersbatch_result_members_groups[] groups?; - sharinglist_file_membersbatch_result_members_invitees[] invitees?; + GroupInfos[] groups?; + InviteeMembershipInfo[] invitees?; UserMembershipInfo[] users?; }; @@ -2484,17 +2342,14 @@ public type ListFolderContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type files_move_batch_v2_body record { - boolean allow_ownership_transfer?; - boolean autorename?; - filescopy_batch_v2_entries[] entries?; +public type DeleteBatchResult record { + string \.tag?; + DeleteBatchResultEntry[] entries?; }; -public type devices_list_member_devices_body record { - boolean include_desktop_clients?; - boolean include_mobile_clients?; - boolean include_web_sessions?; - string team_member_id?; +public type AddPropertiesArg record { + string path?; + PropertyGroup[] property_groups?; }; # Represents the Headers record for the operation: copyBatchCheck @@ -2510,20 +2365,17 @@ public type DeleteManualContactsBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type list_file_members_continue_body record { - string cursor?; -}; - -public type files_copy_v2_body record { - boolean allow_ownership_transfer?; - boolean allow_shared_folder?; - boolean autorename?; - string from_path?; - string to_path?; +public type SharedLinkSettings record { + string access?; + string audience?; + string requested_visibility?; }; -public type job_status_check_body record { - string async_job_id?; +public type CreateFileRequestArgs record { + FileRequestDeadline deadline?; + string destination?; + boolean open?; + string title?; }; public type FolderMetadataResponse record { @@ -2544,7 +2396,11 @@ public type LegalHoldPolicy record { MembersInfo members?; string name?; string start_date?; - teamgroupsget_info_profile_status status?; + TeamMemberStatus status?; +}; + +public type LockFileBatchArg record { + LockFileArg[] entries?; }; # Represents the Headers record for the operation: get @@ -2568,14 +2424,15 @@ public type UploadSessionAppendHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharing_relinquish_file_membership_body record { - string file?; +public type UnmountFolderArg record { + string shared_folder_id?; }; -public type devices_revoke_device_session_body record { - string \.tag?; - string session_id?; - string team_member_id?; +public type UpdateFolderPolicyArg record { + string acl_update_policy?; + string member_policy?; + string shared_folder_id?; + string shared_link_policy?; }; # Represents the Headers record for the operation: saveUrlCheckJobStatus @@ -2584,10 +2441,6 @@ public type SaveUrlCheckJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type files_unlock_file_batch_body record { - filesget_file_lock_batch_entries[] entries?; -}; - # Represents the Headers record for the operation: copy public type CopyHeaders record { string? dropbox\-api\-path\-root?; @@ -2595,16 +2448,29 @@ public type CopyHeaders record { string? dropbox\-api\-select\-user?; }; -public type excluded_users_remove_body record { - teamgroupsmembersadd_user[] users?; -}; - # Represents the Headers record for the operation: update public type UpdateHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type UserFeature record { + string \.tag?; +}; + +public type MemberProfile record { + string account_id?; + string email?; + boolean email_verified?; + string joined_on?; + TeamMembershipType membership_type?; + Name name?; + string profile_photo_url?; + SecondaryEmail[] secondary_emails?; + TeamMemberStatus status?; + string team_member_id?; +}; + # Represents the Headers record for the operation: listFolderGetLatestCursor public type ListFolderGetLatestCursorHeaders record { string? dropbox\-api\-path\-root?; @@ -2612,6 +2478,11 @@ public type ListFolderGetLatestCursorHeaders record { string? dropbox\-api\-select\-user?; }; +public type SaveUrlArg record { + string path?; + string url?; +}; + public type FileMetadata record { string client_modified?; string content_hash?; @@ -2636,24 +2507,12 @@ public type UpdateFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharingget_file_metadatabatch_result_access_type record { - string \.tag?; -}; - # Represents the Headers record for the operation: getSharedLinkMetadata public type GetSharedLinkMetadataHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type sharing_check_share_job_status_body record { - string async_job_id?; -}; - -public type create_folder_batch_check_body record { - string async_job_id?; -}; - # Represents the Headers record for the operation: moveBatchCheck public type MoveBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2661,15 +2520,6 @@ public type MoveBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; -public type sharing_share_folder_body record { - string access_inheritance?; - string acl_update_policy?; - boolean force_async?; - string member_policy?; - string path?; - string shared_link_policy?; -}; - # Represents the Headers record for the operation: uploadSessionFinishBatchCheck public type UploadSessionFinishBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2681,17 +2531,19 @@ public type LinkAction record { string \.tag?; }; -public type features_get_values_body record { - teamfeaturesget_values_features[] features?; +public type OverwritePropertyGroupArg record { + string path?; + PropertyGroup[] property_groups?; }; -public type sharing_mount_folder_body record { - string shared_folder_id?; +public type GroupSelector record { + string \.tag?; + string group_id?; }; public type FileMemberActionResult record { - sharingadd_file_member_members member?; - sharingadd_file_member_result result?; + MemberSelector member?; + FileMemberActionIndividualResult result?; }; # Represents the Headers record for the operation: uploadSessionFinish @@ -2707,11 +2559,6 @@ public type MembersInfo record { string[] team_member_ids?; }; -public type sharinglist_file_membersbatch_result_members_invitee record { - string \.tag?; - string email?; -}; - public type SharingInfo record { string modified_by?; boolean no_access?; @@ -2720,6 +2567,15 @@ public type SharingInfo record { boolean traverse_only?; }; +public type GetSharedLinkMetadataArg record { + string path?; + string url?; +}; + +public type MembersListContinueArg record { + string cursor?; +}; + # Represents the Headers record for the operation: copyBatch public type CopyBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2729,54 +2585,61 @@ public type CopyBatchHeaders record { public type ListFileMembersIndividualResult record { string file?; - sharinglist_file_membersbatch_result result?; + ListFileMembersCountResult result?; }; -# Represents the Headers record for the operation: relinquishFileMembership -public type RelinquishFileMembershipHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-admin?; - string? dropbox\-api\-select\-user?; +public type MemberAccess record { + string access_type?; + UserSelectorArg user?; }; -public type list_continue_body_1 record { - string cursor?; +public type GetTemplateResult record { + string description?; + PropertyFieldTemplateAsResponse[] fields?; + string name?; }; -public type ListFileRequestsResponse record { - string cursor?; - FileRequestAsResponse[] file_requests?; - boolean has_more?; +public type SecondaryEmail record { + string email?; + boolean is_verified?; }; -public type usersfeaturesget_values_features record { - string \.tag?; +public type SaveCopyReferenceArg record { + string copy_reference?; + string path?; }; -public type LegalHoldsListHeldRevisionResult record { - LegalHoldHeldRevisionMetadata[] entries?; - boolean has_more?; +# Represents the Headers record for the operation: relinquishFileMembership +public type RelinquishFileMembershipHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; }; -public type filescopy_batch_v2_entries record { - string from_path?; - string to_path?; +public type MembersDeactivateArg record { + UserSelectorArg user?; + boolean wipe_data?; }; -public type list_continue_body_5 record { - string cursor?; +public type LegalHoldsListHeldRevisionResult record { + LegalHoldHeldRevisionMetadata[] entries?; + boolean has_more?; }; -public type list_continue_body_4 record { - string cursor?; +public type FolderPolicy record { + AclUpdatePolicy acl_update_policy?; + MemberPolicy member_policy?; + SharedFolderMemberPolicy resolved_member_policy?; + MemberPolicy shared_link_policy?; }; -public type list_continue_body_3 record { +public type ListSharedLinksArg record { string cursor?; }; -public type list_continue_body_2 record { - string cursor?; +public type MembersSetProfilePhotoArg record { + Photo photo?; + UserSelectorArg user?; }; # Represents the Headers record for the operation: getFolderMetadata @@ -2786,42 +2649,6 @@ public type GetFolderMetadataHeaders record { string? dropbox\-api\-select\-user?; }; -public type ListTemplatesResponse record { - string[] template_ids?; -}; - -public type linked_apps_list_member_linked_apps_body record { - string team_member_id?; -}; - -public type sharingmodify_shared_link_settings_settings record { - string access?; - string audience?; - string requested_visibility?; -}; - -public type GetMetadataResponse record { - string \.tag?; - string client_modified?; - string content_hash?; - FileLockInfo file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - PropertyGroup[] property_groups?; - string rev?; - string server_modified?; - MetadataSharingInfo sharing_info?; - decimal size?; -}; - -public type MetadataResponse record { - MetadataAsResponse metadata?; -}; - # Represents the Headers record for the operation: uploadSessionFinishBatch public type UploadSessionFinishBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2829,26 +2656,22 @@ public type UploadSessionFinishBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type GetThumbnailBatchResult record { + GetThumbnailBatchResultEntry[] entries?; +}; + # Represents the Headers record for the operation: templatesListForUser public type TemplatesListForUserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type list_continue_body_6 record { - string cursor?; -}; - public type NamespaceRelativePathLogInfo record { boolean is_shared_namespace?; string ns_id?; string relative_path?; }; -public type sharinglist_file_membersbatch_result_members_platform_type record { - string \.tag?; -}; - # Represents the Headers record for the operation: getPreview public type GetPreviewHeaders record { string? dropbox\-api\-path\-root?; @@ -2857,28 +2680,19 @@ public type GetPreviewHeaders record { string? dropbox\-api\-select\-user?; }; -public type devices_revoke_device_session_batch_body record { - devices_revoke_device_session_body[] revoke_devices?; -}; - public type TemplateId record { string template_id?; }; -public type FilePath record { - string path?; -}; - -public type RemovePropertiesRequest record { - string path?; - string[] property_template_ids?; +public type ModifySharedLinkSettingsArgs record { + boolean remove_expiration?; + SharedLinkSettings settings?; + string url?; }; -public type filesget_thumbnail_batch_entries record { - string format?; - string mode?; - string path?; - string size?; +public type MembersSetPermissions2Arg record { + string new_role?; + UserSelectorArg user?; }; # Represents the Headers record for the operation: getThumbnail @@ -2911,6 +2725,15 @@ public type ProxyConfig record {| string password = ""; |}; +public type MembersRemoveArg record { + boolean keep_account?; + boolean retain_team_shares?; + UserSelectorArg transfer_admin_id?; + UserSelectorArg transfer_dest_id?; + UserSelectorArg user?; + boolean wipe_data?; +}; + public type GeoLocationLogInfo record { string city?; string country?; @@ -2918,31 +2741,27 @@ public type GeoLocationLogInfo record { string region?; }; -public type ListReceivedFilesResponse record { - string cursor?; - SharedFileMetadata[] entries?; -}; - -public type DeleteSecondaryEmailsResult record { - UserDeleteResult[] results?; +public type SetProfilePhotoArg record { + Photo photo?; }; -public type copy_batch_check_v2_body record { - string async_job_id?; +public type GetTeamEventsArg record { + string category?; + decimal 'limit?; }; -public type get_file_metadata_batch_body record { - anydata[] actions?; - string[] files?; +public type DeleteSecondaryEmailsResult record { + UserDeleteResult[] results?; }; -public type upload_session_finish_batch_body record { - filesupload_sessionfinish_batch_entries[] entries?; +public type LegalHoldsPolicyUpdateArg record { + string id?; + string[] members?; }; -public type sharing_transfer_folder_body record { - string shared_folder_id?; - string to_dropbox_id?; +public type SearchV2Arg record { + boolean include_highlights?; + string query?; }; # Represents the Headers record for the operation: app @@ -2950,3 +2769,7 @@ public type AppHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; + +public type UploadSessionFinishBatchArg record { + UploadSessionFinishArg[] entries?; +}; diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml index 55a4d51..d242b32 100644 --- a/docs/spec/openapi.yaml +++ b/docs/spec/openapi.yaml @@ -113,7 +113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SetProfilePhotoRequest' + $ref: '#/components/schemas/SetProfilePhotoArg' examples: set_profile_photo: value: @@ -133,7 +133,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SetProfilePhotoResponse' + $ref: '#/components/schemas/SetProfilePhotoResult' examples: set_profile_photo response: value: @@ -157,7 +157,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TokenFromOauth1Request' + $ref: '#/components/schemas/TokenFromOauth1Arg' examples: token/from_oauth1: value: @@ -176,7 +176,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TokenFromOauth1Response' + $ref: '#/components/schemas/TokenFromOauth1Result' examples: token/from_oauth1 response: value: @@ -218,7 +218,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CheckAppRequest' + $ref: '#/components/schemas/EchoArg' examples: app: value: @@ -260,7 +260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CheckUserRequest' + $ref: '#/components/schemas/EchoArg' examples: user: value: @@ -320,7 +320,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteManualContactsBatchRequest' + $ref: '#/components/schemas/DeleteManualContactsArg' examples: delete_manual_contacts_batch: value: @@ -349,7 +349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddPropertiesRequest' + $ref: '#/components/schemas/AddPropertiesArg' examples: properties/add: value: @@ -381,7 +381,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OverwritePropertiesRequest' + $ref: '#/components/schemas/OverwritePropertyGroupArg' examples: properties/overwrite: value: @@ -413,7 +413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RemovePropertiesRequest' + $ref: '#/components/schemas/RemovePropertiesArg' examples: properties/remove: value: @@ -442,7 +442,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchPropertiesRequest' + $ref: '#/components/schemas/PropertiesSearchArg' examples: properties/search: value: @@ -466,7 +466,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchPropertiesResponse' + $ref: '#/components/schemas/PropertiesSearchResult' examples: properties/search response: value: @@ -498,7 +498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchPropertiesContinueRequest' + $ref: '#/components/schemas/PropertiesSearchContinueArg' examples: properties/search/continue: value: @@ -516,7 +516,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchPropertiesResponse' + $ref: '#/components/schemas/PropertiesSearchResult' examples: properties/search/continue response: value: @@ -548,7 +548,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdatePropertiesRequest' + $ref: '#/components/schemas/UpdatePropertiesArg' examples: properties/update: value: @@ -579,7 +579,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddTemplateForTeam' + $ref: '#/components/schemas/AddTemplateArg' examples: templates/add_for_team: value: @@ -605,7 +605,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddTemplateResponse' + $ref: '#/components/schemas/AddTemplateResult' examples: templates/add_for_team response: value: @@ -631,7 +631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddTemplateForUser' + $ref: '#/components/schemas/AddTemplateArg' examples: templates/add_for_user: value: @@ -657,7 +657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddTemplateResponse' + $ref: '#/components/schemas/AddTemplateResult' examples: templates/add_for_user response: value: @@ -678,7 +678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetTemplateForTeam' + $ref: '#/components/schemas/GetTemplateArg' examples: templates/get_for_team: value: @@ -696,7 +696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetTemplateResponse' + $ref: '#/components/schemas/GetTemplateResult' examples: templates/get_for_team response: value: @@ -731,7 +731,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetTemplateForUserRequest' + $ref: '#/components/schemas/GetTemplateArg' examples: templates/get_for_user: value: @@ -749,7 +749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetTemplateResponse' + $ref: '#/components/schemas/GetTemplateResult' examples: templates/get_for_user response: value: @@ -788,7 +788,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListTemplatesResponse' + $ref: '#/components/schemas/ListTemplateResult' examples: templates/list_for_team response: value: @@ -824,7 +824,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListTemplatesResponse' + $ref: '#/components/schemas/ListTemplateResult' examples: templates/list_for_user response: value: @@ -846,7 +846,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RemoveTemplateForTeamRequest' + $ref: '#/components/schemas/RemoveTemplateArg' examples: templates/remove_for_team: value: @@ -899,7 +899,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateTemplateForTeamRequest' + $ref: '#/components/schemas/UpdateTemplateArg' examples: templates/update_for_team: value: @@ -952,7 +952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateTemplateForUserRequest' + $ref: '#/components/schemas/UpdateTemplateArg' examples: templates/update_for_user: value: @@ -1012,7 +1012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileRequestCount' + $ref: '#/components/schemas/CountFileRequestsResult' examples: count response: value: @@ -1036,7 +1036,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateFileRequestRequest' + $ref: '#/components/schemas/CreateFileRequestArgs' examples: create: value: @@ -1093,7 +1093,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/file_requests_delete_body' + $ref: '#/components/schemas/DeleteFileRequestArgs' examples: delete: value: @@ -1113,7 +1113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteFileRequestsResponse' + $ref: '#/components/schemas/DeleteFileRequestsResult' examples: delete response: value: @@ -1173,7 +1173,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteFileRequestsResponse' + $ref: '#/components/schemas/DeleteFileRequestsResult' examples: delete_all_closed response: value: @@ -1224,7 +1224,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/file_requests_get_body' + $ref: '#/components/schemas/GetFileRequestArgs' examples: get: value: @@ -1276,7 +1276,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/file_requests_list_v2_body' + $ref: '#/components/schemas/ListFileRequestsArg' examples: list: value: @@ -1294,7 +1294,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFileRequestsResponse' + $ref: '#/components/schemas/ListFileRequestsV2Result' examples: list response: value: @@ -1347,7 +1347,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_continue_body' + $ref: '#/components/schemas/ListFileRequestsContinueArg' examples: list/continue: value: @@ -1365,7 +1365,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFileRequestsResponse' + $ref: '#/components/schemas/ListFileRequestsV2Result' examples: list/continue response: value: @@ -1418,7 +1418,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/file_requests_update_body' + $ref: '#/components/schemas/UpdateFileRequestArgs' examples: update: value: @@ -1479,7 +1479,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_copy_v2_body' + $ref: '#/components/schemas/RelocationArg' examples: copy: value: @@ -1501,7 +1501,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetadataResponse' + $ref: '#/components/schemas/MetadataResult' examples: copy response: value: @@ -1553,7 +1553,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_copy_batch_v2_body' + $ref: '#/components/schemas/RelocationBatchArgBase' examples: copy_batch: value: @@ -1574,7 +1574,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RelocationBatchV2Response' + $ref: '#/components/schemas/RelocationBatchV2Result' examples: copy_batch response: value: @@ -1627,7 +1627,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/copy_batch_check_v2_body' + $ref: '#/components/schemas/PollArg' examples: copy_batch/check: value: @@ -1645,7 +1645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RelocationBatchV2Response' + $ref: '#/components/schemas/RelocationBatchV2Result' examples: copy_batch/check response: value: @@ -1697,7 +1697,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/copy_reference_get_body' + $ref: '#/components/schemas/GetCopyReferenceArg' examples: copy_reference/get: value: @@ -1715,7 +1715,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetCopyReferenceResponse' + $ref: '#/components/schemas/GetCopyReferenceResult' examples: copy_reference/get response: value: @@ -1766,7 +1766,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/copy_reference_save_body' + $ref: '#/components/schemas/SaveCopyReferenceArg' examples: copy_reference/save: value: @@ -1785,7 +1785,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetadataResponse' + $ref: '#/components/schemas/MetadataResult' examples: copy_reference/save response: value: @@ -1835,7 +1835,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_create_folder_v2_body' + $ref: '#/components/schemas/CreateFolderArg' examples: create_folder: value: @@ -1894,7 +1894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_create_folder_batch_body' + $ref: '#/components/schemas/CreateFolderBatchArg' examples: create_folder_batch: value: @@ -1915,7 +1915,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateFolderBatchResponse' + $ref: '#/components/schemas/CreateFolderBatchResult' examples: create_folder_batch response: value: @@ -1957,7 +1957,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/create_folder_batch_check_body' + $ref: '#/components/schemas/PollArg' examples: create_folder_batch/check: value: @@ -1975,7 +1975,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateFolderBatchResponse' + $ref: '#/components/schemas/CreateFolderBatchResult' examples: create_folder_batch/check response: value: @@ -2019,7 +2019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FilePath' + $ref: '#/components/schemas/DeleteArg' examples: delete: value: @@ -2037,7 +2037,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetadataResponse' + $ref: '#/components/schemas/MetadataResult' examples: delete response: value: @@ -2088,7 +2088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteFilesBatchRequest' + $ref: '#/components/schemas/DeleteBatchArg' examples: delete_batch: value: @@ -2107,7 +2107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteBatchResponse' + $ref: '#/components/schemas/DeleteBatchResult' examples: delete_batch response: value: @@ -2160,7 +2160,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/delete_batch_check_body' + $ref: '#/components/schemas/PollArg' examples: delete_batch/check: value: @@ -2178,7 +2178,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteBatchResponse' + $ref: '#/components/schemas/DeleteBatchResult' examples: delete_batch/check response: value: @@ -2377,7 +2377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportFileResponse' + $ref: '#/components/schemas/ExportResult' examples: export response: value: @@ -2429,7 +2429,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_get_file_lock_batch_body' + $ref: '#/components/schemas/LockFileBatchArg' examples: get_file_lock_batch: value: @@ -2507,7 +2507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_get_metadata_body' + $ref: '#/components/schemas/GetMetadataArg' examples: get_metadata: value: @@ -2528,7 +2528,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetMetadataResponse' + $ref: '#/components/schemas/Metadata' examples: get_metadata response: value: @@ -2647,7 +2647,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_get_temporary_link_body' + $ref: '#/components/schemas/GetTemporaryLinkArg' examples: get_temporary_link: value: @@ -2665,7 +2665,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetTemporaryLinkResponse' + $ref: '#/components/schemas/GetTemporaryLinkResult' examples: get_temporary_link response: value: @@ -2738,7 +2738,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_get_temporary_upload_link_body' + $ref: '#/components/schemas/GetTemporaryUploadLinkArg' examples: get_temporary_upload_link: value: @@ -2762,7 +2762,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetTemporaryUploadLinkResponse' + $ref: '#/components/schemas/GetTemporaryUploadLinkResult' examples: get_temporary_upload_link response: value: @@ -2806,7 +2806,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetThumbnailResponse' + $ref: '#/components/schemas/PreviewResult' examples: get_thumbnail response: value: @@ -2856,7 +2856,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_get_thumbnail_batch_body' + $ref: '#/components/schemas/GetThumbnailBatchArg' examples: get_thumbnail_batch: value: @@ -2878,7 +2878,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetThumbnailBatchResponse' + $ref: '#/components/schemas/GetThumbnailBatchResult' examples: get_thumbnail_batch response: value: @@ -2935,7 +2935,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_list_folder_body' + $ref: '#/components/schemas/ListFolderArg' examples: list_folder: value: @@ -2959,7 +2959,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFolderResponse' + $ref: '#/components/schemas/ListFolderResult' examples: list_folder response: value: @@ -3026,7 +3026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_folder_continue_body' + $ref: '#/components/schemas/ListFolderContinueArg' examples: list_folder/continue: value: @@ -3044,7 +3044,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFolderResponse' + $ref: '#/components/schemas/ListFolderResult' examples: list_folder/continue response: value: @@ -3111,7 +3111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_folder_get_latest_cursor_body' + $ref: '#/components/schemas/ListFolderArg' examples: list_folder/get_latest_cursor: value: @@ -3135,7 +3135,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_folder_continue_body' + $ref: '#/components/schemas/ListFolderContinueArg' examples: list_folder/get_latest_cursor response: value: @@ -3160,7 +3160,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_folder_longpoll_body' + $ref: '#/components/schemas/ListFolderLongpollArg' examples: list_folder/longpoll: value: @@ -3205,7 +3205,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_list_revisions_body' + $ref: '#/components/schemas/ListRevisionsArg' examples: list_revisions: value: @@ -3274,7 +3274,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_lock_file_batch_body' + $ref: '#/components/schemas/LockFileBatchArg' examples: lock_file_batch: value: @@ -3353,7 +3353,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_move_v2_body' + $ref: '#/components/schemas/RelocationArg' examples: move: value: @@ -3375,7 +3375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetadataResponse' + $ref: '#/components/schemas/MetadataResult' examples: move response: value: @@ -3427,7 +3427,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_move_batch_v2_body' + $ref: '#/components/schemas/MoveBatchArg' examples: move_batch: value: @@ -3449,7 +3449,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RelocationBatchV2Response' + $ref: '#/components/schemas/RelocationBatchV2Result' examples: move_batch response: value: @@ -3502,7 +3502,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/move_batch_check_v2_body' + $ref: '#/components/schemas/PollArg' examples: move_batch/check: value: @@ -3520,7 +3520,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RelocationBatchV2Response' + $ref: '#/components/schemas/RelocationBatchV2Result' examples: move_batch/check response: value: @@ -3574,7 +3574,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_permanently_delete_body' + $ref: '#/components/schemas/DeleteArg' examples: permanently_delete: value: @@ -3602,7 +3602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_restore_body' + $ref: '#/components/schemas/RestoreArg' examples: restore: value: @@ -3670,7 +3670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_save_url_body' + $ref: '#/components/schemas/SaveUrlArg' examples: save_url: value: @@ -3737,7 +3737,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/save_url_check_job_status_body' + $ref: '#/components/schemas/PollArg' examples: save_url/check_job_status: value: @@ -3781,7 +3781,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_search_v2_body' + $ref: '#/components/schemas/SearchV2Arg' examples: search: value: @@ -3800,7 +3800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchFilesResponse' + $ref: '#/components/schemas/SearchV2Result' examples: search response: value: @@ -3855,7 +3855,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/search_continue_v2_body' + $ref: '#/components/schemas/SearchV2ContinueArg' examples: search/continue: value: @@ -3873,7 +3873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchFilesResponse' + $ref: '#/components/schemas/SearchV2Result' examples: search/continue response: value: @@ -3927,7 +3927,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/files_unlock_file_batch_body' + $ref: '#/components/schemas/UnlockFileBatchArg' examples: unlock_file_batch: value: @@ -4179,7 +4179,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/upload_session_finish_batch_body' + $ref: '#/components/schemas/UploadSessionFinishBatchArg' examples: upload_session/finish_batch: value: @@ -4257,7 +4257,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/finish_batch_check_body' + $ref: '#/components/schemas/PollArg' examples: upload_session/finish_batch/check: value: @@ -4374,7 +4374,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_add_file_member_body' + $ref: '#/components/schemas/AddFileMemberArgs' examples: add_file_member: value: @@ -4437,7 +4437,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_add_folder_member_body' + $ref: '#/components/schemas/AddFolderMemberArg' examples: add_folder_member: value: @@ -4476,7 +4476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_check_job_status_body' + $ref: '#/components/schemas/PollArg' examples: check_job_status: value: @@ -4519,7 +4519,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_check_remove_member_job_status_body' + $ref: '#/components/schemas/PollArg' examples: check_remove_member_job_status: value: @@ -4562,7 +4562,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_check_share_job_status_body' + $ref: '#/components/schemas/PollArg' examples: check_share_job_status: value: @@ -4639,7 +4639,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_get_file_metadata_body' + $ref: '#/components/schemas/GetFileMetadataArg' examples: get_file_metadata: value: @@ -4658,7 +4658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetFileMetadataResponse' + $ref: '#/components/schemas/SharedFileMetadata' examples: get_file_metadata response: value: @@ -4704,7 +4704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/get_file_metadata_batch_body' + $ref: '#/components/schemas/GetFileMetadataBatchArg' examples: get_file_metadata/batch: value: @@ -4754,7 +4754,7 @@ paths: preview_url: https://www.dropbox.com/scl/fi/fir9vjelf time_invited: 2016-01-20T00:00:00Z items: - $ref: '#/components/schemas/GetFileMetadataIndicidualResult' + $ref: '#/components/schemas/GetFileMetadataIndividualResult' examples: get_file_metadata/batch response: value: @@ -4804,7 +4804,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_get_folder_metadata_body' + $ref: '#/components/schemas/GetMetadataArgs' examples: get_folder_metadata: value: @@ -4942,7 +4942,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_get_shared_link_metadata_body' + $ref: '#/components/schemas/GetSharedLinkMetadataArg' examples: get_shared_link_metadata: value: @@ -5006,7 +5006,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_list_file_members_body' + $ref: '#/components/schemas/ListFileMembersArg' examples: list_file_members: value: @@ -5088,7 +5088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_file_members_batch_body' + $ref: '#/components/schemas/ListFileMembersBatchArg' examples: list_file_members/batch: value: @@ -5221,7 +5221,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_file_members_continue_body' + $ref: '#/components/schemas/ListFileMembersContinueArg' examples: list_file_members/continue: value: @@ -5301,7 +5301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_folder_members_continue_body' + $ref: '#/components/schemas/ListFolderMembersContinueArg' examples: list_folder_members/continue: value: @@ -5378,7 +5378,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_list_folders_body' + $ref: '#/components/schemas/ListFoldersArgs' examples: list_folders: value: @@ -5456,7 +5456,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_folders_continue_body' + $ref: '#/components/schemas/ListFoldersContinueArg' examples: list_folders/continue: value: @@ -5533,7 +5533,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_list_mountable_folders_body' + $ref: '#/components/schemas/ListFoldersArgs' examples: list_mountable_folders: value: @@ -5611,7 +5611,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_mountable_folders_continue_body' + $ref: '#/components/schemas/ListFoldersContinueArg' examples: list_mountable_folders/continue: value: @@ -5690,7 +5690,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_list_received_files_body' + $ref: '#/components/schemas/ListFilesArg' examples: list_received_files: value: @@ -5709,7 +5709,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListReceivedFilesResponse' + $ref: '#/components/schemas/ListFilesResult' examples: list_received_files response: value: @@ -5757,7 +5757,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_received_files_continue_body' + $ref: '#/components/schemas/ListFilesContinueArg' examples: list_received_files/continue: value: @@ -5775,7 +5775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListReceivedFilesResponse' + $ref: '#/components/schemas/ListFilesResult' examples: list_received_files/continue response: value: @@ -5825,7 +5825,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_list_shared_links_body' + $ref: '#/components/schemas/ListSharedLinksArg' examples: list_shared_links: value: @@ -5891,7 +5891,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_modify_shared_link_settings_body' + $ref: '#/components/schemas/ModifySharedLinkSettingsArgs' examples: modify_shared_link_settings: value: @@ -5959,7 +5959,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_mount_folder_body' + $ref: '#/components/schemas/MountFolderArg' examples: mount_folder: value: @@ -6035,7 +6035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_relinquish_file_membership_body' + $ref: '#/components/schemas/RelinquishFileMembershipArg' examples: relinquish_file_membership: value: @@ -6063,7 +6063,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_relinquish_folder_membership_body' + $ref: '#/components/schemas/RelinquishFolderMembershipArg' examples: relinquish_folder_membership: value: @@ -6107,7 +6107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_remove_file_member_2_body' + $ref: '#/components/schemas/RemoveFileMemberArg' examples: remove_file_member_2: value: @@ -6153,7 +6153,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_remove_folder_member_body' + $ref: '#/components/schemas/RemoveFolderMemberArg' examples: remove_folder_member: value: @@ -6202,7 +6202,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_revoke_shared_link_body' + $ref: '#/components/schemas/RevokeSharedLinkArg' examples: revoke_shared_link: value: @@ -6230,7 +6230,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_set_access_inheritance_body' + $ref: '#/components/schemas/SetAccessInheritanceArg' examples: set_access_inheritance: value: @@ -6310,7 +6310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_share_folder_body' + $ref: '#/components/schemas/ShareFolderArg' examples: share_folder: value: @@ -6393,7 +6393,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_transfer_folder_body' + $ref: '#/components/schemas/TransferFolderArg' examples: transfer_folder: value: @@ -6422,7 +6422,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_unmount_folder_body' + $ref: '#/components/schemas/UnmountFolderArg' examples: unmount_folder: value: @@ -6450,7 +6450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnshareFileRequest' + $ref: '#/components/schemas/UnshareFileArg' examples: unshare_file: value: @@ -6479,7 +6479,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_unshare_folder_body' + $ref: '#/components/schemas/UnshareFolderArg' examples: unshare_folder: value: @@ -6523,7 +6523,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_update_file_member_body' + $ref: '#/components/schemas/UpdateFileMemberArgs' examples: update_file_member: value: @@ -6570,7 +6570,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_update_folder_member_body' + $ref: '#/components/schemas/UpdateFolderMemberArg' examples: update_folder_member: value: @@ -6618,7 +6618,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sharing_update_folder_policy_body' + $ref: '#/components/schemas/UpdateFolderPolicyArg' examples: update_folder_policy: value: @@ -6694,7 +6694,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/devices_list_member_devices_body' + $ref: '#/components/schemas/ListMemberDevicesArg' examples: devices/list_member_devices: value: @@ -6745,7 +6745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/devices_revoke_device_session_body' + $ref: '#/components/schemas/RevokeDeviceSessionArg' examples: devices/revoke_device_session: value: @@ -6772,7 +6772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/devices_revoke_device_session_batch_body' + $ref: '#/components/schemas/RevokeDeviceSessionBatchArg' examples: devices/revoke_device_session_batch: value: @@ -6801,7 +6801,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/groups_create_body' + $ref: '#/components/schemas/GroupCreateArg' examples: groups/create: value: @@ -6877,7 +6877,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/groups_delete_body' + $ref: '#/components/schemas/GroupSelector' examples: groups/delete: value: @@ -6919,7 +6919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/groups_get_info_body' + $ref: '#/components/schemas/GroupsSelector' examples: groups/get_info: value: @@ -7033,7 +7033,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/job_status_get_body' + $ref: '#/components/schemas/PollArg' examples: groups/job_status/get: value: @@ -7074,7 +7074,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/groups_list_body' + $ref: '#/components/schemas/GroupsListArg' examples: groups/list: value: @@ -7122,7 +7122,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_continue_body_1' + $ref: '#/components/schemas/GroupsListContinueArg' examples: groups/list/continue: value: @@ -7171,7 +7171,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_add_body' + $ref: '#/components/schemas/GroupMembersAddArg' examples: groups/members/add: value: @@ -7254,7 +7254,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_list_body' + $ref: '#/components/schemas/GroupsMembersListArg' examples: groups/members/list: value: @@ -7300,7 +7300,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_continue_body_2' + $ref: '#/components/schemas/GroupsMembersListContinueArg' examples: groups/members/list/continue: value: @@ -7345,7 +7345,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_remove_body' + $ref: '#/components/schemas/GroupMembersRemoveArg' examples: groups/members/remove: value: @@ -7426,7 +7426,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_set_access_type_body' + $ref: '#/components/schemas/GroupMembersSetAccessTypeArg' examples: groups/members/set_access_type: value: @@ -7544,7 +7544,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/groups_update_body' + $ref: '#/components/schemas/GroupUpdateArgs' examples: groups/update: value: @@ -7623,7 +7623,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/legal_holds_create_policy_body' + $ref: '#/components/schemas/LegalHoldsPolicyCreateArg' examples: legal_holds/create_policy: value: @@ -7678,7 +7678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/legal_holds_get_policy_body' + $ref: '#/components/schemas/LegalHoldsGetPolicyArg' examples: legal_holds/get_policy: value: @@ -7729,7 +7729,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/legal_holds_list_held_revisions_body' + $ref: '#/components/schemas/LegalHoldsListHeldRevisionsArg' examples: legal_holds/list_held_revisions: value: @@ -7782,7 +7782,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/legal_holds_list_held_revisions_continue_body' + $ref: '#/components/schemas/LegalHoldsListHeldRevisionsContinueArg' examples: legal_holds/list_held_revisions_continue: value: @@ -7835,7 +7835,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/legal_holds_list_policies_body' + $ref: '#/components/schemas/LegalHoldsListPoliciesArg' examples: legal_holds/list_policies: value: @@ -7887,7 +7887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/legal_holds_release_policy_body' + $ref: '#/components/schemas/LegalHoldsPolicyReleaseArg' examples: legal_holds/release_policy: value: @@ -7913,7 +7913,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/legal_holds_update_policy_body' + $ref: '#/components/schemas/LegalHoldsPolicyUpdateArg' examples: legal_holds/update_policy: value: @@ -7966,7 +7966,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/linked_apps_list_member_linked_apps_body' + $ref: '#/components/schemas/ListMemberAppsArg' examples: linked_apps/list_member_linked_apps: value: @@ -8058,7 +8058,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/excluded_users_add_body' + $ref: '#/components/schemas/ExcludedUsersUpdateArg' examples: member_space_limits/excluded_users/add: value: @@ -8101,7 +8101,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/excluded_users_list_body' + $ref: '#/components/schemas/ExcludedUsersListArg' examples: member_space_limits/excluded_users/list: value: @@ -8143,7 +8143,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_continue_body_3' + $ref: '#/components/schemas/ExcludedUsersListContinueArg' examples: member_space_limits/excluded_users/list/continue: value: @@ -8185,7 +8185,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/excluded_users_remove_body' + $ref: '#/components/schemas/ExcludedUsersUpdateArg' examples: member_space_limits/excluded_users/remove: value: @@ -8228,7 +8228,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/member_space_limits_get_custom_quota_body' + $ref: '#/components/schemas/CustomQuotaUsersArg' examples: member_space_limits/get_custom_quota: value: @@ -8274,7 +8274,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/member_space_limits_remove_custom_quota_body' + $ref: '#/components/schemas/CustomQuotaUsersArg' examples: member_space_limits/remove_custom_quota: value: @@ -8320,7 +8320,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/member_space_limits_set_custom_quota_body' + $ref: '#/components/schemas/SetCustomQuotaArg' examples: member_space_limits/set_custom_quota: value: @@ -8373,7 +8373,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_add_body_1' + $ref: '#/components/schemas/MembersAddV2Arg' examples: members/add: value: @@ -8451,7 +8451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/job_status_get_body_1' + $ref: '#/components/schemas/PollArg' examples: members/add/job_status/get: value: @@ -8522,7 +8522,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_delete_profile_photo_body' + $ref: '#/components/schemas/MembersDeleteProfilePhotoArg' examples: members/delete_profile_photo: value: @@ -8593,7 +8593,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_get_info_body' + $ref: '#/components/schemas/MembersGetInfoV2Arg' examples: members/get_info: value: @@ -8696,7 +8696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_list_body_1' + $ref: '#/components/schemas/MembersListArg' examples: members/list: value: @@ -8768,7 +8768,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_continue_body_4' + $ref: '#/components/schemas/MembersListContinueArg' examples: members/list/continue: value: @@ -8839,7 +8839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_move_former_member_files_body' + $ref: '#/components/schemas/MembersDataTransferArg' examples: members/move_former_member_files: value: @@ -8888,7 +8888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/job_status_check_body' + $ref: '#/components/schemas/PollArg' examples: members/move_former_member_files/job_status/check: value: @@ -8930,7 +8930,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_recover_body' + $ref: '#/components/schemas/MembersRecoverArg' examples: members/recover: value: @@ -8962,7 +8962,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_remove_body_1' + $ref: '#/components/schemas/MembersRemoveArg' examples: members/remove: value: @@ -9014,7 +9014,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/job_status_get_body_2' + $ref: '#/components/schemas/PollArg' examples: members/remove/job_status/get: value: @@ -9056,7 +9056,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/secondary_emails_add_body' + $ref: '#/components/schemas/AddSecondaryEmailsArg' examples: members/secondary_emails/add: value: @@ -9119,7 +9119,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/secondary_emails_delete_body' + $ref: '#/components/schemas/DeleteSecondaryEmailsArg' examples: members/secondary_emails/delete: value: @@ -9175,7 +9175,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/secondary_emails_resend_verification_emails_body' + $ref: '#/components/schemas/ResendVerificationEmailArg' examples: members/secondary_emails/resend_verification_emails: value: @@ -9231,7 +9231,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_send_welcome_email_body' + $ref: '#/components/schemas/UserSelectorArg' examples: members/send_welcome_email: value: @@ -9258,7 +9258,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_set_admin_permissions_body' + $ref: '#/components/schemas/MembersSetPermissions2Arg' examples: members/set_admin_permissions: value: @@ -9279,7 +9279,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SetAdminPermissionsResult' + $ref: '#/components/schemas/MembersSetPermissionsResult' examples: members/set_admin_permissions response: value: @@ -9304,7 +9304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_set_profile_body' + $ref: '#/components/schemas/MembersSetProfileArg' examples: members/set_profile: value: @@ -9376,7 +9376,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_set_profile_photo_body' + $ref: '#/components/schemas/MembersSetProfilePhotoArg' examples: members/set_profile_photo: value: @@ -9450,7 +9450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_suspend_body' + $ref: '#/components/schemas/MembersDeactivateArg' examples: members/suspend: value: @@ -9480,7 +9480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/members_unsuspend_body' + $ref: '#/components/schemas/MembersUnsuspendArg' examples: members/unsuspend: value: @@ -9507,7 +9507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/namespaces_list_body' + $ref: '#/components/schemas/TeamNamespacesListArg' examples: namespaces/list: value: @@ -9558,7 +9558,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_continue_body_5' + $ref: '#/components/schemas/TeamNamespacesListContinueArg' examples: namespaces/list/continue: value: @@ -9698,7 +9698,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_activate_body' + $ref: '#/components/schemas/TeamFolderIdArg' examples: team_folder/activate: value: @@ -9749,7 +9749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_archive_body' + $ref: '#/components/schemas/TeamFolderArchiveArg' examples: team_folder/archive: value: @@ -9802,7 +9802,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/archive_check_body' + $ref: '#/components/schemas/PollArg' examples: team_folder/archive/check: value: @@ -9854,7 +9854,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_create_body' + $ref: '#/components/schemas/TeamFolderCreateArg' examples: team_folder/create: value: @@ -9906,7 +9906,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_get_info_body' + $ref: '#/components/schemas/TeamFolderIdListArg' examples: team_folder/get_info: value: @@ -9935,7 +9935,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_list_body' + $ref: '#/components/schemas/TeamFolderListArg' examples: team_folder/list: value: @@ -9989,7 +9989,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/list_continue_body_6' + $ref: '#/components/schemas/TeamFolderListContinueArg' examples: team_folder/list/continue: value: @@ -10043,7 +10043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_permanently_delete_body' + $ref: '#/components/schemas/TeamFolderIdArg' examples: team_folder/permanently_delete: value: @@ -10069,7 +10069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_rename_body' + $ref: '#/components/schemas/TeamFolderRenameArg' examples: team_folder/rename: value: @@ -10120,7 +10120,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_folder_update_sync_settings_body' + $ref: '#/components/schemas/TeamFolderUpdateSyncSettingsArg' examples: team_folder/update_sync_settings: value: @@ -10174,7 +10174,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/features_get_values_body' + $ref: '#/components/schemas/FeaturesGetValuesBatchArg' examples: features/get_values: value: @@ -10194,7 +10194,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeaturesGetValuesResponse' + $ref: '#/components/schemas/FeaturesGetValuesBatchResult' examples: features/get_values response: value: @@ -10232,7 +10232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetInfoResponse' + $ref: '#/components/schemas/TeamGetInfoResult' examples: get_info response: value: @@ -10328,7 +10328,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/team_log_get_events_body' + $ref: '#/components/schemas/GetTeamEventsArg' examples: get_events: value: @@ -10447,7 +10447,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/get_events_continue_body' + $ref: '#/components/schemas/GetTeamEventsContinueArg' examples: get_events/continue: value: @@ -10567,7 +10567,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/features_get_values_body_1' + $ref: '#/components/schemas/UserFeaturesGetValuesBatchArg' examples: features/get_values: value: @@ -10615,7 +10615,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/users_get_account_body' + $ref: '#/components/schemas/GetAccountArg' examples: get_account: value: @@ -10668,7 +10668,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/users_get_account_batch_body' + $ref: '#/components/schemas/GetAccountBatchArg' examples: get_account_batch: value: @@ -10813,7 +10813,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetSpaceUsageResponse' + $ref: '#/components/schemas/SpaceUsage' examples: get_space_usage response: value: @@ -10832,18 +10832,18 @@ components: base64_data: type: string example: SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= - SetProfilePhotoRequest: + SetProfilePhotoArg: type: object properties: photo: $ref: '#/components/schemas/Photo' - SetProfilePhotoResponse: + SetProfilePhotoResult: type: object properties: profile_photo_url: type: string example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - TokenFromOauth1Request: + TokenFromOauth1Arg: type: object properties: oauth1_token: @@ -10852,13 +10852,13 @@ components: oauth1_token_secret: type: string example: qomoftv0472git7 - TokenFromOauth1Response: + TokenFromOauth1Result: type: object properties: oauth2_token: type: string example: 9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn - CheckAppRequest: + EchoArg: type: object properties: query: @@ -10870,13 +10870,7 @@ components: result: type: string example: foo - CheckUserRequest: - type: object - properties: - query: - type: string - example: foo - DeleteManualContactsBatchRequest: + DeleteManualContactsArg: type: object properties: email_addresses: @@ -10909,7 +10903,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - AddPropertiesRequest: + AddPropertiesArg: type: object properties: path: @@ -10924,7 +10918,7 @@ components: template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa items: $ref: '#/components/schemas/PropertyGroup' - OverwritePropertiesRequest: + OverwritePropertyGroupArg: type: object properties: path: @@ -10939,7 +10933,7 @@ components: template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa items: $ref: '#/components/schemas/PropertyGroup' - RemovePropertiesRequest: + RemovePropertiesArg: type: object properties: path: @@ -10952,7 +10946,7 @@ components: items: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - SearchPropertiesMode: + PropertiesSearchMode: type: object properties: ".tag": @@ -10961,18 +10955,18 @@ components: field_name: type: string example: Security - SearchPropertiesQuery: + PropertiesSearchQuery: type: object properties: logical_operator: type: string example: or_operator mode: - $ref: '#/components/schemas/SearchPropertiesMode' + $ref: '#/components/schemas/PropertiesSearchMode' query: type: string example: Confidential - SearchPropertiesRequest: + PropertiesSearchArg: type: object properties: queries: @@ -10984,11 +10978,11 @@ components: field_name: Security query: Confidential items: - $ref: '#/components/schemas/SearchPropertiesQuery' + $ref: '#/components/schemas/PropertiesSearchQuery' template_filter: type: string example: filter_none - SearchPropertiesResponse: + PropertiesSearchResult: type: object properties: matches: @@ -11004,13 +10998,13 @@ components: template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa items: $ref: '#/components/schemas/SearchProperties' - SearchPropertiesContinueRequest: + PropertiesSearchContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - PropertyGroupsUpdate: + PropertyGroupUpdate: type: object properties: add_or_update_fields: @@ -11027,7 +11021,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - UpdatePropertiesRequest: + UpdatePropertiesArg: type: object properties: path: @@ -11042,7 +11036,7 @@ components: remove_fields: [] template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa items: - $ref: '#/components/schemas/PropertyGroupsUpdate' + $ref: '#/components/schemas/PropertyGroupUpdate' PropertyFieldTemplate: type: object properties: @@ -11057,7 +11051,7 @@ components: type: type: string example: string - AddTemplateForTeam: + AddTemplateArg: type: object properties: description: @@ -11077,39 +11071,19 @@ components: name: type: string example: Security - AddTemplateResponse: + AddTemplateResult: type: object properties: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - AddTemplateForUser: - type: object - properties: - description: - type: string - example: These properties describe how confidential this file or folder - is. - fields: - type: array - example: - - description: |- - This is the security policy of the file or folder described. - Policies can be Confidential, Public or Internal. - name: Security Policy - type: string - items: - $ref: '#/components/schemas/PropertyFieldTemplate' - name: - type: string - example: Security - GetTemplateForTeam: + GetTemplateArg: type: object properties: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - GetTemplateResponse: + GetTemplateResult: type: object properties: description: @@ -11130,13 +11104,7 @@ components: name: type: string example: Security - GetTemplateForUserRequest: - type: object - properties: - template_id: - type: string - example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - ListTemplatesResponse: + ListTemplateResult: type: object properties: template_ids: @@ -11146,7 +11114,7 @@ components: items: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - RemoveTemplateForTeamRequest: + RemoveTemplateArg: type: object properties: template_id: @@ -11158,30 +11126,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - UpdateTemplateForTeamRequest: - type: object - properties: - add_fields: - type: array - example: - - description: |- - This is the security policy of the file or folder described. - Policies can be Confidential, Public or Internal. - name: Security Policy - type: string - items: - $ref: '#/components/schemas/PropertyFieldTemplate' - description: - type: string - example: These properties will describe how confidential this file or folder - is. - name: - type: string - example: New Security Template Name - template_id: - type: string - example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - UpdateTemplateForUserRequest: + UpdateTemplateArg: type: object properties: add_fields: @@ -11204,7 +11149,7 @@ components: template_id: type: string example: ptid:1a5n2i6d3OYEAAAAAAAAAYa - FileRequestCount: + CountFileRequestsResult: type: object properties: file_request_count: @@ -11219,7 +11164,7 @@ components: deadline: type: string example: 2020-10-12T17:00:00Z - CreateFileRequestRequest: + CreateFileRequestArgs: type: object properties: deadline: @@ -11259,7 +11204,7 @@ components: url: type: string example: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y - file_requests_delete_body: + DeleteFileRequestArgs: type: object properties: ids: @@ -11270,7 +11215,7 @@ components: items: type: string example: oaCAVmEyrqYnkZX9955Y - DeleteFileRequestsResponse: + DeleteFileRequestsResult: type: object properties: file_requests: @@ -11305,19 +11250,19 @@ components: url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T items: $ref: '#/components/schemas/FileRequestAsResponse' - file_requests_get_body: + GetFileRequestArgs: type: object properties: id: type: string example: oaCAVmEyrqYnkZX9955Y - file_requests_list_v2_body: + ListFileRequestsArg: type: object properties: limit: type: number example: 1000 - ListFileRequestsResponse: + ListFileRequestsV2Result: type: object properties: cursor: @@ -11358,13 +11303,13 @@ components: has_more: type: boolean example: true - list_continue_body: + ListFileRequestsContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - file_requestsupdate_deadline: + UpdateFileRequestDeadline: type: object properties: ".tag": @@ -11376,11 +11321,11 @@ components: deadline: type: string example: 2020-10-12T17:00:00Z - file_requests_update_body: + UpdateFileRequestArgs: type: object properties: deadline: - $ref: '#/components/schemas/file_requestsupdate_deadline' + $ref: '#/components/schemas/UpdateFileRequestDeadline' destination: type: string example: /File Requests/Homework @@ -11393,7 +11338,7 @@ components: title: type: string example: Homework submission - files_copy_v2_body: + RelocationArg: type: object properties: allow_ownership_transfer: @@ -11411,12 +11356,12 @@ components: to_path: type: string example: /Homework/algebra - MetadataResponse: + MetadataResult: type: object properties: metadata: $ref: '#/components/schemas/MetadataAsResponse' - filescopy_batch_v2_entries: + RelocationPath: type: object properties: from_path: @@ -11425,7 +11370,7 @@ components: to_path: type: string example: /Homework/algebra - files_copy_batch_v2_body: + RelocationBatchArgBase: type: object properties: autorename: @@ -11437,8 +11382,8 @@ components: - from_path: /Homework/math to_path: /Homework/algebra items: - $ref: '#/components/schemas/filescopy_batch_v2_entries' - RelocationBatchV2Response: + $ref: '#/components/schemas/RelocationPath' + RelocationBatchV2Result: type: object properties: ".tag": @@ -11476,19 +11421,19 @@ components: size: 7212 items: $ref: '#/components/schemas/CopyBatchResponseEntries' - copy_batch_check_v2_body: + PollArg: type: object properties: async_job_id: type: string example: 34g93hh34h04y384084 - copy_reference_get_body: + GetCopyReferenceArg: type: object properties: path: type: string example: /video.mp4 - GetCopyReferenceResponse: + GetCopyReferenceResult: type: object properties: copy_reference: @@ -11499,7 +11444,7 @@ components: example: 2045-05-12T15:50:38Z metadata: $ref: '#/components/schemas/MetadataAsResponse' - copy_reference_save_body: + SaveCopyReferenceArg: type: object properties: copy_reference: @@ -11508,7 +11453,7 @@ components: path: type: string example: /video.mp4 - files_create_folder_v2_body: + CreateFolderArg: type: object properties: autorename: @@ -11522,7 +11467,7 @@ components: properties: metadata: $ref: '#/components/schemas/FolderMetadata' - files_create_folder_batch_body: + CreateFolderBatchArg: type: object properties: autorename: @@ -11538,7 +11483,7 @@ components: items: type: string example: /Homework/math - CreateFolderBatchResponse: + CreateFolderBatchResult: type: object properties: ".tag": @@ -11564,20 +11509,14 @@ components: read_only: false traverse_only: false items: - $ref: '#/components/schemas/CreateFolderBatchResponseEntry' - create_folder_batch_check_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - FilePath: + $ref: '#/components/schemas/CreateFolderBatchResultEntry' + DeleteArg: type: object properties: path: type: string example: /Homework/math/Prime_Numbers.txt - DeleteFilesBatchRequest: + DeleteBatchArg: type: object properties: entries: @@ -11585,8 +11524,8 @@ components: example: - path: /Homework/math/Prime_Numbers.txt items: - $ref: '#/components/schemas/FilePath' - DeleteBatchResponse: + $ref: '#/components/schemas/DeleteArg' + DeleteBatchResult: type: object properties: ".tag": @@ -11624,12 +11563,6 @@ components: size: 7212 items: $ref: '#/components/schemas/DeleteBatchResultEntry' - delete_batch_check_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 FileMetadata: type: object properties: @@ -11679,20 +11612,20 @@ components: size: type: number example: 7212 - ExportFileResponse: + ExportResult: type: object properties: export_metadata: - $ref: '#/components/schemas/ExportFileResponseMetadata' + $ref: '#/components/schemas/ExportMetadata' file_metadata: $ref: '#/components/schemas/FileMetadata' - filesget_file_lock_batch_entries: + LockFileArg: type: object properties: path: type: string example: /John Doe/sample/test.pdf - files_get_file_lock_batch_body: + LockFileBatchArg: type: object properties: entries: @@ -11700,7 +11633,7 @@ components: example: - path: /John Doe/sample/test.pdf items: - $ref: '#/components/schemas/filesget_file_lock_batch_entries' + $ref: '#/components/schemas/LockFileArg' LockFileBatchResult: type: object properties: @@ -11742,7 +11675,7 @@ components: size: 7212 items: $ref: '#/components/schemas/LockFileResultEntry' - files_get_metadata_body: + GetMetadataArg: type: object properties: include_deleted: @@ -11757,65 +11690,13 @@ components: path: type: string example: /Homework/math - GetMetadataResponse: - type: object - properties: - ".tag": - type: string - example: file - client_modified: - type: string - example: 2015-05-12T15:50:38Z - content_hash: - type: string - example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 - file_lock_info: - $ref: '#/components/schemas/FileLockInfo' - has_explicit_shared_members: - type: boolean - example: false - id: - type: string - example: id:a4ayc_80_OEAAAAAAAAAXw - is_downloadable: - type: boolean - example: true - name: - type: string - example: Prime_Numbers.txt - path_display: - type: string - example: /Homework/math/Prime_Numbers.txt - path_lower: - type: string - example: /homework/math/prime_numbers.txt - property_groups: - type: array - example: - - fields: - - name: Security Policy - value: Confidential - template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa - items: - $ref: '#/components/schemas/PropertyGroup' - rev: - type: string - example: a1c10ce0dd78 - server_modified: - type: string - example: 2015-05-12T15:50:38Z - sharing_info: - $ref: '#/components/schemas/MetadataSharingInfo' - size: - type: number - example: 7212 - files_get_temporary_link_body: + GetTemporaryLinkArg: type: object properties: path: type: string example: /video.mp4 - GetTemporaryLinkResponse: + GetTemporaryLinkResult: type: object properties: link: @@ -11823,7 +11704,7 @@ components: example: https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 metadata: $ref: '#/components/schemas/FileMetadata' - filesget_temporary_upload_link_commit_info: + CommitInfo: type: object properties: autorename: @@ -11841,26 +11722,26 @@ components: strict_conflict: type: boolean example: false - files_get_temporary_upload_link_body: + GetTemporaryUploadLinkArg: type: object properties: commit_info: - $ref: '#/components/schemas/filesget_temporary_upload_link_commit_info' + $ref: '#/components/schemas/CommitInfo' duration: type: number example: 3600 - GetTemporaryUploadLinkResponse: + GetTemporaryUploadLinkResult: type: object properties: link: type: string example: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND - GetThumbnailResponse: + PreviewResult: type: object properties: file_metadata: $ref: '#/components/schemas/FileMetadata' - filesget_thumbnail_batch_entries: + ThumbnailArg: type: object properties: format: @@ -11875,7 +11756,7 @@ components: size: type: string example: w64h64 - files_get_thumbnail_batch_body: + GetThumbnailBatchArg: type: object properties: entries: @@ -11886,8 +11767,8 @@ components: path: /image.jpg size: w64h64 items: - $ref: '#/components/schemas/filesget_thumbnail_batch_entries' - GetThumbnailBatchResponse: + $ref: '#/components/schemas/ThumbnailArg' + GetThumbnailBatchResult: type: object properties: entries: @@ -11922,7 +11803,7 @@ components: thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= items: $ref: '#/components/schemas/GetThumbnailBatchResultEntry' - files_list_folder_body: + ListFolderArg: type: object properties: include_deleted: @@ -11946,7 +11827,7 @@ components: recursive: type: boolean example: false - ListFolderResponse: + ListFolderResult: type: object properties: cursor: @@ -12000,37 +11881,13 @@ components: has_more: type: boolean example: false - list_folder_continue_body: + ListFolderContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - list_folder_get_latest_cursor_body: - type: object - properties: - include_deleted: - type: boolean - example: false - include_has_explicit_shared_members: - type: boolean - example: false - include_media_info: - type: boolean - example: false - include_mounted_folders: - type: boolean - example: true - include_non_downloadable_files: - type: boolean - example: true - path: - type: string - example: /Homework/math - recursive: - type: boolean - example: false - list_folder_longpoll_body: + ListFolderLongpollArg: type: object properties: cursor: @@ -12045,7 +11902,7 @@ components: changes: type: boolean example: true - files_list_revisions_body: + ListRevisionsArg: type: object properties: limit: @@ -12092,34 +11949,7 @@ components: is_deleted: type: boolean example: false - files_lock_file_batch_body: - type: object - properties: - entries: - type: array - example: - - path: /John Doe/sample/test.pdf - items: - $ref: '#/components/schemas/filesget_file_lock_batch_entries' - files_move_v2_body: - type: object - properties: - allow_ownership_transfer: - type: boolean - example: false - allow_shared_folder: - type: boolean - example: false - autorename: - type: boolean - example: false - from_path: - type: string - example: /Homework/math - to_path: - type: string - example: /Homework/algebra - files_move_batch_v2_body: + MoveBatchArg: type: object properties: allow_ownership_transfer: @@ -12134,20 +11964,8 @@ components: - from_path: /Homework/math to_path: /Homework/algebra items: - $ref: '#/components/schemas/filescopy_batch_v2_entries' - move_batch_check_v2_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - files_permanently_delete_body: - type: object - properties: - path: - type: string - example: /Homework/math/Prime_Numbers.txt - files_restore_body: + $ref: '#/components/schemas/RelocationPath' + RestoreArg: type: object properties: path: @@ -12156,7 +11974,7 @@ components: rev: type: string example: a1c10ce0dd78 - files_save_url_body: + SaveUrlArg: type: object properties: path: @@ -12217,19 +12035,13 @@ components: size: type: number example: 7212 - save_url_check_job_status_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 CheckJobStatusResponse: type: object properties: ".tag": type: string example: in_progress - files_search_v2_body: + SearchV2Arg: type: object properties: include_highlights: @@ -12238,7 +12050,7 @@ components: query: type: string example: cat - SearchFilesResponse: + SearchV2Result: type: object properties: has_more: @@ -12277,13 +12089,13 @@ components: size: 7212 items: $ref: '#/components/schemas/SearchMatch' - search_continue_v2_body: + SearchV2ContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - files_unlock_file_batch_body: + UnlockFileBatchArg: type: object properties: entries: @@ -12291,8 +12103,8 @@ components: example: - path: /John Doe/sample/test.pdf items: - $ref: '#/components/schemas/filesget_file_lock_batch_entries' - filesupload_sessionfinish_batch_cursor: + $ref: '#/components/schemas/LockFileArg' + UploadSessionCursor: type: object properties: offset: @@ -12301,14 +12113,14 @@ components: session_id: type: string example: 1234faaf0678bcde - filesupload_sessionfinish_batch_entries: + UploadSessionFinishArg: type: object properties: commit: - $ref: '#/components/schemas/filesget_temporary_upload_link_commit_info' + $ref: '#/components/schemas/CommitInfo' cursor: - $ref: '#/components/schemas/filesupload_sessionfinish_batch_cursor' - upload_session_finish_batch_body: + $ref: '#/components/schemas/UploadSessionCursor' + UploadSessionFinishBatchArg: type: object properties: entries: @@ -12324,7 +12136,7 @@ components: offset: 0 session_id: 1234faaf0678bcde items: - $ref: '#/components/schemas/filesupload_sessionfinish_batch_entries' + $ref: '#/components/schemas/UploadSessionFinishArg' UploadSessionFinishBatchResult: type: object properties: @@ -12361,28 +12173,13 @@ components: size: 7212 items: $ref: '#/components/schemas/UploadSessionFinishBatchResultEntry' - finish_batch_check_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 UploadSessionStartResult: type: object properties: session_id: type: string example: 1234faaf0678bcde - sharingadd_file_member_members: - type: object - properties: - ".tag": - type: string - example: email - email: - type: string - example: justin@example.com - sharing_add_file_member_body: + AddFileMemberArgs: type: object properties: access_level: @@ -12403,11 +12200,11 @@ components: - ".tag": email email: justin@example.com items: - $ref: '#/components/schemas/sharingadd_file_member_members' + $ref: '#/components/schemas/MemberSelector' quiet: type: boolean example: false - sharingadd_file_member_result: + FileMemberActionIndividualResult: type: object properties: ".tag": @@ -12417,10 +12214,10 @@ components: type: object properties: member: - $ref: '#/components/schemas/sharingadd_file_member_members' + $ref: '#/components/schemas/MemberSelector' result: - $ref: '#/components/schemas/sharingadd_file_member_result' - sharingadd_folder_member_member: + $ref: '#/components/schemas/FileMemberActionIndividualResult' + MemberSelector: type: object properties: ".tag": @@ -12432,15 +12229,15 @@ components: email: type: string example: justin@example.com - sharingadd_folder_member_members: + AddMember: type: object properties: access_level: type: string example: editor member: - $ref: '#/components/schemas/sharingadd_folder_member_member' - sharing_add_folder_member_body: + $ref: '#/components/schemas/MemberSelector' + AddFolderMemberArg: type: object properties: custom_message: @@ -12458,37 +12255,19 @@ components: ".tag": dropbox_id dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q items: - $ref: '#/components/schemas/sharingadd_folder_member_members' + $ref: '#/components/schemas/AddMember' quiet: type: boolean example: false shared_folder_id: type: string example: "84528192421" - sharing_check_job_status_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - sharing_check_remove_member_job_status_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 GenericResponseWithTag: type: object properties: ".tag": type: string example: complete - sharing_check_share_job_status_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 ShareFolderResponse: type: object properties: @@ -12498,7 +12277,7 @@ components: access_inheritance: $ref: '#/components/schemas/AccessInheritance' access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + $ref: '#/components/schemas/AclUpdatePolicy' is_inside_team_folder: type: boolean example: false @@ -12518,7 +12297,7 @@ components: example: [] items: {} policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + $ref: '#/components/schemas/FolderPolicy' preview_url: type: string example: https://www.dropbox.com/scl/fo/fir9vjelf @@ -12528,7 +12307,7 @@ components: time_invited: type: string example: 2016-01-20T00:00:00Z - sharing_get_file_metadata_body: + GetFileMetadataArg: type: object properties: actions: @@ -12538,45 +12317,7 @@ components: file: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw - GetFileMetadataResponse: - type: object - properties: - access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' - id: - type: string - example: id:3kmLmQFnf1AAAAAAAAAAAw - name: - type: string - example: file.txt - owner_display_names: - type: array - example: - - Jane Doe - items: - type: string - example: Jane Doe - owner_team: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' - path_display: - type: string - example: /dir/file.txt - path_lower: - type: string - example: /dir/file.txt - permissions: - type: array - example: [] - items: {} - policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' - preview_url: - type: string - example: https://www.dropbox.com/scl/fi/fir9vjelf - time_invited: - type: string - example: 2016-01-20T00:00:00Z - get_file_metadata_batch_body: + GetFileMetadataBatchArg: type: object properties: actions: @@ -12591,13 +12332,13 @@ components: items: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw - sharingget_file_metadatabatch_result_access_type: + AccessLevel: type: object properties: ".tag": type: string example: viewer - sharingget_file_metadatabatch_result_owner_team: + Team: type: object properties: id: @@ -12606,13 +12347,13 @@ components: name: type: string example: "Acme, Inc." - sharingget_file_metadatabatch_result_policy_acl_update_policy: + AclUpdatePolicy: type: object properties: ".tag": type: string example: owner - sharingget_file_metadatabatch_result_policy_member_policy: + MemberPolicy: type: object properties: ".tag": @@ -12624,25 +12365,25 @@ components: ".tag": type: string example: team - sharingget_file_metadatabatch_result_policy: + FolderPolicy: type: object properties: acl_update_policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + $ref: '#/components/schemas/AclUpdatePolicy' member_policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' + $ref: '#/components/schemas/MemberPolicy' resolved_member_policy: $ref: '#/components/schemas/SharedFolderMemberPolicy' shared_link_policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' - sharingget_file_metadatabatch_result: + $ref: '#/components/schemas/MemberPolicy' + SharedFileMetadataWithTag: type: object properties: ".tag": type: string example: metadata access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + $ref: '#/components/schemas/AccessLevel' id: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw @@ -12657,7 +12398,7 @@ components: type: string example: Jane Doe owner_team: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + $ref: '#/components/schemas/Team' path_display: type: string example: /dir/file.txt @@ -12669,22 +12410,22 @@ components: example: [] items: {} policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + $ref: '#/components/schemas/FolderPolicy' preview_url: type: string example: https://www.dropbox.com/scl/fi/fir9vjelf time_invited: type: string example: 2016-01-20T00:00:00Z - GetFileMetadataIndicidualResult: + GetFileMetadataIndividualResult: type: object properties: file: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw result: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result' - sharing_get_folder_metadata_body: + $ref: '#/components/schemas/SharedFileMetadataWithTag' + GetMetadataArgs: type: object properties: actions: @@ -12700,7 +12441,7 @@ components: access_inheritance: $ref: '#/components/schemas/AccessInheritance' access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + $ref: '#/components/schemas/AclUpdatePolicy' is_inside_team_folder: type: boolean example: false @@ -12720,7 +12461,7 @@ components: example: [] items: {} policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + $ref: '#/components/schemas/FolderPolicy' preview_url: type: string example: https://www.dropbox.com/scl/fo/fir9vjelf @@ -12764,7 +12505,7 @@ components: url: type: string example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - sharing_get_shared_link_metadata_body: + GetSharedLinkMetadataArg: type: object properties: path: @@ -12773,7 +12514,7 @@ components: url: type: string example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - sharing_list_file_members_body: + ListFileMembersArg: type: object properties: file: @@ -12807,7 +12548,7 @@ components: is_inherited: false permissions: [] items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + $ref: '#/components/schemas/GroupInfos' invitees: type: array example: @@ -12819,7 +12560,7 @@ components: is_inherited: false permissions: [] items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + $ref: '#/components/schemas/InviteeMembershipInfo' users: type: array example: @@ -12837,8 +12578,8 @@ components: same_team: true team_member_id: dbmid:abcd1234 items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_users' - list_file_members_batch_body: + $ref: '#/components/schemas/UserFileMembershipInfo' + ListFileMembersBatchArg: type: object properties: files: @@ -12852,31 +12593,25 @@ components: limit: type: number example: 10 - sharinglist_file_membersbatch_result_members_access_type: - type: object - properties: - ".tag": - type: string - example: editor - sharinglist_file_membersbatch_result_members_group_group_management_type: + GroupManagementType: type: object properties: ".tag": type: string example: user_managed - sharinglist_file_membersbatch_result_members_group: + GroupInfo: type: object properties: group_id: type: string example: g:e2db7665347abcd600000000001a2b3c group_management_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + $ref: '#/components/schemas/GroupManagementType' group_name: type: string example: Test group group_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + $ref: '#/components/schemas/GroupManagementType' is_member: type: boolean example: false @@ -12889,13 +12624,13 @@ components: same_team: type: boolean example: true - sharinglist_file_membersbatch_result_members_groups: + GroupInfos: type: object properties: access_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_access_type' + $ref: '#/components/schemas/AccessLevel' group: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group' + $ref: '#/components/schemas/GroupInfo' is_inherited: type: boolean example: false @@ -12903,7 +12638,7 @@ components: type: array example: [] items: {} - sharinglist_file_membersbatch_result_members_invitee: + InviteeInfo: type: object properties: ".tag": @@ -12912,13 +12647,13 @@ components: email: type: string example: jessica@example.com - sharinglist_file_membersbatch_result_members_invitees: + InviteeMembershipInfo: type: object properties: access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + $ref: '#/components/schemas/AccessLevel' invitee: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitee' + $ref: '#/components/schemas/InviteeInfo' is_inherited: type: boolean example: false @@ -12926,13 +12661,13 @@ components: type: array example: [] items: {} - sharinglist_file_membersbatch_result_members_platform_type: + PlatformType: type: object properties: ".tag": type: string example: unknown - sharinglist_file_membersbatch_result_members_user: + UserInfo: type: object properties: account_id: @@ -12950,11 +12685,11 @@ components: team_member_id: type: string example: dbmid:abcd1234 - sharinglist_file_membersbatch_result_members_users: + UserFileMembershipInfo: type: object properties: access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + $ref: '#/components/schemas/AclUpdatePolicy' is_inherited: type: boolean example: false @@ -12963,66 +12698,13 @@ components: example: [] items: {} platform_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_platform_type' + $ref: '#/components/schemas/PlatformType' time_last_seen: type: string example: 2016-01-20T00:00:00Z user: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_user' - sharinglist_file_membersbatch_result_members: - type: object - properties: - groups: - type: array - example: - - access_type: - ".tag": editor - group: - group_id: g:e2db7665347abcd600000000001a2b3c - group_management_type: - ".tag": user_managed - group_name: Test group - group_type: - ".tag": user_managed - is_member: false - is_owner: false - member_count: 10 - same_team: true - is_inherited: false - permissions: [] - items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' - invitees: - type: array - example: - - access_type: - ".tag": viewer - invitee: - ".tag": email - email: jessica@example.com - is_inherited: false - permissions: [] - items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' - users: - type: array - example: - - access_type: - ".tag": owner - is_inherited: false - permissions: [] - platform_type: - ".tag": unknown - time_last_seen: 2016-01-20T00:00:00Z - user: - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc - display_name: Robert Smith - email: bob@example.com - same_team: true - team_member_id: dbmid:abcd1234 - items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_users' - sharinglist_file_membersbatch_result: + $ref: '#/components/schemas/UserInfo' + ListFileMembersCountResult: type: object properties: ".tag": @@ -13032,7 +12714,7 @@ components: type: number example: 3 members: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members' + $ref: '#/components/schemas/SharedFileMembers' ListFileMembersIndividualResult: type: object properties: @@ -13040,14 +12722,14 @@ components: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw result: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result' - list_file_members_continue_body: + $ref: '#/components/schemas/ListFileMembersCountResult' + ListFileMembersContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - list_folder_members_continue_body: + ListFolderMembersContinueArg: type: object properties: cursor: @@ -13078,7 +12760,7 @@ components: is_inherited: false permissions: [] items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + $ref: '#/components/schemas/GroupInfos' invitees: type: array example: @@ -13090,7 +12772,7 @@ components: is_inherited: false permissions: [] items: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + $ref: '#/components/schemas/InviteeMembershipInfo' users: type: array example: @@ -13106,7 +12788,7 @@ components: team_member_id: dbmid:abcd1234 items: $ref: '#/components/schemas/UserMembershipInfo' - sharing_list_folders_body: + ListFoldersArgs: type: object properties: actions: @@ -13161,29 +12843,13 @@ components: time_invited: 2016-01-20T00:00:00Z items: $ref: '#/components/schemas/SharedFolderMetadata' - list_folders_continue_body: - type: object - properties: - cursor: - type: string - example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - sharing_list_mountable_folders_body: - type: object - properties: - actions: - type: array - example: [] - items: {} - limit: - type: number - example: 100 - list_mountable_folders_continue_body: + ListFoldersContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - sharing_list_received_files_body: + ListFilesArg: type: object properties: actions: @@ -13193,7 +12859,7 @@ components: limit: type: number example: 100 - ListReceivedFilesResponse: + ListFilesResult: type: object properties: cursor: @@ -13227,13 +12893,13 @@ components: time_invited: 2016-01-20T00:00:00Z items: $ref: '#/components/schemas/SharedFileMetadata' - list_received_files_continue_body: + ListFilesContinueArg: type: object properties: cursor: type: string example: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId - sharing_list_shared_links_body: + ListSharedLinksArg: type: object properties: cursor: @@ -13274,7 +12940,7 @@ components: url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 items: $ref: '#/components/schemas/SharedLinkMetadata' - sharingmodify_shared_link_settings_settings: + SharedLinkSettings: type: object properties: access: @@ -13286,30 +12952,30 @@ components: requested_visibility: type: string example: public - sharing_modify_shared_link_settings_body: + ModifySharedLinkSettingsArgs: type: object properties: remove_expiration: type: boolean example: false settings: - $ref: '#/components/schemas/sharingmodify_shared_link_settings_settings' + $ref: '#/components/schemas/SharedLinkSettings' url: type: string example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - sharing_mount_folder_body: + MountFolderArg: type: object properties: shared_folder_id: type: string example: "84528192421" - sharing_relinquish_file_membership_body: + RelinquishFileMembershipArg: type: object properties: file: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw - sharing_relinquish_folder_membership_body: + RelinquishFolderMembershipArg: type: object properties: leave_a_copy: @@ -13318,28 +12984,28 @@ components: shared_folder_id: type: string example: "84528192421" - sharing_remove_file_member_2_body: + RemoveFileMemberArg: type: object properties: file: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw member: - $ref: '#/components/schemas/sharingadd_file_member_members' + $ref: '#/components/schemas/MemberSelector' CustomQuotaResponse: type: object properties: ".tag": type: string example: other - sharing_remove_folder_member_body: + RemoveFolderMemberArg: type: object properties: leave_a_copy: type: boolean example: false member: - $ref: '#/components/schemas/sharingadd_file_member_members' + $ref: '#/components/schemas/MemberSelector' shared_folder_id: type: string example: "84528192421" @@ -13352,13 +13018,13 @@ components: async_job_id: type: string example: 34g93hh34h04y384084 - sharing_revoke_shared_link_body: + RevokeSharedLinkArg: type: object properties: url: type: string example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 - sharing_set_access_inheritance_body: + SetAccessInheritanceArg: type: object properties: access_inheritance: @@ -13367,7 +13033,7 @@ components: shared_folder_id: type: string example: "84528192421" - sharing_share_folder_body: + ShareFolderArg: type: object properties: access_inheritance: @@ -13388,7 +13054,7 @@ components: shared_link_policy: type: string example: members - sharing_transfer_folder_body: + TransferFolderArg: type: object properties: shared_folder_id: @@ -13397,19 +13063,19 @@ components: to_dropbox_id: type: string example: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q - sharing_unmount_folder_body: + UnmountFolderArg: type: object properties: shared_folder_id: type: string example: "84528192421" - UnshareFileRequest: + UnshareFileArg: type: object properties: file: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw - sharing_unshare_folder_body: + UnshareFolderArg: type: object properties: leave_a_copy: @@ -13418,7 +13084,7 @@ components: shared_folder_id: type: string example: "84528192421" - sharing_update_file_member_body: + UpdateFileMemberArgs: type: object properties: access_level: @@ -13428,19 +13094,19 @@ components: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw member: - $ref: '#/components/schemas/sharingadd_file_member_members' - sharing_update_folder_member_body: + $ref: '#/components/schemas/MemberSelector' + UpdateFolderMemberArg: type: object properties: access_level: type: string example: editor member: - $ref: '#/components/schemas/sharingadd_file_member_members' + $ref: '#/components/schemas/MemberSelector' shared_folder_id: type: string example: "84528192421" - sharing_update_folder_policy_body: + UpdateFolderPolicyArg: type: object properties: acl_update_policy: @@ -13455,7 +13121,7 @@ components: shared_link_policy: type: string example: members - devices_list_member_devices_body: + ListMemberDevicesArg: type: object properties: include_desktop_clients: @@ -13470,7 +13136,7 @@ components: team_member_id: type: string example: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - devices_revoke_device_session_body: + RevokeDeviceSessionArg: type: object properties: ".tag": @@ -13482,7 +13148,7 @@ components: team_member_id: type: string example: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU - devices_revoke_device_session_batch_body: + RevokeDeviceSessionBatchArg: type: object properties: revoke_devices: @@ -13492,8 +13158,8 @@ components: session_id: 1234faaf0678bcde team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU items: - $ref: '#/components/schemas/devices_revoke_device_session_body' - groups_create_body: + $ref: '#/components/schemas/RevokeDeviceSessionArg' + GroupCreateArg: type: object properties: add_creator_as_owner: @@ -13515,7 +13181,7 @@ components: type: string example: g:e2db7665347abcd600000000001a2b3c group_management_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + $ref: '#/components/schemas/GroupManagementType' group_name: type: string example: project launch @@ -13552,8 +13218,8 @@ components: ".tag": active team_member_id: dbmid:1234567 items: - $ref: '#/components/schemas/teamgroupsget_info_members' - groups_delete_body: + $ref: '#/components/schemas/GroupMemberInfo' + GroupSelector: type: object properties: ".tag": @@ -13562,7 +13228,7 @@ components: group_id: type: string example: g:e2db7665347abcd600000000001a2b3c - groups_get_info_body: + GroupsSelector: type: object properties: ".tag": @@ -13576,19 +13242,19 @@ components: items: type: string example: g:e2db7665347abcd600000000001a2b3c - teamgroupsget_info_access_type: + GroupAccessType: type: object properties: ".tag": type: string example: member - teamgroupsget_info_profile_membership_type: + TeamMembershipType: type: object properties: ".tag": type: string example: full - teamgroupsget_info_profile_name: + Name: type: object properties: abbreviated_name: @@ -13606,7 +13272,7 @@ components: surname: type: string example: Ferdinand - teamgroupsget_info_profile_secondary_emails: + SecondaryEmail: type: object properties: email: @@ -13615,13 +13281,13 @@ components: is_verified: type: boolean example: true - teamgroupsget_info_profile_status: + TeamMemberStatus: type: object properties: ".tag": type: string example: active - teamgroupsget_info_profile: + MemberProfile: type: object properties: account_id: @@ -13637,9 +13303,9 @@ components: type: string example: 2015-05-12T15:50:38Z membership_type: - $ref: '#/components/schemas/teamgroupsget_info_profile_membership_type' + $ref: '#/components/schemas/TeamMembershipType' name: - $ref: '#/components/schemas/teamgroupsget_info_profile_name' + $ref: '#/components/schemas/Name' profile_photo_url: type: string example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 @@ -13653,19 +13319,19 @@ components: - email: grape@strawberry.com is_verified: false items: - $ref: '#/components/schemas/teamgroupsget_info_profile_secondary_emails' + $ref: '#/components/schemas/SecondaryEmail' status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' + $ref: '#/components/schemas/TeamMemberStatus' team_member_id: type: string example: dbmid:1234567 - teamgroupsget_info_members: + GroupMemberInfo: type: object properties: access_type: - $ref: '#/components/schemas/teamgroupsget_info_access_type' + $ref: '#/components/schemas/GroupAccessType' profile: - $ref: '#/components/schemas/teamgroupsget_info_profile' + $ref: '#/components/schemas/MemberProfile' GroupsGetInfoItem: type: object properties: @@ -13679,7 +13345,7 @@ components: type: string example: g:e2db7665347abcd600000000001a2b3c group_management_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + $ref: '#/components/schemas/GroupManagementType' group_name: type: string example: project launch @@ -13716,14 +13382,8 @@ components: ".tag": active team_member_id: dbmid:1234567 items: - $ref: '#/components/schemas/teamgroupsget_info_members' - job_status_get_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - groups_list_body: + $ref: '#/components/schemas/GroupMemberInfo' + GroupsListArg: type: object properties: limit: @@ -13748,13 +13408,13 @@ components: has_more: type: boolean example: false - list_continue_body_1: + GroupsListContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - teamgroupsmembersadd_user: + UserSelectorArg: type: object properties: ".tag": @@ -13763,19 +13423,19 @@ components: team_member_id: type: string example: dbmid:efgh5678 - teamgroupsmembersadd_members: + MemberAccess: type: object properties: access_type: type: string example: member user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - members_add_body: + $ref: '#/components/schemas/UserSelectorArg' + GroupMembersAddArg: type: object properties: group: - $ref: '#/components/schemas/groups_delete_body' + $ref: '#/components/schemas/GroupSelector' members: type: array example: @@ -13784,7 +13444,7 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teamgroupsmembersadd_members' + $ref: '#/components/schemas/MemberAccess' return_members: type: boolean example: true @@ -13796,11 +13456,11 @@ components: example: "99988877733388" group_info: $ref: '#/components/schemas/GroupFullInfo' - members_list_body: + GroupsMembersListArg: type: object properties: group: - $ref: '#/components/schemas/groups_delete_body' + $ref: '#/components/schemas/GroupSelector' limit: type: number example: 100 @@ -13817,17 +13477,17 @@ components: type: array example: [] items: {} - list_continue_body_2: + GroupsMembersListContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - members_remove_body: + GroupMembersRemoveArg: type: object properties: group: - $ref: '#/components/schemas/groups_delete_body' + $ref: '#/components/schemas/GroupSelector' return_members: type: boolean example: true @@ -13837,25 +13497,25 @@ components: - ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - members_set_access_type_body: + $ref: '#/components/schemas/UserSelectorArg' + GroupMembersSetAccessTypeArg: type: object properties: access_type: type: string example: member group: - $ref: '#/components/schemas/groups_delete_body' + $ref: '#/components/schemas/GroupSelector' return_members: type: boolean example: true user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - groups_update_body: + $ref: '#/components/schemas/UserSelectorArg' + GroupUpdateArgs: type: object properties: group: - $ref: '#/components/schemas/groups_delete_body' + $ref: '#/components/schemas/GroupSelector' new_group_external_id: type: string example: sales-234 @@ -13868,7 +13528,7 @@ components: return_members: type: boolean example: true - legal_holds_create_policy_body: + LegalHoldsPolicyCreateArg: type: object properties: end_date: @@ -13908,14 +13568,14 @@ components: type: string example: 2016-01-01T00:00:00Z status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' - legal_holds_get_policy_body: + $ref: '#/components/schemas/TeamMemberStatus' + LegalHoldsGetPolicyArg: type: object properties: id: type: string example: pid_dbhid:abcd1234 - legal_holds_list_held_revisions_body: + LegalHoldsListHeldRevisionsArg: type: object properties: id: @@ -13943,13 +13603,13 @@ components: has_more: type: boolean example: false - legal_holds_list_held_revisions_continue_body: + LegalHoldsListHeldRevisionsContinueArg: type: object properties: id: type: string example: pid_dbhid:abcd1234 - legal_holds_list_policies_body: + LegalHoldsListPoliciesArg: type: object properties: include_released: @@ -13974,13 +13634,13 @@ components: ".tag": active items: $ref: '#/components/schemas/LegalHoldPolicyAsResponse' - legal_holds_release_policy_body: + LegalHoldsPolicyReleaseArg: type: object properties: id: type: string example: pid_dbhid:abcd1234 - legal_holds_update_policy_body: + LegalHoldsPolicyUpdateArg: type: object properties: id: @@ -13993,13 +13653,13 @@ components: items: type: string example: dbmid:FDFSVF-DFSDF - linked_apps_list_member_linked_apps_body: + ListMemberAppsArg: type: object properties: team_member_id: type: string example: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I - excluded_users_add_body: + ExcludedUsersUpdateArg: type: object properties: users: @@ -14008,13 +13668,13 @@ components: - ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teamgroupsmembersadd_user' + $ref: '#/components/schemas/UserSelectorArg' ExcludedUsersUpdateResult: type: object properties: status: - $ref: '#/components/schemas/sharingadd_file_member_result' - excluded_users_list_body: + $ref: '#/components/schemas/FileMemberActionIndividualResult' + ExcludedUsersListArg: type: object properties: limit: @@ -14033,13 +13693,13 @@ components: type: array example: [] items: {} - list_continue_body_3: + ExcludedUsersListContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - excluded_users_remove_body: + CustomQuotaUsersArg: type: object properties: users: @@ -14048,36 +13708,16 @@ components: - ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - member_space_limits_get_custom_quota_body: - type: object - properties: - users: - type: array - example: - - ".tag": team_member_id - team_member_id: dbmid:efgh5678 - items: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - member_space_limits_remove_custom_quota_body: - type: object - properties: - users: - type: array - example: - - ".tag": team_member_id - team_member_id: dbmid:efgh5678 - items: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - teammember_space_limitsset_custom_quota_users_and_quotas: + $ref: '#/components/schemas/UserSelectorArg' + UserCustomQuotaArg: type: object properties: quota_gb: type: number example: 30 user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - member_space_limits_set_custom_quota_body: + $ref: '#/components/schemas/UserSelectorArg' + SetCustomQuotaArg: type: object properties: users_and_quotas: @@ -14088,8 +13728,8 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teammember_space_limitsset_custom_quota_users_and_quotas' - teammembersadd_new_members: + $ref: '#/components/schemas/UserCustomQuotaArg' + MemberAddV2Arg: type: object properties: member_email: @@ -14110,7 +13750,7 @@ components: send_welcome_email: type: boolean example: true - members_add_body_1: + MembersAddV2Arg: type: object properties: force_async: @@ -14126,7 +13766,7 @@ components: role: member_only send_welcome_email: true items: - $ref: '#/components/schemas/teammembersadd_new_members' + $ref: '#/components/schemas/MemberAddV2Arg' MembersAddResult: type: object properties: @@ -14167,25 +13807,19 @@ components: ".tag": member_only items: $ref: '#/components/schemas/MemberAddResult' - job_status_get_body_1: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - members_delete_profile_photo_body: + MembersDeleteProfilePhotoArg: type: object properties: user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' + $ref: '#/components/schemas/UserSelectorArg' TeamMemberInfoV2Result: type: object properties: profile: - $ref: '#/components/schemas/teammembersget_info_profile' + $ref: '#/components/schemas/TeamMemberProfile' role: - $ref: '#/components/schemas/teammembersget_info_role' - members_get_info_body: + $ref: '#/components/schemas/AdminTier' + MembersGetInfoV2Arg: type: object properties: members: @@ -14194,17 +13828,8 @@ components: - ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - teammembersget_info_profile_secondary_emails: - type: object - properties: - email: - type: string - example: grape@strawberry.com - is_verified: - type: boolean - example: false - teammembersget_info_profile: + $ref: '#/components/schemas/UserSelectorArg' + TeamMemberProfile: type: object properties: account_id: @@ -14233,9 +13858,9 @@ components: type: string example: "20" membership_type: - $ref: '#/components/schemas/teamgroupsget_info_profile_membership_type' + $ref: '#/components/schemas/TeamMembershipType' name: - $ref: '#/components/schemas/teamgroupsget_info_profile_name' + $ref: '#/components/schemas/Name' profile_photo_url: type: string example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 @@ -14247,13 +13872,13 @@ components: - email: apple@orange.com is_verified: true items: - $ref: '#/components/schemas/teammembersget_info_profile_secondary_emails' + $ref: '#/components/schemas/SecondaryEmail' status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' + $ref: '#/components/schemas/TeamMemberStatus' team_member_id: type: string example: dbmid:FDFSVF-DFSDF - teammembersget_info_role: + AdminTier: type: object properties: ".tag": @@ -14266,10 +13891,10 @@ components: type: string example: member_info profile: - $ref: '#/components/schemas/teammembersget_info_profile' + $ref: '#/components/schemas/TeamMemberProfile' role: - $ref: '#/components/schemas/teammembersget_info_role' - members_list_body_1: + $ref: '#/components/schemas/AdminTier' + MembersListArg: type: object properties: include_removed: @@ -14320,33 +13945,27 @@ components: ".tag": member_only items: $ref: '#/components/schemas/TeamMemberInfoV2Result' - list_continue_body_4: + MembersListContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - members_move_former_member_files_body: + MembersDataTransferArg: type: object properties: transfer_admin_id: - $ref: '#/components/schemas/teamgroupsmembersadd_user' + $ref: '#/components/schemas/UserSelectorArg' transfer_dest_id: - $ref: '#/components/schemas/teamgroupsmembersadd_user' + $ref: '#/components/schemas/UserSelectorArg' user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - job_status_check_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - members_recover_body: + $ref: '#/components/schemas/UserSelectorArg' + MembersRecoverArg: type: object properties: user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - members_remove_body_1: + $ref: '#/components/schemas/UserSelectorArg' + MembersRemoveArg: type: object properties: keep_account: @@ -14356,21 +13975,15 @@ components: type: boolean example: false transfer_admin_id: - $ref: '#/components/schemas/teamgroupsmembersadd_user' + $ref: '#/components/schemas/UserSelectorArg' transfer_dest_id: - $ref: '#/components/schemas/teamgroupsmembersadd_user' + $ref: '#/components/schemas/UserSelectorArg' user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' + $ref: '#/components/schemas/UserSelectorArg' wipe_data: type: boolean example: true - job_status_get_body_2: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - teammemberssecondary_emailsadd_new_secondary_emails: + UserSecondaryEmailsArg: type: object properties: secondary_emails: @@ -14382,8 +13995,8 @@ components: type: string example: bob2@hotmail.com user: - $ref: '#/components/schemas/teamgroupsmembersadd_user' - secondary_emails_add_body: + $ref: '#/components/schemas/UserSelectorArg' + AddSecondaryEmailsArg: type: object properties: new_secondary_emails: @@ -14396,7 +14009,7 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + $ref: '#/components/schemas/UserSecondaryEmailsArg' AddSecondaryEmailsResult: type: object properties: @@ -14420,7 +14033,7 @@ components: team_member_id: dbmid:efgh5678 items: $ref: '#/components/schemas/UserAddResult' - secondary_emails_delete_body: + DeleteSecondaryEmailsArg: type: object properties: emails_to_delete: @@ -14433,7 +14046,7 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + $ref: '#/components/schemas/UserSecondaryEmailsArg' DeleteSecondaryEmailsResult: type: object properties: @@ -14451,7 +14064,7 @@ components: team_member_id: dbmid:efgh5678 items: $ref: '#/components/schemas/UserDeleteResult' - secondary_emails_resend_verification_emails_body: + ResendVerificationEmailArg: type: object properties: emails_to_resend: @@ -14464,7 +14077,7 @@ components: ".tag": team_member_id team_member_id: dbmid:efgh5678 items: - $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + $ref: '#/components/schemas/UserSecondaryEmailsArg' ResendVerificationEmailResult: type: object properties: @@ -14480,32 +14093,23 @@ components: team_member_id: dbmid:efgh5678 items: $ref: '#/components/schemas/UserResendResult' - members_send_welcome_email_body: - type: object - properties: - ".tag": - type: string - example: team_member_id - team_member_id: - type: string - example: dbmid:efgh5678 - members_set_admin_permissions_body: + MembersSetPermissions2Arg: type: object properties: new_role: type: string example: member_only user: - $ref: '#/components/schemas/members_send_welcome_email_body' - SetAdminPermissionsResult: + $ref: '#/components/schemas/UserSelectorArg' + MembersSetPermissionsResult: type: object properties: role: - $ref: '#/components/schemas/teammembersget_info_role' + $ref: '#/components/schemas/AdminTier' team_member_id: type: string example: dbmid:9978889 - members_set_profile_body: + MembersSetProfileArg: type: object properties: new_email: @@ -14515,28 +14119,28 @@ components: type: string example: Smith user: - $ref: '#/components/schemas/members_send_welcome_email_body' - members_set_profile_photo_body: + $ref: '#/components/schemas/UserSelectorArg' + MembersSetProfilePhotoArg: type: object properties: photo: $ref: '#/components/schemas/Photo' user: - $ref: '#/components/schemas/members_send_welcome_email_body' - members_suspend_body: + $ref: '#/components/schemas/UserSelectorArg' + MembersDeactivateArg: type: object properties: user: - $ref: '#/components/schemas/members_send_welcome_email_body' + $ref: '#/components/schemas/UserSelectorArg' wipe_data: type: boolean example: false - members_unsuspend_body: + MembersUnsuspendArg: type: object properties: user: - $ref: '#/components/schemas/members_send_welcome_email_body' - namespaces_list_body: + $ref: '#/components/schemas/UserSelectorArg' + TeamNamespacesListArg: type: object properties: limit: @@ -14565,13 +14169,13 @@ components: team_member_id: dbmid:1234567 items: $ref: '#/components/schemas/NamespaceMetadata' - list_continue_body_5: + TeamNamespacesListContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - team_folder_activate_body: + TeamFolderIdArg: type: object properties: team_folder_id: @@ -14595,13 +14199,13 @@ components: type: string example: Marketing status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' + $ref: '#/components/schemas/TeamMemberStatus' sync_setting: $ref: '#/components/schemas/SyncSetting' team_folder_id: type: string example: "123456789" - team_folder_archive_body: + TeamFolderArchiveArg: type: object properties: force_async_off: @@ -14631,19 +14235,13 @@ components: type: string example: Marketing status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' + $ref: '#/components/schemas/TeamMemberStatus' sync_setting: $ref: '#/components/schemas/SyncSetting' team_folder_id: type: string example: "123456789" - archive_check_body: - type: object - properties: - async_job_id: - type: string - example: 34g93hh34h04y384084 - team_folder_create_body: + TeamFolderCreateArg: type: object properties: name: @@ -14652,7 +14250,7 @@ components: sync_setting: type: string example: not_synced - team_folder_get_info_body: + TeamFolderIdListArg: type: object properties: team_folder_ids: @@ -14664,7 +14262,7 @@ components: items: type: string example: "947182" - team_folder_list_body: + TeamFolderListArg: type: object properties: limit: @@ -14695,19 +14293,13 @@ components: team_folder_id: "123456789" items: $ref: '#/components/schemas/TeamFolderMetadata' - list_continue_body_6: + TeamFolderListContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - team_folder_permanently_delete_body: - type: object - properties: - team_folder_id: - type: string - example: "123456789" - team_folder_rename_body: + TeamFolderRenameArg: type: object properties: name: @@ -14716,7 +14308,7 @@ components: team_folder_id: type: string example: "123456789" - teamteam_folderupdate_sync_settings_content_sync_settings: + ContentSyncSettingArg: type: object properties: id: @@ -14725,7 +14317,7 @@ components: sync_setting: type: string example: not_synced - team_folder_update_sync_settings_body: + TeamFolderUpdateSyncSettingsArg: type: object properties: content_sync_settings: @@ -14734,20 +14326,20 @@ components: - id: id:a4ayc_80_OEAAAAAAAAAXw sync_setting: not_synced items: - $ref: '#/components/schemas/teamteam_folderupdate_sync_settings_content_sync_settings' + $ref: '#/components/schemas/ContentSyncSettingArg' sync_setting: type: string example: not_synced team_folder_id: type: string example: "123456789" - teamfeaturesget_values_features: + Feature: type: object properties: ".tag": type: string example: upload_api_rate_limit - features_get_values_body: + FeaturesGetValuesBatchArg: type: object properties: features: @@ -14756,8 +14348,8 @@ components: - ".tag": upload_api_rate_limit - ".tag": has_team_shared_dropbox items: - $ref: '#/components/schemas/teamfeaturesget_values_features' - FeaturesGetValuesResponse: + $ref: '#/components/schemas/Feature' + FeaturesGetValuesBatchResult: type: object properties: values: @@ -14773,7 +14365,7 @@ components: has_team_shared_dropbox: false items: $ref: '#/components/schemas/FeatureValue' - TeamGetInfoResponse: + TeamGetInfoResult: type: object properties: name: @@ -14794,8 +14386,8 @@ components: type: object properties: admin_profile: - $ref: '#/components/schemas/teammembersget_info_profile' - team_log_get_events_body: + $ref: '#/components/schemas/TeamMemberProfile' + GetTeamEventsArg: type: object properties: category: @@ -14892,19 +14484,19 @@ components: has_more: type: boolean example: false - get_events_continue_body: + GetTeamEventsContinueArg: type: object properties: cursor: type: string example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu - usersfeaturesget_values_features: + UserFeature: type: object properties: ".tag": type: string example: paper_as_files - features_get_values_body_1: + UserFeaturesGetValuesBatchArg: type: object properties: features: @@ -14913,7 +14505,7 @@ components: - ".tag": paper_as_files - ".tag": file_locking items: - $ref: '#/components/schemas/usersfeaturesget_values_features' + $ref: '#/components/schemas/UserFeature' UserFeaturesGetValuesResult: type: object properties: @@ -14926,7 +14518,7 @@ components: enabled: true items: $ref: '#/components/schemas/UserFeatureValue' - users_get_account_body: + GetAccountArg: type: object properties: account_id: @@ -14951,11 +14543,11 @@ components: type: boolean example: false name: - $ref: '#/components/schemas/teamgroupsget_info_profile_name' + $ref: '#/components/schemas/Name' profile_photo_url: type: string example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 - users_get_account_batch_body: + GetAccountBatchArg: type: object properties: account_ids: @@ -14993,7 +14585,7 @@ components: type: string example: en name: - $ref: '#/components/schemas/teamgroupsget_info_profile_name' + $ref: '#/components/schemas/Name' referral_link: type: string example: https://db.tt/ZITNuhtI @@ -15004,7 +14596,7 @@ components: team_member_id: type: string example: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU - GetSpaceUsageResponse: + SpaceUsage: type: object properties: allocation: @@ -15217,7 +14809,7 @@ components: $ref: '#/components/schemas/PropertyGroup' sharing_info: $ref: '#/components/schemas/FolderSharingInfo' - CreateFolderBatchResponseEntry: + CreateFolderBatchResultEntry: type: object properties: ".tag": @@ -15233,7 +14825,7 @@ components: example: success metadata: $ref: '#/components/schemas/MetadataAsResponse' - ExportFileResponseMetadata: + ExportMetadata: type: object properties: export_hash: @@ -15500,12 +15092,12 @@ components: type: string example: dbmid:abcd1234 team_info: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + $ref: '#/components/schemas/Team' UserMembershipInfo: type: object properties: access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + $ref: '#/components/schemas/AclUpdatePolicy' is_inherited: type: boolean example: false @@ -15514,12 +15106,12 @@ components: example: [] items: {} user: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_user' + $ref: '#/components/schemas/UserInfo' SharedFileMetadata: type: object properties: access_type: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + $ref: '#/components/schemas/AccessLevel' id: type: string example: id:3kmLmQFnf1AAAAAAAAAAAw @@ -15534,7 +15126,7 @@ components: type: string example: Jane Doe owner_team: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + $ref: '#/components/schemas/Team' path_display: type: string example: /dir/file.txt @@ -15546,7 +15138,7 @@ components: example: [] items: {} policy: - $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + $ref: '#/components/schemas/FolderPolicy' preview_url: type: string example: https://www.dropbox.com/scl/fi/fir9vjelf @@ -15560,7 +15152,7 @@ components: type: string example: g:e2db7665347abcd600000000001a2b3c group_management_type: - $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + $ref: '#/components/schemas/GroupManagementType' group_name: type: string example: Test group @@ -15590,7 +15182,7 @@ components: type: string example: dbmid:abcd1234abcd1234abcd1234abcd1234a23 author_member_status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' + $ref: '#/components/schemas/TeamMemberStatus' content_hash: type: string example: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 @@ -15633,7 +15225,7 @@ components: type: string example: 2016-01-01T00:00:00Z status: - $ref: '#/components/schemas/teamgroupsget_info_profile_status' + $ref: '#/components/schemas/TeamMemberStatus' MemberAddResult: type: object properties: @@ -15641,9 +15233,9 @@ components: type: string example: success profile: - $ref: '#/components/schemas/teammembersget_info_profile' + $ref: '#/components/schemas/TeamMemberProfile' role: - $ref: '#/components/schemas/teammembersget_info_role' + $ref: '#/components/schemas/AdminTier' AddSecondaryEmailResult: type: object properties: @@ -15651,7 +15243,7 @@ components: type: string example: success success: - $ref: '#/components/schemas/teamgroupsget_info_profile_secondary_emails' + $ref: '#/components/schemas/SecondaryEmail' unavailable: type: string example: alice@example.com @@ -15662,7 +15254,7 @@ components: type: string example: success invalid_user: - $ref: '#/components/schemas/members_send_welcome_email_body' + $ref: '#/components/schemas/UserSelectorArg' results: type: array example: @@ -15675,7 +15267,7 @@ components: items: $ref: '#/components/schemas/AddSecondaryEmailResult' user: - $ref: '#/components/schemas/members_send_welcome_email_body' + $ref: '#/components/schemas/UserSelectorArg' DeleteSecondaryEmailResult: type: object properties: @@ -15704,7 +15296,7 @@ components: items: $ref: '#/components/schemas/DeleteSecondaryEmailResult' user: - $ref: '#/components/schemas/members_send_welcome_email_body' + $ref: '#/components/schemas/UserSelectorArg' ResendSecondaryEmailResult: type: object properties: @@ -15728,7 +15320,7 @@ components: items: $ref: '#/components/schemas/ResendSecondaryEmailResult' user: - $ref: '#/components/schemas/members_send_welcome_email_body' + $ref: '#/components/schemas/UserSelectorArg' NamespaceType: type: object properties: From 3652bef5e655b2674a8a5fa404911471f1599be6 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Thu, 31 Oct 2024 18:04:07 +0530 Subject: [PATCH 15/15] Update docs/spec/sanitations.md Co-authored-by: Sumudu Nissanka --- docs/spec/sanitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 3787be0..bbb8efe 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -32,6 +32,6 @@ These changes are done in order to improve the overall usability, and as workaro The following command was used to generate the Ballerina client from the OpenAPI specification. The command should be executed from the repository root directory. ```bash -bal openapi -i docs/spec/openapi.json --mode client --license docs/license.txt -o ballerina +bal openapi -i docs/spec/openapi.yaml --mode client --license docs/license.txt -o ballerina ``` Note: The license year is hardcoded to 2024, change if necessary.