onfleet

package module

Go to main page

Versions in this module

v0

v0.5.4

Dec 12, 2024

Changes in this version

+ type PositionEnum string

+ const PositionEnumHub

+ const PositionEnumWorkerAddress

+ const PositionEnumWorkerLocation

+ type RoutePlan struct

+ ActualEndTime *int64

+ ActualStartTime *int64

+ Color string

+ EndTime *int64

+ EndingHubId *string

+ Id string

+ Name string

+ Organization string

+ ShortId string

+ StartTime int64

+ StartingHubId *string

+ State string

+ Tasks []string

+ Team *string

+ TimeCreated int64

+ TimeLastModified int64

+ VehicleType string

+ Worker string

+ type RoutePlanAddTasksParams struct

+ Tasks []string

+ type RoutePlanListQueryParams struct

+ CreatedTimeFrom int64

+ CreatedTimeTo int64

+ HasTasks bool

+ Limit int64

+ StartTimeFrom int64

+ StartTimeTo int64

+ WorkerId string

+ type RoutePlanParams struct

+ Color string

+ EndAt PositionEnum

+ EndTime int64

+ EndingHubId string

+ Name string

+ StartAt PositionEnum

+ StartTime int64

+ StartingHubId string

+ TaskIds []string

+ Team string

+ Timezone string

+ VehicleType string

+ Worker string

+ type RoutePlansPaginated struct

+ LastId string

+ RoutePlans []RoutePlan

type Task

+ RoutePlan *string

v0.5.3

Dec 10, 2024

Changes in this version

type TaskListQueryParams

+ Dependencies []string

+ type TooManyRequestsError struct

+ func (err TooManyRequestsError) Error() string

v0.5.2

Dec 10, 2024

Changes in this version

+ const CustomFieldValidDataTypeBoolean

+ const CustomFieldValidDataTypeDate

+ const CustomFieldValidDataTypeDecimal

+ const CustomFieldValidDataTypeInteger

+ const CustomFieldValidDataTypeMultiLineText

+ const CustomFieldValidDataTypeSingleLineText

+ const CustomFieldValidDataTypeURL

+ const CustomFieldVisibilityOptionAPI

+ const CustomFieldVisibilityOptionAdmin

+ const CustomFieldVisibilityOptionWorker

+ type CustomField struct

+ AsArray bool

+ Contexts []CustomFieldContext

+ Description string

+ Editability []CustomFieldVisibilityOption

+ Key string

+ Name string

+ Type CustomFieldValidDataType

+ Value any

+ Visibility []CustomFieldVisibilityOption

+ type CustomFieldContext struct

+ Conditions []any

+ IsRequired bool

+ Name string

+ type CustomFieldParams struct

+ Key string

+ Value any

+ type CustomFieldValidDataType string

+ type CustomFieldVisibilityOption string

type Task

+ CustomFields []CustomField

type TaskParams

+ CustomFields []CustomFieldParams

v0.5.1

Jan 18, 2024

Changes in this version

+ type DeliveryManifest struct

+ DepartureTime int64

+ Driver Driver

+ HubAddress string

+ ManifestDate int64

+ Tasks []Task

+ TotalDistance string

+ TurnByTurn []TurnByTurn

+ Vehicle WorkerVehicleParam

+ type Driver struct

+ Name string

+ Phone string

+ type ManifestGenerateParams struct

+ HubId string

+ WorkerId string

type Task

+ ETA *int64

+ type TurnByTurn struct

+ DrivingDistance string

+ ETA int64

+ EndAddress string

+ StartAddress string

+ Steps []string

v0.5.0

Oct 18, 2023

Changes in this version

+ type TaskBatchCreateErrorAsync struct

+ Cause string

+ ErrorCode int

+ Message string

+ StatusCode int

+ TaskData TaskParams

+ type TaskBatchCreateResponseAsync struct

+ JobID string

+ Status string

+ type TaskBatchStatusResponseAsync struct

+ Errors []TaskBatchCreateErrorAsync

+ FailedTasks []TaskParams

+ NewTasks []Task

+ NewTasksWithWarnings []Task

+ Status string

