GoogleApi.Jobs.V2.Api.Companies.jobs_companies_patch

You're seeing just the function jobs_companies_patch, go back to GoogleApi.Jobs.V2.Api.Companies module for more information.
Link to this function

jobs_companies_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

jobs_companies_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Jobs.V2.Model.Company.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Updates the specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.

Parameters

  • connection (type: GoogleApi.Jobs.V2.Connection.t) - Connection to server

  • name (type: String.t) - Required during company update.

    The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.

    • :access_token (type: String.t) - OAuth access token.

    • :alt (type: String.t) - Data format for response.

    • :callback (type: String.t) - JSONP

    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.

    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.

    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.

    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").

    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").

    • :updateCompanyFields (type: String.t) - Optional but strongly recommended to be provided for the best service experience.

      If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are:

      • displayName
      • website
      • imageUrl
      • companySize
      • distributorBillingCompanyId
      • companyInfoSources
      • careerPageLink
      • hiringAgency
      • hqLocation
      • eeoText
      • keywordSearchableCustomAttributes
      • title (deprecated)
      • keywordSearchableCustomFields (deprecated)
    • :body (type: GoogleApi.Jobs.V2.Model.Company.t) -

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Jobs.V2.Model.Company{}} on success
  • {:error, info} on failure