Class: Files::As2OutgoingMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/as2_outgoing_message.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ As2OutgoingMessage

Returns a new instance of As2OutgoingMessage.



7
8
9
10
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/as2_outgoing_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_outgoing_message.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



81
82
83
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 81

def self.all(params = {}, options = {})
  list(params, options)
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.

Raises:



71
72
73
74
75
76
77
78
79
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 71

def self.list(params = {}, options = {})
  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(As2OutgoingMessage, params) do
    Api.send_request("/as2_outgoing_messages", :get, params, options)
  end
end

Instance Method Details

#activity_log ⇒ Object

string - JSON Structure of the activity log.



33
34
35
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 33

def activity_log
  @attributes[:activity_log]
end

#as2_partner_id ⇒ Object

int64 - Id of the AS2 Partner associated with this message.



18
19
20
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 18

def as2_partner_id
  @attributes[:as2_partner_id]
end

#attachment_filename ⇒ Object

string - Filename of the file being sent.



58
59
60
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 58

def attachment_filename
  @attributes[:attachment_filename]
end

#body_size ⇒ Object

string - Encrypted Payload Body Size



53
54
55
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 53

def body_size
  @attributes[:body_size]
end

#created_at ⇒ Object

date-time - Message creation date/time



63
64
65
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 63

def created_at
  @attributes[:created_at]
end

#http_headers ⇒ Object

object - HTTP Headers sent with this message.



28
29
30
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 28

def http_headers
  @attributes[:http_headers]
end

#id ⇒ Object

int64 - Id of the AS2 Partner.



13
14
15
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 13

def id
  @attributes[:id]
end

#message_id ⇒ Object

string - AS2 Message Id



48
49
50
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 48

def message_id
  @attributes[:message_id]
end

#mic ⇒ Object

string - AS2 Message Integrity Check



43
44
45
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 43

def mic
  @attributes[:mic]
end

#processing_result ⇒ Object

string - Result of processing. Valid values: ‘send_failed`, `send_success`



38
39
40
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 38

def processing_result
  @attributes[:processing_result]
end

#uuid ⇒ Object

string - UUID assigned to this message.



23
24
25
 
# File 'lib/files.com/models/as2_outgoing_message.rb', line 23

def uuid
  @attributes[:uuid]
end