Class: Basecamp::Services::VaultsService

Inherits:
BaseService show all
Defined in:
lib/basecamp/generated/services/vaults_service.rb

Overview

Service for Vaults operations

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#create(vault_id:, title:) ⇒ Hash

Create a new vault (subfolder) in a vault

Parameters:

  • vault_id (Integer) —

    vault id ID

  • title (String) —

    title

Returns:

  • (Hash) —

    response data



45
46
47
48
49
 
# File 'lib/basecamp/generated/services/vaults_service.rb', line 45

def create(vault_id:, title:)
  with_operation(service: "vaults", operation: "create", is_mutation: true, resource_id: vault_id) do
    http_post("/vaults/#{vault_id}/vaults.json", body: compact_params(title: title)).json
  end
end

#get(vault_id:) ⇒ Hash

Get a single vault by id

Parameters:

  • vault_id (Integer) —

    vault id ID

Returns:

  • (Hash) —

    response data



13
14
15
16
17
 
# File 'lib/basecamp/generated/services/vaults_service.rb', line 13

def get(vault_id:)
  with_operation(service: "vaults", operation: "get", is_mutation: false, resource_id: vault_id) do
    http_get("/vaults/#{vault_id}", operation: "GetVault").json
  end
end

#list(vault_id:, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

List vaults (subfolders) in a vault

Parameters:

  • vault_id (Integer) —

    vault id ID

  • 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)



34
35
36
37
38
39
 
# File 'lib/basecamp/generated/services/vaults_service.rb', line 34

def list(vault_id:, page: nil, max_items: nil)
  wrap_paginated(service: "vaults", operation: "list", is_mutation: false, resource_id: vault_id) do
    params = compact_query_params(page: page)
    paginate("/vaults/#{vault_id}/vaults.json", params: params, operation: "ListVaults", max_items: max_items)
  end
end

#update(vault_id:, title: nil) ⇒ Hash

Update an existing vault

Parameters:

  • vault_id (Integer) —

    vault id ID

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

    title

Returns:

  • (Hash) —

    response data



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

def update(vault_id:, title: nil)
  with_operation(service: "vaults", operation: "update", is_mutation: true, resource_id: vault_id) do
    http_put("/vaults/#{vault_id}", body: compact_params(title: title)).json
  end
end