pipedrive_ruby 1.0.1.pre15
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.
- checksums.yaml +7 -0
- data/.codeclimate.yml +30 -0
- data/.gitignore +12 -0
- data/.rspec +2 -0
- data/.rubocop.yml +1156 -0
- data/.travis.yml +8 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +4 -0
- data/Guardfile +56 -0
- data/LICENSE.txt +21 -0
- data/README.md +59 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/Activities.html +138 -0
- data/doc/ActivitiesFields.html +134 -0
- data/doc/ActivitiesTypes.html +141 -0
- data/doc/Authorizations.html +138 -0
- data/doc/Currencies.html +143 -0
- data/doc/DealsFields.html +146 -0
- data/doc/EmailMessages.html +137 -0
- data/doc/EmailThreads.html +136 -0
- data/doc/Estages.html +137 -0
- data/doc/Files.html +139 -0
- data/doc/Filters.html +139 -0
- data/doc/GlobalMessages.html +134 -0
- data/doc/Goals.html +137 -0
- data/doc/NoteFields.html +134 -0
- data/doc/Notes.html +137 -0
- data/doc/OrganizationFields.html +147 -0
- data/doc/OrganizationRelationships.html +135 -0
- data/doc/PermissionSets.html +134 -0
- data/doc/PersonFields.html +146 -0
- data/doc/Persons.html +136 -0
- data/doc/PipedriveRuby/Activities.html +159 -0
- data/doc/PipedriveRuby/ActivitiesFields.html +148 -0
- data/doc/PipedriveRuby/ActivitiesTypes.html +148 -0
- data/doc/PipedriveRuby/ActivityFields.html +148 -0
- data/doc/PipedriveRuby/ActivityTypes.html +148 -0
- data/doc/PipedriveRuby/Authorizations.html +231 -0
- data/doc/PipedriveRuby/Base.html +456 -0
- data/doc/PipedriveRuby/Currencies.html +162 -0
- data/doc/PipedriveRuby/DealFields.html +148 -0
- data/doc/PipedriveRuby/Deals.html +842 -0
- data/doc/PipedriveRuby/HttpFactory.html +1362 -0
- data/doc/PipedriveRuby/Organizations.html +148 -0
- data/doc/PipedriveRuby/PipedriveClient.html +385 -0
- data/doc/PipedriveRuby/Products.html +319 -0
- data/doc/PipedriveRuby/PushNotifications.html +159 -0
- data/doc/PipedriveRuby/Recents.html +159 -0
- data/doc/PipedriveRuby/SearchResults.html +250 -0
- data/doc/PipedriveRuby/UserConnections.html +159 -0
- data/doc/PipedriveRuby/UserSettings.html +159 -0
- data/doc/PipedriveRuby.html +174 -0
- data/doc/Pipelines.html +134 -0
- data/doc/ProductFields.html +147 -0
- data/doc/Products.html +140 -0
- data/doc/PushNotifications.html +141 -0
- data/doc/Recent.html +134 -0
- data/doc/Roles.html +134 -0
- data/doc/SearchResults.html +135 -0
- data/doc/UserConnections.html +134 -0
- data/doc/UserSettings.html +134 -0
- data/doc/Users.html +137 -0
- data/doc/_index.html +425 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +474 -0
- data/doc/file.README.html +160 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +160 -0
- data/doc/js/app.js +243 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +411 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/http_factory.rb +154 -0
- data/lib/pipedrive_client.rb +24 -0
- data/lib/pipedrive_ruby/version.rb +4 -0
- data/lib/pipedrive_ruby.rb +48 -0
- data/lib/resources/activities.rb +9 -0
- data/lib/resources/activitiy_fields.rb +6 -0
- data/lib/resources/activity_types.rb +11 -0
- data/lib/resources/authorizations.rb +16 -0
- data/lib/resources/base.rb +17 -0
- data/lib/resources/currencies.rb +13 -0
- data/lib/resources/deal_fields.rb +10 -0
- data/lib/resources/deals.rb +72 -0
- data/lib/resources/email_messages.rb +5 -0
- data/lib/resources/email_threads.rb +4 -0
- data/lib/resources/files.rb +4 -0
- data/lib/resources/filters.rb +4 -0
- data/lib/resources/global_messages.rb +3 -0
- data/lib/resources/goals.rb +4 -0
- data/lib/resources/note_fields.rb +3 -0
- data/lib/resources/notes.rb +4 -0
- data/lib/resources/organization_fields.rb +8 -0
- data/lib/resources/organization_relationships.rb +3 -0
- data/lib/resources/organizations.rb +7 -0
- data/lib/resources/permission_sets.rb +3 -0
- data/lib/resources/person_fields.rb +3 -0
- data/lib/resources/persons.rb +4 -0
- data/lib/resources/pipelines.rb +3 -0
- data/lib/resources/product_fields.rb +8 -0
- data/lib/resources/products.rb +29 -0
- data/lib/resources/push_notifications.rb +10 -0
- data/lib/resources/recents.rb +6 -0
- data/lib/resources/roles.rb +3 -0
- data/lib/resources/search_results.rb +14 -0
- data/lib/resources/stages.rb +4 -0
- data/lib/resources/user_connections.rb +7 -0
- data/lib/resources/user_settings.rb +6 -0
- data/lib/resources/users.rb +5 -0
- data/pipedrive_ruby.gemspec +34 -0
- metadata +286 -0
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: PipedriveRuby
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.0
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "PipedriveRuby";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (P)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">PipedriveRuby</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Module: PipedriveRuby
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<dl>
|
|
82
|
+
<dt>Defined in:</dt>
|
|
83
|
+
<dd>lib/pipedrive_ruby.rb<span class="defines">,<br />
|
|
84
|
+
lib/http_factory.rb,<br /> lib/resources/base.rb,<br /> lib/resources/deals.rb,<br /> lib/pipedrive_client.rb,<br /> lib/resources/recents.rb,<br /> lib/resources/products.rb,<br /> lib/resources/currencies.rb,<br /> lib/resources/activities.rb,<br /> lib/resources/deal_fields.rb,<br /> lib/pipedrive_ruby/version.rb,<br /> lib/resources/organizations.rb,<br /> lib/resources/user_settings.rb,<br /> lib/resources/authorizations.rb,<br /> lib/resources/activity_types.rb,<br /> lib/resources/search_results.rb,<br /> lib/resources/user_connections.rb,<br /> lib/resources/activitiy_fields.rb,<br /> lib/resources/push_notifications.rb</span>
|
|
85
|
+
</dd>
|
|
86
|
+
</dl>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
|
|
90
|
+
<h2>Overview</h2><div class="docstring">
|
|
91
|
+
<div class="discussion">
|
|
92
|
+
|
|
93
|
+
<p>Manage subscriptions of push notifications / web hooks / REST hooks about
|
|
94
|
+
data changes. A subscription means a designated HTTP(S) endpoint which will
|
|
95
|
+
receive a request every time a certain event happens on your Pipedrive
|
|
96
|
+
account. E.g. when you have subscribed to receive events about all new
|
|
97
|
+
deals ('deal.added'), this HTTP(S) will receive a request per each
|
|
98
|
+
such event. See <a
|
|
99
|
+
href="https://app.pipedrive.com/push_notifications#dialog:/push_notifications/help">app.pipedrive.com/push_notifications#dialog:/push_notifications/help</a>
|
|
100
|
+
for detailed documentation of web hooks.</p>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
</div>
|
|
105
|
+
<div class="tags">
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div><h2>Defined Under Namespace</h2>
|
|
109
|
+
<p class="children">
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="PipedriveRuby/Activities.html" title="PipedriveRuby::Activities (class)">Activities</a></span>, <span class='object_link'><a href="PipedriveRuby/ActivityFields.html" title="PipedriveRuby::ActivityFields (class)">ActivityFields</a></span>, <span class='object_link'><a href="PipedriveRuby/ActivityTypes.html" title="PipedriveRuby::ActivityTypes (class)">ActivityTypes</a></span>, <span class='object_link'><a href="PipedriveRuby/Authorizations.html" title="PipedriveRuby::Authorizations (class)">Authorizations</a></span>, <span class='object_link'><a href="PipedriveRuby/Base.html" title="PipedriveRuby::Base (class)">Base</a></span>, <span class='object_link'><a href="PipedriveRuby/Currencies.html" title="PipedriveRuby::Currencies (class)">Currencies</a></span>, <span class='object_link'><a href="PipedriveRuby/DealFields.html" title="PipedriveRuby::DealFields (class)">DealFields</a></span>, <span class='object_link'><a href="PipedriveRuby/Deals.html" title="PipedriveRuby::Deals (class)">Deals</a></span>, <span class='object_link'><a href="PipedriveRuby/HttpFactory.html" title="PipedriveRuby::HttpFactory (class)">HttpFactory</a></span>, <span class='object_link'><a href="PipedriveRuby/Organizations.html" title="PipedriveRuby::Organizations (class)">Organizations</a></span>, <span class='object_link'><a href="PipedriveRuby/PipedriveClient.html" title="PipedriveRuby::PipedriveClient (class)">PipedriveClient</a></span>, <span class='object_link'><a href="PipedriveRuby/Products.html" title="PipedriveRuby::Products (class)">Products</a></span>, <span class='object_link'><a href="PipedriveRuby/PushNotifications.html" title="PipedriveRuby::PushNotifications (class)">PushNotifications</a></span>, <span class='object_link'><a href="PipedriveRuby/Recents.html" title="PipedriveRuby::Recents (class)">Recents</a></span>, <span class='object_link'><a href="PipedriveRuby/SearchResults.html" title="PipedriveRuby::SearchResults (class)">SearchResults</a></span>, <span class='object_link'><a href="PipedriveRuby/UserConnections.html" title="PipedriveRuby::UserConnections (class)">UserConnections</a></span>, <span class='object_link'><a href="PipedriveRuby/UserSettings.html" title="PipedriveRuby::UserSettings (class)">UserSettings</a></span>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</p>
|
|
118
|
+
|
|
119
|
+
<h2>Constant Summary</h2>
|
|
120
|
+
<dl class="constants">
|
|
121
|
+
|
|
122
|
+
<dt id="API_URL-constant" class="">API_URL =
|
|
123
|
+
<div class="docstring">
|
|
124
|
+
<div class="discussion">
|
|
125
|
+
|
|
126
|
+
<p>this is the url for API V1</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tags">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</dt>
|
|
136
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.pipedrive.com/v1</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
137
|
+
|
|
138
|
+
<dt id="VERSION-constant" class="">VERSION =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<p>version of gem</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</dt>
|
|
152
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.0.1.pre11</span><span class='tstring_end'>"</span></span></pre></dd>
|
|
153
|
+
|
|
154
|
+
</dl>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</div>
|
|
165
|
+
|
|
166
|
+
<div id="footer">
|
|
167
|
+
Generated on Tue Jul 19 12:47:24 2016 by
|
|
168
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
169
|
+
0.9.0 (ruby-2.2.5).
|
|
170
|
+
</div>
|
|
171
|
+
|
|
172
|
+
</div>
|
|
173
|
+
</body>
|
|
174
|
+
</html>
|
data/doc/Pipelines.html
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Pipelines
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.0
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "Pipelines";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (P)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Pipelines</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Pipelines
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Pipelines</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/resources/pipelines.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>Pipelines are essentially ordered collections of Stages.</p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
<div id="footer">
|
|
127
|
+
Generated on Tue Jul 19 12:47:24 2016 by
|
|
128
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
129
|
+
0.9.0 (ruby-2.2.5).
|
|
130
|
+
</div>
|
|
131
|
+
|
|
132
|
+
</div>
|
|
133
|
+
</body>
|
|
134
|
+
</html>
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: ProductFields
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.0
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "ProductFields";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (P)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">ProductFields</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: ProductFields
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">ProductFields</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/resources/product_fields.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>ProductFields represent the near-complete schema for a Product in the
|
|
108
|
+
context of the company of the authorized user. Each company can have a
|
|
109
|
+
different schema for their Products, with various custom fields. In the
|
|
110
|
+
context of using ProductFields as a schema for defining the data fields of
|
|
111
|
+
a Product, it must be kept in mind that some types of custom fields can
|
|
112
|
+
have additional data fields which are not separate ProductFields per se.
|
|
113
|
+
Such is the case with monetary, daterange and timerange fields – each of
|
|
114
|
+
these fields will have one additional data field in addition to the one
|
|
115
|
+
presented in the context of ProductFields. For example, if there is a
|
|
116
|
+
monetary field with the key 'ffk9s9' stored on the account,
|
|
117
|
+
'ffk9s9' would hold the numeric value of the field, and
|
|
118
|
+
'ffk9s9_currency' would hold the ISO currency code that goes along
|
|
119
|
+
with the numeric value. To find out which data fields are available, fetch
|
|
120
|
+
one Product and list its keys.</p>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
</div>
|
|
125
|
+
<div class="tags">
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</div>
|
|
138
|
+
|
|
139
|
+
<div id="footer">
|
|
140
|
+
Generated on Tue Jul 19 12:47:24 2016 by
|
|
141
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
142
|
+
0.9.0 (ruby-2.2.5).
|
|
143
|
+
</div>
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</body>
|
|
147
|
+
</html>
|
data/doc/Products.html
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Products
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.0
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "Products";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (P)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Products</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Products
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Products</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/resources/products.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>Products are the goods or services you are dealing with. Each product can
|
|
108
|
+
have N different price points - first, each Product can have a price in N
|
|
109
|
+
different currencies, and secondly, each Product can have N variations of
|
|
110
|
+
itself, each having N prices different currencies. Note that only one price
|
|
111
|
+
per variation per currency is supported. Products can be instantiated to
|
|
112
|
+
Deals. In the context of instatiation, a custom price, quantity, duration
|
|
113
|
+
and discount can be applied.</p>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
<div class="tags">
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</div>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
</div>
|
|
131
|
+
|
|
132
|
+
<div id="footer">
|
|
133
|
+
Generated on Sat Jul 16 16:50:52 2016 by
|
|
134
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
135
|
+
0.9.0 (ruby-2.2.5).
|
|
136
|
+
</div>
|
|
137
|
+
|
|
138
|
+
</div>
|
|
139
|
+
</body>
|
|
140
|
+
</html>
|