Procore.Api.PDFsPDFTemplateConfigsPDFTemplateConfigs (procore_sdk v0.3.0)

API calls for all endpoints tagged PDFsPDFTemplateConfigsPDFTemplateConfigs.

Summary

Functions

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

List PDF template configs Returns a list of PDF template configs

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

Delete PDF Template Config Delete PDF Template Config

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

Return a PDF Template Config Return a PDF Template Config

rest_v10_companies_company_id_pdf_template_configs_id_patch(connection, procore_company_id, company_id, id, body50, opts \\ [])

Update a PDF Template Config Update a PDF Template Config

rest_v10_companies_company_id_pdf_template_configs_id_update_default_project_patch(connection, procore_company_id, company_id, id, body50, opts \\ [])

Update a PDF Template Config Update a PDF Template Config

rest_v10_companies_company_id_pdf_template_configs_post(connection, procore_company_id, company_id, body50, opts \\ [])

Create PDF Template Config Create new PDF Template Config for a specified company

Functions

Link to this function

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

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

List PDF template configs Returns a list of PDF template configs

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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[record_generic_tool_id]" (integer()): Return item(s) with the specified Generic Tool ID.
    • :"filters[project_id]" (integer()): Return item(s) with the Project ID.
    • :"filters[template_name]" (String.t): Return item(s) with provided template_name.
    • :"filters[only_parent]" (boolean()): Return only parent records.
    • :scope (String.t): Return only scoped records.

Returns

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

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

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

Delete PDF Template Config Delete PDF Template Config

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()): PDF Template Configs ID
  • opts (keyword): Optional parameters

Returns

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

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

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

Return a PDF Template Config Return a PDF Template Config

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()): PDF Template Configs ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_pdf_template_configs_id_patch(connection, procore_company_id, company_id, id, body50, opts \\ [])

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

Update a PDF Template Config Update a PDF Template Config

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()): PDF Template Configs ID
  • body50 (Body50):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_pdf_template_configs_id_update_default_project_patch(connection, procore_company_id, company_id, id, body50, opts \\ [])

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

Update a PDF Template Config Update a PDF Template Config

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 PDF Template Config
  • body50 (Body50):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_pdf_template_configs_post(connection, procore_company_id, company_id, body50, opts \\ [])

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

Create PDF Template Config Create new PDF Template Config for a specified 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.
  • body50 (Body50):
  • opts (keyword): Optional parameters

Returns

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