Procore.Api.CoreProjectDirectoryProjectMemberships (procore_sdk v0.2.0)

API calls for all endpoints tagged CoreProjectDirectoryProjectMemberships.

Summary

Functions

rest_v10_projects_project_id_project_memberships_bulk_add_post(connection, procore_company_id, project_id, bulk_create_project_membership_body, opts \\ [])

Bulk Create Project Memberships Bulk Create Project Memberships for many parties on the given Project. This endpoint can currently only be used to add reference users to a project. It cannot be used to add a user who has a login or to add vendors.

rest_v10_projects_project_id_project_memberships_get(connection, procore_company_id, project_id, opts \\ [])

List Project Memberships List all Project Memberships on a given Project. This endpoint returns all Memberships, including inactive Users/Vendors.

rest_v10_projects_project_id_project_memberships_id_delete(connection, procore_company_id, project_id, id, party_id, opts \\ [])

Delete Project Membership Delete a Project Membership for a party on the given Project. This endpoint can currently only be used to delete reference users from a project. It cannot be used to delete a user who has a login or to delete vendors.

rest_v10_projects_project_id_project_memberships_post(connection, procore_company_id, project_id, project_membership_body, opts \\ [])

Create Project Membership Create a Project Membership for a party on the given Project. This endpoint can currently only be used to add reference users to a project. It cannot be used to add a user who has a login or to add vendors.

Functions

Link to this function

rest_v10_projects_project_id_project_memberships_bulk_add_post(connection, procore_company_id, project_id, bulk_create_project_membership_body, opts \\ [])

@spec rest_v10_projects_project_id_project_memberships_bulk_add_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.BulkCreateProjectMembershipBody.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [integer()]}
  | {:error, Tesla.Env.t()}

Bulk Create Project Memberships Bulk Create Project Memberships for many parties on the given Project. This endpoint can currently only be used to add reference users to a project. It cannot be used to add a user who has a login or to add vendors.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • bulk_create_project_membership_body (BulkCreateProjectMembershipBody):
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%Integer{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_project_memberships_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v10_projects_project_id_project_memberships_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.ProjectMembership.t()]}
  | {:error, Tesla.Env.t()}

List Project Memberships List all Project Memberships on a given Project. This endpoint returns all Memberships, including inactive Users/Vendors.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

  • {:ok, [%ProjectMembership{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_project_memberships_id_delete(connection, procore_company_id, project_id, id, party_id, opts \\ [])

@spec rest_v10_projects_project_id_project_memberships_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Delete Project Membership Delete a Project Membership for a party on the given Project. This endpoint can currently only be used to delete reference users from a project. It cannot be used to delete a user who has a login or to delete vendors.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • id (integer()): The ID of the Project Membership
  • party_id (integer()): The ID of the Party (reference user)
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_project_memberships_post(connection, procore_company_id, project_id, project_membership_body, opts \\ [])

@spec rest_v10_projects_project_id_project_memberships_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.ProjectMembershipBody.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [float()]}
  | {:error, Tesla.Env.t()}

Create Project Membership Create a Project Membership for a party on the given Project. This endpoint can currently only be used to add reference users to a project. It cannot be used to add a user who has a login or to add vendors.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • project_membership_body (ProjectMembershipBody):
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%Float{}, ...]} on success
  • {:error, Tesla.Env.t} on failure