google-cloud-talent 0.1.0 → 0.2.0

data/lib/google/cloud/talent/v4beta1/completion_client.rb

@@ -59,18 +59,39 @@ module Google
           ].freeze
 
 
-          PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}"
+          COMPANY_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/tenants/{tenant}/companies/{company}"
           )
 
-          private_constant :PROJECT_PATH_TEMPLATE
+          private_constant :COMPANY_PATH_TEMPLATE
 
-          # Returns a fully-qualified project resource name string.
+          TENANT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/tenants/{tenant}"
+          )
+
+          private_constant :TENANT_PATH_TEMPLATE
+
+          # Returns a fully-qualified company resource name string.
+          # @param project [String]
+          # @param tenant [String]
+          # @param company [String]
+          # @return [String]
+          def self.company_path project, tenant, company
+            COMPANY_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"tenant" => tenant,
+              :"company" => company
+            )
+          end
+
+          # Returns a fully-qualified tenant resource name string.
           # @param project [String]
+          # @param tenant [String]
           # @return [String]
-          def self.project_path project
-            PROJECT_PATH_TEMPLATE.render(
-              :"project" => project
+          def self.tenant_path project, tenant
+            TENANT_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"tenant" => tenant
             )
           end
 
@@ -179,7 +200,10 @@ module Google
             @complete_query = Google::Gax.create_api_call(
               @completion_stub.method(:complete_query),
               defaults["complete_query"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
           end
 
@@ -188,13 +212,16 @@ module Google
           # Completes the specified prefix with keyword suggestions.
           # Intended for use by a job search auto-complete search box.
           #
-          # @param name [String]
+          # @param parent [String]
           #   Required.
           #
-          #   Resource name of project the completion is performed within.
+          #   Resource name of tenant the completion is performed within.
           #
-          #   The format is "projects/{project_id}", for example,
-          #   "projects/api-test-project".
+          #   The format is "projects/{project_id}/tenants/{tenant_id}", for example,
+          #   "projects/api-test-project/tenant/foo".
+          #
+          #   Tenant id is optional and the default tenant is used if unspecified, for
+          #   example, "projects/api-test-project".
           # @param query [String]
           #   Required.
           #
@@ -215,44 +242,37 @@ module Google
           #   For more information, see
           #   [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
           #
-          #   For
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType::JOB_TITLE}
-          #   type, only open jobs with the same
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
-          #   are returned.
+          #   For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType::JOB_TITLE} type, only open jobs with the same
+          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are returned.
           #
-          #   For
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType::COMPANY_NAME}
-          #   type, only companies having open jobs with the same
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
-          #   are returned.
+          #   For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType::COMPANY_NAME} type,
+          #   only companies having open jobs with the same {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are
+          #   returned.
           #
-          #   For
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}
-          #   type, only open jobs with the same
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
-          #   or companies having open jobs with the same
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
-          #   are returned.
+          #   For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED} type, only open jobs with the same
+          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} or companies having open jobs with the same
+          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are returned.
           #
           #   The maximum number of allowed characters is 255.
-          # @param company_name [String]
+          # @param company [String]
           #   Optional.
           #
           #   If provided, restricts completion to specified company.
           #
-          #   The format is "projects/{project_id}/companies/{company_id}", for example,
-          #   "projects/api-test-project/companies/foo".
+          #   The format is
+          #   "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
+          #   example, "projects/api-test-project/tenants/foo/companies/bar".
+          #
+          #   Tenant id is optional and the default tenant is used if unspecified, for
+          #   example, "projects/api-test-project/companies/bar".
           # @param scope [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope]
           #   Optional.
           #
-          #   The scope of the completion. The defaults is
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope::PUBLIC}.
+          #   The scope of the completion. The defaults is {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope::PUBLIC}.
           # @param type [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType]
           #   Optional.
           #
-          #   The completion topic. The default is
-          #   {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}.
+          #   The completion topic. The default is {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -265,31 +285,31 @@ module Google
           #   require "google/cloud/talent"
           #
           #   completion_client = Google::Cloud::Talent::Completion.new(version: :v4beta1)
-          #   formatted_name = Google::Cloud::Talent::V4beta1::CompletionClient.project_path("[PROJECT]")
+          #   formatted_parent = Google::Cloud::Talent::V4beta1::CompletionClient.tenant_path("[PROJECT]", "[TENANT]")
           #
           #   # TODO: Initialize `query`:
           #   query = ''
           #
           #   # TODO: Initialize `page_size`:
           #   page_size = 0
-          #   response = completion_client.complete_query(formatted_name, query, page_size)
+          #   response = completion_client.complete_query(formatted_parent, query, page_size)
 
           def complete_query \
