NetCoreForce.ModelGenerator 6.1.0

NetCoreForce.ModelGenerator

A .NET CLI tool that generates strongly typed C# model classes from your Salesforce org, optionally including custom objects and custom fields. It generates one file per class, named [ClassName].cs, for use with the NetCoreForce.Client Salesforce REST API library for .NET.

Documentation: https://netcoreforce.com/

Install

Requires .NET 8.0 or later.

dotnet tool install --global NetCoreForce.ModelGenerator

To update an existing install:

dotnet tool update --global NetCoreForce.ModelGenerator

The tool is then available as a global command:

NetCoreForce.ModelGenerator generate --help

Authentication

The generator logs in to Salesforce using an OAuth 2.0 flow, set with the --auth-method option or the authMethod config file setting:

The client ID and secret are the Consumer Key and Consumer Secret from your org's connected app or external client app.

Client Credentials requires your org's My Domain token endpoint, e.g. https://your-domain.my.salesforce.com/services/oauth2/token, rather than the default https://login.salesforce.com/services/oauth2/token. The connected app must have the Client Credentials flow enabled, with a run-as user assigned. If no token endpoint is given, the generator prompts for one.

Username-Password is deprecated by Salesforce. It's blocked by default in orgs created in Summer '23 or later, and admins can disable it in any org, so it may not be available in your org. Use Client Credentials where possible.

Usage

Generate models for Account and Contact using Client Credentials, with the client secret in an environment variable:

export NETCOREFORCE_CLIENT_SECRET=your_client_secret
NetCoreForce.ModelGenerator generate --auth-method ClientCredentials --client-id your_client_id --token-request-endpoint https://your-domain.my.salesforce.com/services/oauth2/token -o Account -o Contact -p Sf -n MyProject.Models -d ./Models

(In PowerShell: $env:NETCOREFORCE_CLIENT_SECRET = "your_client_secret")

Generate models including custom objects and referenced objects:

NetCoreForce.ModelGenerator generate -p Sf -r -c -n MyProject.Models -d ~/git/myproject.models

• Prefix classes with "Sf"
• Include referenced objects
• Include custom objects and fields
• Use the "MyProject.Models" namespace
• Place the generated classes in ~/git/myproject.models

Any required settings not given as options or in a config file are prompted for interactively, including the auth method, credentials, objects to generate, and namespace. The client secret and password are not echoed when entered at the prompt.

Secrets

Provide the client secret and password with the NETCOREFORCE_CLIENT_SECRET and NETCOREFORCE_PASSWORD environment variables, or enter them at the prompt. The --client-secret and --password options still work, but print a warning, since command line arguments are visible in shell history and process listings.

The order of precedence is: command option, then environment variable, then config file, then prompt.

The token request endpoint must be HTTPS. The generator shows the host it is logging in to before sending credentials.

Options

Generating all objects: to generate all queryable objects, use -o all, add "all" as the first or only item in the Objects array of the config file, or enter all when prompted.

Referenced objects: with the -r/--include-references option, the generated classes may not compile if a referenced object wasn't also generated. For instance, the Salesforce User object is referenced by many objects. Either generate the referenced objects too, or remove those properties from the generated classes.

Configuration

A config file is optional. Settings given as command options override those in the config file.

By default the generator looks for modelgenerator_config.json in the current directory. Use --config-file to load a different file, and --save-config to save the current options, including any values entered at the prompts, so you don't need to re-enter them next time.

--save-config does not save the client secret, password or refresh token. A config file you write by hand can still contain them, so keep it secure and out of source control - or leave them out and use the environment variables.

Only use a config file you trust: it controls the token endpoint your credentials are sent to.

The apiVersion setting controls the Salesforce API version used to generate the models, and defaults to v67.0.

Example config file

Client Credentials:

{
  "AuthInfo": {
    "authMethod": 2,
    "clientId": "your_client_id",
    "clientSecret": "your_client_secret",
    "tokenRequestEndpoint": "https://your-domain.my.salesforce.com/services/oauth2/token",
    "apiVersion": "v67.0"
  },
  "OutputDirectory": "Models",
  "Objects": [
    "Account",
    "Contact"
  ],
  "ClassPrefix": "Sf",
  "ClassSuffix": null,
  "ClassNamespace": "MyProject.Models",
  "IncludeCustom": true,
  "IncludeReferences": true
}

For Username-Password, set "authMethod": 1 and add "username" and "password" to AuthInfo.

Object Naming

A few Salesforce objects have names that are reserved or easily confused in C#, such as Namespace, Domain, Case, and Task. Use the prefix or suffix option to avoid this, e.g. a "Sf" prefix generates SfTask instead of Task.

Using a prefix is recommended. It avoids naming conflicts, and makes the models easy to find in IntelliSense by typing the prefix. Each generated class records the original Salesforce object name in its summary documentation, and exposes it through the static SObjectTypeName property.

Links

• Documentation
• NetCoreForce.Client
• NetCoreForce.Models - pre-generated models for standard objects
• GitHub repository

Licensed under the MIT license.