+ Submitted string

+ TasksCreated int

+ TasksErrored int

+ TasksReceived int

v0.4.0

Jun 2, 2023

v0.3.1

Apr 6, 2023

Changes in this version

type TaskListQueryParams

+ LastId string

v0.3.0

Apr 6, 2023

Changes in this version

+ type TaskListQueryParams struct

+ CompleteAfterAfter int64

+ CompleteBeforeBefore int64

+ From int64

+ LastID string

+ To int64

+ Worker string

+ type TasksPaginated struct

+ LastId string

+ Tasks []Task

v0.2.3

Mar 31, 2023

v0.2.2

Mar 31, 2023

Changes in this version

type DestinationCreateParams

+ Metadata []Metadata

v0.2.1

Mar 31, 2023

v0.2.0

Mar 31, 2023

v0.1.6

Mar 31, 2023

Changes in this version

+ func ParseError(r io.Reader) error

+ type Admin struct

+ Email string

+ ID string

+ IsAccountOwner bool

+ IsActive bool

+ IsReadOnly bool

+ Metadata []Metadata

+ Name string

+ Organization string

+ Phone string

+ Teams []string

+ TimeCreated int64

+ TimeLastModified int64

+ Type string

+ type AdminCreateParams struct

+ Email string

+ IsReadOnly bool

+ Metadata []Metadata

+ Name string

+ Phone string

+ Type string

+ type AdminUpdateParams struct

+ Email string

+ Metadata []Metadata

+ Name string

+ Phone string

+ type Container struct

+ ActiveTask *string

+ ID string

+ Organization string

+ Tasks []string

+ Team string

+ TimeCreated int64

+ TimeLastModified int64

+ Type ContainerType

+ Worker string

+ type ContainerQueryKey string

+ const ContainerQueryKeyOrganizations

+ const ContainerQueryKeyTeams

+ const ContainerQueryKeyWorkers

+ type ContainerTaskInsertParams struct

+ ConsiderDependencies bool

+ Tasks []any

+ type ContainerType string

+ const ContainerTypeOrganization

+ const ContainerTypeTeam

+ const ContainerTypeWorker

+ type Destination struct

+ Address DestinationAddress

+ GooglePlaceId string

+ ID string

+ Location DestinationLocation

+ Metadata []Metadata

+ Notes string

+ TimeCreated int64

+ TimeLastModified int64

+ Warnings []any

+ type DestinationAddress struct

+ Apartment string

+ City string

+ Country string

+ Name string

+ Number string

+ PostalCode string

+ State string

+ Street string

+ Unparsed string

+ type DestinationCreateParams struct

+ Address DestinationAddress

+ Location DestinationLocation

+ Notes string

+ Options *DestinationOptionsParam

+ type DestinationLocation []float64

+ type DestinationOptionsParam struct

+ Language string

+ type Hub struct

+ Address DestinationAddress

+ ID string

+ Location DestinationLocation

+ Name string

+ Teams []string

+ type HubCreateParams struct

+ Address DestinationAddress

+ Name string

+ Teams []string

+ type HubUpdateParams struct

+ Address DestinationAddress

+ Name string

+ Teams []string

+ type Metadata struct

+ Name string

+ Subtype string

+ Type string

+ Value any

+ Visibility []MetadataVisibilityOption

+ type MetadataVisibilityOption string

+ const MetadataVisibilityOptionApi

+ const MetadataVisibilityOptionDashboard

+ const MetadataVisibilityOptionWorker

+ type Organization struct

+ Country string

+ Delegatees []string

+ DriverSupportEmail string

+ Email string

+ ID string

+ Image string

+ Name string

+ TimeCreated int64

+ TimeLastModified int64

+ Timezone string

+ type OrganizationDelegate struct

+ Country string

+ DriverSupportEmail string

+ Email string

+ ID string

+ IsFulfillment bool

+ Name string

+ Timezone string

+ type Recipient struct

+ ID string

+ Metadata []Metadata

+ Name string

+ Notes string

+ Organization string

+ Phone string

+ SkipSmsNotifications bool

+ TimeCreated int64

+ TimeLastModified int64

