From d89bc504075f2781db75dea7f8ab9611ab239971 Mon Sep 17 00:00:00 2001 From: Willie Ruemmele Date: Fri, 3 May 2024 08:26:18 -0600 Subject: [PATCH] docs: update readme --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8d2a95d..b2d1876 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,25 @@ This repository contains the full Salesforce WSDL files. These files are used primarily by tooling vendors to build tools for developing on the Salesforce platform. +# @salesforce/types + +--- + +These wsdls are the source for generating the types found in the `@salesforce/types` package. These can be used in your code like + +```typescript +import type { LogCategory } from '@salesforce/types/apex'; +import type { TestLevel } from '@salesforce/types/metadata'; +import type { StatusCode } from '@salesforce/types/partner'; +import type { PermissionSetFlowAccess } from '@salesforce/types/tooling'; +``` + +We also additionally publish a schema type `ApiSchemaTypes` with each file that can serve as a parseable index of type names to types. + ## Contributing -We do not accept contributions or issues to this repository. These files are provided as reference only. No support is provided for this repository. +--- + +We do not accept contributions or issues to this repository. These files are provided as reference only. No support is provided for this repository. -For future Salesforce employees looking to update this repo, instructions are [here](https://salesforce.quip.com/6bQJAJbfE5Lo). \ No newline at end of file +For future Salesforce employees looking to update this repo, instructions are [here](https://salesforce.quip.com/6bQJAJbfE5Lo).