teamlab 0.2.1 → 0.2.2

data/README.md

@@ -10,25 +10,25 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install teamlab
+    gem install teamlab
 
 ## Usage
 
 First of all, you should configure your enviroment by commands
 
-    $ Teamlab.configure do |config|
-    $   config.server = 'example.teamlab.com'
-    $   config.username = 'foo'
-    $   config.password = 'bar'
-    $ end
+    Teamlab.configure do |config|
+      config.server = 'example.teamlab.com'
+      config.username = 'foo'
+      config.password = 'bar'
+    end
 
 and then call methods you need:
 
-    $ Teamlab.people.get_people
+    Teamlab.people.get_people
 
 
 ## Contributing
@@ -38,3 +38,8 @@ and then call methods you need:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## Documentation
+
+Please read TeamLab API [documentation](http://api.teamlab.com/2.0/) for more information about API methods

data/lib/teamlab/Modules/Calendar.rb

@@ -37,18 +37,18 @@ module Teamlab
       @request.get(['calendars', start_date.to_s, end_date.to_s])
     end
 
-    def create_calendar(name, options = {})
-      @request.post('', {name: name}.merge(options))
+    def create_calendar(name, time_zone, options = {})
+      @request.post('', {name: name, timeZone: time_zone}.merge(options))
     end
 
-    def create_calendar_by_ical_link(ical_url, options = {})
-      @request.post(%w(calendarurl), {iCalUrl: ical_url}.merge(options))
+    def create_calendar_by_ical_link(ical_url, name, options = {})
+      @request.post(%w(calendarurl), {iCalUrl: ical_url, name: name}.merge(options))
     end
 
 #============== TODO: OPTIONAL VARIABLES
 
     def add_event(calendar_id, name, options = {})
-      @request.post([calendar_id.to_s], {name: name}.merge(options))
+      @request.post([calendar_id.to_s, 'event'], {name: name}.merge(options))
     end
 
     def import_ical(calendar_id, *files)
@@ -57,14 +57,14 @@ module Teamlab
 
 #============== TODO: OPTIONAL VARIABLES
 
-    def update_calendar(calendar_id, name, options = {})
-      @request.put([calendar_id.to_s], {name: name}.merge(options))
+    def update_calendar(calendar_id, name, time_zone, options = {})
+      @request.put([calendar_id.to_s], {name: name, timeZone: time_zone}.merge(options))
     end
 
 #============== TODO: OPTIONAL VARIABLES
 
-    def update_calendar_user_view(calendar_id, options = {})
-      @request.put([calendar_id.to_s, 'view'], options)
+    def update_calendar_user_view(calendar_id, name, time_zone, options = {})
+      @request.put([calendar_id.to_s, 'view'], {name: name, timeZone: time_zone}.merge(options))
     end
 
     def manage_subscriptions(states)

data/lib/teamlab/Modules/Community.rb

@@ -158,8 +158,8 @@ module Teamlab
 
 #==================================== TODO: ERROR
 
-    def add_thread_to_category(category_id, category_name, thread_name, options = {})
-      @request.post(%w(forum), {categoryId: category_id, categoryName: category_name.to_s, threadName: thread_name}.merge(options))
+    def add_thread_to_category(category_id, category_name, thread_name, description)
+      @request.post(%w(forum), categoryId: category_id, categoryName: category_name.to_s, threadName: thread_name, description: description)
     end
 
     def add_topic_to_thread(thread_id, subject, content, options = {})
@@ -170,8 +170,8 @@ module Teamlab
       @request.post(['forum', 'topic', topic_id.to_s], {subject: subject, content: content}.merge(options))
     end
 
-    def update_topic_in_thread(topic_id, options = {})
-      @request.put(['forum', 'topic', topic_id.to_s], options)
+    def update_topic_in_thread(topic_id, subject, options = {})
+      @request.put(['forum', 'topic', topic_id.to_s], {subject: subject}.merge(options))
     end
 
     def update_post_in_topic(topic_id, post_id, options = {})

data/lib/teamlab/Modules/Crm.rb

@@ -5,6 +5,7 @@ module Teamlab
       @request = Teamlab::Request.new('crm')
     end
 
+    #region Opportunity
     def get_all_opportunity_stages
       @request.get(%w(opportunity stage))
     end
@@ -37,11 +38,11 @@ module Teamlab
       @request.get(['settings', 'currency', currency.to_s, 'summarytable'])
     end
 
-    def create_opportunity(title, responsible_id, options = {})
-      @request.post(%w(opportunity), {title: title, responsibleid: responsible_id}.merge(options))
+    def create_opportunity(stage_id, title, responsible_id, options = {}) #есть тест
+      @request.post(%w(opportunity), {stageId: stage_id, title: title, responsibleid: responsible_id}.merge(options))
     end
 
-    def create_opportunity_stage(title, color, options = {})
+    def create_opportunity_stage(title, color, options = {}) #есть тест
       @request.post(%w(opportunity stage), { title: title, color: color }.merge(options))
     end
 
@@ -49,19 +50,19 @@ module Teamlab
       @request.post(['opportunity', opportunity_id.to_s, 'contact', contact_id.to_s])
     end
 
-    def set_opportunity_success_rights(opportunity_id, is_private, access_list)
-      @request.put(%w(opportunity access), opportunityid: opportunity_id, isPrivate: is_private, accessList: access_list)
+    def set_opportunity_access_rights(opportunity_ids, is_private, *users)
+      @request.put(%w(opportunity access), opportunityid: opportunity_ids.to_a.flatten, isPrivate: is_private, accessList: users.flatten)
     end
 
     def update_opportunity_stage(id, title, color, options = {})
       @request.put(['opportunity', 'stage', id.to_s], { title: title, color: color,  }.merge(options))
     end
 
-    def update_opportunity_stage_order(options = {})
+    def update_opportunity_stages_order(options = {})
       @request.put(%w(opportunity stage reorder), options)
     end
 
-    def set_opportunity_access_rights(options = {})
+    def set_opportunity_access_rights_for_users(options = {})
       @request.put(%w(opportunity filter access), options)
     end
 
@@ -82,8 +83,8 @@ module Teamlab
       @request.put(['opportunity', opportunity_id.to_s, 'stage', stage_id.to_s], stageid: stage_id)
     end
 
-    def delete_opportunity_group(opportunity_ids)
-      @request.delete(%w(opportunity), opportunityids: opportunity_ids)
+    def delete_opportunity_group(*opportunity_ids)
+      @request.delete(%w(opportunity), opportunityids: opportunity_ids.flatten)
     end
 
     def delete_opportunity_group_by_filter(options = {})
@@ -102,12 +103,16 @@ module Teamlab
       @request.delete(['opportunity', opportunity_id.to_s, 'contact', contact_id.to_s])
     end
 
+    #endregion
+
+    #region General
+
     def get_invoice_taxes
       @request.get(%w(invoice tax))
     end
 
-    def get_contacts_for_mail(contact_ids)
-      @request.get(%w(contact mail), contactids: contact_ids)
+    def get_contacts_for_mail(*contact_ids)
+      @request.get(%w(contact mail), contactids: contact_ids.flatten)
     end
 
     def get_cases_by_prefix(contact_id, prefix)
@@ -122,11 +127,11 @@ module Teamlab
       @request.get(%w(invoice sample))
     end
 
-    def get_invoices(options = {})
+    def get_invoices_by_filter(options = {})
       @request.get(%w(invoice filter), options)
     end
 
-    def get_contacts(options = {})
+    def get_contacts_by_filter(options = {})
       @request.get(%w(contact filter), options)
     end
 
@@ -134,7 +139,7 @@ module Teamlab
       @request.get(%w(invoice settings))
     end
 
-    def get_invoice_items(options = {})
+    def get_invoice_items_by_filter(options = {})
       @request.get(%w(invoiceitem filter), options)
     end
 
@@ -166,12 +171,12 @@ module Teamlab
 
 #=========================================== TODO: OPTIONAL VARIABLES =====================================================
 
-    def create_invoice_line(invoice_id)
-      @request.post(%w(invoiceline), invoiceId: invoice_id)
+    def create_invoice_line(invoice_id, options = {})
+      @request.post(%w(invoiceline), {invoiceId: invoice_id}.merge(options))
     end
 
-    def create_invoice_item(options = {})
-      @request.post(%w(invoiceitem), options)
+    def create_invoice_item(title, description, price, stock_keeping_unit, options = {})
+      @request.post(%w(invoiceitem), {title: title, description: description, price: price, sku: stock_keeping_unit.to_s}.merge(options))
     end
 
     def create_invoice_tax(name, description, options = {})
@@ -190,10 +195,8 @@ module Teamlab
       @request.post(%w(contact person), {firstName: first_name, lastName: last_name}.merge(options))
     end
 
-#=========================================== TODO: OPTIONAL VARIABLES =====================================================
-
-    def create_company(company_name, options = {})
-      @request.post(%w(contact company), {companyName: company_name}.merge(options))
+    def create_company(company_name, managers, options = {})
+      @request.post(%w(contact company), {companyName: company_name, managerList: managers}.merge(options))
     end
 
     def create_task_group(title, options = {})
@@ -216,16 +219,12 @@ module Teamlab
       @request.put(%w(settings), options)
     end
 
-#=========================================== TODO: OPTIONAL VARIABLES =====================================================
-
-    def update_task(task_id, options = {})
-      @request.put(['task', task_id.to_s], options)
+    def update_task(task_id, title, deadline, category_id, options = {})
+      @request.put(['task', task_id.to_s], {title: title, deadline: deadline, categoryid: category_id}.merge(options))
     end
 
-#=========================================== TODO: OPTIONAL VARIABLES =====================================================
-
-    def update_invoice_item(id, options = {})
-      @request.put(['invoiceitem', id.to_s], options)
+    def update_invoice_item(id, title, description, price, stock_keeping_unit, options = {})
+      @request.put(['invoiceitem', id.to_s], {title: title, description: description, price: price, sku: stock_keeping_unit.to_s}.merge(options))
     end
 
     def update_invoice_tax(id, name, options = {})
@@ -236,8 +235,8 @@ module Teamlab
       @request.put(['contact', 'type', id.to_s], {title: title}.merge(options))
     end
 
-    def update_contact_status(id, options = {})
-      @request.put(['contact', 'status', id.to_s], options)
+    def update_contact_status(id, title, options = {})
+      @request.put(['contact', 'status', id.to_s], {title: title.to_s}.merge(options))
     end
 
 #=========================================== TODO: OPTIONAL VARIABLES =====================================================
@@ -250,6 +249,10 @@ module Teamlab
       @request.put(%w(contact tag settings), options)
     end
 
+    def save_number_settings(options = {})
+      @request.put(%w(invoice settings name), options)
+    end
+
     def set_access_to_batch_contact(options = {})
       @request.put(%w(contact filter access), options)
     end
@@ -274,10 +277,8 @@ module Teamlab
       @request.put(['contact', 'status', status_id.to_s, 'color'], color: color)
     end
 
-#=========================================== TODO: OPTIONAL VARIABLES =====================================================
-
-    def update_person(id, options = {})
-      @request.put(['contact', 'person', id.to_s], options)
+    def update_person(id, first_name, last_name, options = {})
+      @request.put(['contact', 'person', id.to_s], {firstName: first_name, lastName: last_name}.merge(options))
     end
 
     def update_contact_status_by_id(contact_id, contact_status_id)
@@ -295,7 +296,7 @@ module Teamlab
     end
 
     def update_person_and_its_company_status(person_id, contact_status_id)
-      @request.put(['contact', 'preson', person_id.to_s, 'status'], contactStatusId: contact_status_id)
+      @request.put(['contact', 'person', person_id.to_s, 'status'], contactStatusId: contact_status_id)
     end
 
     def update_company_and_participants_status(company_id, contact_status_id)
@@ -346,10 +347,8 @@ module Teamlab
       @request.get(%w(history category))
     end
 
-#=========================================== TODO: OPTIONAL VARIABLES =====================================================
-
-    def create_event(options = {})
-      @request.post(%w(history), options)
+    def create_event(contact_id, content, category_id, options = {})
+      @request.post(%w(history), {contactId: contact_id, content: content, categoryId: category_id}.merge(options))
     end
 
     def create_history_category(title, image_name, options = {})
@@ -396,12 +395,12 @@ module Teamlab
       @request.post(%w(task category), {title: title.to_s, imageName: image_name.to_s}.merge(options))
     end
 
-    def get_contact_upcoming_tasks(contact_id)
-      @request.post(%w(contact task near), contactid: contact_id)
+    def get_contact_upcoming_tasks(*contact_ids)
+      @request.post(%w(contact task near), contactid: contact_ids.flatten)
     end
 
-    def update_task_category(category_id, options = {})
-      @request.put(['task', 'category', category_id.to_s], options)
+    def update_task_category(category_id, title, options = {})
+      @request.put(['task', 'category', category_id.to_s], { title: title }.merge(options))
     end
 
     def close_task(task_id)
@@ -468,8 +467,8 @@ module Teamlab
       @request.post(%w(contact data), items: items.flatten)
     end
 
-    def quick_person_list_creation(*data)
-      @request.post(%w(contact person quick), data: data.flatten)
+    def quick_person_list_creation(data)
+      @request.post(%w(contact person quick), data: data)
     end
 
     def quick_company_list_creation(*names)
@@ -524,16 +523,16 @@ module Teamlab
       @request.put(['contact', 'company', company_id.to_s], {companyName: company_name.to_s}.merge(options))
     end
 
-    def update_contact_info(information_id, contact_id, info_type, data, options = {})
-      @request.put(['contact', contact_id.to_s, 'data', information_id.to_s], {infoType: info_type, data: INFO_DATA}.merge(options))
+    def update_contact_info(information_id, contact_id, data, options = {})
+      @request.put(['contact', contact_id.to_s, 'data', information_id.to_s], {data: data}.merge(options))
     end
 
     def change_contact_photo_by_url(contact_id, photo_url)
       @request.put(['contact', contact_id.to_s, 'changephotobyurl'], photourl: photo_url)
     end
 
-    def update_contact_address(contact_id, information_record_id, address, options = {})
-      @request.put(['contact', contact_id.to_s, 'data', 'address', information_record_id.to_s], {address: address}.merge(options))
+    def update_contact_address(contact_id, information_id, address, options = {})
+      @request.put(['contact', contact_id.to_s, 'data', 'address', information_id.to_s], {address: address}.merge(options))
     end
 
     def delete_contact(id)
@@ -552,14 +551,16 @@ module Teamlab
       @request.delete(['contact', 'company', company_id.to_s, 'person'], {personId: person_id})
     end
 
-    def delete_ontact_address(contact_id, information_record_id)
-      @request.delete(['contact', contact_id.to_s, 'data', 'address', information_record_id.to_s])
+    def delete_contact_address(contact_id, information_id)
+      @request.delete(['contact', contact_id.to_s, 'data', 'address', information_id.to_s])
     end
 
     def remove_contact_from_project(contact_id, project_id)
       @request.delete(['contact', contact_id.to_s, 'project', project_id.to_s])
     end
 
+    #region Files
+
     def get_root_folder_id
       @request.get(%w(files root))
     end
@@ -572,8 +573,8 @@ module Teamlab
       @request.post([entity_type, entity_id, 'files'], files: fileids.flatten)
     end
 
-    def create_txt(entity_type, entity_id, title, options = {})
-      @request.post([entity_type.to_s, entity_id.to_s, 'files', 'text'], {title: title}.merge(options))
+    def create_txt(entity_type, entity_id, title, content)
+      @request.post([entity_type.to_s, entity_id.to_s, 'files', 'text'], title: title, content: content)
     end
 
 #================================== TODO: UPLOAD FILES ================================
@@ -599,13 +600,13 @@ module Teamlab
     end
 
     def create_tag(entity_type, tag_name)
-      @request.get([entity_type.to_s, 'tag'], tagName: tag_name)
+      @request.post([entity_type.to_s, 'tag'], tagName: tag_name)
     end
 
 #=========================================== TODO: OPTIONAL VARIABLES =====================================================
 
-    def add_tag_to_case_group_by_filter(options = {})
-      @request.post(%w(case filter taglist), options)
+    def add_tag_to_case_group_by_filter(tag_name, options = {})
+      @request.post(%w(case filter taglist), {tagName: tag_name}.merge(options))
     end
 
 #=========================================== TODO: OPTIONAL VARIABLES =====================================================
@@ -616,8 +617,8 @@ module Teamlab
 
 #=========================================== TODO: OPTIONAL VARIABLES =====================================================
 
-    def add_tag_to_opportunity_group(options = {})
-      @request.post(%w(opportunity filter taglist), options)
+    def add_tag_to_opportunity_group(tag_name, options = {})
+      @request.post(%w(opportunity filter taglist), {tagName: tag_name}.merge(options))
     end
 
     def add_tag(entity_type, entity_id, tag_name)
@@ -668,8 +669,8 @@ module Teamlab
 
 #=========================================== TODO: OPTIONAL VARIABLES =====================================================
 
-    def update_task_template(container_id, task_template_id,   options = {})
-      @request.put(['tasktemplatecontainer', container_id.to_s, 'tasktemplate'], {id: task_template_id.to_s}.merge(options))
+    def update_task_template(container_id, task_template_id, title, options = {})
+      @request.put(['tasktemplatecontainer', container_id.to_s, 'tasktemplate'], {id: task_template_id.to_s, title: title}.merge(options))
     end
 
     def delete_task_template_container(container_id)
@@ -680,8 +681,6 @@ module Teamlab
       @request.delete(['tasktemplatecontainer', 'tasktemplate', id.to_s])
     end
 
-#=========================================== TODO: OPTIONAL VARIABLES =====================================================
-
     def get_case_list(options = {})
       @request.get(%w(case filter), options)
     end
@@ -702,8 +701,8 @@ module Teamlab
       @request.post(['case', case_id.to_s, 'contact'], contactId: contact_id)
     end
 
-    def set_case_access_rights(case_id, options = {})
-      @request.put(%w(case access), {caseId: case_id}.merge(options))
+    def set_case_access_rights(case_ids, options = {})
+      @request.put(%w(case access), {caseId: case_ids}.merge(options))
     end
 
     def update_case(case_id, title, options = {})
@@ -750,16 +749,16 @@ module Teamlab
       @request.get([entity_type.to_s, 'customfield', 'definitions'])
     end
 
-    def create_user_field(entity_type, field_type, options = {})
-      @request.post([entity_type.to_s, 'customfield'], {fieldType: field_type}.merge(options))
+    def create_user_field(entity_type, label, field_type, options = {})
+      @request.post([entity_type.to_s, 'customfield'], {fieldType: field_type, label: label}.merge(options))
     end
 
     def set_user_field_value(entity_type, entity_id, field_id, field_value)
       @request.post([entity_type.to_s, entity_id.to_s, 'customfield', field_id.to_s], fieldValue: field_value)
     end
 
-    def update_selected_user_field(entity_type, user_field_id, field_type, options = {})
-      @request.put([entity_type.to_s, 'customfield', user_field_id.to_s], {fieldType: field_type}.merge(options))
+    def update_selected_user_field(entity_type, user_field_id, label, field_type, options = {})
+      @request.put([entity_type.to_s, 'customfield', user_field_id.to_s], {fieldType: field_type, label: label}.merge(options))
     end
 
     def update_user_fields_order(entity_type, *field_ids)

data/lib/teamlab/Modules/Files.rb

@@ -37,7 +37,7 @@ module Teamlab
       @request.get(['@search', query.to_s])
     end
 
-    def get_recent_upload_files(folder_id)
+    def get_recent_uploaded_files(folder_id)
       @request.get([folder_id.to_s, 'feeds'])
     end