_pkgdown.yml

title: squareupr
url: https://stevenmmortimer.github.io/squareupr
template:
  params:
    bootswatch: spacelab
    ganalytics: UA-98603021-2

home:
  strip_header: true
  
navbar:
  type: default
  left:
    - text: "Articles"
      icon: fas fa-book
      menu: 
      -  text: Getting Started
         href: articles/getting-started.html
    - text: Reference
      icon: fa-file-code-o
      href: reference/index.html
    - text: News
      icon: fa-newspaper-o
      href: news/index.html
  right:
    - text: GitHub
      icon: fa-github fa-lg
      href: https://github.com/StevenMMortimer/squareupr
      
reference:
  - title: Authentication
    desc: Functions used for authenticating
    contents:
      - '`sq_auth`'
  - title: Locations Endpoint
    desc: Functions used for retrieving location details.
    contents:
      - '`sq_get_location`'
      - '`sq_list_locations`'
  - title: Customers Endpoint
    desc: Functions used for creating, retrieving, updating, and deleting customers.
    contents:
      - '`sq_get_customer`'
      - '`sq_list_customers`'
      - '`sq_search_customers`'
      - '`sq_create_customer`'
      - '`sq_delete_customer`'
      - '`sq_update_customer`'
  - title: Transactions Endpoint
    desc: Functions used for retrieving transaction details.
    contents:
      - '`sq_get_transaction`'
      - '`sq_list_transactions`'
  - title: Payments Endpoint
    desc: Functions used for retrieving payment details.
    contents:
      - '`sq_get_payment`'
      - '`sq_list_payments`'
  - title: Items Endpoint
    desc: Functions used for creating, retrieving, updating, and deleting items.
    contents:
      - '`sq_get_item`'
      - '`sq_list_items`'
      - '`sq_create_item`'
      - '`sq_delete_item`'
      - '`sq_update_item`'
  - title: Discounts Endpoint
    desc: Functions used for listing, creating, updating, and deleting discounts.
    contents:
      - '`sq_list_discounts`'
  - title: Fees Endpoint
    desc: Functions used for listing, creating, updating, and deleting fees.
    contents:
      - '`sq_list_fees`'
  - title: Categories Endpoint
    desc: Functions used for listing, creating, updating, and deleting categories.
    contents:
      - '`sq_list_categories`'   
  - title: Modifiers Endpoint
    desc: Functions used for listing, creating, updating, and deleting modifiers.
    contents:
      - '`sq_list_modifiers`'       
  - title: Package Utilities
    desc: Utility functions that make it easier to use the **squareupr** package
    contents:
      - '`sq_null_to_na`'
      - '`sq_extract_cust_groups`'