-              name,
+              parent,
               query,
               page_size,
               language_codes: nil,
-              company_name: nil,
+              company: nil,
               scope: nil,
               type: nil,
               options: nil,
               &block
             req = {
-              name: name,
+              parent: parent,
               query: query,
               page_size: page_size,
               language_codes: language_codes,
-              company_name: company_name,
+              company: company,
               scope: scope,
               type: type
             }.delete_if { |_, v| v.nil? }

data/lib/google/cloud/talent/v4beta1/completion_service_pb.rb

@@ -8,11 +8,11 @@ require 'google/api/annotations_pb'
 require 'google/cloud/talent/v4beta1/common_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.cloud.talent.v4beta1.CompleteQueryRequest" do
-    optional :name, :string, 1
+    optional :parent, :string, 1
     optional :query, :string, 2
     repeated :language_codes, :string, 3
     optional :page_size, :int32, 4
-    optional :company_name, :string, 5
+    optional :company, :string, 5
     optional :scope, :enum, 6, "google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope"
     optional :type, :enum, 7, "google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType"
   end

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application.rb

@@ -0,0 +1,189 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+
+
+module Google
+  module Cloud
+    module Talent
+      module V4beta1
+        # Resource that represents a job application record of a candidate.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required during application update.
+        #
+        #     Resource name assigned to an application by the API.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}",
+        #     for example,
+        #     "projects/api-test-project/tenants/foo/profiles/bar/applications/baz".
+        # @!attribute [rw] external_id
+        #   @return [String]
+        #     Required.
+        #
+        #     Client side application identifier, used to uniquely identify the
+        #     recruiter.
+        #
+        #     The maximum number of allowed characters is 255.
+        # @!attribute [rw] profile
+        #   @return [String]
+        #     Required.
+        #
+        #     Resource name of the candidate of this application.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
+        #     for example, "projects/api-test-project/tenants/foo/profiles/bar".
+        # @!attribute [rw] job
+        #   @return [String]
+        #     One of either a job or a company is required.
+        #
+        #     Resource name of the job which the candidate applied for.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}",
+        #     for example, "projects/api-test-project/tenants/foo/jobs/bar".
+        # @!attribute [rw] company
+        #   @return [String]
+        #     One of either a job or a company is required.
+        #
+        #     Resource name of the company which the candidate applied for.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}",
+        #     for example, "projects/api-test-project/tenants/foo/companies/bar".
+        # @!attribute [rw] application_date
+        #   @return [Google::Type::Date]
+        #     Optional.
+        #
+        #     The application date.
+        # @!attribute [rw] stage
+        #   @return [Google::Cloud::Talent::V4beta1::Application::ApplicationStage]
+        #     Required.
+        #
+        #     What is the most recent stage of the application (that is, new, screen,
+        #     send cv, hired, finished work)?  This field is intentionally not
+        #     comprehensive of every possible status, but instead, represents statuses
+        #     that would be used to indicate to the ML models good / bad matches.
+        # @!attribute [rw] state
+        #   @return [Google::Cloud::Talent::V4beta1::Application::ApplicationState]
+        #     Optional.
+        #
+        #     The application state.
+        # @!attribute [rw] interviews
+        #   @return [Array<Google::Cloud::Talent::V4beta1::Interview>]
+        #     Optional.
+        #
+        #     All interviews (screen, onsite, and so on) conducted as part of this
+        #     application (includes details such as user conducting the interview,
+        #     timestamp, feedback, and so on).
+        # @!attribute [rw] referral
+        #   @return [Google::Protobuf::BoolValue]
+        #     Optional.
+        #
+        #     If the candidate is referred by a employee.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Required.
+        #
+        #     Reflects the time that the application was created.
+        # @!attribute [rw] update_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Optional.
+        #
+        #     The last update timestamp.
+        # @!attribute [rw] outcome_notes
+        #   @return [String]
+        #     Optional.
+        #
+        #     Free text reason behind the recruitement outcome (for example, reason for
+        #     withdraw / reject, reason for an unsuccessful finish, and so on).
+        #
+        #     Number of characters allowed is 100.
+        # @!attribute [rw] outcome
+        #   @return [Google::Cloud::Talent::V4beta1::Outcome]
+        #     Optional.
+        #
+        #     Outcome positiveness shows how positive the outcome is.
+        # @!attribute [rw] is_match
+        #   @return [Google::Protobuf::BoolValue]
+        #     Output only. Indicates whether this job application is a match to
+        #     application related filters. This value is only applicable in profile
+        #     search response.
+        # @!attribute [rw] job_title_snippet
+        #   @return [String]
+        #     Output only. Job title snippet shows how the job title is related to a
+        #     search query. It's empty if the job title isn't related to the search
+        #     query.
+        class Application
+          # The stage of the application.
+          module ApplicationStage
+            # Default value.
+            APPLICATION_STAGE_UNSPECIFIED = 0
+
+            # Candidate has applied or a recruiter put candidate into consideration but
+            # candidate is not yet screened / no decision has been made to move or not
+            # move the candidate to the next stage.
+            NEW = 1
+
+            # A recruiter decided to screen the candidate for this role.
+            SCREEN = 2
+
+            # Candidate is being / was sent to the customer / hiring manager for
+            # detailed review.
+            HIRING_MANAGER_REVIEW = 3
+
+            # Candidate was approved by the client / hiring manager and is being / was
+            # interviewed for the role.
+            INTERVIEW = 4
+
+            # Candidate will be / has been given an offer of employment.
+            OFFER_EXTENDED = 5
+
+            # Candidate has accepted their offer of employment.
+            OFFER_ACCEPTED = 6
+
+            # Candidate has begun (or completed) their employment or assignment with
+            # the employer.
+            STARTED = 7
+          end
+
+          # Enum that represents the application status.
+          module ApplicationState
+            # Default value.
+            APPLICATION_STATE_UNSPECIFIED = 0
+
+            # The current stage is in progress or pending, for example, interviews in
+            # progress.
+            IN_PROGRESS = 1
+
+            # The current stage was terminated by a candidate decision.
+            CANDIDATE_WITHDREW = 2
+
+            # The current stage was terminated by an employer or agency decision.
+            EMPLOYER_WITHDREW = 3
+
+            # The current stage is successfully completed, but the next stage (if
+            # applicable) has not begun.
+            COMPLETED = 4
+
+            # The current stage was closed without an exception, or terminated for
+            # reasons unrealated to the candidate.
+            CLOSED = 5
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application_service.rb

