From 1b0e8608fcc45e65377a8213773b838c4f828d7b Mon Sep 17 00:00:00 2001 From: jimbrig Date: Tue, 3 Sep 2024 22:45:56 +0000 Subject: [PATCH] Update documentation --- NAMESPACE | 1 - man/entrata_properties.Rd | 16 ++++++++-------- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 57b2ecb..8a2d2ac 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -99,7 +99,6 @@ importFrom(dplyr,filter) importFrom(dplyr,left_join) importFrom(dplyr,mutate) importFrom(dplyr,pull) -importFrom(dplyr,rename) importFrom(dplyr,rename_with) importFrom(dplyr,select) importFrom(fs,path_temp) diff --git a/man/entrata_properties.Rd b/man/entrata_properties.Rd index 800cccb..b2f69c9 100644 --- a/man/entrata_properties.Rd +++ b/man/entrata_properties.Rd @@ -1,22 +1,20 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/entrata_properties.R -\name{parse_property_res_data} -\alias{parse_property_res_data} +\name{entrata_properties} \alias{entrata_properties} +\alias{parse_property_res_data} \title{Entrata API Properties Endpoint} \usage{ -parse_property_res_data(res_data) - entrata_properties( property_ids = c(NULL), property_lookup_codes = NULL, show_all_status = FALSE, ... ) + +parse_property_res_data(res_data) } \arguments{ -\item{res_data}{Response data from the Entrata API's "getProperties" method.} - \item{property_ids}{Character Vector of Property IDs to include in the request body parameters. If \code{NULL}, all properties will be returned. Default is \code{NULL}.} @@ -91,6 +89,8 @@ around \code{\link[httr2:req_verbose]{req_verbose()}} that uses an integer to co Use \code{\link[httr2:with_verbosity]{with_verbosity()}} to control the verbosity of requests that you can't affect directly.} }} + +\item{res_data}{Response data from the Entrata API's "getProperties" method.} } \value{ A tibble with the property information @@ -98,9 +98,9 @@ A tibble with the property information A tibble with the property information } \description{ -This function parses the response from the Entrata API's "getProperties" method. - This function retrieves properties from the Entrata API. + +This function parses the response from the Entrata API's "getProperties" method. } \section{Functions}{ \itemize{