webhooks

Documentation

Overview

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Index

• type WebhookSubscriptions
  • func (e *WebhookSubscriptions) GetPrimary() *types.GUID
• type WebhookSubscriptionsEndpoint
  • func (s *WebhookSubscriptionsEndpoint) Create(ctx context.Context, division int, entity *WebhookSubscriptions) (*WebhookSubscriptions, error)
  • func (s *WebhookSubscriptionsEndpoint) Delete(ctx context.Context, division int, id *types.GUID) error
  • func (s *WebhookSubscriptionsEndpoint) Get(ctx context.Context, division int, id *types.GUID) (*WebhookSubscriptions, error)
  • func (s *WebhookSubscriptionsEndpoint) List(ctx context.Context, division int, all bool, o *api.ListOptions) ([]*WebhookSubscriptions, error)
  • func (s *WebhookSubscriptionsEndpoint) New() *WebhookSubscriptions
  • func (s *WebhookSubscriptionsEndpoint) Update(ctx context.Context, division int, entity *WebhookSubscriptions) (*WebhookSubscriptions, error)
  • func (s *WebhookSubscriptionsEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)
• type WebhooksService
  • func NewWebhooksService(apiClient *api.Client) *WebhooksService

Types

type WebhookSubscriptions

type WebhookSubscriptions struct {
	MetaData *api.MetaData `json:"__metadata,omitempty"`
	// ID: Primary key
	ID *types.GUID `json:"ID,omitempty"`

	// CallbackURL: Callback URL endpoint
	CallbackURL *string `json:"CallbackURL,omitempty"`

	// ClientID: OAuth client Id
	ClientID *types.GUID `json:"ClientID,omitempty"`

	// Created: Creation date
	Created *types.Date `json:"Created,omitempty"`

	// Creator: User ID of creator
	Creator *types.GUID `json:"Creator,omitempty"`

	// CreatorFullName: Name of creator
	CreatorFullName *string `json:"CreatorFullName,omitempty"`

	// Description: Description of the OAuth Client
	Description *string `json:"Description,omitempty"`

	// Division: Division code
	Division *int `json:"Division,omitempty"`

	// Topic: Webhook subscription topic, e.g.: FinancialTransactions, Items, StockPositions
	Topic *string `json:"Topic,omitempty"`
}

WebhookSubscriptions: Service: Webhooks Entity: WebhookSubscriptions URL: /api/v1/{division}/webhooks/WebhookSubscriptions HasWebhook: false IsInBeta: false Methods: GET POST PUT DELETE Endpoint docs: https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=WebhooksWebhookSubscriptions

func (*WebhookSubscriptions) GetPrimary

func (e *WebhookSubscriptions) GetPrimary() *types.GUID

type WebhookSubscriptionsEndpoint

type WebhookSubscriptionsEndpoint service

WebhookSubscriptionsEndpoint is responsible for communicating with the WebhookSubscriptions endpoint of the Webhooks service.

func (*WebhookSubscriptionsEndpoint) Create

func (s *WebhookSubscriptionsEndpoint) Create(ctx context.Context, division int, entity *WebhookSubscriptions) (*WebhookSubscriptions, error)

Create the WebhookSubscriptions entity in the provided division.

func (*WebhookSubscriptionsEndpoint) Delete

func (s *WebhookSubscriptionsEndpoint) Delete(ctx context.Context, division int, id *types.GUID) error

Delete the WebhookSubscriptions entity in the provided division.

func (*WebhookSubscriptionsEndpoint) Get

func (s *WebhookSubscriptionsEndpoint) Get(ctx context.Context, division int, id *types.GUID) (*WebhookSubscriptions, error)

Get the WebhookSubscriptions entitiy in the provided division.

func (*WebhookSubscriptionsEndpoint) List

func (s *WebhookSubscriptionsEndpoint) List(ctx context.Context, division int, all bool, o *api.ListOptions) ([]*WebhookSubscriptions, error)

List the WebhookSubscriptions entities in the provided division. If all is true, all the paginated results are fetched; if false, list the first page.

func (*WebhookSubscriptionsEndpoint) New

func (s *WebhookSubscriptionsEndpoint) New() *WebhookSubscriptions

New returns an empty WebhookSubscriptions entity

func (*WebhookSubscriptionsEndpoint) Update

func (s *WebhookSubscriptionsEndpoint) Update(ctx context.Context, division int, entity *WebhookSubscriptions) (*WebhookSubscriptions, error)

Update the WebhookSubscriptions entity in the provided division.

func (*WebhookSubscriptionsEndpoint) UserHasRights

func (s *WebhookSubscriptionsEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)

type WebhooksService

type WebhooksService struct {

	// Endpoints available under this service
	WebhookSubscriptions *WebhookSubscriptionsEndpoint
	// contains filtered or unexported fields
}

WebhooksService is responsible for communication with the Webhooks endpoints of the Exact Online API.

func NewWebhooksService

func NewWebhooksService(apiClient *api.Client) *WebhooksService

NewWebhooksService creates a new initialized instance of the WebhooksService.