Categorygithub.com/russman12/go-forcepkgtooling
package
0.2.2
Repository: https://github.com/russman12/go-force.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
23
Dependents
0
Files
9.8k SLOC

# README

Go client for Salesforce Tooling API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 56.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Documentation for API Endpoints

All URIs are relative to https://myorg.lightning.force.com/services/data/v56.0/tooling

ClassMethodHTTP requestSummary
DefaultApiCreateRecordPost /sobjects/{SObjectName}Create a new record
DefaultApiDeleteRecordDelete /sobjects/{SObjectName}/{id}Delete record
DefaultApiDescribeSObjectGet /sobjects/{SObjectName}/describeCompletely describe SObject metadata
DefaultApiExecuteAnonymousGet /executeAnonymousExecutes anonymous Apex
DefaultApiGetCompletionsGet /completionsRetrieve available code completions
DefaultApiGetSObjectGet /sobjects/{SObjectName}Describe SObject metadata
DefaultApiGetSObjectsGet /sobjectsList SObjects
DefaultApiQueryGet /queryExecutes query
DefaultApiRetrieveRecordGet /sobjects/{SObjectName}/{id}Retrieve records or fields
DefaultApiRunTestsAsyncPost /runTestsAsynchronousRun tests asynchronously
DefaultApiRunTestsSyncPost /runTestsSynchronousRun tests synchronously
DefaultApiSearchGet /searchExecutes SOSL
DefaultApiUpdateRecordPatch /sobjects/{SObjectName}/{id}Update record

Documentation For Models

Documentation For Authorization

oAuth (password)

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A

Example

package main

import (
    "golang.org/x/oauth2"
    "context"
)

func main() {
    oAuth2Cfg := oauth2.Config{}
    token, err := oAuth2Cfg.PasswordCredentialsToken(context.Background(), "username", "password")
    if err != nil {
        panic(err)
    }
    tokenSrc := oAuth2Cfg.TokenSource(context.Background(), token)
    packageName.NewAPIClient(packageName.NewConfiguration(), tokenSrc)
}

oAuth (application)

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

Example

package main

import (
    "golang.org/x/oauth2"
    "context"
)

func main() {
    oAuth2Cfg := clientcredentials.Config{}
    tokenSrc := oAuth2Cfg.TokenSource(context.Background())
    packageName.NewAPIClient(packageName.NewConfiguration(), tokenSrc)
}

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]

# Packages

No description provided by the author

# Functions

AsyncTestSimpleRequestAsAsyncTestRequest is a convenience function that returns AsyncTestSimpleRequest wrapped in AsyncTestRequest.
CacheExpires helper function to determine remaining time before repeating a request.
NewActionOverride instantiates a new ActionOverride object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewActionOverrideWithDefaults instantiates a new ActionOverride object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewAsyncTestSimpleRequest instantiates a new AsyncTestSimpleRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAsyncTestSimpleRequestWithDefaults instantiates a new AsyncTestSimpleRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewChildRelationship instantiates a new ChildRelationship object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewChildRelationshipWithDefaults instantiates a new ChildRelationship object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCodeCoverageResult instantiates a new CodeCoverageResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCodeCoverageResultWithDefaults instantiates a new CodeCoverageResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCodeCoverageWarning instantiates a new CodeCoverageWarning object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCodeCoverageWarningWithDefaults instantiates a new CodeCoverageWarning object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCodeLocation instantiates a new CodeLocation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCodeLocationWithDefaults instantiates a new CodeLocation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCompletionTypeFromValue returns a pointer to a valid CompletionType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewConfiguration returns a new Configuration object.
NewConfigurationWithActiveServerVars returns a new Configuration object with the default server and variable replacements set.
NewDescribeGlobalResult instantiates a new DescribeGlobalResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDescribeGlobalResultWithDefaults instantiates a new DescribeGlobalResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDescribeSObjectResult instantiates a new DescribeSObjectResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDescribeSObjectResultExt instantiates a new DescribeSObjectResultExt object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDescribeSObjectResultExtWithDefaults instantiates a new DescribeSObjectResultExt object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDescribeSObjectResultWithDefaults instantiates a new DescribeSObjectResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEncodingTypeFromValue returns a pointer to a valid EncodingType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewExecuteAnonymousResult instantiates a new ExecuteAnonymousResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecuteAnonymousResultWithDefaults instantiates a new ExecuteAnonymousResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewField instantiates a new Field object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFieldTypeFromValue returns a pointer to a valid FieldType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewFieldWithDefaults instantiates a new Field object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFlowCoverageResult instantiates a new FlowCoverageResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFlowCoverageResultWithDefaults instantiates a new FlowCoverageResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFlowCoverageWarning instantiates a new FlowCoverageWarning object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFlowCoverageWarningWithDefaults instantiates a new FlowCoverageWarning object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFlowProcessTypeFromValue returns a pointer to a valid FlowProcessType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewNamedLayoutInfo instantiates a new NamedLayoutInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNamedLayoutInfoWithDefaults instantiates a new NamedLayoutInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPicklistEntry instantiates a new PicklistEntry object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPicklistEntryWithDefaults instantiates a new PicklistEntry object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewQueryResult instantiates a new QueryResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewQueryResultWithDefaults instantiates a new QueryResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRecordTypeInfo instantiates a new RecordTypeInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRecordTypeInfoWithDefaults instantiates a new RecordTypeInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRunTestsResult instantiates a new RunTestsResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRunTestsResultWithDefaults instantiates a new RunTestsResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewScopeInfo instantiates a new ScopeInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewScopeInfoWithDefaults instantiates a new ScopeInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSObjectDescribe instantiates a new SObjectDescribe object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSObjectDescribeURL instantiates a new SObjectDescribeURL object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSObjectDescribeURLWithDefaults instantiates a new SObjectDescribeURL object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSObjectDescribeWithDefaults instantiates a new SObjectDescribe object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSObjectResult instantiates a new SObjectResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSObjectResultWithDefaults instantiates a new SObjectResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSOSLResult instantiates a new SOSLResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSOSLResultWithDefaults instantiates a new SOSLResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTestLevelFromValue returns a pointer to a valid TestLevel for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewTestRequest instantiates a new TestRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTestRequestWithDefaults instantiates a new TestRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTestResultsSuccess instantiates a new TestResultsSuccess object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTestResultsSuccessWithDefaults instantiates a new TestResultsSuccess object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTestsArrayClassIdItem instantiates a new TestsArrayClassIdItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTestsArrayClassIdItemWithDefaults instantiates a new TestsArrayClassIdItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTestsArrayClassNameItem instantiates a new TestsArrayClassNameItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTestsArrayClassNameItemWithDefaults instantiates a new TestsArrayClassNameItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTestsArrayMaxFailedTestsItem instantiates a new TestsArrayMaxFailedTestsItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTestsArrayMaxFailedTestsItemWithDefaults instantiates a new TestsArrayMaxFailedTestsItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTestsArrayTestLevelItem instantiates a new TestsArrayTestLevelItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTestsArrayTestLevelItemWithDefaults instantiates a new TestsArrayTestLevelItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
TestRequestAsAsyncTestRequest is a convenience function that returns TestRequest wrapped in AsyncTestRequest.
TestsArrayClassIdItemAsTestsArrayItem is a convenience function that returns TestsArrayClassIdItem wrapped in TestsArrayItem.
TestsArrayClassNameItemAsTestsArrayItem is a convenience function that returns TestsArrayClassNameItem wrapped in TestsArrayItem.
TestsArrayMaxFailedTestsItemAsTestsArrayItem is a convenience function that returns TestsArrayMaxFailedTestsItem wrapped in TestsArrayItem.
TestsArrayTestLevelItemAsTestsArrayItem is a convenience function that returns TestsArrayTestLevelItem wrapped in TestsArrayItem.

