Class: ModernTreasury::Resources::Cases

Inherits:

Object

• Object
• ModernTreasury::Resources::Cases

Defined in:

lib/modern_treasury/resources/cases.rb,
sig/modern_treasury/resources/cases.rbs

Instance Method Summary

• #initialize(client:) ⇒ Cases constructor private

  A new instance of Cases.

• #list(after_cursor: nil, per_page: nil, status: nil, subject_id: nil, subject_type: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::Case>

  Get a list of cases.

• #retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::Case

  Get details on a single case.

Constructor Details

#initialize(client:) ⇒ Cases

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

Parameters:

• client (ModernTreasury::Client)
• client: (ModernTreasury::Client)

# File 'lib/modern_treasury/resources/cases.rb', line 61

def initialize(client:)
  @client = client
end

Instance Method Details

#list(after_cursor: nil, per_page: nil, status: nil, subject_id: nil, subject_type: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::Case>

Get a list of cases.

Parameters:

• after_cursor (String, nil)
• per_page (Integer)
• status (Symbol, ModernTreasury::Models::CaseListParams::Status) —

  The status of the case.

• subject_id (String) —

  The ID of the object the case is about.

• subject_type (Symbol, ModernTreasury::Models::CaseListParams::SubjectType) —

  The type of the object the case is about.

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

Returns:

• (ModernTreasury::Internal::Page<ModernTreasury::Models::Case>)

See Also:

• Models::CaseListParams

# File 'lib/modern_treasury/resources/cases.rb', line 45

def list(params = {})
  parsed, options = ModernTreasury::CaseListParams.dump_request(params)
  query = ModernTreasury::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/cases",
    query: query,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::Case,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::Case

Get details on a single case.

Parameters:

• id (String) —

  id

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

Returns:

• (ModernTreasury::Models::Case)

See Also:

• Models::CaseRetrieveParams

# File 'lib/modern_treasury/resources/cases.rb', line 17

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