Files.com 1.4.183__tar.gz → 1.4.185__tar.gz

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.
Files changed (114) hide show
  1. {Files.com-1.4.183 → Files.com-1.4.185}/Files.com.egg-info/PKG-INFO +1 -1
  2. {Files.com-1.4.183 → Files.com-1.4.185}/PKG-INFO +1 -1
  3. {Files.com-1.4.183 → Files.com-1.4.185}/README.md +72 -53
  4. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/__init__.py +1 -1
  5. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/automation.py +1 -1
  6. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/automation_run.py +1 -1
  7. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bundle_action.py +1 -1
  8. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/email_incoming_message.py +1 -1
  9. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/external_event.py +1 -1
  10. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/history.py +1 -1
  11. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/inbox_upload.py +1 -1
  12. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/permission.py +1 -1
  13. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/remote_server.py +2 -2
  14. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/usage_daily_snapshot.py +1 -1
  15. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/user.py +2 -2
  16. {Files.com-1.4.183 → Files.com-1.4.185}/Files.com.egg-info/SOURCES.txt +0 -0
  17. {Files.com-1.4.183 → Files.com-1.4.185}/Files.com.egg-info/dependency_links.txt +0 -0
  18. {Files.com-1.4.183 → Files.com-1.4.185}/Files.com.egg-info/requires.txt +0 -0
  19. {Files.com-1.4.183 → Files.com-1.4.185}/Files.com.egg-info/top_level.txt +0 -0
  20. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/api.py +0 -0
  21. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/api_client.py +0 -0
  22. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/error.py +0 -0
  23. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/list_obj.py +0 -0
  24. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/__init__.py +0 -0
  25. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/account_line_item.py +0 -0
  26. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/action.py +0 -0
  27. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/action_notification_export.py +0 -0
  28. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/action_notification_export_result.py +0 -0
  29. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/api_key.py +0 -0
  30. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/api_request_log.py +0 -0
  31. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/app.py +0 -0
  32. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/as2_incoming_message.py +0 -0
  33. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/as2_outgoing_message.py +0 -0
  34. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/as2_partner.py +0 -0
  35. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/as2_station.py +0 -0
  36. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/auto.py +0 -0
  37. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/automation_log.py +0 -0
  38. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bandwidth_snapshot.py +0 -0
  39. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/behavior.py +0 -0
  40. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bundle.py +0 -0
  41. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bundle_download.py +0 -0
  42. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bundle_notification.py +0 -0
  43. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bundle_path.py +0 -0
  44. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bundle_recipient.py +0 -0
  45. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/bundle_registration.py +0 -0
  46. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/clickwrap.py +0 -0
  47. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/dns_record.py +0 -0
  48. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/email_log.py +0 -0
  49. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/errors.py +0 -0
  50. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/exavault_api_request_log.py +0 -0
  51. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/file.py +0 -0
  52. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/file_action.py +0 -0
  53. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/file_comment.py +0 -0
  54. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/file_comment_reaction.py +0 -0
  55. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/file_migration.py +0 -0
  56. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/file_migration_log.py +0 -0
  57. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/file_upload_part.py +0 -0
  58. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/folder.py +0 -0
  59. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/form_field.py +0 -0
  60. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/form_field_set.py +0 -0
  61. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/ftp_action_log.py +0 -0
  62. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/gpg_key.py +0 -0
  63. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/group.py +0 -0
  64. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/group_user.py +0 -0
  65. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/history_export.py +0 -0
  66. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/history_export_result.py +0 -0
  67. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/image.py +0 -0
  68. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/inbox_recipient.py +0 -0
  69. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/inbox_registration.py +0 -0
  70. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/invoice.py +0 -0
  71. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/invoice_line_item.py +0 -0
  72. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/ip_address.py +0 -0
  73. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/lock.py +0 -0
  74. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/message.py +0 -0
  75. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/message_comment.py +0 -0
  76. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/message_comment_reaction.py +0 -0
  77. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/message_reaction.py +0 -0
  78. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/notification.py +0 -0
  79. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/outbound_connection_log.py +0 -0
  80. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/payment.py +0 -0
  81. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/payment_line_item.py +0 -0
  82. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/preview.py +0 -0
  83. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/priority.py +0 -0
  84. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/project.py +0 -0
  85. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/public_hosting_request_log.py +0 -0
  86. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/public_ip_address.py +0 -0
  87. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/public_key.py +0 -0
  88. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/remote_bandwidth_snapshot.py +0 -0
  89. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/remote_server_configuration_file.py +0 -0
  90. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/request.py +0 -0
  91. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/session.py +0 -0
  92. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/settings_change.py +0 -0
  93. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/sftp_action_log.py +0 -0
  94. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/sftp_host_key.py +0 -0
  95. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/share_group.py +0 -0
  96. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/share_group_member.py +0 -0
  97. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/siem_http_destination.py +0 -0
  98. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/site.py +0 -0
  99. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/snapshot.py +0 -0
  100. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/sso_strategy.py +0 -0
  101. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/status.py +0 -0
  102. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/style.py +0 -0
  103. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/sync_log.py +0 -0
  104. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/usage_snapshot.py +0 -0
  105. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/user_cipher_use.py +0 -0
  106. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/user_request.py +0 -0
  107. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/user_sftp_client_use.py +0 -0
  108. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/web_dav_action_log.py +0 -0
  109. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/models/webhook_test.py +0 -0
  110. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/path_util.py +0 -0
  111. {Files.com-1.4.183 → Files.com-1.4.185}/files_sdk/util.py +0 -0
  112. {Files.com-1.4.183 → Files.com-1.4.185}/pyproject.toml +0 -0
  113. {Files.com-1.4.183 → Files.com-1.4.185}/setup.cfg +0 -0
  114. {Files.com-1.4.183 → Files.com-1.4.185}/setup.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.2