+ type RecipientCreateParams struct

+ Metadata []Metadata

+ Name string

+ Notes string

+ Phone string

+ SkipPhoneNumberValidation bool

+ SkipSmsNotifications bool

+ UseLongCodeForText bool

+ type RecipientQueryKey string

+ const RecipientQueryKeyName

+ const RecipientQueryKeyPhone

+ type RecipientUpdateParams struct

+ Metadata []Metadata

+ Name string

+ Notes string

+ SkipSmsNotifications bool

+ type RequestError struct

+ Code string

+ Message RequestErrorMessage

+ func (err RequestError) Error() string

+ type RequestErrorMessage struct

+ Cause any

+ Error int

+ Message string

+ RemoteAddress string

+ Request string

+ StatusCode int

+ type Task struct

+ AdditionalQuantities TaskAdditionalQuantities

+ Appearance TaskAppearance

+ Barcodes *TaskBarcodeContainer

+ CompleteAfter *int64

+ CompleteBefore *int64

+ CompletionDetails TaskCompletionDetails

+ Container *TaskContainer

+ Creator string

+ DelayTime *float64

+ Dependencies []string

+ Destination Destination

+ EstimatedArrivalTime *int64

+ EstimatedCompletionTime *int64

+ Eta *int64

+ Executor string

+ Feedback []any

+ ID string

+ Identity TaskIdentity

+ Merchant string

+ Metadata []Metadata

+ Notes string

+ Organization string

+ Overrides TaskOverrides

+ PickupTask bool

+ Quantity float64

+ Recipients []Recipient

+ ScanOnlyRequiredBarcodes bool

+ ServiceTime float64

+ ShortId string

+ SourceTaskId string

+ State TaskState

+ TimeCreated int64

+ TimeLastModified int64

+ TrackingUrl string

+ TrackingViewed bool

+ Worker *string

+ type TaskAdditionalQuantities struct

+ QuantityA float64

+ QuantityB float64

+ QuantityC float64

+ type TaskAppearance struct

+ TriangleColor *string

+ type TaskAppearanceParam struct

+ TriangleColor string

+ type TaskAutoAssignMode string

+ const TaskAutoAssignModeDistance

+ const TaskAutoAssignModeLoad

+ type TaskAutoAssignMultiOptionsParam struct

+ ConsiderDependencies bool

+ ExcludedWorkerIds []string

+ MaxAssignedTaskCount int

+ Mode TaskAutoAssignMode

+ RestrictAutoAssignmentToTeam bool

+ Teams []string

+ type TaskAutoAssignMultiParams struct

+ Options TaskAutoAssignMultiOptionsParam

+ Tasks []string

+ type TaskAutoAssignMultiResponse struct

+ AssignedTasks []string

+ AssignedTasksCount int

+ type TaskAutoAssignParam struct

+ ConsiderDependencies bool

+ ExcludedWorkerIds []string

+ MaxAssignedTaskCount int

+ Mode TaskAutoAssignMode

+ Team string

+ type TaskBarcode struct

+ BlockCompletion bool

+ Data string

+ type TaskBarcodeContainer struct

+ Captured []TaskCapturedBarcode

+ Required []TaskBarcode

+ type TaskBatchCreateError struct

+ Error RequestErrorMessage

+ Task TaskParams

+ type TaskBatchCreateParams struct

+ Tasks []TaskParams

+ type TaskBatchCreateResponse struct

+ Errors []TaskBatchCreateError

+ Tasks []Task

+ type TaskCapturedBarcode struct

+ Data string

+ ID string

+ Location DestinationLocation

+ Symbology string

+ Time int64

+ WasRequested bool

+ type TaskCloneOverridesParam struct

+ CompleteAfter int64

+ CompleteBefore int64

+ Destination any

+ Metadata []Metadata

+ Notes string

+ PickupTask bool

+ Recipients any

+ ServiceTime float64

+ type TaskCloneParams struct

+ IncludeBarcodes bool

+ IncludeDependencies bool

+ IncludeMetadata bool

+ Overrides *TaskCloneOverridesParam

+ type TaskCompletionDetails struct

