worker

Documentation

Index

• type Client
  • func Plug(apiKey string, rlHttpClient *netwrk.RlHttpClient, url string, ...) *Client
  • func (c *Client) Create(params onfleet.WorkerCreateParams) (onfleet.Worker, error)
  • func (c *Client) Delete(workerId string) error
  • func (c *Client) Get(workerId string) (onfleet.Worker, error)
  • func (c *Client) GetSchedule(workerId string) (onfleet.WorkerScheduleEntries, error)
  • func (c *Client) GetWithQuery(workerId string, params onfleet.WorkerGetQueryParams) (map[string]any, error)
  • func (c *Client) List() ([]onfleet.Worker, error)
  • func (c *Client) ListTasks(workerId string, params onfleet.WorkerTasksListQueryParams) (onfleet.WorkerTasks, error)
  • func (c *Client) ListWithMetadataQuery(metadata []onfleet.Metadata) ([]onfleet.Worker, error)
  • func (c *Client) ListWithQuery(params onfleet.WorkerListQueryParams) ([]map[string]any, error)
  • func (c *Client) ListWorkersByLocation(params onfleet.WorkersByLocationListQueryParams) (onfleet.WorkersByLocation, error)
  • func (c *Client) SetSchedule(workerId string, entries onfleet.WorkerScheduleEntries) (onfleet.WorkerScheduleEntries, error)
  • func (c *Client) Update(workerId string, params onfleet.WorkerUpdateParams) (onfleet.Worker, error)

Types

type Client

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

func Plug

func Plug(apiKey string, rlHttpClient *netwrk.RlHttpClient, url string, call netwrk.Caller) *Client

func (*Client) Create

func (c *Client) Create(params onfleet.WorkerCreateParams) (onfleet.Worker, error)

Reference https://docs.onfleet.com/reference/create-worker

func (*Client) Delete

func (c *Client) Delete(workerId string) error

Reference https://docs.onfleet.com/reference/delete-worker

func (*Client) Get

func (c *Client) Get(workerId string) (onfleet.Worker, error)

Reference https://docs.onfleet.com/reference/get-single-worker

func (*Client) GetSchedule

func (c *Client) GetSchedule(workerId string) (onfleet.WorkerScheduleEntries, error)

Reference https://docs.onfleet.com/reference/get-workers-schedule

func (*Client) GetWithQuery

func (c *Client) GetWithQuery(workerId string, params onfleet.WorkerGetQueryParams) (map[string]any, error)

Reference https://docs.onfleet.com/reference/get-single-worker

func (*Client) List

func (c *Client) List() ([]onfleet.Worker, error)

Reference https://docs.onfleet.com/reference/list-workers

func (*Client) ListTasks

func (c *Client) ListTasks(workerId string, params onfleet.WorkerTasksListQueryParams) (onfleet.WorkerTasks, error)

Reference https://docs.onfleet.com/reference/list-workers-assigned-tasks

func (*Client) ListWithMetadataQuery

func (c *Client) ListWithMetadataQuery(metadata []onfleet.Metadata) ([]onfleet.Worker, error)

Reference https://docs.onfleet.com/reference/querying-by-metadata

func (*Client) ListWithQuery

func (c *Client) ListWithQuery(params onfleet.WorkerListQueryParams) ([]map[string]any, error)

Reference // Reference https://docs.onfleet.com/reference/list-workers

func (*Client) ListWorkersByLocation

func (c *Client) ListWorkersByLocation(params onfleet.WorkersByLocationListQueryParams) (onfleet.WorkersByLocation, error)

Reference https://docs.onfleet.com/reference/get-workers-by-location

func (*Client) SetSchedule

func (c *Client) SetSchedule(workerId string, entries onfleet.WorkerScheduleEntries) (onfleet.WorkerScheduleEntries, error)

Reference https://docs.onfleet.com/reference/set-workers-schedule

func (*Client) Update

func (c *Client) Update(workerId string, params onfleet.WorkerUpdateParams) (onfleet.Worker, error)

Reference https://docs.onfleet.com/reference/update-worker