Categorygithub.com/tinymile/delivery-sdk-go
modulepackage
0.0.0-20230503152150-6845bbc74a61
Repository: https://github.com/tinymile/delivery-sdk-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
12
Dependents
0
Files
1.8k SLOC

# README

1 tiny-mile-logo-black

Go Delivery SDK

We provide an HTTP API to make it easier for new partners to quickly integrate with us and start sending delivery requests our way. While you can use our API directly by making raw HTTP requests to it, we also provide client libraries in some languages to speed up development.

For the full documentation of the API, please see https://external-api.prod.gcp.tinymile.ai/doc.

For the development version, see https://external-api.dev.gcp.tinymile.ai/doc . This is the version this repository is synchronized with.

Basic usage

delivery_sdk.NewClientWithResponses(
        "https://external-api.prod.gcp.tinymile.ai",
		delivery_sdk.WithAPIKeyAuthentication(apiKey))

API Compatibility

The API is versioned, so this SDK is guaranteed to have forward compatibility with the API.

Build

Clone this repo and run make all to build it.

# Functions

Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateOpenRobotLidCommandRequest calls the generic CreateOpenRobotLidCommand builder with application/json body.
NewCreateOpenRobotLidCommandRequestWithBody generates requests for CreateOpenRobotLidCommand with any type of body.
NewCreateOrderRequest calls the generic CreateOrder builder with application/json body.
NewCreateOrderRequestWithBody generates requests for CreateOrder with any type of body.
NewGetDeliveryJobCurrentCourierRequest generates requests for GetDeliveryJobCurrentCourier.
NewGetDeliveryJobRequest generates requests for GetDeliveryJob.
NewGetJobsForOrderRequest generates requests for GetJobsForOrder.
NewGetOrderByExternalIdRequest generates requests for GetOrderByExternalId.
NewGetOrderRequest generates requests for GetOrder.
NewPostJobCancelledRequest calls the generic PostJobCancelled builder with application/json body.
NewPostJobCancelledRequestWithBody generates requests for PostJobCancelled with any type of body.
NewPostOrderDroppedOffRequest calls the generic PostOrderDroppedOff builder with application/json body.
NewPostOrderDroppedOffRequestWithBody generates requests for PostOrderDroppedOff with any type of body.
NewPostOrderPickedUpRequest calls the generic PostOrderPickedUp builder with application/json body.
NewPostOrderPickedUpRequestWithBody generates requests for PostOrderPickedUp with any type of body.
NewRequestQuoteRequest calls the generic RequestQuote builder with application/json body.
NewRequestQuoteRequestWithBody generates requests for RequestQuote with any type of body.
NewSetWebhooksRequest calls the generic SetWebhooks builder with application/json body.
NewSetWebhooksRequestWithBody generates requests for SetWebhooks with any type of body.
ParseCreateOpenRobotLidCommandResponse parses an HTTP response from a CreateOpenRobotLidCommandWithResponse call.
ParseCreateOrderResponse parses an HTTP response from a CreateOrderWithResponse call.
ParseGetDeliveryJobCurrentCourierResponse parses an HTTP response from a GetDeliveryJobCurrentCourierWithResponse call.
ParseGetDeliveryJobResponse parses an HTTP response from a GetDeliveryJobWithResponse call.
ParseGetJobsForOrderResponse parses an HTTP response from a GetJobsForOrderWithResponse call.
ParseGetOrderByExternalIdResponse parses an HTTP response from a GetOrderByExternalIdWithResponse call.
ParseGetOrderResponse parses an HTTP response from a GetOrderWithResponse call.
ParsePostJobCancelledResponse parses an HTTP response from a PostJobCancelledWithResponse call.
ParsePostOrderDroppedOffResponse parses an HTTP response from a PostOrderDroppedOffWithResponse call.
ParsePostOrderPickedUpResponse parses an HTTP response from a PostOrderPickedUpWithResponse call.
ParseRequestQuoteResponse parses an HTTP response from a RequestQuoteWithResponse call.
ParseSetWebhooksResponse parses an HTTP response from a SetWebhooksWithResponse call.
No description provided by the author
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

