# README

Go API client for merge_hris_client

The unified API for building rich integrations with multiple HR Information System platforms.

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: 1.0
Package version: 1.3.0
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.merge.dev/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./merge_hris_client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

Class	Method	HTTP request
AccountDetailsApi	AccountDetailsRetrieve	Get /account-details
AccountTokenApi	AccountTokenRetrieve	Get /account-token/{public_token}
AvailableActionsApi	AvailableActionsRetrieve	Get /available-actions
BankInfoApi	BankInfoList	Get /bank-info
BankInfoApi	BankInfoRetrieve	Get /bank-info/{id}
BenefitsApi	BenefitsList	Get /benefits
BenefitsApi	BenefitsRetrieve	Get /benefits/{id}
CompaniesApi	CompaniesList	Get /companies
CompaniesApi	CompaniesRetrieve	Get /companies/{id}
DeleteAccountApi	DeleteAccountCreate	Post /delete-account
EmployeePayrollRunsApi	EmployeePayrollRunsList	Get /employee-payroll-runs
EmployeePayrollRunsApi	EmployeePayrollRunsRetrieve	Get /employee-payroll-runs/{id}
EmployeesApi	EmployeesCreate	Post /employees
EmployeesApi	EmployeesIgnoreCreate	Post /employees/ignore/{model_id}
EmployeesApi	EmployeesList	Get /employees
EmployeesApi	EmployeesMetaPostRetrieve	Get /employees/meta/post
EmployeesApi	EmployeesRetrieve	Get /employees/{id}
EmploymentsApi	EmploymentsList	Get /employments
EmploymentsApi	EmploymentsRetrieve	Get /employments/{id}
ForceResyncApi	SyncStatusResyncCreate	Post /sync-status/resync
GenerateKeyApi	GenerateKeyCreate	Post /generate-key
GroupsApi	GroupsList	Get /groups
GroupsApi	GroupsRetrieve	Get /groups/{id}
IssuesApi	IssuesList	Get /issues
IssuesApi	IssuesRetrieve	Get /issues/{id}
LinkTokenApi	LinkTokenCreate	Post /link-token
LinkedAccountsApi	LinkedAccountsList	Get /linked-accounts
LocationsApi	LocationsList	Get /locations
LocationsApi	LocationsRetrieve	Get /locations/{id}
PassthroughApi	PassthroughCreate	Post /passthrough
PayGroupsApi	PayGroupsList	Get /pay-groups
PayGroupsApi	PayGroupsRetrieve	Get /pay-groups/{id}
PayrollRunsApi	PayrollRunsList	Get /payroll-runs
PayrollRunsApi	PayrollRunsRetrieve	Get /payroll-runs/{id}
RegenerateKeyApi	RegenerateKeyCreate	Post /regenerate-key
SelectiveSyncApi	SelectiveSyncConfigurationsList	Get /selective-sync/configurations
SelectiveSyncApi	SelectiveSyncConfigurationsUpdate	Put /selective-sync/configurations
SelectiveSyncApi	SelectiveSyncMetaList	Get /selective-sync/meta
SyncStatusApi	SyncStatusList	Get /sync-status
TeamsApi	TeamsList	Get /teams
TeamsApi	TeamsRetrieve	Get /teams/{id}
TimeOffApi	TimeOffCreate	Post /time-off
TimeOffApi	TimeOffList	Get /time-off
TimeOffApi	TimeOffMetaPostRetrieve	Get /time-off/meta/post
TimeOffApi	TimeOffRetrieve	Get /time-off/{id}
TimeOffBalancesApi	TimeOffBalancesList	Get /time-off-balances
TimeOffBalancesApi	TimeOffBalancesRetrieve	Get /time-off-balances/{id}
WebhookReceiversApi	WebhookReceiversCreate	Post /webhook-receivers
WebhookReceiversApi	WebhookReceiversList	Get /webhook-receivers

Documentation For Models

Documentation For Authorization

tokenAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

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]