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,171 @@
1
+ # History
2
+
3
+ ## Example History Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "path": "path",
9
+ "when": "2000-01-01T01:00:00Z",
10
+ "destination": "/to_path",
11
+ "display": "Actual text of the action here.",
12
+ "ip": "192.283.128.182",
13
+ "source": "/from_path",
14
+ "targets": [
15
+
16
+ ],
17
+ "user_id": 1,
18
+ "username": "user",
19
+ "action": "create",
20
+ "failure_type": "none",
21
+ "interface": "web"
22
+ }
23
+ ```
24
+
25
+ * `id` (int64): Action ID
26
+ * `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
27
+ * `when` (date-time): Action occurrence date/time
28
+ * `destination` (string): The destination path for this action, if applicable
29
+ * `display` (string): Friendly displayed output
30
+ * `ip` (string): IP Address that performed this action
31
+ * `source` (string): The source path for this action, if applicable
32
+ * `targets` (array): Targets
33
+ * `user_id` (int64): User ID
34
+ * `username` (string): Username
35
+ * `action` (string): Type of action
36
+ * `failure_type` (string): Failure type. If action was a user login or session failure, why did it fail?
37
+ * `interface` (string): Interface on which this action occurred.
38
+
39
+
40
+ ---
41
+
42
+ ## List history for specific file
43
+
44
+ ```
45
+ Files::History.list_for_file(path,
46
+ display: "Actual text of the action here.",
47
+ page: 1,
48
+ per_page: 1,
49
+ action: "create"
50
+ )
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+ * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
56
+ * `end_at` (string): Leave blank or set to a date/time to filter later entries.
57
+ * `display` (string): Display format. Leave blank or set to `full` or `parent`.
58
+ * `page` (int64): Current page number.
59
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
61
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
62
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `user_id` and `created_at`.
63
+ * `path` (string): Required - Path to operate on.
64
+
65
+
66
+ ---
67
+
68
+ ## List history for specific folder
69
+
70
+ ```
71
+ Files::History.list_for_folder(path,
72
+ display: "Actual text of the action here.",
73
+ page: 1,
74
+ per_page: 1,
75
+ action: "create"
76
+ )
77
+ ```
78
+
79
+ ### Parameters
80
+
81
+ * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
82
+ * `end_at` (string): Leave blank or set to a date/time to filter later entries.
83
+ * `display` (string): Display format. Leave blank or set to `full` or `parent`.
84
+ * `page` (int64): Current page number.
85
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
86
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
87
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
88
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `user_id` and `created_at`.
89
+ * `path` (string): Required - Path to operate on.
90
+
91
+
92
+ ---
93
+
94
+ ## List history for specific user
95
+
96
+ ```
97
+ Files::History.list_for_user(user_id,
98
+ display: "Actual text of the action here.",
99
+ page: 1,
100
+ per_page: 1,
101
+ action: "create"
102
+ )
103
+ ```
104
+
105
+ ### Parameters
106
+
107
+ * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
108
+ * `end_at` (string): Leave blank or set to a date/time to filter later entries.
109
+ * `display` (string): Display format. Leave blank or set to `full` or `parent`.
110
+ * `page` (int64): Current page number.
111
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
112
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
113
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
114
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `user_id` and `created_at`.
115
+ * `user_id` (int64): Required - User ID.
116
+
117
+
118
+ ---
119
+
120
+ ## List site login history
121
+
122
+ ```
123
+ Files::History.list_logins(
124
+ display: "Actual text of the action here.",
125
+ page: 1,
126
+ per_page: 1,
127
+ action: "create"
128
+ )
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
134
+ * `end_at` (string): Leave blank or set to a date/time to filter later entries.
135
+ * `display` (string): Display format. Leave blank or set to `full` or `parent`.
136
+ * `page` (int64): Current page number.
137
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
138
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
139
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
140
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `user_id` and `created_at`.
141
+
142
+
143
+ ---
144
+
145
+ ## List site full action history
146
+
147
+ ```
148
+ Files::History.list(
149
+ display: "Actual text of the action here.",
150
+ page: 1,
151
+ per_page: 1,
152
+ action: "create"
153
+ )
154
+ ```
155
+
156
+ ### Parameters
157
+
158
+ * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
159
+ * `end_at` (string): Leave blank or set to a date/time to filter later entries.
160
+ * `display` (string): Display format. Leave blank or set to `full` or `parent`.
161
+ * `page` (int64): Current page number.
162
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
163
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
164
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
165
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `path`, `created_at`, `folder` or `user_id`.
166
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
167
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
168
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
169
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
170
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
171
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
@@ -0,0 +1,174 @@
1
+ # HistoryExport
2
+
3
+ ## Example HistoryExport Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "start_at": "2000-01-01T01:00:00Z",
9
+ "end_at": "2000-01-01T01:00:00Z",
10
+ "status": "ready",
11
+ "query_action": "read",
12
+ "query_interface": "ftp",
13
+ "query_user_id": 1,
14
+ "query_file_id": 1,
15
+ "query_parent_id": 1,
16
+ "query_path": "MyFile.txt",
17
+ "query_folder": "Folder",
18
+ "query_src": "SrcFolder",
19
+ "query_destination": "DestFolder",
20
+ "query_ip": "127.0.0.1",
21
+ "query_username": "jerry",
22
+ "query_failure_type": "bad_password",
23
+ "query_target_id": 1,
24
+ "query_target_name": "full",
25
+ "query_target_permission": "full",
26
+ "query_target_user_id": 1,
27
+ "query_target_username": "jerry",
28
+ "query_target_platform": "windows",
29
+ "query_target_permission_set": "desktop_app"
30
+ }
31
+ ```
32
+
33
+ * `id` (int64): History Export ID
34
+ * `start_at` (date-time): Start date/time of export range.
35
+ * `end_at` (date-time): End date/time of export range.
36
+ * `status` (string): Status of export. Will be: `building` or `ready`
37
+ * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
38
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
39
+ * `query_user_id` (int64): Return results that are actions performed by the user indiciated by this User ID
40
+ * `query_file_id` (int64): Return results that are file actions related to the file indicated by this File ID
41
+ * `query_parent_id` (int64): Return results that are file actions inside the parent folder specified by this folder ID
42
+ * `query_path` (string): Return results that are file actions related to this path.
43
+ * `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
44
+ * `query_src` (string): Return results that are file moves originating from this path.
45
+ * `query_destination` (string): Return results that are file moves with this path as destination.
46
+ * `query_ip` (string): Filter results by this IP address.
47
+ * `query_username` (string): Filter results by this username.
48
+ * `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
49
+ * `query_target_id` (int64): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
50
+ * `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
51
+ * `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
52
+ * `query_target_user_id` (int64): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
53
+ * `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
54
+ * `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
55
+ * `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
56
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
57
+
58
+
59
+ ---
60
+
61
+ ## List History Exports
62
+
63
+ ```
64
+ Files::HistoryExport.list(
65
+ user_id: 1,
66
+ page: 1,
67
+ per_page: 1
68
+ )
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
74
+ * `page` (int64): Current page number.
75
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
76
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
77
+
78
+
79
+ ---
80
+
81
+ ## Show History Export
82
+
83
+ ```
84
+ Files::HistoryExport.find(id)
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ * `id` (int64): Required - History Export ID.
90
+
91
+
92
+ ---
93
+
94
+ ## Create History Export
95
+
96
+ ```
97
+ Files::HistoryExport.create(
98
+ user_id: 1,
99
+ start_at: "2000-01-01T01:00:00Z",
100
+ end_at: "2000-01-01T01:00:00Z",
101
+ query_action: "read",
102
+ query_interface: "ftp",
103
+ query_user_id: 1,
104
+ query_file_id: 1,
105
+ query_parent_id: 1,
106
+ query_path: "MyFile.txt",
107
+ query_folder: "Folder",
108
+ query_src: "SrcFolder",
109
+ query_destination: "DestFolder",
110
+ query_ip: "127.0.0.1",
111
+ query_username: "jerry",
112
+ query_failure_type: "bad_password",
113
+ query_target_id: 1,
114
+ query_target_name: "full",
115
+ query_target_permission: "full",
116
+ query_target_user_id: 1,
117
+ query_target_username: "jerry",
118
+ query_target_platform: "windows",
119
+ query_target_permission_set: "desktop_app"
120
+ )
121
+ ```
122
+
123
+ ### Parameters
124
+
125
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
126
+ * `start_at` (string): Start date/time of export range.
127
+ * `end_at` (string): End date/time of export range.
128
+ * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
129
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
130
+ * `query_user_id` (int64): Return results that are actions performed by the user indiciated by this User ID
131
+ * `query_file_id` (int64): Return results that are file actions related to the file indicated by this File ID
132
+ * `query_parent_id` (int64): Return results that are file actions inside the parent folder specified by this folder ID
133
+ * `query_path` (string): Return results that are file actions related to this path.
134
+ * `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
135
+ * `query_src` (string): Return results that are file moves originating from this path.
136
+ * `query_destination` (string): Return results that are file moves with this path as destination.
137
+ * `query_ip` (string): Filter results by this IP address.
138
+ * `query_username` (string): Filter results by this username.
139
+ * `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
140
+ * `query_target_id` (int64): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
141
+ * `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
142
+ * `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
143
+ * `query_target_user_id` (int64): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
144
+ * `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
145
+ * `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
146
+ * `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
147
+
148
+
149
+ ---
150
+
151
+ ## Delete History Export
152
+
153
+ ```
154
+ Files::HistoryExport.delete(id)
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ * `id` (int64): Required - History Export ID.
160
+
161
+
162
+ ---
163
+
164
+ ## Delete History Export
165
+
166
+ ```
167
+ history_export = Files::HistoryExport.list_for(path).first
168
+
169
+ history_export.delete
170
+ ```
171
+
172
+ ### Parameters
173
+
174
+ * `id` (int64): Required - History Export ID.
@@ -0,0 +1,13 @@
1
+ # Image
2
+
3
+ ## Example Image Object
4
+
5
+ ```
6
+ {
7
+ "name": "My logo",
8
+ "uri": "https://mysite.files.com/.../my_image.png"
9
+ }
10
+ ```
11
+
12
+ * `name` (string): Image name
13
+ * `uri` (string): Image URI
@@ -0,0 +1,72 @@
1
+ # Invoice
2
+
3
+ ## Example Invoice Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "amount": "",
9
+ "balance": "",
10
+ "created_at": "2000-01-01T01:00:00Z",
11
+ "currency": "USD",
12
+ "download_uri": "https://url...",
13
+ "invoice_line_items": [
14
+
15
+ ],
16
+ "method": "paypal",
17
+ "payment_line_items": [
18
+
19
+ ],
20
+ "payment_reversed_at": "2000-01-01T01:00:00Z",
21
+ "payment_type": "",
22
+ "site_name": "My Site",
23
+ "type": "invoice",
24
+ "updated_at": "2000-01-01T01:00:00Z"
25
+ }
26
+ ```
27
+
28
+ * `id` (int64): Line item Id
29
+ * `amount` (double): Line item amount
30
+ * `balance` (double): Line item balance
31
+ * `created_at` (date-time): Line item created at
32
+ * `currency` (string): Line item currency
33
+ * `download_uri` (string): Line item download uri
34
+ * `invoice_line_items` (array): Associated invoice line items
35
+ * `method` (string): Line item payment method
36
+ * `payment_line_items` (array): Associated payment line items
37
+ * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
38
+ * `payment_type` (string): Type of payment if applicable
39
+ * `site_name` (string): Site name this line item is for
40
+ * `type` (string): Type of line item, either payment or invoice
41
+ * `updated_at` (date-time): Line item updated at
42
+
43
+
44
+ ---
45
+
46
+ ## List Invoices
47
+
48
+ ```
49
+ Files::Invoice.list(
50
+ page: 1,
51
+ per_page: 1
52
+ )
53
+ ```
54
+
55
+ ### Parameters
56
+
57
+ * `page` (int64): Current page number.
58
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
59
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
60
+
61
+
62
+ ---
63
+
64
+ ## Show Invoice
65
+
66
+ ```
67
+ Files::Invoice.find(id)
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ * `id` (int64): Required - Invoice ID.
@@ -0,0 +1,27 @@
1
+ # InvoiceLineItem
2
+
3
+ ## Example InvoiceLineItem Object
4
+
5
+ ```
6
+ {
7
+ "amount": "",
8
+ "created_at": "2000-01-01T01:00:00Z",
9
+ "description": "Service from 2019-01-01 through 2019-12-31",
10
+ "type": "invoice",
11
+ "service_end_at": "2000-01-01T01:00:00Z",
12
+ "service_start_at": "2000-01-01T01:00:00Z",
13
+ "updated_at": "2000-01-01T01:00:00Z",
14
+ "plan": "Enterprise",
15
+ "site": "My site"
16
+ }
17
+ ```
18
+
19
+ * `amount` (double): Invoice line item amount
20
+ * `created_at` (date-time): Invoice line item created at date/time
21
+ * `description` (string): Invoice line item description
22
+ * `type` (string): Invoice line item type
23
+ * `service_end_at` (date-time): Invoice line item service end date/time
24
+ * `service_start_at` (date-time): Invoice line item service start date/time
25
+ * `updated_at` (date-time): Invoice line item updated date/time
26
+ * `plan` (string): Plan name
27
+ * `site` (string): Site name