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



27
28
29
30
31
 
# File 'lib/basecamp/generated/services/client_correspondences_service.rb', line 27

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

#list(bucket_id:, sort: nil, direction: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

List all client correspondences in a project

Parameters:

  • bucket_id (Integer) —

    bucket id ID

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

    created_at|updated_at

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

    asc|desc

  • page (Integer, nil) (defaults to: nil) —

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

  • max_items (Integer, nil) (defaults to: nil) —

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



17
18
19
20
21
22
 
# File 'lib/basecamp/generated/services/client_correspondences_service.rb', line 17

def list(bucket_id:, sort: nil, direction: nil, page: nil, max_items: nil)
  wrap_paginated(service: "clientcorrespondences", operation: "list", is_mutation: false, project_id: bucket_id) do
    params = compact_query_params(sort: sort, direction: direction, page: page)
    paginate("/buckets/#{bucket_id}/client/correspondences.json", params: params, operation: "ListClientCorrespondences", max_items: max_items)
  end
end