Class: Believe::Resources::Believe

Inherits:

Object

• Object
• Believe::Resources::Believe

Defined in:

lib/believe/resources/believe.rb

Overview

Interactive endpoints for motivation and guidance

Instance Method Summary

• #initialize(client:) ⇒ Believe constructor private

  A new instance of Believe.

• #submit(situation:, situation_type:, context: nil, intensity: nil, request_options: {}) ⇒ ::Believe::Models::BelieveSubmitResponse

  Submit your situation and receive Ted Lasso-style motivational guidance.

Constructor Details

#initialize(client:) ⇒ Believe

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Believe.

Parameters:

• client (::Believe::Client)

# File 'lib/believe/resources/believe.rb', line 38

def initialize(client:)
  @client = client
end

Instance Method Details

#submit(situation:, situation_type:, context: nil, intensity: nil, request_options: {}) ⇒ ::Believe::Models::BelieveSubmitResponse

Submit your situation and receive Ted Lasso-style motivational guidance.

Parameters:

• situation (String) —

  Describe your situation

• situation_type (Symbol, ::Believe::Models::BelieveSubmitParams::SituationType) —

  Type of situation

• context (String, nil) —

  Additional context

• intensity (Integer) —

  How intense is the response needed (1=gentle, 10=full Ted)

• request_options (::Believe::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (::Believe::Models::BelieveSubmitResponse)

See Also:

• Models::BelieveSubmitParams

# File 'lib/believe/resources/believe.rb', line 24

def submit(params)
  parsed, options = ::Believe::BelieveSubmitParams.dump_request(params)
  @client.request(
    method: :post,
    path: "believe",
    body: parsed,
    model: ::Believe::Models::BelieveSubmitResponse,
    options: options
  )
end