@@ -0,0 +1,121 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+
+
+module Google
+  module Cloud
+    module Talent
+      module V4beta1
+        # The Request of the CreateApplication method.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required.
+        #
+        #     Resource name of the profile under which the application is created.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for
+        #     example, "projects/test-project/tenants/test-tenant/profiles/test-profile".
+        # @!attribute [rw] application
+        #   @return [Google::Cloud::Talent::V4beta1::Application]
+        #     Required.
+        #
+        #     The application to be created.
+        class CreateApplicationRequest; end
+
+        # Request for getting a application by name.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required.
+        #
+        #     The resource name of the application to be retrieved.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}",
+        #     for example,
+        #     "projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
+        class GetApplicationRequest; end
+
+        # Request for updating a specified application.
+        # @!attribute [rw] application
+        #   @return [Google::Cloud::Talent::V4beta1::Application]
+        #     Required.
+        #
+        #     The application resource to replace the current resource in the system.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Optional but strongly recommended for the best service
+        #     experience.
+        #
+        #     If {Google::Cloud::Talent::V4beta1::UpdateApplicationRequest#update_mask update_mask} is provided, only the specified fields in
+        #     {Google::Cloud::Talent::V4beta1::UpdateApplicationRequest#application application} are updated. Otherwise all the fields are updated.
+        #
+        #     A field mask to specify the application fields to be updated. Only
+        #     top level fields of {Google::Cloud::Talent::V4beta1::Application Application} are supported.
+        class UpdateApplicationRequest; end
+
+        # Request to delete a application.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required.
+        #
+        #     The resource name of the application to be deleted.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}",
+        #     for example,
+        #     "projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
+        class DeleteApplicationRequest; end
+
+        # List applications for which the client has ACL visibility.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required.
+        #
+        #     Resource name of the profile under which the application is created.
+        #
+        #     The format is
+        #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for
+        #     example, "projects/test-project/tenants/test-tenant/profiles/test-profile".
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     Optional.
+        #
+        #     The starting indicator from which to return results.
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Optional.
+        #
+        #     The maximum number of applications to be returned, at most 100.
+        #     Default is 100 if a non-positive number is provided.
+        class ListApplicationsRequest; end
+
+        # Output only.
+        #
+        # The List applications response object.
+        # @!attribute [rw] applications
+        #   @return [Array<Google::Cloud::Talent::V4beta1::Application>]
+        #     Applications for the current client.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     A token to retrieve the next page of results.
+        # @!attribute [rw] metadata
+        #   @return [Google::Cloud::Talent::V4beta1::ResponseMetadata]
+        #     Additional information for the API invocation, such as the request
+        #     tracking id.
+        class ListApplicationsResponse; end
+      end
+    end
+  end
+end