Class: Inttegro::MessageTemplate::PageRequest

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

Overview

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

#channel ⇒ Inttegro::MessageTemplate::Channel? (readonly)

Value of the channel field in the Inttegro API payload.

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

Returns:



55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/page_request.rb', line 55

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :status, T.nilable(Inttegro::MessageTemplate::Status), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
end

#locale ⇒ String? (readonly)

Value of the locale field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/page_request.rb', line 55

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :status, T.nilable(Inttegro::MessageTemplate::Status), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
end

#page ⇒ Integer? (readonly)

Value of the page field in the Inttegro API payload.

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

Returns:

  • (Integer, nil) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/page_request.rb', line 55

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :status, T.nilable(Inttegro::MessageTemplate::Status), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
end

#purpose ⇒ String? (readonly)

Value of the purpose field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/page_request.rb', line 55

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :status, T.nilable(Inttegro::MessageTemplate::Status), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
end

#size ⇒ Integer? (readonly)

Value of the size field in the Inttegro API payload.

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

Returns:

  • (Integer, nil) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/page_request.rb', line 55

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :status, T.nilable(Inttegro::MessageTemplate::Status), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
end

#status ⇒ Inttegro::MessageTemplate::Status? (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:



55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/page_request.rb', line 55

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :status, T.nilable(Inttegro::MessageTemplate::Status), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
end