files.com 1.0.228 → 1.0.232

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/action_notification_export_result.md +1 -1
  4. data/docs/api_key.md +1 -1
  5. data/docs/app.md +7 -7
  6. data/docs/as2_incoming_message.md +55 -0
  7. data/docs/as2_outgoing_message.md +49 -0
  8. data/docs/as2_partner.md +136 -0
  9. data/docs/as2_station.md +148 -0
  10. data/docs/automation.md +1 -1
  11. data/docs/automation_run.md +1 -1
  12. data/docs/bandwidth_snapshot.md +1 -1
  13. data/docs/behavior.md +2 -2
  14. data/docs/bundle.md +1 -1
  15. data/docs/bundle_download.md +1 -1
  16. data/docs/bundle_recipient.md +1 -1
  17. data/docs/bundle_registration.md +1 -1
  18. data/docs/clickwrap.md +1 -1
  19. data/docs/dns_record.md +1 -1
  20. data/docs/external_event.md +7 -7
  21. data/docs/file_comment.md +1 -1
  22. data/docs/folder.md +1 -1
  23. data/docs/form_field_set.md +1 -1
  24. data/docs/group.md +1 -1
  25. data/docs/group_user.md +1 -1
  26. data/docs/history.md +5 -5
  27. data/docs/history_export.md +2 -2
  28. data/docs/history_export_result.md +2 -2
  29. data/docs/inbox_recipient.md +1 -1
  30. data/docs/inbox_registration.md +1 -1
  31. data/docs/inbox_upload.md +1 -1
  32. data/docs/invoice.md +1 -1
  33. data/docs/ip_address.md +2 -2
  34. data/docs/lock.md +1 -1
  35. data/docs/message.md +1 -1
  36. data/docs/message_comment.md +1 -1
  37. data/docs/message_comment_reaction.md +1 -1
  38. data/docs/message_reaction.md +1 -1
  39. data/docs/notification.md +1 -1
  40. data/docs/payment.md +1 -1
  41. data/docs/permission.md +7 -7
  42. data/docs/priority.md +1 -1
  43. data/docs/project.md +1 -1
  44. data/docs/public_key.md +1 -1
  45. data/docs/remote_server.md +1 -1
  46. data/docs/request.md +2 -2
  47. data/docs/settings_change.md +1 -1
  48. data/docs/sso_strategy.md +1 -1
  49. data/docs/sync_job.md +1 -1
  50. data/docs/usage_daily_snapshot.md +7 -7
  51. data/docs/usage_snapshot.md +1 -1
  52. data/docs/user.md +7 -7
  53. data/docs/user_cipher_use.md +1 -1
  54. data/docs/user_request.md +1 -1
  55. data/lib/files.com/errors.rb +1 -0
  56. data/lib/files.com/models/action_notification_export_result.rb +1 -1
  57. data/lib/files.com/models/api_key.rb +1 -1
  58. data/lib/files.com/models/app.rb +7 -7
  59. data/lib/files.com/models/as2_incoming_message.rb +100 -0
  60. data/lib/files.com/models/as2_outgoing_message.rb +85 -0
  61. data/lib/files.com/models/as2_partner.rb +188 -0
  62. data/lib/files.com/models/as2_station.rb +217 -0
  63. data/lib/files.com/models/automation.rb +1 -1
  64. data/lib/files.com/models/automation_run.rb +1 -1
  65. data/lib/files.com/models/bandwidth_snapshot.rb +1 -1
  66. data/lib/files.com/models/behavior.rb +2 -2
  67. data/lib/files.com/models/bundle.rb +1 -1
  68. data/lib/files.com/models/bundle_download.rb +1 -1
  69. data/lib/files.com/models/bundle_recipient.rb +1 -1
  70. data/lib/files.com/models/bundle_registration.rb +1 -1
  71. data/lib/files.com/models/clickwrap.rb +1 -1
  72. data/lib/files.com/models/dns_record.rb +1 -1
  73. data/lib/files.com/models/external_event.rb +7 -7
  74. data/lib/files.com/models/file_comment.rb +1 -1
  75. data/lib/files.com/models/folder.rb +1 -1
  76. data/lib/files.com/models/form_field_set.rb +1 -1
  77. data/lib/files.com/models/group.rb +1 -1
  78. data/lib/files.com/models/group_user.rb +1 -1
  79. data/lib/files.com/models/history.rb +5 -5
  80. data/lib/files.com/models/history_export.rb +2 -2
  81. data/lib/files.com/models/history_export_result.rb +2 -2
  82. data/lib/files.com/models/inbox_recipient.rb +1 -1
  83. data/lib/files.com/models/inbox_registration.rb +1 -1
  84. data/lib/files.com/models/inbox_upload.rb +1 -1
  85. data/lib/files.com/models/invoice.rb +1 -1
  86. data/lib/files.com/models/ip_address.rb +2 -2
  87. data/lib/files.com/models/lock.rb +1 -1
  88. data/lib/files.com/models/message.rb +1 -1
  89. data/lib/files.com/models/message_comment.rb +1 -1
  90. data/lib/files.com/models/message_comment_reaction.rb +1 -1
  91. data/lib/files.com/models/message_reaction.rb +1 -1
  92. data/lib/files.com/models/notification.rb +1 -1
  93. data/lib/files.com/models/payment.rb +1 -1
  94. data/lib/files.com/models/permission.rb +7 -7
  95. data/lib/files.com/models/priority.rb +1 -1
  96. data/lib/files.com/models/project.rb +1 -1
  97. data/lib/files.com/models/public_key.rb +1 -1
  98. data/lib/files.com/models/remote_server.rb +1 -1
  99. data/lib/files.com/models/request.rb +2 -2
  100. data/lib/files.com/models/settings_change.rb +1 -1
  101. data/lib/files.com/models/sso_strategy.rb +1 -1
  102. data/lib/files.com/models/sync_job.rb +1 -1
  103. data/lib/files.com/models/usage_daily_snapshot.rb +7 -7
  104. data/lib/files.com/models/usage_snapshot.rb +1 -1
  105. data/lib/files.com/models/user.rb +7 -7
  106. data/lib/files.com/models/user_cipher_use.rb +1 -1
  107. data/lib/files.com/models/user_request.rb +1 -1
  108. data/lib/files.com.rb +4 -1
  109. metadata +11 -5
  110. data/docs/as2_key.md +0 -131
  111. data/lib/files.com/models/as2_key.rb +0 -176
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f69db0db605f1e4f0d82720a9768276ec402d16e81d6c577c7585fe8f91dd069
4
- data.tar.gz: 7f92c64559527e74ba064be293e84691a61855d315b4ec16273c9326d6d75996
3
+ metadata.gz: 4e853badb0a1e39fec123b97f30f3464469400fe2bb515d278f18dbf11218b4b
4
+ data.tar.gz: e6d7bf73ac7299cb6f2fe321a36abc39139cad3b1eb81adc98db906f7184d4e9
5
5
  SHA512:
