Class: Inttegro::MessageTemplate::ScannedLink

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/message_template/scanned_link.rb

Overview

Typed representation of the scanned link object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#host ⇒ String? (readonly)

Value of the host field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: host.

Returns:

  • (String, nil) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/message_template/scanned_link.rb', line 47

class ScannedLink < T::Struct
  const :host, T.nilable(String), default: nil
  const :raw, String
  const :reason, T.nilable(String), default: nil
  const :scheme, String
  const :status, String
end

#raw ⇒ String (readonly)

Value of the raw field in the Inttegro API payload.

Required in the API payload. Wire name: raw.

Returns:

  • (String) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/message_template/scanned_link.rb', line 47

class ScannedLink < T::Struct
  const :host, T.nilable(String), default: nil
  const :raw, String
  const :reason, T.nilable(String), default: nil
  const :scheme, String
  const :status, String
end

#reason ⇒ String? (readonly)

Value of the reason field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: reason.

Returns:

  • (String, nil) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/message_template/scanned_link.rb', line 47

class ScannedLink < T::Struct
  const :host, T.nilable(String), default: nil
  const :raw, String
  const :reason, T.nilable(String), default: nil
  const :scheme, String
  const :status, String
end

#scheme ⇒ String (readonly)

Value of the scheme field in the Inttegro API payload.

Required in the API payload. Wire name: scheme.

Returns:

  • (String) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/message_template/scanned_link.rb', line 47

class ScannedLink < T::Struct
  const :host, T.nilable(String), default: nil
  const :raw, String
  const :reason, T.nilable(String), default: nil
  const :scheme, String
  const :status, String
end

#status ⇒ String (readonly)

Value of the status field in the Inttegro API payload.

Required in the API payload. Wire name: status.

Returns:

  • (String) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/message_template/scanned_link.rb', line 47

class ScannedLink < T::Struct
  const :host, T.nilable(String), default: nil
  const :raw, String
  const :reason, T.nilable(String), default: nil
  const :scheme, String
  const :status, String
end