Class: Knockapi::Models::MessageDeliveryLog::Request

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/message_delivery_log.rb

Overview

See Also:

Defined Under Namespace

Modules: Body, Method

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(body: nil, headers: nil, host: nil, method_: nil, path: nil, query: nil) ⇒ Object

A message delivery log request.

Parameters:

  • body (String, Hash{Symbol=>Object}) (defaults to: nil) —

    The body content that was sent with the request.

  • headers (Hash{Symbol=>Object}, nil) (defaults to: nil) —

    The headers that were sent with the request.

  • host (String) (defaults to: nil) —

    The host to which the request was sent.

  • method_ (Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method) (defaults to: nil) —

    The HTTP method used for the request.

  • path (String) (defaults to: nil) —

    The path of the URL that was requested.

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

    The query string of the URL that was requested.




# File 'lib/knockapi/models/message_delivery_log.rb', line 105

Instance Attribute Details

#body ⇒ String, ...

The body content that was sent with the request.

Returns:

  • (String, Hash{Symbol=>Object}, nil) 


73
 
# File 'lib/knockapi/models/message_delivery_log.rb', line 73

optional :body, union: -> { Knockapi::MessageDeliveryLog::Request::Body }

#headers ⇒ Hash{Symbol=>Object}?

The headers that were sent with the request.

Returns:



79
 
# File 'lib/knockapi/models/message_delivery_log.rb', line 79

optional :headers, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true

#host ⇒ String?

The host to which the request was sent.

Returns:

  • (String, nil) 


85
 
# File 'lib/knockapi/models/message_delivery_log.rb', line 85

optional :host, String

#method_ ⇒ Symbol, ...

The HTTP method used for the request.

Returns:



91
 
# File 'lib/knockapi/models/message_delivery_log.rb', line 91

optional :method_, enum: -> { Knockapi::MessageDeliveryLog::Request::Method }, api_name: :method

#path ⇒ String?

The path of the URL that was requested.

Returns:

  • (String, nil) 


97
 
# File 'lib/knockapi/models/message_delivery_log.rb', line 97

optional :path, String

#query ⇒ String?

The query string of the URL that was requested.

Returns:

  • (String, nil) 


103
 
# File 'lib/knockapi/models/message_delivery_log.rb', line 103

optional :query, String, nil?: true