files.com 1.0.92

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 (136) hide show
  1. checksums.yaml +7 -0
  2. data/CONTRIBUTORS +4 -0
  3. data/Gemfile +12 -0
  4. data/Gemfile.lock +82 -0
  5. data/LICENSE +21 -0
  6. data/README.md +119 -0
  7. data/Rakefile +12 -0
  8. data/SECURITY.md +24 -0
  9. data/_VERSION +1 -0
  10. data/bin/files +8 -0
  11. data/bin/files-console +16 -0
  12. data/docs/account_line_item.md +41 -0
  13. data/docs/action.md +37 -0
  14. data/docs/api_key.md +202 -0
  15. data/docs/app.md +59 -0
  16. data/docs/as2_key.md +133 -0
  17. data/docs/auto.md +11 -0
  18. data/docs/automation.md +190 -0
  19. data/docs/behavior.md +208 -0
  20. data/docs/bundle.md +252 -0
  21. data/docs/bundle_download.md +35 -0
  22. data/docs/clickwrap.md +143 -0
  23. data/docs/dns_record.md +35 -0
  24. data/docs/errors.md +17 -0
  25. data/docs/file.md +204 -0
  26. data/docs/file_action.md +126 -0
  27. data/docs/file_comment.md +116 -0
  28. data/docs/file_comment_reaction.md +62 -0
  29. data/docs/file_part_upload.md +37 -0
  30. data/docs/file_utils.md +4 -0
  31. data/docs/folder.md +90 -0
  32. data/docs/group.md +153 -0
  33. data/docs/group_user.md +124 -0
  34. data/docs/history.md +171 -0
  35. data/docs/history_export.md +174 -0
  36. data/docs/image.md +13 -0
  37. data/docs/invoice.md +72 -0
  38. data/docs/invoice_line_item.md +27 -0
  39. data/docs/ip_address.md +55 -0
  40. data/docs/lock.md +98 -0
  41. data/docs/message.md +147 -0
  42. data/docs/message_comment.md +132 -0
  43. data/docs/message_comment_reaction.md +94 -0
  44. data/docs/message_reaction.md +94 -0
  45. data/docs/notification.md +177 -0
  46. data/docs/payment.md +72 -0
  47. data/docs/payment_line_item.md +19 -0
  48. data/docs/permission.md +95 -0
  49. data/docs/preview.md +19 -0
  50. data/docs/project.md +121 -0
  51. data/docs/public_ip_address.md +13 -0
  52. data/docs/public_key.md +133 -0
  53. data/docs/remote_server.md +356 -0
  54. data/docs/request.md +100 -0
  55. data/docs/session.md +78 -0
  56. data/docs/site.md +448 -0
  57. data/docs/sso_strategy.md +114 -0
  58. data/docs/status.md +21 -0
  59. data/docs/style.md +93 -0
  60. data/docs/usage_daily_snapshot.md +45 -0
  61. data/docs/usage_snapshot.md +53 -0
  62. data/docs/user.md +535 -0
  63. data/docs/user_cipher_use.md +41 -0
  64. data/docs/user_request.md +93 -0
  65. data/files.com.gemspec +22 -0
  66. data/lib/files.com.rb +184 -0
  67. data/lib/files.com/api.rb +38 -0
  68. data/lib/files.com/api_client.rb +340 -0
  69. data/lib/files.com/errors.rb +41 -0
  70. data/lib/files.com/list.rb +95 -0
  71. data/lib/files.com/models/account_line_item.rb +82 -0
  72. data/lib/files.com/models/action.rb +77 -0
  73. data/lib/files.com/models/api_key.rb +270 -0
  74. data/lib/files.com/models/app.rb +106 -0
  75. data/lib/files.com/models/as2_key.rb +179 -0
  76. data/lib/files.com/models/auto.rb +17 -0
  77. data/lib/files.com/models/automation.rb +304 -0
  78. data/lib/files.com/models/behavior.rb +266 -0
  79. data/lib/files.com/models/bundle.rb +371 -0
  80. data/lib/files.com/models/bundle_download.rb +49 -0
  81. data/lib/files.com/models/clickwrap.rb +197 -0
  82. data/lib/files.com/models/dir.rb +3 -0
  83. data/lib/files.com/models/dns_record.rb +51 -0
  84. data/lib/files.com/models/errors.rb +22 -0
  85. data/lib/files.com/models/file.rb +968 -0
  86. data/lib/files.com/models/file_action.rb +126 -0
  87. data/lib/files.com/models/file_comment.rb +146 -0
  88. data/lib/files.com/models/file_comment_reaction.rb +100 -0
  89. data/lib/files.com/models/file_part_upload.rb +82 -0
  90. data/lib/files.com/models/file_utils.rb +118 -0
  91. data/lib/files.com/models/folder.rb +357 -0
  92. data/lib/files.com/models/group.rb +208 -0
  93. data/lib/files.com/models/group_user.rb +171 -0
  94. data/lib/files.com/models/history.rb +228 -0
  95. data/lib/files.com/models/history_export.rb +353 -0
  96. data/lib/files.com/models/image.rb +22 -0
  97. data/lib/files.com/models/invoice.rb +117 -0
  98. data/lib/files.com/models/invoice_line_item.rb +57 -0
  99. data/lib/files.com/models/ip_address.rb +66 -0
  100. data/lib/files.com/models/lock.rb +173 -0
  101. data/lib/files.com/models/message.rb +201 -0
  102. data/lib/files.com/models/message_comment.rb +165 -0
  103. data/lib/files.com/models/message_comment_reaction.rb +128 -0
  104. data/lib/files.com/models/message_reaction.rb +128 -0
  105. data/lib/files.com/models/notification.rb +263 -0
  106. data/lib/files.com/models/payment.rb +117 -0
  107. data/lib/files.com/models/payment_line_item.rb +37 -0
  108. data/lib/files.com/models/permission.rb +172 -0
  109. data/lib/files.com/models/preview.rb +37 -0
  110. data/lib/files.com/models/project.rb +140 -0
  111. data/lib/files.com/models/public_ip_address.rb +22 -0
  112. data/lib/files.com/models/public_key.rb +179 -0
  113. data/lib/files.com/models/remote_server.rb +680 -0
  114. data/lib/files.com/models/request.rb +179 -0
  115. data/lib/files.com/models/session.rb +247 -0
  116. data/lib/files.com/models/site.rb +733 -0
  117. data/lib/files.com/models/sso_strategy.rb +227 -0
  118. data/lib/files.com/models/status.rb +37 -0
  119. data/lib/files.com/models/style.rb +131 -0
  120. data/lib/files.com/models/usage_daily_snapshot.rb +66 -0
  121. data/lib/files.com/models/usage_snapshot.rb +96 -0
  122. data/lib/files.com/models/user.rb +876 -0
  123. data/lib/files.com/models/user_cipher_use.rb +63 -0
  124. data/lib/files.com/models/user_request.rb +127 -0
  125. data/lib/files.com/response.rb +25 -0
  126. data/lib/files.com/sizable_io.rb +32 -0
  127. data/lib/files.com/system_profiler.rb +56 -0
  128. data/lib/files.com/util.rb +106 -0
  129. data/lib/files.com/version.rb +5 -0
  130. data/spec/list_spec.rb +214 -0
  131. data/spec/models/file_spec.rb +68 -0
  132. data/spec/models/folder_spec.rb +40 -0
  133. data/spec/spec_helper.rb +36 -0
  134. data/test.sh +8 -0
  135. data/test/test.rb +75 -0
  136. metadata +235 -0