2
2
  Name: Files.com
3
- Version: 1.4.183
3
+ Version: 1.4.185
4
4
  Summary: Python bindings for the Files.com API
5
5
  Home-page: UNKNOWN
6
6
  License: MIT
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.2
2
2
  Name: Files.com
3
- Version: 1.4.183
3
+ Version: 1.4.185
4
4
  Summary: Python bindings for the Files.com API
5
5
  Home-page: UNKNOWN
6
6
  License: MIT
@@ -508,116 +508,117 @@ files_sdk.error.FolderAdminPermissionRequiredError -> files_sdk.error.NotAuthori
508
508
  |`TrialLockedError`| `SiteConfigurationError` |
509
509
  |`UserRequestsEnabledRequiredError`| `SiteConfigurationError` |
510
510
 
511
- ## Mock Server
512
-
513
- Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
514
- SDKs and other direct integrations against the Files.com API in an integration test environment.
515
-
516
- It is a Ruby app that operates as a minimal server for the purpose of testing basic network
517
- operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
518
- deeply inspect your submissions for correctness.
519
-
520
- Eventually we will add more features intended for integration testing, such as the ability to
521
- intentionally provoke errors.
522
-
523
- Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
524
-
525
- The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
526
-
527
- A README is available on the GitHub link.
528
-
529
- ## File/Folder Operations
530
-
531
- This SDK allows both file-based transfer and data-based transfer. Please see the examples below.
511
+ ## Examples
532
512
 
533
513
  ### Upload
534
514
 
535
- The second parameter is optional and will simply use the local filename by default.
515
+ #### Upload a File
536
516
 
537
517
  ```python
538
- files_sdk.file.upload_file("local.txt", "/remote.txt")
518
+ files_sdk.file.upload_file("local.txt", "remote.txt")
539
519
  ```
540
520
 
541
521
  If the parent directories do not already exist, they can be automatically created by passing
542
522
  `mkdir_parents` in the `params`.
543
523
 
