Class: Moonbase::Resources::Activities

Inherits:

Object

• Object
• Moonbase::Resources::Activities

Defined in:

lib/moonbase/resources/activities.rb

Overview

View activities and capture calls

Instance Method Summary

• #initialize(client:) ⇒ Activities constructor private

  A new instance of Activities.

• #list(after: nil, before: nil, constituent_entity_id: nil, constituent_entity_type: nil, constituent_relation: nil, limit: nil, occurred_at: nil, type: nil, request_options: {}) ⇒ Moonbase::Internal::CursorPage<Moonbase::Models::Activity>

  Some parameter documentations has been truncated, see Models::ActivityListParams for more details.

• #retrieve(id, request_options: {}) ⇒ Moonbase::Models::Activity

  Retrieves the details of an existing activity.

Constructor Details

#initialize(client:) ⇒ Activities

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 Activities.

Parameters:

• client (Moonbase::Client)

# File 'lib/moonbase/resources/activities.rb', line 71

def initialize(client:)
  @client = client
end

Instance Method Details

#list(after: nil, before: nil, constituent_entity_id: nil, constituent_entity_type: nil, constituent_relation: nil, limit: nil, occurred_at: nil, type: nil, request_options: {}) ⇒ Moonbase::Internal::CursorPage<Moonbase::Models::Activity>

Some parameter documentations has been truncated, see Models::ActivityListParams for more details.

Returns a list of activities.

Parameters:

• after (String) —

  When specified, returns results starting immediately after the item identified b

• before (String) —

  When specified, returns results starting immediately before the item identified

• constituent_entity_id (Moonbase::Models::ActivityListParams::ConstituentEntityID) —

  Filter activities by which entities were involved. Must be paired with constitue

• constituent_entity_type (Moonbase::Models::ActivityListParams::ConstituentEntityType) —

  Filter activities by which entities were involved. Must be paired with constitue

• constituent_relation (Moonbase::Models::ActivityListParams::ConstituentRelation) —

  Filter activities by which entities were involved via specific relations. Must b

• limit (Integer) —

  Maximum number of items to return per page. Must be between 1 and 100. Defaults

• occurred_at (Moonbase::Models::ActivityListParams::OccurredAt) —

  Filter activities by when they occurred.

• type (Moonbase::Models::ActivityListParams::Type) —

  Filter activities by type.

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

Returns:

• (Moonbase::Internal::CursorPage<Moonbase::Models::Activity>)

See Also:

• Models::ActivityListParams

# File 'lib/moonbase/resources/activities.rb', line 55

def list(params = {})
  parsed, options = Moonbase::ActivityListParams.dump_request(params)
  query = Moonbase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "activities",
    query: query,
    page: Moonbase::Internal::CursorPage,
    model: Moonbase::Activity,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Moonbase::Models::Activity

Retrieves the details of an existing activity.

Parameters:

• id (String) —

  The ID of the Activity to retrieve.

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

Returns:

• (Moonbase::Models::Activity)

See Also:

• Models::ActivityRetrieveParams

# File 'lib/moonbase/resources/activities.rb', line 18

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["activities/%1$s", id],
    model: Moonbase::Activity,
    options: params[:request_options]
  )
end