files.com 1.1.771 → 1.1.773

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 (65) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/as2_partner.md +10 -2
  4. data/docs/as2_station.md +20 -13
  5. data/docs/event_subscription.md +12 -5
  6. data/lib/files.com/models/ai_assistant_personality.rb +3 -0
  7. data/lib/files.com/models/ai_task.rb +5 -0
  8. data/lib/files.com/models/api_key.rb +3 -0
  9. data/lib/files.com/models/as2_partner.rb +34 -2
  10. data/lib/files.com/models/as2_station.rb +44 -13
  11. data/lib/files.com/models/automation.rb +5 -0
  12. data/lib/files.com/models/behavior.rb +3 -0
  13. data/lib/files.com/models/bundle.rb +5 -0
  14. data/lib/files.com/models/bundle_notification.rb +3 -0
  15. data/lib/files.com/models/child_site_management_policy.rb +3 -0
  16. data/lib/files.com/models/clickwrap.rb +3 -0
  17. data/lib/files.com/models/custom_domain.rb +3 -0
  18. data/lib/files.com/models/desktop_configuration_profile.rb +3 -0
  19. data/lib/files.com/models/event_channel.rb +3 -0
  20. data/lib/files.com/models/event_subscription.rb +7 -4
  21. data/lib/files.com/models/event_target.rb +3 -0
  22. data/lib/files.com/models/expectation.rb +3 -0
  23. data/lib/files.com/models/file.rb +4 -0
  24. data/lib/files.com/models/file_comment.rb +3 -0
  25. data/lib/files.com/models/file_comment_reaction.rb +3 -0
  26. data/lib/files.com/models/form_field_set.rb +3 -0
  27. data/lib/files.com/models/gpg_key.rb +3 -0
  28. data/lib/files.com/models/group.rb +3 -0
  29. data/lib/files.com/models/group_user.rb +4 -0
  30. data/lib/files.com/models/holiday_calendar.rb +3 -0
  31. data/lib/files.com/models/integration_centric_profile.rb +3 -0
  32. data/lib/files.com/models/key_lifecycle_rule.rb +3 -0
  33. data/lib/files.com/models/lock.rb +4 -0
  34. data/lib/files.com/models/metadata_category.rb +3 -0
  35. data/lib/files.com/models/notification.rb +3 -0
  36. data/lib/files.com/models/partner.rb +3 -0
  37. data/lib/files.com/models/partner_channel.rb +3 -0
  38. data/lib/files.com/models/partner_channel_template.rb +3 -0
  39. data/lib/files.com/models/partner_site.rb +3 -0
  40. data/lib/files.com/models/partner_site_request.rb +3 -0
  41. data/lib/files.com/models/permission.rb +3 -0
  42. data/lib/files.com/models/public_key.rb +3 -0
  43. data/lib/files.com/models/remote_mount_backend.rb +5 -0
  44. data/lib/files.com/models/remote_server.rb +3 -0
  45. data/lib/files.com/models/remote_server_credential.rb +3 -0
  46. data/lib/files.com/models/request.rb +3 -0
  47. data/lib/files.com/models/schedule.rb +3 -0
  48. data/lib/files.com/models/scheduled_export.rb +3 -0
  49. data/lib/files.com/models/secret.rb +3 -0
  50. data/lib/files.com/models/session.rb +1 -0
  51. data/lib/files.com/models/sftp_host_key.rb +3 -0
  52. data/lib/files.com/models/share_group.rb +3 -0
  53. data/lib/files.com/models/siem_http_destination.rb +3 -0
  54. data/lib/files.com/models/site_subdomain_redirect.rb +3 -0
  55. data/lib/files.com/models/snapshot.rb +5 -0
  56. data/lib/files.com/models/sso_strategy.rb +2 -0
  57. data/lib/files.com/models/style.rb +3 -0
  58. data/lib/files.com/models/sync.rb +7 -0
  59. data/lib/files.com/models/user.rb +10 -0
  60. data/lib/files.com/models/user_additional_email_recipient.rb +3 -0
  61. data/lib/files.com/models/user_lifecycle_rule.rb +3 -0
  62. data/lib/files.com/models/user_request.rb +3 -0
  63. data/lib/files.com/models/workspace.rb +3 -0
  64. data/lib/files.com/version.rb +1 -1
  65. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ba2233176acec459a9153f352067ae5b7e82a69f8d20d9e9635a1da0760896f1
