files.com 1.2.509 → 1.2.511

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -599,6 +599,7 @@ Error
599
599
  | `BadRequest_CantMoveWithMultipleLocationsError`| `BadRequestError` |
600
600
  | `BadRequest_DatetimeParseError`| `BadRequestError` |
601
601
  | `BadRequest_DestinationSameError`| `BadRequestError` |
602
+ | `BadRequest_DestinationSiteMismatchError`| `BadRequestError` |
602
603
  | `BadRequest_DoesNotSupportSortingError`| `BadRequestError` |
603
604
  | `BadRequest_FolderMustNotBeAFileError`| `BadRequestError` |
604
605
  | `BadRequest_FoldersNotAllowedError`| `BadRequestError` |
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.509
1
+ 1.2.511
package/docs/Errors.md CHANGED
@@ -53,6 +53,7 @@ These errors are derived from the error groups listed above.
53
53
  ### BadRequest_CantMoveWithMultipleLocationsError
54
54
  ### BadRequest_DatetimeParseError
55
55
  ### BadRequest_DestinationSameError
56
+ ### BadRequest_DestinationSiteMismatchError
56
57
  ### BadRequest_DoesNotSupportSortingError
57
58
  ### BadRequest_FolderMustNotBeAFileError
58
59
  ### BadRequest_FoldersNotAllowedError
@@ -17,6 +17,8 @@
17
17
  "name": "My Main API Key",
18
18
  "permission_set": "full",
19
19
  "platform": "win32",
20
+ "site_id": 1,
21
+ "site_name": "example",
20
22
  "url": "example",
21
23
  "user_id": 1
22
24
  }
@@ -35,6 +37,8 @@
35
37
  * `name` (string): Internal name for the API Key. For your use.
36
38
  * `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
37
39
  * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
40
+ * `site_id` (int64): Site ID
41
+ * `site_name` (string): Site Name
38
42
  * `url` (string): URL for API host.
39
43
  * `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
40
44
  * `path` (string): Folder path restriction for `office_integration` permission set API keys.
@@ -55,7 +59,7 @@ await ApiKey.list({
55
59
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
56
60
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
57
61
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
62
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `expires_at`.
59
63
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
60
64
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
61
65
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
@@ -177,6 +181,8 @@ await api_key.update({
177
181
  "name": "My Main API Key",
178
182
  "permission_set": "full",
179
183
  "platform": "win32",
184
+ "site_id": 1,
185
+ "site_name": "example",
180
186
  "url": "example",
181
187
  "user_id": 1
182
188
  }
@@ -54,7 +54,7 @@ await AutomationRun.list({
54
54
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
55
55
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
56
56
  * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
57
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
57
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
58
58
  * `automation_id` (int64): Required - ID of the associated Automation.
59
59
 
60
60
  ---
@@ -0,0 +1,115 @@
1
+ # PartnerSiteRequest
2
+
3
+ ## Example PartnerSiteRequest Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "partner_id": 1,
9
+ "linked_site_id": 1,
10
+ "status": "pending",
11
+ "pairing_key": "abc123xyz",
12
+ "created_at": "2000-01-01T01:00:00Z",
13
+ "updated_at": "2000-01-01T01:00:00Z"
14
+ }
15
+ ```
16
+
17
+ * `id` (int64): Partner Site Request ID
18
+ * `partner_id` (int64): Partner ID
19
+ * `linked_site_id` (int64): Linked Site ID
20
+ * `status` (string): Request status (pending, approved, rejected)
21
+ * `pairing_key` (string): Pairing key used to approve this request on the target site
22
+ * `created_at` (date-time): Request creation date/time
23
+ * `updated_at` (date-time): Request last updated date/time
24
+ * `site_url` (string): Site URL to link to
25
+
26
+ ---
27
+
28
+ ## List Partner Site Requests
29
+
30
+ ```
31
+ await PartnerSiteRequest.list
32
+ ```
33
+
34
+
35
+ ### Parameters
36
+
37
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
38
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
39
+
40
+ ---
41
+
42
+ ## Find partner site request by pairing key
43
+
44
+ ```
45
+ await PartnerSiteRequest.findByPairingKey({
46
+ 'pairing_key': "pairing_key",
47
+ })
48
+ ```
49
+
50
+
51
+ ### Parameters
52
+
53
+ * `pairing_key` (string): Required - Pairing key for the partner site request
54
+
55
+ ---
56
+
57
+ ## Create Partner Site Request
58
+
59
+ ```
60
+ await PartnerSiteRequest.create({
61
+ 'partner_id': 1,
62
+ 'site_url': "site_url",
63
+ })
64
+ ```
65
+
66
+
67
+ ### Parameters
68
+
69
+ * `partner_id` (int64): Required - Partner ID to link with
70
+ * `site_url` (string): Required - Site URL to link to
71
+
72
+ ---
73
+
74
+ ## Reject partner site request
75
+
76
+ ```
77
+ const [partner_site_request] = await PartnerSiteRequest.list()
78
+
79
+ await partner_site_request.reject()
80
+ ```
81
+
82
+ ### Parameters
83
+
84
+ * `id` (int64): Required - Partner Site Request ID.
85
+
86
+
87
+ ---
88
+
89
+ ## Approve partner site request
90
+
91
+ ```
92
+ const [partner_site_request] = await PartnerSiteRequest.list()
93
+
94
+ await partner_site_request.approve()
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ * `id` (int64): Required - Partner Site Request ID.
100
+
101
+
102
+ ---
103
+
104
+ ## Delete Partner Site Request
105
+
106
+ ```
107
+ const [partner_site_request] = await PartnerSiteRequest.list()
108
+
109
+ await partner_site_request.delete()
110
+ ```
111
+
112
+ ### Parameters
113
+
114
+ * `id` (int64): Required - Partner Site Request ID.
115
+