_pkgdown.yml

title: salesforcer
url: https://stevenmmortimer.github.io/salesforcer
template:
  params:
    bootswatch: spacelab
    ganalytics: UA-98603021-2
    docsearch:
      api_key: c7d5ea1103660127418415a82a24fc3d
      index_name: salesforcer

home:
  strip_header: true
  
navbar:
  type: default
  left:
    - text: "Articles"
      icon: fas fa-book
      menu: 
      -  text: Getting Started
         href: articles/getting-started.html
      -  text: Working with Bulk API
         href: articles/working-with-bulk-api.html
      -  text: Transitioning from RForcecom
         href: articles/transitioning-from-RForcecom.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/salesforcer
      
reference:
  - title: Authentication
    desc: Functions used for authenticating
    contents:
      - '`sf_auth`'
  - title: Query/Search Functions
    desc: Functions used for querying and searching
    contents:
      - '`sf_query`'
      - '`sf_search`'
  - title: CRUD Functions
    desc: Functions used for create, retrieve, update, and delete records.
    contents:
      - '`sf_create`'
      - '`sf_retrieve`'
      - '`sf_update`'
      - '`sf_upsert`'
      - '`sf_delete`'
  - title: Metadata Functions
    desc: Functions used for create, retrieve, update, and delete metadata.
    contents:
      - '`sf_create_metadata`'
      - '`sf_update_metadata`'
      - '`sf_upsert_metadata`'
      - '`sf_delete_metadata`'
      - '`sf_rename_metadata`'
      - '`sf_read_metadata`'
      - '`sf_list_metadata`'
      - '`sf_retrieve_metadata`'
      - '`sf_describe_metadata`'
      - '`sf_describe_objects`'
      - '`sf_describe_object_fields`'
  - title: Salesforce Org Utility Functions
    desc: Functions used for basic calls to understand the org.
    contents:
      - '`sf_user_info`'
      - '`sf_server_timestamp`'
      - '`sf_list_rest_api_versions`'
      - '`sf_list_resources`'
      - '`sf_list_api_limits`'
      - '`sf_list_objects`'
  - title: Backward Compatibility with RForcecom
    desc: Functions that mirror RForcecom to ease code transitions between salesforcer and RForcecom
    contents:
      - '`rforcecom.login`'
      - '`rforcecom.getServerTimestamp`'
      - '`rforcecom.getObjectDescription`'
      - '`rforcecom.create`'
      - '`rforcecom.update`'
      - '`rforcecom.upsert`'
      - '`rforcecom.delete`'
      - '`rforcecom.retrieve`'
      - '`rforcecom.search`'
      - '`rforcecom.query`'
      - '`rforcecom.bulkQuery`'