smartsheet 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +11 -11
  3. data/.rubocop.yml +4 -4
  4. data/.travis.yml +13 -6
  5. data/.yardopts +3 -3
  6. data/CHANGELOG.md +103 -0
  7. data/Gemfile +6 -6
  8. data/LICENSE +202 -202
  9. data/README.md +214 -141
  10. data/Rakefile +29 -23
  11. data/bin/console +14 -14
  12. data/bin/setup +8 -8
  13. data/lib/smartsheet.rb +2 -2
  14. data/lib/smartsheet/api/body_builder.rb +25 -25
  15. data/lib/smartsheet/api/endpoint_spec.rb +54 -36
  16. data/lib/smartsheet/api/faraday_adapter/faraday_net_client.rb +45 -42
  17. data/lib/smartsheet/api/faraday_adapter/faraday_response.rb +70 -70
  18. data/lib/smartsheet/api/faraday_adapter/middleware/faraday_error_translator.rb +20 -20
  19. data/lib/smartsheet/api/faraday_adapter/middleware/response_parser.rb +25 -25
  20. data/lib/smartsheet/api/file_spec.rb +31 -31
  21. data/lib/smartsheet/api/header_builder.rb +90 -84
  22. data/lib/smartsheet/api/request.rb +42 -29
  23. data/lib/smartsheet/api/request_client.rb +43 -27
  24. data/lib/smartsheet/api/request_logger.rb +182 -182
  25. data/lib/smartsheet/api/request_spec.rb +57 -44
  26. data/lib/smartsheet/api/response_net_client_decorator.rb +54 -54
  27. data/lib/smartsheet/api/retry_logic.rb +40 -40
  28. data/lib/smartsheet/api/retry_net_client_decorator.rb +37 -37
  29. data/lib/smartsheet/api/url_builder.rb +25 -25
  30. data/lib/smartsheet/client.rb +191 -185
  31. data/lib/smartsheet/constants.rb +15 -15
  32. data/lib/smartsheet/endpoints/contacts/contacts.rb +30 -30
  33. data/lib/smartsheet/endpoints/favorites/favorites.rb +159 -159
  34. data/lib/smartsheet/endpoints/folders/folders.rb +125 -125
  35. data/lib/smartsheet/endpoints/groups/groups.rb +83 -83
  36. data/lib/smartsheet/endpoints/home/home.rb +20 -20
  37. data/lib/smartsheet/endpoints/reports/reports.rb +100 -100
  38. data/lib/smartsheet/endpoints/reports/reports_share.rb +69 -69
  39. data/lib/smartsheet/endpoints/search/search.rb +30 -30
  40. data/lib/smartsheet/endpoints/server_info/server_info.rb +21 -21
  41. data/lib/smartsheet/endpoints/share/share.rb +58 -58
  42. data/lib/smartsheet/endpoints/sheets/automation_rules.rb +56 -0
  43. data/lib/smartsheet/endpoints/sheets/cells.rb +82 -82
  44. data/lib/smartsheet/endpoints/sheets/columns.rb +66 -66
  45. data/lib/smartsheet/endpoints/sheets/comments.rb +64 -64
  46. data/lib/smartsheet/endpoints/sheets/comments_attachments.rb +78 -78
  47. data/lib/smartsheet/endpoints/sheets/cross_sheet_references.rb +45 -0
  48. data/lib/smartsheet/endpoints/sheets/discussions.rb +84 -84
  49. data/lib/smartsheet/endpoints/sheets/discussions_attachments.rb +22 -22
  50. data/lib/smartsheet/endpoints/sheets/rows.rb +106 -95
  51. data/lib/smartsheet/endpoints/sheets/rows_attachments.rb +92 -92
  52. data/lib/smartsheet/endpoints/sheets/sheets.rb +326 -317
  53. data/lib/smartsheet/endpoints/sheets/sheets_attachments.rb +174 -174
  54. data/lib/smartsheet/endpoints/sheets/sheets_share.rb +69 -69
  55. data/lib/smartsheet/endpoints/sights/sights.rb +101 -101
  56. data/lib/smartsheet/endpoints/sights/sights_share.rb +69 -69
  57. data/lib/smartsheet/endpoints/templates/templates.rb +29 -29
  58. data/lib/smartsheet/endpoints/token/token.rb +65 -60
  59. data/lib/smartsheet/endpoints/update_requests/sent_update_requests.rb +44 -44
  60. data/lib/smartsheet/endpoints/update_requests/update_requests.rb +74 -74
  61. data/lib/smartsheet/endpoints/users/alternate_emails.rb +79 -79
  62. data/lib/smartsheet/endpoints/users/users.rb +77 -77
  63. data/lib/smartsheet/endpoints/webhooks/webhooks.rb +71 -71
  64. data/lib/smartsheet/endpoints/workspaces/workspaces.rb +87 -87
  65. data/lib/smartsheet/endpoints/workspaces/workspaces_share.rb +70 -70
  66. data/lib/smartsheet/error.rb +69 -69
  67. data/lib/smartsheet/general_request.rb +74 -74
  68. data/lib/smartsheet/version.rb +5 -5
  69. data/smartsheet.gemspec +54 -52
  70. metadata +34 -3
