Module: Smartsheet::Share

Included in:
ReportsShare, SheetsShare, SightsShare, WorkspacesShare
Defined in:
lib/smartsheet/endpoints/share/share.rb

Overview

Sharing Endpoints Mixin

Instance Method Summary collapse

Instance Method Details

#create_share(url:, body:, params:, header_overrides:, **url_args) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/smartsheet/endpoints/share/share.rb', line 36

def create_share(url:, body:, params:, header_overrides:, **url_args)
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, url + ['shares'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params,
      body: body,
      **url_args
  )
  client.make_request(endpoint_spec, request_spec)
end

#delete_share(share_id:, url:, params:, header_overrides:, **url_args) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
 
# File 'lib/smartsheet/endpoints/share/share.rb', line 4

def delete_share(share_id:, url:, params:, header_overrides:, **url_args)
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, url + ['shares', :share_id])
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      share_id: share_id,
      **url_args
  )
  client.make_request(endpoint_spec, request_spec)
end

#get_share(share_id:, url:, params:, header_overrides:, **url_args) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/smartsheet/endpoints/share/share.rb', line 15

def get_share(share_id:, url:, params:, header_overrides:, **url_args)
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, url + ['shares', :share_id])
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      share_id: share_id,
      **url_args
  )
  client.make_request(endpoint_spec, request_spec)
end

#list_share(url:, params:, header_overrides:, **url_args) ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/smartsheet/endpoints/share/share.rb', line 26

def list_share(url:, params:, header_overrides:, **url_args)
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, url + ['shares'])
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params,
      **url_args
  )
  client.make_request(endpoint_spec, request_spec)
end

#update_share(share_id:, url:, body:, params:, header_overrides:, **url_args) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/smartsheet/endpoints/share/share.rb', line 47

def update_share(share_id:, url:, body:, params:, header_overrides:, **url_args)
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, url + ['shares', :share_id], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body,
      share_id: share_id,
      **url_args
  )
  client.make_request(endpoint_spec, request_spec)
end