No description provided by the author
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierEventKind.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierState.
Defines values for CourierType.
Defines values for CourierType.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobEventKind.
Defines values for DeliveryJobPackageHolder.
Defines values for DeliveryJobPackageHolder.
Defines values for DeliveryJobPackageHolder.
Defines values for DeliveryJobPackageHolder.
Defines values for DeliveryJobStage.
Defines values for DeliveryJobStage.
Defines values for DeliveryJobStage.
Defines values for DeliveryJobStage.
Defines values for DeliveryJobStage.
Defines values for DeliveryOrderRejectionReason.
Defines values for DeliveryOrderRejectionReason.
Defines values for DeliveryOrderRejectionReason.
Defines values for DeliveryOrderRejectionReason.
Defines values for DeliveryOrderRejectionReason.
Defines values for DeliveryOrderRejectionReason.
Defines values for DeliveryOrderStatus.
Defines values for DeliveryOrderStatus.
Defines values for DeliveryOrderStatus.
Defines values for DeliveryOrderStatus.
Defines values for InvalidClientActionErrorReason.
Defines values for InvalidClientActionErrorReason.
Defines values for InvalidClientActionErrorReason.
Defines values for SetWebhookErrorReason.

# Structs

AddressDescription defines model for AddressDescription.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
CompleteAddress defines model for CompleteAddress.
Courier defines model for Courier.
CourierDestination defines model for CourierDestination.
CourierEvent defines model for CourierEvent.
No description provided by the author
No description provided by the author
DeliveryCharges defines model for DeliveryCharges.
DeliveryJob defines model for DeliveryJob.
DeliveryJobEvent defines model for DeliveryJobEvent.
DeliveryOrder defines model for DeliveryOrder.
DeliveryOrderCreationRequest defines model for DeliveryOrderCreationRequest.
DeliveryOrderParty defines model for DeliveryOrderParty.
DeliveryOrderQuote defines model for DeliveryOrderQuote.
DeliveryOrderQuoteRequest defines model for DeliveryOrderQuoteRequest.
DeliveryOrderRejection defines model for DeliveryOrderRejection.
DeliveryService defines model for DeliveryService.
DeliveryServiceNotifyParty defines model for DeliveryServiceNotifyParty.
GeocodedAddress defines model for GeocodedAddress.
GeocodeLogEntry defines model for GeocodeLogEntry.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InvalidClientActionError defines model for InvalidClientActionError.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SetWebhookError defines model for SetWebhookError.
No description provided by the author
TimeWindow defines model for TimeWindow.
Webhook defines model for Webhook.
Webhooks defines model for Webhooks.

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
CreateOpenRobotLidCommandJSONBody defines parameters for CreateOpenRobotLidCommand.
CreateOrderClientErrorResponse defines model for CreateOrderClientErrorResponse.
Doer performs HTTP requests.
PostJobCancelledJSONBody defines parameters for PostJobCancelled.
PostOrderDroppedOffJSONBody defines parameters for PostOrderDroppedOff.
PostOrderPickedUpJSONBody defines parameters for PostOrderPickedUp.
RequestQuoteClientErrorResponse defines model for RequestQuoteClientErrorResponse.

# Type aliases

ClientOption allows setting custom parameters during construction.
CourierEventKind defines model for CourierEvent.Kind.
CourierState defines model for Courier.State.
CourierType defines model for Courier.Type.
CreateOpenRobotLidCommandJSONRequestBody defines body for CreateOpenRobotLidCommand for application/json ContentType.
CreateOrderJSONBody defines parameters for CreateOrder.
CreateOrderJSONRequestBody defines body for CreateOrder for application/json ContentType.
DeliveryJobEventKind defines model for DeliveryJobEvent.Kind.
DeliveryJobPackageHolder defines model for DeliveryJob.PackageHolder.
DeliveryJobStage defines model for DeliveryJob.Stage.
DeliveryOrderRejectionReason defines model for DeliveryOrderRejection.Reason.
DeliveryOrderStatus defines model for DeliveryOrder.Status.
InvalidClientActionErrorReason defines model for InvalidClientActionError.Reason.
PostJobCancelledJSONRequestBody defines body for PostJobCancelled for application/json ContentType.
PostOrderDroppedOffJSONRequestBody defines body for PostOrderDroppedOff for application/json ContentType.
PostOrderPickedUpJSONRequestBody defines body for PostOrderPickedUp for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.
RequestQuoteJSONBody defines parameters for RequestQuote.
RequestQuoteJSONRequestBody defines body for RequestQuote for application/json ContentType.
SetWebhookErrorReason defines model for SetWebhookError.Reason.
SetWebhooksJSONBody defines parameters for SetWebhooks.
SetWebhooksJSONRequestBody defines body for SetWebhooks for application/json ContentType.