Class: Files::As2IncomingMessage
- Inherits:
-
Object
- Object
- Files::As2IncomingMessage
- Defined in:
- lib/files.com/models/as2_incoming_message.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
Instance Method Summary collapse
-
#activity_log ⇒ Object
string - JSON Structure of the activity log.
-
#as2_from ⇒ Object
string - AS2 FROM header of message.
-
#as2_partner_id ⇒ Object
int64 - Id of the AS2 Partner associated with this message.
-
#as2_station_id ⇒ Object
int64 - Id of the AS2 Station associated with this message.
-
#as2_to ⇒ Object
string - AS2 TO header of message.
-
#attachment_filename ⇒ Object
string - Filename of the file being received.
-
#body_size ⇒ Object
string - Encrypted Payload Body Size.
-
#content_type ⇒ Object
string - Content Type header of the incoming message.
-
#created_at ⇒ Object
date-time - Message creation date/time.
-
#date ⇒ Object
string - Date Header.
-
#encrypted_uri ⇒ Object
string - URL to download the encrypted signed smime that is to sent as AS2 body.
-
#hex_recipient_serial ⇒ Object
string - Incoming Message Recipient(the Client Cert used to encrypt this message)‘s serial in hex format.
-
#http_headers ⇒ Object
object - HTTP Headers sent with this message.
-
#http_response_code ⇒ Object
string - HTTP Response Code sent for this message.
-
#http_response_headers ⇒ Object
object - HTTP Headers sent for this message.
-
#id ⇒ Object
int64 - Id of the AS2 Partner.
-
#initialize(attributes = {}, options = {}) ⇒ As2IncomingMessage
constructor
A new instance of As2IncomingMessage.
-
#ip ⇒ Object
string - IP Address of the Sender.
-
#mdn_response_uri ⇒ Object
string - URL to download the http response body.
-
#message_decrypted ⇒ Object
boolean - Message decrypted successfully?.
-
#message_id ⇒ Object
string - AS2 Message Id.
-
#message_mdn_returned ⇒ Object
boolean - MDN returned?.
-
#message_processing_success ⇒ Object
boolean - Message processed successfully?.
-
#message_received ⇒ Object
boolean - Message body received?.
-
#message_signature_verified ⇒ Object
boolean - Message signature verified?.
-
#mic ⇒ Object
string - AS2 Message Integrity Check.
-
#mic_algo ⇒ Object
string - AS2 Message Integrity Check Algorithm Used.
-
#processing_result ⇒ Object
string - Result of processing.
-
#raw_uri ⇒ Object
string - URL to download the original file contents.
-
#recipient_issuer ⇒ Object
string - Incoming Message Recipient(the Client Cert used to encrypt this message)‘s issuer.
-
#recipient_serial ⇒ Object
string - Incoming Message Recipient(the Client Cert used to encrypt this message)‘s serial.
-
#smime_signed_uri ⇒ Object
string - URL to download the file contents as smime with signature.
-
#smime_uri ⇒ Object
string - URL to download the file contents encoded as smime.
-
#subject ⇒ Object
string - AS2 Subject Header.
-
#uuid ⇒ Object
string - UUID assigned to this message.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ As2IncomingMessage
Returns a new instance of As2IncomingMessage.
7 8 9 10 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 7 def initialize(attributes = {}, = {}) @attributes = attributes || {} @options = || {} end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
5 6 7 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
196 197 198 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 196 def self.all(params = {}, = {}) list(params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
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.
per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
as2_partner_id - int64 - As2 Partner ID. If provided, will return message specific to that partner.
186 187 188 189 190 191 192 193 194 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 186 def self.list(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String) raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: as2_partner_id must be an Integer") if params.dig(:as2_partner_id) and !params.dig(:as2_partner_id).is_a?(Integer) List.new(As2IncomingMessage, params) do Api.send_request("/as2_incoming_messages", :get, params, ) end end |
Instance Method Details
#activity_log ⇒ Object
string - JSON Structure of the activity log.
43 44 45 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 43 def activity_log @attributes[:activity_log] end |
#as2_from ⇒ Object
string - AS2 FROM header of message
68 69 70 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 68 def as2_from @attributes[:as2_from] end |
#as2_partner_id ⇒ Object
int64 - Id of the AS2 Partner associated with this message.
18 19 20 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 18 def as2_partner_id @attributes[:as2_partner_id] end |
#as2_station_id ⇒ Object
int64 - Id of the AS2 Station associated with this message.
23 24 25 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 23 def as2_station_id @attributes[:as2_station_id] end |
#as2_to ⇒ Object
string - AS2 TO header of message
63 64 65 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 63 def as2_to @attributes[:as2_to] end |
#attachment_filename ⇒ Object
string - Filename of the file being received.
93 94 95 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 93 def @attributes[:attachment_filename] end |
#body_size ⇒ Object
string - Encrypted Payload Body Size
88 89 90 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 88 def body_size @attributes[:body_size] end |
#content_type ⇒ Object
string - Content Type header of the incoming message.
33 34 35 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 33 def content_type @attributes[:content_type] end |
#created_at ⇒ Object
date-time - Message creation date/time
103 104 105 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 103 def created_at @attributes[:created_at] end |
#date ⇒ Object
string - Date Header
83 84 85 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 83 def date @attributes[:date] end |
#encrypted_uri ⇒ Object
string - URL to download the encrypted signed smime that is to sent as AS2 body
158 159 160 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 158 def encrypted_uri @attributes[:encrypted_uri] end |
#hex_recipient_serial ⇒ Object
string - Incoming Message Recipient(the Client Cert used to encrypt this message)‘s serial in hex format.
123 124 125 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 123 def hex_recipient_serial @attributes[:hex_recipient_serial] end |
#http_headers ⇒ Object
object - HTTP Headers sent with this message.
38 39 40 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 38 def http_headers @attributes[:http_headers] end |
#http_response_code ⇒ Object
string - HTTP Response Code sent for this message
108 109 110 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 108 def http_response_code @attributes[:http_response_code] end |
#http_response_headers ⇒ Object
object - HTTP Headers sent for this message.
113 114 115 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 113 def http_response_headers @attributes[:http_response_headers] end |
#id ⇒ Object
int64 - Id of the AS2 Partner.
13 14 15 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 13 def id @attributes[:id] end |
#ip ⇒ Object
string - IP Address of the Sender
98 99 100 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 98 def ip @attributes[:ip] end |
#mdn_response_uri ⇒ Object
string - URL to download the http response body
178 179 180 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 178 def mdn_response_uri @attributes[:mdn_response_uri] end |
#message_decrypted ⇒ Object
boolean - Message decrypted successfully?
138 139 140 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 138 def @attributes[:message_decrypted] end |
#message_id ⇒ Object
string - AS2 Message Id
73 74 75 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 73 def @attributes[:message_id] end |
#message_mdn_returned ⇒ Object
boolean - MDN returned?
153 154 155 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 153 def @attributes[:message_mdn_returned] end |
#message_processing_success ⇒ Object
boolean - Message processed successfully?
148 149 150 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 148 def @attributes[:message_processing_success] end |
#message_received ⇒ Object
boolean - Message body received?
133 134 135 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 133 def @attributes[:message_received] end |
#message_signature_verified ⇒ Object
boolean - Message signature verified?
143 144 145 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 143 def @attributes[:message_signature_verified] end |
#mic ⇒ Object
string - AS2 Message Integrity Check
53 54 55 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 53 def mic @attributes[:mic] end |
#mic_algo ⇒ Object
string - AS2 Message Integrity Check Algorithm Used
58 59 60 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 58 def mic_algo @attributes[:mic_algo] end |
#processing_result ⇒ Object
string - Result of processing.
48 49 50 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 48 def processing_result @attributes[:processing_result] end |
#raw_uri ⇒ Object
string - URL to download the original file contents
173 174 175 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 173 def raw_uri @attributes[:raw_uri] end |
#recipient_issuer ⇒ Object
string - Incoming Message Recipient(the Client Cert used to encrypt this message)‘s issuer
128 129 130 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 128 def recipient_issuer @attributes[:recipient_issuer] end |
#recipient_serial ⇒ Object
string - Incoming Message Recipient(the Client Cert used to encrypt this message)‘s serial
118 119 120 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 118 def recipient_serial @attributes[:recipient_serial] end |
#smime_signed_uri ⇒ Object
string - URL to download the file contents as smime with signature
163 164 165 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 163 def smime_signed_uri @attributes[:smime_signed_uri] end |
#smime_uri ⇒ Object
string - URL to download the file contents encoded as smime
168 169 170 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 168 def smime_uri @attributes[:smime_uri] end |
#subject ⇒ Object
string - AS2 Subject Header
78 79 80 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 78 def subject @attributes[:subject] end |
#uuid ⇒ Object
string - UUID assigned to this message.
28 29 30 |
# File 'lib/files.com/models/as2_incoming_message.rb', line 28 def uuid @attributes[:uuid] end |