544
524
  ```python
545
- files_sdk.file.upload_file("local.txt", "/uploads/remote.txt", params={"mkdir_parents": True})
525
+ files_sdk.file.upload_file("local.txt", "uploads/remote.txt", params={"mkdir_parents": True})
546
526
  ```
547
527
 
548
- #### Writing a File Example (string)
528
+ #### Write File Data
549
529
 
550
530
  ```python
551
531
  with files_sdk.file.open("foo.txt", 'w') as f:
552
532
  f.write("contents")
553
533
  ```
554
534
 
555
- #### Writing a File Example (binary)
535
+ Or, for binary data:
556
536
 
557
537
  ```python
558
538
  with files_sdk.file.open("foo.txt", 'wb') as f:
559
539
  f.write(b"contents")
560
540
  ```
561
541
 
562
- ### Download
542
+ #### Create a Folder
543
+
544
+ ```python
545
+ files_sdk.folder.create("path/to/folder/to/be/created", params={"mkdir_parents": True})
546
+ ```
563
547
 
564
- #### File Download
548
+ ### Download
565
549
 
566
- The second parameter is optional and will simply use the remote filename by default.
550
+ #### Download a File
567
551
 
568
552
  ```python
569
- files_sdk.file.download_file("/remote.txt", "local.txt")
553
+ files_sdk.file.download_file("remote.txt", "local.txt")
570
554
  ```
571
555
 
572
- #### Reading a File Example (string)
556
+ #### Read File Data
573
557
 
574
558
  ```python
575
- with files_sdk.open("foo.txt", 'r') as f:
559
+ with files_sdk.file.open("foo.txt", 'r') as f:
576
560
  print(f.read())
577
561
  ```
578
562
 
579
- #### Reading a File Example (binary)
563
+ Or, for binary data:
580
564
 
581
565
  ```python
582
- with files_sdk.open("foo.txt", 'rb') as f:
566
+ with files_sdk.file.open("foo.txt", 'rb') as f:
583
567
  print(f.read())
584
568
  ```
585
569
 
586
570
  ### List
587
571
 
572
+ #### List Folder Contents
573
+
574
+ There are two ways to list folder contents:
575
+ 1. `auto_paging_iter` - automatically paginates and loads each page into memory
576
+ 2. `load_next_page/has_next_page` - manually paginates and loads each page into memory
577
+
588
578
  ```python
589
- for f in files_sdk.folder.list_for("/").auto_paging_iter():
590
- print(f.type, f.path)
579
+ for item in files_sdk.folder.list_for("remote/path/to/folder/").auto_paging_iter():
580
+ print(item.type, item.path)
591
581
  ```
592
582
 
593
- #### List Responses and Cursor Paging
583
+ ```python
584
+ list_obj = files_sdk.folder.list_for('remote/path/to/folder/')
585
+
586
+ while True:
587
+ for item in list_obj:
588
+ print(item.type, item.path)
589
+ if not list_obj.has_next_page:
590
+ break
591
+ list_obj.load_next_page()
592
+ ```
594
593
 
595
- List responses for APIs with cursor support will return an iterable object
596
- which contains a single page of records. It has a built-in `auto_paging_iter`
597
- method to iterate through the pages, making the additional API calls
598
- as needed.
594
+ ### Copy
599
595
 
600
- ##### Iterating with auto_paging_iter
596
+ The copy method works for both files and folders.
601
597
 
602
598
  ```python
603
- list_obj = files_sdk.folder.list_for('/')
599
+ files_sdk.file.copy("source/path", params={"destination": "destination/path"})
600
+ ```
601
+
602
+ ### Move
604
603
 
605
- for f in list_obj.auto_paging_iter():
606
- print(f.type, f.path)
604
+ The move method works for both files and folders.
605
+
606
+ ```python
607
+ files_sdk.file.move("source/path", params={"destination": "destination/path"})
607
608
  ```
608
609
 
609
- ##### Iterating Manually
610
+ ### Delete
611
+
612
+ The delete method works for both files and folders.
610
613
 
