Class: Smartsheet::Folders

Inherits:
Object
  • Object
show all
Defined in:
lib/smartsheet/endpoints/folders/folders.rb

Overview

Folders Endpoints

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Folders

Returns a new instance of Folders.



8
9
10
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 8

def initialize(client)
  @client = client
end

Instance Method Details

#copy(folder_id:, body:, params: {}, header_overrides: {}) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 12

def copy(folder_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['folders', :folder_id, 'copy'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params,
      body: body,
      folder_id: folder_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#create(body:, params: {}, header_overrides: {}) ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 23

def create(body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['home', 'folders'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body
  )
  client.make_request(endpoint_spec, request_spec)
end

#create_in_folder(folder_id:, body:, params: {}, header_overrides: {}) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 33

def create_in_folder(folder_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['folders', :folder_id, 'folders'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body,
      folder_id: folder_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#create_in_workspace(workspace_id:, body:, params: {}, header_overrides: {}) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 44

def create_in_workspace(workspace_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['workspaces', :workspace_id, 'folders'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body,
      workspace_id: workspace_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#delete(folder_id:, params: {}, header_overrides: {}) ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 55

def delete(folder_id:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['folders', :folder_id])
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      folder_id: folder_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#get(folder_id:, params: {}, header_overrides: {}) ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 65

def get(folder_id:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['folders', :folder_id])
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params,
      folder_id: folder_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#list(params: {}, header_overrides: {}) ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 75

def list(params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['home', 'folders'])
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params
  )
  client.make_request(endpoint_spec, request_spec)
end

#list_in_folder(folder_id:, params: {}, header_overrides: {}) ⇒ Object 



84
85
86
87
88
89
90
91
92
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 84

def list_in_folder(folder_id:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['folders', :folder_id, 'folders'])
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params,
      folder_id: folder_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#list_in_workspace(workspace_id:, params: {}, header_overrides: {}) ⇒ Object 



94
95
96
97
98
99
100
101
102
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 94

def list_in_workspace(workspace_id:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['workspaces', :workspace_id, 'folders'])
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params,
      workspace_id: workspace_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#move(folder_id:, body:, params: {}, header_overrides: {}) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 104

def move(folder_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['folders', :folder_id, 'move'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body,
      folder_id: folder_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#update(folder_id:, body:, params: {}, header_overrides: {}) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/smartsheet/endpoints/folders/folders.rb', line 115

def update(folder_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['folders', :folder_id], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body,
      folder_id: folder_id
  )
  client.make_request(endpoint_spec, request_spec)
end