Skip to content

Commit fac7792

Browse files
birdofpreyrubirdofpreyru
committed
Markup of services documentation
1 parent c64791b commit fac7792

22 files changed

+1326
-152
lines changed

‎docs/index.md

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,64 @@ actions and reducer; thus, this module.</p>
6262
<dd><p>This module provides a service for conventient access to Topcoder APIs.</p>
6363
</dd>
6464
<dt>
65-
<a href="services/challenges.md">services/challenges</a></dt>
66-
<dd><p>This module provides a service for convenient manipulation with Topcoder
67-
challenges via TC API.</p>
65+
<a href="services.billing.md">services.billing</a></dt>
66+
<dd><p>Access to Topcoder billing accounts.</p>
67+
</dd>
68+
<dt>
69+
<a href="services.challenges.md">services.challenges</a></dt>
70+
<dd><p>This module provides a service for convenient manipulation with
71+
Topcoder challenges via TC API.</p>
72+
</dd>
73+
<dt>
74+
<a href="services.communities.md">services.communities</a></dt>
75+
<dd><p>Communities service.</p>
76+
</dd>
77+
<dt>
78+
<a href="services.direct.md">services.direct</a></dt>
79+
<dd><p>The Direct service takes care about communication with Direct APIs:
80+
projects, billing accounts, copilots, all these stuff should be added here,
81+
at least for now.</p>
82+
</dd>
83+
<dt>
84+
<a href="services.groups.md">services.groups</a></dt>
85+
<dd><p>Service for communication with group-related part of Topcoder API.</p>
86+
<p>NOTE: Through this file, and in related contexts, by loading a user group,
87+
or user groups data, we refer to loading the information about descendant
88+
user groups; i.e. given some user group(s) we speak about loading the sub-
89+
three of related child groups.</p>
90+
<p>By group maps we refer to the object having group IDs as the keys, and
91+
group data objects as the values. Any group object included into a group map
92+
has its &quot;subGroups&quot; array (if present) replaced by &quot;subGroupIds&quot;, that lists
93+
only the IDs of immediate child groups; actual child group objects from
94+
&quot;subGroups&quot; are recursively added to the top level of the group map.
95+
Also each group in the group map is timestamped to keep caching of
96+
the loaded data.</p>
97+
</dd>
98+
<dt>
99+
<a href="services.members.md">services.members</a></dt>
100+
<dd><p>This module provides a service for searching for Topcoder
101+
members via API V3.</p>
102+
</dd>
103+
<dt>
104+
<a href="services.reviewOpportunities.md">services.reviewOpportunities</a></dt>
105+
<dd><p>This module provides a service for retrieving Review Opportunities and
106+
submitting applications.</p>
107+
</dd>
108+
<dt>
109+
<a href="services.terms.md">services.terms</a></dt>
110+
<dd><p>This module provides a service for convenient manipulation with
111+
Topcoder challenges&#39; terms via TC API.</p>
112+
</dd>
113+
<dt>
114+
<a href="services.user-settings.md">services.user-settings</a></dt>
115+
<dd><p>User Settings service. Corresponding part of the backend is
116+
implemented as a separate Heroku App, which is set up only for prod.
117+
Currently, we use it to save user-defined filters in the challenge search.</p>
118+
</dd>
119+
<dt>
120+
<a href="services.user.md">services.user</a></dt>
121+
<dd><p>The User service provides functionality related to Topcoder user
122+
accounts.</p>
68123
</dd>
69124
</dl>
70125

‎docs/services.billing.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<a name="module_services.billing"></a>
2+
3+
## services.billing
4+
Access to Topcoder billing accounts.
5+
6+
7+
* [services.billing](#module_services.billing)
8+
* _static_
9+
* [.default](#module_services.billing.default)
10+
* [.getService(tokenV3)](#module_services.billing.getService) ⇒ <code>Billing</code>
11+
* _inner_
12+
* [~Billing](#module_services.billing..Billing)
13+
* [new Billing(tokenV3)](#new_module_services.billing..Billing_new)
14+
* [.getUserBillingAccounts()](#module_services.billing..Billing+getUserBillingAccounts) ⇒ <code>Promise</code>
15+
16+
<a name="module_services.billing.default"></a>
17+
18+
### services.billing.default
19+
Default module export is
20+
[Billing](#module_services.billing..Billing) class.
21+
22+
**Kind**: static property of [<code>services.billing</code>](#module_services.billing)
23+
<a name="module_services.billing.getService"></a>
24+
25+
### services.billing.getService(tokenV3) ⇒ <code>Billing</code>
26+
Returns a new or existing Billing service for the user specified by token.
27+
28+
**Kind**: static method of [<code>services.billing</code>](#module_services.billing)
29+
**Returns**: <code>Billing</code> - Billing service instance.
30+
31+
| Param | Type | Description |
32+
| --- | --- | --- |
33+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
34+
35+
<a name="module_services.billing..Billing"></a>
36+
37+
### services.billing~Billing
38+
Billing service object.
39+
40+
**Kind**: inner class of [<code>services.billing</code>](#module_services.billing)
41+
42+
* [~Billing](#module_services.billing..Billing)
43+
* [new Billing(tokenV3)](#new_module_services.billing..Billing_new)
44+
* [.getUserBillingAccounts()](#module_services.billing..Billing+getUserBillingAccounts) ⇒ <code>Promise</code>
45+
46+
<a name="new_module_services.billing..Billing_new"></a>
47+
48+
#### new Billing(tokenV3)
49+
Creates a new service.
50+
51+
52+
| Param | Type | Description |
53+
| --- | --- | --- |
54+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
55+
56+
<a name="module_services.billing..Billing+getUserBillingAccounts"></a>
57+
58+
#### billing.getUserBillingAccounts() ⇒ <code>Promise</code>
59+
Gets billing accounts accessible to service user.
60+
61+
**Kind**: instance method of [<code>Billing</code>](#module_services.billing..Billing)
62+
**Returns**: <code>Promise</code> - Resolves to the list of billing account objects.

0 commit comments

Comments
 (0)