Class: Inttegro::Search::Result

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/search/result.rb

Overview

Typed representation of the result 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

#amount ⇒ Inttegro::Money::Amount? (readonly)

Value of the amount field in the Inttegro API payload.

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

Returns:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end

#customer_name ⇒ String? (readonly)

Value of the customer_name field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end

#resource ⇒ Inttegro::Search::ResourceReference (readonly)

Value of the resource field in the Inttegro API payload.

Required in the API payload. Wire name: resource.

Returns:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end

#status ⇒ String? (readonly)

Value of the status field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end

#summary ⇒ String? (readonly)

Value of the summary field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end

#title ⇒ String (readonly)

Value of the title field in the Inttegro API payload.

Required in the API payload. Wire name: title.

Returns:

  • (String) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end

#updated_at ⇒ Time (readonly)

Value of the updated_at field in the Inttegro API payload.

Required in the API payload. Wire name: updated_at.

Returns:

  • (Time) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end

#url ⇒ String? (readonly)

Value of the url field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/search/result.rb', line 67

class Result < T::Struct
  const :resource, Inttegro::Search::ResourceReference
  const :title, String
  const :summary, T.nilable(String), default: nil
  const :status, T.nilable(String), default: nil
  const :customer_name, T.nilable(String), default: nil
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :url, T.nilable(String), default: nil
  const :updated_at, Time
end