4
- data.tar.gz: 82536ede5376f998ba6c0827cdf349041daf7c313cf08295aa354d9643394606
3
+ metadata.gz: 07f3cc24cf0891a91c9feaf9fdeeae39301d8b23a32207616eba7db5cc070ace
4
+ data.tar.gz: b1619f673e77c0a9423c8083ec425a6ea26f61cd9a1d6aa9629be3d6e0f70cf6
5
5
  SHA512:
6
- metadata.gz: '0279639e4ed0268c37345eaf3329fac1311ef5cbb24ae92eeebda299fec69cbc0c0b2c38168e652111d1e1b7c756f68fcf194b541d73209b3d4f773cee9efa05'
7
- data.tar.gz: 33a7181f562e76dae23dc6a54b6d60aad77ddfb5cf8dc2fbb27667a0f4bb656b64be3a0dbb03e4bb726b2e28a4c8f19ce71ce729e53f857a67e9bc484fd9d5be
6
+ metadata.gz: 85ca525bf43d05c3cf61e12aaea2fc9c22a97f8b2c31a8e136e6840d7578e8e88bb703d49c850068286195f89bf5c943371dead5f15ab813cae0a700f661e1f5
7
+ data.tar.gz: 4fad3a9f835494fc420493feac4aed82c9ad1d4a23a14674fffdcaece12c3d5ba5480b53a60a337851d5a1bfcc840cae3b4988eabe7c58c8123f131091bcf9fc
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.771
1
+ 1.1.773
data/docs/as2_partner.md CHANGED
@@ -50,6 +50,8 @@
50
50
  * `public_certificate_not_before` (string): Not before value of public certificate used for message security.
51
51
  * `public_certificate_not_after` (string): Not after value of public certificate used for message security.
52
52
  * `http_auth_password` (string): Password to send to server for HTTP Authentication.
53
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
54
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
53
55
 
54
56
 
55
57
  ---
@@ -97,7 +99,7 @@ Files::As2Partner.create(
97
99
  as2_station_id: 1,
98
100
  name: "AS2 Partner Name",
99
101
  uri: "example",
100
- public_certificate: "public_certificate"
102
+ public_certificate: "example"
101
103
  )
102
104
  ```
103
105
 
@@ -114,7 +116,9 @@ Files::As2Partner.create(
114
116
  * `as2_station_id` (int64): Required - ID of the AS2 Station associated with this partner.
115
117
  * `name` (string): Required - The partner's formal AS2 name.
116
118
  * `uri` (string): Required - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
117
- * `public_certificate` (string): Required - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
119
+ * `public_certificate` (string): Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
120
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
121
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
118
122
 
119
123
 
120
124
  ---
@@ -150,6 +154,8 @@ Files::As2Partner.update(id,
150
154
  * `name` (string): The partner's formal AS2 name.
151
155
  * `uri` (string): Public URI where we will send the AS2 messages (via HTTP/HTTPS).
152
156
  * `public_certificate` (string): Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
157
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
158
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
153
159
 
154
160
 
155
161
  ---
@@ -200,6 +206,8 @@ as2_partner.update(
200
206
  * `name` (string): The partner's formal AS2 name.
201
207
  * `uri` (string): Public URI where we will send the AS2 messages (via HTTP/HTTPS).
202
208
  * `public_certificate` (string): Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
209
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
210
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
203
211
 
204
212
 
205
213
  ---
data/docs/as2_station.md CHANGED
@@ -37,8 +37,10 @@
37
37
  * `public_certificate_not_before` (string): Not before value of public certificate used for message security.
38
38
  * `public_certificate_not_after` (string): Not after value of public certificate used for message security.
39
39
  * `private_key_password_md5` (string): MD5 hash of private key password used for message security.
40
- * `private_key` (string):
41
- * `private_key_password` (string):
40
+ * `private_key` (string): PEM-encoded private key matching public_certificate.
41
+ * `private_key_password` (string): Password for the PEM-encoded private key.
42
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's certificate and private key. Provide this instead of public_certificate and private_key.
43
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
42
44
 
43
45
 
44
46
  ---
@@ -78,8 +80,7 @@ Files::As2Station.find(id)
78
80
  Files::As2Station.create(
79
81
  name: "AS2 Station Name",
80
82
  workspace_id: 1,
81
- public_certificate: "public_certificate",
82
- private_key: "private_key"
83
+ public_certificate: "example"
83
84
  )
84
85
  ```