@@ -1,45 +1,45 @@
1
- module Smartsheet
2
- # Sent Update Requests Endpoints
3
- # @see https://smartsheet-platform.github.io/api-docs/?ruby#update-requests API Update Requests
4
- # Docs
5
- class SentUpdateRequests
6
- attr_reader :client
7
- private :client
8
-
9
- def initialize(client)
10
- @client = client
11
- end
12
-
13
- def delete(sheet_id:, sent_update_request_id:, params: {}, header_overrides: {})
14
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'sentupdaterequests', :sent_update_request_id])
15
- request_spec = Smartsheet::API::RequestSpec.new(
16
- params: params,
17
- header_overrides: header_overrides,
18
- sheet_id: sheet_id,
19
- sent_update_request_id: sent_update_request_id
20
- )
21
- client.make_request(endpoint_spec, request_spec)
22
- end
23
-
24
- def get(sheet_id:, sent_update_request_id:, params: {}, header_overrides: {})
25
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'sentupdaterequests', :sent_update_request_id])
26
- request_spec = Smartsheet::API::RequestSpec.new(
27
- params: params,
28
- header_overrides: header_overrides,
29
- sheet_id: sheet_id,
30
- sent_update_request_id: sent_update_request_id
31
- )
32
- client.make_request(endpoint_spec, request_spec)
33
- end
34
-
35
- def list(sheet_id:, params: {}, header_overrides: {})
36
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'sentupdaterequests'])
37
- request_spec = Smartsheet::API::RequestSpec.new(
38
- header_overrides: header_overrides,
39
- params: params,
40
- sheet_id: sheet_id
41
- )
42
- client.make_request(endpoint_spec, request_spec)
43
- end
44
- end
1
+ module Smartsheet
2
+ # Sent Update Requests Endpoints
3
+ # @see https://smartsheet-platform.github.io/api-docs/?ruby#update-requests API Update Requests
4
+ # Docs
5
+ class SentUpdateRequests
6
+ attr_reader :client
7
+ private :client
8
+
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ def delete(sheet_id:, sent_update_request_id:, params: {}, header_overrides: {})
14
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'sentupdaterequests', :sent_update_request_id])
15
+ request_spec = Smartsheet::API::RequestSpec.new(
16
+ params: params,
17
+ header_overrides: header_overrides,
18
+ sheet_id: sheet_id,
19
+ sent_update_request_id: sent_update_request_id
20
+ )
21
+ client.make_request(endpoint_spec, request_spec)
22
+ end
23
+
24
+ def get(sheet_id:, sent_update_request_id:, params: {}, header_overrides: {})
25
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'sentupdaterequests', :sent_update_request_id])
26
+ request_spec = Smartsheet::API::RequestSpec.new(
27
+ params: params,
28
+ header_overrides: header_overrides,
29
+ sheet_id: sheet_id,
30
+ sent_update_request_id: sent_update_request_id
31
+ )
32
+ client.make_request(endpoint_spec, request_spec)
33
+ end
34
+
35
+ def list(sheet_id:, params: {}, header_overrides: {})
36
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'sentupdaterequests'])
37
+ request_spec = Smartsheet::API::RequestSpec.new(
38
+ header_overrides: header_overrides,
39
+ params: params,
40
+ sheet_id: sheet_id
41
+ )
42
+ client.make_request(endpoint_spec, request_spec)
43
+ end
44
+ end
45
45
  end
