Class: Smartsheet::Workspaces

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

Overview

Workspaces Endpoints

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Workspaces

Returns a new instance of Workspaces.



13
14
15
16
17
 
# File 'lib/smartsheet/endpoints/workspaces/workspaces.rb', line 13

def initialize(client)
  @client = client

  @share = WorkspacesShare.new(client)
end

Instance Attribute Details

#share ⇒ WorkspacesShare (readonly)

Returns:



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/smartsheet/endpoints/workspaces/workspaces.rb', line 9

class Workspaces
  attr_reader :client, :share
  private :client

  def initialize(client)
    @client = client

    @share = WorkspacesShare.new(client)
  end

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

  def create(body:, params: {}, header_overrides: {})
    endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['workspaces'], 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

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

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

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

  def update(workspace_id:, body:, params: {}, header_overrides: {})
    endpoint_spec = Smartsheet::API::EndpointSpec.new(
        :put,
        ['workspaces', :workspace_id],
        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
end

Instance Method Details

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/smartsheet/endpoints/workspaces/workspaces.rb', line 19

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

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



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

def create(body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['workspaces'], 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

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



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

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

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



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

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

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



64
65
66
67
68
69
70
71
 
# File 'lib/smartsheet/endpoints/workspaces/workspaces.rb', line 64

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

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/smartsheet/endpoints/workspaces/workspaces.rb', line 73

def update(workspace_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(
      :put,
      ['workspaces', :workspace_id],
      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