files.com 1.1.179 → 1.1.181

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 (143) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/action_notification_export_result.md +0 -17
  4. data/docs/api_key.md +0 -21
  5. data/docs/api_request_log.md +0 -14
  6. data/docs/app.md +0 -15
  7. data/docs/as2_incoming_message.md +0 -21
  8. data/docs/as2_outgoing_message.md +0 -21
  9. data/docs/as2_partner.md +0 -9
  10. data/docs/as2_station.md +0 -9
  11. data/docs/automation.md +0 -18
  12. data/docs/automation_log.md +0 -14
  13. data/docs/automation_run.md +0 -17
  14. data/docs/bandwidth_snapshot.md +0 -18
  15. data/docs/behavior.md +0 -15
  16. data/docs/bundle.md +0 -22
  17. data/docs/bundle_action.md +0 -18
  18. data/docs/bundle_download.md +0 -23
  19. data/docs/bundle_notification.md +0 -14
  20. data/docs/bundle_recipient.md +0 -17
  21. data/docs/bundle_registration.md +0 -15
  22. data/docs/clickwrap.md +0 -9
  23. data/docs/dns_record.md +0 -9
  24. data/docs/email_incoming_message.md +0 -19
  25. data/docs/email_log.md +0 -14
  26. data/docs/exavault_api_request_log.md +0 -14
  27. data/docs/external_event.md +0 -19
  28. data/docs/file_migration_log.md +0 -14
  29. data/docs/form_field_set.md +0 -15
  30. data/docs/ftp_action_log.md +0 -14
  31. data/docs/gpg_key.md +0 -16
  32. data/docs/group.md +0 -19
  33. data/docs/group_user.md +0 -17
  34. data/docs/history.md +0 -85
  35. data/docs/history_export_result.md +0 -17
  36. data/docs/inbox_recipient.md +0 -17
  37. data/docs/inbox_registration.md +0 -15
  38. data/docs/inbox_upload.md +0 -18
  39. data/docs/invoice.md +0 -9
  40. data/docs/ip_address.md +0 -36
  41. data/docs/message.md +0 -17
  42. data/docs/message_comment.md +0 -17
  43. data/docs/message_comment_reaction.md +0 -17
  44. data/docs/message_reaction.md +0 -17
  45. data/docs/notification.md +0 -20
  46. data/docs/outbound_connection_log.md +0 -14
  47. data/docs/payment.md +0 -9
  48. data/docs/permission.md +0 -21
  49. data/docs/priority.md +0 -13
  50. data/docs/project.md +0 -9
  51. data/docs/public_hosting_request_log.md +0 -14
  52. data/docs/public_key.md +0 -15
  53. data/docs/remote_bandwidth_snapshot.md +0 -18
  54. data/docs/remote_server.md +0 -15
  55. data/docs/request.md +0 -17
  56. data/docs/settings_change.md +0 -14
  57. data/docs/sftp_action_log.md +0 -14
  58. data/docs/sftp_host_key.md +0 -9
  59. data/docs/share_group.md +0 -15
  60. data/docs/siem_http_destination.md +0 -9
  61. data/docs/snapshot.md +0 -9
  62. data/docs/sso_strategy.md +0 -9
  63. data/docs/sync_log.md +0 -14
  64. data/docs/usage_daily_snapshot.md +0 -18
  65. data/docs/usage_snapshot.md +0 -9
  66. data/docs/user.md +0 -24
  67. data/docs/user_cipher_use.md +0 -15
  68. data/docs/user_request.md +0 -9
  69. data/docs/user_sftp_client_use.md +0 -15
  70. data/docs/web_dav_action_log.md +0 -14
  71. data/lib/files.com/models/action_notification_export_result.rb +0 -14
  72. data/lib/files.com/models/api_key.rb +0 -23
  73. data/lib/files.com/models/api_request_log.rb +0 -13
  74. data/lib/files.com/models/app.rb +0 -15
  75. data/lib/files.com/models/as2_incoming_message.rb +0 -23
  76. data/lib/files.com/models/as2_outgoing_message.rb +0 -23
  77. data/lib/files.com/models/as2_partner.rb +0 -7
  78. data/lib/files.com/models/as2_station.rb +0 -7
  79. data/lib/files.com/models/automation.rb +0 -21
  80. data/lib/files.com/models/automation_log.rb +0 -13
  81. data/lib/files.com/models/automation_run.rb +0 -16
  82. data/lib/files.com/models/bandwidth_snapshot.rb +0 -21
  83. data/lib/files.com/models/behavior.rb +0 -15
  84. data/lib/files.com/models/bundle.rb +0 -25
  85. data/lib/files.com/models/bundle_action.rb +0 -21
  86. data/lib/files.com/models/bundle_download.rb +0 -25
  87. data/lib/files.com/models/bundle_notification.rb +0 -13
  88. data/lib/files.com/models/bundle_recipient.rb +0 -16
  89. data/lib/files.com/models/bundle_registration.rb +0 -11
  90. data/lib/files.com/models/clickwrap.rb +0 -7
  91. data/lib/files.com/models/dns_record.rb +0 -7
  92. data/lib/files.com/models/email_incoming_message.rb +0 -23
  93. data/lib/files.com/models/email_log.rb +0 -13
  94. data/lib/files.com/models/exavault_api_request_log.rb +0 -13
  95. data/lib/files.com/models/external_event.rb +0 -23
  96. data/lib/files.com/models/file_migration_log.rb +0 -13
  97. data/lib/files.com/models/form_field_set.rb +0 -11
  98. data/lib/files.com/models/ftp_action_log.rb +0 -13
  99. data/lib/files.com/models/gpg_key.rb +0 -13
  100. data/lib/files.com/models/group.rb +0 -18
  101. data/lib/files.com/models/group_user.rb +0 -13
  102. data/lib/files.com/models/history.rb +0 -104
  103. data/lib/files.com/models/history_export_result.rb +0 -14
  104. data/lib/files.com/models/inbox_recipient.rb +0 -16
  105. data/lib/files.com/models/inbox_registration.rb +0 -11
  106. data/lib/files.com/models/inbox_upload.rb +0 -21
  107. data/lib/files.com/models/invoice.rb +0 -7
  108. data/lib/files.com/models/ip_address.rb +0 -28
  109. data/lib/files.com/models/message.rb +0 -14
  110. data/lib/files.com/models/message_comment.rb +0 -14
  111. data/lib/files.com/models/message_comment_reaction.rb +0 -14
  112. data/lib/files.com/models/message_reaction.rb +0 -14
  113. data/lib/files.com/models/notification.rb +0 -20
  114. data/lib/files.com/models/outbound_connection_log.rb +0 -13
  115. data/lib/files.com/models/payment.rb +0 -7
  116. data/lib/files.com/models/permission.rb +0 -22
  117. data/lib/files.com/models/priority.rb +0 -14
  118. data/lib/files.com/models/project.rb +0 -7
  119. data/lib/files.com/models/public_hosting_request_log.rb +0 -13
  120. data/lib/files.com/models/public_key.rb +0 -11
  121. data/lib/files.com/models/remote_bandwidth_snapshot.rb +0 -21
  122. data/lib/files.com/models/remote_server.rb +0 -15
  123. data/lib/files.com/models/request.rb +0 -14
  124. data/lib/files.com/models/settings_change.rb +0 -13
  125. data/lib/files.com/models/sftp_action_log.rb +0 -13
  126. data/lib/files.com/models/sftp_host_key.rb +0 -7
  127. data/lib/files.com/models/share_group.rb +0 -11
  128. data/lib/files.com/models/siem_http_destination.rb +0 -7
  129. data/lib/files.com/models/snapshot.rb +0 -7
  130. data/lib/files.com/models/sso_strategy.rb +0 -7
  131. data/lib/files.com/models/sync_log.rb +0 -13
  132. data/lib/files.com/models/usage_daily_snapshot.rb +0 -21
  133. data/lib/files.com/models/usage_snapshot.rb +0 -7
  134. data/lib/files.com/models/user.rb +0 -28
  135. data/lib/files.com/models/user_cipher_use.rb +0 -11
  136. data/lib/files.com/models/user_request.rb +0 -7
  137. data/lib/files.com/models/user_sftp_client_use.rb +0 -11
  138. data/lib/files.com/models/web_dav_action_log.rb +0 -13
  139. data/lib/files.com/version.rb +1 -1
  140. data/lib/files.com.rb +0 -1
  141. metadata +2 -4
  142. data/docs/export.md +0 -76
  143. data/lib/files.com/models/export.rb +0 -170