+ Actions []any

+ Distance float64

+ Events []TaskCompletionEvent

+ FailureNotes string

+ FailureReason string

+ FirstLocation DestinationLocation

+ LastLocation DestinationLocation

+ Notes string

+ PhotoUploadId *string

+ PhotoUploadIds *[]string

+ SignatureUploadId *string

+ Success bool

+ Time *int64

+ UnavailableAttachments []any

+ type TaskCompletionEvent struct

+ Location DestinationLocation

+ Name string

+ Time int64

+ type TaskCompletionRequirementsParam struct

+ MinimumAge int

+ Notes bool

+ Photo bool

+ Signature bool

+ type TaskContainer struct

+ Organization string

+ Team string

+ Type ContainerType

+ Worker string

+ type TaskForceCompletionDetailsParam struct

+ Notes string

+ Success bool

+ type TaskForceCompletionParams struct

+ CompletionDetails TaskForceCompletionDetailsParam

+ type TaskIdentity struct

+ Checksum *any

+ FailedScanCount int

+ type TaskOverrides struct

+ RecipientName *string

+ RecipientNotes *string

+ RecipientSkipSmsNotifications *bool

+ UseMerchantForProxy *string

+ type TaskParams struct

+ Appearance *TaskAppearanceParam

+ AutoAssign *TaskAutoAssignParam

+ Barcodes []TaskBarcode

+ CompleteAfter int64

+ CompleteBefore int64

+ Container *TaskContainer

+ Dependencies []string

+ Destination any

+ Executor string

+ Merchant string

+ Metadata []Metadata

+ Notes string

+ PickupTask bool

+ Quantity float64

+ RecipientName string

+ RecipientNotes string

+ RecipientSkipSmsNotifications bool

+ Recipients any

+ Requirements *TaskCompletionRequirementsParam

+ ScanOnlyRequiredBarcodes bool

+ ServiceTime float64

+ UseMerchantForProxy bool

+ type TaskState int

+ const TaskStateActive

+ const TaskStateAssigned

+ const TaskStateCompleted

+ const TaskStateUnassigned

+ type Team struct

+ EnableSelfAssignment bool

+ Hub *string

+ ID string

+ Managers []string

+ Name string

+ Tasks []string

+ TimeCreated int64

+ TimeLastModified int64

+ Workers []string

+ type TeamAutoDispatch struct

+ DispatchId string

+ type TeamAutoDispatchParams struct

+ MaxAllowedDelay int

+ MaxTasksPerRoute int

+ RouteEnd string

+ ScheduleTimeWindow []int64

+ ServiceTime int

+ TaskTimeWindow []int64

+ type TeamCreateParams struct

+ EnableSelfAssignment bool

+ Hub string

+ Managers []string

+ Name string

+ Workers []string

+ type TeamTasks struct

+ LastId string

+ Tasks []Task

+ type TeamTasksListQueryParams struct

+ From int64

+ IsPickupTask string

+ LastId string

+ To int64

+ type TeamUpdateParams struct

+ EnableSelfAssignment bool

+ Hub string

+ Managers []string

+ Name string

+ Workers []string

+ type TeamWorkerEta struct

+ Steps []TeamWorkerEtaStep

+ Vehicle WorkerVehicleType

+ WorkerId string

+ type TeamWorkerEtaQueryParams struct

+ DropoffLocation string

+ PickupLocation string

+ PickupTime int64

+ RestrictedVehiclesTypes WorkerVehicleType

+ ServiceTime float64

+ type TeamWorkerEtaStep struct

+ CompletionTime int64

+ Distance float64

+ Location DestinationLocation

+ ServiceTime float64

+ TravelTime float64

+ type Webhook struct

+ Count int64

+ ID string

+ IsEnabled bool

+ Name string

+ Threshold float64

+ Trigger int

+ Url string

+ type WebhookCreateParams struct

+ Name string

+ Threshold float64

+ Trigger int

+ Url string

+ type Worker struct

+ AccountStatus WorkerAccountStatus

+ ActiveTask *string

+ AdditionalCapacities WorkerAdditionalCapacities

+ Addresses *WorkerAddresses

