upwork-api 1.0.0

data/lib/upwork/api/routers/hr/roles.rb

@@ -0,0 +1,49 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      module Hr
+        # Roles
+        class Roles
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Get user roles
+          def get_all
+            $LOG.i "running " + __method__.to_s
+            @client.get '/hr/v2/userroles'
+          end
+          
+          # Get by specific user
+          #
+          # Arguments:
+          #  reference: (String)
+          def get_by_specific_user(user_reference)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/hr/v2/userroles/' + user_reference
+          end
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/hr/submissions.rb

@@ -0,0 +1,63 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      module Hr
+        # Submissions workflow
+        class Submissions
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Freelancer submits work for the client to approve
+          #
+          # Arguments:
+          #  params: (Hash)
+          def request_approval(params)
+            $LOG.i "running " + __method__.to_s
+            @client.post '/hr/v3/fp/submissions', params
+          end
+          
+          # Approve an existing Submission
+          #
+          # Arguments:
+          #  submission_id: (String)
+          #  params: (Hash)
+          def approve(submission_id, params)
+            $LOG.i "running " + __method__.to_s
+            @client.put '/hr/v3/fp/submissions/' + submission_id + '/approve', params
+          end
+          
+          # Reject an existing Submission
+          #
+          # Arguments:
+          #  submission_id: (String)
+          #  params: (Hash)
+          def reject(submission_id, params)
+            $LOG.i "running " + __method__.to_s
+            @client.put '/hr/v3/fp/submissions/' + submission_id + '/reject', params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/jobs/profile.rb

@@ -0,0 +1,43 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      module Jobs
+        # Freelancer's profile info
+        class Profile
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Get specific profile
+          #
+          # Arguments:
+          #  key: (String)
+          def get_specific(key)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/profiles/v1/jobs/' + key
+          end
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/jobs/search.rb

@@ -0,0 +1,43 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      module Jobs
+        # Search Job profiles
+        class Search
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Search profiles
+          #
+          # Arguments:
+          #  params: (Hash)
+          def find(params)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/profiles/v2/search/jobs', params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/mc.rb

@@ -0,0 +1,113 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      class Mc
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Get trays
+        def get_trays
+          $LOG.i "running " + __method__.to_s
+          @client.get '/mc/v1/trays'
+        end
+        
+        # Get tray by type
+        #
+        # Arguments:
+        #  username: (String)
+        #  type: (String)
+        def get_tray_by_type(username, type)
+          $LOG.i "running " + __method__.to_s
+          @client.get '/mc/v1/trays/' + username + '/' + type
+        end
+        
+        # List thread details based on thread id
+        #
+        # Arguments:
+        #  username: (String)
+        #  thread_id: (String)
+        def get_thread_details(username, thread_id)
+          $LOG.i "running " + __method__.to_s
+          @client.get '/mc/v1/threads/' + username + '/' + thread_id
+        end
+        
+        # Get a specific thread by context
+        #
+        # Arguments:
+        #  username: (String)
+        #  job_key: (String)
+        #  application_id: (String)
+        #  context: (String)
+        def get_thread_by_context(username, job_key, application_id, context = 'Interviews')
+          $LOG.i "running " + __method__.to_s
+          @client.get '/mc/v1/contexts/' + username + '/' + context + ':' + job_key + ':' + application_id
+        end
+        
+        # Get a specific thread by context (last message content)
+        #
+        # Arguments:
+        #  username: (String)
+        #  job_key: (String)
+        #  application_id: (String)
+        #  context: (String)
+        def get_thread_by_context_last_posts(username, job_key, application_id, context = 'Interviews')
+          $LOG.i "running " + __method__.to_s
+          @client.get '/mc/v1/contexts/' + username + '/' + context + ':' + job_key + ':' + application_id + '/last_posts'
+        end
+        
+        # Send new message
+        #
+        # Arguments:
+        #  username: (String)
+        #  params: (Hash)
+        def start_new_thread(username, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.post '/mc/v1/threads/' + username, params
+        end
+        
+        # Reply to existent thread
+        #
+        # Arguments:
+        #  username: (String)
+        #  thread_id: (String)
+        #  params: (Hash)
+        def reply_to_thread(username, thread_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.post '/mc/v1/threads/' + username + '/' + thread_id, params
+        end
+        
+        # Update threads based on user actions
+        #
+        # Arguments:
+        #  username: (String)
+        #  thread_id: (String)
+        #  params: (Hash)
+        def mark_thread(username, thread_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.put '/mc/v1/threads/' + username + '/' + thread_id, params
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/metadata.rb

@@ -0,0 +1,71 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      # Get Metadata
+      class Metadata
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Get categories
+        def get_categories
+          $LOG.i "running " + __method__.to_s
+          @client.get '/profiles/v1/metadata/categories'
+        end
+        
+        # Get categories (v2)
+        def get_categories_v2
+          $LOG.i "running " + __method__.to_s
+          @client.get '/profiles/v2/metadata/categories'
+        end
+        
+        # Get skills
+        def get_skills
+          $LOG.i "running " + __method__.to_s
+          @client.get '/profiles/v1/metadata/skills'
+        end
+        
+        # Get regions
+        def get_regions
+          $LOG.i "running " + __method__.to_s
+          @client.get '/profiles/v1/metadata/regions'
+        end
+        
+        # Get tests
+        def get_tests
+          $LOG.i "running " + __method__.to_s
+          @client.get '/profiles/v1/metadata/tests'
+        end
+        
+        # Get reasons
+        #
+        # Arguments:
+        #  params: (Hash)
+        def get_reasons(params)
+          $LOG.i "running " + __method__.to_s
+          @client.get '/profiles/v1/metadata/reasons', params;
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/organization/companies.rb

@@ -0,0 +1,67 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      module Organization
+        # Companies inside Organization
+        class Companies
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT
+          end
+          
+          # Get Companies Info
+          def get_list
+            $LOG.i "running " + __method__.to_s
+            @client.get '/hr/v2/companies'
+          end
+          
+          # Get Specific Company
+          #
+          # Arguments:
+          #  company_reference: (String)
+          def get_specific(company_reference)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/hr/v2/companies/' + company_reference
+          end
+          
+          # Get Teams in Company
+          #
+          # Arguments:
+          #  company_reference: (String)
+          def get_teams(company_reference)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/hr/v2/companies/' + company_reference + '/teams'
+          end
+          
+          # Get Users in Company
+          #
+          # Arguments:
+          #  company_reference: (String)
+          def get_users(company_reference)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/hr/v2/companies/' + company_reference + '/users'
+          end
+        end
+      end
+    end
+  end
+end