Procore.Api.CoreCompanyDocumentsCompanyFoldersAndFiles (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyDocumentsCompanyFoldersAndFiles.

Summary

Functions

rest_v10_companies_company_id_file_versions_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show company file version Show detailed information about a File Version.

rest_v10_companies_company_id_file_versions_post(connection, procore_company_id, company_id, file_id, file_version, opts \\ [])

Create company file version Uploads a new version of a specific file in the Company Documents tool. See the Procore Support website articles on Company Documents.

rest_v10_companies_company_id_files_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

Delete company File Delete a specific File.

rest_v10_companies_company_id_files_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show company File Show detailed information about a File.

rest_v10_companies_company_id_files_id_patch(connection, procore_company_id, company_id, id, file, opts \\ [])

Update company File Update a specific File (creates a new file version).

rest_v10_companies_company_id_files_id_send_email_post(connection, procore_company_id, company_id, id, body30, opts \\ [])

Send email for file sharing Send email for file sharing.

rest_v10_companies_company_id_files_post(connection, procore_company_id, company_id, file, opts \\ [])

Create company File Create a new File associated with specific Company.

rest_v10_companies_company_id_folders_get(connection, procore_company_id, company_id, opts \\ [])

List company Folders and Files Return a list of Folders and Files associated with a specific Company.

rest_v10_companies_company_id_folders_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

Delete company Folder Delete the specified Folder by moving it to the recycle bin.

rest_v10_companies_company_id_folders_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show company Folder Show detail on a specific Folder.

rest_v10_companies_company_id_folders_id_patch(connection, procore_company_id, company_id, id, rest_v10_folders_post_request, opts \\ [])

Update company Folder Update a specific Folder.

rest_v10_companies_company_id_folders_post(connection, procore_company_id, company_id, rest_v10_folders_post_request, opts \\ [])

Create company Folder Create a new Folder associated with a specific Company.

Functions

rest_v10_companies_company_id_file_versions_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show company file version Show detailed information about a File Version.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the file version
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.RestV10FileVersionsPost201Response.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_file_versions_post(connection, procore_company_id, company_id, file_id, file_version, opts \\ [])

@spec rest_v10_companies_company_id_file_versions_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10CompaniesCompanyIdFileVersionsPostRequestFileVersion.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10FileVersionsPost201Response.t()}
  | {:ok, Procore.Model.RestV10ProjectsIdFiltersGetDefaultResponse.t()}
  | {:error, Tesla.Env.t()}

Create company file version Uploads a new version of a specific file in the Company Documents tool. See the Procore Support website articles on Company Documents.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
file_id (integer()): The id of the File
file_version (Procore.Model.RestV10CompaniesCompanyIdFileVersionsPostRequestFileVersion.t):
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.RestV10FileVersionsPost201Response.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_files_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

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

Delete company File Delete a specific File.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the File
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_files_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show company File Show detailed information about a File.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the File
opts (keyword): Optional parameters
- :show_latest_version_only (boolean()): Show only latest File Version

Returns

{:ok, Procore.Model.RestV10FilesPost201Response.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_files_id_patch(connection, procore_company_id, company_id, id, file, opts \\ [])

@spec rest_v10_companies_company_id_files_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10FilesIdPatchRequestFile.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10FilesPost201Response.t()}
  | {:ok, Procore.Model.RestV10FilesIdPatch409Response.t()}
  | {:error, Tesla.Env.t()}

Update company File Update a specific File (creates a new file version).

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the File
file (Procore.Model.RestV10FilesIdPatchRequestFile.t):
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.RestV10FilesPost201Response.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_files_id_send_email_post(connection, procore_company_id, company_id, id, body30, opts \\ [])

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

Send email for file sharing Send email for file sharing.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the File
body30 (Body30):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_files_post(connection, procore_company_id, company_id, file, opts \\ [])

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

Create company File Create a new File associated with specific Company.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
file (Procore.Model.RestV10CompaniesCompanyIdFilesPostRequestFile.t):
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.RestV10FilesPost201Response.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_folders_get(connection, procore_company_id, company_id, opts \\ [])

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

List company Folders and Files Return a list of Folders and Files associated with a specific Company.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
opts (keyword): Optional parameters
- :exclude_folders (boolean()): Exclude children Folders from results
- :exclude_files (boolean()): Exclude children Files from results

Returns

{:ok, Procore.Model.Folder.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_folders_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

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

Delete company Folder Delete the specified Folder by moving it to the recycle bin.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the Folder
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_folders_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show company Folder Show detail on a specific Folder.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the Folder
opts (keyword): Optional parameters
- :exclude_folders (boolean()): Exclude children Folders from results
- :exclude_files (boolean()): Exclude children Files from results

Returns

{:ok, Procore.Model.Folder.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_folders_id_patch(connection, procore_company_id, company_id, id, rest_v10_folders_post_request, opts \\ [])

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

Update company Folder Update a specific Folder.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
id (integer()): ID of the Folder
rest_v10_folders_post_request (RestV10FoldersPostRequest):
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.Folder.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_companies_company_id_folders_post(connection, procore_company_id, company_id, rest_v10_folders_post_request, opts \\ [])

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

Create company Folder Create a new Folder associated with a specific Company.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
rest_v10_folders_post_request (RestV10FoldersPostRequest):
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.Folder1.t} on success
{:error, Tesla.Env.t} on failure