Class: Sink::Resources::Types::ReadOnlyParams

Inherits:
Object
  • Object
show all
Defined in:
lib/sink/resources/types/read_only_params.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ReadOnlyParams

Returns a new instance of ReadOnlyParams.

Parameters:



8
9
10
 
# File 'lib/sink/resources/types/read_only_params.rb', line 8

def initialize(client:)
  @client = client
end

Instance Method Details

#simple(params = {}, opts = {}) ⇒ Hash

Endpoint with a request params schema object that contains a ‘readOnly`

property.

Parameters:

  • params (Hash{Symbol => Object}) (defaults to: {}) —

    Attributes to send in this request. @option params [String, nil] :should_show_up This should be generated in the request params type.

  • opts (Hash, Sink::RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:

  • (Hash) 


21
22
23
24
25
26
27
28
29
30
 
# File 'lib/sink/resources/types/read_only_params.rb', line 21

def simple(params = {}, opts = {})
  req = {
    method: :post,
    path: "/types/read_only_params/simple",
    body: params,
    headers: {"Content-Type" => "application/json"},
    model: Hash
  }
  @client.request(req, opts)
end