+ Analytics *WorkerAnalytics

+ Capacity float64

+ DelayTime *float64

+ DisplayName *string

+ HasRecentlyUsedSpoofedLocations bool

+ ID string

+ ImageUrl *string

+ Location DestinationLocation

+ Metadata []Metadata

+ Name string

+ OnDuty bool

+ Organization string

+ Phone string

+ Tasks []string

+ Teams []string

+ TimeCreated int64

+ TimeLastModified int64

+ TimeLastSeen int64

+ Timezone *string

+ UserData WorkerUserData

+ Vehicle *WorkerVehicle

+ type WorkerAccountStatus string

+ const WorkerAccountStatusAccepted

+ const WorkerAccountStatusInvited

+ type WorkerAdditionalCapacities struct

+ CapacityA float64

+ CapacityB float64

+ CapacityC float64

+ type WorkerAddressRoutingParam struct

+ Routing string

+ type WorkerAddresses struct

+ Routing *WorkerAddressesRouting

+ type WorkerAddressesRouting struct

+ Address DestinationAddress

+ CreatedByLocation bool

+ GooglePlaceId string

+ ID string

+ Location DestinationLocation

+ Notes string

+ Organization string

+ TimeCreated int64

+ TimeLastModified int64

+ WasGeocoded bool

+ type WorkerAnalytics struct

+ Distances WorkerAnalyticsDistances

+ Events []WorkerAnalyticsEvent

+ TaskCounts WorkerAnalyticsTaskCounts

+ Times WorkerAnalyticsTimes

+ type WorkerAnalyticsDistances struct

+ Enroute float64

+ Idle float64

+ type WorkerAnalyticsEvent struct

+ Action string

+ Time int64

+ type WorkerAnalyticsTaskCounts struct

+ Failed int

+ Succeeded int

+ type WorkerAnalyticsTimes struct

+ Enroute float64

+ Idle float64

+ type WorkerCreateParams struct

+ Addresses *WorkerAddressRoutingParam

+ Capacity float64

+ DisplayName string

+ Metadata []Metadata

+ Name string

+ Phone string

+ Teams []string

+ Vehicle *WorkerVehicleParam

+ type WorkerGetQueryParams struct

+ Analytics bool

+ Filter string

+ From int64

+ To int64

+ type WorkerListQueryParams struct

+ Filter string

+ Phones string

+ States string

+ Teams string

+ type WorkerSchedule struct

+ Date string

+ Shifts [][]int64

+ Timezone string

+ type WorkerScheduleEntries struct

+ Entries []WorkerSchedule

+ type WorkerTasks struct

+ LastId string

+ Tasks []Task

+ type WorkerTasksListQueryParams struct

+ From int64

+ IsPickupTask string

+ LastId string

+ To int64

+ type WorkerUpdateParams struct

+ Addresses *WorkerAddressRoutingParam

+ Capacity float64

+ DisplayName string

+ Metadata []Metadata

+ Name string

+ Teams []string

+ Vehicle *WorkerVehicleParam

+ type WorkerUserData struct

+ AppVersion string

+ BatteryLevel float32

+ DeviceDescription string

+ Platform string

+ type WorkerVehicle struct

+ Color *string

+ Description *string

+ ID string

+ LicensePlate *string

+ TimeLastModified int64

+ Type WorkerVehicleType

+ type WorkerVehicleParam struct

+ Color string

+ Description string

+ LicensePlate string

+ Type WorkerVehicleType

+ type WorkerVehicleType string

+ const WorkerVehicleTypeBicycle

+ const WorkerVehicleTypeCar

+ const WorkerVehicleTypeMotorcycle

+ const WorkerVehicleTypeTruck

+ type WorkersByLocation struct

+ Workers []Worker

+ type WorkersByLocationListQueryParams struct

+ Latitude float64

+ Longitude float64

+ Radius float64

v0.1.5

Mar 27, 2023

v0.1.4

Mar 27, 2023

v0.1.3

Mar 27, 2023

v0.1.2

Mar 26, 2023

v0.1.1

Mar 26, 2023

v0.1.0

Mar 26, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL