mergeatsgo

package module
v0.12.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 27, 2024 License: MIT Imports: 12 Imported by: 0

README

ATS Go SDK

Merge is a single API to add hundreds of integrations to your app.

SDK Installation

go get github.com/speakeasy-sdks/merge-ats-go

SDK Example Usage

Example

package main

import (
	"context"
	mergeatsgo "github.com/speakeasy-sdks/merge-ats-go"
	"github.com/speakeasy-sdks/merge-ats-go/pkg/models/shared"
	"log"
)

func main() {
	s := mergeatsgo.New(
		mergeatsgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	var xAccountToken string = "<value>"

	ctx := context.Background()
	res, err := s.AccountDetails.Retrieve(ctx, xAccountToken)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountDetails != nil {
		// handle response
	}
}

Available Resources and Operations

AccountDetails

  • Retrieve - Get details for a linked account.

AccountToken

  • Retrieve - Returns the account token for the end user with the provided public token.

Activities

  • Create - Creates an Activity object with the given values.
  • List - Returns a list of Activity objects.
  • Retrieve - Returns an Activity object with the given id.
  • RetrievePostMetadata - Returns metadata for Activity POSTs.

Applications

  • Create - Creates an Application object with the given values.
  • List - Returns a list of Application objects.
  • Retrieve - Returns an Application object with the given id.
  • RetrievePostMetadata - Returns metadata for Application POSTs.
  • UpdateChangeState - Updates the current_stage field of an Application object

AsyncPassthrough

  • Create - Asynchronously pull data from an endpoint not currently supported by Merge.
  • Retrieve - Retrieves data from earlier async-passthrough POST request

Attachments

  • Create - Creates an Attachment object with the given values.
  • List - Returns a list of Attachment objects.
  • Retrieve - Returns an Attachment object with the given id.
  • RetrievePostMetadata - Returns metadata for Attachment POSTs.

AvailableActions

  • Retrieve - Returns a list of models and actions available for an account.

Candidates

  • Create - Creates a Candidate object with the given values.
  • IgnoreCreate - Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
  • List - Returns a list of Candidate objects.
  • Retrieve - Returns a Candidate object with the given id.
  • RetrievePatchMetadata - Returns metadata for Candidate PATCHs.
  • RetrievePostMetadata - Returns metadata for Candidate POSTs.
  • Update - Updates a Candidate object with the given id.

DeleteAccount

Departments

  • List - Returns a list of Department objects.
  • Retrieve - Returns a Department object with the given id.

Eeocs

  • List - Returns a list of EEOC objects.
  • Retrieve - Returns an EEOC object with the given id.

GenerateKey

  • Create - Create a remote key.

Interviews

  • Create - Creates a ScheduledInterview object with the given values.
  • List - Returns a list of ScheduledInterview objects.
  • Retrieve - Returns a ScheduledInterview object with the given id.
  • RetrievePostMetadata - Returns metadata for ScheduledInterview POSTs.

Issues

JobInterviewStages

  • List - Returns a list of JobInterviewStage objects.
  • Retrieve - Returns a JobInterviewStage object with the given id.

Jobs

  • List - Returns a list of Job objects.
  • Retrieve - Returns a Job object with the given id.

LinkToken

  • Create - Creates a link token to be used when linking a new end user.

LinkedAccounts

  • List - List linked accounts for your organization.

Offers

  • List - Returns a list of Offer objects.
  • Retrieve - Returns an Offer object with the given id.

Offices

  • List - Returns a list of Office objects.
  • Retrieve - Returns an Office object with the given id.

Passthrough

  • Create - Pull data from an endpoint not currently supported by Merge.

RegenerateKey

  • Create - Exchange remote keys.

RejectReasons

  • List - Returns a list of RejectReason objects.
  • Retrieve - Returns a RejectReason object with the given id.

Scorecards

  • List - Returns a list of Scorecard objects.
  • Retrieve - Returns a Scorecard object with the given id.

SelectiveSync

  • List - Get a linked account's selective syncs.
  • RetrievePostMetadata - Get metadata for the conditions available to a linked account.
  • Update - Replace a linked account's selective syncs.

SyncStatus

  • List - Get syncing status. Possible values: DISABLED, DONE, FAILED, PARTIALLY_SYNCED, PAUSED, SYNCING

ForceResync

  • Create - Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.

Tags

  • List - Returns a list of Tag objects.

Users

  • List - Returns a list of RemoteUser objects.
  • Retrieve - Returns a RemoteUser object with the given id.

WebhookReceivers

  • Create - Creates a WebhookReceiver object with the given values.
  • List - Returns a list of WebhookReceiver objects.

Special Types

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

Example

package main

import (
	"context"
	"errors"
	mergeatsgo "github.com/speakeasy-sdks/merge-ats-go"
	"github.com/speakeasy-sdks/merge-ats-go/pkg/models/sdkerrors"
	"github.com/speakeasy-sdks/merge-ats-go/pkg/models/shared"
	"log"
)

func main() {
	s := mergeatsgo.New(
		mergeatsgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	var xAccountToken string = "<value>"

	ctx := context.Background()
	res, err := s.AccountDetails.Retrieve(ctx, xAccountToken)
	if err != nil {

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://api.merge.dev/api/ats/v1 None
1 https://api-sandbox.merge.dev/api/ats/v1 None
Example
package main

import (
	"context"
	mergeatsgo "github.com/speakeasy-sdks/merge-ats-go"
	"github.com/speakeasy-sdks/merge-ats-go/pkg/models/shared"
	"log"
)

func main() {
	s := mergeatsgo.New(
		mergeatsgo.WithServerIndex(1),
		mergeatsgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	var xAccountToken string = "<value>"

	ctx := context.Background()
	res, err := s.AccountDetails.Retrieve(ctx, xAccountToken)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountDetails != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	mergeatsgo "github.com/speakeasy-sdks/merge-ats-go"
	"github.com/speakeasy-sdks/merge-ats-go/pkg/models/shared"
	"log"
)

func main() {
	s := mergeatsgo.New(
		mergeatsgo.WithServerURL("https://api.merge.dev/api/ats/v1"),
		mergeatsgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	var xAccountToken string = "<value>"

	ctx := context.Background()
	res, err := s.AccountDetails.Retrieve(ctx, xAccountToken)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountDetails != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
TokenAuth apiKey API key

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	mergeatsgo "github.com/speakeasy-sdks/merge-ats-go"
	"log"
)

func main() {
	s := mergeatsgo.New(
		mergeatsgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	var xAccountToken string = "<value>"

	ctx := context.Background()
	res, err := s.AccountDetails.Retrieve(ctx, xAccountToken)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountDetails != nil {
		// handle response
	}
}

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ServerList = []string{

	"https://api.merge.dev/api/ats/v1",

	"https://api-sandbox.merge.dev/api/ats/v1",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool 

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int 

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String 

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type AccountDetails added in v0.8.0 

type AccountDetails struct {
	// contains filtered or unexported fields
}

func (*AccountDetails) Retrieve added in v0.8.0 

func (s *AccountDetails) Retrieve(ctx context.Context, xAccountToken string) (*operations.AccountDetailsRetrieveResponse, error)

Retrieve - Get details for a linked account.

type AccountToken added in v0.8.0 

type AccountToken struct {
	// contains filtered or unexported fields
}

func (*AccountToken) Retrieve added in v0.8.0 

func (s *AccountToken) Retrieve(ctx context.Context, publicToken string) (*operations.AccountTokenRetrieveResponse, error)

Retrieve - Returns the account token for the end user with the provided public token.

type Activities added in v0.8.0 

type Activities struct {
	// contains filtered or unexported fields
}

func (*Activities) Create added in v0.8.0 

func (s *Activities) Create(ctx context.Context, activityEndpointRequest shared.ActivityEndpointRequest, xAccountToken string, isDebugMode *bool, runAsync *bool) (*operations.ActivitiesCreateResponse, error)

Create - Creates an `Activity` object with the given values.

func (*Activities) List added in v0.8.0 

func (s *Activities) List(ctx context.Context, request operations.ActivitiesListRequest) (*operations.ActivitiesListResponse, error)

List - Returns a list of `Activity` objects.

func (*Activities) Retrieve added in v0.8.0 

func (s *Activities) Retrieve(ctx context.Context, request operations.ActivitiesRetrieveRequest) (*operations.ActivitiesRetrieveResponse, error)

Retrieve - Returns an `Activity` object with the given `id`.

func (*Activities) RetrievePostMetadata added in v0.8.0 

func (s *Activities) RetrievePostMetadata(ctx context.Context, xAccountToken string) (*operations.ActivitiesMetaPostRetrieveResponse, error)

RetrievePostMetadata - Returns metadata for `Activity` POSTs.

type Applications added in v0.8.0 

type Applications struct {
	// contains filtered or unexported fields
}

func (*Applications) Create added in v0.8.0 

func (s *Applications) Create(ctx context.Context, applicationEndpointRequest shared.ApplicationEndpointRequest, xAccountToken string, isDebugMode *bool, runAsync *bool) (*operations.ApplicationsCreateResponse, error)

Create - Creates an `Application` object with the given values.

func (*Applications) List added in v0.8.0 

func (s *Applications) List(ctx context.Context, request operations.ApplicationsListRequest) (*operations.ApplicationsListResponse, error)

List - Returns a list of `Application` objects.

func (*Applications) Retrieve added in v0.8.0 

func (s *Applications) Retrieve(ctx context.Context, xAccountToken string, id string, expand *operations.ApplicationsRetrieveQueryParamExpand, includeRemoteData *bool) (*operations.ApplicationsRetrieveResponse, error)

Retrieve - Returns an `Application` object with the given `id`.

func (*Applications) RetrievePostMetadata added in v0.8.0 

func (s *Applications) RetrievePostMetadata(ctx context.Context, xAccountToken string, applicationRemoteTemplateID *string) (*operations.ApplicationsMetaPostRetrieveResponse, error)

RetrievePostMetadata - Returns metadata for `Application` POSTs.

func (*Applications) UpdateChangeState added in v0.8.0 

func (s *Applications) UpdateChangeState(ctx context.Context, request operations.ApplicationsChangeStageCreateRequest) (*operations.ApplicationsChangeStageCreateResponse, error)

UpdateChangeState - Updates the `current_stage` field of an `Application` object

type AsyncPassthrough added in v0.8.0 

type AsyncPassthrough struct {
	// contains filtered or unexported fields
}

func (*AsyncPassthrough) Create added in v0.8.0 

func (s *AsyncPassthrough) Create(ctx context.Context, dataPassthroughRequest shared.DataPassthroughRequest, xAccountToken string) (*operations.AsyncPassthroughCreateResponse, error)

Create - Asynchronously pull data from an endpoint not currently supported by Merge.

func (*AsyncPassthrough) Retrieve added in v0.8.0 

func (s *AsyncPassthrough) Retrieve(ctx context.Context, xAccountToken string, asyncPassthroughReceiptID string) (*operations.AsyncPassthroughRetrieveResponse, error)

Retrieve - Retrieves data from earlier async-passthrough POST request

type Ats 

type Ats struct {
	AccountDetails     *AccountDetails
	AccountToken       *AccountToken
	Activities         *Activities
	Applications       *Applications
	AsyncPassthrough   *AsyncPassthrough
	Attachments        *Attachments
	AvailableActions   *AvailableActions
	Candidates         *Candidates
	DeleteAccount      *DeleteAccount
	Departments        *Departments
	Eeocs              *Eeocs
	GenerateKey        *GenerateKey
	Interviews         *Interviews
	Issues             *Issues
	JobInterviewStages *JobInterviewStages
	Jobs               *Jobs
	LinkToken          *LinkToken
	LinkedAccounts     *LinkedAccounts
	Offers             *Offers
	Offices            *Offices
	Passthrough        *Passthrough
	RegenerateKey      *RegenerateKey
	RejectReasons      *RejectReasons
	Scorecards         *Scorecards
	SelectiveSync      *SelectiveSync
	SyncStatus         *SyncStatus
	ForceResync        *ForceResync
	Tags               *Tags
	Users              *Users
	WebhookReceivers   *WebhookReceivers
	// contains filtered or unexported fields
}

Ats - Merge ATS API: The unified API for building rich integrations with multiple Applicant Tracking System platforms.

func New 

func New(opts ...SDKOption) *Ats

New creates a new instance of the SDK with the provided options

type Attachments added in v0.8.0 

type Attachments struct {
	// contains filtered or unexported fields
}

func (*Attachments) Create added in v0.8.0 

func (s *Attachments) Create(ctx context.Context, attachmentEndpointRequest shared.AttachmentEndpointRequest, xAccountToken string, isDebugMode *bool, runAsync *bool) (*operations.AttachmentsCreateResponse, error)

Create - Creates an `Attachment` object with the given values.

func (*Attachments) List added in v0.8.0 

func (s *Attachments) List(ctx context.Context, request operations.AttachmentsListRequest) (*operations.AttachmentsListResponse, error)

List - Returns a list of `Attachment` objects.

func (*Attachments) Retrieve added in v0.8.0 

func (s *Attachments) Retrieve(ctx context.Context, request operations.AttachmentsRetrieveRequest) (*operations.AttachmentsRetrieveResponse, error)

Retrieve - Returns an `Attachment` object with the given `id`.

func (*Attachments) RetrievePostMetadata added in v0.8.0 

func (s *Attachments) RetrievePostMetadata(ctx context.Context, xAccountToken string) (*operations.AttachmentsMetaPostRetrieveResponse, error)

RetrievePostMetadata - Returns metadata for `Attachment` POSTs.

type AvailableActions added in v0.8.0 

type AvailableActions struct {
	// contains filtered or unexported fields
}

func (*AvailableActions) Retrieve added in v0.8.0 

func (s *AvailableActions) Retrieve(ctx context.Context, xAccountToken string) (*operations.AvailableActionsRetrieveResponse, error)

Retrieve - Returns a list of models and actions available for an account.

type Candidates added in v0.8.0 

type Candidates struct {
	// contains filtered or unexported fields
}

func (*Candidates) Create added in v0.8.0 

func (s *Candidates) Create(ctx context.Context, candidateEndpointRequest shared.CandidateEndpointRequest, xAccountToken string, isDebugMode *bool, runAsync *bool) (*operations.CandidatesCreateResponse, error)

Create - Creates a `Candidate` object with the given values.

func (*Candidates) IgnoreCreate added in v0.8.0 

func (s *Candidates) IgnoreCreate(ctx context.Context, ignoreCommonModelRequest shared.IgnoreCommonModelRequest, xAccountToken string, modelID string) (*operations.CandidatesIgnoreCreateResponse, error)

IgnoreCreate - Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.

func (*Candidates) List added in v0.8.0 

func (s *Candidates) List(ctx context.Context, request operations.CandidatesListRequest) (*operations.CandidatesListResponse, error)

List - Returns a list of `Candidate` objects.

func (*Candidates) Retrieve added in v0.8.0 

func (s *Candidates) Retrieve(ctx context.Context, xAccountToken string, id string, expand *operations.CandidatesRetrieveQueryParamExpand, includeRemoteData *bool) (*operations.CandidatesRetrieveResponse, error)

Retrieve - Returns a `Candidate` object with the given `id`.

func (*Candidates) RetrievePatchMetadata added in v0.8.0 

func (s *Candidates) RetrievePatchMetadata(ctx context.Context, xAccountToken string, id string) (*operations.CandidatesMetaPatchRetrieveResponse, error)

RetrievePatchMetadata - Returns metadata for `Candidate` PATCHs.

func (*Candidates) RetrievePostMetadata added in v0.8.0 

func (s *Candidates) RetrievePostMetadata(ctx context.Context, xAccountToken string) (*operations.CandidatesMetaPostRetrieveResponse, error)

RetrievePostMetadata - Returns metadata for `Candidate` POSTs.

func (*Candidates) Update added in v0.8.0 

func (s *Candidates) Update(ctx context.Context, request operations.PartialUpdateRequest) (*operations.PartialUpdateResponse, error)

Update - Updates a `Candidate` object with the given `id`.

type DeleteAccount added in v0.8.0 

type DeleteAccount struct {
	// contains filtered or unexported fields
}

func (*DeleteAccount) DeleteAccountDelete added in v0.8.0 

func (s *DeleteAccount) DeleteAccountDelete(ctx context.Context, xAccountToken string) (*operations.DeleteAccountDeleteResponse, error)

DeleteAccountDelete - Delete a linked account.

type Departments added in v0.8.0 

type Departments struct {
	// contains filtered or unexported fields
}

func (*Departments) List added in v0.8.0 

func (s *Departments) List(ctx context.Context, request operations.DepartmentsListRequest) (*operations.DepartmentsListResponse, error)

List - Returns a list of `Department` objects.

func (*Departments) Retrieve added in v0.8.0 

func (s *Departments) Retrieve(ctx context.Context, xAccountToken string, id string, includeRemoteData *bool) (*operations.DepartmentsRetrieveResponse, error)

Retrieve - Returns a `Department` object with the given `id`.

type Eeocs added in v0.8.0 

type Eeocs struct {
	// contains filtered or unexported fields
}

func (*Eeocs) List added in v0.8.0 

func (s *Eeocs) List(ctx context.Context, request operations.EeocsListRequest) (*operations.EeocsListResponse, error)

List - Returns a list of `EEOC` objects.

func (*Eeocs) Retrieve added in v0.8.0 

func (s *Eeocs) Retrieve(ctx context.Context, request operations.EeocsRetrieveRequest) (*operations.EeocsRetrieveResponse, error)

Retrieve - Returns an `EEOC` object with the given `id`.

type ForceResync added in v0.8.0 

type ForceResync struct {
	// contains filtered or unexported fields
}

func (*ForceResync) Create added in v0.8.0 

func (s *ForceResync) Create(ctx context.Context, xAccountToken string) (*operations.SyncStatusResyncCreateResponse, error)

Create - Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.

type GenerateKey added in v0.8.0 

type GenerateKey struct {
	// contains filtered or unexported fields
}

func (*GenerateKey) Create added in v0.8.0 

func (s *GenerateKey) Create(ctx context.Context, request shared.GenerateRemoteKeyRequest) (*operations.GenerateKeyCreateResponse, error)

Create a remote key.

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type Interviews added in v0.8.0 

type Interviews struct {
	// contains filtered or unexported fields
}

func (*Interviews) Create added in v0.8.0 

func (s *Interviews) Create(ctx context.Context, scheduledInterviewEndpointRequest shared.ScheduledInterviewEndpointRequest, xAccountToken string, isDebugMode *bool, runAsync *bool) (*operations.InterviewsCreateResponse, error)

Create - Creates a `ScheduledInterview` object with the given values.

func (*Interviews) List added in v0.8.0 

func (s *Interviews) List(ctx context.Context, request operations.InterviewsListRequest) (*operations.InterviewsListResponse, error)

List - Returns a list of `ScheduledInterview` objects.

func (*Interviews) Retrieve added in v0.8.0 

func (s *Interviews) Retrieve(ctx context.Context, request operations.InterviewsRetrieveRequest) (*operations.InterviewsRetrieveResponse, error)

Retrieve - Returns a `ScheduledInterview` object with the given `id`.

func (*Interviews) RetrievePostMetadata added in v0.8.0 

func (s *Interviews) RetrievePostMetadata(ctx context.Context, xAccountToken string) (*operations.InterviewsMetaPostRetrieveResponse, error)

RetrievePostMetadata - Returns metadata for `ScheduledInterview` POSTs.

type Issues added in v0.8.0 

type Issues struct {
	// contains filtered or unexported fields
}

func (*Issues) List added in v0.8.0 

func (s *Issues) List(ctx context.Context, request operations.IssuesListRequest) (*operations.IssuesListResponse, error)

List - Gets issues.

func (*Issues) Retrieve added in v0.8.0 

func (s *Issues) Retrieve(ctx context.Context, id string) (*operations.IssuesRetrieveResponse, error)

Retrieve - Get a specific issue.

type JobInterviewStages added in v0.8.0 

type JobInterviewStages struct {
	// contains filtered or unexported fields
}

func (*JobInterviewStages) List added in v0.8.0 

func (s *JobInterviewStages) List(ctx context.Context, request operations.JobInterviewStagesListRequest) (*operations.JobInterviewStagesListResponse, error)

List - Returns a list of `JobInterviewStage` objects.

func (*JobInterviewStages) Retrieve added in v0.8.0 

func (s *JobInterviewStages) Retrieve(ctx context.Context, xAccountToken string, id string, expand *operations.JobInterviewStagesRetrieveQueryParamExpand, includeRemoteData *bool) (*operations.JobInterviewStagesRetrieveResponse, error)

Retrieve - Returns a `JobInterviewStage` object with the given `id`.

type Jobs added in v0.8.0 

type Jobs struct {
	// contains filtered or unexported fields
}

func (*Jobs) List added in v0.8.0 

func (s *Jobs) List(ctx context.Context, request operations.JobsListRequest) (*operations.JobsListResponse, error)

List - Returns a list of `Job` objects.

func (*Jobs) Retrieve added in v0.8.0 

func (s *Jobs) Retrieve(ctx context.Context, request operations.JobsRetrieveRequest) (*operations.JobsRetrieveResponse, error)

Retrieve - Returns a `Job` object with the given `id`.

type LinkToken added in v0.8.0 

type LinkToken struct {
	// contains filtered or unexported fields
}

func (*LinkToken) Create added in v0.8.0 

func (s *LinkToken) Create(ctx context.Context, request shared.EndUserDetailsRequest) (*operations.LinkTokenCreateResponse, error)

Create - Creates a link token to be used when linking a new end user.

type LinkedAccounts added in v0.8.0 

type LinkedAccounts struct {
	// contains filtered or unexported fields
}

func (*LinkedAccounts) List added in v0.8.0 

func (s *LinkedAccounts) List(ctx context.Context, request operations.LinkedAccountsListRequest) (*operations.LinkedAccountsListResponse, error)

List linked accounts for your organization.

type Offers added in v0.8.0 

type Offers struct {
	// contains filtered or unexported fields
}

func (*Offers) List added in v0.8.0 

func (s *Offers) List(ctx context.Context, request operations.OffersListRequest) (*operations.OffersListResponse, error)

List - Returns a list of `Offer` objects.

func (*Offers) Retrieve added in v0.8.0 

func (s *Offers) Retrieve(ctx context.Context, request operations.OffersRetrieveRequest) (*operations.OffersRetrieveResponse, error)

Retrieve - Returns an `Offer` object with the given `id`.

type Offices added in v0.8.0 

type Offices struct {
	// contains filtered or unexported fields
}

func (*Offices) List added in v0.8.0 

func (s *Offices) List(ctx context.Context, request operations.OfficesListRequest) (*operations.OfficesListResponse, error)

List - Returns a list of `Office` objects.

func (*Offices) Retrieve added in v0.8.0 

func (s *Offices) Retrieve(ctx context.Context, xAccountToken string, id string, includeRemoteData *bool) (*operations.OfficesRetrieveResponse, error)

Retrieve - Returns an `Office` object with the given `id`.

type Passthrough added in v0.8.0 

type Passthrough struct {
	// contains filtered or unexported fields
}

func (*Passthrough) Create added in v0.8.0 

func (s *Passthrough) Create(ctx context.Context, dataPassthroughRequest shared.DataPassthroughRequest, xAccountToken string) (*operations.PassthroughCreateResponse, error)

Create - Pull data from an endpoint not currently supported by Merge.

type RegenerateKey added in v0.8.0 

type RegenerateKey struct {
	// contains filtered or unexported fields
}

func (*RegenerateKey) Create added in v0.8.0 

func (s *RegenerateKey) Create(ctx context.Context, request shared.RemoteKeyForRegenerationRequest) (*operations.RegenerateKeyCreateResponse, error)

Create - Exchange remote keys.

type RejectReasons added in v0.8.0 

type RejectReasons struct {
	// contains filtered or unexported fields
}

func (*RejectReasons) List added in v0.8.0 

func (s *RejectReasons) List(ctx context.Context, request operations.RejectReasonsListRequest) (*operations.RejectReasonsListResponse, error)

List - Returns a list of `RejectReason` objects.

func (*RejectReasons) Retrieve added in v0.8.0 

func (s *RejectReasons) Retrieve(ctx context.Context, xAccountToken string, id string, includeRemoteData *bool) (*operations.RejectReasonsRetrieveResponse, error)

Retrieve - Returns a `RejectReason` object with the given `id`.

type SDKOption 

type SDKOption func(*Ats)

func WithClient 

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig added in v0.5.0 

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithSecurity added in v0.6.0 

func WithSecurity(tokenAuth string) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource added in v0.6.0 

func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

func WithServerIndex 

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL 

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL 

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

type Scorecards added in v0.8.0 

type Scorecards struct {
	// contains filtered or unexported fields
}

func (*Scorecards) List added in v0.8.0 

func (s *Scorecards) List(ctx context.Context, request operations.ScorecardsListRequest) (*operations.ScorecardsListResponse, error)

List - Returns a list of `Scorecard` objects.

func (*Scorecards) Retrieve added in v0.8.0 

func (s *Scorecards) Retrieve(ctx context.Context, request operations.ScorecardsRetrieveRequest) (*operations.ScorecardsRetrieveResponse, error)

Retrieve - Returns a `Scorecard` object with the given `id`.

type SelectiveSync added in v0.8.0 

type SelectiveSync struct {
	// contains filtered or unexported fields
}

func (*SelectiveSync) List added in v0.8.0 

func (s *SelectiveSync) List(ctx context.Context, xAccountToken string) (*operations.SelectiveSyncConfigurationsListResponse, error)

List - Get a linked account's selective syncs.

func (*SelectiveSync) RetrievePostMetadata added in v0.8.0 

func (s *SelectiveSync) RetrievePostMetadata(ctx context.Context, xAccountToken string, commonModel *string, cursor *string, pageSize *int64) (*operations.SelectiveSyncMetaListResponse, error)

RetrievePostMetadata - Get metadata for the conditions available to a linked account.

func (*SelectiveSync) Update added in v0.8.0 

func (s *SelectiveSync) Update(ctx context.Context, linkedAccountSelectiveSyncConfigurationListRequest shared.LinkedAccountSelectiveSyncConfigurationListRequest, xAccountToken string) (*operations.SelectiveSyncConfigurationsUpdateResponse, error)

Update - Replace a linked account's selective syncs.

type SyncStatus added in v0.8.0 

type SyncStatus struct {
	// contains filtered or unexported fields
}

func (*SyncStatus) List added in v0.8.0 

func (s *SyncStatus) List(ctx context.Context, xAccountToken string, cursor *string, pageSize *int64) (*operations.SyncStatusListResponse, error)

List - Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`

type Tags added in v0.8.0 

type Tags struct {
	// contains filtered or unexported fields
}

func (*Tags) List added in v0.8.0 

func (s *Tags) List(ctx context.Context, request operations.TagsListRequest) (*operations.TagsListResponse, error)

List - Returns a list of `Tag` objects.

type Users added in v0.8.0 

type Users struct {
	// contains filtered or unexported fields
}

func (*Users) List added in v0.8.0 

func (s *Users) List(ctx context.Context, request operations.UsersListRequest) (*operations.UsersListResponse, error)

List - Returns a list of `RemoteUser` objects.

func (*Users) Retrieve added in v0.8.0 

func (s *Users) Retrieve(ctx context.Context, request operations.UsersRetrieveRequest) (*operations.UsersRetrieveResponse, error)

Retrieve - Returns a `RemoteUser` object with the given `id`.

type WebhookReceivers added in v0.8.0 

type WebhookReceivers struct {
	// contains filtered or unexported fields
}

func (*WebhookReceivers) Create added in v0.8.0 

func (s *WebhookReceivers) Create(ctx context.Context, webhookReceiverRequest shared.WebhookReceiverRequest, xAccountToken string) (*operations.WebhookReceiversCreateResponse, error)

Create - Creates a `WebhookReceiver` object with the given values.

func (*WebhookReceivers) List added in v0.8.0 

func (s *WebhookReceivers) List(ctx context.Context, xAccountToken string) (*operations.WebhookReceiversListResponse, error)

List - Returns a list of `WebhookReceiver` objects.

Source Files

View all Source files

Directories

Path Synopsis
internal
hooks
pkg
models/operations
models/sdkerrors
models/shared
types
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.