Class: SafetyKit::Models::DeletionRequestCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/safety_kit/models/deletion_request_create_response.rb

Overview

Defined Under Namespace

Modules: Status

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(deletion_request_id:, status:, external_request_id: nil) ⇒ Object

Response returned after SafetyKit accepts and logs a deletion request.

Parameters:

  • deletion_request_id (String)

    SafetyKit correlation identifier for the logged deletion request.

  • status (Symbol, SafetyKit::Models::DeletionRequestCreateResponse::Status)

    Deletion request was accepted and logged.

  • external_request_id (String) (defaults to: nil)

    Caller-provided request identifier, if supplied.



# File 'lib/safety_kit/models/deletion_request_create_response.rb', line 25

Instance Attribute Details

#deletion_request_idString

SafetyKit correlation identifier for the logged deletion request.

Returns:

  • (String)


11
# File 'lib/safety_kit/models/deletion_request_create_response.rb', line 11

required :deletion_request_id, String

#external_request_idString?

Caller-provided request identifier, if supplied.

Returns:

  • (String, nil)


23
# File 'lib/safety_kit/models/deletion_request_create_response.rb', line 23

optional :external_request_id, String

#statusSymbol, SafetyKit::Models::DeletionRequestCreateResponse::Status

Deletion request was accepted and logged.



17
# File 'lib/safety_kit/models/deletion_request_create_response.rb', line 17

required :status, enum: -> { SafetyKit::Models::DeletionRequestCreateResponse::Status }