@@ -1,170 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Files
4
- class Export
5
- attr_reader :options, :attributes
6
-
7
- def initialize(attributes = {}, options = {})
8
- @attributes = attributes || {}
9
- @options = options || {}
10
- end
11
-
12
- # int64 - ID for this Export
13
- def id
14
- @attributes[:id]
15
- end
16
-
17
- def id=(value)
18
- @attributes[:id] = value
19
- end
20
-
21
- # string - Status of the Export
22
- def export_status
23
- @attributes[:export_status]
24
- end
25
-
26
- def export_status=(value)
27
- @attributes[:export_status] = value
28
- end
29
-
30
- # string - Type of data being exported
31
- def export_type
32
- @attributes[:export_type]
33
- end
34
-
35
- def export_type=(value)
36
- @attributes[:export_type] = value
37
- end
38
-
39
- # int64 - Number of rows exported
40
- def export_rows
41
- @attributes[:export_rows]
42
- end
43
-
44
- def export_rows=(value)
45
- @attributes[:export_rows] = value
46
- end
47
-
48
- # string - Link to download Export file.
49
- def download_uri
50
- @attributes[:download_uri]
51
- end
52
-
53
- def download_uri=(value)
54
- @attributes[:download_uri] = value
55
- end
56
-
57
- # string - Export message
58
- def message
59
- @attributes[:message]
60
- end
61
-
62
- def message=(value)
63
- @attributes[:message] = value
64
- end
65
-
66
- # int64 - User ID. Provide a value of `0` to operate the current session's user.
67
- def user_id
68
- @attributes[:user_id]
69
- end
70
-
71
- def user_id=(value)
72
- @attributes[:user_id] = value
73
- end
74
-
75
- # object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
76
- def sort_by
77
- @attributes[:sort_by]
78
- end
79
-
80
- def sort_by=(value)
81
- @attributes[:sort_by] = value
82
- end
83
-
84
- # object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
85
- def filter
86
- @attributes[:filter]
87
- end
88
-
89
- def filter=(value)
90
- @attributes[:filter] = value
91
- end
92
-
93
- # object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
94
- def filter_prefix
95
- @attributes[:filter_prefix]
96
- end
97
-
98
- def filter_prefix=(value)
99
- @attributes[:filter_prefix] = value
100
- end
101
-
102
- def save
103
- if @attributes[:id]
104
- raise NotImplementedError.new("The Export object doesn't support updates.")
105
- else
106
- new_obj = Export.create(@attributes, @options)
107
- end
108
-
109
- @attributes = new_obj.attributes
110
- true
111
- end
112
-
113
- # Parameters:
114
- # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
115
- # 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.
116
- # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
117
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
118
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
119
- # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
120
- def self.list(params = {}, options = {})
121
- raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
122
- raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
123
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
124
- raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
125
- raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
126
- raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
127
-
128
- List.new(Export, params) do
129
- Api.send_request("/exports", :get, params, options)
130
- end
131
- end
132
-
133
- def self.all(params = {}, options = {})
134
- list(params, options)
135
- end
136
-
137
- # Parameters:
138
- # id (required) - int64 - Export ID.
139
- def self.find(id, params = {}, options = {})
140
- params ||= {}
141
- params[:id] = id
142
- raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
143
- raise MissingParameterError.new("Parameter missing: id") unless params[:id]
144
-
145
- response, options = Api.send_request("/exports/#{params[:id]}", :get, params, options)
146
- Export.new(response.data, options)
147
- end
148
-
149
- def self.get(id, params = {}, options = {})
150
- find(id, params, options)
151
- end
152
-
153
- # Parameters:
154
- # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
155
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
156
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
157
- # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
158
- def self.create(params = {}, options = {})
159
- raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
160
- raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
161
- raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
162
- raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
163
-
164
- response, options = Api.send_request("/exports/create_export", :post, params, options)
165
- response.data.map do |entity_data|
166
- Export.new(entity_data, options)
167
- end
168
- end
169
- end
170
- end