Merge pull request #121 from teamsnap/import-from-team

Import from team

Author: amw3bb

CHANGELOG.md

@@ -1,5 +1,11 @@
 # TeamSnap JavaScript SDK CHANGELOG
 
+### March 7, 2016 // Version 1.12.0
+- Adds `importMembersFromTeam` method.
+- Adds `loadImportableMembers` method.
+
+---
+
 ### March 2, 2016 // Version 1.11.2
 - Adds error message to `memberPaymentTransaction` is `amount` is null.
 

docs/collections/members.md

@@ -14,6 +14,8 @@
 - [getMemberSort](#getMemberSort)
 - [canEditTeam](#canEditTeam)
 - [canEditItem](#canEditItem)
+- [importMembersFromTeam](#importMembersFromTeam)
+- [loadImportableMembers](#loadImportableMembers)
 
 
 ---
@@ -271,7 +273,7 @@ if(teamsnap.canEditTeam(member, team)){
 
 
 <a id="canEditItem"></a>
-## `canEditItem(meber, team, item)`
+## `canEditItem(member, team, item)`
 Returns true if a member has write permissions for a specific item on a team.
 
 ### Params
@@ -292,3 +294,40 @@ if(teamsnap.canEditItem(member, team, availability)){
   // Getouttahere.
 }
 ```
+
+
+---
+
+
+<a id="importMembersFromTeam"></a>
+## `importMembersFromTeam(memberIds, teamId)`
+Creates an import of members from a different team to a destination team.
+
+## Params
+* `memberIds`: [ids] - array of `memberIds` to be imported.
+* `teamId`: [id, object] - `teamId` or `team.id` of team to import members to.
+
+### Examples
+```javascript
+// ~~~~~
+// Imports members to destination team
+teamsnap.importMembersFromTeam([1, 2], 3);
+```
+
+---
+
+
+<a id="loadImportableMembers"></a>
+## `loadImportableMembers(userId, includeArchivedTeams)`
+Creates a list of importable members by current member's userId.
+
+## Params
+* `userId`: [id] - `userId` of current member.
+* `includeArchivedTeams`: [bool] - include or exclude members from archived teams (optional).
+
+### Examples
+```javascript
+// ~~~~~
+// Loads list of importable members by current member's userId
+teamsnap.loadImportableMembers(8, true);
+```

lib/teamsnap.js

@@ -1794,6 +1794,39 @@ exports.canEditItem = function(member, team, item) {
   }
 };
 
+exports.importMembersFromTeam = function(memberIds, teamId, callback) {
+  var params;
+  if (!memberIds) {
+    throw new TSArgsError('teamsnap.importMembersFromTeam', 'must include `memberIds`');
+  }
+  if (!this.isItem(teamId)) {
+    throw new TSArgsError('teamsnap.importMembersFromTeam', "must provide a teamId");
+  }
+  if (this.isItem(teamId)) {
+    teamId = teamId.id;
+  }
+  params = {
+    sourceMemberIds: memberIds,
+    destinationTeamId: teamId
+  };
+  return this.collections.members.exec('importFromTeam', params, callback);
+};
+
+exports.loadImportableMembers = function(userId, includeArchivedTeams, callback) {
+  var params;
+  if (!userId) {
+    throw new TSArgsError('teamsnap.loadImportableMembers', "must provide a userId");
+  }
+  if (typeof includeArchivedTeams === 'function') {
+    callback = includeArchivedTeams;
+  }
+  params = {
+    userId: userId,
+    includeArchivedTeams: includeArchivedTeams
+  };
+  return this.collections.members.queryItems('importableMembers', params, callback);
+};
+
 });
 
 require.register("collections/membersPreferences", function(exports, require, module) {
@@ -5847,7 +5880,7 @@ ref = require('./model'), Collection = ref.Collection, Item = ref.Item;
 require('./errors');
 
 TeamSnap = (function() {
-  TeamSnap.prototype.version = '1.11.2';
+  TeamSnap.prototype.version = '1.12.0';
 
   TeamSnap.prototype.promises = promises;
 

lib/teamsnap.min.js

@@ -1,6 +1,6 @@
 {
   "name": "teamsnap.js",
-  "version": "1.11.2",
+  "version": "1.12.0",
   "description": "A JavaScript library for using the TeamSnap API.",
   "author": "Jacob Wright with TeamSnap (http://www.teamsnap.com)",
   "homepage": "https://github.com/teamsnap/teamsnap-javascript-sdk",

package.json

@@ -145,3 +145,26 @@ exports.canEditItem = (member, team, item) ->
     item.href is member.href
   else
     item.links.member.href is member.href
+
+exports.importMembersFromTeam = (memberIds, teamId, callback) ->
+  unless memberIds
+    throw new TSArgsError 'teamsnap.importMembersFromTeam', 'must include
+    `memberIds`'
+  unless @isItem teamId
+    throw new TSArgsError 'teamsnap.importMembersFromTeam', "must provide
+     a teamId"
+  if @isItem teamId
+    teamId = teamId.id
+  params = sourceMemberIds: memberIds, destinationTeamId: teamId
+
+  @collections.members.exec 'importFromTeam', params, callback
+
+exports.loadImportableMembers = (userId, includeArchivedTeams, callback) ->
+  unless userId
+    throw new TSArgsError 'teamsnap.loadImportableMembers', "must provide
+     a userId"
+  if typeof includeArchivedTeams is 'function'
+    callback = includeArchivedTeams
+  params = userId: userId, includeArchivedTeams: includeArchivedTeams
+
+  @collections.members.queryItems 'importableMembers', params, callback

src/collections/members.coffee

@@ -3,7 +3,7 @@ promises = require './promises'
 require './errors'
 
 class TeamSnap
-  version: '1.11.2'
+  version: '1.12.0'
   promises: promises
   when: promises.when
   TeamSnap: TeamSnap