Documentation by YARD 0.9.25
+Documentation by YARD 0.9.36
Alphabetic Index
@@ -448,9 +448,9 @@Namespace Listing A-Z
Usage
Contributing
-See contribute.md
+See contribute.md
diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 913b5e9..9310077 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -7,7 +7,7 @@ jobs: strategy: matrix: - ruby-version: [2.7, 2.6] + ruby-version: [3.1] steps: - uses: actions/checkout@v2 diff --git a/.yardoc/checksums b/.yardoc/checksums index 099439d..0080e86 100644 --- a/.yardoc/checksums +++ b/.yardoc/checksums @@ -3,19 +3,19 @@ lib/sfrest/cron.rb b79eca6a734af70d17053ca85518e9f62737434f lib/sfrest/info.rb ba9d80b54d182490ea894dc832d338705ccadf3e lib/sfrest/role.rb 14f829291f7c0b54b35acab383e01535f25e763a lib/sfrest/site.rb d101ddf331e15e941506fda4d7ad2248ae8eca31 -lib/sfrest/task.rb f404ebbdcc21815653802d8b0c7ecbdba86ce6d4 +lib/sfrest/task.rb fe185422ddb48945b6332d3de1e880df69f83010 lib/sfrest/user.rb c00d77c9be76b447b3c5410624d106f638840721 lib/sfrest/audit.rb 83b4ed11bb31fb500d59f98b573afd1be7686887 lib/sfrest/error.rb 11e22e8c019e8ed00d3f8830db3f8c1b304d37ca -lib/sfrest/group.rb 673058253fb7d9d1eec45a2b3f2735377a32203d -lib/sfrest/stage.rb 8e81c2268e5a8ba011b79222f753569829a32b9e -lib/sfrest/theme.rb 4f51f2ad5e186c3e0afae4e2456a6eedee1130b1 +lib/sfrest/group.rb e10bac10e3b7c5f654f3bced7568009c9e8b2c7f +lib/sfrest/stage.rb b23832cc2f53531dec425e6855a2056b6a3dc36c +lib/sfrest/theme.rb f9d951f0b26490870cb5339c46660625b22b0764 lib/sfrest/usage.rb f32860fbf0610704e4033aec1383f57e3ac2941a lib/sfrest/backup.rb b938242b1442f8e4e9e112aa2b00e7706e2eb756 lib/sfrest/update.rb 2dc95ca50ab0d7017ac1296b80d1c417a5e9d834 lib/sfrest/domains.rb 2774e0f43de5ef3af79f108a9aea78e9b6e0e9c3 lib/sfrest/profile.rb e506ccffecf7a8cf34e420924243250de38d8e6b -lib/sfrest/version.rb fbb3930e93ff0af2ec9c7805d033d81de4b1c3c2 +lib/sfrest/version.rb d4076f4db94997dfa08685c50d5bfa4f7c68298c lib/sfrest/codebase.rb 86aec3743bd186f1a5bce5e8db27a57444fc1668 lib/sfrest/variable.rb 29d5899e356488e2f58df6841b80b67cc6b43d06 lib/sfrest/collection.rb 60a123604d676b82cc1b2a97d9288637a0e3f3d1 diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat index 67f26ab..9c24b20 100644 Binary files a/.yardoc/objects/root.dat and b/.yardoc/objects/root.dat differ diff --git a/doc/SFRest.html b/doc/SFRest.html index ea4ccee..f953764 100644 --- a/doc/SFRest.html +++ b/doc/SFRest.html @@ -6,7 +6,7 @@
'0.0.46'
'0.0.47'
Extract the return data for 'key' based on the result object.
+Extract the return data for ‘key’ based on the result object.
Extract the return data for 'key' based on the result object
+Extract the return data for ‘key’ based on the result object
Lists the codebases { “stacks” => { 1 => “abcde”, 2 => 'fghij' } }.
+Lists the codebases { “stacks” => { 1 => “abcde”, 2 => ‘fghij’ } }.
Lists the codebases { “stacks” => { 1 => “abcde”, 2 => 'fghij' } }
+Lists the codebases { “stacks” => { 1 => “abcde”, 2 => ‘fghij’ } }
Extract the site data for 'key' based on the site result object.
+Extract the site data for ‘key’ based on the site result object.
Extract the site data for 'key' based on the site result object
+Extract the site data for ‘key’ based on the site result object
the request's HTTP status
+the request’s HTTP status
'limit' and 'page' are supported for pagination.
+‘limit’ and ‘page’ are supported for pagination.
Extract the group data for 'key' based on the site result object.
+Extract the group data for ‘key’ based on the site result object.
{'count' => count, 'uids_added' => Hash }
+{‘count’ => count, ‘uids_added’ => Hash }
=> 123, 'site_ids_added' => [1, 2, …]
+=> 123, ‘site_ids_added’ => [1, 2, …]
{'count' => count, 'uids_demoted' => Hash }
+{‘count’ => count, ‘uids_demoted’ => Hash }
# File 'lib/sfrest/group.rb', line 144 def get_group_id(groupname) res = group_list - id = group_data_from_results(res, groupname, 'group_id') - return id if id + group_data_from_results(res, groupname, 'group_id') end
{'count' => count, 'members' => Hash }
+{‘count’ => count, ‘members’ => Hash }
Extract the group data for 'key' based on the site result object
+Extract the group data for ‘key’ based on the site result object
+154 155 156 157 158 159 -160 -161+160
# File 'lib/sfrest/group.rb', line 155 +# File 'lib/sfrest/group.rb', line 154 def group_data_from_results(res, groupname, key) groups = res['groups'] @@ -1399,7 +1397,7 @@—
-@@ -1534,7 +1532,7 @@all the groups on the factory plus a count {'count' => count, 'groups' => Hash }
+all the groups on the factory plus a count {‘count’ => count, ‘groups’ => Hash }
—
-@@ -1633,7 +1631,7 @@{'count' => count, 'uids_promoted' => [1, 2, …] }
+{‘count’ => count, ‘uids_promoted’ => [1, 2, …] }
—
-@@ -1732,7 +1730,7 @@=> 123, 'uids_removed' => [1, 2, …]
+=> 123, ‘uids_removed’ => [1, 2, …]
—
-@@ -1898,7 +1896,7 @@=> 123, 'site_ids_removed' => [1, 2, …], 'site_ids_failed' => [3, 4, …]
+=> 123, ‘site_ids_removed’ => [1, 2, …], ‘site_ids_failed’ => [3, 4, …]
—
-@@ -1911,13 +1909,13 @@{'count' => count, 'sites' => Hash }
+{‘count’ => count, ‘sites’ => Hash }
+165 166 167 -168 -169+168
# File 'lib/sfrest/group.rb', line 166 +# File 'lib/sfrest/group.rb', line 165 def sites(group_id = 0) current_path = "/api/v1/groups/#{group_id}/sites" @@ -1933,9 +1931,9 @@diff --git a/doc/SFRest/Info.html b/doc/SFRest/Info.html index 2ce33df..4273b62 100644 --- a/doc/SFRest/Info.html +++ b/doc/SFRest/Info.html @@ -6,7 +6,7 @@
Class: SFRest::Info - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -305,9 +305,9 @@diff --git a/doc/SFRest/InvalidApiVersion.html b/doc/SFRest/InvalidApiVersion.html index b25a8e4..aa64db6 100644 --- a/doc/SFRest/InvalidApiVersion.html +++ b/doc/SFRest/InvalidApiVersion.html @@ -6,7 +6,7 @@
Exception: SFRest::InvalidApiVersion - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -133,9 +133,9 @@Overview
diff --git a/doc/SFRest/InvalidDataError.html b/doc/SFRest/InvalidDataError.html index 6962045..2df24f8 100644 --- a/doc/SFRest/InvalidDataError.html +++ b/doc/SFRest/InvalidDataError.html @@ -6,7 +6,7 @@Exception: SFRest::InvalidDataError - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -133,9 +133,9 @@Overview
diff --git a/doc/SFRest/InvalidResponse.html b/doc/SFRest/InvalidResponse.html index 4d55cd3..51b49bd 100644 --- a/doc/SFRest/InvalidResponse.html +++ b/doc/SFRest/InvalidResponse.html @@ -6,7 +6,7 @@Exception: SFRest::InvalidResponse - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -133,9 +133,9 @@Overview
diff --git a/doc/SFRest/Pathbuilder.html b/doc/SFRest/Pathbuilder.html index 3094bf6..11d62ba 100644 --- a/doc/SFRest/Pathbuilder.html +++ b/doc/SFRest/Pathbuilder.html @@ -6,7 +6,7 @@Class: SFRest::Pathbuilder - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -250,9 +250,9 @@diff --git a/doc/SFRest/Profile.html b/doc/SFRest/Profile.html index c160292..81e7a3b 100644 --- a/doc/SFRest/Profile.html +++ b/doc/SFRest/Profile.html @@ -6,7 +6,7 @@
Class: SFRest::Profile - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -561,7 +561,7 @@—
-@@ -692,9 +692,9 @@Profile info formatted like so: { 'profiles' => [ +
Profile info formatted like so: { ‘profiles’ => [
-'name' => 'testing', 'description' => 'Some description', 'stack_id' => 1, @@ -569,7 +569,7 @@
'enabled' => true
], 'count' => 1, 'time' => '2021-03-12T02:26:34+00:00'
+], ‘count’ => 1, ‘time’ => ‘2021-03-12T02:26:34+00:00’
diff --git a/doc/SFRest/Role.html b/doc/SFRest/Role.html index a125589..d1923eb 100644 --- a/doc/SFRest/Role.html +++ b/doc/SFRest/Role.html @@ -6,7 +6,7 @@
Class: SFRest::Role - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -827,7 +827,7 @@—
-@@ -981,9 +981,9 @@all the roles on the factory plus a count {'count' => count, 'roles' => Hash }
+all the roles on the factory plus a count {‘count’ => count, ‘roles’ => Hash }
diff --git a/doc/SFRest/SFError.html b/doc/SFRest/SFError.html index c5bec8e..e50bf8c 100644 --- a/doc/SFRest/SFError.html +++ b/doc/SFRest/SFError.html @@ -6,7 +6,7 @@
Exception: SFRest::SFError - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -129,9 +129,9 @@Direct Known Subclasses
diff --git a/doc/SFRest/Security_settings.html b/doc/SFRest/Security_settings.html index 649a261..68d1f35 100644 --- a/doc/SFRest/Security_settings.html +++ b/doc/SFRest/Security_settings.html @@ -6,7 +6,7 @@Class: SFRest::Security_settings - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -566,9 +566,9 @@diff --git a/doc/SFRest/Site.html b/doc/SFRest/Site.html index 4f8b2c7..5a2928a 100644 --- a/doc/SFRest/Site.html +++ b/doc/SFRest/Site.html @@ -6,7 +6,7 @@
Class: SFRest::Site - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -339,7 +339,7 @@
-@@ -1004,7 +1004,7 @@Extract the site data for 'key' based on the site result object.
+Extract the site data for ‘key’ based on the site result object.
diff --git a/doc/SFRest/Site_guard.html b/doc/SFRest/Site_guard.html index d6072a0..abdb70f 100644 --- a/doc/SFRest/Site_guard.html +++ b/doc/SFRest/Site_guard.html @@ -6,7 +6,7 @@-@@ -1231,9 +1231,9 @@Extract the site data for 'key' based on the site result object
+Extract the site data for ‘key’ based on the site result object
Class: SFRest::Site_guard - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -538,9 +538,9 @@diff --git a/doc/SFRest/Site_ownership.html b/doc/SFRest/Site_ownership.html index 3b4a6f0..9eadadf 100644 --- a/doc/SFRest/Site_ownership.html +++ b/doc/SFRest/Site_ownership.html @@ -6,7 +6,7 @@
Class: SFRest::Site_ownership - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -772,9 +772,9 @@- Generated on Thu Apr 25 14:58:27 2024 by - yard - 0.9.25 (ruby-2.7.5). + Generated on Thu May 9 14:39:29 2024 by + yard + 0.9.36 (ruby-3.1.3). diff --git a/doc/SFRest/Site_update_priority.html b/doc/SFRest/Site_update_priority.html index 090a608..69abd38 100644 --- a/doc/SFRest/Site_update_priority.html +++ b/doc/SFRest/Site_update_priority.html @@ -6,7 +6,7 @@
Class: SFRest::Site_update_priority - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -500,9 +500,9 @@diff --git a/doc/SFRest/Stage.html b/doc/SFRest/Stage.html index 9cb6b3c..aeb2842 100644 --- a/doc/SFRest/Stage.html +++ b/doc/SFRest/Stage.html @@ -6,7 +6,7 @@
Class: SFRest::Stage - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -217,7 +217,7 @@
-@@ -657,7 +657,7 @@Stage a site rubocop: disable Style/OptionalBooleanParameter.
+Stage a site rubocop: disable Style/OptionalBooleanParameter, Metrics/ParameterLists.
diff --git a/doc/SFRest/Task.html b/doc/SFRest/Task.html index 27dfa97..29d6129 100644 --- a/doc/SFRest/Task.html +++ b/doc/SFRest/Task.html @@ -6,7 +6,7 @@-@@ -883,9 +883,9 @@Stage a site rubocop: disable Style/OptionalBooleanParameter
+Stage a site rubocop: disable Style/OptionalBooleanParameter, Metrics/ParameterLists
Class: SFRest::Task - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -474,7 +474,7 @@
-@@ -1144,13 +1144,13 @@Get a specific task's logs.
+Get a specific task’s logs.
-271 -272 273 -274+274 +275 +276
# File 'lib/sfrest/task.rb', line 271 +# File 'lib/sfrest/task.rb', line 273 def delete_task(task_id) current_path = "/api/v1/tasks/#{task_id}" @@ -1225,13 +1225,13 @@
-178 -179 180 -181+181 +182 +183
# File 'lib/sfrest/task.rb', line 178 +# File 'lib/sfrest/task.rb', line 180 def find_task(task_id) current_path = "/api/v1/tasks/#{task_id}" @@ -1254,7 +1254,7 @@
-@@ -1375,7 +1375,6 @@Find a set of task ids.
+Find a set of task ids. rubocop:disable Metrics/ParameterLists
-150 151 152 153 @@ -1384,13 +1383,16 @@+159 +160 +161156 157 158 -159
# File 'lib/sfrest/task.rb', line 150 +# File 'lib/sfrest/task.rb', line 151 def find_task_ids(limit = nil, page = nil, group = nil, klass = nil, status = nil) - res = find_tasks limit: limit, page: page, group: group, klass: klass, status: status + # rubocop:enable Metrics/ParameterLists + res = find_tasks limit: limit, page: page, group: group, klass: klass, status: status task_ids = [] i = 0 res.each do |task| @@ -1526,14 +1528,14 @@
-169 -170 171 172 -173+173 +174 +175
# File 'lib/sfrest/task.rb', line 169 +# File 'lib/sfrest/task.rb', line 171 def find_tasks(datum = nil) current_path = '/api/v1/tasks' @@ -1611,13 +1613,13 @@
-279 -280 281 -282+282 +283 +284
# File 'lib/sfrest/task.rb', line 279 +# File 'lib/sfrest/task.rb', line 281 def get_task_class_info(type = '') current_path = "/api/v1/classes/#{type}" @@ -1728,8 +1730,6 @@
-188 -189 190 191 192 @@ -1741,10 +1741,12 @@+201 +202 +203198 199 200 -201
# File 'lib/sfrest/task.rb', line 188 +# File 'lib/sfrest/task.rb', line 190 def get_task_id(name, group = nil, klass = nil, status = nil) page_size = 100 @@ -1777,7 +1779,7 @@
-@@ -1806,13 +1808,13 @@Get a specific task's logs
+Get a specific task’s logs
-219 -220 221 -222+222 +223 +224
# File 'lib/sfrest/task.rb', line 219 +# File 'lib/sfrest/task.rb', line 221 def get_task_logs(task_id) current_path = "/api/v1/tasks/#{task_id}/logs" @@ -1877,13 +1879,13 @@
-287 -288 289 -290+290 +291 +292
# File 'lib/sfrest/task.rb', line 287 +# File 'lib/sfrest/task.rb', line 289 def get_wip_task_status(task_id) current_path = "/api/v1/wip/task/#{task_id}/status" @@ -1933,8 +1935,6 @@
-227 -228 229 230 231 @@ -1943,10 +1943,12 @@+237 +238 +239234 235 236 -237
# File 'lib/sfrest/task.rb', line 227 +# File 'lib/sfrest/task.rb', line 229 def globally_paused? paused = false @@ -1990,14 +1992,14 @@
-204 -205 206 207 -208+208 +209 +210
# File 'lib/sfrest/task.rb', line 204 +# File 'lib/sfrest/task.rb', line 206 def pause_all_tasks current_path = '/api/v1/pause' @@ -2021,7 +2023,7 @@
-@@ -2068,14 +2070,14 @@Pauses a specific task identified by its task id. This can pause either the task and it's children or just the task
+Pauses a specific task identified by its task id. This can pause either the task and it’s children or just the task
-243 -244 245 246 -247+247 +248 +249
# File 'lib/sfrest/task.rb', line 243 +# File 'lib/sfrest/task.rb', line 245 def pause_task(task_id, level = 'family') current_path = "/api/v1/pause/#{task_id}" @@ -2113,14 +2115,14 @@
-211 -212 213 214 -215+215 +216 +217
# File 'lib/sfrest/task.rb', line 211 +# File 'lib/sfrest/task.rb', line 213 def resume_all_tasks current_path = '/api/v1/pause' @@ -2144,7 +2146,7 @@
-@@ -2191,14 +2193,14 @@Resumes a specific task identified by its task id. This can resume either the task and it's children or just the task
+Resumes a specific task identified by its task id. This can resume either the task and it’s children or just the task
-253 -254 255 256 -257+257 +258 +259
# File 'lib/sfrest/task.rb', line 253 +# File 'lib/sfrest/task.rb', line 255 def resume_task(task_id, level = 'family') current_path = "/api/v1/pause/#{task_id}" @@ -3207,14 +3209,14 @@
-262 -263 264 265 -266+266 +267 +268
# File 'lib/sfrest/task.rb', line 262 +# File 'lib/sfrest/task.rb', line 264 def terminate_task(task_id) current_path = "/api/v1/tasks/#{task_id}/terminate" @@ -3285,12 +3287,12 @@
-295 -296 -297+297 +298 +299
# File 'lib/sfrest/task.rb', line 295 +# File 'lib/sfrest/task.rb', line 297 def wait_until_done(task_id, max_nap = 600) wait_until_state(task_id, 'done', max_nap) @@ -3373,8 +3375,6 @@
-303 -304 305 306 307 @@ -3384,15 +3384,17 @@+314 +315 +316311 312 313 -314
# File 'lib/sfrest/task.rb', line 303 +# File 'lib/sfrest/task.rb', line 305 def wait_until_state(task_id, state, max_nap) blink_time = 5 # wake up and scan nap_start = Time.now - state_method = method("task_#{state}?".to_sym) + state_method = method(:"task_#{state}?") loop do break if state_method.call(task_id) raise TaskNotDoneError, "Task: #{task_id} has taken too long to complete!" if Time.new > (nap_start + max_nap) @@ -3411,9 +3413,9 @@diff --git a/doc/SFRest/TaskNotDoneError.html b/doc/SFRest/TaskNotDoneError.html index 3498b4a..74a7444 100644 --- a/doc/SFRest/TaskNotDoneError.html +++ b/doc/SFRest/TaskNotDoneError.html @@ -6,7 +6,7 @@
Exception: SFRest::TaskNotDoneError - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -133,9 +133,9 @@Overview
diff --git a/doc/SFRest/Task_log_settings.html b/doc/SFRest/Task_log_settings.html index b4cd7d6..3d2e826 100644 --- a/doc/SFRest/Task_log_settings.html +++ b/doc/SFRest/Task_log_settings.html @@ -6,7 +6,7 @@Class: SFRest::Task_log_settings - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -520,9 +520,9 @@diff --git a/doc/SFRest/Theme.html b/doc/SFRest/Theme.html index 245c229..62efe0c 100644 --- a/doc/SFRest/Theme.html +++ b/doc/SFRest/Theme.html @@ -6,7 +6,7 @@
Class: SFRest::Theme - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -294,14 +294,14 @@
-19 -20 21 22 -23+23 +24 +25
# File 'lib/sfrest/theme.rb', line 19 +# File 'lib/sfrest/theme.rb', line 21 def process_theme_notification(sitegroup_id = 0) current_path = '/api/v1/theme/process' @@ -325,7 +325,7 @@
-@@ -339,17 +339,19 @@Sends a theme notification.
+Sends a theme notification. rubocop:disable Metrics/ParameterLists
-12 13 14 15 -16+16 +17 +18
# File 'lib/sfrest/theme.rb', line 12 +# File 'lib/sfrest/theme.rb', line 13 def send_theme_notification(scope = 'site', event = 'modify', nid = 0, theme = '') - current_path = '/api/v1/theme/notification' + # rubocop:enable Metrics/ParameterLists + current_path = '/api/v1/theme/notification' payload = { 'scope' => scope, 'event' => event, 'nid' => nid, 'theme' => theme }.to_json @conn.post(current_path, payload) end@@ -363,9 +365,9 @@diff --git a/doc/SFRest/UnprocessableEntity.html b/doc/SFRest/UnprocessableEntity.html index 9b59ec2..8388df7 100644 --- a/doc/SFRest/UnprocessableEntity.html +++ b/doc/SFRest/UnprocessableEntity.html @@ -6,7 +6,7 @@
Exception: SFRest::UnprocessableEntity - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -133,9 +133,9 @@Overview
diff --git a/doc/SFRest/Update.html b/doc/SFRest/Update.html index 6f17e60..fb36f9d 100644 --- a/doc/SFRest/Update.html +++ b/doc/SFRest/Update.html @@ -6,7 +6,7 @@Class: SFRest::Update - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -1012,7 +1012,7 @@
diff --git a/doc/SFRest/Usage.html b/doc/SFRest/Usage.html index e9ff492..e4a3494 100644 --- a/doc/SFRest/Usage.html +++ b/doc/SFRest/Usage.html @@ -6,7 +6,7 @@-@@ -1311,9 +1311,9 @@Starts an update. The rest api supports the following scope: sites|factory|both (defaults to 'sites') start_time: sites_type: code|code, db| code, db, registry (defaults to 'code, db') factory_type: code|code, db (defaults to 'code, db') sites_ref: factory_ref: This method does not filter or validate so that it can be used for negative cases. (missing data)
+Starts an update. The rest api supports the following scope: sites|factory|both (defaults to ‘sites’) start_time: sites_type: code|code, db| code, db, registry (defaults to ‘code, db’) factory_type: code|code, db (defaults to ‘code, db’) sites_ref: factory_ref: This method does not filter or validate so that it can be used for negative cases. (missing data)
Class: SFRest::Usage - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -298,7 +298,7 @@
@@ -319,7 +319,7 @@Optional filter parameters
-'start_from' => “YYYY-MM”, # String 'sort_order' => “acs|desc”, # String 'limit' => Integer, # Number of months to list (max 120) 'page' => Integer # Page number to show
+‘start_from’ => “YYYY-MM”, # String ‘sort_order’ => “acs|desc”, # String ‘limit’ => Integer, # Number of months to list (max 120) ‘page’ => Integer # Page number to show
diff --git a/doc/SFRest/User.html b/doc/SFRest/User.html index 7c432c1..96e70e4 100644 --- a/doc/SFRest/User.html +++ b/doc/SFRest/User.html @@ -6,7 +6,7 @@The dynamic request data.
-{ 'count' => Integer,
+{ ‘count’ => Integer,
'time' => String date, 'most_recent_data' => 'YYYY-MM-DD', @@ -375,9 +375,9 @@
Class: SFRest::User - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -337,7 +337,7 @@
-@@ -968,7 +968,7 @@Extract the user data for 'key' based on the user result object.
+Extract the user data for ‘key’ based on the user result object.
diff --git a/doc/SFRest/Variable.html b/doc/SFRest/Variable.html index fd430f2..050443d 100644 --- a/doc/SFRest/Variable.html +++ b/doc/SFRest/Variable.html @@ -6,7 +6,7 @@-@@ -1169,9 +1169,9 @@Extract the user data for 'key' based on the user result object
+Extract the user data for ‘key’ based on the user result object
Class: SFRest::Variable - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -428,9 +428,9 @@diff --git a/doc/_index.html b/doc/_index.html index 4777d3f..aa46e1a 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -4,7 +4,7 @@
- Documentation by YARD 0.9.25 + Documentation by YARD 0.9.36 @@ -52,7 +52,7 @@ -diff --git a/doc/frames.html b/doc/frames.html index 691af4e..53734c2 100644 --- a/doc/frames.html +++ b/doc/frames.html @@ -2,13 +2,18 @@ -Documentation by YARD 0.9.25
+diff --git a/doc/css/style.css b/doc/css/style.css index 62f4349..eb0dbc8 100644 --- a/doc/css/style.css +++ b/doc/css/style.css @@ -52,6 +52,7 @@ body { background: #fff; padding: 1.2em; padding-top: 0.2em; + box-sizing: border-box; } @media (max-width: 920px) { diff --git a/doc/file.README.html b/doc/file.README.html index 953e62f..1e7e7a4 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -6,7 +6,7 @@Documentation by YARD 0.9.36
Alphabetic Index
@@ -448,9 +448,9 @@Namespace Listing A-Z
File: README - — Documentation by YARD 0.9.25 + — Documentation by YARD 0.9.36 @@ -84,13 +84,13 @@Usage
Contributing
-See contribute.md
+See contribute.md
Documentation by YARD 0.9.25 +Documentation by YARD 0.9.36