diff --git a/404.html b/404.html index f4af852..e4abd1c 100644 --- a/404.html +++ b/404.html @@ -1,5 +1,4 @@ - - + @@ -45,7 +44,18 @@
  • Entrata API
    • - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + + @@ -42,37 +79,52 @@

    All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

    -

    [Unreleased]

    +

    [Unreleased] +

    -

    Bug Fixes

    -
    + +
    -

    Configuration

    -
    + +
    -

    Data

    -
    +

    Data +

    + +
    -

    DevOps

    -
    + +
    -

    Documentation

    -
    + +
    -

    Features

    -
    + +
    -

    Refactoring

    -
    + +
    -

    Testing

    - +
    +

    Changelog generated by git-cliff. ***

    + + - + + - + + diff --git a/LICENSE-text.html b/LICENSE-text.html index efdeae1..02ba44a 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,5 +1,24 @@ - -License • gmhleasr + + + + + + +License • gmhleasr + + + + + + + + + + + + + + Skip to contents @@ -15,17 +34,35 @@ + + @@ -39,7 +76,8 @@ 
    Copyright 2024 No Clocks, LLC. All rights reserved.
    - + + - + + - + + diff --git a/articles/decisions.html b/articles/decisions.html index 6ce1672..0de9642 100644 --- a/articles/decisions.html +++ b/articles/decisions.html @@ -1,5 +1,4 @@ - - + @@ -44,7 +43,18 @@
  • Entrata API
    • - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + + @@ -39,14 +76,20 @@

    All vignettes

    -
    Architecture Decision Records
    +
    +
    Architecture Decision Records
    -
    Entrata API
    + +
    Entrata API
    -
    gmhleasr
    + +
    gmhleasr
    -
    - + +
    + + + - + + - + + diff --git a/authors.html b/authors.html index 8eac192..5902582 100644 --- a/authors.html +++ b/authors.html @@ -1,5 +1,24 @@ - -Authors and Citation • gmhleasr + + + + + + +Authors and Citation • gmhleasr + + + + + + + + + + + + + + Skip to contents @@ -15,17 +34,35 @@ + + @@ -38,7 +75,8 @@

    Authors

    -
    + +

    Citation

    @@ -72,7 +111,8 @@

    Citation

    + + - + + - + + diff --git a/index.html b/index.html index d375f9f..0b06381 100644 --- a/index.html +++ b/index.html @@ -1,197 +1,5 @@ - - - - - -Shiny Dashboard for GMH Communities Leasing Data • gmhleasr - - - - - - - - - - - - - - - - - Skip to contents - - -
    -
    -
    -

    -GMH Leasing Package - gmhleasr -

    -
    -

    -Changelog · Documentation · Development Documentation -

    -

    -hexlogo

    -

    -

    -
    -
    -

    [!WARNING] This package is a work in progress.

    -
    -
    -

    [!NOTE] This is an R package for built by No Clocks, LLC for GMH Communities for managing and maintaining a Shiny application to visualize and report on Leasing Data.

    -
    -
    -
    -

    Contents -

    - -
    -
    -

    Badges -

    - - -
    -
    -

    Overview -

    -

    The goal of gmhleasr is to provide a set of tools for GMH Communities Leasing.

    -

    Resources:

    - -
    -
    -

    Installation -

    -

    You can install the development version of gmhleasr like so:

    -
    -# remotes method
-remotes::install_github("noclocks/gmhleasr")
-
-# devtools method
-devtools::install_github("noclocks/gmhleasr")
-
-# pak method
-pak::pkg_install("noclocks/gmhleasr")
    -
    -

    © 2024 No Clocks, LLC

    -
    - -
    -
    - - - -
    - - - - - - - +gmhleasr + + diff --git a/main/404.html b/main/404.html index f4af852..e4abd1c 100644 --- a/main/404.html +++ b/main/404.html @@ -1,5 +1,4 @@ - - + @@ -45,7 +44,18 @@
  • Entrata API
    • - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + + @@ -42,37 +79,52 @@

    All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

    -

    [Unreleased]

    +

    [Unreleased] +

    -

    Bug Fixes

    -
    + +
    -

    Configuration

    -
    + +
    -

    Data

    -
    +

    Data +

    + +
    -

    DevOps

    -
    + +
    -

    Documentation

    -
    + +
    -

    Features

    -
    + +
    -

    Refactoring

    -
    + +
    -

    Testing

    - +
    +

    Changelog generated by git-cliff. ***

    + + - + + - + + diff --git a/main/LICENSE-text.html b/main/LICENSE-text.html index efdeae1..02ba44a 100644 --- a/main/LICENSE-text.html +++ b/main/LICENSE-text.html @@ -1,5 +1,24 @@ - -License • gmhleasr + + + + + + +License • gmhleasr + + + + + + + + + + + + + + Skip to contents @@ -15,17 +34,35 @@ + + @@ -39,7 +76,8 @@ 
    Copyright 2024 No Clocks, LLC. All rights reserved.
    - + + - + + - + + diff --git a/main/articles/decisions.html b/main/articles/decisions.html index 6ce1672..0de9642 100644 --- a/main/articles/decisions.html +++ b/main/articles/decisions.html @@ -1,5 +1,4 @@ - - + @@ -44,7 +43,18 @@
  • Entrata API
    • - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + + @@ -39,14 +76,20 @@

    All vignettes

    -
    Architecture Decision Records
    +
    +
    Architecture Decision Records
    -
    Entrata API
    + +
    Entrata API
    -
    gmhleasr
    + +
    gmhleasr
    -
    - + +
    + + + - + + - + + diff --git a/main/authors.html b/main/authors.html index 8eac192..5902582 100644 --- a/main/authors.html +++ b/main/authors.html @@ -1,5 +1,24 @@ - -Authors and Citation • gmhleasr + + + + + + +Authors and Citation • gmhleasr + + + + + + + + + + + + + + Skip to contents @@ -15,17 +34,35 @@ + + @@ -38,7 +75,8 @@

    Authors

    -
    + +

    Citation

    @@ -72,7 +111,8 @@

    Citation

    + + - + + - + + diff --git a/main/index.html b/main/index.html index c0d0f77..06c2cb2 100644 --- a/main/index.html +++ b/main/index.html @@ -1,5 +1,4 @@ - - + @@ -47,7 +46,18 @@
  • Entrata API
    • - +
  • + +
    + reference +main +develop +deps +articles +.git +
    +
    • + + @@ -52,12 +91,17 @@
    -

    Details

    +

    Details +

    This class ...

    -

    Public fields

    -

    config
    +

    Public fields +

    +

    +
    +
    +
    config

    A list containing the Entrata API configuration, including the username, password, and API base URL.

    @@ -66,15 +110,20 @@

    Public fields -

    Methods

    +

    Methods +

    -

    Public methods

    +

    Public methods +

    -

    -

    Method new()

    + +
    +

    +
    +
    +

    Method new() +

    Initializes the Entrata API manager with the provided configuration. -If no configuration is provided, the default configuration will be used.

    -

    Usage

    -

    EntrataAPI$new(config = config::get("entrata"))

    +If no configuration is provided, the default configuration will be used.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$new(config = config::get("entrata"))
    +

    +
    -

    Arguments

    -

    config
    +

    Arguments +

    +

    +
    +
    +
    config

    A list containing the Entrata API configuration.

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    The initialized Entrata API manager.

    -

    -

    Method send_request()

    -

    Sends a request to the Entrata API.

    -

    Usage

    -

    EntrataAPI$send_request(
+
    +

    +
    +
    +

    Method send_request() +

    +

    Sends a request to the Entrata API.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$send_request(
   endpoint,
   method,
   method_version = "r1",
@@ -116,12 +191,18 @@ 
    Usage
   timeout = NULL,
   progress = FALSE,
   ...
-)

    +)
    +

    +
    -

    Arguments

    -

    endpoint
    +

    Arguments +

    +

    +
    +
    +
    endpoint

    The Entrata API endpoint to call.

    @@ -153,43 +234,77 @@

    Argumentshttr2::req_perform() call.

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    The response object from the API request.

    -

    -

    Method get_reports_list()

    -

    Retrieves the list of available Entrata reports.

    -

    Usage

    -

    EntrataAPI$get_reports_list(latest_only = TRUE)

    +
    +

    +
    +
    +

    Method get_reports_list() +

    +

    Retrieves the list of available Entrata reports.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_reports_list(latest_only = TRUE)
    +

    +
    -

    Arguments

    -

    latest_only
    +

    Arguments +

    +

    +
    +
    +
    latest_only

    Logical, should only the latest version of each report be returned?

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    A tibble containing the report information.

    -

    -

    Method get_report_info()

    -

    Retrieves detailed information for a specific Entrata report.

    -

    Usage

    -

    EntrataAPI$get_report_info(report_name, report_version = "latest")

    +
    +

    +
    +
    +

    Method get_report_info() +

    +

    Retrieves detailed information for a specific Entrata report.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_report_info(report_name, report_version = "latest")
    +

    +
    -

    Arguments

    -

    report_name
    +

    Arguments +

    +

    +
    +
    +
    report_name

    The name of the report to retrieve information for.

    @@ -197,47 +312,81 @@

    Arguments -

    Returns

    +

    Returns +

    A list containing the report name, description, and filters.

    -

    -

    Method get_latest_report_version()

    -

    Retrieves the latest version of a specific Entrata report.

    -

    Usage

    -

    EntrataAPI$get_latest_report_version(report_name)

    +
    +

    +
    +
    +

    Method get_latest_report_version() +

    +

    Retrieves the latest version of a specific Entrata report.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_latest_report_version(report_name)
    +

    +
    -

    Arguments

    -

    report_name
    +

    Arguments +

    +

    +
    +
    +
    report_name

    The name of the report to retrieve the latest version for.

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    The latest version of the report as a character string.

    -

    -

    Method generate_pre_lease_report()

    -

    Generates a pre-lease report in Entrata.

    -

    Usage

    -

    EntrataAPI$generate_pre_lease_report(
+
    +

    +
    +
    +

    Method generate_pre_lease_report() +

    +

    Generates a pre-lease report in Entrata.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$generate_pre_lease_report(
   property_ids,
   period_start = "2024-09-01",
   ...
-)

    +)
    +

    +
    -

    Arguments

    -

    property_ids
    +

    Arguments +

    +

    +
    +
    +
    property_ids

    A vector of property IDs to include in the report.

    @@ -249,39 +398,69 @@

    Arguments -

    Returns

    +

    Returns +

    A list containing the summary and details of the pre-lease report.

    -

    -

    Method get_property_ids()

    -

    Retrieves the list of property IDs from the Entrata API.

    -

    Usage

    -

    EntrataAPI$get_property_ids()

    +
    +

    +
    +
    +

    Method get_property_ids() +

    +

    Retrieves the list of property IDs from the Entrata API.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_property_ids()
    +

    +
    -

    Returns

    +

    Returns +

    A vector of property IDs.

    -

    -

    Method clone()

    -

    The objects of this class are cloneable with this method.

    -

    Usage

    -

    EntrataAPI$clone(deep = FALSE)

    +
    +

    +
    +
    +

    Method clone() +

    +

    The objects of this class are cloneable with this method.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$clone(deep = FALSE)
    +

    +
    -

    Arguments

    -

    deep
    +

    Arguments +

    +

    +
    +
    +
    deep

    Whether to make a deep clone.

    -

    +
    +

    +
    @@ -289,7 +468,8 @@

    Arguments

    + +
    - + +
    - + + diff --git a/main/reference/app_assets.html b/main/reference/app_assets.html index 780ec4d..bb8ab39 100644 --- a/main/reference/app_assets.html +++ b/main/reference/app_assets.html @@ -1,7 +1,28 @@ - -App Assets — app_assets • gmhleasr + + + + + + +App Assets — app_assets • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + +
    @@ -45,44 +84,59 @@
    -

    Usage

    +

    Usage +

    app_assets(...)
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    Additional arguments (currently unused)

    -
    +
    +
    -

    Value

    +

    Value +

    <head> with app assets configured

    -

    Details

    +

    Details +

    This function is used to add the app's favicon, bundle the app's assets, add various <meta> tags, and include necessary external libraries and shiny related packages to the app.

    -

    By default it will perform the following actions:

    + +
    -

    See also

    +

    See also +

    app_favicon(), bundle_app_assets(), shiny::addResourcePath(), shinyjs::useShinyjs(), shinyFeedback::useShinyFeedback(), waiter::useWaiter()

    + + - + + - + + diff --git a/main/reference/app_controlbar.html b/main/reference/app_controlbar.html index f4be21c..e0d44d9 100644 --- a/main/reference/app_controlbar.html +++ b/main/reference/app_controlbar.html @@ -1,5 +1,26 @@ - -App Controlbar Module — app_controlbar • gmhleasr + + + + + + +App Controlbar Module — app_controlbar • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,38 @@
    -

    Usage

    +

    Usage +

    app_controlbar_ui(id)
 
 app_controlbar_server(id)
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    + +
    -

    Value

    +

    Value +

    -
    + + + + - + + - + + diff --git a/main/reference/app_favicon.html b/main/reference/app_favicon.html index 14b3e8e..3ab928c 100644 --- a/main/reference/app_favicon.html +++ b/main/reference/app_favicon.html @@ -1,5 +1,26 @@ - -App Favicon — app_favicon • gmhleasr + + + + + + +App Favicon — app_favicon • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,26 +81,33 @@
    -

    Usage

    +

    Usage +

    app_favicon(path = app_sys("favicon.ico"))
    -

    Arguments

    +

    Arguments +

    -
    path
    +
    +
    path +

    The path to the favicon file. See details for more information on how to set this path. Default is www/images/favicons/favicon.ico, which is specific to this package.

    -
    + +
    -

    Value

    +

    Value +

    <head> with necessary favicon declaration

    -

    Details

    +

    Details +

    The path to the favicon file should utilize the pre-configured resourcePath, i.e. "www/*", to ensure the favicon is accessible to the app.

    The www prefixed path is instantiated in the app_assets() function which @@ -69,7 +115,8 @@

    Details

    + + - + + - + + diff --git a/main/reference/app_footer.html b/main/reference/app_footer.html index 74e50f6..a5aa21d 100644 --- a/main/reference/app_footer.html +++ b/main/reference/app_footer.html @@ -1,5 +1,26 @@ - -App Footer Module — app_footer • gmhleasr + + + + + + +App Footer Module — app_footer • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,38 @@
    -

    Usage

    +

    Usage +

    app_footer_ui(id)
 
 app_footer_server(id)
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    + +
    -

    Value

    +

    Value +

    -
    + + + + - + + - + + diff --git a/main/reference/app_globals.html b/main/reference/app_globals.html index a427c13..000860a 100644 --- a/main/reference/app_globals.html +++ b/main/reference/app_globals.html @@ -1,5 +1,26 @@ - -App Global Variables — app_globals • gmhleasr + + + + + + +App Global Variables — app_globals • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    set_app_global(name, value)
 
 get_app_globals()