@@ -0,0 +1,55 @@
1
+ # IpAddress
2
+
3
+ ## Example IpAddress Object
4
+
5
+ ```
6
+ {
7
+ "id": "Site",
8
+ "associated_with": "Site",
9
+ "group_id": 1,
10
+ "ip_addresses": [
11
+
12
+ ]
13
+ }
14
+ ```
15
+
16
+ * `id` (string): Unique label for list; used by Zapier and other integrations.
17
+ * `associated_with` (string): The object that this public IP address list is associated with.
18
+ * `group_id` (int64): Group ID
19
+ * `ip_addresses` (array): A list of IP addresses.
20
+
21
+
22
+ ---
23
+
24
+ ## List IP Addresses associated with the current site
25
+
26
+ ```
27
+ Files::IpAddress.list(
28
+ page: 1,
29
+ per_page: 1
30
+ )
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ * `page` (int64): Current page number.
36
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
37
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
38
+
39
+
40
+ ---
41
+
42
+ ## List all possible public IP addresses
43
+
44
+ ```
45
+ Files::IpAddress.get_reserved(
46
+ page: 1,
47
+ per_page: 1
48
+ )
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `page` (int64): Current page number.
54
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
55
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
@@ -0,0 +1,98 @@
1
+ # Lock
2
+
3
+ ## Example Lock Object
4
+
5
+ ```
6
+ {
7
+ "path": "locked_file",
8
+ "timeout": 43200,
9
+ "depth": "infinity",
10
+ "owner": "user",
11
+ "scope": "shared",
12
+ "token": "17c54824e9931a4688ca032d03f6663c",
13
+ "type": "write",
14
+ "user_id": 1,
15
+ "username": "username"
16
+ }
17
+ ```
18
+
19
+ * `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
20
+ * `timeout` (int64): Lock timeout
21
+ * `depth` (string): Lock depth (0 or infinity)
22
+ * `owner` (string): Owner of lock. This can be any arbitrary string.
23
+ * `scope` (string): Lock scope(shared or exclusive)
24
+ * `token` (string): Lock token. Use to release lock.
25
+ * `type` (string): Lock type
26
+ * `user_id` (int64): Lock creator user ID
27
+ * `username` (string): Lock creator username
28
+
29
+
30
+ ---
31
+
32
+ ## List Locks by path
33
+
34
+ ```
35
+ Files::Lock.list_for(path,
36
+ page: 1,
37
+ per_page: 1,
38
+ include_children: true
39
+ )
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ * `page` (int64): Current page number.
45
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
47
+ * `path` (string): Required - Path to operate on.
48
+ * `include_children` (boolean): Include locks from children objects?
49
+
50
+
51
+ ---
52
+
53
+ ## Create Lock
54
+
55
+ ```
56
+ Files::Lock.create(path,
57
+ timeout: 1
58
+ )
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ * `path` (string): Required - Path
64
+ * `timeout` (int64): Lock timeout length
65
+
66
+
67
+ ---
68
+
69
+ ## Delete Lock
70
+
71
+ ```
72
+ Files::Lock.delete(path,
73
+ token: "token"
74
+ )
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ * `path` (string): Required - Path
80
+ * `token` (string): Required - Lock token
81
+
82
+
83
+ ---
84
+
85
+ ## Delete Lock
86
+
87
+ ```
88
+ lock = Files::Lock.list_for(path).first
89
+
90
+ lock.delete(
91
+ token: "token"
92
+ )
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ * `path` (string): Required - Path
98
+ * `token` (string): Required - Lock token
@@ -0,0 +1,147 @@
1
+ # Message
2
+
3
+ ## Example Message Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "subject": "Files.com Account Upgrade",
9
+ "body": "We should upgrade our Files.com account!",
10
+ "comments": [
11
+
12
+ ]
13
+ }
14
+ ```
15
+
16
+ * `id` (int64): Message ID
17
+ * `subject` (string): Message subject.
18
+ * `body` (string): Message body.
19
+ * `comments` (array): Comments.
20
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
21
+ * `project_id` (int64): Project to which the message should be attached.
22
+
23
+
24
+ ---
25
+
26
+ ## List Messages
27
+
28
+ ```
29
+ Files::Message.list(
30
+ user_id: 1,
31
+ page: 1,
32
+ per_page: 1,
33
+ project_id: 1
34
+ )
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
40
+ * `page` (int64): Current page number.
41
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
43
+ * `project_id` (int64): Required - Project for which to return messages.
44
+
45
+
46
+ ---
47
+
48
+ ## Show Message
49
+
50
+ ```
51
+ Files::Message.find(id)
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ * `id` (int64): Required - Message ID.
57
+
58
+
59
+ ---
60
+
61
+ ## Create Message
62
+
63
+ ```
64
+ Files::Message.create(
65
+ user_id: 1,
66
+ project_id: 1,
67
+ subject: "Files.com Account Upgrade",
68
+ body: "We should upgrade our Files.com account!"
69
+ )
70
+ ```
71
+
72
+ ### Parameters
73
+
74
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
75
+ * `project_id` (int64): Required - Project to which the message should be attached.
76
+ * `subject` (string): Required - Message subject.
77
+ * `body` (string): Required - Message body.
78
+
79
+
80
+ ---
81
+
82
+ ## Update Message
83
+
84
+ ```
85
+ Files::Message.update(id,
86
+ project_id: 1,
87
+ subject: "Files.com Account Upgrade",
88
+ body: "We should upgrade our Files.com account!"
89
+ )
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ * `id` (int64): Required - Message ID.
95
+ * `project_id` (int64): Required - Project to which the message should be attached.
96
+ * `subject` (string): Required - Message subject.
97
+ * `body` (string): Required - Message body.
98
+
99
+
100
+ ---
101
+
102
+ ## Delete Message
103
+
104
+ ```
105
+ Files::Message.delete(id)
106
+ ```
107
+
108
+ ### Parameters
109
+
110
+ * `id` (int64): Required - Message ID.
111
+
112
+
113
+ ---
114
+
115
+ ## Update Message
116
+
117
+ ```
118
+ message = Files::Message.list_for(path).first
119
+
120
+ message.update(
121
+ project_id: 1,
122
+ subject: "Files.com Account Upgrade",
123
+ body: "We should upgrade our Files.com account!"
124
+ )
125
+ ```
126
+
127
+ ### Parameters
128
+
129
+ * `id` (int64): Required - Message ID.
130
+ * `project_id` (int64): Required - Project to which the message should be attached.
131
+ * `subject` (string): Required - Message subject.
132
+ * `body` (string): Required - Message body.
133
+
134
+
135
+ ---
136
+
137
+ ## Delete Message
138
+
139
+ ```
140
+ message = Files::Message.list_for(path).first
141
+
142
+ message.delete
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+ * `id` (int64): Required - Message ID.
@@ -0,0 +1,132 @@
1
+ # MessageComment
2
+
3
+ ## Example MessageComment Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "body": "What a great idea, thank you!",
9
+ "reactions": [
10
+
11
+ ]
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): Message Comment ID
16
+ * `body` (string): Comment body.
17
+ * `reactions` (array): Reactions to this comment.
18
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
19
+
20
+
21
+ ---
22
+
23
+ ## List Message Comments
24
+
25
+ ```
26
+ Files::MessageComment.list(
27
+ user_id: 1,
28
+ page: 1,
29
+ per_page: 1,
30
+ message_id: 1
31
+ )
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
37
+ * `page` (int64): Current page number.
38
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
39
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
40
+ * `message_id` (int64): Required - Message comment to return comments for.
41
+
42
+
43
+ ---
44
+
45
+ ## Show Message Comment
46
+
47
+ ```
48
+ Files::MessageComment.find(id)
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `id` (int64): Required - Message Comment ID.
54
+
55
+
56
+ ---
57
+
58
+ ## Create Message Comment
59
+
60
+ ```
61
+ Files::MessageComment.create(
62
+ user_id: 1,
63
+ body: "body"
64
+ )
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
70
+ * `body` (string): Required - Comment body.
71
+
72
+
73
+ ---
74
+
75
+ ## Update Message Comment
76
+
77
+ ```
78
+ Files::MessageComment.update(id,
79
+ body: "body"
80
+ )
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ * `id` (int64): Required - Message Comment ID.
86
+ * `body` (string): Required - Comment body.
87
+
88
+
89
+ ---
90
+
91
+ ## Delete Message Comment
92
+
93
+ ```
94
+ Files::MessageComment.delete(id)
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ * `id` (int64): Required - Message Comment ID.
100
+
101
+
102
+ ---
103
+
104
+ ## Update Message Comment
105
+
106
+ ```
107
+ message_comment = Files::MessageComment.list_for(path).first
108
+
109
+ message_comment.update(
110
+ body: "body"
111
+ )
112
+ ```
113
+
114
+ ### Parameters
115
+
116
+ * `id` (int64): Required - Message Comment ID.
117
+ * `body` (string): Required - Comment body.
118
+
119
+
120
+ ---
121
+
122
+ ## Delete Message Comment
123
+
124
+ ```
125
+ message_comment = Files::MessageComment.list_for(path).first
126
+
127
+ message_comment.delete
128
+ ```
129
+
130
+ ### Parameters
131
+
132
+ * `id` (int64): Required - Message Comment ID.
@@ -0,0 +1,94 @@
1
+ # MessageCommentReaction
2
+
3
+ ## Example MessageCommentReaction Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "emoji": "👍"
9
+ }
10
+ ```
11
+
12
+ * `id` (int64): Reaction ID
13
+ * `emoji` (string): Emoji used in the reaction.
14
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
15
+
16
+
17
+ ---
18
+
19
+ ## List Message Comment Reactions
20
+
21
+ ```
22
+ Files::MessageCommentReaction.list(
23
+ user_id: 1,
24
+ page: 1,
25
+ per_page: 1,
26
+ message_comment_id: 1
27
+ )
28
+ ```
29
+
30
+ ### Parameters
31
+
32
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
33
+ * `page` (int64): Current page number.
34
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
36
+ * `message_comment_id` (int64): Required - Message comment to return reactions for.
37
+
38
+
39
+ ---
40
+
41
+ ## Show Message Comment Reaction
42
+
43
+ ```
44
+ Files::MessageCommentReaction.find(id)
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ * `id` (int64): Required - Message Comment Reaction ID.
50
+
51
+
52
+ ---
53
+
54
+ ## Create Message Comment Reaction
55
+
56
+ ```
57
+ Files::MessageCommentReaction.create(
58
+ user_id: 1,
59
+ emoji: "emoji"
60
+ )
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
66
+ * `emoji` (string): Required - Emoji to react with.
67
+
68
+
69
+ ---
70
+
71
+ ## Delete Message Comment Reaction
72
+
73
+ ```
74
+ Files::MessageCommentReaction.delete(id)
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ * `id` (int64): Required - Message Comment Reaction ID.
80
+
81
+
82
+ ---
83
+
84
+ ## Delete Message Comment Reaction
85
+
86
+ ```
87
+ message_comment_reaction = Files::MessageCommentReaction.list_for(path).first
88
+
89
+ message_comment_reaction.delete
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ * `id` (int64): Required - Message Comment Reaction ID.