# Constants

List of CompletionType.
List of CompletionType.
List of EncodingType.
List of EncodingType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FieldType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of FlowProcessType.
List of TestLevel.
List of TestLevel.
List of TestLevel.

# Variables

All allowed values of CompletionType enum.
All allowed values of EncodingType enum.
All allowed values of FieldType enum.
All allowed values of FlowProcessType enum.
All allowed values of TestLevel enum.
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.

# Structs

ActionOverride struct for ActionOverride.
APIClient manages communication with the Salesforce Platform REST API API v56.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AsyncTestRequest - struct for AsyncTestRequest.
AsyncTestSimpleRequest struct for AsyncTestSimpleRequest.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
ChildRelationship struct for ChildRelationship.
CodeCoverageResult struct for CodeCoverageResult.
CodeCoverageWarning struct for CodeCoverageWarning.
CodeLocation struct for CodeLocation.
Configuration stores the configuration of the API client.
DescribeGlobalResult struct for DescribeGlobalResult.
DescribeSObjectResult struct for DescribeSObjectResult.
DescribeSObjectResultExt struct for DescribeSObjectResultExt.
ExecuteAnonymousResult struct for ExecuteAnonymousResult.
Field struct for Field.
FlowCoverageResult struct for FlowCoverageResult.
FlowCoverageWarning struct for FlowCoverageWarning.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
NamedLayoutInfo struct for NamedLayoutInfo.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PicklistEntry struct for PicklistEntry.
QueryResult struct for QueryResult.
RecordTypeInfo The name of the named layout for the object.
RunTestsResult struct for RunTestsResult.
ScopeInfo A scope for an object that can be used to filter object records.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SObjectDescribe struct for SObjectDescribe.
SObjectDescribeURL struct for SObjectDescribeURL.
SObjectResult struct for SObjectResult.
SOSLResult struct for SOSLResult.
TestRequest struct for TestRequest.
TestResultsSuccess struct for TestResultsSuccess.
TestsArrayClassIdItem struct for TestsArrayClassIdItem.
TestsArrayClassNameItem struct for TestsArrayClassNameItem.
TestsArrayItem - struct for TestsArrayItem.
TestsArrayMaxFailedTestsItem struct for TestsArrayMaxFailedTestsItem.
TestsArrayTestLevelItem struct for TestsArrayTestLevelItem.

# Interfaces

No description provided by the author

# Type aliases

CompletionType Type of completion.
DefaultApiService DefaultApi service.
EncodingType Use a compression header to compress a REST API request or response.
FieldType See FieldType for a list of allowable values.
FlowProcessType the model 'FlowProcessType'.
ServerConfigurations stores multiple ServerConfiguration items.
TestLevel the model 'TestLevel'.