Class: Inttegro::Chime::PageRequest

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

Overview

Request to retrieve a page of chimes

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

#customer_id ⇒ String? (readonly)

Restrict the page to chimes associated with this customer

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

Returns:

  • (String, nil) 


42
43
44
45
46
47
 
# File 'lib/inttegro/chime/page_request.rb', line 42

class PageRequest < T::Struct
  const :customer_id, T.nilable(String), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :recipient, T.nilable(String), default: nil
end

#page_number ⇒ Integer? (readonly)

1-based page index to fetch

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

Returns:

  • (Integer, nil) 


42
43
44
45
46
47
 
# File 'lib/inttegro/chime/page_request.rb', line 42

class PageRequest < T::Struct
  const :customer_id, T.nilable(String), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :recipient, T.nilable(String), default: nil
end

#page_size ⇒ Integer? (readonly)

Number of chimes to return

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

Returns:

  • (Integer, nil) 


42
43
44
45
46
47
 
# File 'lib/inttegro/chime/page_request.rb', line 42

class PageRequest < T::Struct
  const :customer_id, T.nilable(String), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :recipient, T.nilable(String), default: nil
end

#recipient ⇒ String? (readonly)

Restrict the page to chimes whose recipient exactly matches this phone number or email address

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

Returns:

  • (String, nil) 


42
43
44
45
46
47
 
# File 'lib/inttegro/chime/page_request.rb', line 42

class PageRequest < T::Struct
  const :customer_id, T.nilable(String), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :recipient, T.nilable(String), default: nil
end