@@ -51,28 +91,37 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    name
    +
    +
    name +

    A character string.

    -
    value
    +
    value +

    A value.

    -
    + +
    -

    Value

    +

    Value +

    -
    + + + + - + + - + + diff --git a/main/reference/app_header.html b/main/reference/app_header.html index 73828d5..bf02412 100644 --- a/main/reference/app_header.html +++ b/main/reference/app_header.html @@ -1,5 +1,26 @@ - -App Header Module — app_header • gmhleasr + + + + + + +App Header Module — app_header • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,44 +81,61 @@
    -

    Usage

    +

    Usage +

    app_header_ui(id, title = "GMH Leasing Dashboard", ...)
 
 app_header_server(id, app_globals = NULL)
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    title
    +
    title +

    The title of the dashboard

    -
    + +
    -

    Value

    +

    Value +

    -
    + +
    -

    Details

    -

    The module includes both the UI and server functions for the header:

    + + + + - + + - + + diff --git a/main/reference/app_logo.html b/main/reference/app_logo.html index bf51f46..4ce8ec0 100644 --- a/main/reference/app_logo.html +++ b/main/reference/app_logo.html @@ -1,5 +1,26 @@ - -App Logo — app_logo • gmhleasr + + + + + + +App Logo — app_logo • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    app_logo(
   path = "public/images/logos/gmh-logo.svg",
   alt = "GMH Communities",
@@ -51,28 +91,36 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    path
    +
    +
    path +

    Path to the logo file

    -
    alt
    +
    alt +

    Alt text for the logo

    -
    style
    +
    style +

    CSS style for the logo

    -
    + +
    -

    Value

    +

    Value +

    HTML image tag with the provided logo

    + +
    @@ -83,11 +131,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/app_meta.html b/main/reference/app_meta.html index 7bf6123..c51a398 100644 --- a/main/reference/app_meta.html +++ b/main/reference/app_meta.html @@ -1,5 +1,26 @@ - -App <meta> — app_meta • gmhleasr + + + + + + +App <meta> — app_meta • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,24 +36,43 @@ + +
    -

    App <meta>

    +

    App <meta> +

    Source: R/app_assets.R
    app_meta.Rd
    @@ -42,7 +82,8 @@
    -

    Usage

    +

    Usage +

    app_meta(
   package = "gmhleasr",
   app_name = "GMH Leasing Dashboard",
@@ -66,93 +107,117 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    package
    +
    +
    package +

    Name of the package

    -
    app_name
    +
    app_name +

    Name of the app

    -
    app_version
    +
    app_version +

    Version of the app

    -
    description
    +
    description +

    Description of the app

    -
    url
    +
    url +

    URL of the app

    -
    theme_color
    +
    theme_color +

    Theme color of the app

    -
    robots
    +
    robots +

    Robots.txt policy

    -
    generator
    +
    generator +

    Generator of the app

    -
    subject
    +
    subject +

    Subject of the app

    -
    rating
    +
    rating +

    Rating of the app

    -
    referrer
    +
    referrer +

    Referrer policy

    -
    csp
    +
    csp +

    Content Security Policy

    -
    image
    +
    image +

    Image URL

    -
    image_alt
    +
    image_alt +

    Image alt text

    -
    twitter_creator
    +
    twitter_creator +

    Twitter creator

    -
    twitter_card_type
    +
    twitter_card_type +

    Twitter card type

    -
    twitter_site
    +
    twitter_site +

    Twitter site

    -
    ...
    +
    ... +

    Additional arguments (currently unused)

    -
    + +
    -

    Value

    +

    Value +

    Raw <meta> tags via metathis::meta() (to be passed into the app's <head>)

    -

    See also

    +

    See also +

    metathis::meta()

    + + - + + - + + diff --git a/main/reference/app_server.html b/main/reference/app_server.html index 0f02541..19fc9cf 100644 --- a/main/reference/app_server.html +++ b/main/reference/app_server.html @@ -1,5 +1,26 @@ - -App Server — app_server • gmhleasr + + + + + + +App Server — app_server • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,21 +81,27 @@
    -

    Usage

    +

    Usage +

    app_server(input, output, session)
    -

    Arguments

    +

    Arguments +

    -
    input, output, session
    +
    +
    input, output, session +

    Internal parameters for shiny.

    -
    + + + +
    @@ -67,11 +112,12 @@

    Argumentspkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/app_sidebar.html b/main/reference/app_sidebar.html index ce19915..67a69f1 100644 --- a/main/reference/app_sidebar.html +++ b/main/reference/app_sidebar.html @@ -1,7 +1,28 @@ - -App Sidebar Module — app_sidebar • gmhleasr + + + + + + +App Sidebar Module — app_sidebar • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    app_sidebar_ui(id)
 
 app_sidebar_server(id, app_globals = NULL)
@@ -56,24 +96,34 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    + +
    -

    Value

    +

    Value +

    -

    • app_sidebar_ui(): A bs4Dash sidebar UI element

      • +
        +

      • app_sidebar_ui(): A bs4Dash sidebar UI element

      • app_sidebar_server(): Server logic for the sidebar

        • -

      • app_sidebar_ui(): A bs4Dash sidebar UI element

        • +
      +
        +

      • app_sidebar_ui(): A bs4Dash sidebar UI element

      • app_sidebar_server(): Server logic for the sidebar

        • -
    + + + +
    @@ -84,11 +134,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/app_sys.html b/main/reference/app_sys.html index b70ff5d..6ed6b88 100644 --- a/main/reference/app_sys.html +++ b/main/reference/app_sys.html @@ -1,5 +1,26 @@ - -App System File — app_sys • gmhleasr + + + + + + +App System File — app_sys • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    app_sys(...)
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    Path components.

    -
    + +
    -

    Value

    +

    Value +

    Path to file in package.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/app_ui.html b/main/reference/app_ui.html index 97b8387..44d1728 100644 --- a/main/reference/app_ui.html +++ b/main/reference/app_ui.html @@ -1,5 +1,26 @@ - -App User Interface — app_ui • gmhleasr + + + + + + +App User Interface — app_ui • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    app_ui(request)
    -

    Arguments

    +

    Arguments +

    -
    request
    +
    +
    request +

    Internal parameter for {shiny}.

    -
    + +
    -

    Value

    +

    Value +

    A {shiny} UI object.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/apply_xl_styles.html b/main/reference/apply_xl_styles.html index ff49645..710a632 100644 --- a/main/reference/apply_xl_styles.html +++ b/main/reference/apply_xl_styles.html @@ -1,7 +1,28 @@ - -Apply Styles to Cells in an Excel Sheet — apply_xl_styles • gmhleasr + + + + + + +Apply Styles to Cells in an Excel Sheet — apply_xl_styles • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    apply_xl_styles(
   wb,
   sheet_number,
@@ -74,104 +114,131 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    wb
    +
    +
    wb +

    A workbook object from openxlsx.

    -
    sheet_number
    +
    sheet_number +

    Numeric or character identifier for the sheet.

    -
    rows
    +
    rows +

    The row range to apply the style to.

    -
    cols
    +
    cols +

    The column number to apply the style to.

    -
    font_name
    +
    font_name +

    Font name.

    -
    font_size
    +
    font_size +

    Font size.

    -
    font_color
    +
    font_color +

    Font color.

    -
    number_format
    +
    number_format +

    Number format.

    -
    border
    +
    border +

    Border style.

    -
    border_color
    +
    border_color +

    Border color.

    -
    border_style
    +
    border_style +

    Border style.

    -
    bg_fill
    +
    bg_fill +

    Background fill color.

    -
    fg_fill
    +
    fg_fill +

    Foreground fill color.

    -
    halign
    +
    halign +

    Horizontal alignment.

    -
    valign
    +
    valign +

    Vertical alignment.

    -
    text_decoration
    +
    text_decoration +

    Text decoration.

    -
    wrap_text
    +
    wrap_text +

    Wrap text.

    -
    text_rotation
    +
    text_rotation +

    Text rotation angle.

    -
    indent
    +
    indent +

    Indentation level.

    -
    locked
    +
    locked +

    Lock cells.

    -
    hidden
    +
    hidden +

    Hide cells.

    -
    ...
    +
    ... +

    Additional arguments.

    -
    + +
    -

    Value

    +

    Value +

    NULL. The function modifies the workbook object in place.

    + +
    @@ -182,11 +249,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/derive_req_body.html b/main/reference/derive_req_body.html index ee74c97..e7adc5a 100644 --- a/main/reference/derive_req_body.html +++ b/main/reference/derive_req_body.html @@ -1,5 +1,26 @@ - -Derive Entrata API Request Body — derive_req_body • gmhleasr + + + + + + +Derive Entrata API Request Body — derive_req_body • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,33 +81,42 @@
    -

    Usage

    +

    Usage +

    derive_req_body(method, method_version, method_params)
    -

    Arguments

    +

    Arguments +

    -
    method
    +
    +
    method +

    The Entrata API method to use.

    -
    method_version
    +
    method_version +

    The version of the API method to use.

    -
    method_params
    +
    method_params +

    A named list of parameters to include in the request body.

    -
    + +
    -

    Value

    +

    Value +

    A list representing the request body.

    + +
    @@ -79,11 +127,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/display_phone_number.html b/main/reference/display_phone_number.html index 99af4f7..fae54e4 100644 --- a/main/reference/display_phone_number.html +++ b/main/reference/display_phone_number.html @@ -1,5 +1,26 @@ - -Displau Phone Number — display_phone_number • gmhleasr + + + + + + +Displau Phone Number — display_phone_number • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,31 +81,39 @@
    -

    Usage

    +

    Usage +

    display_phone_number(phone)
    -

    Arguments

    +

    Arguments +

    -
    phone
    +
    +
    phone +

    String representing a phone number.

    -
    + +
    -

    Value

    +

    Value +

    Formatted string of the phone number.

    -

    Examples

    +

    Examples +

    display_phone_number("5555555555")
 #> [1] "(555) 555-5555"
    + +
    @@ -77,11 +124,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/entrata.html b/main/reference/entrata.html index 3a64810..9d4f6a8 100644 --- a/main/reference/entrata.html +++ b/main/reference/entrata.html @@ -1,11 +1,32 @@ - -Entrata API Request — entrata • gmhleasr + + + + + +Entrata API Request — entrata • gmhleasr + + + + + + + + + + + + + +create requests to the Entrata API."> + + + Skip to contents @@ -21,17 +42,35 @@ + + @@ -51,7 +90,8 @@
    -

    Usage

    +

    Usage +

    entrata(
   endpoint = NULL,
   method = NULL,
@@ -71,15 +111,19 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    endpoint
    +
    +
    endpoint +

    Entrata API Endpoint to send the request to. Default is NULL. See details for the available endpoints.

    -
    method
    +
    method +

    Entrata API Method to use in the request. Not to be confused with the HTTP request method (i.e. GET, POST), this method must be a method that is available in the Entrata API for the @@ -90,14 +134,16 @@

    Argumentsmethod_version +
    method_version +

    Entrata API Method Version to use in the request. Default is "r1". Some endpoints have multiple versions of the same method. The version should be provided as a string. See details for more information on the structure of the request and available versions by endpoint method.

    -
    method_params
    +
    method_params +

    List of parameters to use in the request body's "method" object. Default is an empty list. The parameters should be provided as a named list where the names are the parameter names and the values are the @@ -108,77 +154,95 @@

    Argumentsua +
    ua +

    User Agent string to use in the request. Default is to use user_agent().

    -
    verbosity
    -

    How much information to print? This is a wrapper -around req_verbose() that uses an integer to control verbosity:

    • 0: no output

      • +
      verbosity +
      +
      +

      How much information to print? This is a wrapper +around req_verbose() that uses an integer to control verbosity:

      +
        +

      • 0: no output

      • 1: show headers

      • 2: show headers and bodies

      • 3: show headers, bodies, and curl status messages.

        • -

      Use with_verbosity() to control the verbosity of requests that -you can't affect directly.

      +
    +

    Use with_verbosity() to control the verbosity of requests that +you can't affect directly.

    +
    -
    perform
    +
    perform +

    Logical value indicating whether to perform the request. Default is FALSE. If FALSE, the function will return the request object without performing the request. If TRUE, the function will perform the request and return the response object.

    -
    extract
    +
    extract +

    Logical value indicating whether to extract the response. Default is the value of perform. If TRUE, the function will extract the response object and return it. If FALSE, the function will return the response object as is.

    -
    enable_retry
    +
    enable_retry +

    Logical value indicating whether to enable request retry. Default is FALSE. If TRUE, the function will enable request retry with the default retry settings. If FALSE, the function will not enable request retry.

    -
    timeout
    +
    timeout +

    Numeric value indicating the request timeout in seconds. Default is NULL. If provided, the function will set the request timeout to the provided value in seconds.

    -
    dry_run
    +
    dry_run +

    Logical value indicating whether to perform a dry run of the request. Default is FALSE. If TRUE, the function will perform a dry run of the request before performing the actual request (or if perform is not set, will return the request object without performing the request).

    -
    progress
    +
    progress +

    Logical value indicating whether to show progress of the request. Only useful for long running requests. Default is FALSE. If TRUE, the function will show the progress of the request.

    -
    config
    +
    config +

    Entrata API Configuration Values as a list. Default is to use config::get("entrata") to retrieve the configuration values from a config.yml configuration file. The configuration values should include the following keys: username, password, and base_url. See details.

    -
    ...
    +
    ... +

    Additional arguments to pass to the request object.

    -

    + +
    -

    Value

    +

    Value +

    httr2::request() object with the Entrata API request.

    -

    Details

    +

    Details +

    This function creates a request to the Entrata API using the httr2 package.

    Specifically, the function creates an HTTP POST request to the Entrata API by appending to the request's URL path the provided endpoint, assigning the @@ -186,11 +250,17 @@

    Detailsmethod name and params parameters. See below for details.

    This is the raw format of the base template request:

    -

    +

    +
    +
    +

    +

    where the Authorization header is a Basic authentication header with the provided username and password and the body is a JSON encoded data object using the provided method and params:

    -

    {
+
    
+
    
+
    {
 "data": {
   "auth": {
     "type": [
@@ -217,19 +287,25 @@ 
    Details    }
   }
 }
-}
    
+}
    +

    +

    -

    See also

    -

    Entrata API Documentation

    +

    See also +

    +
    +

    Entrata API Documentation

    MDN Web Docs: HTTP Caching

    httr2::req_auth_basic(), httr2::request(), httr2::req_body_json(), httr2::req_headers(), httr2::req_template(), httr2::req_url_path_append(), -httr2::req_method()

    +httr2::req_method()

    +
    + + - + + - + + diff --git a/main/reference/entrata_internal.html b/main/reference/entrata_internal.html index 83a7d31..307f11a 100644 --- a/main/reference/entrata_internal.html +++ b/main/reference/entrata_internal.html @@ -1,15 +1,36 @@ - -Entrata API Internal Helpers — entrata_internal • gmhleasr + + + + + +Entrata API Internal Helpers — entrata_internal • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -25,17 +46,35 @@ + + @@ -48,41 +87,53 @@
    -

    Internal helper functions for the Entrata API request functions.

    • validate_entrata_endpoint_method(): Validate Entrata API Endpoint and Method

      • +

      Internal helper functions for the Entrata API request functions.

      +
        +

      • validate_entrata_endpoint_method(): Validate Entrata API Endpoint and Method

      • validate_entrata_method_params(): Validate Entrata API Method Parameters

      • get_default_method(): Get Default Method by Endpoint

        • -
    + +
    -

    Usage

    +

    Usage +

    validate_entrata_endpoint_method(endpoint, method)
 
 get_default_method(endpoint)
    -

    Arguments

    +

    Arguments +

    -
    endpoint
    +
    +
    endpoint +

    Entrata API Endpoint to validate.

    -
    method
    +
    method +

    Entrata API Method to validate.

    -
    method_params
    +
    method_params +

    List of parameters to validate.

    -
    + +
    -

    See also

    +

    See also +

    Entrata API Documentation

    + + - + + - + + diff --git a/main/reference/entrata_leases.html b/main/reference/entrata_leases.html index cf1a4cc..5f8c349 100644 --- a/main/reference/entrata_leases.html +++ b/main/reference/entrata_leases.html @@ -1,5 +1,26 @@ - -Entrata Leases — entrata_leases • gmhleasr + + + + + + +Entrata Leases — entrata_leases • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    entrata_leases(
   property_id,
   application_id = as.integer(NULL),
@@ -70,108 +110,136 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    application_id
    +
    +
    application_id +

    Optional. Integer value of the application ID

    -
    customer_id
    +
    customer_id +

    Optional. Integer value of the customer ID

    -
    lease_status_type_ids
    +
    lease_status_type_ids +

    Optional. Integer vector of lease status type IDs

    -
    lease_ids
    +
    lease_ids +

    Optional. Integer vector of lease IDs

    -
    scheduled_ar_code_ids
    +
    scheduled_ar_code_ids +

    Optional. Integer vector of scheduled AR code IDs

    -
    unit_number
    +
    unit_number +

    Optional. Character value of the unit number

    -
    building_name
    +
    building_name +

    Optional. Character value of the building name

    -
    move_in_date_from
    +
    move_in_date_from +

    Optional. Date value of the move-in date from

    -
    move_in_date_to
    +
    move_in_date_to +

    Optional. Date value of the move-in date to

    -
    lease_expiring_date_from
    +
    lease_expiring_date_from +

    Optional. Date value of the lease expiring from

    -
    lease_expiring_date_to
    +
    lease_expiring_date_to +

    Optional. Date value of the lease expiring to

    -
    move_out_date_from
    +
    move_out_date_from +

    Optional. Date value of the move-out date from

    -
    move_out_date_to
    +
    move_out_date_to +

    Optional. Date value of the move-out date to

    -
    include_other_income_leases
    +
    include_other_income_leases +

    Optional. Logical value to include other income leases

    -
    resident_friendly_mode
    +
    resident_friendly_mode +

    Optional. Logical value to include resident friendly mode

    -
    include_lease_history
    +
    include_lease_history +

    Optional. Logical value to include lease history information

    -
    include_ar_transactions
    +
    include_ar_transactions +

    Optional. Logical value to include AR transactions

    -
    pagination_page_number
    +
    pagination_page_number +

    Pagination page number. Default is 1

    -
    pagination_page_size
    +
    pagination_page_size +

    Number of items per page. Default is 500

    - +

    Logical value to include pagination links in the response. Default is FALSE

    -
    ...
    +
    ... +

    Additional parameters to pass to the request

    -
    property_ids
    +
    property_ids +

    Required. Integer vector of property IDs

    -
    + +
    -

    Value

    +

    Value +

    Parsed Response Body Content as a tibble with leases data.

    -

    See also

    +

    See also +

    parse_entrata_leases()

    + + - + + - + + diff --git a/main/reference/entrata_pre_lease_report.html b/main/reference/entrata_pre_lease_report.html index 06c2c42..da7e115 100644 --- a/main/reference/entrata_pre_lease_report.html +++ b/main/reference/entrata_pre_lease_report.html @@ -1,13 +1,34 @@ - -Entrata Pre-Lease Report — entrata_pre_lease_report • gmhleasr + + + + + +Entrata Pre-Lease Report — entrata_pre_lease_report • gmhleasr + + + + + + + + + + + + + +data for the summary and details report "subtotals"."> + + + Skip to contents @@ -23,17 +44,35 @@ + + @@ -54,7 +93,8 @@
    -

    Usage

    +

    Usage +

    entrata_pre_lease_report(
   property_ids = get_property_ids_filter_param(),
   leasing_period_start_date = get_pre_lease_period_start_date(),
@@ -76,96 +116,118 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    property_ids
    +
    +
    property_ids +

    A vector of property IDs to include in the report. Defaults to get_property_ids_filter_param(), which returns all available property IDs. The actual values passed to the request need to be unnamed and flattened to a character vector or single level list.

    -
    leasing_period_start_date
    +
    leasing_period_start_date +

    The start date of the leasing period. Defaults to the result of get_pre_lease_period_start_date() which returns the date for September 1st of either the current year or the next year, depending on the current date. The date should be formatted as "m/d/Y".

    -
    leasing_period_type
    +
    leasing_period_type +

    The type of leasing period. Defaults to "today". Can be one of "today" or "date".

    -
    summarize_by
    +
    summarize_by +

    The method of summarizing the report. Defaults to "property". Can be one of "property", "unit_type", "floorplan_name", or "do_not_summarize".

    -
    group_by
    +
    group_by +

    The method of grouping the report. Defaults to "do_not_group". Can be one of "do_not_group", "unit_type", "floorplan_name", or "lease_term".

    -
    consider_pre_leased_on
    +
    consider_pre_leased_on +

    The method of considering pre-leased units. Defaults to "33". Can be one of "32", "33", "34", "41", "42", "43", or "44", which (I believe) represent the various leasing occupancy types.

    -
    charge_code_detail
    +
    charge_code_detail +

    The method of showing charge code details. Defaults to "0". If set to "1", the report will show charge code details.

    -
    space_options
    +
    space_options +

    The method of showing space options. Defaults to "do_not_show". Can be one of "do_not_show", "show_preferred", or "show_actual".

    -
    additional_units_shown
    +
    additional_units_shown +

    The method of showing additional units. Defaults to "available". Can be one of "available" or "excluded".

    -
    combine_unit_spaces_with_same_lease
    +
    combine_unit_spaces_with_same_lease +

    The method of combining unit spaces with the same lease. Defaults to "0". If set to "1", the report will combine unit spaces with the same lease.

    -
    consolidate_by
    +
    consolidate_by +

    The method of consolidating the report. Defaults to "no_consolidation". Can be one of "no_consolidation", "consolidate_all_properties", or "consolidate_by_property_groups".

    -
    arrange_by_property
    +
    arrange_by_property +

    The method of arranging the report by property. Defaults to "0". If set to "1", the report will be arranged by property.

    -
    subtotals
    +
    subtotals +

    A list of subtotals to include in the report. Defaults to "summary" and "details". Can be one or both of "summary" and "details".

    -
    yoy
    +
    yoy +

    The method of showing year-over-year data. Defaults to "1". If set to "0", the report will not show year-over-year data.

    -
    ...
    +
    ... +

    Additional parameters for the API request passed on to the downstream entrata() function.

    -
    + +
    -

    Value

    +

    Value +

    A list with the extracted, un-processed report data.

    -

    Details

    -

    The function performs the following steps:

    1. Get the latest report version for the "pre_lease" report using the +

      Details +

      +

      The function performs the following steps:

      +
        +

      1. Get the latest report version for the "pre_lease" report using the get_latest_report_version() function.

      2. Prepare the property IDs, leasing period start date, and period method parameters.

      3. Validate the input parameters for summarize_by, group_by, consider_pre_leased_on, @@ -181,15 +243,20 @@

        Details

      4. Return a list with the extracted, un-processed report data for further downstream processing or analysis.

        5. -
    + +
    -

    See also

    -

    Entrata API Documentation

    -

    get_latest_report_version(), get_property_ids_filter_param(), get_pre_lease_period_start_date()

    +

    See also +

    +
    +

    Entrata API Documentation

    +

    get_latest_report_version(), get_property_ids_filter_param(), get_pre_lease_period_start_date()

    +
    + + - + + - + + diff --git a/main/reference/entrata_properties.html b/main/reference/entrata_properties.html index 03de7e0..29f5bb7 100644 --- a/main/reference/entrata_properties.html +++ b/main/reference/entrata_properties.html @@ -1,7 +1,28 @@ - -Entrata API Properties Endpoint — entrata_properties • gmhleasr + + + + + + +Entrata API Properties Endpoint — entrata_properties • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    entrata_properties(
   property_ids = c(NULL),
   property_lookup_codes = NULL,
@@ -57,27 +97,36 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    property_ids
    +
    +
    property_ids +

    Character Vector of Property IDs to include in the request body parameters. If NULL, all properties will be returned. Default is NULL.

    -
    property_lookup_codes
    +
    property_lookup_codes +

    Character string with a "Property Lookup Code" to include in the request's body. Default is NULL.

    -
    show_all_status
    +
    show_all_status +

    Logical: if TRUE will return all properties, regardless of status. Default is FALSE.

    -
    ...
    -

    Arguments passed on to entrata

    endpoint
    +
    ... +
    +
    +

    Arguments passed on to entrata

    +
    +
    endpoint

    Entrata API Endpoint to send the request to. Default is NULL. See details for the available endpoints.

    @@ -151,45 +200,62 @@

    Argumentsreq_verbose() that uses an integer to control verbosity:

    • 0: no output

      • +
      +

      How much information to print? This is a wrapper +around req_verbose() that uses an integer to control verbosity:

      +
        +

      • 0: no output

      • 1: show headers

      • 2: show headers and bodies

      • 3: show headers, bodies, and curl status messages.

        • -

      Use with_verbosity() to control the verbosity of requests that -you can't affect directly.

      +
    +

    Use with_verbosity() to control the verbosity of requests that +you can't affect directly.

    +

    -
    +
    + -
    res_data
    +
    res_data +

    Response data from the Entrata API's "getProperties" method.

    -
    + +
    -

    Value

    +

    Value +

    A tibble with the property information

    A tibble with the property information

    -

    Functions

    +

    Functions +

    -

    • parse_property_res_data(): Parse Entrata Properties Response Data

      • -
    +
      +

    • parse_property_res_data(): Parse Entrata Properties Response Data

      • +
    +
    -

    See also

    -

    entrata()

    -

    https://gmhcommunities.entrata.com/api/v1/documentation/getProperties

    +

    See also +

    +
    +

    entrata()

    +

    https://gmhcommunities.entrata.com/api/v1/documentation/getProperties

    +
    -

    Examples

    +

    Examples +
    + +
    @@ -200,11 +266,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/entrata_request_validation.html b/main/reference/entrata_request_validation.html index c62d3a8..9a40210 100644 --- a/main/reference/entrata_request_validation.html +++ b/main/reference/entrata_request_validation.html @@ -1,17 +1,38 @@ - -Entrata API Request Validations — entrata_request_validation • gmhleasr + + + + + +Entrata API Request Validations — entrata_request_validation • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -27,17 +48,35 @@ + + @@ -50,14 +89,18 @@
    -

    Helper functions for validating Entrata API requests.

    • validate_entrata_request_endpoint(): Validate Entrata API Endpoint

      • +

      Helper functions for validating Entrata API requests.

      +
        +

      • validate_entrata_request_endpoint(): Validate Entrata API Endpoint

      • validate_entrata_request_endpoint_method(): Validate Entrata API Endpoint's Method

      • validate_entrata_request_method_params(): Validate Entrata API Endpoint Method's Parameters

      • validate_entrata_request(): Validate Entrata API Request by performing all validation checks

        • -
    + +
    -

    Usage

    +

    Usage +

    validate_entrata_request_endpoint(
   endpoint,
   arg = rlang::caller_arg(endpoint),
@@ -95,49 +138,61 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    endpoint
    +
    +
    endpoint +

    Entrata API Endpoint to validate. Must be one of the available Entrata API endpoints.

    -
    arg, arg_endpoint, arg_method, arg_method_params
    +
    arg, arg_endpoint, arg_method, arg_method_params +

    Arguments to use for error messages.

    -
    call
    +
    call +

    Environment to use for error messages. Defaults to the calling environment.

    -
    method
    +
    method +

    Entrata API Endpoint Method to validate. Should be one of the available methods for the specified endpoint.

    -
    method_params
    +
    method_params +

    List of method parameters to validate. Should be a named list corresponding the the specific endpoint/method's available and required parameters.

    -
    ...
    +
    ... +

    Additional arguments to pass to the underlying validation functions.

    -
    + +
    -

    Value

    +

    Value +

    All validation functions are used for their side effects have no return values, except for validate_entrata_request() which will return TRUE if validations pass.

    -

    See also

    +

    See also +

    Entrata API Documentation

    + + - + + - + + diff --git a/main/reference/flucol.html b/main/reference/flucol.html index 13aa49d..821bd24 100644 --- a/main/reference/flucol.html +++ b/main/reference/flucol.html @@ -1,5 +1,26 @@ - -Fluid Column - Shiny fluidRow + Column — flucol • gmhleasr + + + + + + +Fluid Column - Shiny fluidRow + Column — flucol • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,33 +81,42 @@
    -

    Usage

    +

    Usage +

    flucol(..., width = 12, offset = 0)
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    elements to include within the flucol

    -
    width
    +
    width +

    width

    -
    offset
    +
    offset +

    offset

    -
    + +
    -

    Value

    +

    Value +

    A column wrapped in fluidRow

    + +
    @@ -79,11 +127,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/get_app_config.html b/main/reference/get_app_config.html index 45397ad..bc34c20 100644 --- a/main/reference/get_app_config.html +++ b/main/reference/get_app_config.html @@ -1,5 +1,26 @@ - -Get App Config — get_app_config • gmhleasr + + + + + + +Get App Config — get_app_config • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    get_app_config(
   value,
   config = Sys.getenv("APP_CONFIG_ACTIVE", Sys.getenv("R_CONFIG_ACTIVE", "default")),
@@ -53,44 +93,54 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    value
    +
    +
    value +

    Name of value (NULL to read all values)

    -
    config
    +
    config +

    Name of configuration to read from. Defaults to the value of the R_CONFIG_ACTIVE environment variable ("default" if the variable does not exist).

    -
    use_parent
    +
    use_parent +

    TRUE to scan parent directories for configuration files if the specified config file isn't found.

    -
    file
    +
    file +

    Configuration file to read from (defaults to "config.yml"). If the file isn't found at the location specified then parent directories are searched for a file of the same name.

    -
    + +
    -

    Value

    +

    Value +

    The value of the configuration key.

    -

    Details

    +

    Details +

    The only difference in this function and config::get() is that this function sets the default value of the file argument to the app's config.yml file and attempts to set the config argument to the value of the APP_CONFIG_ACTIVE.

    + + - + + - + + diff --git a/main/reference/get_entrata_report_info.html b/main/reference/get_entrata_report_info.html index 707349a..bc36150 100644 --- a/main/reference/get_entrata_report_info.html +++ b/main/reference/get_entrata_report_info.html @@ -1,7 +1,28 @@ - -Get Entrata Report Info — get_entrata_report_info • gmhleasr + + + + + + +Get Entrata Report Info — get_entrata_report_info • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,30 +84,38 @@
    -

    Usage

    +

    Usage +

    get_entrata_report_info(report_name, report_version = "latest")
    -

    Arguments

    +

    Arguments +

    -
    report_name
    +
    +
    report_name +

    A character string representing the name of the report.

    -
    report_version
    +
    report_version +

    A character string representing the version of the report. Defaults to "latest".

    -
    + +
    -

    Value

    +

    Value +

    A list containing report name, description, and filters.

    + +
    @@ -79,11 +126,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/get_entrata_reports_list.html b/main/reference/get_entrata_reports_list.html index 0520138..beb02f1 100644 --- a/main/reference/get_entrata_reports_list.html +++ b/main/reference/get_entrata_reports_list.html @@ -1,7 +1,28 @@ - -Get Entrata Reports List — get_entrata_reports_list • gmhleasr + + + + + + +Get Entrata Reports List — get_entrata_reports_list • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,27 +84,34 @@
    -

    Usage

    +

    Usage +

    get_entrata_reports_list(latest_only = TRUE)
    -

    Arguments

    +

    Arguments +

    -
    latest_only
    +
    +
    latest_only +

    Logical, if TRUE (default), returns only the latest version of each report.

    -
    + +
    -

    Value

    +

    Value +

    A tibble containing report information including report name, ID, system name, and version.

    + +
    @@ -76,11 +122,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/get_latest_report_version.html b/main/reference/get_latest_report_version.html index ce2e341..ccf66d8 100644 --- a/main/reference/get_latest_report_version.html +++ b/main/reference/get_latest_report_version.html @@ -1,7 +1,28 @@ - -Get Latest Report Version — get_latest_report_version • gmhleasr + + + + + + +Get Latest Report Version — get_latest_report_version • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,25 +84,32 @@
    -

    Usage

    +

    Usage +

    get_latest_report_version(report_name)
    -

    Arguments

    +

    Arguments +

    -
    report_name
    +
    +
    report_name +

    A character string representing the name of the report.

    -
    + +
    -

    Value

    +

    Value +

    A character string representing the latest version of the report.

    + +
    @@ -74,11 +120,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/get_properties.html b/main/reference/get_properties.html index 6423636..55e50de 100644 --- a/main/reference/get_properties.html +++ b/main/reference/get_properties.html @@ -1,5 +1,26 @@ - -Get Entrata Properties — get_properties • gmhleasr + + + + + + +Get Entrata Properties — get_properties • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    get_properties(
   api,
   property_ids = NULL,
@@ -53,36 +93,46 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    api
    +
    +
    api +

    An instance of the EntrataAPI class.

    -
    property_ids
    +
    property_ids +

    A vector of property IDs to retrieve.

    -
    property_lookup_codes
    +
    property_lookup_codes +

    A vector of property lookup codes to retrieve.

    -
    show_all_status
    +
    show_all_status +

    Logical. Whether to return all properties regardless of status.

    -
    ...
    +
    ... +

    Additional parameters to pass to the underlying API request.

    -
    + +
    -

    Value

    +

    Value +

    A data frame with the retrieved property information.

    + +
    @@ -93,11 +143,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/get_property_ids_filter_param.html b/main/reference/get_property_ids_filter_param.html index edd45bc..20c2ddd 100644 --- a/main/reference/get_property_ids_filter_param.html +++ b/main/reference/get_property_ids_filter_param.html @@ -1,7 +1,28 @@ - -Get Property IDs Filter Parameter — get_property_ids_filter_param • gmhleasr + + + + + + +Get Property IDs Filter Parameter — get_property_ids_filter_param • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,17 +84,20 @@
    -

    Usage

    +

    Usage +

    get_property_ids_filter_param()
    -

    Value

    +

    Value +

    A list of character strings representing property IDs.

    + +
    @@ -66,11 +108,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/gmhleasr-package.html b/main/reference/gmhleasr-package.html index 903baa7..a0fd4ed 100644 --- a/main/reference/gmhleasr-package.html +++ b/main/reference/gmhleasr-package.html @@ -1,7 +1,28 @@ - -gmhleasr: Shiny Dashboard for GMH Communities Leasing Data — gmhleasr-package • gmhleasr + + + + + + +gmhleasr: Shiny Dashboard for GMH Communities Leasing Data — gmhleasr-package • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -46,21 +85,34 @@
    -

    See also

    -

    Useful links:

    +
    -

    Author

    +

    Author +

    Maintainer: Jimmy Briggs jimmy.briggs@jimbrig.com (ORCID)

    -

    Authors:

    Other contributors:

    +

    Authors:

    + +

    Other contributors:

    + + + +
    @@ -71,11 +123,12 @@

    Author<

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/icon_text.html b/main/reference/icon_text.html index a48de42..9f3d895 100644 --- a/main/reference/icon_text.html +++ b/main/reference/icon_text.html @@ -1,5 +1,26 @@ - -Icon Text — icon_text • gmhleasr + + + + + + +Icon Text — icon_text • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,37 @@
    -

    Usage

    +

    Usage +

    icon_text(icon, text)
    -

    Arguments

    +

    Arguments +

    -
    icon
    +
    +
    icon +

    fontawesome icon

    -
    text
    +
    text +

    text

    -
    + +
    -

    Value

    +

    Value +

    HTML div

    -

    Examples

    +

    Examples +

    icon_text("table", "Table")
 #> <div>
 #>   <i class="fas fa-table" role="presentation" aria-label="table icon"></i>
@@ -74,7 +121,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/main/reference/index.html b/main/reference/index.html index ef73d7d..07cfbd9 100644 --- a/main/reference/index.html +++ b/main/reference/index.html @@ -1,5 +1,24 @@ - -Package index • gmhleasr + + + + + + +Package index • gmhleasr + + + + + + + + + + + + + + Skip to contents @@ -15,17 +34,35 @@ + + @@ -36,300 +73,398 @@
    -

    All functions

    +

    All functions +

    -
    +
    +
    -
    +
    +
    EntrataAPI
    Entrata API Manager Client
    -
    +
    +
    +
    app_assets()
    App Assets
    -
    +
    +
    +
    app_controlbar_ui() app_controlbar_server()
    App Controlbar Module
    -
    +
    +
    +
    app_favicon()
    App Favicon
    -
    +
    +
    +
    app_footer_ui() app_footer_server()
    App Footer Module
    -
    +
    +
    +
    set_app_global() get_app_globals() get_app_global()
    App Global Variables
    -
    +
    +
    +
    app_header_ui() app_header_server()
    App Header Module
    -
    +
    +
    +
    app_logo()
    App Logo
    -
    +
    +
    +
    app_meta()
    -
    App <meta>
    -
    +
    App <meta> +
    +
    +
    +
    app_server()
    App Server
    -
    +
    +
    +
    app_sidebar_ui() app_sidebar_server()
    App Sidebar Module
    -
    +
    +
    +
    app_ui()
    App User Interface
    -
    +
    +
    +
    derive_req_body()
    Derive Entrata API Request Body
    -
    +
    +
    +
    display_phone_number()
    Displau Phone Number
    -
    +
    +
    +
    entrata()
    Entrata API Request
    -
    +
    +
    +
    entrata_leases()
    Entrata Leases
    -
    +
    +
    +
    entrata_pre_lease_report()
    Entrata Pre-Lease Report
    -
    +
    +
    +
    entrata_properties() parse_property_res_data()
    Entrata API Properties Endpoint
    -
    +
    +
    +
    validate_entrata_request_endpoint() validate_entrata_request_endpoint_method() validate_entrata_request_method_params() validate_entrata_request()
    Entrata API Request Validations
    -
    +
    +
    +
    flucol()
    Fluid Column - Shiny fluidRow + Column
    -
    +
    +
    +
    get_app_config()
    Get App Config
    -
    +
    +
    +
    get_entrata_report_info()
    Get Entrata Report Info
    -
    +
    +
    +
    get_entrata_reports_list()
    Get Entrata Reports List
    -
    +
    +
    +
    get_latest_report_version()
    Get Latest Report Version
    -
    +
    +
    +
    get_properties()
    Get Entrata Properties
    -
    +
    +
    +
    get_property_ids_filter_param()
    Get Property IDs Filter Parameter
    -
    +
    +
    +
    icon_text()
    Icon Text
    -
    +
    +
    +
    insert_logo()
    Insert Logo
    -
    +
    +
    +
    is_boolean_string()
    Is Boolean String
    -
    +
    +
    +
    make_reactive_trigger()
    Make Reactive Trigger
    -
    +
    +
    +
    parse_entrata_leases() parse_entrata_lease_customers() parse_entrata_lease_intervals() parse_entrata_lease_scheduled_charges() parse_entrata_lease_unit_spaces()
    Parse Response for Entrata Leases
    -
    +
    +
    +
    parse_entrata_properties()
    Parse Entrata Properties
    -
    +
    +
    +
    parse_guess_all()
    Reparse a Data Frame
    -
    +
    +
    +
    picker()
    Picker Input
    -
    +
    +
    +
    picker_entrata_reports()
    Picker Input for Entrata Reports
    -
    +
    +
    +
    res_err_body() res_is_err()
    Request Error Helpers
    -
    +
    +
    +
    req_should_retry() req_retry_is_transient() req_retry_backoff() req_retry_after()
    Request Retry Helpers
    -
    +
    +
    +
    run_app()
    Run Shiny App
    -
    +
    +
    +
    strip_phone_number()
    Strip Phone Number
    -
    +
    +
    +
    trim_ws()
    Trim Whitespace
    -
    +
    +
    +
    user_agent()
    Create User Agent
    -
    +
    +
    +
    centered() help_mark() help_label()
    HTML Utilities
    -
    +
    +
    +
    write_json_schema() yaml_to_json() yaml_to_list()
    Schema (JSON/YAML) Utilities
    -
    +
    +
    +
    validate_entrata_config()
    Validate Entrata API Configuration
    -
    +
    +
    +
    validate_entrata_report_name()
    Validate Entrata Report Name
    -
    +
    +
    +
    verify_css()
    Verify CSS
    -
    +
    +
    +
    view_list()
    View List
    -
    - + + + +
    @@ -340,11 +475,12 @@

    All functionspkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/insert_logo.html b/main/reference/insert_logo.html index d3ea631..07c29dc 100644 --- a/main/reference/insert_logo.html +++ b/main/reference/insert_logo.html @@ -1,5 +1,26 @@ - -Insert Logo — insert_logo • gmhleasr + + + + + + +Insert Logo — insert_logo • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    insert_logo(
   file,
   style = "background-color: #FFF; width: 100%; height: 100%;",
@@ -52,32 +92,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    file
    +
    +
    file +

    file

    -
    style
    +
    style +

    style

    -
    width
    +
    width +

    width

    -
    ref
    +
    ref +

    ref

    -
    + +
    -

    Value

    +

    Value +

    tag

    + +
    @@ -88,11 +137,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/is_app_local.html b/main/reference/is_app_local.html index 41b72e0..fe6616e 100644 --- a/main/reference/is_app_local.html +++ b/main/reference/is_app_local.html @@ -1,5 +1,26 @@ - -Is App Local? — is_app_local • gmhleasr + + + + + + +Is App Local? — is_app_local • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,17 +81,20 @@
    -

    Usage

    +

    Usage +

    is_app_local()
    -

    Value

    +

    Value +

    A logical value.

    + +
    @@ -63,11 +105,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/is_boolean_string.html b/main/reference/is_boolean_string.html index 21b94a1..da443ab 100644 --- a/main/reference/is_boolean_string.html +++ b/main/reference/is_boolean_string.html @@ -1,5 +1,26 @@ - -Is Boolean String — is_boolean_string • gmhleasr + + + + + + +Is Boolean String — is_boolean_string • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,33 +81,41 @@
    -

    Usage

    +

    Usage +

    is_boolean_string(str)
    -

    Arguments

    +

    Arguments +

    -
    str
    +
    +
    str +

    Character string to check. Typically, with the Entrata API, "boolean" values are represented as quoted integers ("0" or "1") representing FALSE and TRUE, respectively.

    -
    + +
    -

    Value

    +

    Value +

    TRUE if the string is a boolean string, FALSE otherwise.

    -

    Examples

    +

    Examples +

    is_boolean_string("0")
 #> [1] TRUE
    + +
    @@ -79,11 +126,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/make_reactive_trigger.html b/main/reference/make_reactive_trigger.html index da2706b..824b7e1 100644 --- a/main/reference/make_reactive_trigger.html +++ b/main/reference/make_reactive_trigger.html @@ -1,19 +1,40 @@ - -Make Reactive Trigger — make_reactive_trigger • gmhleasr + + + + + +Make Reactive Trigger — make_reactive_trigger • gmhleasr + + + + + + + + + + + + + +See here."> + + + Skip to contents @@ -29,17 +50,35 @@ + + @@ -52,44 +91,56 @@
    -

    Create a 'reactive trigger' object (not a proper R class) with two methods:

    1. depend() : must be written in a code chunk to execute on triggering

      2. +

      Create a 'reactive trigger' object (not a proper R class) with two methods:

      +
        +

      1. depend() : must be written in a code chunk to execute on triggering

      2. trigger(): when executed, trigger the object (and all the "depending" code chunks)

        3. -

      This function is freely re-used from Dean Attali's work: +

    +

    This function is freely re-used from Dean Attali's work: See here.

    -

    Usage

    +

    Usage +

    make_reactive_trigger(dev = FALSE, label = "")
    -

    Arguments

    +

    Arguments +

    -
    dev
    +
    +
    dev +

    logical; if TRUE, will print messages to console

    -
    label
    +
    label +

    character; label for the trigger

    -
    + +
    -

    Value

    +

    Value +

    list with two functions: depend() and trigger()

    -

    Examples

    +

    Examples +

    
 # create a reactive trigger
 trigger <- make_reactive_trigger(dev = TRUE, label = "my_trigger")
    + +
    @@ -100,11 +151,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/parse_entrata_leases.html b/main/reference/parse_entrata_leases.html index e3be18b..f20bf87 100644 --- a/main/reference/parse_entrata_leases.html +++ b/main/reference/parse_entrata_leases.html @@ -1,5 +1,26 @@ - -Parse Response for Entrata Leases — parse_entrata_leases • gmhleasr + + + + + + +Parse Response for Entrata Leases — parse_entrata_leases • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    parse_entrata_leases(res)
 
 parse_entrata_lease_customers(res_content)
@@ -55,19 +95,25 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    res
    +
    +
    res +

    The httr2::response() object from the Entrata API

    -
    res_content
    +
    res_content +

    Response content to parse

    -
    + +
    -

    Value

    +

    Value +

    Parsed Response Body Content as a tibble with leases data.

    Parsed Response Body Content as a tibble with lease customer data.

    Parsed Response Body Content as a tibble with lease interval data.

    @@ -75,29 +121,38 @@

    Value

    Parsed Response Body Content as a tibble with lease unit spaces data.

    -

    Details

    +

    Details +

    The core function is parse_entrata_leases(), which parses the response from the Entrata API's "getLeases" method called via entrata_leases().

    -

    parse_entrata_leases() calls the following functions to parse the response:

    • parse_entrata_lease_customers(): Parse Entrata lease customers

      • +

      parse_entrata_leases() calls the following functions to parse the response:

      +
        +

      • parse_entrata_lease_customers(): Parse Entrata lease customers

      • parse_entrata_lease_intervals(): Parse Entrata lease intervals

      • parse_entrata_lease_scheduled_charges(): Parse Entrata lease scheduled charges

      • parse_entrata_lease_unit_spaces(): Parse Entrata lease unit spaces

        • -
    + +
    -

    Functions

    +

    Functions +

    -

    • parse_entrata_lease_customers(): Parse Entrata Lease Customers

      • +
        +

      • parse_entrata_lease_customers(): Parse Entrata Lease Customers

      • parse_entrata_lease_intervals(): Parse Entrata Lease Intervals

      • parse_entrata_lease_scheduled_charges(): Parse Entrata Lease Scheduled Charges

      • parse_entrata_lease_unit_spaces(): Parse Entrata Lease Unit Spaces

        • -
    + +
    -

    See also

    +

    See also +

    entrata_leases()

    + + - + + - + + diff --git a/main/reference/parse_entrata_properties.html b/main/reference/parse_entrata_properties.html index fb16bd7..0d9c006 100644 --- a/main/reference/parse_entrata_properties.html +++ b/main/reference/parse_entrata_properties.html @@ -1,5 +1,26 @@ - -Parse Entrata Properties — parse_entrata_properties • gmhleasr + + + + + + +Parse Entrata Properties — parse_entrata_properties • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    parse_entrata_properties(res)
    -

    Arguments

    +

    Arguments +

    -
    res
    +
    +
    res +

    The httr2::response() object from the Entrata API.

    -
    + +
    -

    Value

    +

    Value +

    A data frame with the parsed property information.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/parse_guess_all.html b/main/reference/parse_guess_all.html index f8d9707..a1f4904 100644 --- a/main/reference/parse_guess_all.html +++ b/main/reference/parse_guess_all.html @@ -1,7 +1,28 @@ - -Reparse a Data Frame — parse_guess_all • gmhleasr + + + + + + +Reparse a Data Frame — parse_guess_all • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,25 +84,32 @@
    -

    Usage

    +

    Usage +

    parse_guess_all(df)
    -

    Arguments

    +

    Arguments +

    -
    df
    +
    +
    df +

    data frame

    -
    + +
    -

    Value

    +

    Value +

    a data frame with re-parsed data types

    -

    Examples

    +

    Examples +

    my_df <- tibble::tibble(a = "1", b = "a", c = 5)
 str(my_df)
 #> tibble [1 × 3] (S3: tbl_df/tbl/data.frame)
@@ -88,7 +134,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/main/reference/picker.html b/main/reference/picker.html index d4e9625..ad2dac1 100644 --- a/main/reference/picker.html +++ b/main/reference/picker.html @@ -1,5 +1,26 @@ - -Picker Input — picker • gmhleasr + + + + + + +Picker Input — picker • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    picker(
   id,
   label,
@@ -56,54 +96,68 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    Input ID for the picker

    -
    label
    +
    label +

    Label for the picker

    -
    choices
    +
    choices +

    Choices for the picker

    -
    selected
    +
    selected +

    Selected choices

    -
    multiple
    +
    multiple +

    Are multiple selections allowed?

    -
    count_threshold
    +
    count_threshold +

    Threshold for displaying count of selected items, default is 3.

    -
    choice_options
    +
    choice_options +

    Passed through to shinyWidgets::pickerInput()'s choicesOpt argument.

    -
    ...
    +
    ... +

    Additional arguments passed to shinyWidgets::pickerInput().

    -
    + +
    -

    Value

    +

    Value +

    A select input control that can be added to the app's UI.

    -

    See also

    +

    See also +

    shinyWidgets::pickerInput()

    + + - + + - + + diff --git a/main/reference/picker_entrata_reports.html b/main/reference/picker_entrata_reports.html index e8c5c52..70a1463 100644 --- a/main/reference/picker_entrata_reports.html +++ b/main/reference/picker_entrata_reports.html @@ -1,5 +1,26 @@ - -Picker Input for Entrata Reports — picker_entrata_reports • gmhleasr + + + + + + +Picker Input for Entrata Reports — picker_entrata_reports • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    picker_entrata_reports(
   id,
   label = "Select Report",
@@ -52,32 +92,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    id

    -
    label
    +
    label +

    label

    -
    selected
    +
    selected +

    selected

    -
    ...
    +
    ... +

    dots

    -
    + +
    -

    Value

    +

    Value +

    a

    + +
    @@ -88,11 +137,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/request_error.html b/main/reference/request_error.html index 935167e..1758653 100644 --- a/main/reference/request_error.html +++ b/main/reference/request_error.html @@ -1,9 +1,30 @@ - -Request Error Helpers — request_error • gmhleasr + + + + + +Request Error Helpers — request_error • gmhleasr + + + + + + + + + + + + + +about the error that occurred during the request."> + + + Skip to contents @@ -19,17 +40,35 @@ + + @@ -48,52 +87,66 @@
    -

    Usage

    +

    Usage +

    res_err_body(resp)
 
 res_is_err(resp)
    -

    Arguments

    +

    Arguments +

    -
    resp
    +
    +
    resp +

    httr2::response() object

    -
    + +
    -

    Value

    +

    Value +

    -

    • res_err_body() - Error message as a string.

      • +
        +

      • res_err_body() - Error message as a string.

      • res_is_err() - Logical value indicating whether the response is an error.

      • res_err_retry() - Logical value indicating whether the request is retryable.

        • -
    + +
    -

    Details

    +

    Details +

    The Entrata API is unique in that it always returns a 200 status code, regardless of the success or failure of the request. To determine if a request was successful or not, we must inspect the response body. If the response body contains an error message, we can assume that the request was not successful.

    -

    Functions

    +

    Functions +

    -

    • res_err_body() - Extracts the error code and message from the response +

        +

      • res_err_body() - Extracts the error code and message from the response body. Used for the body argument in httr2::req_error().

      • res_is_err() - Determines if the response is an error. This is used for the is_error argument in httr2::req_error().

      • res_err_retry() - Determines if the request should be retried based off the response's error code.

        • -
    + +
    -

    See also

    +

    See also +

    httr2::req_error()

    + + - + + - + + diff --git a/main/reference/request_retry.html b/main/reference/request_retry.html index cef46a3..763fe5b 100644 --- a/main/reference/request_retry.html +++ b/main/reference/request_retry.html @@ -1,19 +1,40 @@ - -Request Retry Helpers — request_retry • gmhleasr + + + + + +Request Retry Helpers — request_retry • gmhleasr + + + + + + + + + + + + + +passing it the "queue id" as a parameter."> + + + Skip to contents @@ -29,17 +50,35 @@ + + @@ -63,7 +102,8 @@
    -

    Usage

    +

    Usage +

    req_should_retry(resp)
 
 req_retry_is_transient(resp)
@@ -74,35 +114,45 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    resp
    +
    +
    resp +

    httr2::response() object

    -
    + +
    -

    Value

    +

    Value +

    -

    • req_should_retry() - Logical value indicating whether the request should be +

        +

      • req_should_retry() - Logical value indicating whether the request should be retried.

      • req_retry_is_transient() - Logical value indicating whether the request is transient and should be retried.

      • req_retry_backoff() - The backoff time in seconds.

      • req_retry_after() - The time to wait before retrying the request.

        • -
    + +
    -

    Details

    +

    Details +

    The httr2::req_retry() function alters the HTTP request during httr2::req_perform() so that it will automatically retry in the case of a "transient" error. This is useful when working with APIs that may experience temporary issues that can be resolved by retrying the request.

    -

    Functions

    +

    Functions +

    -

    • req_should_retry() - Determines if the request should be retried based off +

        +

      • req_should_retry() - Determines if the request should be retried based off the response's status code.

      • req_retry_is_transient() - Determines if the request is transient and should be retried (applicable for the /queue endpoint's getQueueStatus method).

        • @@ -110,14 +160,17 @@

        Functions -

        See also

        +

        See also +

        httr2::req_retry()

    + + - + + - + + diff --git a/main/reference/run_app.html b/main/reference/run_app.html index 75a8ad5..80242c9 100644 --- a/main/reference/run_app.html +++ b/main/reference/run_app.html @@ -1,5 +1,26 @@ - -Run Shiny App — run_app • gmhleasr + + + + + + +Run Shiny App — run_app • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    run_app(
   onStart = NULL,
   options = list(),
@@ -53,16 +93,20 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    onStart
    +
    +
    onStart +

    A function that will be called before the app is actually run. This is only needed for shinyAppObj, since in the shinyAppDir case, a global.R file can be used for this purpose.

    -
    options
    +
    options +

    Named options that should be passed to the runApp call (these can be any of the following: "port", "launch.browser", "host", "quiet", "display.mode" and "test.mode"). You can also specify width and @@ -70,31 +114,37 @@

    ArgumentsenableBookmarking +
    enableBookmarking +

    Can be one of "url", "server", or "disable". The default value, NULL, will respect the setting from any previous calls to enableBookmarking(). See enableBookmarking() for more information on bookmarking your app.

    -
    uiPattern
    +
    uiPattern +

    A regular expression that will be applied to each GET request to determine whether the ui should be used to handle the request. Note that the entire request path must match the regular expression in order for the match to be considered successful.

    -
    ...
    +
    ... +

    Additional options

    -

    + +
    -

    Value

    +

    Value +

    A Shiny Application.

    + +
    @@ -105,11 +155,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/run_with_opts.html b/main/reference/run_with_opts.html index 40eb1b9..fbec57d 100644 --- a/main/reference/run_with_opts.html +++ b/main/reference/run_with_opts.html @@ -1,5 +1,26 @@ - -Run with Options — run_with_opts • gmhleasr + + + + + + +Run with Options — run_with_opts • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,37 +81,47 @@
    -

    Usage

    +

    Usage +

    run_with_opts(app, opts, maintenance_page = maintenance_page, print = TRUE)
    -

    Arguments

    +

    Arguments +

    -
    app
    +
    +
    app +

    Shiny App object.

    -
    opts
    +
    opts +

    A list of options to pass to the Shiny App.

    -
    maintenance_page
    +
    maintenance_page +

    A Shiny App object to display when the app is in maintenance mode.

    -
    print
    +
    print +

    A logical value to print the app. Defaults to TRUE.

    -
    + +
    -

    Value

    +

    Value +

    A Shiny App object.

    + +
    @@ -83,11 +132,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/strip_phone_number.html b/main/reference/strip_phone_number.html index c40cca3..d74dfe8 100644 --- a/main/reference/strip_phone_number.html +++ b/main/reference/strip_phone_number.html @@ -1,9 +1,30 @@ - -Strip Phone Number — strip_phone_number • gmhleasr + + + + + +Strip Phone Number — strip_phone_number • gmhleasr + + + + + + + + + + + + + +attribute's protocol."> + + + Skip to contents @@ -19,17 +40,35 @@ + + @@ -48,25 +87,32 @@
    -

    Usage

    +

    Usage +

    strip_phone_number(phone)
    -

    Arguments

    +

    Arguments +

    -
    phone
    +
    +
    phone +

    String representing a phone number.

    -
    + +
    -

    Value

    +

    Value +

    Formatted string of the phone number.

    -

    Examples

    +

    Examples +

    strip_phone_number("(555) 555-5555")
 #> [1] "+15555555555"
 strip_phone_number("555-555-5555")
@@ -76,7 +122,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/main/reference/trim_ws.html b/main/reference/trim_ws.html index ab51e26..a0fd13b 100644 --- a/main/reference/trim_ws.html +++ b/main/reference/trim_ws.html @@ -1,7 +1,28 @@ - -Trim Whitespace — trim_ws • gmhleasr + + + + + + +Trim Whitespace — trim_ws • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    trim_ws(str, ...)
 
 # S3 method for class 'character'
@@ -59,30 +99,38 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    str
    +
    +
    str +

    Character vector, or a data frame.

    -
    ...
    +
    ... +

    Currently not used.

    -
    + +
    -

    Value

    +

    Value +

    Character vector, where trailing and leading white spaces are removed.

    -

    Examples

    +

    Examples +

    trim_ws("  no space!  ")
 #> [1] "no space!"
    + +
    @@ -93,11 +141,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/user_agent.html b/main/reference/user_agent.html index 6ae587b..3ee9913 100644 --- a/main/reference/user_agent.html +++ b/main/reference/user_agent.html @@ -1,5 +1,26 @@ - -Create User Agent — user_agent • gmhleasr + + + + + + +Create User Agent — user_agent • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    user_agent(
   package = "gmhleasr",
   version = utils::packageVersion("gmhleasr"),
@@ -52,35 +92,44 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    package
    +
    +
    package +

    Package name. Default is "gmhleasr".

    -
    version
    +
    version +

    Package version. Default is the current version of "gmhleasr".

    -
    url
    +
    url +

    Package URL. Default is the URL from the package's DESCRIPTION file.

    -
    + +
    -

    Value

    +

    Value +

    User agent string.

    -

    Examples

    +

    Examples +

    user_agent("gmhleasr", "0.0.1")
 #> gmhleasr/0.0.1 (https://github.com/noclocks/gmhleasr,
 #>     https://docs.noclocks.dev/gmhleasr/)
    + +
    @@ -91,11 +140,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/utils_html.html b/main/reference/utils_html.html index eaa46fe..e1996bc 100644 --- a/main/reference/utils_html.html +++ b/main/reference/utils_html.html @@ -1,17 +1,38 @@ - -HTML Utilities — utils_html • gmhleasr + + + + + +HTML Utilities — utils_html • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -27,17 +48,35 @@ + + @@ -51,13 +90,16 @@
    -

    • centered(): Centered HTML element

      • +
        +

      • centered(): Centered HTML element

      • help_mark(): Help icon with hover text

      • help_label(): Label with help icon

        • -
    + +
    -

    Usage

    +

    Usage +

    centered(...)
 
 help_mark(help_txt)
@@ -66,31 +108,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    HTML elements

    -
    help_txt
    +
    help_txt +

    Help text

    -
    label_text
    +
    label_text +

    Label text

    -
    + +
    -

    Value

    +

    Value +

    -

    • centered(): Centered HTML element

      • +
        +

      • centered(): Centered HTML element

      • help_mark(): Help icon with hover text

      • help_label(): Label with help

        • -
    + + + +
    @@ -101,11 +153,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/utils_schema.html b/main/reference/utils_schema.html index 185ee4a..6ef3e40 100644 --- a/main/reference/utils_schema.html +++ b/main/reference/utils_schema.html @@ -1,17 +1,38 @@ - -Schema (JSON/YAML) Utilities — utils_schema • gmhleasr + + + + + +Schema (JSON/YAML) Utilities — utils_schema • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -27,17 +48,35 @@ + + @@ -51,13 +90,16 @@
    -

    • write_json_schema(): Write JSON schema to file

      • +
        +

      • write_json_schema(): Write JSON schema to file

      • yaml_to_json(): Convert YAML to JSON

      • yaml_to_list(): Convert YAML to list

        • -
    + +
    -

    Usage

    +

    Usage +

    write_json_schema(schema, path)
 
 yaml_to_json(yaml)
@@ -66,27 +108,36 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    schema
    +
    +
    schema +

    JSON schema

    -
    path
    +
    path +

    File path

    -
    + +
    -

    Value

    +

    Value +

    -

    • write_json_schema(): Invisible file path

      • +
        +

      • write_json_schema(): Invisible file path

      • yaml_to_json(): JSON string

      • yaml_to_list(): List

        • -
    + + + +
    @@ -97,11 +148,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/validate_entrata_config.html b/main/reference/validate_entrata_config.html index 99f542a..a3ee8ef 100644 --- a/main/reference/validate_entrata_config.html +++ b/main/reference/validate_entrata_config.html @@ -1,5 +1,26 @@ - -Validate Entrata API Configuration — validate_entrata_config • gmhleasr + + + + + + +Validate Entrata API Configuration — validate_entrata_config • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    validate_entrata_config(cfg)
    -

    Arguments

    +

    Arguments +

    -
    cfg
    +
    +
    cfg +

    Either a path to a YAML configuration file or a list object containing the configurations.

    -
    + +
    -

    Value

    +

    Value +

    The original configuration object, invisibly.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/validate_entrata_report_name.html b/main/reference/validate_entrata_report_name.html index 8bfa943..077445d 100644 --- a/main/reference/validate_entrata_report_name.html +++ b/main/reference/validate_entrata_report_name.html @@ -1,9 +1,30 @@ - -Validate Entrata Report Name — validate_entrata_report_name • gmhleasr + + + + + +Validate Entrata Report Name — validate_entrata_report_name • gmhleasr + + + + + + + + + + + + + +an error is thrown with suggestions for valid report names."> + + + Skip to contents @@ -19,17 +40,35 @@ + + @@ -48,7 +87,8 @@
    -

    Usage

    +

    Usage +

    validate_entrata_report_name(
   report_name,
   arg = rlang::caller_arg(report_name),
@@ -58,32 +98,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    report_name
    +
    +
    report_name +

    A character string representing the report name to validate.

    -
    arg
    +
    arg +

    The argument name for the report name. Default is the caller's argument name.

    -
    call
    +
    call +

    The calling environment. Default is the caller's environment.

    -
    ...
    +
    ... +

    Additional arguments to pass to the underlying validation functions.

    -
    + +
    -

    Value

    +

    Value +

    NULL. Throws an error if the report name is invalid.

    + +
    @@ -94,11 +143,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/main/reference/verify_css.html b/main/reference/verify_css.html index 1d795e1..d6b522d 100644 --- a/main/reference/verify_css.html +++ b/main/reference/verify_css.html @@ -1,5 +1,26 @@ - -Verify CSS — verify_css • gmhleasr + + + + + + +Verify CSS — verify_css • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,37 @@
    -

    Usage

    +

    Usage +

    verify_css(selector, css)
    -

    Arguments

    +

    Arguments +

    -
    selector
    +
    +
    selector +

    The CSS selector for the element to verify

    -
    css
    +
    css +

    A named list of CSS properties and their expected values

    -
    + +
    -

    Value

    +

    Value +

    A logical value indicating whether the CSS properties match the expected values

    -

    Examples

    +

    Examples +

    if (FALSE) { # \dontrun{
 verify_css("#my-element", list("color" = "red", "font-size" = "16px"))
 } # }
@@ -72,7 +119,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/main/reference/view_list.html b/main/reference/view_list.html index 87298fc..19f5c7e 100644 --- a/main/reference/view_list.html +++ b/main/reference/view_list.html @@ -1,5 +1,27 @@ - -View List — view_list • gmhleasr + + + + + + +View List — view_list • gmhleasr + + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +37,35 @@ + + @@ -42,23 +82,31 @@
    -

    Usage

    +

    Usage +

    view_list(listdata = NULL, ...)
    -

    Arguments

    +

    Arguments +

    -
    listdata
    +
    +
    listdata +

    List or string data to view - Although designed for lists, listdata can be any data source that can be rendered into JSON through jsonlite::toJSON(). Alternately, listdata could be a character string of valid JSON. This might be helpful when dealing with an API response.

    -
    ...
    -

    Arguments passed on to listviewer::jsonedit

    mode
    +
    ... +
    +
    +

    Arguments passed on to listviewer::jsonedit

    +
    +
    mode

    string for the initial view from modes. 'tree' is the default.

    modes
    @@ -77,22 +125,27 @@

    Arguments -

    Value

    +

    Value +

    A JSON viewer of the list data.

    -

    Examples

    +

    Examples +

    view_list(list(1, 2, 3))
    + +
    @@ -103,11 +156,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/pkgdown.yml b/pkgdown.yml index e6d22f4..bf59dc3 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,11 +1,11 @@ -pandoc: 3.1.11 +pandoc: '3.4' pkgdown: 2.1.1 pkgdown_sha: ~ articles: decisions: decisions.html entrata: entrata.html gmhleasr: gmhleasr.html -last_built: 2024-11-11T23:31Z +last_built: 2024-12-07T01:08Z urls: - reference: https://docs.noclocks.dev/gmhleasr/reference - article: https://docs.noclocks.dev/gmhleasr/articles + reference: https://docs.noclocks.dev/gmhleasr/main/reference + article: https://docs.noclocks.dev/gmhleasr/main/articles diff --git a/reference/EntrataAPI.html b/reference/EntrataAPI.html index 11249c3..e7f156e 100644 --- a/reference/EntrataAPI.html +++ b/reference/EntrataAPI.html @@ -1,11 +1,32 @@ - -Entrata API Manager Client — EntrataAPI • gmhleasr + + + + + +Entrata API Manager Client — EntrataAPI • gmhleasr + + + + + + + + + + + + + +and response parsing, making it easy for developers to work with the API."> + + + Skip to contents @@ -21,17 +42,35 @@ + + @@ -52,12 +91,17 @@
    -

    Details

    +

    Details +

    This class ...

    -

    Public fields

    -

    config
    +

    Public fields +

    +

    +
    +
    +
    config

    A list containing the Entrata API configuration, including the username, password, and API base URL.

    @@ -66,15 +110,20 @@

    Public fields -

    Methods

    +

    Methods +

    -

    Public methods

    +

    Public methods +

    -

    -

    Method new()

    + +
    +

    +
    +
    +

    Method new() +

    Initializes the Entrata API manager with the provided configuration. -If no configuration is provided, the default configuration will be used.

    -

    Usage

    -

    EntrataAPI$new(config = config::get("entrata"))

    +If no configuration is provided, the default configuration will be used.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$new(config = config::get("entrata"))
    +

    +
    -

    Arguments

    -

    config
    +

    Arguments +

    +

    +
    +
    +
    config

    A list containing the Entrata API configuration.

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    The initialized Entrata API manager.

    -

    -

    Method send_request()

    -

    Sends a request to the Entrata API.

    -

    Usage

    -

    EntrataAPI$send_request(
+
    +

    +
    +
    +

    Method send_request() +

    +

    Sends a request to the Entrata API.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$send_request(
   endpoint,
   method,
   method_version = "r1",
@@ -116,12 +191,18 @@ 
    Usage
   timeout = NULL,
   progress = FALSE,
   ...
-)

    +)
    +

    +
    -

    Arguments

    -

    endpoint
    +

    Arguments +

    +

    +
    +
    +
    endpoint

    The Entrata API endpoint to call.

    @@ -153,43 +234,77 @@

    Argumentshttr2::req_perform() call.

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    The response object from the API request.

    -

    -

    Method get_reports_list()

    -

    Retrieves the list of available Entrata reports.

    -

    Usage

    -

    EntrataAPI$get_reports_list(latest_only = TRUE)

    +
    +

    +
    +
    +

    Method get_reports_list() +

    +

    Retrieves the list of available Entrata reports.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_reports_list(latest_only = TRUE)
    +

    +
    -

    Arguments

    -

    latest_only
    +

    Arguments +

    +

    +
    +
    +
    latest_only

    Logical, should only the latest version of each report be returned?

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    A tibble containing the report information.

    -

    -

    Method get_report_info()

    -

    Retrieves detailed information for a specific Entrata report.

    -

    Usage

    -

    EntrataAPI$get_report_info(report_name, report_version = "latest")

    +
    +

    +
    +
    +

    Method get_report_info() +

    +

    Retrieves detailed information for a specific Entrata report.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_report_info(report_name, report_version = "latest")
    +

    +
    -

    Arguments

    -

    report_name
    +

    Arguments +

    +

    +
    +
    +
    report_name

    The name of the report to retrieve information for.

    @@ -197,47 +312,81 @@

    Arguments -

    Returns

    +

    Returns +

    A list containing the report name, description, and filters.

    -

    -

    Method get_latest_report_version()

    -

    Retrieves the latest version of a specific Entrata report.

    -

    Usage

    -

    EntrataAPI$get_latest_report_version(report_name)

    +
    +

    +
    +
    +

    Method get_latest_report_version() +

    +

    Retrieves the latest version of a specific Entrata report.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_latest_report_version(report_name)
    +

    +
    -

    Arguments

    -

    report_name
    +

    Arguments +

    +

    +
    +
    +
    report_name

    The name of the report to retrieve the latest version for.

    -

    +
    +

    +
    -

    Returns

    +

    Returns +

    The latest version of the report as a character string.

    -

    -

    Method generate_pre_lease_report()

    -

    Generates a pre-lease report in Entrata.

    -

    Usage

    -

    EntrataAPI$generate_pre_lease_report(
+
    +

    +
    +
    +

    Method generate_pre_lease_report() +

    +

    Generates a pre-lease report in Entrata.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$generate_pre_lease_report(
   property_ids,
   period_start = "2024-09-01",
   ...
-)

    +)
    +

    +
    -

    Arguments

    -

    property_ids
    +

    Arguments +

    +

    +
    +
    +
    property_ids

    A vector of property IDs to include in the report.

    @@ -249,39 +398,69 @@

    Arguments -

    Returns

    +

    Returns +

    A list containing the summary and details of the pre-lease report.

    -

    -

    Method get_property_ids()

    -

    Retrieves the list of property IDs from the Entrata API.

    -

    Usage

    -

    EntrataAPI$get_property_ids()

    +
    +

    +
    +
    +

    Method get_property_ids() +

    +

    Retrieves the list of property IDs from the Entrata API.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$get_property_ids()
    +

    +
    -

    Returns

    +

    Returns +

    A vector of property IDs.

    -

    -

    Method clone()

    -

    The objects of this class are cloneable with this method.

    -

    Usage

    -

    EntrataAPI$clone(deep = FALSE)

    +
    +

    +
    +
    +

    Method clone() +

    +

    The objects of this class are cloneable with this method.

    +
    +

    Usage +

    +

    +
    +
    EntrataAPI$clone(deep = FALSE)
    +

    +
    -

    Arguments

    -

    deep
    +

    Arguments +

    +

    +
    +
    +
    deep

    Whether to make a deep clone.

    -

    +
    +

    +
    @@ -289,7 +468,8 @@

    Arguments

    + +
    - + +
    - + + diff --git a/reference/app_assets.html b/reference/app_assets.html index 780ec4d..bb8ab39 100644 --- a/reference/app_assets.html +++ b/reference/app_assets.html @@ -1,7 +1,28 @@ - -App Assets — app_assets • gmhleasr + + + + + + +App Assets — app_assets • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + +
    @@ -45,44 +84,59 @@
    -

    Usage

    +

    Usage +

    app_assets(...)
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    Additional arguments (currently unused)

    -
    +
    +
    -

    Value

    +

    Value +

    <head> with app assets configured

    -

    Details

    +

    Details +

    This function is used to add the app's favicon, bundle the app's assets, add various <meta> tags, and include necessary external libraries and shiny related packages to the app.

    -

    By default it will perform the following actions:

    + +
    -

    See also

    +

    See also +

    app_favicon(), bundle_app_assets(), shiny::addResourcePath(), shinyjs::useShinyjs(), shinyFeedback::useShinyFeedback(), waiter::useWaiter()

    + + - + + - + + diff --git a/reference/app_controlbar.html b/reference/app_controlbar.html index f4be21c..e0d44d9 100644 --- a/reference/app_controlbar.html +++ b/reference/app_controlbar.html @@ -1,5 +1,26 @@ - -App Controlbar Module — app_controlbar • gmhleasr + + + + + + +App Controlbar Module — app_controlbar • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,38 @@
    -

    Usage

    +

    Usage +

    app_controlbar_ui(id)
 
 app_controlbar_server(id)
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    + +
    -

    Value

    +

    Value +

    -

    • app_controlbar_ui(): A bs4Dash controlbar UI element

      • +
        +

      • app_controlbar_ui(): A bs4Dash controlbar UI element

      • app_controlbar_server(): Server logic for the controlbar

        • -
    + + + +
    @@ -75,11 +123,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/app_favicon.html b/reference/app_favicon.html index 14b3e8e..3ab928c 100644 --- a/reference/app_favicon.html +++ b/reference/app_favicon.html @@ -1,5 +1,26 @@ - -App Favicon — app_favicon • gmhleasr + + + + + + +App Favicon — app_favicon • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,26 +81,33 @@
    -

    Usage

    +

    Usage +

    app_favicon(path = app_sys("favicon.ico"))
    -

    Arguments

    +

    Arguments +

    -
    path
    +
    +
    path +

    The path to the favicon file. See details for more information on how to set this path. Default is www/images/favicons/favicon.ico, which is specific to this package.

    -
    + +
    -

    Value

    +

    Value +

    <head> with necessary favicon declaration

    -

    Details

    +

    Details +

    The path to the favicon file should utilize the pre-configured resourcePath, i.e. "www/*", to ensure the favicon is accessible to the app.

    The www prefixed path is instantiated in the app_assets() function which @@ -69,7 +115,8 @@

    Details

    + + - + + - + + diff --git a/reference/app_footer.html b/reference/app_footer.html index 74e50f6..a5aa21d 100644 --- a/reference/app_footer.html +++ b/reference/app_footer.html @@ -1,5 +1,26 @@ - -App Footer Module — app_footer • gmhleasr + + + + + + +App Footer Module — app_footer • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,38 @@
    -

    Usage

    +

    Usage +

    app_footer_ui(id)
 
 app_footer_server(id)
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    + +
    -

    Value

    +

    Value +

    -

    • app_footer_ui(): A bs4Dash footer UI element

      • +
        +

      • app_footer_ui(): A bs4Dash footer UI element

      • app_footer_server(): Server logic for the footer

        • -
    + + + +
    @@ -75,11 +123,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/app_globals.html b/reference/app_globals.html index a427c13..000860a 100644 --- a/reference/app_globals.html +++ b/reference/app_globals.html @@ -1,5 +1,26 @@ - -App Global Variables — app_globals • gmhleasr + + + + + + +App Global Variables — app_globals • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    set_app_global(name, value)
 
 get_app_globals()
@@ -51,28 +91,37 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    name
    +
    +
    name +

    A character string.

    -
    value
    +
    value +

    A value.

    -
    + +
    -

    Value

    +

    Value +

    -

    • set_app_global(): Sets a global variable and invisibly returns the previous value, +

        +

      • set_app_global(): Sets a global variable and invisibly returns the previous value, if any.

      • get_app_globals(): Returns a list of all global variables.

      • get_app_global(): Returns the value of a global variable by name.

        • -
    + + + +
    @@ -83,11 +132,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/app_header.html b/reference/app_header.html index 73828d5..bf02412 100644 --- a/reference/app_header.html +++ b/reference/app_header.html @@ -1,5 +1,26 @@ - -App Header Module — app_header • gmhleasr + + + + + + +App Header Module — app_header • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,44 +81,61 @@
    -

    Usage

    +

    Usage +

    app_header_ui(id, title = "GMH Leasing Dashboard", ...)
 
 app_header_server(id, app_globals = NULL)
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    title
    +
    title +

    The title of the dashboard

    -
    + +
    -

    Value

    +

    Value +

    -

    • app_header_ui(): An htmltools::tagList() of the header UI elements

      • +
        +

      • app_header_ui(): An htmltools::tagList() of the header UI elements

      • app_header_server(): List of reactive expressions for the header

        • -
    + +
    -

    Details

    -

    The module includes both the UI and server functions for the header:

    • app_header_ui(): The UI function for the header

      • +

      Details +

      +

      The module includes both the UI and server functions for the header:

      +
        +

      • app_header_ui(): The UI function for the header

      • app_header_server(): The server function for the header

        • -

      The header will include the following elements:

      • GMH Communities logo

        • +
      +

      The header will include the following elements:

      +
        +

      • GMH Communities logo

      • Dashboard title

      • About button

      • Refresh button

      • Contact Us dropdown menu

      • User Menu dropdown menu

        • -
    + + + + - + + - + + diff --git a/reference/app_logo.html b/reference/app_logo.html index bf51f46..4ce8ec0 100644 --- a/reference/app_logo.html +++ b/reference/app_logo.html @@ -1,5 +1,26 @@ - -App Logo — app_logo • gmhleasr + + + + + + +App Logo — app_logo • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    app_logo(
   path = "public/images/logos/gmh-logo.svg",
   alt = "GMH Communities",
@@ -51,28 +91,36 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    path
    +
    +
    path +

    Path to the logo file

    -
    alt
    +
    alt +

    Alt text for the logo

    -
    style
    +
    style +

    CSS style for the logo

    -
    + +
    -

    Value

    +

    Value +

    HTML image tag with the provided logo

    + +
    @@ -83,11 +131,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/app_meta.html b/reference/app_meta.html index 7bf6123..c51a398 100644 --- a/reference/app_meta.html +++ b/reference/app_meta.html @@ -1,5 +1,26 @@ - -App <meta> — app_meta • gmhleasr + + + + + + +App <meta> — app_meta • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,24 +36,43 @@ + +
    -

    App <meta>

    +

    App <meta> +

    Source: R/app_assets.R
    app_meta.Rd
    @@ -42,7 +82,8 @@
    -

    Usage

    +

    Usage +

    app_meta(
   package = "gmhleasr",
   app_name = "GMH Leasing Dashboard",
@@ -66,93 +107,117 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    package
    +
    +
    package +

    Name of the package

    -
    app_name
    +
    app_name +

    Name of the app

    -
    app_version
    +
    app_version +

    Version of the app

    -
    description
    +
    description +

    Description of the app

    -
    url
    +
    url +

    URL of the app

    -
    theme_color
    +
    theme_color +

    Theme color of the app

    -
    robots
    +
    robots +

    Robots.txt policy

    -
    generator
    +
    generator +

    Generator of the app

    -
    subject
    +
    subject +

    Subject of the app

    -
    rating
    +
    rating +

    Rating of the app

    -
    referrer
    +
    referrer +

    Referrer policy

    -
    csp
    +
    csp +

    Content Security Policy

    -
    image
    +
    image +

    Image URL

    -
    image_alt
    +
    image_alt +

    Image alt text

    -
    twitter_creator
    +
    twitter_creator +

    Twitter creator

    -
    twitter_card_type
    +
    twitter_card_type +

    Twitter card type

    -
    twitter_site
    +
    twitter_site +

    Twitter site

    -
    ...
    +
    ... +

    Additional arguments (currently unused)

    -
    + +
    -

    Value

    +

    Value +

    Raw <meta> tags via metathis::meta() (to be passed into the app's <head>)

    -

    See also

    +

    See also +

    metathis::meta()

    + + - + + - + + diff --git a/reference/app_server.html b/reference/app_server.html index 0f02541..19fc9cf 100644 --- a/reference/app_server.html +++ b/reference/app_server.html @@ -1,5 +1,26 @@ - -App Server — app_server • gmhleasr + + + + + + +App Server — app_server • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,21 +81,27 @@
    -

    Usage

    +

    Usage +

    app_server(input, output, session)
    -

    Arguments

    +

    Arguments +

    -
    input, output, session
    +
    +
    input, output, session +

    Internal parameters for shiny.

    -
    + + + +
    @@ -67,11 +112,12 @@

    Argumentspkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/app_sidebar.html b/reference/app_sidebar.html index ce19915..67a69f1 100644 --- a/reference/app_sidebar.html +++ b/reference/app_sidebar.html @@ -1,7 +1,28 @@ - -App Sidebar Module — app_sidebar • gmhleasr + + + + + + +App Sidebar Module — app_sidebar • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    app_sidebar_ui(id)
 
 app_sidebar_server(id, app_globals = NULL)
@@ -56,24 +96,34 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    The module id

    -
    + +
    -

    Value

    +

    Value +

    -

    • app_sidebar_ui(): A bs4Dash sidebar UI element

      • +
        +

      • app_sidebar_ui(): A bs4Dash sidebar UI element

      • app_sidebar_server(): Server logic for the sidebar

        • -

      • app_sidebar_ui(): A bs4Dash sidebar UI element

        • +
      +
        +

      • app_sidebar_ui(): A bs4Dash sidebar UI element

      • app_sidebar_server(): Server logic for the sidebar

        • -
    + + + +
    @@ -84,11 +134,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/app_sys.html b/reference/app_sys.html index b70ff5d..6ed6b88 100644 --- a/reference/app_sys.html +++ b/reference/app_sys.html @@ -1,5 +1,26 @@ - -App System File — app_sys • gmhleasr + + + + + + +App System File — app_sys • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    app_sys(...)
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    Path components.

    -
    + +
    -

    Value

    +

    Value +

    Path to file in package.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/app_ui.html b/reference/app_ui.html index 97b8387..44d1728 100644 --- a/reference/app_ui.html +++ b/reference/app_ui.html @@ -1,5 +1,26 @@ - -App User Interface — app_ui • gmhleasr + + + + + + +App User Interface — app_ui • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    app_ui(request)
    -

    Arguments

    +

    Arguments +

    -
    request
    +
    +
    request +

    Internal parameter for {shiny}.

    -
    + +
    -

    Value

    +

    Value +

    A {shiny} UI object.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/apply_xl_styles.html b/reference/apply_xl_styles.html index ff49645..710a632 100644 --- a/reference/apply_xl_styles.html +++ b/reference/apply_xl_styles.html @@ -1,7 +1,28 @@ - -Apply Styles to Cells in an Excel Sheet — apply_xl_styles • gmhleasr + + + + + + +Apply Styles to Cells in an Excel Sheet — apply_xl_styles • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    apply_xl_styles(
   wb,
   sheet_number,
@@ -74,104 +114,131 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    wb
    +
    +
    wb +

    A workbook object from openxlsx.

    -
    sheet_number
    +
    sheet_number +

    Numeric or character identifier for the sheet.

    -
    rows
    +
    rows +

    The row range to apply the style to.

    -
    cols
    +
    cols +

    The column number to apply the style to.

    -
    font_name
    +
    font_name +

    Font name.

    -
    font_size
    +
    font_size +

    Font size.

    -
    font_color
    +
    font_color +

    Font color.

    -
    number_format
    +
    number_format +

    Number format.

    -
    border
    +
    border +

    Border style.

    -
    border_color
    +
    border_color +

    Border color.

    -
    border_style
    +
    border_style +

    Border style.

    -
    bg_fill
    +
    bg_fill +

    Background fill color.

    -
    fg_fill
    +
    fg_fill +

    Foreground fill color.

    -
    halign
    +
    halign +

    Horizontal alignment.

    -
    valign
    +
    valign +

    Vertical alignment.

    -
    text_decoration
    +
    text_decoration +

    Text decoration.

    -
    wrap_text
    +
    wrap_text +

    Wrap text.

    -
    text_rotation
    +
    text_rotation +

    Text rotation angle.

    -
    indent
    +
    indent +

    Indentation level.

    -
    locked
    +
    locked +

    Lock cells.

    -
    hidden
    +
    hidden +

    Hide cells.

    -
    ...
    +
    ... +

    Additional arguments.

    -
    + +
    -

    Value

    +

    Value +

    NULL. The function modifies the workbook object in place.

    + +
    @@ -182,11 +249,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/derive_req_body.html b/reference/derive_req_body.html index ee74c97..e7adc5a 100644 --- a/reference/derive_req_body.html +++ b/reference/derive_req_body.html @@ -1,5 +1,26 @@ - -Derive Entrata API Request Body — derive_req_body • gmhleasr + + + + + + +Derive Entrata API Request Body — derive_req_body • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,33 +81,42 @@
    -

    Usage

    +

    Usage +

    derive_req_body(method, method_version, method_params)
    -

    Arguments

    +

    Arguments +

    -
    method
    +
    +
    method +

    The Entrata API method to use.

    -
    method_version
    +
    method_version +

    The version of the API method to use.

    -
    method_params
    +
    method_params +

    A named list of parameters to include in the request body.

    -
    + +
    -

    Value

    +

    Value +

    A list representing the request body.

    + +
    @@ -79,11 +127,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/display_phone_number.html b/reference/display_phone_number.html index 99af4f7..fae54e4 100644 --- a/reference/display_phone_number.html +++ b/reference/display_phone_number.html @@ -1,5 +1,26 @@ - -Displau Phone Number — display_phone_number • gmhleasr + + + + + + +Displau Phone Number — display_phone_number • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,31 +81,39 @@
    -

    Usage

    +

    Usage +

    display_phone_number(phone)
    -

    Arguments

    +

    Arguments +

    -
    phone
    +
    +
    phone +

    String representing a phone number.

    -
    + +
    -

    Value

    +

    Value +

    Formatted string of the phone number.

    -

    Examples

    +

    Examples +

    display_phone_number("5555555555")
 #> [1] "(555) 555-5555"
    + +
    @@ -77,11 +124,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/entrata.html b/reference/entrata.html index 3a64810..9d4f6a8 100644 --- a/reference/entrata.html +++ b/reference/entrata.html @@ -1,11 +1,32 @@ - -Entrata API Request — entrata • gmhleasr + + + + + +Entrata API Request — entrata • gmhleasr + + + + + + + + + + + + + +create requests to the Entrata API."> + + + Skip to contents @@ -21,17 +42,35 @@ + + @@ -51,7 +90,8 @@
    -

    Usage

    +

    Usage +

    entrata(
   endpoint = NULL,
   method = NULL,
@@ -71,15 +111,19 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    endpoint
    +
    +
    endpoint +

    Entrata API Endpoint to send the request to. Default is NULL. See details for the available endpoints.

    -
    method
    +
    method +

    Entrata API Method to use in the request. Not to be confused with the HTTP request method (i.e. GET, POST), this method must be a method that is available in the Entrata API for the @@ -90,14 +134,16 @@

    Argumentsmethod_version +
    method_version +

    Entrata API Method Version to use in the request. Default is "r1". Some endpoints have multiple versions of the same method. The version should be provided as a string. See details for more information on the structure of the request and available versions by endpoint method.

    -
    method_params
    +
    method_params +

    List of parameters to use in the request body's "method" object. Default is an empty list. The parameters should be provided as a named list where the names are the parameter names and the values are the @@ -108,77 +154,95 @@

    Argumentsua +
    ua +

    User Agent string to use in the request. Default is to use user_agent().

    -
    verbosity
    -

    How much information to print? This is a wrapper -around req_verbose() that uses an integer to control verbosity:

    • 0: no output

      • +
      verbosity +
      +
      +

      How much information to print? This is a wrapper +around req_verbose() that uses an integer to control verbosity:

      +
        +

      • 0: no output

      • 1: show headers

      • 2: show headers and bodies

      • 3: show headers, bodies, and curl status messages.

        • -

      Use with_verbosity() to control the verbosity of requests that -you can't affect directly.

      +
    +

    Use with_verbosity() to control the verbosity of requests that +you can't affect directly.

    +
    -
    perform
    +
    perform +

    Logical value indicating whether to perform the request. Default is FALSE. If FALSE, the function will return the request object without performing the request. If TRUE, the function will perform the request and return the response object.

    -
    extract
    +
    extract +

    Logical value indicating whether to extract the response. Default is the value of perform. If TRUE, the function will extract the response object and return it. If FALSE, the function will return the response object as is.

    -
    enable_retry
    +
    enable_retry +

    Logical value indicating whether to enable request retry. Default is FALSE. If TRUE, the function will enable request retry with the default retry settings. If FALSE, the function will not enable request retry.

    -
    timeout
    +
    timeout +

    Numeric value indicating the request timeout in seconds. Default is NULL. If provided, the function will set the request timeout to the provided value in seconds.

    -
    dry_run
    +
    dry_run +

    Logical value indicating whether to perform a dry run of the request. Default is FALSE. If TRUE, the function will perform a dry run of the request before performing the actual request (or if perform is not set, will return the request object without performing the request).

    -
    progress
    +
    progress +

    Logical value indicating whether to show progress of the request. Only useful for long running requests. Default is FALSE. If TRUE, the function will show the progress of the request.

    -
    config
    +
    config +

    Entrata API Configuration Values as a list. Default is to use config::get("entrata") to retrieve the configuration values from a config.yml configuration file. The configuration values should include the following keys: username, password, and base_url. See details.

    -
    ...
    +
    ... +

    Additional arguments to pass to the request object.

    -

    + +
    -

    Value

    +

    Value +

    httr2::request() object with the Entrata API request.

    -

    Details

    +

    Details +

    This function creates a request to the Entrata API using the httr2 package.

    Specifically, the function creates an HTTP POST request to the Entrata API by appending to the request's URL path the provided endpoint, assigning the @@ -186,11 +250,17 @@

    Detailsmethod name and params parameters. See below for details.

    This is the raw format of the base template request:

    -

    +

    +
    +
    +

    +

    where the Authorization header is a Basic authentication header with the provided username and password and the body is a JSON encoded data object using the provided method and params:

    -

    {
+
    
+
    
+
    {
 "data": {
   "auth": {
     "type": [
@@ -217,19 +287,25 @@ 
    Details    }
   }
 }
-}
    
+}
    +

    +

    -

    See also

    -

    Entrata API Documentation

    +

    See also +

    +
    +

    Entrata API Documentation

    MDN Web Docs: HTTP Caching

    httr2::req_auth_basic(), httr2::request(), httr2::req_body_json(), httr2::req_headers(), httr2::req_template(), httr2::req_url_path_append(), -httr2::req_method()

    +httr2::req_method()

    +
    + + - + + - + + diff --git a/reference/entrata_internal.html b/reference/entrata_internal.html index 83a7d31..307f11a 100644 --- a/reference/entrata_internal.html +++ b/reference/entrata_internal.html @@ -1,15 +1,36 @@ - -Entrata API Internal Helpers — entrata_internal • gmhleasr + + + + + +Entrata API Internal Helpers — entrata_internal • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -25,17 +46,35 @@ + + @@ -48,41 +87,53 @@
    -

    Internal helper functions for the Entrata API request functions.

    • validate_entrata_endpoint_method(): Validate Entrata API Endpoint and Method

      • +

      Internal helper functions for the Entrata API request functions.

      +
        +

      • validate_entrata_endpoint_method(): Validate Entrata API Endpoint and Method

      • validate_entrata_method_params(): Validate Entrata API Method Parameters

      • get_default_method(): Get Default Method by Endpoint

        • -
    + +
    -

    Usage

    +

    Usage +

    validate_entrata_endpoint_method(endpoint, method)
 
 get_default_method(endpoint)
    -

    Arguments

    +

    Arguments +

    -
    endpoint
    +
    +
    endpoint +

    Entrata API Endpoint to validate.

    -
    method
    +
    method +

    Entrata API Method to validate.

    -
    method_params
    +
    method_params +

    List of parameters to validate.

    -
    + +
    -

    See also

    +

    See also +

    Entrata API Documentation

    + + - + + - + + diff --git a/reference/entrata_leases.html b/reference/entrata_leases.html index cf1a4cc..5f8c349 100644 --- a/reference/entrata_leases.html +++ b/reference/entrata_leases.html @@ -1,5 +1,26 @@ - -Entrata Leases — entrata_leases • gmhleasr + + + + + + +Entrata Leases — entrata_leases • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    entrata_leases(
   property_id,
   application_id = as.integer(NULL),
@@ -70,108 +110,136 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    application_id
    +
    +
    application_id +

    Optional. Integer value of the application ID

    -
    customer_id
    +
    customer_id +

    Optional. Integer value of the customer ID

    -
    lease_status_type_ids
    +
    lease_status_type_ids +

    Optional. Integer vector of lease status type IDs

    -
    lease_ids
    +
    lease_ids +

    Optional. Integer vector of lease IDs

    -
    scheduled_ar_code_ids
    +
    scheduled_ar_code_ids +

    Optional. Integer vector of scheduled AR code IDs

    -
    unit_number
    +
    unit_number +

    Optional. Character value of the unit number

    -
    building_name
    +
    building_name +

    Optional. Character value of the building name

    -
    move_in_date_from
    +
    move_in_date_from +

    Optional. Date value of the move-in date from

    -
    move_in_date_to
    +
    move_in_date_to +

    Optional. Date value of the move-in date to

    -
    lease_expiring_date_from
    +
    lease_expiring_date_from +

    Optional. Date value of the lease expiring from

    -
    lease_expiring_date_to
    +
    lease_expiring_date_to +

    Optional. Date value of the lease expiring to

    -
    move_out_date_from
    +
    move_out_date_from +

    Optional. Date value of the move-out date from

    -
    move_out_date_to
    +
    move_out_date_to +

    Optional. Date value of the move-out date to

    -
    include_other_income_leases
    +
    include_other_income_leases +

    Optional. Logical value to include other income leases

    -
    resident_friendly_mode
    +
    resident_friendly_mode +

    Optional. Logical value to include resident friendly mode

    -
    include_lease_history
    +
    include_lease_history +

    Optional. Logical value to include lease history information

    -
    include_ar_transactions
    +
    include_ar_transactions +

    Optional. Logical value to include AR transactions

    -
    pagination_page_number
    +
    pagination_page_number +

    Pagination page number. Default is 1

    -
    pagination_page_size
    +
    pagination_page_size +

    Number of items per page. Default is 500

    - +

    Logical value to include pagination links in the response. Default is FALSE

    -
    ...
    +
    ... +

    Additional parameters to pass to the request

    -
    property_ids
    +
    property_ids +

    Required. Integer vector of property IDs

    -
    + +
    -

    Value

    +

    Value +

    Parsed Response Body Content as a tibble with leases data.

    -

    See also

    +

    See also +

    parse_entrata_leases()

    + + - + + - + + diff --git a/reference/entrata_pre_lease_report.html b/reference/entrata_pre_lease_report.html index 06c2c42..da7e115 100644 --- a/reference/entrata_pre_lease_report.html +++ b/reference/entrata_pre_lease_report.html @@ -1,13 +1,34 @@ - -Entrata Pre-Lease Report — entrata_pre_lease_report • gmhleasr + + + + + +Entrata Pre-Lease Report — entrata_pre_lease_report • gmhleasr + + + + + + + + + + + + + +data for the summary and details report "subtotals"."> + + + Skip to contents @@ -23,17 +44,35 @@ + + @@ -54,7 +93,8 @@
    -

    Usage

    +

    Usage +

    entrata_pre_lease_report(
   property_ids = get_property_ids_filter_param(),
   leasing_period_start_date = get_pre_lease_period_start_date(),
@@ -76,96 +116,118 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    property_ids
    +
    +
    property_ids +

    A vector of property IDs to include in the report. Defaults to get_property_ids_filter_param(), which returns all available property IDs. The actual values passed to the request need to be unnamed and flattened to a character vector or single level list.

    -
    leasing_period_start_date
    +
    leasing_period_start_date +

    The start date of the leasing period. Defaults to the result of get_pre_lease_period_start_date() which returns the date for September 1st of either the current year or the next year, depending on the current date. The date should be formatted as "m/d/Y".

    -
    leasing_period_type
    +
    leasing_period_type +

    The type of leasing period. Defaults to "today". Can be one of "today" or "date".

    -
    summarize_by
    +
    summarize_by +

    The method of summarizing the report. Defaults to "property". Can be one of "property", "unit_type", "floorplan_name", or "do_not_summarize".

    -
    group_by
    +
    group_by +

    The method of grouping the report. Defaults to "do_not_group". Can be one of "do_not_group", "unit_type", "floorplan_name", or "lease_term".

    -
    consider_pre_leased_on
    +
    consider_pre_leased_on +

    The method of considering pre-leased units. Defaults to "33". Can be one of "32", "33", "34", "41", "42", "43", or "44", which (I believe) represent the various leasing occupancy types.

    -
    charge_code_detail
    +
    charge_code_detail +

    The method of showing charge code details. Defaults to "0". If set to "1", the report will show charge code details.

    -
    space_options
    +
    space_options +

    The method of showing space options. Defaults to "do_not_show". Can be one of "do_not_show", "show_preferred", or "show_actual".

    -
    additional_units_shown
    +
    additional_units_shown +

    The method of showing additional units. Defaults to "available". Can be one of "available" or "excluded".

    -
    combine_unit_spaces_with_same_lease
    +
    combine_unit_spaces_with_same_lease +

    The method of combining unit spaces with the same lease. Defaults to "0". If set to "1", the report will combine unit spaces with the same lease.

    -
    consolidate_by
    +
    consolidate_by +

    The method of consolidating the report. Defaults to "no_consolidation". Can be one of "no_consolidation", "consolidate_all_properties", or "consolidate_by_property_groups".

    -
    arrange_by_property
    +
    arrange_by_property +

    The method of arranging the report by property. Defaults to "0". If set to "1", the report will be arranged by property.

    -
    subtotals
    +
    subtotals +

    A list of subtotals to include in the report. Defaults to "summary" and "details". Can be one or both of "summary" and "details".

    -
    yoy
    +
    yoy +

    The method of showing year-over-year data. Defaults to "1". If set to "0", the report will not show year-over-year data.

    -
    ...
    +
    ... +

    Additional parameters for the API request passed on to the downstream entrata() function.

    -
    + +
    -

    Value

    +

    Value +

    A list with the extracted, un-processed report data.

    -

    Details

    -

    The function performs the following steps:

    1. Get the latest report version for the "pre_lease" report using the +

      Details +

      +

      The function performs the following steps:

      +
        +

      1. Get the latest report version for the "pre_lease" report using the get_latest_report_version() function.

      2. Prepare the property IDs, leasing period start date, and period method parameters.

      3. Validate the input parameters for summarize_by, group_by, consider_pre_leased_on, @@ -181,15 +243,20 @@

        Details

      4. Return a list with the extracted, un-processed report data for further downstream processing or analysis.

        5. -
    + +
    -

    See also

    -

    Entrata API Documentation

    -

    get_latest_report_version(), get_property_ids_filter_param(), get_pre_lease_period_start_date()

    +

    See also +

    +
    +

    Entrata API Documentation

    +

    get_latest_report_version(), get_property_ids_filter_param(), get_pre_lease_period_start_date()

    +
    + + - + + - + + diff --git a/reference/entrata_properties.html b/reference/entrata_properties.html index 03de7e0..29f5bb7 100644 --- a/reference/entrata_properties.html +++ b/reference/entrata_properties.html @@ -1,7 +1,28 @@ - -Entrata API Properties Endpoint — entrata_properties • gmhleasr + + + + + + +Entrata API Properties Endpoint — entrata_properties • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    entrata_properties(
   property_ids = c(NULL),
   property_lookup_codes = NULL,
@@ -57,27 +97,36 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    property_ids
    +
    +
    property_ids +

    Character Vector of Property IDs to include in the request body parameters. If NULL, all properties will be returned. Default is NULL.

    -
    property_lookup_codes
    +
    property_lookup_codes +

    Character string with a "Property Lookup Code" to include in the request's body. Default is NULL.

    -
    show_all_status
    +
    show_all_status +

    Logical: if TRUE will return all properties, regardless of status. Default is FALSE.

    -
    ...
    -

    Arguments passed on to entrata

    endpoint
    +
    ... +
    +
    +

    Arguments passed on to entrata

    +
    +
    endpoint

    Entrata API Endpoint to send the request to. Default is NULL. See details for the available endpoints.

    @@ -151,45 +200,62 @@

    Argumentsreq_verbose() that uses an integer to control verbosity:

    • 0: no output

      • +
      +

      How much information to print? This is a wrapper +around req_verbose() that uses an integer to control verbosity:

      +
        +

      • 0: no output

      • 1: show headers

      • 2: show headers and bodies

      • 3: show headers, bodies, and curl status messages.

        • -

      Use with_verbosity() to control the verbosity of requests that -you can't affect directly.

      +
    +

    Use with_verbosity() to control the verbosity of requests that +you can't affect directly.

    +

    -
    +
    + -
    res_data
    +
    res_data +

    Response data from the Entrata API's "getProperties" method.

    -
    + +
    -

    Value

    +

    Value +

    A tibble with the property information

    A tibble with the property information

    -

    Functions

    +

    Functions +

    -

    • parse_property_res_data(): Parse Entrata Properties Response Data

      • -
    +
      +

    • parse_property_res_data(): Parse Entrata Properties Response Data

      • +
    +
    -

    See also

    -

    entrata()

    -

    https://gmhcommunities.entrata.com/api/v1/documentation/getProperties

    +

    See also +

    +
    +

    entrata()

    +

    https://gmhcommunities.entrata.com/api/v1/documentation/getProperties

    +
    -

    Examples

    +

    Examples +
    + +
    @@ -200,11 +266,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/entrata_request_validation.html b/reference/entrata_request_validation.html index c62d3a8..9a40210 100644 --- a/reference/entrata_request_validation.html +++ b/reference/entrata_request_validation.html @@ -1,17 +1,38 @@ - -Entrata API Request Validations — entrata_request_validation • gmhleasr + + + + + +Entrata API Request Validations — entrata_request_validation • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -27,17 +48,35 @@ + + @@ -50,14 +89,18 @@
    -

    Helper functions for validating Entrata API requests.

    • validate_entrata_request_endpoint(): Validate Entrata API Endpoint

      • +

      Helper functions for validating Entrata API requests.

      +
        +

      • validate_entrata_request_endpoint(): Validate Entrata API Endpoint

      • validate_entrata_request_endpoint_method(): Validate Entrata API Endpoint's Method

      • validate_entrata_request_method_params(): Validate Entrata API Endpoint Method's Parameters

      • validate_entrata_request(): Validate Entrata API Request by performing all validation checks

        • -
    + +
    -

    Usage

    +

    Usage +

    validate_entrata_request_endpoint(
   endpoint,
   arg = rlang::caller_arg(endpoint),
@@ -95,49 +138,61 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    endpoint
    +
    +
    endpoint +

    Entrata API Endpoint to validate. Must be one of the available Entrata API endpoints.

    -
    arg, arg_endpoint, arg_method, arg_method_params
    +
    arg, arg_endpoint, arg_method, arg_method_params +

    Arguments to use for error messages.

    -
    call
    +
    call +

    Environment to use for error messages. Defaults to the calling environment.

    -
    method
    +
    method +

    Entrata API Endpoint Method to validate. Should be one of the available methods for the specified endpoint.

    -
    method_params
    +
    method_params +

    List of method parameters to validate. Should be a named list corresponding the the specific endpoint/method's available and required parameters.

    -
    ...
    +
    ... +

    Additional arguments to pass to the underlying validation functions.

    -
    + +
    -

    Value

    +

    Value +

    All validation functions are used for their side effects have no return values, except for validate_entrata_request() which will return TRUE if validations pass.

    -

    See also

    +

    See also +

    Entrata API Documentation

    + + - + + - + + diff --git a/reference/flucol.html b/reference/flucol.html index 13aa49d..821bd24 100644 --- a/reference/flucol.html +++ b/reference/flucol.html @@ -1,5 +1,26 @@ - -Fluid Column - Shiny fluidRow + Column — flucol • gmhleasr + + + + + + +Fluid Column - Shiny fluidRow + Column — flucol • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,33 +81,42 @@
    -

    Usage

    +

    Usage +

    flucol(..., width = 12, offset = 0)
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    elements to include within the flucol

    -
    width
    +
    width +

    width

    -
    offset
    +
    offset +

    offset

    -
    + +
    -

    Value

    +

    Value +

    A column wrapped in fluidRow

    + +
    @@ -79,11 +127,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/get_app_config.html b/reference/get_app_config.html index 45397ad..bc34c20 100644 --- a/reference/get_app_config.html +++ b/reference/get_app_config.html @@ -1,5 +1,26 @@ - -Get App Config — get_app_config • gmhleasr + + + + + + +Get App Config — get_app_config • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    get_app_config(
   value,
   config = Sys.getenv("APP_CONFIG_ACTIVE", Sys.getenv("R_CONFIG_ACTIVE", "default")),
@@ -53,44 +93,54 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    value
    +
    +
    value +

    Name of value (NULL to read all values)

    -
    config
    +
    config +

    Name of configuration to read from. Defaults to the value of the R_CONFIG_ACTIVE environment variable ("default" if the variable does not exist).

    -
    use_parent
    +
    use_parent +

    TRUE to scan parent directories for configuration files if the specified config file isn't found.

    -
    file
    +
    file +

    Configuration file to read from (defaults to "config.yml"). If the file isn't found at the location specified then parent directories are searched for a file of the same name.

    -
    + +
    -

    Value

    +

    Value +

    The value of the configuration key.

    -

    Details

    +

    Details +

    The only difference in this function and config::get() is that this function sets the default value of the file argument to the app's config.yml file and attempts to set the config argument to the value of the APP_CONFIG_ACTIVE.

    + + - + + - + + diff --git a/reference/get_entrata_report_info.html b/reference/get_entrata_report_info.html index 707349a..bc36150 100644 --- a/reference/get_entrata_report_info.html +++ b/reference/get_entrata_report_info.html @@ -1,7 +1,28 @@ - -Get Entrata Report Info — get_entrata_report_info • gmhleasr + + + + + + +Get Entrata Report Info — get_entrata_report_info • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,30 +84,38 @@
    -

    Usage

    +

    Usage +

    get_entrata_report_info(report_name, report_version = "latest")
    -

    Arguments

    +

    Arguments +

    -
    report_name
    +
    +
    report_name +

    A character string representing the name of the report.

    -
    report_version
    +
    report_version +

    A character string representing the version of the report. Defaults to "latest".

    -
    + +
    -

    Value

    +

    Value +

    A list containing report name, description, and filters.

    + +
    @@ -79,11 +126,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/get_entrata_reports_list.html b/reference/get_entrata_reports_list.html index 0520138..beb02f1 100644 --- a/reference/get_entrata_reports_list.html +++ b/reference/get_entrata_reports_list.html @@ -1,7 +1,28 @@ - -Get Entrata Reports List — get_entrata_reports_list • gmhleasr + + + + + + +Get Entrata Reports List — get_entrata_reports_list • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,27 +84,34 @@
    -

    Usage

    +

    Usage +

    get_entrata_reports_list(latest_only = TRUE)
    -

    Arguments

    +

    Arguments +

    -
    latest_only
    +
    +
    latest_only +

    Logical, if TRUE (default), returns only the latest version of each report.

    -
    + +
    -

    Value

    +

    Value +

    A tibble containing report information including report name, ID, system name, and version.

    + +
    @@ -76,11 +122,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/get_latest_report_version.html b/reference/get_latest_report_version.html index ce2e341..ccf66d8 100644 --- a/reference/get_latest_report_version.html +++ b/reference/get_latest_report_version.html @@ -1,7 +1,28 @@ - -Get Latest Report Version — get_latest_report_version • gmhleasr + + + + + + +Get Latest Report Version — get_latest_report_version • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,25 +84,32 @@
    -

    Usage

    +

    Usage +

    get_latest_report_version(report_name)
    -

    Arguments

    +

    Arguments +

    -
    report_name
    +
    +
    report_name +

    A character string representing the name of the report.

    -
    + +
    -

    Value

    +

    Value +

    A character string representing the latest version of the report.

    + +
    @@ -74,11 +120,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/get_properties.html b/reference/get_properties.html index 6423636..55e50de 100644 --- a/reference/get_properties.html +++ b/reference/get_properties.html @@ -1,5 +1,26 @@ - -Get Entrata Properties — get_properties • gmhleasr + + + + + + +Get Entrata Properties — get_properties • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    get_properties(
   api,
   property_ids = NULL,
@@ -53,36 +93,46 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    api
    +
    +
    api +

    An instance of the EntrataAPI class.

    -
    property_ids
    +
    property_ids +

    A vector of property IDs to retrieve.

    -
    property_lookup_codes
    +
    property_lookup_codes +

    A vector of property lookup codes to retrieve.

    -
    show_all_status
    +
    show_all_status +

    Logical. Whether to return all properties regardless of status.

    -
    ...
    +
    ... +

    Additional parameters to pass to the underlying API request.

    -
    + +
    -

    Value

    +

    Value +

    A data frame with the retrieved property information.

    + +
    @@ -93,11 +143,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/get_property_ids_filter_param.html b/reference/get_property_ids_filter_param.html index edd45bc..20c2ddd 100644 --- a/reference/get_property_ids_filter_param.html +++ b/reference/get_property_ids_filter_param.html @@ -1,7 +1,28 @@ - -Get Property IDs Filter Parameter — get_property_ids_filter_param • gmhleasr + + + + + + +Get Property IDs Filter Parameter — get_property_ids_filter_param • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,17 +84,20 @@
    -

    Usage

    +

    Usage +

    get_property_ids_filter_param()
    -

    Value

    +

    Value +

    A list of character strings representing property IDs.

    + +
    @@ -66,11 +108,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/gmhleasr-package.html b/reference/gmhleasr-package.html index 903baa7..a0fd4ed 100644 --- a/reference/gmhleasr-package.html +++ b/reference/gmhleasr-package.html @@ -1,7 +1,28 @@ - -gmhleasr: Shiny Dashboard for GMH Communities Leasing Data — gmhleasr-package • gmhleasr + + + + + + +gmhleasr: Shiny Dashboard for GMH Communities Leasing Data — gmhleasr-package • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -46,21 +85,34 @@
    -

    See also

    -

    Useful links:

    +
    -

    Author

    +

    Author +

    Maintainer: Jimmy Briggs jimmy.briggs@jimbrig.com (ORCID)

    -

    Authors:

    Other contributors:

    +

    Authors:

    + +

    Other contributors:

    + + + +
    @@ -71,11 +123,12 @@

    Author<

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/icon_text.html b/reference/icon_text.html index a48de42..9f3d895 100644 --- a/reference/icon_text.html +++ b/reference/icon_text.html @@ -1,5 +1,26 @@ - -Icon Text — icon_text • gmhleasr + + + + + + +Icon Text — icon_text • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,37 @@
    -

    Usage

    +

    Usage +

    icon_text(icon, text)
    -

    Arguments

    +

    Arguments +

    -
    icon
    +
    +
    icon +

    fontawesome icon

    -
    text
    +
    text +

    text

    -
    + +
    -

    Value

    +

    Value +

    HTML div

    -

    Examples

    +

    Examples +

    icon_text("table", "Table")
 #> <div>
 #>   <i class="fas fa-table" role="presentation" aria-label="table icon"></i>
@@ -74,7 +121,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/reference/index.html b/reference/index.html index ef73d7d..07cfbd9 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,5 +1,24 @@ - -Package index • gmhleasr + + + + + + +Package index • gmhleasr + + + + + + + + + + + + + + Skip to contents @@ -15,17 +34,35 @@ + + @@ -36,300 +73,398 @@
    -

    All functions

    +

    All functions +

    -
    +
    +
    -
    +
    +
    EntrataAPI
    Entrata API Manager Client
    -
    +
    +
    +
    app_assets()
    App Assets
    -
    +
    +
    +
    app_controlbar_ui() app_controlbar_server()
    App Controlbar Module
    -
    +
    +
    +
    app_favicon()
    App Favicon
    -
    +
    +
    +
    app_footer_ui() app_footer_server()
    App Footer Module
    -
    +
    +
    +
    set_app_global() get_app_globals() get_app_global()
    App Global Variables
    -
    +
    +
    +
    app_header_ui() app_header_server()
    App Header Module
    -
    +
    +
    +
    app_logo()
    App Logo
    -
    +
    +
    +
    app_meta()
    -
    App <meta>
    -
    +
    App <meta> +
    +
    +
    +
    app_server()
    App Server
    -
    +
    +
    +
    app_sidebar_ui() app_sidebar_server()
    App Sidebar Module
    -
    +
    +
    +
    app_ui()
    App User Interface
    -
    +
    +
    +
    derive_req_body()
    Derive Entrata API Request Body
    -
    +
    +
    +
    display_phone_number()
    Displau Phone Number
    -
    +
    +
    +
    entrata()
    Entrata API Request
    -
    +
    +
    +
    entrata_leases()
    Entrata Leases
    -
    +
    +
    +
    entrata_pre_lease_report()
    Entrata Pre-Lease Report
    -
    +
    +
    +
    entrata_properties() parse_property_res_data()
    Entrata API Properties Endpoint
    -
    +
    +
    +
    validate_entrata_request_endpoint() validate_entrata_request_endpoint_method() validate_entrata_request_method_params() validate_entrata_request()
    Entrata API Request Validations
    -
    +
    +
    +
    flucol()
    Fluid Column - Shiny fluidRow + Column
    -
    +
    +
    +
    get_app_config()
    Get App Config
    -
    +
    +
    +
    get_entrata_report_info()
    Get Entrata Report Info
    -
    +
    +
    +
    get_entrata_reports_list()
    Get Entrata Reports List
    -
    +
    +
    +
    get_latest_report_version()
    Get Latest Report Version
    -
    +
    +
    +
    get_properties()
    Get Entrata Properties
    -
    +
    +
    +
    get_property_ids_filter_param()
    Get Property IDs Filter Parameter
    -
    +
    +
    +
    icon_text()
    Icon Text
    -
    +
    +
    +
    insert_logo()
    Insert Logo
    -
    +
    +
    +
    is_boolean_string()
    Is Boolean String
    -
    +
    +
    +
    make_reactive_trigger()
    Make Reactive Trigger
    -
    +
    +
    +
    parse_entrata_leases() parse_entrata_lease_customers() parse_entrata_lease_intervals() parse_entrata_lease_scheduled_charges() parse_entrata_lease_unit_spaces()
    Parse Response for Entrata Leases
    -
    +
    +
    +
    parse_entrata_properties()
    Parse Entrata Properties
    -
    +
    +
    +
    parse_guess_all()
    Reparse a Data Frame
    -
    +
    +
    +
    picker()
    Picker Input
    -
    +
    +
    +
    picker_entrata_reports()
    Picker Input for Entrata Reports
    -
    +
    +
    +
    res_err_body() res_is_err()
    Request Error Helpers
    -
    +
    +
    +
    req_should_retry() req_retry_is_transient() req_retry_backoff() req_retry_after()
    Request Retry Helpers
    -
    +
    +
    +
    run_app()
    Run Shiny App
    -
    +
    +
    +
    strip_phone_number()
    Strip Phone Number
    -
    +
    +
    +
    trim_ws()
    Trim Whitespace
    -
    +
    +
    +
    user_agent()
    Create User Agent
    -
    +
    +
    +
    centered() help_mark() help_label()
    HTML Utilities
    -
    +
    +
    +
    write_json_schema() yaml_to_json() yaml_to_list()
    Schema (JSON/YAML) Utilities
    -
    +
    +
    +
    validate_entrata_config()
    Validate Entrata API Configuration
    -
    +
    +
    +
    validate_entrata_report_name()
    Validate Entrata Report Name
    -
    +
    +
    +
    verify_css()
    Verify CSS
    -
    +
    +
    +
    view_list()
    View List
    -
    - + + + +
    @@ -340,11 +475,12 @@

    All functionspkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/insert_logo.html b/reference/insert_logo.html index d3ea631..07c29dc 100644 --- a/reference/insert_logo.html +++ b/reference/insert_logo.html @@ -1,5 +1,26 @@ - -Insert Logo — insert_logo • gmhleasr + + + + + + +Insert Logo — insert_logo • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    insert_logo(
   file,
   style = "background-color: #FFF; width: 100%; height: 100%;",
@@ -52,32 +92,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    file
    +
    +
    file +

    file

    -
    style
    +
    style +

    style

    -
    width
    +
    width +

    width

    -
    ref
    +
    ref +

    ref

    -
    + +
    -

    Value

    +

    Value +

    tag

    + +
    @@ -88,11 +137,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/is_app_local.html b/reference/is_app_local.html index 41b72e0..fe6616e 100644 --- a/reference/is_app_local.html +++ b/reference/is_app_local.html @@ -1,5 +1,26 @@ - -Is App Local? — is_app_local • gmhleasr + + + + + + +Is App Local? — is_app_local • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,17 +81,20 @@
    -

    Usage

    +

    Usage +

    is_app_local()
    -

    Value

    +

    Value +

    A logical value.

    + +
    @@ -63,11 +105,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/is_boolean_string.html b/reference/is_boolean_string.html index 21b94a1..da443ab 100644 --- a/reference/is_boolean_string.html +++ b/reference/is_boolean_string.html @@ -1,5 +1,26 @@ - -Is Boolean String — is_boolean_string • gmhleasr + + + + + + +Is Boolean String — is_boolean_string • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,33 +81,41 @@
    -

    Usage

    +

    Usage +

    is_boolean_string(str)
    -

    Arguments

    +

    Arguments +

    -
    str
    +
    +
    str +

    Character string to check. Typically, with the Entrata API, "boolean" values are represented as quoted integers ("0" or "1") representing FALSE and TRUE, respectively.

    -
    + +
    -

    Value

    +

    Value +

    TRUE if the string is a boolean string, FALSE otherwise.

    -

    Examples

    +

    Examples +

    is_boolean_string("0")
 #> [1] TRUE
    + +
    @@ -79,11 +126,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/make_reactive_trigger.html b/reference/make_reactive_trigger.html index da2706b..824b7e1 100644 --- a/reference/make_reactive_trigger.html +++ b/reference/make_reactive_trigger.html @@ -1,19 +1,40 @@ - -Make Reactive Trigger — make_reactive_trigger • gmhleasr + + + + + +Make Reactive Trigger — make_reactive_trigger • gmhleasr + + + + + + + + + + + + + +See here."> + + + Skip to contents @@ -29,17 +50,35 @@ + + @@ -52,44 +91,56 @@
    -

    Create a 'reactive trigger' object (not a proper R class) with two methods:

    1. depend() : must be written in a code chunk to execute on triggering

      2. +

      Create a 'reactive trigger' object (not a proper R class) with two methods:

      +
        +

      1. depend() : must be written in a code chunk to execute on triggering

      2. trigger(): when executed, trigger the object (and all the "depending" code chunks)

        3. -

      This function is freely re-used from Dean Attali's work: +

    +

    This function is freely re-used from Dean Attali's work: See here.

    -

    Usage

    +

    Usage +

    make_reactive_trigger(dev = FALSE, label = "")
    -

    Arguments

    +

    Arguments +

    -
    dev
    +
    +
    dev +

    logical; if TRUE, will print messages to console

    -
    label
    +
    label +

    character; label for the trigger

    -
    + +
    -

    Value

    +

    Value +

    list with two functions: depend() and trigger()

    -

    Examples

    +

    Examples +

    
 # create a reactive trigger
 trigger <- make_reactive_trigger(dev = TRUE, label = "my_trigger")
    + +
    @@ -100,11 +151,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/parse_entrata_leases.html b/reference/parse_entrata_leases.html index e3be18b..f20bf87 100644 --- a/reference/parse_entrata_leases.html +++ b/reference/parse_entrata_leases.html @@ -1,5 +1,26 @@ - -Parse Response for Entrata Leases — parse_entrata_leases • gmhleasr + + + + + + +Parse Response for Entrata Leases — parse_entrata_leases • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    parse_entrata_leases(res)
 
 parse_entrata_lease_customers(res_content)
@@ -55,19 +95,25 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    res
    +
    +
    res +

    The httr2::response() object from the Entrata API

    -
    res_content
    +
    res_content +

    Response content to parse

    -
    + +
    -

    Value

    +

    Value +

    Parsed Response Body Content as a tibble with leases data.

    Parsed Response Body Content as a tibble with lease customer data.

    Parsed Response Body Content as a tibble with lease interval data.

    @@ -75,29 +121,38 @@

    Value

    Parsed Response Body Content as a tibble with lease unit spaces data.

    -

    Details

    +

    Details +

    The core function is parse_entrata_leases(), which parses the response from the Entrata API's "getLeases" method called via entrata_leases().

    -

    parse_entrata_leases() calls the following functions to parse the response:

    • parse_entrata_lease_customers(): Parse Entrata lease customers

      • +

      parse_entrata_leases() calls the following functions to parse the response:

      +
        +

      • parse_entrata_lease_customers(): Parse Entrata lease customers

      • parse_entrata_lease_intervals(): Parse Entrata lease intervals

      • parse_entrata_lease_scheduled_charges(): Parse Entrata lease scheduled charges

      • parse_entrata_lease_unit_spaces(): Parse Entrata lease unit spaces

        • -
    + +
    -

    Functions

    +

    Functions +

    -

    • parse_entrata_lease_customers(): Parse Entrata Lease Customers

      • +
        +

      • parse_entrata_lease_customers(): Parse Entrata Lease Customers

      • parse_entrata_lease_intervals(): Parse Entrata Lease Intervals

      • parse_entrata_lease_scheduled_charges(): Parse Entrata Lease Scheduled Charges

      • parse_entrata_lease_unit_spaces(): Parse Entrata Lease Unit Spaces

        • -
    + +
    -

    See also

    +

    See also +

    entrata_leases()

    + + - + + - + + diff --git a/reference/parse_entrata_properties.html b/reference/parse_entrata_properties.html index fb16bd7..0d9c006 100644 --- a/reference/parse_entrata_properties.html +++ b/reference/parse_entrata_properties.html @@ -1,5 +1,26 @@ - -Parse Entrata Properties — parse_entrata_properties • gmhleasr + + + + + + +Parse Entrata Properties — parse_entrata_properties • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    parse_entrata_properties(res)
    -

    Arguments

    +

    Arguments +

    -
    res
    +
    +
    res +

    The httr2::response() object from the Entrata API.

    -
    + +
    -

    Value

    +

    Value +

    A data frame with the parsed property information.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/parse_guess_all.html b/reference/parse_guess_all.html index f8d9707..a1f4904 100644 --- a/reference/parse_guess_all.html +++ b/reference/parse_guess_all.html @@ -1,7 +1,28 @@ - -Reparse a Data Frame — parse_guess_all • gmhleasr + + + + + + +Reparse a Data Frame — parse_guess_all • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,25 +84,32 @@
    -

    Usage

    +

    Usage +

    parse_guess_all(df)
    -

    Arguments

    +

    Arguments +

    -
    df
    +
    +
    df +

    data frame

    -
    + +
    -

    Value

    +

    Value +

    a data frame with re-parsed data types

    -

    Examples

    +

    Examples +

    my_df <- tibble::tibble(a = "1", b = "a", c = 5)
 str(my_df)
 #> tibble [1 × 3] (S3: tbl_df/tbl/data.frame)
@@ -88,7 +134,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/reference/picker.html b/reference/picker.html index d4e9625..ad2dac1 100644 --- a/reference/picker.html +++ b/reference/picker.html @@ -1,5 +1,26 @@ - -Picker Input — picker • gmhleasr + + + + + + +Picker Input — picker • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    picker(
   id,
   label,
@@ -56,54 +96,68 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    Input ID for the picker

    -
    label
    +
    label +

    Label for the picker

    -
    choices
    +
    choices +

    Choices for the picker

    -
    selected
    +
    selected +

    Selected choices

    -
    multiple
    +
    multiple +

    Are multiple selections allowed?

    -
    count_threshold
    +
    count_threshold +

    Threshold for displaying count of selected items, default is 3.

    -
    choice_options
    +
    choice_options +

    Passed through to shinyWidgets::pickerInput()'s choicesOpt argument.

    -
    ...
    +
    ... +

    Additional arguments passed to shinyWidgets::pickerInput().

    -
    + +
    -

    Value

    +

    Value +

    A select input control that can be added to the app's UI.

    -

    See also

    +

    See also +

    shinyWidgets::pickerInput()

    + + - + + - + + diff --git a/reference/picker_entrata_reports.html b/reference/picker_entrata_reports.html index e8c5c52..70a1463 100644 --- a/reference/picker_entrata_reports.html +++ b/reference/picker_entrata_reports.html @@ -1,5 +1,26 @@ - -Picker Input for Entrata Reports — picker_entrata_reports • gmhleasr + + + + + + +Picker Input for Entrata Reports — picker_entrata_reports • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    picker_entrata_reports(
   id,
   label = "Select Report",
@@ -52,32 +92,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    id
    +
    +
    id +

    id

    -
    label
    +
    label +

    label

    -
    selected
    +
    selected +

    selected

    -
    ...
    +
    ... +

    dots

    -
    + +
    -

    Value

    +

    Value +

    a

    + +
    @@ -88,11 +137,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/request_error.html b/reference/request_error.html index 935167e..1758653 100644 --- a/reference/request_error.html +++ b/reference/request_error.html @@ -1,9 +1,30 @@ - -Request Error Helpers — request_error • gmhleasr + + + + + +Request Error Helpers — request_error • gmhleasr + + + + + + + + + + + + + +about the error that occurred during the request."> + + + Skip to contents @@ -19,17 +40,35 @@ + + @@ -48,52 +87,66 @@
    -

    Usage

    +

    Usage +

    res_err_body(resp)
 
 res_is_err(resp)
    -

    Arguments

    +

    Arguments +

    -
    resp
    +
    +
    resp +

    httr2::response() object

    -
    + +
    -

    Value

    +

    Value +

    -

    • res_err_body() - Error message as a string.

      • +
        +

      • res_err_body() - Error message as a string.

      • res_is_err() - Logical value indicating whether the response is an error.

      • res_err_retry() - Logical value indicating whether the request is retryable.

        • -
    + +
    -

    Details

    +

    Details +

    The Entrata API is unique in that it always returns a 200 status code, regardless of the success or failure of the request. To determine if a request was successful or not, we must inspect the response body. If the response body contains an error message, we can assume that the request was not successful.

    -

    Functions

    +

    Functions +

    -

    • res_err_body() - Extracts the error code and message from the response +

        +

      • res_err_body() - Extracts the error code and message from the response body. Used for the body argument in httr2::req_error().

      • res_is_err() - Determines if the response is an error. This is used for the is_error argument in httr2::req_error().

      • res_err_retry() - Determines if the request should be retried based off the response's error code.

        • -
    + +
    -

    See also

    +

    See also +

    httr2::req_error()

    + + - + + - + + diff --git a/reference/request_retry.html b/reference/request_retry.html index cef46a3..763fe5b 100644 --- a/reference/request_retry.html +++ b/reference/request_retry.html @@ -1,19 +1,40 @@ - -Request Retry Helpers — request_retry • gmhleasr + + + + + +Request Retry Helpers — request_retry • gmhleasr + + + + + + + + + + + + + +passing it the "queue id" as a parameter."> + + + Skip to contents @@ -29,17 +50,35 @@ + + @@ -63,7 +102,8 @@
    -

    Usage

    +

    Usage +

    req_should_retry(resp)
 
 req_retry_is_transient(resp)
@@ -74,35 +114,45 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    resp
    +
    +
    resp +

    httr2::response() object

    -
    + +
    -

    Value

    +

    Value +

    -

    • req_should_retry() - Logical value indicating whether the request should be +

        +

      • req_should_retry() - Logical value indicating whether the request should be retried.

      • req_retry_is_transient() - Logical value indicating whether the request is transient and should be retried.

      • req_retry_backoff() - The backoff time in seconds.

      • req_retry_after() - The time to wait before retrying the request.

        • -
    + +
    -

    Details

    +

    Details +

    The httr2::req_retry() function alters the HTTP request during httr2::req_perform() so that it will automatically retry in the case of a "transient" error. This is useful when working with APIs that may experience temporary issues that can be resolved by retrying the request.

    -

    Functions

    +

    Functions +

    -

    • req_should_retry() - Determines if the request should be retried based off +

        +

      • req_should_retry() - Determines if the request should be retried based off the response's status code.

      • req_retry_is_transient() - Determines if the request is transient and should be retried (applicable for the /queue endpoint's getQueueStatus method).

        • @@ -110,14 +160,17 @@

        Functions -

        See also

        +

        See also +

        httr2::req_retry()

    + + - + + - + + diff --git a/reference/run_app.html b/reference/run_app.html index 75a8ad5..80242c9 100644 --- a/reference/run_app.html +++ b/reference/run_app.html @@ -1,5 +1,26 @@ - -Run Shiny App — run_app • gmhleasr + + + + + + +Run Shiny App — run_app • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    run_app(
   onStart = NULL,
   options = list(),
@@ -53,16 +93,20 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    onStart
    +
    +
    onStart +

    A function that will be called before the app is actually run. This is only needed for shinyAppObj, since in the shinyAppDir case, a global.R file can be used for this purpose.

    -
    options
    +
    options +

    Named options that should be passed to the runApp call (these can be any of the following: "port", "launch.browser", "host", "quiet", "display.mode" and "test.mode"). You can also specify width and @@ -70,31 +114,37 @@

    ArgumentsenableBookmarking +
    enableBookmarking +

    Can be one of "url", "server", or "disable". The default value, NULL, will respect the setting from any previous calls to enableBookmarking(). See enableBookmarking() for more information on bookmarking your app.

    -
    uiPattern
    +
    uiPattern +

    A regular expression that will be applied to each GET request to determine whether the ui should be used to handle the request. Note that the entire request path must match the regular expression in order for the match to be considered successful.

    -
    ...
    +
    ... +

    Additional options

    -

    + +
    -

    Value

    +

    Value +

    A Shiny Application.

    + +
    @@ -105,11 +155,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/run_with_opts.html b/reference/run_with_opts.html index 40eb1b9..fbec57d 100644 --- a/reference/run_with_opts.html +++ b/reference/run_with_opts.html @@ -1,5 +1,26 @@ - -Run with Options — run_with_opts • gmhleasr + + + + + + +Run with Options — run_with_opts • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,37 +81,47 @@
    -

    Usage

    +

    Usage +

    run_with_opts(app, opts, maintenance_page = maintenance_page, print = TRUE)
    -

    Arguments

    +

    Arguments +

    -
    app
    +
    +
    app +

    Shiny App object.

    -
    opts
    +
    opts +

    A list of options to pass to the Shiny App.

    -
    maintenance_page
    +
    maintenance_page +

    A Shiny App object to display when the app is in maintenance mode.

    -
    print
    +
    print +

    A logical value to print the app. Defaults to TRUE.

    -
    + +
    -

    Value

    +

    Value +

    A Shiny App object.

    + +
    @@ -83,11 +132,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/strip_phone_number.html b/reference/strip_phone_number.html index c40cca3..d74dfe8 100644 --- a/reference/strip_phone_number.html +++ b/reference/strip_phone_number.html @@ -1,9 +1,30 @@ - -Strip Phone Number — strip_phone_number • gmhleasr + + + + + +Strip Phone Number — strip_phone_number • gmhleasr + + + + + + + + + + + + + +attribute's protocol."> + + + Skip to contents @@ -19,17 +40,35 @@ + + @@ -48,25 +87,32 @@
    -

    Usage

    +

    Usage +

    strip_phone_number(phone)
    -

    Arguments

    +

    Arguments +

    -
    phone
    +
    +
    phone +

    String representing a phone number.

    -
    + +
    -

    Value

    +

    Value +

    Formatted string of the phone number.

    -

    Examples

    +

    Examples +

    strip_phone_number("(555) 555-5555")
 #> [1] "+15555555555"
 strip_phone_number("555-555-5555")
@@ -76,7 +122,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/reference/trim_ws.html b/reference/trim_ws.html index ab51e26..a0fd13b 100644 --- a/reference/trim_ws.html +++ b/reference/trim_ws.html @@ -1,7 +1,28 @@ - -Trim Whitespace — trim_ws • gmhleasr + + + + + + +Trim Whitespace — trim_ws • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -17,17 +38,35 @@ + + @@ -45,7 +84,8 @@
    -

    Usage

    +

    Usage +

    trim_ws(str, ...)
 
 # S3 method for class 'character'
@@ -59,30 +99,38 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    str
    +
    +
    str +

    Character vector, or a data frame.

    -
    ...
    +
    ... +

    Currently not used.

    -
    + +
    -

    Value

    +

    Value +

    Character vector, where trailing and leading white spaces are removed.

    -

    Examples

    +

    Examples +

    trim_ws("  no space!  ")
 #> [1] "no space!"
    + +
    @@ -93,11 +141,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/user_agent.html b/reference/user_agent.html index 68e26f1..491eea3 100644 --- a/reference/user_agent.html +++ b/reference/user_agent.html @@ -1,5 +1,26 @@ - -Create User Agent — user_agent • gmhleasr + + + + + + +Create User Agent — user_agent • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,7 +81,8 @@
    -

    Usage

    +

    Usage +

    user_agent(
   package = "gmhleasr",
   version = utils::packageVersion("gmhleasr"),
@@ -52,35 +92,44 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    package
    +
    +
    package +

    Package name. Default is "gmhleasr".

    -
    version
    +
    version +

    Package version. Default is the current version of "gmhleasr".

    -
    url
    +
    url +

    Package URL. Default is the URL from the package's DESCRIPTION file.

    -
    + +
    -

    Value

    +

    Value +

    User agent string.

    -

    Examples

    +

    Examples +

    user_agent("gmhleasr", "0.0.1")
 #> gmhleasr/0.0.1 (https://github.com/noclocks/gmhleasr,
 #>         https://docs.noclocks.dev/gmhleasr/)
    + +
    @@ -91,11 +140,12 @@

    Examplespkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/utils_html.html b/reference/utils_html.html index eaa46fe..e1996bc 100644 --- a/reference/utils_html.html +++ b/reference/utils_html.html @@ -1,17 +1,38 @@ - -HTML Utilities — utils_html • gmhleasr + + + + + +HTML Utilities — utils_html • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -27,17 +48,35 @@ + + @@ -51,13 +90,16 @@
    -

    • centered(): Centered HTML element

      • +
        +

      • centered(): Centered HTML element

      • help_mark(): Help icon with hover text

      • help_label(): Label with help icon

        • -
    + +
    -

    Usage

    +

    Usage +

    centered(...)
 
 help_mark(help_txt)
@@ -66,31 +108,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    ...
    +
    +
    ... +

    HTML elements

    -
    help_txt
    +
    help_txt +

    Help text

    -
    label_text
    +
    label_text +

    Label text

    -
    + +
    -

    Value

    +

    Value +

    -

    • centered(): Centered HTML element

      • +
        +

      • centered(): Centered HTML element

      • help_mark(): Help icon with hover text

      • help_label(): Label with help

        • -
    + + + +
    @@ -101,11 +153,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/utils_schema.html b/reference/utils_schema.html index 185ee4a..6ef3e40 100644 --- a/reference/utils_schema.html +++ b/reference/utils_schema.html @@ -1,17 +1,38 @@ - -Schema (JSON/YAML) Utilities — utils_schema • gmhleasr + + + + + +Schema (JSON/YAML) Utilities — utils_schema • gmhleasr + + + + + + + + + + + + + +"> + + + Skip to contents @@ -27,17 +48,35 @@ + + @@ -51,13 +90,16 @@
    -

    • write_json_schema(): Write JSON schema to file

      • +
        +

      • write_json_schema(): Write JSON schema to file

      • yaml_to_json(): Convert YAML to JSON

      • yaml_to_list(): Convert YAML to list

        • -
    + +
    -

    Usage

    +

    Usage +

    write_json_schema(schema, path)
 
 yaml_to_json(yaml)
@@ -66,27 +108,36 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    schema
    +
    +
    schema +

    JSON schema

    -
    path
    +
    path +

    File path

    -
    + +
    -

    Value

    +

    Value +

    -

    • write_json_schema(): Invisible file path

      • +
        +

      • write_json_schema(): Invisible file path

      • yaml_to_json(): JSON string

      • yaml_to_list(): List

        • -
    + + + +
    @@ -97,11 +148,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/validate_entrata_config.html b/reference/validate_entrata_config.html index 99f542a..a3ee8ef 100644 --- a/reference/validate_entrata_config.html +++ b/reference/validate_entrata_config.html @@ -1,5 +1,26 @@ - -Validate Entrata API Configuration — validate_entrata_config • gmhleasr + + + + + + +Validate Entrata API Configuration — validate_entrata_config • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,25 +81,32 @@
    -

    Usage

    +

    Usage +

    validate_entrata_config(cfg)
    -

    Arguments

    +

    Arguments +

    -
    cfg
    +
    +
    cfg +

    Either a path to a YAML configuration file or a list object containing the configurations.

    -
    + +
    -

    Value

    +

    Value +

    The original configuration object, invisibly.

    + +
    @@ -71,11 +117,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/validate_entrata_report_name.html b/reference/validate_entrata_report_name.html index 8bfa943..077445d 100644 --- a/reference/validate_entrata_report_name.html +++ b/reference/validate_entrata_report_name.html @@ -1,9 +1,30 @@ - -Validate Entrata Report Name — validate_entrata_report_name • gmhleasr + + + + + +Validate Entrata Report Name — validate_entrata_report_name • gmhleasr + + + + + + + + + + + + + +an error is thrown with suggestions for valid report names."> + + + Skip to contents @@ -19,17 +40,35 @@ + + @@ -48,7 +87,8 @@
    -

    Usage

    +

    Usage +

    validate_entrata_report_name(
   report_name,
   arg = rlang::caller_arg(report_name),
@@ -58,32 +98,41 @@ 
    Usage
    -

    Arguments

    +

    Arguments +

    -
    report_name
    +
    +
    report_name +

    A character string representing the report name to validate.

    -
    arg
    +
    arg +

    The argument name for the report name. Default is the caller's argument name.

    -
    call
    +
    call +

    The calling environment. Default is the caller's environment.

    -
    ...
    +
    ... +

    Additional arguments to pass to the underlying validation functions.

    -
    + +
    -

    Value

    +

    Value +

    NULL. Throws an error if the report name is invalid.

    + +
    @@ -94,11 +143,12 @@

    Value

    Site built with pkgdown 2.1.1.

    -
    - + + - + + diff --git a/reference/verify_css.html b/reference/verify_css.html index 1d795e1..d6b522d 100644 --- a/reference/verify_css.html +++ b/reference/verify_css.html @@ -1,5 +1,26 @@ - -Verify CSS — verify_css • gmhleasr + + + + + + +Verify CSS — verify_css • gmhleasr + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +36,35 @@ + + @@ -42,29 +81,37 @@
    -

    Usage

    +

    Usage +

    verify_css(selector, css)
    -

    Arguments

    +

    Arguments +

    -
    selector
    +
    +
    selector +

    The CSS selector for the element to verify

    -
    css
    +
    css +

    A named list of CSS properties and their expected values

    -
    + +
    -

    Value

    +

    Value +

    A logical value indicating whether the CSS properties match the expected values

    -

    Examples

    +

    Examples +

    if (FALSE) { # \dontrun{
 verify_css("#my-element", list("color" = "red", "font-size" = "16px"))
 } # }
@@ -72,7 +119,8 @@ 
    Examples
    + +
    - + + - + + diff --git a/reference/view_list.html b/reference/view_list.html index 87298fc..19f5c7e 100644 --- a/reference/view_list.html +++ b/reference/view_list.html @@ -1,5 +1,27 @@ - -View List — view_list • gmhleasr + + + + + + +View List — view_list • gmhleasr + + + + + + + + + + + + + + + + + Skip to contents @@ -15,17 +37,35 @@ + + @@ -42,23 +82,31 @@
    -

    Usage

    +

    Usage +

    view_list(listdata = NULL, ...)
    -

    Arguments

    +

    Arguments +

    -
    listdata
    +
    +
    listdata +

    List or string data to view - Although designed for lists, listdata can be any data source that can be rendered into JSON through jsonlite::toJSON(). Alternately, listdata could be a character string of valid JSON. This might be helpful when dealing with an API response.

    -
    ...
    -

    Arguments passed on to listviewer::jsonedit

    mode
    +
    ... +
    +
    +

    Arguments passed on to listviewer::jsonedit

    +
    +
    mode

    string for the initial view from modes. 'tree' is the default.

    modes
    @@ -77,22 +125,27 @@

    Arguments -

    Value

    +

    Value +

    A JSON viewer of the list data.

    -

    Examples

    +

    Examples +

    view_list(list(1, 2, 3))
    + + - + + - + +