package
0.2.2
Repository: https://github.com/russman12/go-force.git
Documentation: pkg.go.dev

# README

Go client for Salesforce Rest 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

ClassMethodHTTP requestSummary
OrgApiGetLimitsGet /limitsList Org Limits
OrgApiGetResourcesGet /List Available REST Resources
SObjectApiCreateRecordPost /sobjects/{sObject}Create Records Using sObject Basic Information
SObjectApiGetBasicInfoGet /sobjects/{sObject}Retrieve Object Metadata Using sObject Basic Information
SObjectApiGetSObjectsGet /sobjectsGet a List of Objects
SObjectApiRetrieveRecordGet /sobjects/{sObject}/{recordId}Retrieve Records Using sObject Rows
SObjectApiSObjectDescribeGet /sobjects/{sObject}/describeRetrieve Metadata for an Object

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

CacheExpires helper function to determine remaining time before repeating a request.
NewActionOverrides instantiates a new ActionOverrides 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.
NewActionOverridesWithDefaults instantiates a new ActionOverrides 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.
NewChildRelationships instantiates a new ChildRelationships 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.
NewChildRelationshipsWithDefaults instantiates a new ChildRelationships 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.
NewConfiguration returns a new Configuration object.
NewConfigurationWithActiveServerVars returns a new Configuration object with the default server and variable replacements set.
NewCreateRecordResult instantiates a new CreateRecordResult 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.
NewCreateRecordResultWithDefaults instantiates a new CreateRecordResult 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.
NewFieldDescribe instantiates a new FieldDescribe 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.
NewFieldDescribePicklist instantiates a new FieldDescribePicklist 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.
NewFieldDescribePicklistWithDefaults instantiates a new FieldDescribePicklist 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.
NewFieldDescribeWithDefaults instantiates a new FieldDescribe 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.
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.
NewModelError instantiates a new ModelError 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.
NewModelErrorWithDefaults instantiates a new ModelError 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
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.
NewRecordTypeInfoUrls instantiates a new RecordTypeInfoUrls 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.
NewRecordTypeInfoUrlsWithDefaults instantiates a new RecordTypeInfoUrls 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.
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.
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.
NewSObjectDescribes instantiates a new SObjectDescribes 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.
NewSObjectDescribesWithDefaults instantiates a new SObjectDescribes 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.
NewSupportedScopes instantiates a new SupportedScopes 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.
NewSupportedScopesWithDefaults instantiates a new SupportedScopes 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.

# Constants

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 fieldType.
List of fieldType.
List of fieldType.
List of fieldType.

# Variables

All allowed values of EncodingType enum.
All allowed values of FieldType 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

ActionOverrides struct for ActionOverrides.
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
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
ChildRelationships struct for ChildRelationships.
Configuration stores the configuration of the API client.
CreateRecordResult struct for CreateRecordResult.
FieldDescribe struct for FieldDescribe.
FieldDescribePicklist struct for FieldDescribePicklist.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
ModelError struct for ModelError.
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
RecordTypeInfo struct for RecordTypeInfo.
RecordTypeInfoUrls struct for RecordTypeInfoUrls.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SObjectDescribe struct for SObjectDescribe.
SObjectDescribes struct for SObjectDescribes.
SupportedScopes struct for SupportedScopes.

# Interfaces

No description provided by the author
No description provided by the author

# Type aliases

EncodingType Use a compression header to compress a REST API request or response.
FieldType the model 'FieldType'.
OrgApiService OrgApi service.
ServerConfigurations stores multiple ServerConfiguration items.
SObjectApiService SObjectApi service.