@@ -1,75 +1,75 @@
1
- require 'smartsheet/endpoints/update_requests/sent_update_requests'
2
-
3
- module Smartsheet
4
- # Update Requests Endpoints
5
- # @see https://smartsheet-platform.github.io/api-docs/?ruby#update-requests API Update Requests
6
- # Docs
7
- #
8
- # @!attribute [r] sent
9
- # @return [SentUpdateRequests]
10
- class UpdateRequests
11
- attr_reader :client, :sent
12
- private :client
13
-
14
- def initialize(client)
15
- @client = client
16
-
17
- @sent = SentUpdateRequests.new(client)
18
- end
19
-
20
- def create(sheet_id:, body:, params: {}, header_overrides: {})
21
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'updaterequests'], body_type: :json)
22
- request_spec = Smartsheet::API::RequestSpec.new(
23
- params: params,
24
- header_overrides: header_overrides,
25
- body: body,
26
- sheet_id: sheet_id
27
- )
28
- client.make_request(endpoint_spec, request_spec)
29
- end
30
-
31
- def delete(sheet_id:, update_request_id:, params: {}, header_overrides: {})
32
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'updaterequests', :update_request_id])
33
- request_spec = Smartsheet::API::RequestSpec.new(
34
- params: params,
35
- header_overrides: header_overrides,
36
- sheet_id: sheet_id,
37
- update_request_id: update_request_id
38
- )
39
- client.make_request(endpoint_spec, request_spec)
40
- end
41
-
42
- def get(sheet_id:, update_request_id:, params: {}, header_overrides: {})
43
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'updaterequests', :update_request_id])
44
- request_spec = Smartsheet::API::RequestSpec.new(
45
- params: params,
46
- header_overrides: header_overrides,
47
- sheet_id: sheet_id,
48
- update_request_id: update_request_id
49
- )
50
- client.make_request(endpoint_spec, request_spec)
51
- end
52
-
53
- def list(sheet_id:, params: {}, header_overrides: {})
54
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'updaterequests'])
55
- request_spec = Smartsheet::API::RequestSpec.new(
56
- header_overrides: header_overrides,
57
- params: params,
58
- sheet_id: sheet_id
59
- )
60
- client.make_request(endpoint_spec, request_spec)
61
- end
62
-
63
- def update(sheet_id:, update_request_id:, body:, params: {}, header_overrides: {})
64
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sheets', :sheet_id, 'updaterequests', :update_request_id], body_type: :json)
65
- request_spec = Smartsheet::API::RequestSpec.new(
66
- params: params,
67
- header_overrides: header_overrides,
68
- body: body,
69
- sheet_id: sheet_id,
70
- update_request_id: update_request_id
71
- )
72
- client.make_request(endpoint_spec, request_spec)
73
- end
74
- end
1
+ require 'smartsheet/endpoints/update_requests/sent_update_requests'
2
+
3
+ module Smartsheet
4
+ # Update Requests Endpoints
5
+ # @see https://smartsheet-platform.github.io/api-docs/?ruby#update-requests API Update Requests
6
+ # Docs
7
+ #
8
+ # @!attribute [r] sent
9
+ # @return [SentUpdateRequests]
10
+ class UpdateRequests
11
+ attr_reader :client, :sent
12
+ private :client
13
+
14
+ def initialize(client)
15
+ @client = client
16
+
17
+ @sent = SentUpdateRequests.new(client)
18
+ end
19
+
20
+ def create(sheet_id:, body:, params: {}, header_overrides: {})
21
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'updaterequests'], body_type: :json)
22
+ request_spec = Smartsheet::API::RequestSpec.new(
23
+ params: params,
24
+ header_overrides: header_overrides,
25
+ body: body,
26
+ sheet_id: sheet_id
27
+ )
28
+ client.make_request(endpoint_spec, request_spec)
29
+ end
30
+
31
+ def delete(sheet_id:, update_request_id:, params: {}, header_overrides: {})
32
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'updaterequests', :update_request_id])
33
+ request_spec = Smartsheet::API::RequestSpec.new(
34
+ params: params,
35
+ header_overrides: header_overrides,
36
+ sheet_id: sheet_id,
37
+ update_request_id: update_request_id
38
+ )
39
+ client.make_request(endpoint_spec, request_spec)
40
+ end
41
+
42
+ def get(sheet_id:, update_request_id:, params: {}, header_overrides: {})
43
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'updaterequests', :update_request_id])
44
+ request_spec = Smartsheet::API::RequestSpec.new(
45
+ params: params,
46
+ header_overrides: header_overrides,
47
+ sheet_id: sheet_id,
48
+ update_request_id: update_request_id
49
+ )
50
+ client.make_request(endpoint_spec, request_spec)
51
+ end
52
+
53
+ def list(sheet_id:, params: {}, header_overrides: {})
54
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'updaterequests'])
55
+ request_spec = Smartsheet::API::RequestSpec.new(
56
+ header_overrides: header_overrides,
57
+ params: params,
58
+ sheet_id: sheet_id
59
+ )
60
+ client.make_request(endpoint_spec, request_spec)
61
+ end
62
+
63
+ def update(sheet_id:, update_request_id:, body:, params: {}, header_overrides: {})
64
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sheets', :sheet_id, 'updaterequests', :update_request_id], body_type: :json)
65
+ request_spec = Smartsheet::API::RequestSpec.new(
66
+ params: params,
67
+ header_overrides: header_overrides,
68
+ body: body,
69
+ sheet_id: sheet_id,
70
+ update_request_id: update_request_id
71
+ )
72
+ client.make_request(endpoint_spec, request_spec)
73
+ end
74
+ end
75
75
  end
