Class: Courier::Models::PublishPreferencesResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/publish_preferences_response.rb

Overview

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(page_id:, published_at:, published_version:, preview_url: nil, published_by: nil) ⇒ Object

Result of publishing the workspace’s preferences page.

Parameters:

  • page_id (String) —

    Id of the published page snapshot.

  • published_at (String) —

    ISO-8601 timestamp of the publish.

  • published_version (Float) —

    Monotonic published version (epoch milliseconds).

  • preview_url (String, nil) (defaults to: nil) —

    Draft-mode hosted preferences page URL for previewing.

  • published_by (String, nil) (defaults to: nil) —

    Id of the publisher.




# File 'lib/courier/models/publish_preferences_response.rb', line 37

Instance Attribute Details

#page_id ⇒ String

Id of the published page snapshot.

Returns:

  • (String) 


11
 
# File 'lib/courier/models/publish_preferences_response.rb', line 11

required :page_id, String

#preview_url ⇒ String?

Draft-mode hosted preferences page URL for previewing.

Returns:

  • (String, nil) 


29
 
# File 'lib/courier/models/publish_preferences_response.rb', line 29

optional :preview_url, String, nil?: true

#published_at ⇒ String

ISO-8601 timestamp of the publish.

Returns:

  • (String) 


17
 
# File 'lib/courier/models/publish_preferences_response.rb', line 17

required :published_at, String

#published_by ⇒ String?

Id of the publisher.

Returns:

  • (String, nil) 


35
 
# File 'lib/courier/models/publish_preferences_response.rb', line 35

optional :published_by, String, nil?: true

#published_version ⇒ Float

Monotonic published version (epoch milliseconds).

Returns:

  • (Float) 


23
 
# File 'lib/courier/models/publish_preferences_response.rb', line 23

required :published_version, Float