task

Documentation

Index

• type Client
  • func Plug(apiKey string, rlHttpClient *netwrk.RlHttpClient, url string, ...) *Client
  • func (c *Client) AutoAssignMulti(params onfleet.TaskAutoAssignMultiParams) (onfleet.TaskAutoAssignMultiResponse, error)
  • func (c *Client) BatchCreate(params onfleet.TaskBatchCreateParams) (onfleet.TaskBatchCreateResponse, error)
  • func (c *Client) BatchCreateAsync(params onfleet.TaskBatchCreateParams) (onfleet.TaskBatchCreateResponseAsync, error)
  • func (c *Client) Clone(taskId string, params *onfleet.TaskCloneParams) (onfleet.Task, error)
  • func (c *Client) Create(params onfleet.TaskParams) (onfleet.Task, error)
  • func (c *Client) Delete(taskId string) error
  • func (c *Client) ForceComplete(taskId string, params onfleet.TaskForceCompletionParams) error
  • func (c *Client) Get(taskId string) (onfleet.Task, error)
  • func (c *Client) GetBatchJobStatus(batchJobId string) (onfleet.TaskBatchStatusResponseAsync, error)
  • func (c *Client) GetByShortId(taskShortId string) (onfleet.Task, error)
  • func (c *Client) List(params onfleet.TaskListQueryParams) (onfleet.TasksPaginated, error)
  • func (c *Client) ListWithMetadataQuery(metadata []onfleet.Metadata) ([]onfleet.Task, error)
  • func (c *Client) Update(taskId string, params onfleet.TaskParams) (onfleet.Task, 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) AutoAssignMulti

func (c *Client) AutoAssignMulti(params onfleet.TaskAutoAssignMultiParams) (onfleet.TaskAutoAssignMultiResponse, error)

Reference https://docs.onfleet.com/reference/automatically-assign-list-of-tasks

func (*Client) BatchCreate

func (c *Client) BatchCreate(params onfleet.TaskBatchCreateParams) (onfleet.TaskBatchCreateResponse, error)

Reference https://docs.onfleet.com/reference/create-tasks-in-batch

func (*Client) BatchCreateAsync

func (c *Client) BatchCreateAsync(params onfleet.TaskBatchCreateParams) (onfleet.TaskBatchCreateResponseAsync, error)

Reference https://docs.onfleet.com/reference/create-tasks-in-batch-async

func (*Client) Clone

func (c *Client) Clone(taskId string, params *onfleet.TaskCloneParams) (onfleet.Task, error)

Reference https://docs.onfleet.com/reference/clone-task

func (*Client) Create

func (c *Client) Create(params onfleet.TaskParams) (onfleet.Task, error)

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

func (*Client) Delete

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

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

func (*Client) ForceComplete

func (c *Client) ForceComplete(taskId string, params onfleet.TaskForceCompletionParams) error

Reference https://docs.onfleet.com/reference/complete-task

func (*Client) Get

func (c *Client) Get(taskId string) (onfleet.Task, error)

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

func (*Client) GetBatchJobStatus

func (c *Client) GetBatchJobStatus(batchJobId string) (onfleet.TaskBatchStatusResponseAsync, error)

Reference https://docs.onfleet.com/reference/batch-job-status

func (*Client) GetByShortId

func (c *Client) GetByShortId(taskShortId string) (onfleet.Task, error)

Reference https://docs.onfleet.com/reference/get-single-task-by-shortid

func (*Client) List

func (c *Client) List(params onfleet.TaskListQueryParams) (onfleet.TasksPaginated, error)

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

func (*Client) ListWithMetadataQuery

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

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

func (*Client) Update

func (c *Client) Update(taskId string, params onfleet.TaskParams) (onfleet.Task, error)

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