1and1 1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +2 -0
- data/1and1-1.0.gem +0 -0
- data/1and1.gemspec +20 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +499 -0
- data/docs/reference.md +2447 -0
- data/examples/dvd_examples.rb +15 -0
- data/examples/example_app.rb +100 -0
- data/examples/firewall_examples.rb +137 -0
- data/examples/image_examples.rb +48 -0
- data/examples/load_balancer_examples.rb +145 -0
- data/examples/log_examples.rb +15 -0
- data/examples/monitoring_center_examples.rb +15 -0
- data/examples/monitoring_policy_examples.rb +343 -0
- data/examples/private_network_examples.rb +86 -0
- data/examples/public_ip_examples.rb +42 -0
- data/examples/role_examples.rb +113 -0
- data/examples/server_appliance_examples.rb +15 -0
- data/examples/server_examples.rb +438 -0
- data/examples/shared_storage_examples.rb +108 -0
- data/examples/usage_examples.rb +6 -0
- data/examples/user_examples.rb +113 -0
- data/examples/vpn_examples.rb +56 -0
- data/lib/1and1/datacenter.rb +73 -0
- data/lib/1and1/dvd.rb +73 -0
- data/lib/1and1/firewall.rb +427 -0
- data/lib/1and1/image.rb +231 -0
- data/lib/1and1/load_balancer.rb +448 -0
- data/lib/1and1/log.rb +77 -0
- data/lib/1and1/monitoring_center.rb +84 -0
- data/lib/1and1/monitoring_policy.rb +598 -0
- data/lib/1and1/oneandone.rb +57 -0
- data/lib/1and1/ping.rb +41 -0
- data/lib/1and1/ping_auth.rb +41 -0
- data/lib/1and1/pricing.rb +41 -0
- data/lib/1and1/private_network.rb +333 -0
- data/lib/1and1/public_ip.rb +192 -0
- data/lib/1and1/role.rb +381 -0
- data/lib/1and1/server.rb +1208 -0
- data/lib/1and1/server_appliance.rb +73 -0
- data/lib/1and1/shared_storage.rb +379 -0
- data/lib/1and1/usage.rb +58 -0
- data/lib/1and1/user.rb +374 -0
- data/lib/1and1/vpn.rb +249 -0
- data/lib/oneandone.rb +27 -0
- data/sphinx/Makefile +192 -0
- data/sphinx/_build/doctrees/dvds.doctree +0 -0
- data/sphinx/_build/doctrees/environment.pickle +0 -0
- data/sphinx/_build/doctrees/firewalls.doctree +0 -0
- data/sphinx/_build/doctrees/images.doctree +0 -0
- data/sphinx/_build/doctrees/index.doctree +0 -0
- data/sphinx/_build/doctrees/load_balancers.doctree +0 -0
- data/sphinx/_build/doctrees/logs.doctree +0 -0
- data/sphinx/_build/doctrees/monitoring_center.doctree +0 -0
- data/sphinx/_build/doctrees/monitoring_policies.doctree +0 -0
- data/sphinx/_build/doctrees/private_networks.doctree +0 -0
- data/sphinx/_build/doctrees/public_ips.doctree +0 -0
- data/sphinx/_build/doctrees/server_appliances.doctree +0 -0
- data/sphinx/_build/doctrees/servers.doctree +0 -0
- data/sphinx/_build/doctrees/shared_storages.doctree +0 -0
- data/sphinx/_build/doctrees/usages.doctree +0 -0
- data/sphinx/_build/doctrees/users.doctree +0 -0
- data/sphinx/_build/html/.buildinfo +4 -0
- data/sphinx/_build/html/_sources/dvds.txt +42 -0
- data/sphinx/_build/html/_sources/firewalls.txt +189 -0
- data/sphinx/_build/html/_sources/images.txt +101 -0
- data/sphinx/_build/html/_sources/index.txt +499 -0
- data/sphinx/_build/html/_sources/load_balancers.txt +231 -0
- data/sphinx/_build/html/_sources/logs.txt +55 -0
- data/sphinx/_build/html/_sources/monitoring_center.txt +55 -0
- data/sphinx/_build/html/_sources/monitoring_policies.txt +288 -0
- data/sphinx/_build/html/_sources/private_networks.txt +146 -0
- data/sphinx/_build/html/_sources/public_ips.txt +78 -0
- data/sphinx/_build/html/_sources/server_appliances.txt +42 -0
- data/sphinx/_build/html/_sources/servers.txt +630 -0
- data/sphinx/_build/html/_sources/shared_storages.txt +160 -0
- data/sphinx/_build/html/_sources/usages.txt +45 -0
- data/sphinx/_build/html/_sources/users.txt +172 -0
- data/sphinx/_build/html/_static/ajax-loader.gif +0 -0
- data/sphinx/_build/html/_static/alabaster.css +585 -0
- data/sphinx/_build/html/_static/basic.css +599 -0
- data/sphinx/_build/html/_static/comment-bright.png +0 -0
- data/sphinx/_build/html/_static/comment-close.png +0 -0
- data/sphinx/_build/html/_static/comment.png +0 -0
- data/sphinx/_build/html/_static/doctools.js +263 -0
- data/sphinx/_build/html/_static/down-pressed.png +0 -0
- data/sphinx/_build/html/_static/down.png +0 -0
- data/sphinx/_build/html/_static/file.png +0 -0
- data/sphinx/_build/html/_static/jquery-1.11.1.js +10308 -0
- data/sphinx/_build/html/_static/jquery.js +4 -0
- data/sphinx/_build/html/_static/minus.png +0 -0
- data/sphinx/_build/html/_static/plus.png +0 -0
- data/sphinx/_build/html/_static/pygments.css +63 -0
- data/sphinx/_build/html/_static/searchtools.js +651 -0
- data/sphinx/_build/html/_static/underscore-1.3.1.js +999 -0
- data/sphinx/_build/html/_static/underscore.js +31 -0
- data/sphinx/_build/html/_static/up-pressed.png +0 -0
- data/sphinx/_build/html/_static/up.png +0 -0
- data/sphinx/_build/html/_static/websupport.js +808 -0
- data/sphinx/_build/html/dvds.html +151 -0
- data/sphinx/_build/html/firewalls.html +397 -0
- data/sphinx/_build/html/genindex.html +114 -0
- data/sphinx/_build/html/images.html +236 -0
- data/sphinx/_build/html/index.html +571 -0
- data/sphinx/_build/html/load_balancers.html +409 -0
- data/sphinx/_build/html/logs.html +160 -0
- data/sphinx/_build/html/monitoring_center.html +160 -0
- data/sphinx/_build/html/monitoring_policies.html +530 -0
- data/sphinx/_build/html/objects.inv +0 -0
- data/sphinx/_build/html/private_networks.html +316 -0
- data/sphinx/_build/html/public_ips.html +215 -0
- data/sphinx/_build/html/rb-modindex.html +106 -0
- data/sphinx/_build/html/search.html +99 -0
- data/sphinx/_build/html/searchindex.js +1 -0
- data/sphinx/_build/html/server_appliances.html +153 -0
- data/sphinx/_build/html/servers.html +994 -0
- data/sphinx/_build/html/shared_storages.html +349 -0
- data/sphinx/_build/html/usages.html +140 -0
- data/sphinx/_build/html/users.html +363 -0
- data/sphinx/conf.py +287 -0
- data/sphinx/dvds.rst +42 -0
- data/sphinx/firewalls.rst +189 -0
- data/sphinx/images.rst +101 -0
- data/sphinx/index.rst +499 -0
- data/sphinx/load_balancers.rst +231 -0
- data/sphinx/logs.rst +55 -0
- data/sphinx/make.bat +263 -0
- data/sphinx/monitoring_center.rst +55 -0
- data/sphinx/monitoring_policies.rst +288 -0
- data/sphinx/private_networks.rst +146 -0
- data/sphinx/public_ips.rst +78 -0
- data/sphinx/server_appliances.rst +42 -0
- data/sphinx/servers.rst +630 -0
- data/sphinx/shared_storages.rst +160 -0
- data/sphinx/usages.rst +45 -0
- data/sphinx/users.rst +172 -0
- data/test/mock-api/add-firewall.json +66 -0
- data/test/mock-api/add-hdd.json +49 -0
- data/test/mock-api/add-lb.json +71 -0
- data/test/mock-api/add-new-ip.json +18 -0
- data/test/mock-api/add-pn.json +66 -0
- data/test/mock-api/add-port-mp.json +81 -0
- data/test/mock-api/add-process-mp.json +20 -0
- data/test/mock-api/add-rule-fp.json +33 -0
- data/test/mock-api/add-rule-lb.json +40 -0
- data/test/mock-api/add-server-ip.json +66 -0
- data/test/mock-api/add-server-mp.json +66 -0
- data/test/mock-api/assign-ip-fp.json +32 -0
- data/test/mock-api/assign-server-lb.json +39 -0
- data/test/mock-api/attach-server-pn.json +14 -0
- data/test/mock-api/attach-server-storage.json +24 -0
- data/test/mock-api/change-api-key.json +15 -0
- data/test/mock-api/change-password.json +5 -0
- data/test/mock-api/change-server-status.json +70 -0
- data/test/mock-api/clone-server.json +29 -0
- data/test/mock-api/create-fp.json +26 -0
- data/test/mock-api/create-image.json +30 -0
- data/test/mock-api/create-lb.json +33 -0
- data/test/mock-api/create-mp.json +81 -0
- data/test/mock-api/create-pn.json +11 -0
- data/test/mock-api/create-public-ip.json +10 -0
- data/test/mock-api/create-server.json +34 -0
- data/test/mock-api/create-snapshot.json +74 -0
- data/test/mock-api/create-storage.json +13 -0
- data/test/mock-api/create-user.json +14 -0
- data/test/mock-api/delete-fp.json +26 -0
- data/test/mock-api/delete-image.json +26 -0
- data/test/mock-api/delete-ip.json +15 -0
- data/test/mock-api/delete-lb.json +33 -0
- data/test/mock-api/delete-mp.json +71 -0
- data/test/mock-api/delete-pn.json +11 -0
- data/test/mock-api/delete-public-ip.json +10 -0
- data/test/mock-api/delete-rule-fp.json +26 -0
- data/test/mock-api/delete-server.json +50 -0
- data/test/mock-api/delete-snapshot.json +74 -0
- data/test/mock-api/delete-storage.json +24 -0
- data/test/mock-api/delete-user.json +15 -0
- data/test/mock-api/detach-server-lb.json +33 -0
- data/test/mock-api/detach-server-mp.json +65 -0
- data/test/mock-api/detach-server-storage.json +19 -0
- data/test/mock-api/edit-image.json +26 -0
- data/test/mock-api/eject-dvd.json +66 -0
- data/test/mock-api/fixed-server-flavors.json +70 -0
- data/test/mock-api/get-appliance.json +16 -0
- data/test/mock-api/get-dvd.json +9 -0
- data/test/mock-api/get-firewall.json +26 -0
- data/test/mock-api/get-fixed-server.json +17 -0
- data/test/mock-api/get-fp-rule.json +7 -0
- data/test/mock-api/get-hardware.json +13 -0
- data/test/mock-api/get-hdd.json +5 -0
- data/test/mock-api/get-image.json +26 -0
- data/test/mock-api/get-lb-rule.json +7 -0
- data/test/mock-api/get-lb-server.json +5 -0
- data/test/mock-api/get-load-balancer.json +33 -0
- data/test/mock-api/get-log.json +23 -0
- data/test/mock-api/get-monitoring-center.json +161 -0
- data/test/mock-api/get-mp-port.json +7 -0
- data/test/mock-api/get-mp-process.json +6 -0
- data/test/mock-api/get-mp-server.json +4 -0
- data/test/mock-api/get-mp.json +65 -0
- data/test/mock-api/get-pn-server.json +4 -0
- data/test/mock-api/get-private-network.json +20 -0
- data/test/mock-api/get-public-ip.json +10 -0
- data/test/mock-api/get-server-dvd.json +4 -0
- data/test/mock-api/get-server-image.json +4 -0
- data/test/mock-api/get-server-ip-fp.json +4 -0
- data/test/mock-api/get-server-ip.json +8 -0
- data/test/mock-api/get-server-pn.json +16 -0
- data/test/mock-api/get-server-status.json +4 -0
- data/test/mock-api/get-server-storage.json +5 -0
- data/test/mock-api/get-server.json +44 -0
- data/test/mock-api/get-storage.json +19 -0
- data/test/mock-api/get-usage.json +161 -0
- data/test/mock-api/get-user-api-key.json +3 -0
- data/test/mock-api/get-user-api.json +7 -0
- data/test/mock-api/get-user.json +15 -0
- data/test/mock-api/list-appliances.json +66 -0
- data/test/mock-api/list-credentials.json +5 -0
- data/test/mock-api/list-dvds.json +128 -0
- data/test/mock-api/list-firewalls.json +54 -0
- data/test/mock-api/list-fp-rules.json +16 -0
- data/test/mock-api/list-hdds.json +7 -0
- data/test/mock-api/list-images.json +54 -0
- data/test/mock-api/list-lb-rules.json +16 -0
- data/test/mock-api/list-lb-servers.json +12 -0
- data/test/mock-api/list-load-balancers.json +68 -0
- data/test/mock-api/list-logs.json +49 -0
- data/test/mock-api/list-monitoring-center-usages.json +90 -0
- data/test/mock-api/list-mp-ports.json +16 -0
- data/test/mock-api/list-mp-processes.json +14 -0
- data/test/mock-api/list-mp-servers.json +10 -0
- data/test/mock-api/list-mps.json +152 -0
- data/test/mock-api/list-pn-servers.json +10 -0
- data/test/mock-api/list-private-networks.json +24 -0
- data/test/mock-api/list-public-ips.json +44 -0
- data/test/mock-api/list-server-fps.json +4 -0
- data/test/mock-api/list-server-ips-fp.json +7 -0
- data/test/mock-api/list-server-ips.json +10 -0
- data/test/mock-api/list-server-lbs.json +6 -0
- data/test/mock-api/list-server-pns.json +6 -0
- data/test/mock-api/list-servers.json +66 -0
- data/test/mock-api/list-snapshots.json +7 -0
- data/test/mock-api/list-storages.json +47 -0
- data/test/mock-api/list-usages.json +144 -0
- data/test/mock-api/list-user-ips.json +5 -0
- data/test/mock-api/list-users.json +31 -0
- data/test/mock-api/load-dvd.json +63 -0
- data/test/mock-api/modify-fp.json +26 -0
- data/test/mock-api/modify-lb.json +33 -0
- data/test/mock-api/modify-mp.json +81 -0
- data/test/mock-api/modify-pn.json +20 -0
- data/test/mock-api/modify-port-mp.json +81 -0
- data/test/mock-api/modify-process-mp.json +73 -0
- data/test/mock-api/modify-public-ip.json +10 -0
- data/test/mock-api/modify-server-hardware.json +44 -0
- data/test/mock-api/modify-server-hdd.json +54 -0
- data/test/mock-api/modify-server.json +44 -0
- data/test/mock-api/modify-storage.json +19 -0
- data/test/mock-api/modify-user-api.json +15 -0
- data/test/mock-api/modify-user.json +15 -0
- data/test/mock-api/reinstall-image.json +52 -0
- data/test/mock-api/remove-firewall-policy.json +26 -0
- data/test/mock-api/remove-hdd.json +54 -0
- data/test/mock-api/remove-ip-fp.json +26 -0
- data/test/mock-api/remove-lb.json +66 -0
- data/test/mock-api/remove-pn.json +71 -0
- data/test/mock-api/remove-port-mp.json +73 -0
- data/test/mock-api/remove-process-mp.json +66 -0
- data/test/mock-api/remove-rule-lb.json +33 -0
- data/test/mock-api/remove-server-ip.json +58 -0
- data/test/mock-api/remove-server-pn.json +16 -0
- data/test/mock-api/restore-snapshot.json +55 -0
- data/test/mock-api/storage-servers.json +12 -0
- data/test/test_mock_dvd.rb +55 -0
- data/test/test_mock_firewall.rb +309 -0
- data/test/test_mock_image.rb +123 -0
- data/test/test_mock_load_balancer.rb +312 -0
- data/test/test_mock_log.rb +55 -0
- data/test/test_mock_monitoring_center.rb +55 -0
- data/test/test_mock_monitoring_policy.rb +587 -0
- data/test/test_mock_private_network.rb +206 -0
- data/test/test_mock_public_ip.rb +118 -0
- data/test/test_mock_server.rb +929 -0
- data/test/test_mock_server_appliance.rb +55 -0
- data/test/test_mock_shared_storage.rb +256 -0
- data/test/test_mock_usage.rb +34 -0
- data/test/test_mock_user.rb +270 -0
- metadata +360 -0
|
@@ -0,0 +1,363 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
6
|
+
<head>
|
|
7
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
8
|
+
|
|
9
|
+
<title>Users — 1and1 Ruby SDK 1.0 documentation</title>
|
|
10
|
+
|
|
11
|
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
12
|
+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
13
|
+
|
|
14
|
+
<script type="text/javascript">
|
|
15
|
+
var DOCUMENTATION_OPTIONS = {
|
|
16
|
+
URL_ROOT: './',
|
|
17
|
+
VERSION: '1.0',
|
|
18
|
+
COLLAPSE_INDEX: false,
|
|
19
|
+
FILE_SUFFIX: '.html',
|
|
20
|
+
HAS_SOURCE: true
|
|
21
|
+
};
|
|
22
|
+
</script>
|
|
23
|
+
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
24
|
+
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
25
|
+
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
26
|
+
<link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
|
|
27
|
+
<link rel="next" title="Usages" href="usages.html" />
|
|
28
|
+
<link rel="prev" title="Logs" href="logs.html" />
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
|
32
|
+
|
|
33
|
+
</head>
|
|
34
|
+
<body role="document">
|
|
35
|
+
|
|
36
|
+
<div class="document">
|
|
37
|
+
<div class="documentwrapper">
|
|
38
|
+
<div class="bodywrapper">
|
|
39
|
+
<div class="body" role="main">
|
|
40
|
+
|
|
41
|
+
<div class="section" id="users">
|
|
42
|
+
<h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h1>
|
|
43
|
+
<dl class="class">
|
|
44
|
+
<dt>
|
|
45
|
+
<code class="descname">OneAndOne::User()</code></dt>
|
|
46
|
+
<dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">User</span></code> class allows a user to perform actions against the 1and1 API.</p>
|
|
47
|
+
<dl class="method">
|
|
48
|
+
<dt id="list">
|
|
49
|
+
<code class="descname">list</code><span class="sig-paren">(</span><em>page: nil</em>, <em>per_page: nil</em>, <em>sort: nil</em>, <em>q: nil</em>, <em>fields: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#list" title="Permalink to this definition">¶</a></dt>
|
|
50
|
+
<dd><p>List all users on your account.</p>
|
|
51
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
52
|
+
<col class="field-name" />
|
|
53
|
+
<col class="field-body" />
|
|
54
|
+
<tbody valign="top">
|
|
55
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
56
|
+
<li><strong>page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Allows the use of pagination. Indicate which page to start on.</li>
|
|
57
|
+
<li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Number of items per page.</li>
|
|
58
|
+
<li><strong>sort</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'name'</span></code> retrieves a list of elements sorted
|
|
59
|
+
alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
|
|
60
|
+
sorted by their creation date in descending order.</li>
|
|
61
|
+
<li><strong>q</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">q</span></code> is for query. Use this parameter to return only the items
|
|
62
|
+
that match your search query.</li>
|
|
63
|
+
<li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Returns only the parameters requested.
|
|
64
|
+
(i.e. fields: ‘id, name, description, hardware.ram’)</li>
|
|
65
|
+
</ul>
|
|
66
|
+
</td>
|
|
67
|
+
</tr>
|
|
68
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
69
|
+
</td>
|
|
70
|
+
</tr>
|
|
71
|
+
</tbody>
|
|
72
|
+
</table>
|
|
73
|
+
</dd></dl>
|
|
74
|
+
|
|
75
|
+
<dl class="method">
|
|
76
|
+
<dt id="create">
|
|
77
|
+
<code class="descname">create</code><span class="sig-paren">(</span><em>name: nil</em>, <em>description: nil</em>, <em>password: nil</em>, <em>email: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#create" title="Permalink to this definition">¶</a></dt>
|
|
78
|
+
<dd><p>Create a new user account.</p>
|
|
79
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
80
|
+
<col class="field-name" />
|
|
81
|
+
<col class="field-body" />
|
|
82
|
+
<tbody valign="top">
|
|
83
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
84
|
+
<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – user name.</li>
|
|
85
|
+
<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – user description.</li>
|
|
86
|
+
<li><strong>password</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – user password.</li>
|
|
87
|
+
<li><strong>email</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – user email.</li>
|
|
88
|
+
</ul>
|
|
89
|
+
</td>
|
|
90
|
+
</tr>
|
|
91
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
92
|
+
</td>
|
|
93
|
+
</tr>
|
|
94
|
+
</tbody>
|
|
95
|
+
</table>
|
|
96
|
+
</dd></dl>
|
|
97
|
+
|
|
98
|
+
<dl class="method">
|
|
99
|
+
<dt id="get">
|
|
100
|
+
<code class="descname">get</code><span class="sig-paren">(</span><em>user_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
|
|
101
|
+
<dd><p>Returns a user account’s current specs.</p>
|
|
102
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
103
|
+
<col class="field-name" />
|
|
104
|
+
<col class="field-body" />
|
|
105
|
+
<tbody valign="top">
|
|
106
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
107
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
108
|
+
</ul>
|
|
109
|
+
</td>
|
|
110
|
+
</tr>
|
|
111
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
112
|
+
</td>
|
|
113
|
+
</tr>
|
|
114
|
+
</tbody>
|
|
115
|
+
</table>
|
|
116
|
+
</dd></dl>
|
|
117
|
+
|
|
118
|
+
<dl class="method">
|
|
119
|
+
<dt id="modify">
|
|
120
|
+
<code class="descname">modify</code><span class="sig-paren">(</span><em>user_id: @id</em>, <em>description: nil</em>, <em>password: nil</em>, <em>email: nil</em>, <em>state: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify" title="Permalink to this definition">¶</a></dt>
|
|
121
|
+
<dd><p>Modify a user account.</p>
|
|
122
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
123
|
+
<col class="field-name" />
|
|
124
|
+
<col class="field-body" />
|
|
125
|
+
<tbody valign="top">
|
|
126
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
127
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
128
|
+
<li><strong>password</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – user password.</li>
|
|
129
|
+
<li><strong>email</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – user email.</li>
|
|
130
|
+
<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – user description.</li>
|
|
131
|
+
<li><strong>state</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – allows you to enable and disable users. Possible values are <code class="docutils literal"><span class="pre">"ACTIVE"</span></code> or <code class="docutils literal"><span class="pre">"DISABLE"</span></code>.</li>
|
|
132
|
+
</ul>
|
|
133
|
+
</td>
|
|
134
|
+
</tr>
|
|
135
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
136
|
+
</td>
|
|
137
|
+
</tr>
|
|
138
|
+
</tbody>
|
|
139
|
+
</table>
|
|
140
|
+
</dd></dl>
|
|
141
|
+
|
|
142
|
+
<dl class="method">
|
|
143
|
+
<dt id="delete">
|
|
144
|
+
<code class="descname">delete</code><span class="sig-paren">(</span><em>user_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#delete" title="Permalink to this definition">¶</a></dt>
|
|
145
|
+
<dd><p>Delete a user account.</p>
|
|
146
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
147
|
+
<col class="field-name" />
|
|
148
|
+
<col class="field-body" />
|
|
149
|
+
<tbody valign="top">
|
|
150
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
151
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
152
|
+
</ul>
|
|
153
|
+
</td>
|
|
154
|
+
</tr>
|
|
155
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
156
|
+
</td>
|
|
157
|
+
</tr>
|
|
158
|
+
</tbody>
|
|
159
|
+
</table>
|
|
160
|
+
</dd></dl>
|
|
161
|
+
|
|
162
|
+
<dl class="method">
|
|
163
|
+
<dt id="api">
|
|
164
|
+
<code class="descname">api</code><span class="sig-paren">(</span><em>user_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#api" title="Permalink to this definition">¶</a></dt>
|
|
165
|
+
<dd><p>Return a user’s API access credentials.</p>
|
|
166
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
167
|
+
<col class="field-name" />
|
|
168
|
+
<col class="field-body" />
|
|
169
|
+
<tbody valign="top">
|
|
170
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
171
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
172
|
+
</ul>
|
|
173
|
+
</td>
|
|
174
|
+
</tr>
|
|
175
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
176
|
+
</td>
|
|
177
|
+
</tr>
|
|
178
|
+
</tbody>
|
|
179
|
+
</table>
|
|
180
|
+
</dd></dl>
|
|
181
|
+
|
|
182
|
+
<dl class="method">
|
|
183
|
+
<dt id="enable_api">
|
|
184
|
+
<code class="descname">enable_api</code><span class="sig-paren">(</span><em>user_id: @id</em>, <em>active: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#enable_api" title="Permalink to this definition">¶</a></dt>
|
|
185
|
+
<dd><p>Enable or disable a user’s API access.</p>
|
|
186
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
187
|
+
<col class="field-name" />
|
|
188
|
+
<col class="field-body" />
|
|
189
|
+
<tbody valign="top">
|
|
190
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
191
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
192
|
+
<li><strong>active</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) – API access.</li>
|
|
193
|
+
</ul>
|
|
194
|
+
</td>
|
|
195
|
+
</tr>
|
|
196
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
197
|
+
</td>
|
|
198
|
+
</tr>
|
|
199
|
+
</tbody>
|
|
200
|
+
</table>
|
|
201
|
+
</dd></dl>
|
|
202
|
+
|
|
203
|
+
<dl class="method">
|
|
204
|
+
<dt id="api_key">
|
|
205
|
+
<code class="descname">api_key</code><span class="sig-paren">(</span><em>user_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#api_key" title="Permalink to this definition">¶</a></dt>
|
|
206
|
+
<dd><p>Return a user’s API key.</p>
|
|
207
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
208
|
+
<col class="field-name" />
|
|
209
|
+
<col class="field-body" />
|
|
210
|
+
<tbody valign="top">
|
|
211
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
212
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
213
|
+
</ul>
|
|
214
|
+
</td>
|
|
215
|
+
</tr>
|
|
216
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
217
|
+
</td>
|
|
218
|
+
</tr>
|
|
219
|
+
</tbody>
|
|
220
|
+
</table>
|
|
221
|
+
</dd></dl>
|
|
222
|
+
|
|
223
|
+
<dl class="method">
|
|
224
|
+
<dt id="change_key">
|
|
225
|
+
<code class="descname">change_key</code><span class="sig-paren">(</span><em>user_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#change_key" title="Permalink to this definition">¶</a></dt>
|
|
226
|
+
<dd><p>Change a user’s API key.</p>
|
|
227
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
228
|
+
<col class="field-name" />
|
|
229
|
+
<col class="field-body" />
|
|
230
|
+
<tbody valign="top">
|
|
231
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
232
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
233
|
+
</ul>
|
|
234
|
+
</td>
|
|
235
|
+
</tr>
|
|
236
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
237
|
+
</td>
|
|
238
|
+
</tr>
|
|
239
|
+
</tbody>
|
|
240
|
+
</table>
|
|
241
|
+
</dd></dl>
|
|
242
|
+
|
|
243
|
+
<dl class="method">
|
|
244
|
+
<dt id="ips">
|
|
245
|
+
<code class="descname">ips</code><span class="sig-paren">(</span><em>user_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#ips" title="Permalink to this definition">¶</a></dt>
|
|
246
|
+
<dd><p>List the IP’s from which a user can access the API.</p>
|
|
247
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
248
|
+
<col class="field-name" />
|
|
249
|
+
<col class="field-body" />
|
|
250
|
+
<tbody valign="top">
|
|
251
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
252
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
253
|
+
</ul>
|
|
254
|
+
</td>
|
|
255
|
+
</tr>
|
|
256
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
257
|
+
</td>
|
|
258
|
+
</tr>
|
|
259
|
+
</tbody>
|
|
260
|
+
</table>
|
|
261
|
+
</dd></dl>
|
|
262
|
+
|
|
263
|
+
<dl class="method">
|
|
264
|
+
<dt id="add_ips">
|
|
265
|
+
<code class="descname">add_ips</code><span class="sig-paren">(</span><em>user_id: @id</em>, <em>ips: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_ips" title="Permalink to this definition">¶</a></dt>
|
|
266
|
+
<dd><p>Add IP’s from which a user can access the API.</p>
|
|
267
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
268
|
+
<col class="field-name" />
|
|
269
|
+
<col class="field-body" />
|
|
270
|
+
<tbody valign="top">
|
|
271
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
272
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
273
|
+
<li><strong>ips</strong> (<code class="docutils literal"><span class="pre">array</span></code>) – an array containing at least one IP string.</li>
|
|
274
|
+
</ul>
|
|
275
|
+
</td>
|
|
276
|
+
</tr>
|
|
277
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
278
|
+
</td>
|
|
279
|
+
</tr>
|
|
280
|
+
</tbody>
|
|
281
|
+
</table>
|
|
282
|
+
</dd></dl>
|
|
283
|
+
|
|
284
|
+
<dl class="method">
|
|
285
|
+
<dt id="remove_ip">
|
|
286
|
+
<code class="descname">remove_ip</code><span class="sig-paren">(</span><em>user_id: @id</em>, <em>ip: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_ip" title="Permalink to this definition">¶</a></dt>
|
|
287
|
+
<dd><p>Remove API access for an IP.</p>
|
|
288
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
289
|
+
<col class="field-name" />
|
|
290
|
+
<col class="field-body" />
|
|
291
|
+
<tbody valign="top">
|
|
292
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
293
|
+
<li><strong>user_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the user.</li>
|
|
294
|
+
<li><strong>ip</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – IP to be removed.</li>
|
|
295
|
+
</ul>
|
|
296
|
+
</td>
|
|
297
|
+
</tr>
|
|
298
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
299
|
+
</td>
|
|
300
|
+
</tr>
|
|
301
|
+
</tbody>
|
|
302
|
+
</table>
|
|
303
|
+
</dd></dl>
|
|
304
|
+
|
|
305
|
+
</dd></dl>
|
|
306
|
+
|
|
307
|
+
</div>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</div>
|
|
311
|
+
</div>
|
|
312
|
+
</div>
|
|
313
|
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
314
|
+
<div class="sphinxsidebarwrapper"><div class="relations">
|
|
315
|
+
<h3>Related Topics</h3>
|
|
316
|
+
<ul>
|
|
317
|
+
<li><a href="index.html">Documentation overview</a><ul>
|
|
318
|
+
<li>Previous: <a href="logs.html" title="previous chapter">Logs</a></li>
|
|
319
|
+
<li>Next: <a href="usages.html" title="next chapter">Usages</a></li>
|
|
320
|
+
</ul></li>
|
|
321
|
+
</ul>
|
|
322
|
+
</div>
|
|
323
|
+
<div role="note" aria-label="source link">
|
|
324
|
+
<h3>This Page</h3>
|
|
325
|
+
<ul class="this-page-menu">
|
|
326
|
+
<li><a href="_sources/users.txt"
|
|
327
|
+
rel="nofollow">Show Source</a></li>
|
|
328
|
+
</ul>
|
|
329
|
+
</div>
|
|
330
|
+
<div id="searchbox" style="display: none" role="search">
|
|
331
|
+
<h3>Quick search</h3>
|
|
332
|
+
<form class="search" action="search.html" method="get">
|
|
333
|
+
<input type="text" name="q" />
|
|
334
|
+
<input type="submit" value="Go" />
|
|
335
|
+
<input type="hidden" name="check_keywords" value="yes" />
|
|
336
|
+
<input type="hidden" name="area" value="default" />
|
|
337
|
+
</form>
|
|
338
|
+
<p class="searchtip" style="font-size: 90%">
|
|
339
|
+
Enter search terms or a module, class or function name.
|
|
340
|
+
</p>
|
|
341
|
+
</div>
|
|
342
|
+
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
343
|
+
</div>
|
|
344
|
+
</div>
|
|
345
|
+
<div class="clearer"></div>
|
|
346
|
+
</div>
|
|
347
|
+
<div class="footer">
|
|
348
|
+
©2016, StackPointCloud, Inc..
|
|
349
|
+
|
|
350
|
+
|
|
|
351
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
|
|
352
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
|
353
|
+
|
|
354
|
+
|
|
|
355
|
+
<a href="_sources/users.txt"
|
|
356
|
+
rel="nofollow">Page source</a>
|
|
357
|
+
</div>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
</body>
|
|
363
|
+
</html>
|
data/sphinx/conf.py
ADDED
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
#
|
|
3
|
+
# 1and1 Ruby SDK documentation build configuration file, created by
|
|
4
|
+
# sphinx-quickstart on Mon Jan 11 20:28:22 2016.
|
|
5
|
+
#
|
|
6
|
+
# This file is execfile()d with the current directory set to its
|
|
7
|
+
# containing dir.
|
|
8
|
+
#
|
|
9
|
+
# Note that not all possible configuration values are present in this
|
|
10
|
+
# autogenerated file.
|
|
11
|
+
#
|
|
12
|
+
# All configuration values have a default; values that are commented out
|
|
13
|
+
# serve to show the default.
|
|
14
|
+
|
|
15
|
+
import sys
|
|
16
|
+
import os
|
|
17
|
+
import shlex
|
|
18
|
+
|
|
19
|
+
# If extensions (or modules to document with autodoc) are in another directory,
|
|
20
|
+
# add these directories to sys.path here. If the directory is relative to the
|
|
21
|
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
22
|
+
#sys.path.insert(0, os.path.abspath('.'))
|
|
23
|
+
sys.path.append(os.path.abspath('/Users/tyler-macbook/.virtualenvs/practice/lib/python2.7/site-packages/sphinxcontrib_rubydomain-0.1dev_20100804-py2.7.egg/sphinxcontrib/'))
|
|
24
|
+
|
|
25
|
+
# -- General configuration ------------------------------------------------
|
|
26
|
+
|
|
27
|
+
# If your documentation needs a minimal Sphinx version, state it here.
|
|
28
|
+
#needs_sphinx = '1.0'
|
|
29
|
+
|
|
30
|
+
# Add any Sphinx extension module names here, as strings. They can be
|
|
31
|
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
32
|
+
# ones.
|
|
33
|
+
extensions = [
|
|
34
|
+
'rubydomain',
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
# Add any paths that contain templates here, relative to this directory.
|
|
38
|
+
templates_path = ['_templates']
|
|
39
|
+
|
|
40
|
+
# The suffix(es) of source filenames.
|
|
41
|
+
# You can specify multiple suffix as a list of string:
|
|
42
|
+
# source_suffix = ['.rst', '.md']
|
|
43
|
+
source_suffix = '.rst'
|
|
44
|
+
|
|
45
|
+
# The encoding of source files.
|
|
46
|
+
#source_encoding = 'utf-8-sig'
|
|
47
|
+
|
|
48
|
+
# The master toctree document.
|
|
49
|
+
master_doc = 'index'
|
|
50
|
+
|
|
51
|
+
# General information about the project.
|
|
52
|
+
project = u'1and1 Ruby SDK'
|
|
53
|
+
copyright = u'2016, StackPointCloud, Inc.'
|
|
54
|
+
author = u'StackPointCloud, Inc.'
|
|
55
|
+
|
|
56
|
+
# The version info for the project you're documenting, acts as replacement for
|
|
57
|
+
# |version| and |release|, also used in various other places throughout the
|
|
58
|
+
# built documents.
|
|
59
|
+
#
|
|
60
|
+
# The short X.Y version.
|
|
61
|
+
version = u'1.0'
|
|
62
|
+
# The full version, including alpha/beta/rc tags.
|
|
63
|
+
release = u'1.0'
|
|
64
|
+
|
|
65
|
+
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
66
|
+
# for a list of supported languages.
|
|
67
|
+
#
|
|
68
|
+
# This is also used if you do content translation via gettext catalogs.
|
|
69
|
+
# Usually you set "language" from the command line for these cases.
|
|
70
|
+
language = None
|
|
71
|
+
|
|
72
|
+
# There are two options for replacing |today|: either, you set today to some
|
|
73
|
+
# non-false value, then it is used:
|
|
74
|
+
#today = ''
|
|
75
|
+
# Else, today_fmt is used as the format for a strftime call.
|
|
76
|
+
#today_fmt = '%B %d, %Y'
|
|
77
|
+
|
|
78
|
+
# List of patterns, relative to source directory, that match files and
|
|
79
|
+
# directories to ignore when looking for source files.
|
|
80
|
+
exclude_patterns = ['_build']
|
|
81
|
+
|
|
82
|
+
# The reST default role (used for this markup: `text`) to use for all
|
|
83
|
+
# documents.
|
|
84
|
+
#default_role = None
|
|
85
|
+
|
|
86
|
+
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
87
|
+
#add_function_parentheses = True
|
|
88
|
+
|
|
89
|
+
# If true, the current module name will be prepended to all description
|
|
90
|
+
# unit titles (such as .. function::).
|
|
91
|
+
#add_module_names = True
|
|
92
|
+
|
|
93
|
+
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
94
|
+
# output. They are ignored by default.
|
|
95
|
+
#show_authors = False
|
|
96
|
+
|
|
97
|
+
# The name of the Pygments (syntax highlighting) style to use.
|
|
98
|
+
pygments_style = 'sphinx'
|
|
99
|
+
|
|
100
|
+
# A list of ignored prefixes for module index sorting.
|
|
101
|
+
#modindex_common_prefix = []
|
|
102
|
+
|
|
103
|
+
# If true, keep warnings as "system message" paragraphs in the built documents.
|
|
104
|
+
#keep_warnings = False
|
|
105
|
+
|
|
106
|
+
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
107
|
+
todo_include_todos = False
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
# -- Options for HTML output ----------------------------------------------
|
|
111
|
+
|
|
112
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
113
|
+
# a list of builtin themes.
|
|
114
|
+
html_theme = 'alabaster'
|
|
115
|
+
|
|
116
|
+
# Theme options are theme-specific and customize the look and feel of a theme
|
|
117
|
+
# further. For a list of options available for each theme, see the
|
|
118
|
+
# documentation.
|
|
119
|
+
#html_theme_options = {}
|
|
120
|
+
|
|
121
|
+
# Add any paths that contain custom themes here, relative to this directory.
|
|
122
|
+
#html_theme_path = []
|
|
123
|
+
|
|
124
|
+
# The name for this set of Sphinx documents. If None, it defaults to
|
|
125
|
+
# "<project> v<release> documentation".
|
|
126
|
+
#html_title = None
|
|
127
|
+
|
|
128
|
+
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
129
|
+
#html_short_title = None
|
|
130
|
+
|
|
131
|
+
# The name of an image file (relative to this directory) to place at the top
|
|
132
|
+
# of the sidebar.
|
|
133
|
+
#html_logo = None
|
|
134
|
+
|
|
135
|
+
# The name of an image file (within the static path) to use as favicon of the
|
|
136
|
+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
137
|
+
# pixels large.
|
|
138
|
+
#html_favicon = None
|
|
139
|
+
|
|
140
|
+
# Add any paths that contain custom static files (such as style sheets) here,
|
|
141
|
+
# relative to this directory. They are copied after the builtin static files,
|
|
142
|
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
143
|
+
html_static_path = ['_static']
|
|
144
|
+
|
|
145
|
+
# Add any extra paths that contain custom files (such as robots.txt or
|
|
146
|
+
# .htaccess) here, relative to this directory. These files are copied
|
|
147
|
+
# directly to the root of the documentation.
|
|
148
|
+
#html_extra_path = []
|
|
149
|
+
|
|
150
|
+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
151
|
+
# using the given strftime format.
|
|
152
|
+
#html_last_updated_fmt = '%b %d, %Y'
|
|
153
|
+
|
|
154
|
+
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
155
|
+
# typographically correct entities.
|
|
156
|
+
#html_use_smartypants = True
|
|
157
|
+
|
|
158
|
+
# Custom sidebar templates, maps document names to template names.
|
|
159
|
+
#html_sidebars = {}
|
|
160
|
+
|
|
161
|
+
# Additional templates that should be rendered to pages, maps page names to
|
|
162
|
+
# template names.
|
|
163
|
+
#html_additional_pages = {}
|
|
164
|
+
|
|
165
|
+
# If false, no module index is generated.
|
|
166
|
+
#html_domain_indices = True
|
|
167
|
+
|
|
168
|
+
# If false, no index is generated.
|
|
169
|
+
#html_use_index = True
|
|
170
|
+
|
|
171
|
+
# If true, the index is split into individual pages for each letter.
|
|
172
|
+
#html_split_index = False
|
|
173
|
+
|
|
174
|
+
# If true, links to the reST sources are added to the pages.
|
|
175
|
+
#html_show_sourcelink = True
|
|
176
|
+
|
|
177
|
+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
178
|
+
#html_show_sphinx = True
|
|
179
|
+
|
|
180
|
+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|
181
|
+
#html_show_copyright = True
|
|
182
|
+
|
|
183
|
+
# If true, an OpenSearch description file will be output, and all pages will
|
|
184
|
+
# contain a <link> tag referring to it. The value of this option must be the
|
|
185
|
+
# base URL from which the finished HTML is served.
|
|
186
|
+
#html_use_opensearch = ''
|
|
187
|
+
|
|
188
|
+
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
|
189
|
+
#html_file_suffix = None
|
|
190
|
+
|
|
191
|
+
# Language to be used for generating the HTML full-text search index.
|
|
192
|
+
# Sphinx supports the following languages:
|
|
193
|
+
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
|
194
|
+
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
|
195
|
+
#html_search_language = 'en'
|
|
196
|
+
|
|
197
|
+
# A dictionary with options for the search language support, empty by default.
|
|
198
|
+
# Now only 'ja' uses this config value
|
|
199
|
+
#html_search_options = {'type': 'default'}
|
|
200
|
+
|
|
201
|
+
# The name of a javascript file (relative to the configuration directory) that
|
|
202
|
+
# implements a search results scorer. If empty, the default will be used.
|
|
203
|
+
#html_search_scorer = 'scorer.js'
|
|
204
|
+
|
|
205
|
+
# Output file base name for HTML help builder.
|
|
206
|
+
htmlhelp_basename = '1and1RubySDKdoc'
|
|
207
|
+
|
|
208
|
+
# -- Options for LaTeX output ---------------------------------------------
|
|
209
|
+
|
|
210
|
+
latex_elements = {
|
|
211
|
+
# The paper size ('letterpaper' or 'a4paper').
|
|
212
|
+
#'papersize': 'letterpaper',
|
|
213
|
+
|
|
214
|
+
# The font size ('10pt', '11pt' or '12pt').
|
|
215
|
+
#'pointsize': '10pt',
|
|
216
|
+
|
|
217
|
+
# Additional stuff for the LaTeX preamble.
|
|
218
|
+
#'preamble': '',
|
|
219
|
+
|
|
220
|
+
# Latex figure (float) alignment
|
|
221
|
+
#'figure_align': 'htbp',
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
# Grouping the document tree into LaTeX files. List of tuples
|
|
225
|
+
# (source start file, target name, title,
|
|
226
|
+
# author, documentclass [howto, manual, or own class]).
|
|
227
|
+
latex_documents = [
|
|
228
|
+
(master_doc, '1and1RubySDK.tex', u'1and1 Ruby SDK Documentation',
|
|
229
|
+
u'StackPointCloud, Inc.', 'manual'),
|
|
230
|
+
]
|
|
231
|
+
|
|
232
|
+
# The name of an image file (relative to this directory) to place at the top of
|
|
233
|
+
# the title page.
|
|
234
|
+
#latex_logo = None
|
|
235
|
+
|
|
236
|
+
# For "manual" documents, if this is true, then toplevel headings are parts,
|
|
237
|
+
# not chapters.
|
|
238
|
+
#latex_use_parts = False
|
|
239
|
+
|
|
240
|
+
# If true, show page references after internal links.
|
|
241
|
+
#latex_show_pagerefs = False
|
|
242
|
+
|
|
243
|
+
# If true, show URL addresses after external links.
|
|
244
|
+
#latex_show_urls = False
|
|
245
|
+
|
|
246
|
+
# Documents to append as an appendix to all manuals.
|
|
247
|
+
#latex_appendices = []
|
|
248
|
+
|
|
249
|
+
# If false, no module index is generated.
|
|
250
|
+
#latex_domain_indices = True
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
# -- Options for manual page output ---------------------------------------
|
|
254
|
+
|
|
255
|
+
# One entry per manual page. List of tuples
|
|
256
|
+
# (source start file, name, description, authors, manual section).
|
|
257
|
+
man_pages = [
|
|
258
|
+
(master_doc, '1and1rubysdk', u'1and1 Ruby SDK Documentation',
|
|
259
|
+
[author], 1)
|
|
260
|
+
]
|
|
261
|
+
|
|
262
|
+
# If true, show URL addresses after external links.
|
|
263
|
+
#man_show_urls = False
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
# -- Options for Texinfo output -------------------------------------------
|
|
267
|
+
|
|
268
|
+
# Grouping the document tree into Texinfo files. List of tuples
|
|
269
|
+
# (source start file, target name, title, author,
|
|
270
|
+
# dir menu entry, description, category)
|
|
271
|
+
texinfo_documents = [
|
|
272
|
+
(master_doc, '1and1RubySDK', u'1and1 Ruby SDK Documentation',
|
|
273
|
+
author, '1and1RubySDK', 'One line description of project.',
|
|
274
|
+
'Miscellaneous'),
|
|
275
|
+
]
|
|
276
|
+
|
|
277
|
+
# Documents to append as an appendix to all manuals.
|
|
278
|
+
#texinfo_appendices = []
|
|
279
|
+
|
|
280
|
+
# If false, no module index is generated.
|
|
281
|
+
#texinfo_domain_indices = True
|
|
282
|
+
|
|
283
|
+
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
|
284
|
+
#texinfo_show_urls = 'footnote'
|
|
285
|
+
|
|
286
|
+
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
|
287
|
+
#texinfo_no_detailmenu = False
|