6
- metadata.gz: 855bb1f45ddd1a7c7aaa9a380b6615fa88e1d42489f5080d95ed643a1fa6ebf6757d939772bc7a1a89a2bbbda724b4d627893854bdd6317bffd8740c765667c2
7
- data.tar.gz: 8aee5b650cd672fd7c8183b4206b1c0484d6022025bf3acd8d2f1f55dcc84b51d6e1384f3f8c67498f15291109efdacde559cba83aa902faa873afee3369abe1
6
+ metadata.gz: 351b85e9adf6a772545a5da425ea0367fe5ca58db50cab1a439cc5e7f80e2a0d7f70369165fbb1d37bb5ea8d741989a70eb297866d5056c15db4a199404a70c4
7
+ data.tar.gz: 2fe0748bd322d8550e461a57a9d27e6f2496cbdfd6eab2c7fa17bfcb8b4a9c1bd960ca18a0261090b9006deef2aa17a554ecc3da377c5c65fc06cdec09e658e9
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.228
1
+ 1.0.232
@@ -44,6 +44,6 @@ Files::ActionNotificationExportResult.list(
44
44
  ### Parameters
45
45
 
46
46
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
47
- * `cursor` (string): Used for pagination. Send a cursor value 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.
47
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
48
48
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
49
49
  * `action_notification_export_id` (int64): Required - ID of the associated action notification export.
data/docs/api_key.md CHANGED
@@ -45,7 +45,7 @@ Files::ApiKey.list(
45
45
  ### Parameters
46
46
 
47
47
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
48
- * `cursor` (string): Used for pagination. Send a cursor value 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.
48
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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 (e.g. sort_by[last_login_at]=desc). Valid fields are `expires_at`.
51
51
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
data/docs/app.md CHANGED
@@ -55,12 +55,12 @@ Files::App.list(
55
55
 
56
56
  ### Parameters
57
57
 
58
- * `cursor` (string): Used for pagination. Send a cursor value 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.
58
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
59
59
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
60
  * `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 `name` and `app_type`.
61
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
62
- * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`.
63
- * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`.
64
- * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
65
- * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`.
66
- * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
61
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
62
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
63
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
64
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
65
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
66
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
@@ -0,0 +1,55 @@
1
+ # As2IncomingMessage
2
+
3
+ ## Example As2IncomingMessage Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "as2_partner_id": 1,
9
+ "uuid": "",
10
+ "content_type": "",
11
+ "http_headers": "",
12
+ "activity_log": "",
13
+ "processing_result": "",
14
+ "as2_to": "",
15
+ "as2_from": "",
16
+ "message_id": "",
17
+ "subject": "",
18
+ "body_size": "",
19
+ "attachment_filename": "",
20
+ "created_at": "2000-01-01T01:00:00Z"
21
+ }
22
+ ```
23
+
24
+ * `id` (int64): Id of the AS2 Partner.
25
+ * `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
26
+ * `uuid` (string): UUID assigned to this message.
27
+ * `content_type` (string): Content Type header of the incoming message.
28
+ * `http_headers` (object): HTTP Headers sent with this message.
29
+ * `activity_log` (string): JSON Structure of the activity log.
30
+ * `processing_result` (string): Result of processing. Valid values: `unable_to_find_station`, `unable_to_find_partner`, `unable_to_validate_signature`, `decrypt_fail`, `file_save_fail`, `success`
31
+ * `as2_to` (string): AS2 TO header of message
32
+ * `as2_from` (string): AS2 FROM header of message
33
+ * `message_id` (string): AS2 Message Id
34
+ * `subject` (string): AS2 Subject Header
35
+ * `body_size` (string): Encrypted Payload Body Size
36
+ * `attachment_filename` (string): Filename of the file being received.
37
+ * `created_at` (date-time): Message creation date/time
38
+
39
+
40
+ ---
41
+
42
+ ## List As2 Incoming Messages
43
+
44
+ ```
45
+ Files::As2IncomingMessage.list(
46
+ per_page: 1,
47
+ as2_partner_id: 1
48
+ )
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
54
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
55
+ * `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
@@ -0,0 +1,49 @@
1
+ # As2OutgoingMessage
2
+
3
+ ## Example As2OutgoingMessage Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "as2_partner_id": 1,
9
+ "uuid": "",
10
+ "http_headers": "",
11
+ "activity_log": "",
12
+ "processing_result": "",
13
+ "mic": "",
14
+ "message_id": "",
15
+ "body_size": "",
16
+ "attachment_filename": "",
17
+ "created_at": "2000-01-01T01:00:00Z"
18
+ }
19
+ ```
20
+
21
+ * `id` (int64): Id of the AS2 Partner.
22
+ * `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
23
+ * `uuid` (string): UUID assigned to this message.
24
+ * `http_headers` (object): HTTP Headers sent with this message.
25
+ * `activity_log` (string): JSON Structure of the activity log.
26
+ * `processing_result` (string): Result of processing. Valid values: `send_failed`, `send_success`
27
+ * `mic` (string): AS2 Message Integrity Check
28
+ * `message_id` (string): AS2 Message Id
29
+ * `body_size` (string): Encrypted Payload Body Size
30
+ * `attachment_filename` (string): Filename of the file being sent.
31
+ * `created_at` (date-time): Message creation date/time
32
+
33
+
34
+ ---
35
+
36
+ ## List As2 Outgoing Messages
37
+
38
+ ```
39
+ Files::As2OutgoingMessage.list(
40
+ per_page: 1,
41
+ as2_partner_id: 1
42
+ )
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
48
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
49
+ * `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
@@ -0,0 +1,136 @@
1
+ # As2Partner
2
+
3
+ ## Example As2Partner Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "as2_station_id": 1,
9
+ "name": "AS2 Partner Name",
10
+ "uri": "",
11
+ "public_certificate_md5": ""
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): Id of the AS2 Partner.
16
+ * `as2_station_id` (int64): Id of the AS2 Station associated with this partner.
17
+ * `name` (string): The partner's formal AS2 name.
18
+ * `uri` (string): Public URI for sending AS2 message to.
19
+ * `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
20
+ * `public_certificate` (string):
21
+
22
+
23
+ ---
24
+
25
+ ## List As2 Partners
26
+
27
+ ```
28
+ Files::As2Partner.list(
29
+ per_page: 1
30
+ )
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
36
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
37
+
38
+
39
+ ---
40
+
41
+ ## Show As2 Partner
42
+
43
+ ```
44
+ Files::As2Partner.find(id)
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ * `id` (int64): Required - As2 Partner ID.
50
+
51
+
52
+ ---
53
+
54
+ ## Create As2 Partner
55
+
56
+ ```
57
+ Files::As2Partner.create(
58
+ name: "name",
59
+ uri: "uri",
60
+ public_certificate: "public_certificate",
61
+ as2_station_id: 1
62
+ )
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ * `name` (string): Required - AS2 Name
68
+ * `uri` (string): Required - URL base for AS2 responses
69
+ * `public_certificate` (string): Required -
70
+ * `as2_station_id` (int64): Required - Id of As2Station for this partner
71
+
72
+
73
+ ---
74
+
75
+ ## Update As2 Partner
76
+
77
+ ```
78
+ Files::As2Partner.update(id,
79
+ name: "AS2 Partner Name"
80
+ )
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ * `id` (int64): Required - As2 Partner ID.
86
+ * `name` (string): AS2 Name
87
+ * `uri` (string): URL base for AS2 responses
88
+ * `public_certificate` (string):
89
+
90
+
91
+ ---
92
+
93
+ ## Delete As2 Partner
94
+
95
+ ```
96
+ Files::As2Partner.delete(id)
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ * `id` (int64): Required - As2 Partner ID.
102
+
103
+
104
+ ---
105
+
106
+ ## Update As2 Partner
107
+
108
+ ```
109
+ as2_partner = Files::As2Partner.list.first
110
+
111
+ as2_partner.update(
112
+ name: "AS2 Partner Name"
113
+ )
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ * `id` (int64): Required - As2 Partner ID.
119
+ * `name` (string): AS2 Name
120
+ * `uri` (string): URL base for AS2 responses
121
+ * `public_certificate` (string):
122
+
123
+
124
+ ---
125
+
126
+ ## Delete As2 Partner
127
+
128
+ ```
129
+ as2_partner = Files::As2Partner.list.first
130
+
131
+ as2_partner.delete
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ * `id` (int64): Required - As2 Partner ID.
@@ -0,0 +1,148 @@
1
+ # As2Station
2
+
3
+ ## Example As2Station Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "name": "AS2 Station Name",
9
+ "uri": "",
10
+ "domain": "domain.test",
11
+ "public_certificate": "",
12
+ "public_certificate_md5": "",
13
+ "private_key_md5": ""
14
+ }
15
+ ```
16
+
17
+ * `id` (int64): Id of the AS2 Station.
18
+ * `name` (string): The station's formal AS2 name.
19
+ * `uri` (string): Public URI for sending AS2 message to.
20
+ * `domain` (string): The station's AS2 domain name.
21
+ * `public_certificate` (string): Public certificate used for message security.
22
+ * `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
23
+ * `private_key_md5` (string): MD5 hash of private key used for message security.
24
+ * `private_key` (string):
25
+
26
+
27
+ ---
28
+
29
+ ## List As2 Stations
30
+
31
+ ```
32
+ Files::As2Station.list(
33
+ per_page: 1
34
+ )
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
40
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
+
42
+
43
+ ---
44
+
45
+ ## Show As2 Station
46
+
47
+ ```
48
+ Files::As2Station.find(id)
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `id` (int64): Required - As2 Station ID.
54
+
55
+
56
+ ---
57
+
58
+ ## Create As2 Station
59
+
60
+ ```
61
+ Files::As2Station.create(
62
+ name: "name",
63
+ domain: "domain",
64
+ uri: "uri",
65
+ public_certificate: "public_certificate",
66
+ private_key: "private_key"
67
+ )
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ * `name` (string): Required - AS2 Name
73
+ * `domain` (string): Required - AS2 Domain
74
+ * `uri` (string): Required - URL base for AS2 responses
75
+ * `public_certificate` (string): Required -
76
+ * `private_key` (string): Required -
77
+
78
+
79
+ ---
80
+
81
+ ## Update As2 Station
82
+
83
+ ```
84
+ Files::As2Station.update(id,
85
+ name: "AS2 Station Name",
86
+ domain: "domain.test"
87
+ )
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ * `id` (int64): Required - As2 Station ID.
93
+ * `name` (string): AS2 Name
94
+ * `domain` (string): AS2 Domain
95
+ * `uri` (string): URL base for AS2 responses
96
+ * `public_certificate` (string):
97
+ * `private_key` (string):
98
+
99
+
100
+ ---
101
+
102
+ ## Delete As2 Station
103
+
104
+ ```
105
+ Files::As2Station.delete(id)
106
+ ```
107
+
108
+ ### Parameters
109
+
110
+ * `id` (int64): Required - As2 Station ID.
111
+
112
+
113
+ ---
114
+
115
+ ## Update As2 Station
116
+
117
+ ```
118
+ as2_station = Files::As2Station.list.first
119
+
120
+ as2_station.update(
121
+ name: "AS2 Station Name",
122
+ domain: "domain.test"
123
+ )
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ * `id` (int64): Required - As2 Station ID.
129
+ * `name` (string): AS2 Name
130
+ * `domain` (string): AS2 Domain
131
+ * `uri` (string): URL base for AS2 responses
132
+ * `public_certificate` (string):
133
+ * `private_key` (string):
134
+
135
+
136
+ ---
137
+
138
+ ## Delete As2 Station
139
+
140
+ ```
141
+ as2_station = Files::As2Station.list.first
142
+
143
+ as2_station.delete
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ * `id` (int64): Required - As2 Station ID.
data/docs/automation.md CHANGED
@@ -80,7 +80,7 @@ Files::Automation.list(
80
80
 
81
81
  ### Parameters
82
82
 
83
- * `cursor` (string): Used for pagination. Send a cursor value 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.
83
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
84
84
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
85
85
  * `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 `automation`.
86
86
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
@@ -36,7 +36,7 @@ Files::AutomationRun.list(
36
36
  ### Parameters
37
37
 
38
38
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
39
- * `cursor` (string): Used for pagination. Send a cursor value 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.
39
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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 (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `status`.
42
42
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
@@ -43,7 +43,7 @@ Files::BandwidthSnapshot.list(
43
43
 
44
44
  ### Parameters
45
45
 
46
- * `cursor` (string): Used for pagination. Send a cursor value 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.
46
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
47
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
48
48
  * `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 `logged_at`.
49
49
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
data/docs/behavior.md CHANGED
@@ -40,7 +40,7 @@ Files::Behavior.list(
40
40
 
41
41
  ### Parameters
42
42
 
43
- * `cursor` (string): Used for pagination. Send a cursor value 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.
43
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
44
44
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
45
  * `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 `behavior`.
46
46
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
@@ -78,7 +78,7 @@ Files::Behavior.list_for(path,
78
78
 
79
79
  ### Parameters
80
80
 
81
- * `cursor` (string): Used for pagination. Send a cursor value 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.
81
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
82
82
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
83
83
  * `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 `behavior`.
84
84
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
data/docs/bundle.md CHANGED
@@ -102,7 +102,7 @@ Files::Bundle.list(
102
102
  ### Parameters
103
103
 
104
104
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
105
- * `cursor` (string): Used for pagination. Send a cursor value 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.
105
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
106
106
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
107
107
  * `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 `created_at` and `code`.
108
108
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
@@ -31,7 +31,7 @@ Files::BundleDownload.list(
31
31
 
32
32
  ### Parameters
33
33
 
34
- * `cursor` (string): Used for pagination. Send a cursor value 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.
34
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
36
  * `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 `created_at`.
37
37
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
@@ -37,7 +37,7 @@ Files::BundleRecipient.list(
37
37
  ### Parameters
38
38
 
39
39
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
40
- * `cursor` (string): Used for pagination. Send a cursor value 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.
40
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
42
  * `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 `has_registrations`.
43
43
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
@@ -48,6 +48,6 @@ Files::BundleRegistration.list(
48
48
  ### Parameters
49
49
 
50
50
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
51
- * `cursor` (string): Used for pagination. Send a cursor value 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.
51
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
52
52
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
53
53
  * `bundle_id` (int64): ID of the associated Bundle
data/docs/clickwrap.md CHANGED
@@ -33,7 +33,7 @@ Files::Clickwrap.list(
33
33
 
34
34
  ### Parameters
35
35
 
36
- * `cursor` (string): Used for pagination. Send a cursor value 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.
36
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
38
 
39
39
 
data/docs/dns_record.md CHANGED
@@ -29,5 +29,5 @@ Files::DnsRecord.list(
29
29
 
30
30
  ### Parameters
31
31
 
32
- * `cursor` (string): Used for pagination. Send a cursor value 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.
32
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
33
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
@@ -43,15 +43,15 @@ Files::ExternalEvent.list(
43
43
 
44
44
  ### Parameters
45
45
 
46
- * `cursor` (string): Used for pagination. Send a cursor value 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.
46
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
47
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
48
48
  * `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 `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
49
- * `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` or `folder_behavior_id`.
50
- * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
51
- * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
52
- * `filter_like` (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` or `folder_behavior_id`.
53
- * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
54
- * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
49
+ * `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` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
50
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
51
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
52
+ * `filter_like` (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` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
53
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
54
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
55
55
 
56
56
 
57
57
  ---
data/docs/file_comment.md CHANGED
@@ -31,7 +31,7 @@ Files::FileComment.list_for(path,
31
31
 
32
32
  ### Parameters
33
33
 
34
- * `cursor` (string): Used for pagination. Send a cursor value 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.
34
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
36
  * `path` (string): Required - Path to operate on.
37
37
 
data/docs/folder.md CHANGED
@@ -67,7 +67,7 @@ Files::Folder.list_for(path,
67
67
 
68
68
  ### Parameters
69
69
 
70
- * `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 header.
70
+ * `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 or the X-Files-Cursor-Prev header.
71
71
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
72
72
  * `path` (string): Required - Path to operate on.
73
73
  * `filter` (string): If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
@@ -56,7 +56,7 @@ Files::FormFieldSet.list(
56
56
  ### Parameters
57
57
 
58
58
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
59
- * `cursor` (string): Used for pagination. Send a cursor value 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.
59
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
60
60
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
61
 
62
62
 
data/docs/group.md CHANGED
@@ -39,7 +39,7 @@ Files::Group.list(
39
39
 
40
40
  ### Parameters
41
41
 
42
- * `cursor` (string): Used for pagination. Send a cursor value 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.
42
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
43
43
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
44
44
  * `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 `name`.
45
45
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
data/docs/group_user.md CHANGED
@@ -37,7 +37,7 @@ Files::GroupUser.list(
37
37
  ### Parameters
38
38
 
39
39
  * `user_id` (int64): User ID. If provided, will return group_users of this user.
40
- * `cursor` (string): Used for pagination. Send a cursor value 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.
40
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
42
  * `group_id` (int64): Group ID. If provided, will return group_users of this group.
43
43