@@ -1,80 +1,80 @@
1
- module Smartsheet
2
- # Alternate Emails Endpoints
3
- # @see https://smartsheet-platform.github.io/api-docs/?ruby#alternate-email-addresses API
4
- # Alternate Email Addresses Docs
5
- class AlternateEmails
6
- attr_reader :client
7
- private :client
8
-
9
- def initialize(client)
10
- @client = client
11
- end
12
-
13
- def add(user_id:, body:, params: {}, header_overrides: {})
14
- endpoint_spec = Smartsheet::API::EndpointSpec.new(
15
- :post,
16
- ['users', :user_id, 'alternateemails'],
17
- body_type: :json
18
- )
19
- request_spec = Smartsheet::API::RequestSpec.new(
20
- params: params,
21
- header_overrides: header_overrides,
22
- body: body,
23
- user_id: user_id
24
- )
25
- client.make_request(endpoint_spec, request_spec)
26
- end
27
-
28
- def make_primary(user_id:, alternate_email_id:, params: {}, header_overrides: {})
29
- endpoint_spec = Smartsheet::API::EndpointSpec.new(
30
- :post,
31
- ['users', :user_id, 'alternateemails', :alternate_email_id, 'makeprimary']
32
- )
33
- request_spec = Smartsheet::API::RequestSpec.new(
34
- params: params,
35
- header_overrides: header_overrides,
36
- alternate_email_id: alternate_email_id,
37
- user_id: user_id
38
- )
39
- client.make_request(endpoint_spec, request_spec)
40
- end
41
-
42
- def delete(user_id:, alternate_email_id:, params: {}, header_overrides: {})
43
- endpoint_spec = Smartsheet::API::EndpointSpec.new(
44
- :delete,
45
- ['users', :user_id, 'alternateemails', :alternate_email_id]
46
- )
47
- request_spec = Smartsheet::API::RequestSpec.new(
48
- params: params,
49
- header_overrides: header_overrides,
50
- alternate_email_id: alternate_email_id,
51
- user_id: user_id
52
- )
53
- client.make_request(endpoint_spec, request_spec)
54
- end
55
-
56
- def get(user_id:, alternate_email_id:, params: {}, header_overrides: {})
57
- endpoint_spec = Smartsheet::API::EndpointSpec.new(
58
- :get,
59
- ['users', :user_id, 'alternateemails', :alternate_email_id]
60
- )
61
- request_spec = Smartsheet::API::RequestSpec.new(
62
- params: params,
63
- header_overrides: header_overrides,
64
- alternate_email_id: alternate_email_id,
65
- user_id: user_id
66
- )
67
- client.make_request(endpoint_spec, request_spec)
68
- end
69
-
70
- def list(user_id:, params: {}, header_overrides: {})
71
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', :user_id, 'alternateemails'])
72
- request_spec = Smartsheet::API::RequestSpec.new(
73
- params: params,
74
- header_overrides: header_overrides,
75
- user_id: user_id
76
- )
77
- client.make_request(endpoint_spec, request_spec)
78
- end
79
- end
1
+ module Smartsheet
2
+ # Alternate Emails Endpoints
3
+ # @see https://smartsheet-platform.github.io/api-docs/?ruby#alternate-email-addresses API
4
+ # Alternate Email Addresses Docs
5
+ class AlternateEmails
6
+ attr_reader :client
7
+ private :client
8
+
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ def add(user_id:, body:, params: {}, header_overrides: {})
14
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(
15
+ :post,
16
+ ['users', :user_id, 'alternateemails'],
17
+ body_type: :json
18
+ )
19
+ request_spec = Smartsheet::API::RequestSpec.new(
20
+ params: params,
21
+ header_overrides: header_overrides,
22
+ body: body,
23
+ user_id: user_id
24
+ )
25
+ client.make_request(endpoint_spec, request_spec)
26
+ end
27
+
28
+ def make_primary(user_id:, alternate_email_id:, params: {}, header_overrides: {})
29
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(
30
+ :post,
31
+ ['users', :user_id, 'alternateemails', :alternate_email_id, 'makeprimary']
32
+ )
33
+ request_spec = Smartsheet::API::RequestSpec.new(
34
+ params: params,
35
+ header_overrides: header_overrides,
36
+ alternate_email_id: alternate_email_id,
37
+ user_id: user_id
38
+ )
39
+ client.make_request(endpoint_spec, request_spec)
40
+ end
41
+
42
+ def delete(user_id:, alternate_email_id:, params: {}, header_overrides: {})
43
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(
44
+ :delete,
45
+ ['users', :user_id, 'alternateemails', :alternate_email_id]
46
+ )
47
+ request_spec = Smartsheet::API::RequestSpec.new(
48
+ params: params,
49
+ header_overrides: header_overrides,
50
+ alternate_email_id: alternate_email_id,
51
+ user_id: user_id
52
+ )
53
+ client.make_request(endpoint_spec, request_spec)
54
+ end
55
+
56
+ def get(user_id:, alternate_email_id:, params: {}, header_overrides: {})
57
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(
58
+ :get,
59
+ ['users', :user_id, 'alternateemails', :alternate_email_id]
60
+ )
61
+ request_spec = Smartsheet::API::RequestSpec.new(
62
+ params: params,
63
+ header_overrides: header_overrides,
64
+ alternate_email_id: alternate_email_id,
65
+ user_id: user_id
66
+ )
67
+ client.make_request(endpoint_spec, request_spec)
68
+ end
69
+
70
+ def list(user_id:, params: {}, header_overrides: {})
71
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', :user_id, 'alternateemails'])
72
+ request_spec = Smartsheet::API::RequestSpec.new(
73
+ params: params,
74
+ header_overrides: header_overrides,
75
+ user_id: user_id
76
+ )
77
+ client.make_request(endpoint_spec, request_spec)
78
+ end
79
+ end
80
80
  end