611
614
  ```python
612
- list_obj = files_sdk.folder.list_for('/')
615
+ files_sdk.file.delete("path/to/file/or/folder")
616
+ ```
613
617
 
614
- for f in list_obj:
615
- print(f.type, f.path)
618
+ In case the folder is not empty, you can use the `recursive` argument:
616
619
 
617
- while list_obj.has_next_page:
618
- list_obj.load_next_page()
619
- for f in list_obj:
620
- print(f.type, f.path)
620
+ ```python
621
+ files_sdk.file.delete("path/to/folder", params={"recursive": True})
621
622
  ```
622
623
 
623
624
  ### Comparing Case-Insensitive Files and Paths
@@ -628,3 +629,21 @@ For related documentation see [Case Sensitivity Documentation](https://www.files
628
629
  if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
629
630
  print("Paths are the same")
630
631
  ```
632
+
633
+ ## Mock Server
634
+
635
+ Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
636
+ SDKs and other direct integrations against the Files.com API in an integration test environment.
637
+
638
+ It is a Ruby app that operates as a minimal server for the purpose of testing basic network
639
+ operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
640
+ deeply inspect your submissions for correctness.
641
+
642
+ Eventually we will add more features intended for integration testing, such as the ability to
643
+ intentionally provoke errors.
644
+
645
+ Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
646
+
647
+ The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
648
+
649
+ A README is available on the GitHub link.
@@ -208,7 +208,7 @@ session_id = None
208
208
  source_ip = None
209
209
  base_url = "https://app.files.com"
210
210
  base_path = "api/rest/v1"
211
- version = "1.4.183"
211
+ version = "1.4.185"
212
212
 
213
213
  __version__ = version
214
214
 
@@ -268,7 +268,7 @@ class Automation:
268
268
  # 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.
269
269
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
270
270
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation`, `disabled`, `last_modified_at` or `name`.
271
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ disabled, automation ]`, `[ last_modified_at, automation ]` or `[ disabled, last_modified_at, automation ]`.
271
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ automation, disabled ]`, `[ automation, last_modified_at ]` or `[ automation, disabled, last_modified_at ]`.
272
272
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
273
273
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
274
274
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
@@ -48,7 +48,7 @@ class AutomationRun:
48
48
  # 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.
49
49
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
50
50
  # 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`.