85
86
 
@@ -87,9 +88,11 @@ Files::As2Station.create(
87
88
 
88
89
  * `name` (string): Required - The station's formal AS2 name.
89
90
  * `workspace_id` (int64): ID of the Workspace associated with this AS2 Station.
90
- * `public_certificate` (string): Required -
91
- * `private_key` (string): Required -
92
- * `private_key_password` (string):
91
+ * `public_certificate` (string): Public certificate used for message security.
92
+ * `private_key` (string): PEM-encoded private key matching public_certificate.
93
+ * `private_key_password` (string): Password for the PEM-encoded private key.
94
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's certificate and private key. Provide this instead of public_certificate and private_key.
95
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
93
96
 
94
97
 
95
98
  ---
@@ -107,9 +110,11 @@ Files::As2Station.update(id,
107
110
 
108
111
  * `id` (int64): Required - As2 Station ID.
109
112
  * `name` (string): The station's formal AS2 name.
110
- * `public_certificate` (string):
111
- * `private_key` (string):
112
- * `private_key_password` (string):
113
+ * `public_certificate` (string): Public certificate used for message security.
114
+ * `private_key` (string): PEM-encoded private key matching public_certificate.
115
+ * `private_key_password` (string): Password for the PEM-encoded private key.
116
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's replacement certificate and private key. Provide this instead of public_certificate and private_key.
117
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
113
118
 
114
119
 
115
120
  ---
@@ -142,9 +147,11 @@ as2_station.update(
142
147
 
143
148
  * `id` (int64): Required - As2 Station ID.
144
149
  * `name` (string): The station's formal AS2 name.
145
- * `public_certificate` (string):
146
- * `private_key` (string):
147
- * `private_key_password` (string):
150
+ * `public_certificate` (string): Public certificate used for message security.
151
+ * `private_key` (string): PEM-encoded private key matching public_certificate.
152
+ * `private_key_password` (string): Password for the PEM-encoded private key.
153
+ * `pkcs12` (string): Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's replacement certificate and private key. Provide this instead of public_certificate and private_key.
154
+ * `pkcs12_password` (string): Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
148
155
 
149
156
 
150
157
  ---
@@ -16,7 +16,14 @@
16
16
  "event_types": [
17
17
  "sync_run.failure.v1"
18
18
  ],
19
- "filter": "example",
19
+ "filter": {
20
+ "payload.sync_name": {
21
+ "prefix": "Nightly"
22
+ },
23
+ "payload.event_errors": {
24
+ "exists": true
25
+ }
26
+ },
20
27
  "delivery_policy": "example",
21
28
  "event_target_ids": [
22
29
  1
@@ -36,7 +43,7 @@
36
43
  * `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
37
44
  * `enabled` (boolean): Whether this Event Subscription can dispatch events.
38
45
  * `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
39
- * `filter` (object): Structured event payload filter.
46
+ * `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
40
47
  * `delivery_policy` (object): Event Subscription delivery policy.
41
48
  * `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
42
49
  * `created_at` (date-time): Event Subscription create date/time.
@@ -103,7 +110,7 @@ Files::EventSubscription.create(
103
110
  * `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
104
111
  * `enabled` (boolean): Whether this Event Subscription can dispatch events.
105
112
  * `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
106
- * `filter` (object): Structured event payload filter.
113
+ * `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
107
114
  * `delivery_policy` (object): Event Subscription delivery policy.
108
115
  * `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
109
116
 
@@ -140,7 +147,7 @@ Files::EventSubscription.update(id,
140
147
  * `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
141
148
  * `enabled` (boolean): Whether this Event Subscription can dispatch events.
142
149
  * `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
143
- * `filter` (object): Structured event payload filter.
150
+ * `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
144
151
  * `delivery_policy` (object): Event Subscription delivery policy.
145
152
  * `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
146
153
 
@@ -192,7 +199,7 @@ event_subscription.update(
192
199
  * `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
193
200
  * `enabled` (boolean): Whether this Event Subscription can dispatch events.
194
201
  * `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
195
- * `filter` (object): Structured event payload filter.
202
+ * `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
196
203
  * `delivery_policy` (object): Event Subscription delivery policy.
197
204
  * `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
198
205
 
@@ -94,6 +94,7 @@ module Files
94
94
  [ response, options ]
95
95
  end
96
96
 
97
+ # Returns the [response, options] pair from Files::Api.send_request.
97
98
  def delete(params = {})
98
99
  params ||= {}
99
100
  params[:id] = @attributes[:id]
@@ -104,6 +105,7 @@ module Files
104
105
  Api.send_request("/ai_assistant_personalities/#{@attributes[:id]}", :delete, params, @options)
105
106
  end
106
107
 
108
+ # Alias for #delete. Returns nil.
107
109
  def destroy(params = {})
108
110
  delete(params)
109
111
  nil
@@ -226,6 +228,7 @@ module Files
226
228
  nil
227
229
  end
228
230
 
231
+ # Alias for ::delete. Returns nil.
229
232
  def self.destroy(id, params = {}, options = {})
230
233
  delete(id, params, options)
231
234
  nil
@@ -218,6 +218,8 @@ module Files
218
218
  end
219
219
 
220
220
  # Manually Run AI Task
221
+ #
222
+ # Returns the [response, options] pair from Files::Api.send_request.
221
223
  def manual_run(params = {})
222
224
  params ||= {}
223
225
  params[:id] = @attributes[:id]
@@ -276,6 +278,7 @@ module Files
276
278
  [ response, options ]
277
279
  end
278
280
 
281
+ # Returns the [response, options] pair from Files::Api.send_request.
279
282
  def delete(params = {})
280
283
  params ||= {}
281
284
  params[:id] = @attributes[:id]
@@ -286,6 +289,7 @@ module Files
286
289
  Api.send_request("/ai_tasks/#{@attributes[:id]}", :delete, params, @options)
287
290
  end
288
291
 
292
+ # Alias for #delete. Returns nil.
289
293
  def destroy(params = {})
290
294
  delete(params)
291
295
  nil
@@ -478,6 +482,7 @@ module Files
478
482
  nil
479
483
  end
480
484
 
485
+ # Alias for ::delete. Returns nil.
481
486
  def self.destroy(id, params = {}, options = {})
482
487
  delete(id, params, options)
483
488
  nil
@@ -195,6 +195,7 @@ module Files
195
195
  [ response, options ]
196
196
  end
197
197
 
198
+ # Returns the [response, options] pair from Files::Api.send_request.
198
199
  def delete(params = {})
199
200
  params ||= {}
200
201
  params[:id] = @attributes[:id]
@@ -205,6 +206,7 @@ module Files
205
206
  Api.send_request("/api_keys/#{@attributes[:id]}", :delete, params, @options)
206
207
  end
207
208
 
209
+ # Alias for #delete. Returns nil.
208
210
  def destroy(params = {})
209
211
  delete(params)
210
212
  nil
@@ -377,6 +379,7 @@ module Files
377
379
  nil
378
380
  end
379
381
 
382
+ # Alias for ::delete. Returns nil.
380
383
  def self.destroy(id, params = {}, options = {})
381
384
  delete(id, params, options)
382
385
  nil
@@ -198,6 +198,24 @@ module Files
198
198
  @attributes[:http_auth_password] = value
199
199
  end
200
200
 
201
+ # string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
202
+ def pkcs12
203
+ @attributes[:pkcs12]
204
+ end
205
+
206
+ def pkcs12=(value)
207
+ @attributes[:pkcs12] = value
208
+ end
209
+
210
+ # string - Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
211
+ def pkcs12_password
212
+ @attributes[:pkcs12_password]
213
+ end
214
+
215
+ def pkcs12_password=(value)
216
+ @attributes[:pkcs12_password] = value
217
+ end
218
+
201
219
  # Parameters:
202
220
  # enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
203
221
  # http_auth_username - string - Username to send to server for HTTP Authentication.
@@ -210,6 +228,8 @@ module Files
210
228
  # name - string - The partner's formal AS2 name.
211
229
  # uri - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
212
230
  # public_certificate - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
231
+ # pkcs12 - string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
232
+ # pkcs12_password - string - Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
213
233
  def update(params = {})
214
234
  params ||= {}
215
235
  params[:id] = @attributes[:id]
@@ -224,6 +244,8 @@ module Files
224
244
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
225
245
  raise InvalidParameterError.new("Bad parameter: uri must be an String") if params[:uri] and !params[:uri].is_a?(String)
226
246
  raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
247
+ raise InvalidParameterError.new("Bad parameter: pkcs12 must be an String") if params[:pkcs12] and !params[:pkcs12].is_a?(String)
248
+ raise InvalidParameterError.new("Bad parameter: pkcs12_password must be an String") if params[:pkcs12_password] and !params[:pkcs12_password].is_a?(String)
227
249
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
228
250
 
229
251
  response, options = Api.send_request("/as2_partners/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("As2Partner") }
@@ -231,6 +253,7 @@ module Files
231
253
  [ response, options ]
232
254
  end
233
255
 
256
+ # Returns the [response, options] pair from Files::Api.send_request.
234
257
  def delete(params = {})
235
258
  params ||= {}
236
259
  params[:id] = @attributes[:id]
@@ -241,6 +264,7 @@ module Files
241
264
  Api.send_request("/as2_partners/#{@attributes[:id]}", :delete, params, @options)
242
265
  end
243
266
 
267
+ # Alias for #delete. Returns nil.
244
268
  def destroy(params = {})
245
269
  delete(params)
246
270
  nil
@@ -315,7 +339,9 @@ module Files
315
339
  # as2_station_id (required) - int64 - ID of the AS2 Station associated with this partner.
316
340
  # name (required) - string - The partner's formal AS2 name.
317
341
  # uri (required) - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
318
- # public_certificate (required) - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
342
+ # public_certificate - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
343
+ # pkcs12 - string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
344
+ # pkcs12_password - string - Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
319
345
  #
320
346
  # params:: Hash of API operation parameter values.
321
347
  # options:: Hash of optional request configuration passed to Files::Api.send_request.
@@ -333,10 +359,11 @@ module Files
333
359
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
334
360
  raise InvalidParameterError.new("Bad parameter: uri must be an String") if params[:uri] and !params[:uri].is_a?(String)
335
361
  raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
362
+ raise InvalidParameterError.new("Bad parameter: pkcs12 must be an String") if params[:pkcs12] and !params[:pkcs12].is_a?(String)
363
+ raise InvalidParameterError.new("Bad parameter: pkcs12_password must be an String") if params[:pkcs12_password] and !params[:pkcs12_password].is_a?(String)
336
364
  raise MissingParameterError.new("Parameter missing: as2_station_id") unless params[:as2_station_id]
337
365
  raise MissingParameterError.new("Parameter missing: name") unless params[:name]
338
366
  raise MissingParameterError.new("Parameter missing: uri") unless params[:uri]
339
- raise MissingParameterError.new("Parameter missing: public_certificate") unless params[:public_certificate]
340
367
 
341
368
  response, options = Api.send_request("/as2_partners", :post, params, options) { |reply| reply.require_object("As2Partner") }
342
369
  As2Partner.new(response.data, options)
@@ -354,6 +381,8 @@ module Files
354
381
  # name - string - The partner's formal AS2 name.
355
382
  # uri - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
356
383
  # public_certificate - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
384
+ # pkcs12 - string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one certificate.
385
+ # pkcs12_password - string - Password for pkcs12. The file and password are used only for import; the extracted public certificate is stored as PEM.
357
386
  #
358
387
  # params:: Hash of API operation parameter values.
359
388
  # options:: Hash of optional request configuration passed to Files::Api.send_request.
@@ -373,6 +402,8 @@ module Files
373
402
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
374
403
  raise InvalidParameterError.new("Bad parameter: uri must be an String") if params[:uri] and !params[:uri].is_a?(String)
375
404
  raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
405
+ raise InvalidParameterError.new("Bad parameter: pkcs12 must be an String") if params[:pkcs12] and !params[:pkcs12].is_a?(String)
406
+ raise InvalidParameterError.new("Bad parameter: pkcs12_password must be an String") if params[:pkcs12_password] and !params[:pkcs12_password].is_a?(String)
376
407
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
377
408
 
378
409
  response, options = Api.send_request("/as2_partners/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("As2Partner") }
@@ -393,6 +424,7 @@ module Files
393
424
  nil
394
425
  end
395
426
 
427
+ # Alias for ::delete. Returns nil.
396
428
  def self.destroy(id, params = {}, options = {})
397
429
  delete(id, params, options)
398
430
  nil
@@ -144,7 +144,7 @@ module Files
144
144
  @attributes[:private_key_password_md5] = value
145
145
  end
146
146
 
147
- # string
147
+ # string - PEM-encoded private key matching public_certificate.
148
148
  def private_key
149
149
  @attributes[:private_key]
150
150
  end
@@ -153,7 +153,7 @@ module Files
153
153
  @attributes[:private_key] = value
154
154
  end
155
155
 
156
- # string
156
+ # string - Password for the PEM-encoded private key.
157
157
  def private_key_password
158
158
  @attributes[:private_key_password]
159
159
  end
@@ -162,11 +162,31 @@ module Files
162
162
  @attributes[:private_key_password] = value
163
163
  end
164
164
 
165
+ # string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's certificate and private key. Provide this instead of public_certificate and private_key.
166
+ def pkcs12
167
+ @attributes[:pkcs12]
168
+ end
169
+
170
+ def pkcs12=(value)
171
+ @attributes[:pkcs12] = value
172
+ end
173
+
174
+ # string - Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
175
+ def pkcs12_password
176
+ @attributes[:pkcs12_password]
177
+ end
178
+
179
+ def pkcs12_password=(value)
180
+ @attributes[:pkcs12_password] = value
181
+ end
182
+
165
183
  # Parameters:
166
184
  # name - string - The station's formal AS2 name.
167
- # public_certificate - string
168
- # private_key - string
169
- # private_key_password - string
185
+ # public_certificate - string - Public certificate used for message security.
186
+ # private_key - string - PEM-encoded private key matching public_certificate.
187
+ # private_key_password - string - Password for the PEM-encoded private key.
188
+ # pkcs12 - string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's replacement certificate and private key. Provide this instead of public_certificate and private_key.
189
+ # pkcs12_password - string - Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
170
190
  def update(params = {})
171
191
  params ||= {}
172
192
  params[:id] = @attributes[:id]
@@ -176,6 +196,8 @@ module Files
176
196
  raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
177
197
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
178
198
  raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
199
+ raise InvalidParameterError.new("Bad parameter: pkcs12 must be an String") if params[:pkcs12] and !params[:pkcs12].is_a?(String)
200
+ raise InvalidParameterError.new("Bad parameter: pkcs12_password must be an String") if params[:pkcs12_password] and !params[:pkcs12_password].is_a?(String)
179
201
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
180
202
 
181
203
  response, options = Api.send_request("/as2_stations/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("As2Station") }
@@ -183,6 +205,7 @@ module Files
183
205
  [ response, options ]
184
206
  end
185
207
 
208
+ # Returns the [response, options] pair from Files::Api.send_request.
186
209
  def delete(params = {})
187
210
  params ||= {}
188
211
  params[:id] = @attributes[:id]
@@ -193,6 +216,7 @@ module Files
193
216
  Api.send_request("/as2_stations/#{@attributes[:id]}", :delete, params, @options)
194
217
  end
195
218
 
219
+ # Alias for #delete. Returns nil.
196
220
  def destroy(params = {})
197
221
  delete(params)
198
222
  nil
@@ -258,9 +282,11 @@ module Files
258
282
  # Parameters:
259
283
  # name (required) - string - The station's formal AS2 name.
260
284
  # workspace_id - int64 - ID of the Workspace associated with this AS2 Station.
261
- # public_certificate (required) - string
262
- # private_key (required) - string
263
- # private_key_password - string
285
+ # public_certificate - string - Public certificate used for message security.
286
+ # private_key - string - PEM-encoded private key matching public_certificate.
287
+ # private_key_password - string - Password for the PEM-encoded private key.
288
+ # pkcs12 - string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's certificate and private key. Provide this instead of public_certificate and private_key.
289
+ # pkcs12_password - string - Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
264
290
  #
265
291
  # params:: Hash of API operation parameter values.
266
292
  # options:: Hash of optional request configuration passed to Files::Api.send_request.
@@ -272,9 +298,9 @@ module Files
272
298
  raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
273
299
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
274
300
  raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
301
+ raise InvalidParameterError.new("Bad parameter: pkcs12 must be an String") if params[:pkcs12] and !params[:pkcs12].is_a?(String)
302
+ raise InvalidParameterError.new("Bad parameter: pkcs12_password must be an String") if params[:pkcs12_password] and !params[:pkcs12_password].is_a?(String)
275
303
  raise MissingParameterError.new("Parameter missing: name") unless params[:name]
276
- raise MissingParameterError.new("Parameter missing: public_certificate") unless params[:public_certificate]
277
- raise MissingParameterError.new("Parameter missing: private_key") unless params[:private_key]
278
304
 
279
305
  response, options = Api.send_request("/as2_stations", :post, params, options) { |reply| reply.require_object("As2Station") }
280
306
  As2Station.new(response.data, options)
@@ -282,9 +308,11 @@ module Files
282
308
 
283
309
  # Parameters:
284
310
  # name - string - The station's formal AS2 name.
285
- # public_certificate - string
286
- # private_key - string
287
- # private_key_password - string
311
+ # public_certificate - string - Public certificate used for message security.
312
+ # private_key - string - PEM-encoded private key matching public_certificate.
313
+ # private_key_password - string - Password for the PEM-encoded private key.
314
+ # pkcs12 - string - Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's replacement certificate and private key. Provide this instead of public_certificate and private_key.
315
+ # pkcs12_password - string - Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.
288
316
  #
289
317
  # params:: Hash of API operation parameter values.
290
318
  # options:: Hash of optional request configuration passed to Files::Api.send_request.
@@ -298,6 +326,8 @@ module Files
298
326
  raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
299
327
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
300
328
  raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
329
+ raise InvalidParameterError.new("Bad parameter: pkcs12 must be an String") if params[:pkcs12] and !params[:pkcs12].is_a?(String)
330
+ raise InvalidParameterError.new("Bad parameter: pkcs12_password must be an String") if params[:pkcs12_password] and !params[:pkcs12_password].is_a?(String)
301
331
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
302
332
 
303
333
  response, options = Api.send_request("/as2_stations/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("As2Station") }
@@ -318,6 +348,7 @@ module Files
318
348
  nil
319
349
  end
320
350
 
351
+ # Alias for ::delete. Returns nil.
321
352
  def self.destroy(id, params = {}, options = {})
322
353
  delete(id, params, options)
323
354
  nil
@@ -429,6 +429,8 @@ module Files
429
429
  #
430
430
  # Parameters:
431
431
  # items - array(object) - Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
432
+ #
433
+ # Returns the [response, options] pair from Files::Api.send_request.
432
434
  def manual_run(params = {})
433
435
  params ||= {}
434
436
  params[:id] = @attributes[:id]
@@ -514,6 +516,7 @@ module Files
514
516
  [ response, options ]
515
517
  end
516
518
 
519
+ # Returns the [response, options] pair from Files::Api.send_request.
517
520
  def delete(params = {})
518
521
  params ||= {}
519
522
  params[:id] = @attributes[:id]
@@ -524,6 +527,7 @@ module Files
524
527
  Api.send_request("/automations/#{@attributes[:id]}", :delete, params, @options)
525
528
  end
526
529
 
530
+ # Alias for #delete. Returns nil.
527
531
  def destroy(params = {})
528
532
  delete(params)
529
533
  nil
@@ -810,6 +814,7 @@ module Files
810
814
  nil
811
815
  end
812
816
 
817
+ # Alias for ::delete. Returns nil.
813
818
  def self.destroy(id, params = {}, options = {})
814
819
  delete(id, params, options)
815
820
  nil
@@ -166,6 +166,7 @@ module Files
166
166
  [ response, options ]
167
167
  end
168
168
 
169
+ # Returns the [response, options] pair from Files::Api.send_request.
169
170
  def delete(params = {})
170
171
  params ||= {}
171
172
  params[:id] = @attributes[:id]
@@ -176,6 +177,7 @@ module Files
176
177
  Api.send_request("/behaviors/#{@attributes[:id]}", :delete, params, @options)
177
178
  end
178
179
 
180
+ # Alias for #delete. Returns nil.
179
181
  def destroy(params = {})
180
182
  delete(params)
181
183
  nil
@@ -358,6 +360,7 @@ module Files
358
360
  nil
359
361
  end
360
362
 
363
+ # Alias for ::delete. Returns nil.
361
364
  def self.destroy(id, params = {}, options = {})
362
365
  delete(id, params, options)
363
366
  nil
@@ -506,6 +506,8 @@ module Files
506
506
  # to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
507
507
  # note - string - Note to include in email.
508
508
  # recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
509
+ #
510
+ # Returns the [response, options] pair from Files::Api.send_request.
509
511
  def share(params = {})
510
512
  params ||= {}
511
513
  params[:id] = @attributes[:id]
@@ -582,6 +584,7 @@ module Files
582
584
  [ response, options ]
583
585
  end
584
586
 
587
+ # Returns the [response, options] pair from Files::Api.send_request.
585
588
  def delete(params = {})
586
589
  params ||= {}
587
590
  params[:id] = @attributes[:id]
@@ -592,6 +595,7 @@ module Files
592
595
  Api.send_request("/bundles/#{@attributes[:id]}", :delete, params, @options)
593
596
  end
594
597
 
598
+ # Alias for #delete. Returns nil.
595
599
  def destroy(params = {})
596
600
  delete(params)
597
601
  nil
@@ -838,6 +842,7 @@ module Files
838
842
  nil
839
843
  end
840
844
 
845
+ # Alias for ::delete. Returns nil.
841
846
  def self.destroy(id, params = {}, options = {})
842
847
  delete(id, params, options)
843
848
  nil
@@ -96,6 +96,7 @@ module Files
96
96
  [ response, options ]
97
97
  end
98
98
 
99
+ # Returns the [response, options] pair from Files::Api.send_request.
99
100
  def delete(params = {})
100
101
  params ||= {}
101
102
  params[:id] = @attributes[:id]
@@ -106,6 +107,7 @@ module Files
106
107
  Api.send_request("/bundle_notifications/#{@attributes[:id]}", :delete, params, @options)
107
108
  end
108
109
 
110
+ # Alias for #delete. Returns nil.
109
111
  def destroy(params = {})
110
112
  delete(params)
111
113
  nil
@@ -225,6 +227,7 @@ module Files
225
227
  nil
226
228
  end
227
229
 
230
+ # Alias for ::delete. Returns nil.
228
231
  def self.destroy(id, params = {}, options = {})
229
232
  delete(id, params, options)
230
233
  nil