@@ -1,78 +1,78 @@
1
- require_relative 'alternate_emails'
2
-
3
- module Smartsheet
4
- # Users Endpoints
5
- # @see https://smartsheet-platform.github.io/api-docs/?ruby#users API Users Docs
6
- #
7
- # @!attribute [r] alternate_emails
8
- # @return [AlternateEmails]
9
- class Users
10
- attr_reader :client, :alternate_emails
11
- private :client
12
-
13
- def initialize(client)
14
- @client = client
15
-
16
- @alternate_emails = AlternateEmails.new(client)
17
- end
18
-
19
- def add(body:, params: {}, header_overrides: {})
20
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['users'], body_type: :json)
21
- request_spec = Smartsheet::API::RequestSpec.new(
22
- header_overrides: header_overrides,
23
- body: body,
24
- params: params
25
- )
26
- client.make_request(endpoint_spec, request_spec)
27
- end
28
-
29
- def get_current(params: {}, header_overrides: {})
30
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', 'me'])
31
- request_spec = Smartsheet::API::RequestSpec.new(
32
- params: params,
33
- header_overrides: header_overrides
34
- )
35
- client.make_request(endpoint_spec, request_spec)
36
- end
37
-
38
- def get(user_id:, params: {}, header_overrides: {})
39
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', :user_id])
40
- request_spec = Smartsheet::API::RequestSpec.new(
41
- params: params,
42
- header_overrides: header_overrides,
43
- user_id: user_id
44
- )
45
- client.make_request(endpoint_spec, request_spec)
46
- end
47
-
48
- def list(params: {}, header_overrides: {})
49
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users'])
50
- request_spec = Smartsheet::API::RequestSpec.new(
51
- header_overrides: header_overrides,
52
- params: params
53
- )
54
- client.make_request(endpoint_spec, request_spec)
55
- end
56
-
57
- def remove(user_id:, params: {}, header_overrides: {})
58
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['users', :user_id])
59
- request_spec = Smartsheet::API::RequestSpec.new(
60
- header_overrides: header_overrides,
61
- params: params,
62
- user_id: user_id
63
- )
64
- client.make_request(endpoint_spec, request_spec)
65
- end
66
-
67
- def update(user_id:, body:, params: {}, header_overrides: {})
68
- endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['users', :user_id], body_type: :json)
69
- request_spec = Smartsheet::API::RequestSpec.new(
70
- params: params,
71
- header_overrides: header_overrides,
72
- body: body,
73
- user_id: user_id
74
- )
75
- client.make_request(endpoint_spec, request_spec)
76
- end
77
- end
1
+ require_relative 'alternate_emails'
2
+
3
+ module Smartsheet
4
+ # Users Endpoints
5
+ # @see https://smartsheet-platform.github.io/api-docs/?ruby#users API Users Docs
6
+ #
7
+ # @!attribute [r] alternate_emails
8
+ # @return [AlternateEmails]
9
+ class Users
10
+ attr_reader :client, :alternate_emails
11
+ private :client
12
+
13
+ def initialize(client)
14
+ @client = client
15
+
16
+ @alternate_emails = AlternateEmails.new(client)
17
+ end
18
+
19
+ def add(body:, params: {}, header_overrides: {})
20
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['users'], body_type: :json)
21
+ request_spec = Smartsheet::API::RequestSpec.new(
22
+ header_overrides: header_overrides,
23
+ body: body,
24
+ params: params
25
+ )
26
+ client.make_request(endpoint_spec, request_spec)
27
+ end
28
+
29
+ def get_current(params: {}, header_overrides: {})
30
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', 'me'])
31
+ request_spec = Smartsheet::API::RequestSpec.new(
32
+ params: params,
33
+ header_overrides: header_overrides
34
+ )
35
+ client.make_request(endpoint_spec, request_spec)
36
+ end
37
+
38
+ def get(user_id:, params: {}, header_overrides: {})
39
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', :user_id])
40
+ request_spec = Smartsheet::API::RequestSpec.new(
41
+ params: params,
42
+ header_overrides: header_overrides,
43
+ user_id: user_id
44
+ )
45
+ client.make_request(endpoint_spec, request_spec)
46
+ end
47
+
48
+ def list(params: {}, header_overrides: {})
49
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users'])
50
+ request_spec = Smartsheet::API::RequestSpec.new(
51
+ header_overrides: header_overrides,
52
+ params: params
53
+ )
54
+ client.make_request(endpoint_spec, request_spec)
55
+ end
56
+
57
+ def remove(user_id:, params: {}, header_overrides: {})
58
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['users', :user_id])
59
+ request_spec = Smartsheet::API::RequestSpec.new(
60
+ header_overrides: header_overrides,
61
+ params: params,
62
+ user_id: user_id
63
+ )
64
+ client.make_request(endpoint_spec, request_spec)
65
+ end
66
+
67
+ def update(user_id:, body:, params: {}, header_overrides: {})
68
+ endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['users', :user_id], body_type: :json)
69
+ request_spec = Smartsheet::API::RequestSpec.new(
70
+ params: params,
71
+ header_overrides: header_overrides,
72
+ body: body,
73
+ user_id: user_id
74
+ )
75
+ client.make_request(endpoint_spec, request_spec)
76
+ end
77
+ end
78
78
  end