Class: Cerca::Models::HTTPEndpoint

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cerca::Models::HTTPEndpoint

Defined in:

lib/cerca/models/http_endpoint.rb

Defined Under Namespace

Modules: Body, Method

Instance Attribute Summary

• #body ⇒ Symbol, ...
• #headers ⇒ Hash{Symbol=>String}^?
• #method_ ⇒ Symbol, Cerca::Models::HTTPEndpoint::Method
• #path ⇒ Hash{Symbol=>String}^?
• #query ⇒ Hash{Symbol=>String}^?
• #url ⇒ String

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(method_:, url:, body: nil, headers: nil, path: nil, query: nil) ⇒ Object constructor

  HTTP endpoint invoked when the tool is called.

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

HTTP endpoint invoked when the tool is called.

Parameters:

• method_ (Symbol, Cerca::Models::HTTPEndpoint::Method)
• url (String)
• body (Symbol, Cerca::Models::HTTPEndpoint::Body) (defaults to: nil)
• headers (Hash{Symbol=>String}) (defaults to: nil)
• path (Hash{Symbol=>String}) (defaults to: nil)
• query (Hash{Symbol=>String}) (defaults to: nil)

# File 'lib/cerca/models/http_endpoint.rb', line 36

Instance Attribute Details

#body ⇒ Symbol, ...

Returns:

• (Symbol, Cerca::Models::HTTPEndpoint::Body, nil)

# File 'lib/cerca/models/http_endpoint.rb', line 19

optional :body, enum: -> { Cerca::HTTPEndpoint::Body }

#headers ⇒ Hash{Symbol=>String}^?

Returns:

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

# File 'lib/cerca/models/http_endpoint.rb', line 24

optional :headers, Cerca::Internal::Type::HashOf[String]

#method_ ⇒ Symbol, Cerca::Models::HTTPEndpoint::Method

Returns:

• (Symbol, Cerca::Models::HTTPEndpoint::Method)

# File 'lib/cerca/models/http_endpoint.rb', line 9

required :method_, enum: -> { Cerca::HTTPEndpoint::Method }, api_name: :method

#path ⇒ Hash{Symbol=>String}^?

Returns:

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

# File 'lib/cerca/models/http_endpoint.rb', line 29

optional :path, Cerca::Internal::Type::HashOf[String]

#query ⇒ Hash{Symbol=>String}^?

Returns:

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

# File 'lib/cerca/models/http_endpoint.rb', line 34

optional :query, Cerca::Internal::Type::HashOf[String]

#url ⇒ String

Returns:

• (String)

# File 'lib/cerca/models/http_endpoint.rb', line 14

required :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/cerca/models/http_endpoint.rb', line 56