Class: Basecamp::Services::ClientCorrespondencesService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/basecamp/generated/services/client_correspondences_service.rb

Overview

Service for ClientCorrespondences operations

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from Basecamp::Services::BaseService

Instance Method Details

#get(correspondence_id:) ⇒ Hash

Get a single client correspondence by id

Parameters:

  • correspondence_id (Integer) —

    correspondence id ID

Returns:

  • (Hash) —

    response data



24
25
26
27
28
 
# File 'lib/basecamp/generated/services/client_correspondences_service.rb', line 24

def get(correspondence_id:)
  with_operation(service: "clientcorrespondences", operation: "get", is_mutation: false, resource_id: correspondence_id) do
    http_get("/client/correspondences/#{correspondence_id}").json
  end
end

#list(sort: nil, direction: nil) ⇒ Enumerator<Hash>

List all client correspondences in a project

Parameters:

  • sort (String, nil) (defaults to: nil) —

    created_at|updated_at

  • direction (String, nil) (defaults to: nil) —

    asc|desc

Returns:

  • (Enumerator<Hash>) —

    paginated results



14
15
16
17
18
19
 
# File 'lib/basecamp/generated/services/client_correspondences_service.rb', line 14

def list(sort: nil, direction: nil)
  wrap_paginated(service: "clientcorrespondences", operation: "list", is_mutation: false) do
    params = compact_query_params(sort: sort, direction: direction)
    paginate("/client/correspondences.json", params: params)
  end
end