51
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ status, automation_id ]`.
51
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.
52
52
  # automation_id (required) - int64 - ID of the associated Automation.
53
53
  def list(params=None, options=None):
54
54
  if not isinstance(params, dict):
@@ -45,7 +45,7 @@ class BundleAction:
45
45
  # 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.
46
46
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
47
47
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
48
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ created_at, bundle_id ]`, `[ created_at, bundle_registration_id ]`, `[ bundle_id, bundle_registration_id ]` or `[ created_at, bundle_id, bundle_registration_id ]`.
48
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ bundle_id, created_at ]`, `[ bundle_registration_id, created_at ]`, `[ bundle_id, bundle_registration_id ]` or `[ bundle_id, bundle_registration_id, created_at ]`.
49
49
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
50
50
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
51
51
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
@@ -48,7 +48,7 @@ class EmailIncomingMessage:
48
48
  # 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.
49
49
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
50
50
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
51
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ created_at, inbox_id ]`, `[ created_at, sender ]`, `[ created_at, status ]`, `[ inbox_id, status ]`, `[ created_at, inbox_id, status ]`, `[ inbox_id, sender, status ]` or `[ created_at, inbox_id, sender, status ]`.
51
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ inbox_id, created_at ]`, `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, status ]`, `[ inbox_id, status, created_at ]`, `[ inbox_id, status, sender ]` or `[ inbox_id, status, sender, created_at ]`.
52
52
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
53
53
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
54
54
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
@@ -63,7 +63,7 @@ class ExternalEvent:
63
63
  # 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.
64
64
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
65
65
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
66
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type ]`, `[ created_at, remote_server_type ]`, `[ created_at, status ]`, `[ event_type, status ]` or `[ created_at, event_type, status ]`.
66
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ event_type, created_at ]`, `[ remote_server_type, created_at ]`, `[ status, created_at ]`, `[ event_type, status ]` or `[ event_type, status, created_at ]`.
67
67
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
68
68
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
69
69
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
@@ -198,7 +198,7 @@ def list_logins(params=None, options=None):
198
198
  # 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.
199
199
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
200
200
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `created_at` or `user_id`.
201
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ user_id, folder ]`, `[ user_id, path ]`, `[ folder, path ]` or `[ user_id, folder, path ]`.
201
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ ]`, `[ path ]`, `[ path ]` or `[ path ]`.
202
202
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
203
203
  def list(params=None, options=None):
204
204
  if not isinstance(params, dict):
@@ -39,7 +39,7 @@ class InboxUpload:
39
39
  # 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.
40
40
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
41
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
42
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `folder_behavior_id` or `inbox_registration_id`. Valid field combinations are `[ created_at, folder_behavior_id ]`, `[ created_at, inbox_registration_id ]`, `[ folder_behavior_id, inbox_registration_id ]` or `[ created_at, folder_behavior_id, inbox_registration_id ]`.
42
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `folder_behavior_id` or `inbox_registration_id`. Valid field combinations are `[ folder_behavior_id, created_at ]`, `[ inbox_registration_id, created_at ]`, `[ folder_behavior_id, inbox_registration_id ]` or `[ folder_behavior_id, inbox_registration_id, created_at ]`.
43
43
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
44
44
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
45
45
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
@@ -76,7 +76,7 @@ class Permission:
76
76
  # 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.
77
77
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
78
78
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path` or `user_id`.
79
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ path, group_id ]`, `[ path, user_id ]` or `[ group_id, user_id ]`.
79
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]` or `[ user_id, group_id ]`.
80
80
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
81
81
  # path - string - Permission path. If provided, will scope all permissions(including upward) to this path.
82
82
  # include_groups - boolean - If searching by user or group, also include user's permissions that are inherited from its groups?
@@ -658,8 +658,8 @@ class RemoteServer:
658
658
  # 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.
659
659
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
660
660
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
661
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ name, server_type ]`, `[ name, backblaze_b2_bucket ]`, `[ name, google_cloud_storage_bucket ]`, `[ name, wasabi_bucket ]`, `[ name, s3_bucket ]`, `[ name, rackspace_container ]`, `[ name, azure_blob_storage_container ]`, `[ name, azure_files_storage_share_name ]`, `[ name, s3_compatible_bucket ]`, `[ name, filebase_bucket ]`, `[ name, cloudflare_bucket ]` or `[ name, linode_bucket ]`.
662
- # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ name, backblaze_b2_bucket ]`, `[ name, google_cloud_storage_bucket ]`, `[ name, wasabi_bucket ]`, `[ name, s3_bucket ]`, `[ name, rackspace_container ]`, `[ name, azure_blob_storage_container ]`, `[ name, azure_files_storage_share_name ]`, `[ name, s3_compatible_bucket ]`, `[ name, filebase_bucket ]`, `[ name, cloudflare_bucket ]` or `[ name, linode_bucket ]`.
661
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ rackspace_container, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
662
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ rackspace_container, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
663
663
  def list(params=None, options=None):
664
664
  if not isinstance(params, dict):
665
665
  params = {}
@@ -50,7 +50,7 @@ class UsageDailySnapshot:
50
50
  # 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.
51
51
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
52
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
53
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ date, usage_snapshot_id ]`.
53
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
54
54
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
55
55
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
56
56
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
@@ -404,10 +404,10 @@ class User:
404
404
  # 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.
405
405
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
406
406
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
407
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]` and `[ name, company ]`.
407
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]` and `[ company, name ]`.
408
408
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
409
409
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
410
- # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ name, company ]`.
410
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
411
411
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
412
412
  # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
413
413
  # ids - string - comma-separated list of User IDs
File without changes
File without changes
File without changes