Class: Smartsheet::Favorites
- Inherits:
-
Object
- Object
- Smartsheet::Favorites
- Defined in:
- lib/smartsheet/endpoints/favorites/favorites.rb
Overview
Favorites Endpoints
Instance Method Summary collapse
- #add(body:, params: {}, header_overrides: {}) ⇒ Object
-
#initialize(client) ⇒ Favorites
constructor
A new instance of Favorites.
- #list(params: {}, header_overrides: {}) ⇒ Object
- #remove_folder(folder_id:, params: {}, header_overrides: {}) ⇒ Object
- #remove_folders(folder_ids:, params: {}, header_overrides: {}) ⇒ Object
- #remove_report(report_id:, params: {}, header_overrides: {}) ⇒ Object
- #remove_reports(report_ids:, params: {}, header_overrides: {}) ⇒ Object
- #remove_sheet(sheet_id:, params: {}, header_overrides: {}) ⇒ Object
- #remove_sheets(sheet_ids:, params: {}, header_overrides: {}) ⇒ Object
- #remove_sight(sight_id:, params: {}, header_overrides: {}) ⇒ Object
- #remove_sights(sight_ids:, params: {}, header_overrides: {}) ⇒ Object
- #remove_template(template_id:, params: {}, header_overrides: {}) ⇒ Object
- #remove_templates(template_ids:, params: {}, header_overrides: {}) ⇒ Object
- #remove_workspace(workspace_id:, params: {}, header_overrides: {}) ⇒ Object
- #remove_workspaces(workspace_ids:, params: {}, header_overrides: {}) ⇒ Object
Constructor Details
#initialize(client) ⇒ Favorites
Returns a new instance of Favorites.
8 9 10 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 8 def initialize(client) @client = client end |
Instance Method Details
#add(body:, params: {}, header_overrides: {}) ⇒ Object
12 13 14 15 16 17 18 19 20 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 12 def add(body:, params: {}, header_overrides: {}) endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['favorites'], body_type: :json) request_spec = Smartsheet::API::RequestSpec.new( header_overrides: header_overrides, params: params, body: body ) client.make_request(endpoint_spec, request_spec) end |
#list(params: {}, header_overrides: {}) ⇒ Object
22 23 24 25 26 27 28 29 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 22 def list(params: {}, header_overrides: {}) endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['favorites']) request_spec = Smartsheet::API::RequestSpec.new( header_overrides: header_overrides, params: params ) client.make_request(endpoint_spec, request_spec) end |
#remove_folder(folder_id:, params: {}, header_overrides: {}) ⇒ Object
31 32 33 34 35 36 37 38 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 31 def remove_folder(folder_id:, params: {}, header_overrides: {}) remove_favorite( url: ['folder', :folder_id], params: params, header_overrides: header_overrides, folder_id: folder_id ) end |
#remove_folders(folder_ids:, params: {}, header_overrides: {}) ⇒ Object
85 86 87 88 89 90 91 92 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 85 def remove_folders(folder_ids:, params: {}, header_overrides: {}) remove_favorites( url: ['folder'], params: params, header_overrides: header_overrides, object_ids: folder_ids ) end |
#remove_report(report_id:, params: {}, header_overrides: {}) ⇒ Object
40 41 42 43 44 45 46 47 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 40 def remove_report(report_id:, params: {}, header_overrides: {}) remove_favorite( url: ['report', :report_id], params: params, header_overrides: header_overrides, report_id: report_id ) end |
#remove_reports(report_ids:, params: {}, header_overrides: {}) ⇒ Object
94 95 96 97 98 99 100 101 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 94 def remove_reports(report_ids:, params: {}, header_overrides: {}) remove_favorites( url: ['report'], params: params, header_overrides: header_overrides, object_ids: report_ids ) end |
#remove_sheet(sheet_id:, params: {}, header_overrides: {}) ⇒ Object
49 50 51 52 53 54 55 56 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 49 def remove_sheet(sheet_id:, params: {}, header_overrides: {}) remove_favorite( url: ['sheet', :sheet_id], params: params, header_overrides: header_overrides, sheet_id: sheet_id ) end |
#remove_sheets(sheet_ids:, params: {}, header_overrides: {}) ⇒ Object
103 104 105 106 107 108 109 110 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 103 def remove_sheets(sheet_ids:, params: {}, header_overrides: {}) remove_favorites( url: ['sheet'], params: params, header_overrides: header_overrides, object_ids: sheet_ids ) end |
#remove_sight(sight_id:, params: {}, header_overrides: {}) ⇒ Object
58 59 60 61 62 63 64 65 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 58 def remove_sight(sight_id:, params: {}, header_overrides: {}) remove_favorite( url: ['sight', :sight_id], params: params, header_overrides: header_overrides, sight_id: sight_id ) end |
#remove_sights(sight_ids:, params: {}, header_overrides: {}) ⇒ Object
112 113 114 115 116 117 118 119 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 112 def remove_sights(sight_ids:, params: {}, header_overrides: {}) remove_favorites( url: ['sight'], params: params, header_overrides: header_overrides, object_ids: sight_ids ) end |
#remove_template(template_id:, params: {}, header_overrides: {}) ⇒ Object
67 68 69 70 71 72 73 74 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 67 def remove_template(template_id:, params: {}, header_overrides: {}) remove_favorite( url: ['template', :template_id], params: params, header_overrides: header_overrides, template_id: template_id ) end |
#remove_templates(template_ids:, params: {}, header_overrides: {}) ⇒ Object
121 122 123 124 125 126 127 128 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 121 def remove_templates(template_ids:, params: {}, header_overrides: {}) remove_favorites( url: ['template'], params: params, header_overrides: header_overrides, object_ids: template_ids ) end |
#remove_workspace(workspace_id:, params: {}, header_overrides: {}) ⇒ Object
76 77 78 79 80 81 82 83 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 76 def remove_workspace(workspace_id:, params: {}, header_overrides: {}) remove_favorite( url: ['workspace', :workspace_id], params: params, header_overrides: header_overrides, workspace_id: workspace_id ) end |
#remove_workspaces(workspace_ids:, params: {}, header_overrides: {}) ⇒ Object
130 131 132 133 134 135 136 137 |
# File 'lib/smartsheet/endpoints/favorites/favorites.rb', line 130 def remove_workspaces(workspace_ids:, params: {}, header_overrides: {}) remove_favorites( url: ['workspace'], params: params, header_overrides: header_overrides, object_ids: workspace_ids ) end |