Merge.CRMClient 1.0.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Merge.CRMClient --version 1.0.0                

                    
                

            
NuGet\Install-Package Merge.CRMClient -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Merge.CRMClient" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Merge.CRMClient --version 1.0.0                

                    
                

            
#r "nuget: Merge.CRMClient, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Merge.CRMClient as a Cake Addin
#addin nuget:?package=Merge.CRMClient&version=1.0.0

// Install Merge.CRMClient as a Cake Tool
#tool nuget:?package=Merge.CRMClient&version=1.0.0

Merge.CRMClient - the C# library for the Merge CRM API

The unified API for building rich integrations with multiple CRM platforms.

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://www.merge.dev/

<a name="frameworks-supported"></a>

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

<a name="dependencies"></a>

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Merge.CRMClient.Api;
using Merge.CRMClient.Client;
using Merge.CRMClient.Model;

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Merge.CRMClient.Api;
using Merge.CRMClient.Client;
using Merge.CRMClient.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.merge.dev/api/crm/v1";
            // Configure API key authorization: tokenAuth
            config.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountDetailsApi(config);
            var xAccountToken = xAccountToken_example;  // string | Token identifying the end user.

            try
            {
                AccountDetails result = apiInstance.AccountDetailsRetrieve(xAccountToken);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AccountDetailsApi.AccountDetailsRetrieve: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/crm/v1

Class Method HTTP request Description
AccountDetailsApi AccountDetailsRetrieve GET /account-details
AccountTokenApi AccountTokenRetrieve GET /account-token/{public_token}
AccountsApi AccountsCreate POST /accounts
AccountsApi AccountsList GET /accounts
AccountsApi AccountsMetaPatchRetrieve GET /accounts/meta/patch/{id}
AccountsApi AccountsMetaPostRetrieve GET /accounts/meta/post
AccountsApi AccountsPartialUpdate PATCH /accounts/{id}
AccountsApi AccountsRemoteFieldClassesList GET /accounts/remote-field-classes
AccountsApi AccountsRetrieve GET /accounts/{id}
AvailableActionsApi AvailableActionsRetrieve GET /available-actions
CommonModelScopesApi CommonModelScopesCreate POST /common-model-scopes
CommonModelScopesApi CommonModelScopesRetrieve GET /common-model-scopes
ContactsApi ContactsCreate POST /contacts
ContactsApi ContactsIgnoreCreate POST /contacts/ignore/{model_id}
ContactsApi ContactsList GET /contacts
ContactsApi ContactsMetaPatchRetrieve GET /contacts/meta/patch/{id}
ContactsApi ContactsMetaPostRetrieve GET /contacts/meta/post
ContactsApi ContactsPartialUpdate PATCH /contacts/{id}
ContactsApi ContactsRemoteFieldClassesList GET /contacts/remote-field-classes
ContactsApi ContactsRetrieve GET /contacts/{id}
CustomObjectClassesApi CustomObjectClassesAssociationTypesCreate POST /custom-object-classes/{custom_object_class_id}/association-types
CustomObjectClassesApi CustomObjectClassesAssociationTypesList GET /custom-object-classes/{custom_object_class_id}/association-types
CustomObjectClassesApi CustomObjectClassesAssociationTypesMetaPostRetrieve GET /custom-object-classes/{custom_object_class_id}/association-types/meta/post
CustomObjectClassesApi CustomObjectClassesAssociationTypesRetrieve GET /custom-object-classes/{custom_object_class_id}/association-types/{id}
CustomObjectClassesApi CustomObjectClassesCustomObjectsAssociationsList GET /custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations
CustomObjectClassesApi CustomObjectClassesCustomObjectsAssociationsUpdate PUT /custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}
CustomObjectClassesApi CustomObjectClassesCustomObjectsCreate POST /custom-object-classes/{custom_object_class_id}/custom-objects
CustomObjectClassesApi CustomObjectClassesCustomObjectsList GET /custom-object-classes/{custom_object_class_id}/custom-objects
CustomObjectClassesApi CustomObjectClassesCustomObjectsMetaPatchRetrieve GET /custom-object-classes/{custom_object_class_id}/custom-objects/meta/patch/{id}
CustomObjectClassesApi CustomObjectClassesCustomObjectsMetaPostRetrieve GET /custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
CustomObjectClassesApi CustomObjectClassesCustomObjectsPartialUpdate PATCH /custom-object-classes/{custom_object_class_id}/custom-objects/{id}
CustomObjectClassesApi CustomObjectClassesCustomObjectsRetrieve GET /custom-object-classes/{custom_object_class_id}/custom-objects/{id}
CustomObjectClassesApi CustomObjectClassesGeneratorUpdate PUT /custom-object-classes/generator/{generator_id}
CustomObjectClassesApi CustomObjectClassesList GET /custom-object-classes
CustomObjectClassesApi CustomObjectClassesRetrieve GET /custom-object-classes/{id}
DeleteAccountApi DeleteAccountCreate POST /delete-account
EngagementTypesApi EngagementTypesList GET /engagement-types
EngagementTypesApi EngagementTypesRemoteFieldClassesList GET /engagement-types/remote-field-classes
EngagementTypesApi EngagementTypesRetrieve GET /engagement-types/{id}
EngagementsApi EngagementsCreate POST /engagements
EngagementsApi EngagementsList GET /engagements
EngagementsApi EngagementsMetaPatchRetrieve GET /engagements/meta/patch/{id}
EngagementsApi EngagementsMetaPostRetrieve GET /engagements/meta/post
EngagementsApi EngagementsPartialUpdate PATCH /engagements/{id}
EngagementsApi EngagementsRemoteFieldClassesList GET /engagements/remote-field-classes
EngagementsApi EngagementsRetrieve GET /engagements/{id}
ForceResyncApi SyncStatusResyncCreate POST /sync-status/resync
GenerateKeyApi GenerateKeyCreate POST /generate-key
IssuesApi IssuesList GET /issues
IssuesApi IssuesRetrieve GET /issues/{id}
LeadsApi LeadsCreate POST /leads
LeadsApi LeadsList GET /leads
LeadsApi LeadsMetaPostRetrieve GET /leads/meta/post
LeadsApi LeadsRemoteFieldClassesList GET /leads/remote-field-classes
LeadsApi LeadsRetrieve GET /leads/{id}
LinkTokenApi LinkTokenCreate POST /link-token
LinkedAccountsApi LinkedAccountsList GET /linked-accounts
NotesApi NotesCreate POST /notes
NotesApi NotesList GET /notes
NotesApi NotesMetaPostRetrieve GET /notes/meta/post
NotesApi NotesRemoteFieldClassesList GET /notes/remote-field-classes
NotesApi NotesRetrieve GET /notes/{id}
OpportunitiesApi OpportunitiesCreate POST /opportunities
OpportunitiesApi OpportunitiesList GET /opportunities
OpportunitiesApi OpportunitiesMetaPatchRetrieve GET /opportunities/meta/patch/{id}
OpportunitiesApi OpportunitiesMetaPostRetrieve GET /opportunities/meta/post
OpportunitiesApi OpportunitiesPartialUpdate PATCH /opportunities/{id}
OpportunitiesApi OpportunitiesRemoteFieldClassesList GET /opportunities/remote-field-classes
OpportunitiesApi OpportunitiesRetrieve GET /opportunities/{id}
PassthroughApi PassthroughCreate POST /passthrough
RegenerateKeyApi RegenerateKeyCreate POST /regenerate-key
SelectiveSyncApi SelectiveSyncConfigurationsList GET /selective-sync/configurations
SelectiveSyncApi SelectiveSyncConfigurationsUpdate PUT /selective-sync/configurations
SelectiveSyncApi SelectiveSyncMetaList GET /selective-sync/meta
StagesApi StagesList GET /stages
StagesApi StagesRemoteFieldClassesList GET /stages/remote-field-classes
StagesApi StagesRetrieve GET /stages/{id}
SyncStatusApi SyncStatusList GET /sync-status
TasksApi TasksList GET /tasks
TasksApi TasksRemoteFieldClassesList GET /tasks/remote-field-classes
TasksApi TasksRetrieve GET /tasks/{id}
UsersApi UsersIgnoreCreate POST /users/ignore/{model_id}
UsersApi UsersList GET /users
UsersApi UsersRemoteFieldClassesList GET /users/remote-field-classes
UsersApi UsersRetrieve GET /users/{id}
WebhookReceiversApi WebhookReceiversCreate POST /webhook-receivers
WebhookReceiversApi WebhookReceiversList GET /webhook-receivers

<a name="documentation-for-models"></a>

Documentation for Models

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="tokenAuth"></a>

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 187 6/20/2023
1.0.0 206 3/8/2023

Minor update