Skip to content

Commit 70942b2

Browse files
author
Dustin McCraw
committed
Add Divisions endpoint
1 parent af753d3 commit 70942b2

19 files changed

+748
-44
lines changed

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# TeamSnap JavaScript SDK CHANGELOG
22

3+
### September 30, 2016 // Version 1.17.0
4+
- Add `divisions` endpoint.
5+
- Update validations on `broadcastEmail`.`saveBroadcastEmail`.
6+
- Add `bulkDeleteBroadcastEmails` method.
7+
- Add `searchDivisionMembers` method.
8+
- Add `searchDivisionTeams` method.
9+
10+
---
11+
312
### September 27, 2016 // Version 1.16.1
413
- Reloads `messages` and `messageData` in `markMessageAsRead` method in persistence wrapper.
514

‎docs/collections/broadcast_emails.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- [createBroadcastEmail](#createBroadcastEmail)
77
- [saveBroadcastEmail](#saveBroadcastEmail)
88
- [deleteBroadcastEmail](#deleteBroadcastEmail)
9+
- [bulkDeleteBroadcastEmails](#bulkDeleteBroadcastEmails)
910

1011

1112
---
@@ -115,3 +116,25 @@ teamsnap.saveBroadcastEmail(broadcastEmail).then(function(){
115116
});
116117
});
117118
```
119+
120+
121+
---
122+
123+
124+
<a id="bulkDeleteBroadcastEmails"></a>
125+
## `bulkDeleteBroadcastEmails(broadcastEmailIds, callback)`
126+
Bulk deletes a list of `broadcastEmail` item.
127+
128+
### Params
129+
* `broadcastEmailIds`: [array] - An array of broadcastEmailIds to be deleted.
130+
* `callback`: [function] - callback to be executed when the operation completes.
131+
132+
### Examples
133+
```javascript
134+
// ~~~~~
135+
// Deletes a broadcastEmail item.
136+
teamsnap.bulkDeleteBroadcastEmails([1,2,3])
137+
```
138+
139+
140+
---

‎docs/collections/divisions.md‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
# Divisions
2+
3+
## Methods
4+
5+
- [loadDivisions](#loadDivisions)
6+
- [loadDivision](#loadDivision)
7+
- [createDivision](#createDivision)
8+
- [deleteDivision](#deleteDivision)
9+
- [ancestorDivisions](#ancestorDivisions)
10+
- [descendantDivisions](#descendantDivisions)
11+
- [childrenDivisions](#childrenDivisions)
12+
13+
---
14+
<a id="loadDivisions"></a>
15+
## `loadDivisions(params, callback)`
16+
Loads items from the `divisions` collection based on given params.
17+
18+
### Params
19+
* `params`: [int, object] - can be either a `divisionId` or an object with query parameters.
20+
* `callback`: [function] - callback to be executed when the operation completes.
21+
22+
To see a list of all available search params you can run:
23+
`teamsnap.collections.divisions.queries.search.params`
24+
25+
### Examples
26+
```javascript
27+
// ~~~~~
28+
// Loads all divisions for `divisionId: 1`.
29+
teamsnap.loadDivisions(1);
30+
31+
// ~~~~~
32+
// Loads a division for `id: 1`.
33+
teamsnap.loadDivisions({id: 1});
34+
```
35+
36+
37+
---
38+
39+
40+
41+
<a id="loadDivision"></a>
42+
## `loadDivision(params, callback)`
43+
Loads a Singular `division` item based on given params.
44+
45+
### Params
46+
* `params`: [int] - this must be a `divisionId`
47+
* `callback`: [function] - callback to be executed when the operation completes.
48+
49+
To see a list of all available search params you can run:
50+
`teamsnap.collections.divisions.queries.search.params`
51+
52+
### Examples
53+
```javascript
54+
// ~~~~~
55+
// Loads a division for `id: 1`.
56+
teamsnap.loadDivision({id: 1});
57+
```
58+
59+
60+
---
61+
62+
63+
<a id="createDivision"></a>
64+
## `createDivision(data)`
65+
Creates a new `division` item.
66+
67+
### Params
68+
* `data`: [object, null] - data object to apply to the newly created object.
69+
70+
### Examples
71+
```javascript
72+
// ~~~~~
73+
// Creates a new division item.
74+
var division = teamsnap.createDivision();
75+
76+
// ~~~~~
77+
// Creates a new division item with `id: 1`.
78+
var division = teamsnap.createDivision({id: 1});
79+
```
80+
81+
82+
---
83+
84+
85+
<a id="saveDivision"></a>
86+
## `saveDivision(division, callback)`
87+
Saves a `division` item.
88+
89+
### Params
90+
* `division`: [object] - division item to be saved.
91+
* `callback`: [function] - callback to be executed when the operation completes.
92+
93+
### Examples
94+
```javascript
95+
// ~~~~~
96+
// Saves division item.
97+
teamsnap.saveDivision(division);
98+
99+
// ~~~~~
100+
// Creates a new division then saves it.
101+
var division = teamsnap.createDivision({
102+
id: 1,
103+
name: 'Example division'
104+
});
105+
106+
teamsnap.saveDivision(division);
107+
```
108+
109+
110+
---
111+
112+
113+
<a id="deleteDivision"></a>
114+
## `deleteDivision(division, callback)`
115+
Deletes a `division` item.
116+
117+
### Params
118+
* `division`: [object] - an item to be deleted.
119+
* `callback`: [function] - callback to be executed when the operation completes.
120+
121+
### Examples
122+
```javascript
123+
// ~~~~~
124+
// Deletes a division item.
125+
teamsnap.deleteDivision(division);
126+
127+
// ~~~~~
128+
// Creates a new division, saves, then deletes it.
129+
var division = teamsnap.createDivision({
130+
id: 1,
131+
name: 'Example division'
132+
});
133+
134+
teamsnap.saveDivision(division).then(function(){
135+
// Save complete, now delete.
136+
teamsnap.deleteDivision(division).then(function(){
137+
// Poof! It's gone!
138+
});
139+
});
140+
```
141+
142+
143+
---
144+
145+
146+
<a id="ancestorDivisions"></a>
147+
## `ancestorDivisions(divisionId, callback)`
148+
Returns the ancestor `division` items.
149+
150+
### Params
151+
* `divisionId`: [int] - an divisionId.
152+
* `callback`: [function] - callback to be executed when the operation completes.
153+
### Examples
154+
```javascript
155+
// ~~~~~
156+
// Returns the ancestor divisions.
157+
var divisions = teamsnap.ancestorDivisions(1);
158+
```
159+
160+
161+
---
162+
163+
164+
<a id="descendantDivisions"></a>
165+
## `descendantDivisions(divisionId, callback)`
166+
Returns the descendant `division` items.
167+
168+
### Params
169+
* `divisionId`: [int] - an divisionId.
170+
* `callback`: [function] - callback to be executed when the operation completes.
171+
### Examples
172+
```javascript
173+
// ~~~~~
174+
// Returns the ancestor divisions.
175+
var divisions = teamsnap.descendantDivisions(1);
176+
```
177+
178+
179+
---
180+
181+
182+
<a id="childrenDivisions"></a>
183+
## `childrenDivisions(divisionId, callback)`
184+
Returns the child `division` items.
185+
186+
### Params
187+
* `divisionId`: [int] - an divisionId.
188+
* `callback`: [function] - callback to be executed when the operation completes.
189+
### Examples
190+
```javascript
191+
// ~~~~~
192+
// Returns the ancestor divisions.
193+
var divisions = teamsnap.childrenDivisions(1);
194+
```
195+
196+
197+
---

‎docs/collections/members.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- [canEditItem](#canEditItem)
1717
- [importMembersFromTeam](#importMembersFromTeam)
1818
- [loadImportableMembers](#loadImportableMembers)
19+
- [divisionSearchMembers](#divisionSearchMembers)
1920

2021

2122
---
@@ -331,3 +332,24 @@ Creates a list of importable members by current member's userId.
331332
// Loads list of importable members by current member's userId
332333
teamsnap.loadImportableMembers(8, true);
333334
```
335+
336+
337+
---
338+
339+
340+
<a id="divisionSearchMembers"></a>
341+
## `divisionSearchMembers(params)`
342+
Search for members in a division.
343+
344+
### Params
345+
* `params`: [object] - params to search, must include `divisionId`
346+
347+
### Examples
348+
```javascript
349+
// ~~~~~
350+
// Return all the active members in a division
351+
teamsnap.divisionSearchMembers({divisionId: 1, isActive: true});
352+
```
353+
354+
355+
---

‎docs/collections/teams.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- [invite](#invite)
1212
- [updateTimeZone](#updateTimeZone)
1313
- [resetStatistics](#resetStatistics)
14+
- [divisionSearchTeams](#divisionSearchTeams)
1415

1516

1617
---
@@ -245,3 +246,25 @@ Resets a team's statistic data (statistics and statistic groups remain).
245246
// Update timezone to "Denver" / MST.
246247
teamsnap.resetStatistics(1);
247248
```
249+
250+
251+
---
252+
253+
254+
<a id="divisionSearchTeams"></a>
255+
## `divisionSearchTeams(params)`
256+
Search for teams in a division.
257+
258+
### Params
259+
* `params`: [object] - params to search, must include `divisionId`
260+
261+
### Examples
262+
```javascript
263+
// ~~~~~
264+
// Return all the active teams in a division
265+
teamsnap.divisionSearchTeams({divisionId: 1, isActive: true});
266+
```
267+
268+
269+
---
270+

0 commit comments

Comments
 (0)