api

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 27, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.

Index

Constants

View Source 
const (
	BearerAuthScopes bearerAuthContextKey = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewAssetsCreateRequest 

func NewAssetsCreateRequest(server string, params *AssetsCreateParams, body AssetsCreateJSONRequestBody) (*http.Request, error)

NewAssetsCreateRequest calls the generic AssetsCreate builder with application/json body

func NewAssetsCreateRequestWithBody 

func NewAssetsCreateRequestWithBody(server string, params *AssetsCreateParams, contentType string, body io.Reader) (*http.Request, error)

NewAssetsCreateRequestWithBody generates requests for AssetsCreate with any type of body

func NewAssetsGetRequest 

func NewAssetsGetRequest(server string, assetId string, params *AssetsGetParams) (*http.Request, error)

NewAssetsGetRequest generates requests for AssetsGet

func NewAssetsListForCustomerRequest 

func NewAssetsListForCustomerRequest(server string, customerId string, params *AssetsListForCustomerParams) (*http.Request, error)

NewAssetsListForCustomerRequest generates requests for AssetsListForCustomer

func NewAssetsListRequest 

func NewAssetsListRequest(server string, params *AssetsListParams) (*http.Request, error)

NewAssetsListRequest generates requests for AssetsList

func NewAssetsUpdateRequest 

func NewAssetsUpdateRequest(server string, assetId string, params *AssetsUpdateParams, body AssetsUpdateJSONRequestBody) (*http.Request, error)

NewAssetsUpdateRequest calls the generic AssetsUpdate builder with application/json body

func NewAssetsUpdateRequestWithBody 

func NewAssetsUpdateRequestWithBody(server string, assetId string, params *AssetsUpdateParams, contentType string, body io.Reader) (*http.Request, error)

NewAssetsUpdateRequestWithBody generates requests for AssetsUpdate with any type of body

func NewBusinessesAvailabilityRequest 

func NewBusinessesAvailabilityRequest(server string, businessId string, params *BusinessesAvailabilityParams) (*http.Request, error)

NewBusinessesAvailabilityRequest generates requests for BusinessesAvailability

func NewBusinessesAvailabilitySlotsRequest 

func NewBusinessesAvailabilitySlotsRequest(server string, businessId string, params *BusinessesAvailabilitySlotsParams) (*http.Request, error)

NewBusinessesAvailabilitySlotsRequest generates requests for BusinessesAvailabilitySlots

func NewBusinessesGetRequest 

func NewBusinessesGetRequest(server string, businessId string, params *BusinessesGetParams) (*http.Request, error)

NewBusinessesGetRequest generates requests for BusinessesGet

func NewBusinessesListRequest 

func NewBusinessesListRequest(server string, params *BusinessesListParams) (*http.Request, error)

NewBusinessesListRequest generates requests for BusinessesList

func NewBusinessesNextAvailableSlotRequest 

func NewBusinessesNextAvailableSlotRequest(server string, businessId string, params *BusinessesNextAvailableSlotParams) (*http.Request, error)

NewBusinessesNextAvailableSlotRequest generates requests for BusinessesNextAvailableSlot

func NewBusinessesServicesRequest 

func NewBusinessesServicesRequest(server string, businessId string, params *BusinessesServicesParams) (*http.Request, error)

NewBusinessesServicesRequest generates requests for BusinessesServices

func NewChatCreateAttachmentsRequestWithBody 

func NewChatCreateAttachmentsRequestWithBody(server string, customerId string, params *ChatCreateAttachmentsParams, contentType string, body io.Reader) (*http.Request, error)

NewChatCreateAttachmentsRequestWithBody generates requests for ChatCreateAttachments with any type of body

func NewChatCreateMessageRequest 

func NewChatCreateMessageRequest(server string, customerId string, params *ChatCreateMessageParams, body ChatCreateMessageJSONRequestBody) (*http.Request, error)

NewChatCreateMessageRequest calls the generic ChatCreateMessage builder with application/json body

func NewChatCreateMessageRequestWithBody 

func NewChatCreateMessageRequestWithBody(server string, customerId string, params *ChatCreateMessageParams, contentType string, body io.Reader) (*http.Request, error)

NewChatCreateMessageRequestWithBody generates requests for ChatCreateMessage with any type of body

func NewChatMessagesRequest 

func NewChatMessagesRequest(server string, customerId string, params *ChatMessagesParams) (*http.Request, error)

NewChatMessagesRequest generates requests for ChatMessages

func NewCustomersGetRequest 

func NewCustomersGetRequest(server string, customerId string, params *CustomersGetParams) (*http.Request, error)

NewCustomersGetRequest generates requests for CustomersGet

func NewCustomersListRequest 

func NewCustomersListRequest(server string, params *CustomersListParams) (*http.Request, error)

NewCustomersListRequest generates requests for CustomersList

func NewCustomersUpdateRequest 

func NewCustomersUpdateRequest(server string, customerId string, params *CustomersUpdateParams, body CustomersUpdateJSONRequestBody) (*http.Request, error)

NewCustomersUpdateRequest calls the generic CustomersUpdate builder with application/json body

func NewCustomersUpdateRequestWithBody 

func NewCustomersUpdateRequestWithBody(server string, customerId string, params *CustomersUpdateParams, contentType string, body io.Reader) (*http.Request, error)

NewCustomersUpdateRequestWithBody generates requests for CustomersUpdate with any type of body

func NewInvoiceItemsCreateRequest 

func NewInvoiceItemsCreateRequest(server string, params *InvoiceItemsCreateParams, body InvoiceItemsCreateJSONRequestBody) (*http.Request, error)

NewInvoiceItemsCreateRequest calls the generic InvoiceItemsCreate builder with application/json body

func NewInvoiceItemsCreateRequestWithBody 

func NewInvoiceItemsCreateRequestWithBody(server string, params *InvoiceItemsCreateParams, contentType string, body io.Reader) (*http.Request, error)

NewInvoiceItemsCreateRequestWithBody generates requests for InvoiceItemsCreate with any type of body

func NewInvoiceItemsDeleteRequest 

func NewInvoiceItemsDeleteRequest(server string, invoiceItemId string, params *InvoiceItemsDeleteParams) (*http.Request, error)

NewInvoiceItemsDeleteRequest generates requests for InvoiceItemsDelete

func NewInvoiceItemsGetRequest 

func NewInvoiceItemsGetRequest(server string, invoiceItemId string, params *InvoiceItemsGetParams) (*http.Request, error)

NewInvoiceItemsGetRequest generates requests for InvoiceItemsGet

func NewInvoiceItemsUpdateRequest 

func NewInvoiceItemsUpdateRequest(server string, invoiceItemId string, params *InvoiceItemsUpdateParams, body InvoiceItemsUpdateJSONRequestBody) (*http.Request, error)

NewInvoiceItemsUpdateRequest calls the generic InvoiceItemsUpdate builder with application/json body

func NewInvoiceItemsUpdateRequestWithBody 

func NewInvoiceItemsUpdateRequestWithBody(server string, invoiceItemId string, params *InvoiceItemsUpdateParams, contentType string, body io.Reader) (*http.Request, error)

NewInvoiceItemsUpdateRequestWithBody generates requests for InvoiceItemsUpdate with any type of body

func NewInvoicesGetRequest 

func NewInvoicesGetRequest(server string, invoiceId string, params *InvoicesGetParams) (*http.Request, error)

NewInvoicesGetRequest generates requests for InvoicesGet

func NewInvoicesListRequest 

func NewInvoicesListRequest(server string, params *InvoicesListParams) (*http.Request, error)

NewInvoicesListRequest generates requests for InvoicesList

func NewJobReportsGetForJobRequest 

func NewJobReportsGetForJobRequest(server string, jobId string, jobReportId string, params *JobReportsGetForJobParams) (*http.Request, error)

NewJobReportsGetForJobRequest generates requests for JobReportsGetForJob

func NewJobReportsGetRequest 

func NewJobReportsGetRequest(server string, jobReportId string, params *JobReportsGetParams) (*http.Request, error)

NewJobReportsGetRequest generates requests for JobReportsGet

func NewJobReportsListForJobRequest 

func NewJobReportsListForJobRequest(server string, jobId string, params *JobReportsListForJobParams) (*http.Request, error)

NewJobReportsListForJobRequest generates requests for JobReportsListForJob

func NewJobReportsListRequest 

func NewJobReportsListRequest(server string, params *JobReportsListParams) (*http.Request, error)

NewJobReportsListRequest generates requests for JobReportsList

func NewJobsCreateRequest 

func NewJobsCreateRequest(server string, params *JobsCreateParams, body JobsCreateJSONRequestBody) (*http.Request, error)

NewJobsCreateRequest calls the generic JobsCreate builder with application/json body

func NewJobsCreateRequestWithBody 

func NewJobsCreateRequestWithBody(server string, params *JobsCreateParams, contentType string, body io.Reader) (*http.Request, error)

NewJobsCreateRequestWithBody generates requests for JobsCreate with any type of body

func NewJobsGetRequest 

func NewJobsGetRequest(server string, jobId string, params *JobsGetParams) (*http.Request, error)

NewJobsGetRequest generates requests for JobsGet

func NewJobsListRequest 

func NewJobsListRequest(server string, params *JobsListParams) (*http.Request, error)

NewJobsListRequest generates requests for JobsList

func NewJobsPartAuthorisationsRequest 

func NewJobsPartAuthorisationsRequest(server string, jobId string, params *JobsPartAuthorisationsParams) (*http.Request, error)

NewJobsPartAuthorisationsRequest generates requests for JobsPartAuthorisations

func NewJobsSubmitPartAuthorisationDecisionsRequest 

func NewJobsSubmitPartAuthorisationDecisionsRequest(server string, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, body JobsSubmitPartAuthorisationDecisionsJSONRequestBody) (*http.Request, error)

NewJobsSubmitPartAuthorisationDecisionsRequest calls the generic JobsSubmitPartAuthorisationDecisions builder with application/json body

func NewJobsSubmitPartAuthorisationDecisionsRequestWithBody 

func NewJobsSubmitPartAuthorisationDecisionsRequestWithBody(server string, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, contentType string, body io.Reader) (*http.Request, error)

NewJobsSubmitPartAuthorisationDecisionsRequestWithBody generates requests for JobsSubmitPartAuthorisationDecisions with any type of body

func NewServicesCreateRequest 

func NewServicesCreateRequest(server string, businessId string, params *ServicesCreateParams, body ServicesCreateJSONRequestBody) (*http.Request, error)

NewServicesCreateRequest calls the generic ServicesCreate builder with application/json body

func NewServicesCreateRequestWithBody 

func NewServicesCreateRequestWithBody(server string, businessId string, params *ServicesCreateParams, contentType string, body io.Reader) (*http.Request, error)

NewServicesCreateRequestWithBody generates requests for ServicesCreate with any type of body

func NewServicesGetRequest 

func NewServicesGetRequest(server string, serviceId string, params *ServicesGetParams) (*http.Request, error)

NewServicesGetRequest generates requests for ServicesGet

func NewServicesListRequest 

func NewServicesListRequest(server string, params *ServicesListParams) (*http.Request, error)

NewServicesListRequest generates requests for ServicesList

func NewServicesUpdateRequest 

func NewServicesUpdateRequest(server string, businessId string, serviceId string, params *ServicesUpdateParams, body ServicesUpdateJSONRequestBody) (*http.Request, error)

NewServicesUpdateRequest calls the generic ServicesUpdate builder with application/json body

func NewServicesUpdateRequestWithBody 

func NewServicesUpdateRequestWithBody(server string, businessId string, serviceId string, params *ServicesUpdateParams, contentType string, body io.Reader) (*http.Request, error)

NewServicesUpdateRequestWithBody generates requests for ServicesUpdate with any type of body

func NewStockGetRequest 

func NewStockGetRequest(server string, stockVariationId string, params *StockGetParams) (*http.Request, error)

NewStockGetRequest generates requests for StockGet

func NewStockListRequest 

func NewStockListRequest(server string, params *StockListParams) (*http.Request, error)

NewStockListRequest generates requests for StockList

func NewWebhookDeliveriesGetRequest 

func NewWebhookDeliveriesGetRequest(server string, deliveryId string, params *WebhookDeliveriesGetParams) (*http.Request, error)

NewWebhookDeliveriesGetRequest generates requests for WebhookDeliveriesGet

func NewWebhookDeliveriesListForEndpointRequest 

func NewWebhookDeliveriesListForEndpointRequest(server string, endpointId string, params *WebhookDeliveriesListForEndpointParams) (*http.Request, error)

NewWebhookDeliveriesListForEndpointRequest generates requests for WebhookDeliveriesListForEndpoint

func NewWebhookDeliveriesReplayRequest 

func NewWebhookDeliveriesReplayRequest(server string, deliveryId string, params *WebhookDeliveriesReplayParams) (*http.Request, error)

NewWebhookDeliveriesReplayRequest generates requests for WebhookDeliveriesReplay

func NewWebhookEndpointsCreateRequest 

func NewWebhookEndpointsCreateRequest(server string, params *WebhookEndpointsCreateParams, body WebhookEndpointsCreateJSONRequestBody) (*http.Request, error)

NewWebhookEndpointsCreateRequest calls the generic WebhookEndpointsCreate builder with application/json body

func NewWebhookEndpointsCreateRequestWithBody 

func NewWebhookEndpointsCreateRequestWithBody(server string, params *WebhookEndpointsCreateParams, contentType string, body io.Reader) (*http.Request, error)

NewWebhookEndpointsCreateRequestWithBody generates requests for WebhookEndpointsCreate with any type of body

func NewWebhookEndpointsDeleteRequest 

func NewWebhookEndpointsDeleteRequest(server string, endpointId string, params *WebhookEndpointsDeleteParams) (*http.Request, error)

NewWebhookEndpointsDeleteRequest generates requests for WebhookEndpointsDelete

func NewWebhookEndpointsGetRequest 

func NewWebhookEndpointsGetRequest(server string, endpointId string, params *WebhookEndpointsGetParams) (*http.Request, error)

NewWebhookEndpointsGetRequest generates requests for WebhookEndpointsGet

func NewWebhookEndpointsListRequest 

func NewWebhookEndpointsListRequest(server string, params *WebhookEndpointsListParams) (*http.Request, error)

NewWebhookEndpointsListRequest generates requests for WebhookEndpointsList

func NewWebhookEndpointsRotateSecretRequest 

func NewWebhookEndpointsRotateSecretRequest(server string, endpointId string, params *WebhookEndpointsRotateSecretParams) (*http.Request, error)

NewWebhookEndpointsRotateSecretRequest generates requests for WebhookEndpointsRotateSecret

func NewWebhookEndpointsUpdateRequest 

func NewWebhookEndpointsUpdateRequest(server string, endpointId string, params *WebhookEndpointsUpdateParams, body WebhookEndpointsUpdateJSONRequestBody) (*http.Request, error)

NewWebhookEndpointsUpdateRequest calls the generic WebhookEndpointsUpdate builder with application/json body

func NewWebhookEndpointsUpdateRequestWithBody 

func NewWebhookEndpointsUpdateRequestWithBody(server string, endpointId string, params *WebhookEndpointsUpdateParams, contentType string, body io.Reader) (*http.Request, error)

NewWebhookEndpointsUpdateRequestWithBody generates requests for WebhookEndpointsUpdate with any type of body

func NewWebhookEventsListRequest 

func NewWebhookEventsListRequest(server string, params *WebhookEventsListParams) (*http.Request, error)

NewWebhookEventsListRequest generates requests for WebhookEventsList

Types

type ApiError 

type ApiError struct {
	// Code Stable machine-readable error code, such as invalid_request or resource_not_found.
	Code *string `json:"code,omitempty"`

	// Message Human-readable explanation of the error.
	Message *string `json:"message,omitempty"`

	// Parameter Request parameter related to the error, when the failure can be tied to one field.
	Parameter *string `json:"parameter,omitempty"`
}

ApiError Public API error details. Codes are stable machine-readable values.

type ApiErrorResponse 

type ApiErrorResponse struct {
	// Error Public API error details. Codes are stable machine-readable values.
	Error *ApiError `json:"error,omitempty"`

	// RequestId Request correlation id. Matches X-Bikebook-Request-Id when the caller supplies one.
	RequestId *string `json:"request_id,omitempty"`
}

ApiErrorResponse Standard error envelope returned by public API endpoints.

type ApiListResponseOfAssetResponse 

type ApiListResponseOfAssetResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]AssetResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfAssetResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfBusinessResponse 

type ApiListResponseOfBusinessResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]BusinessResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfBusinessResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfChatMessageResponse 

type ApiListResponseOfChatMessageResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]ChatMessageResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfChatMessageResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfCustomerResponse 

type ApiListResponseOfCustomerResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]CustomerResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfCustomerResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfInvoiceResponse 

type ApiListResponseOfInvoiceResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]InvoiceResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfInvoiceResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfJobReportResponse 

type ApiListResponseOfJobReportResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]JobReportResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfJobReportResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfJobResponse 

type ApiListResponseOfJobResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]JobResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfJobResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfPartAuthorisationResponse 

type ApiListResponseOfPartAuthorisationResponse struct {
	// Data Part lines on the job report. Each element includes a `pauth_...` `id` for submit decisions.
	Data *[]PartAuthorisationResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfPartAuthorisationResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfServiceResponse 

type ApiListResponseOfServiceResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]ServiceResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfServiceResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfStockVariationResponse 

type ApiListResponseOfStockVariationResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]StockVariationResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfStockVariationResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfWebhookDeliveryResponse 

type ApiListResponseOfWebhookDeliveryResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]WebhookDeliveryResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfWebhookDeliveryResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfWebhookEndpointResponse 

type ApiListResponseOfWebhookEndpointResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]WebhookEndpointResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfWebhookEndpointResponse Standard public API list response with cursor pagination metadata.

type ApiListResponseOfWebhookEventResponse 

type ApiListResponseOfWebhookEventResponse struct {
	// Data Page of public resources returned by the list endpoint.
	Data *[]WebhookEventResponse `json:"data,omitempty"`

	// Pagination Cursor pagination metadata used by public list endpoints.
	Pagination *ApiPagination `json:"pagination,omitempty"`
}

ApiListResponseOfWebhookEventResponse Standard public API list response with cursor pagination metadata.

type ApiPagination 

type ApiPagination struct {
	// HasMore True when another page is available after this response.
	HasMore *bool `json:"has_more,omitempty"`

	// NextCursor Opaque cursor to pass as the next request's cursor parameter. Null when there are no more pages.
	NextCursor *string `json:"next_cursor,omitempty"`
}

ApiPagination Cursor pagination metadata used by public list endpoints.

type AssetResponse 

type AssetResponse struct {
	// BusinessId Workshop that owns the customer asset.
	BusinessId *string `json:"business_id,omitempty"`

	// CustomerId Customer that owns this asset.
	CustomerId *string `json:"customer_id,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// Make Asset make or manufacturer.
	Make *string `json:"make,omitempty"`

	// Model Asset model.
	Model *string `json:"model,omitempty"`

	// Name Asset display name.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always `asset`.
	Object *string `json:"object,omitempty"`

	// SerialNumber Asset serial number, when known.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Type Public asset type, such as bike or another serviced asset category.
	Type *string `json:"type,omitempty"`

	// Year Asset year, when known.
	Year *int32 `json:"year,omitempty"`
}

AssetResponse Public customer asset read model.

type AssetsCreateJSONRequestBody 

type AssetsCreateJSONRequestBody = CreateAssetRequest

AssetsCreateJSONRequestBody defines body for AssetsCreate for application/json ContentType.

type AssetsCreateParams 

type AssetsCreateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

AssetsCreateParams defines parameters for AssetsCreate.

type AssetsCreateResponse 

type AssetsCreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *AssetResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseAssetsCreateResponse 

func ParseAssetsCreateResponse(rsp *http.Response) (*AssetsCreateResponse, error)

ParseAssetsCreateResponse parses an HTTP response from a AssetsCreateWithResponse call

func (AssetsCreateResponse) ContentType 

func (r AssetsCreateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AssetsCreateResponse) Status 

func (r AssetsCreateResponse) Status() string

Status returns HTTPResponse.Status

func (AssetsCreateResponse) StatusCode 

func (r AssetsCreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AssetsGetParams 

type AssetsGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

AssetsGetParams defines parameters for AssetsGet.

type AssetsGetResponse 

type AssetsGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AssetResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseAssetsGetResponse 

func ParseAssetsGetResponse(rsp *http.Response) (*AssetsGetResponse, error)

ParseAssetsGetResponse parses an HTTP response from a AssetsGetWithResponse call

func (AssetsGetResponse) ContentType 

func (r AssetsGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AssetsGetResponse) Status 

func (r AssetsGetResponse) Status() string

Status returns HTTPResponse.Status

func (AssetsGetResponse) StatusCode 

func (r AssetsGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AssetsListForCustomerParams 

type AssetsListForCustomerParams struct {
	Name         *string `form:"name,omitempty" json:"name,omitempty"`
	SerialNumber *string `form:"serial_number,omitempty" json:"serial_number,omitempty"`
	Make         *string `form:"make,omitempty" json:"make,omitempty"`
	Model        *string `form:"model,omitempty" json:"model,omitempty"`
	Type         *string `form:"type,omitempty" json:"type,omitempty"`

	// Sort Sort field. Allowed values: `name`, `created_at`. Default: `name`. Prefix with `-` for descending order (for example `-name`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

AssetsListForCustomerParams defines parameters for AssetsListForCustomer.

type AssetsListForCustomerResponse 

type AssetsListForCustomerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfAssetResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseAssetsListForCustomerResponse 

func ParseAssetsListForCustomerResponse(rsp *http.Response) (*AssetsListForCustomerResponse, error)

ParseAssetsListForCustomerResponse parses an HTTP response from a AssetsListForCustomerWithResponse call

func (AssetsListForCustomerResponse) ContentType 

func (r AssetsListForCustomerResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AssetsListForCustomerResponse) Status 

func (r AssetsListForCustomerResponse) Status() string

Status returns HTTPResponse.Status

func (AssetsListForCustomerResponse) StatusCode 

func (r AssetsListForCustomerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AssetsListParams 

type AssetsListParams struct {
	BusinessId   *string `form:"business_id,omitempty" json:"business_id,omitempty"`
	CustomerId   *string `form:"customer_id,omitempty" json:"customer_id,omitempty"`
	Name         *string `form:"name,omitempty" json:"name,omitempty"`
	SerialNumber *string `form:"serial_number,omitempty" json:"serial_number,omitempty"`
	Make         *string `form:"make,omitempty" json:"make,omitempty"`
	Model        *string `form:"model,omitempty" json:"model,omitempty"`
	Type         *string `form:"type,omitempty" json:"type,omitempty"`

	// Sort Sort field. Allowed values: `name`, `created_at`. Default: `name`. Prefix with `-` for descending order (for example `-name`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

AssetsListParams defines parameters for AssetsList.

type AssetsListResponse 

type AssetsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfAssetResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseAssetsListResponse 

func ParseAssetsListResponse(rsp *http.Response) (*AssetsListResponse, error)

ParseAssetsListResponse parses an HTTP response from a AssetsListWithResponse call

func (AssetsListResponse) ContentType 

func (r AssetsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AssetsListResponse) Status 

func (r AssetsListResponse) Status() string

Status returns HTTPResponse.Status

func (AssetsListResponse) StatusCode 

func (r AssetsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AssetsUpdateJSONRequestBody 

type AssetsUpdateJSONRequestBody = UpdateAssetRequest

AssetsUpdateJSONRequestBody defines body for AssetsUpdate for application/json ContentType.

type AssetsUpdateParams 

type AssetsUpdateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

AssetsUpdateParams defines parameters for AssetsUpdate.

type AssetsUpdateResponse 

type AssetsUpdateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AssetResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseAssetsUpdateResponse 

func ParseAssetsUpdateResponse(rsp *http.Response) (*AssetsUpdateResponse, error)

ParseAssetsUpdateResponse parses an HTTP response from a AssetsUpdateWithResponse call

func (AssetsUpdateResponse) ContentType 

func (r AssetsUpdateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AssetsUpdateResponse) Status 

func (r AssetsUpdateResponse) Status() string

Status returns HTTPResponse.Status

func (AssetsUpdateResponse) StatusCode 

func (r AssetsUpdateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AvailabilityResponse 

type AvailabilityResponse struct {
	// BusinessId Public business id for this availability response.
	BusinessId *string `json:"business_id,omitempty"`

	// CollectionDates Calendar date (`YYYY-MM-DD`). No time or timezone offset — use the date part only.
	CollectionDates *[]openapi_types.Date `json:"collection_dates,omitempty"`

	// CustomerCollectionDates Calendar date (`YYYY-MM-DD`). No time or timezone offset — use the date part only.
	CustomerCollectionDates *[]openapi_types.Date `json:"customer_collection_dates,omitempty"`

	// CustomerDropOffDates Calendar date (`YYYY-MM-DD`). No time or timezone offset — use the date part only.
	CustomerDropOffDates *[]openapi_types.Date `json:"customer_drop_off_dates,omitempty"`

	// From Calendar date (`YYYY-MM-DD`). No time or timezone offset — use the date part only.
	From *openapi_types.Date `json:"from,omitempty"`

	// Object Resource object type. Always availability.
	Object *string `json:"object,omitempty"`

	// To Calendar date (`YYYY-MM-DD`). No time or timezone offset — use the date part only.
	To *openapi_types.Date `json:"to,omitempty"`
}

AvailabilityResponse Public availability response for a business over a date range.

type AvailabilitySlotResponse 

type AvailabilitySlotResponse struct {
	// EndTime End time of the available slot in the business's local schedule.
	EndTime *string `json:"end_time,omitempty"`

	// IsAvailable True when the slot is available for customer selection.
	IsAvailable *bool `json:"is_available,omitempty"`

	// StartTime Start time of the available slot in the business's local schedule.
	StartTime *string `json:"start_time,omitempty"`
}

AvailabilitySlotResponse Public availability time slot.

type AvailabilitySlotsResponse 

type AvailabilitySlotsResponse struct {
	// BusinessId Public business id for this availability result.
	BusinessId *string `json:"business_id,omitempty"`

	// Date Calendar date (`YYYY-MM-DD`). No time or timezone offset — use the date part only.
	Date *openapi_types.Date `json:"date,omitempty"`

	// Object Resource object type. Always availability_slots.
	Object *string `json:"object,omitempty"`

	// Slots Collection/drop-off time windows configured for this date.
	Slots *[]AvailabilitySlotResponse `json:"slots,omitempty"`
}

AvailabilitySlotsResponse Public availability time slots for a single calendar date.

type BusinessResponse 

type BusinessResponse struct {
	// BookingsEnabled True when the business currently accepts customer bookings/jobs.
	BookingsEnabled *bool `json:"bookings_enabled,omitempty"`

	// BusinessType Public business type as a stable snake_case value.
	BusinessType *string `json:"business_type,omitempty"`

	// CollectionEnabled True when mechanic collection is enabled for the business.
	CollectionEnabled *bool `json:"collection_enabled,omitempty"`

	// ContactEmail Public contact email for the business, when configured.
	ContactEmail *string `json:"contact_email,omitempty"`

	// ContactPhone Public contact phone number for the business, when configured.
	ContactPhone *string `json:"contact_phone,omitempty"`

	// Country ISO country code configured for the business.
	Country *string `json:"country,omitempty"`

	// Description Public business profile description.
	Description *string `json:"description,omitempty"`

	// DropOffsEnabled True when customer drop-off is enabled for the business.
	DropOffsEnabled *bool `json:"drop_offs_enabled,omitempty"`

	// Id Public workshop id (`org_...`, for example `org_2abc8example`).
	Id *string `json:"id,omitempty"`

	// ImageUrl Public image or logo URL for the business.
	ImageUrl *string `json:"image_url,omitempty"`

	// Name Public display name of the business.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always business.
	Object *string `json:"object,omitempty"`

	// ServicesVisible True when the business has chosen to show services publicly.
	ServicesVisible *bool `json:"services_visible,omitempty"`

	// Slug Public profile slug when the business has one.
	Slug *string `json:"slug,omitempty"`
}

BusinessResponse Public business profile returned by the public API.

type BusinessesAvailabilityParams 

type BusinessesAvailabilityParams struct {
	// From Inclusive start date (`YYYY-MM-DD`). Optional; defaults to workshop-local today on availability and next_available_slot.
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`

	// To Inclusive end date (`YYYY-MM-DD`). Optional; defaults to `from` + 42 days on availability, or `from` + 90 days on next_available_slot.
	To *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

BusinessesAvailabilityParams defines parameters for BusinessesAvailability.

type BusinessesAvailabilityResponse 

type BusinessesAvailabilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AvailabilityResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseBusinessesAvailabilityResponse 

func ParseBusinessesAvailabilityResponse(rsp *http.Response) (*BusinessesAvailabilityResponse, error)

ParseBusinessesAvailabilityResponse parses an HTTP response from a BusinessesAvailabilityWithResponse call

func (BusinessesAvailabilityResponse) ContentType 

func (r BusinessesAvailabilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BusinessesAvailabilityResponse) Status 

func (r BusinessesAvailabilityResponse) Status() string

Status returns HTTPResponse.Status

func (BusinessesAvailabilityResponse) StatusCode 

func (r BusinessesAvailabilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BusinessesAvailabilitySlotsParams 

type BusinessesAvailabilitySlotsParams struct {
	// Date Calendar date for slot lookup (`YYYY-MM-DD`, required on availability/slots).
	Date *openapi_types.Date `form:"date,omitempty" json:"date,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

BusinessesAvailabilitySlotsParams defines parameters for BusinessesAvailabilitySlots.

type BusinessesAvailabilitySlotsResponse 

type BusinessesAvailabilitySlotsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AvailabilitySlotsResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseBusinessesAvailabilitySlotsResponse 

func ParseBusinessesAvailabilitySlotsResponse(rsp *http.Response) (*BusinessesAvailabilitySlotsResponse, error)

ParseBusinessesAvailabilitySlotsResponse parses an HTTP response from a BusinessesAvailabilitySlotsWithResponse call

func (BusinessesAvailabilitySlotsResponse) ContentType 

func (r BusinessesAvailabilitySlotsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BusinessesAvailabilitySlotsResponse) Status 

func (r BusinessesAvailabilitySlotsResponse) Status() string

Status returns HTTPResponse.Status

func (BusinessesAvailabilitySlotsResponse) StatusCode 

func (r BusinessesAvailabilitySlotsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BusinessesGetParams 

type BusinessesGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

BusinessesGetParams defines parameters for BusinessesGet.

type BusinessesGetResponse 

type BusinessesGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BusinessResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseBusinessesGetResponse 

func ParseBusinessesGetResponse(rsp *http.Response) (*BusinessesGetResponse, error)

ParseBusinessesGetResponse parses an HTTP response from a BusinessesGetWithResponse call

func (BusinessesGetResponse) ContentType 

func (r BusinessesGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BusinessesGetResponse) Status 

func (r BusinessesGetResponse) Status() string

Status returns HTTPResponse.Status

func (BusinessesGetResponse) StatusCode 

func (r BusinessesGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BusinessesListParams 

type BusinessesListParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

BusinessesListParams defines parameters for BusinessesList.

type BusinessesListResponse 

type BusinessesListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfBusinessResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseBusinessesListResponse 

func ParseBusinessesListResponse(rsp *http.Response) (*BusinessesListResponse, error)

ParseBusinessesListResponse parses an HTTP response from a BusinessesListWithResponse call

func (BusinessesListResponse) ContentType 

func (r BusinessesListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BusinessesListResponse) Status 

func (r BusinessesListResponse) Status() string

Status returns HTTPResponse.Status

func (BusinessesListResponse) StatusCode 

func (r BusinessesListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BusinessesNextAvailableSlotParams 

type BusinessesNextAvailableSlotParams struct {
	// From Inclusive start date (`YYYY-MM-DD`). Optional; defaults to workshop-local today on availability and next_available_slot.
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`

	// To Inclusive end date (`YYYY-MM-DD`). Optional; defaults to `from` + 42 days on availability, or `from` + 90 days on next_available_slot.
	To *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

BusinessesNextAvailableSlotParams defines parameters for BusinessesNextAvailableSlot.

type BusinessesNextAvailableSlotResponse 

type BusinessesNextAvailableSlotResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NextAvailableSlotResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseBusinessesNextAvailableSlotResponse 

func ParseBusinessesNextAvailableSlotResponse(rsp *http.Response) (*BusinessesNextAvailableSlotResponse, error)

ParseBusinessesNextAvailableSlotResponse parses an HTTP response from a BusinessesNextAvailableSlotWithResponse call

func (BusinessesNextAvailableSlotResponse) ContentType 

func (r BusinessesNextAvailableSlotResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BusinessesNextAvailableSlotResponse) Status 

func (r BusinessesNextAvailableSlotResponse) Status() string

Status returns HTTPResponse.Status

func (BusinessesNextAvailableSlotResponse) StatusCode 

func (r BusinessesNextAvailableSlotResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BusinessesServicesParams 

type BusinessesServicesParams struct {
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// Sort Sort field. Allowed values: `order`, `name`, `price`, `category`. Default: `order`. Prefix with `-` for descending order (for example `-order`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

BusinessesServicesParams defines parameters for BusinessesServices.

type BusinessesServicesResponse 

type BusinessesServicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfServiceResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseBusinessesServicesResponse 

func ParseBusinessesServicesResponse(rsp *http.Response) (*BusinessesServicesResponse, error)

ParseBusinessesServicesResponse parses an HTTP response from a BusinessesServicesWithResponse call

func (BusinessesServicesResponse) ContentType 

func (r BusinessesServicesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BusinessesServicesResponse) Status 

func (r BusinessesServicesResponse) Status() string

Status returns HTTPResponse.Status

func (BusinessesServicesResponse) StatusCode 

func (r BusinessesServicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ChatAttachmentResponse 

type ChatAttachmentResponse struct {
	// ContentType MIME type supplied for the uploaded file.
	ContentType *string `json:"content_type,omitempty"`

	// FileName Original or display file name.
	FileName *string `json:"file_name,omitempty"`

	// FileSizeBytes File size in bytes, when known.
	FileSizeBytes *int64 `json:"file_size_bytes,omitempty"`

	// Id Public document id for the attached file.
	Id *string `json:"id,omitempty"`
}

ChatAttachmentResponse Public metadata for a file attached to a chat message.

type ChatCreateAttachmentsParams 

type ChatCreateAttachmentsParams struct {
	// JobId Optional public job id (`job_...`) to scope chat messages to one job.
	JobId *string `form:"job_id,omitempty" json:"job_id,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

ChatCreateAttachmentsParams defines parameters for ChatCreateAttachments.

type ChatCreateAttachmentsResponse 

type ChatCreateAttachmentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *ApiListResponseOfChatMessageResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseChatCreateAttachmentsResponse 

func ParseChatCreateAttachmentsResponse(rsp *http.Response) (*ChatCreateAttachmentsResponse, error)

ParseChatCreateAttachmentsResponse parses an HTTP response from a ChatCreateAttachmentsWithResponse call

func (ChatCreateAttachmentsResponse) ContentType 

func (r ChatCreateAttachmentsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ChatCreateAttachmentsResponse) Status 

func (r ChatCreateAttachmentsResponse) Status() string

Status returns HTTPResponse.Status

func (ChatCreateAttachmentsResponse) StatusCode 

func (r ChatCreateAttachmentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ChatCreateMessageJSONRequestBody 

type ChatCreateMessageJSONRequestBody = CreateChatMessageRequest

ChatCreateMessageJSONRequestBody defines body for ChatCreateMessage for application/json ContentType.

type ChatCreateMessageParams 

type ChatCreateMessageParams struct {
	// JobId Optional public job id (`job_...`) to scope chat messages to one job.
	JobId *string `form:"job_id,omitempty" json:"job_id,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

ChatCreateMessageParams defines parameters for ChatCreateMessage.

type ChatCreateMessageResponse 

type ChatCreateMessageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *ChatMessageResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseChatCreateMessageResponse 

func ParseChatCreateMessageResponse(rsp *http.Response) (*ChatCreateMessageResponse, error)

ParseChatCreateMessageResponse parses an HTTP response from a ChatCreateMessageWithResponse call

func (ChatCreateMessageResponse) ContentType 

func (r ChatCreateMessageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ChatCreateMessageResponse) Status 

func (r ChatCreateMessageResponse) Status() string

Status returns HTTPResponse.Status

func (ChatCreateMessageResponse) StatusCode 

func (r ChatCreateMessageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ChatMessageResponse 

type ChatMessageResponse struct {
	// Attachment Public metadata for a file attached to a chat message.
	Attachment *ChatAttachmentResponse `json:"attachment,omitempty"`

	// Body Text body for text messages. File messages use attachment metadata instead.
	Body *string `json:"body,omitempty"`

	// BusinessId Public business id that owns the chat thread, currently an org_... Clerk organization id.
	BusinessId *string `json:"business_id,omitempty"`

	// ContentType Content type: text, image, video, or file.
	ContentType *string `json:"content_type,omitempty"`

	// CreatedAt UTC timestamp when the message was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// CustomerId Public customer id for the chat thread.
	CustomerId *string `json:"customer_id,omitempty"`

	// Id Public chat message id (`chatmsg_...`, for example `chatmsg_01h2example`).
	Id *string `json:"id,omitempty"`

	// JobId Optional public job id used by the caller for context.
	JobId *string `json:"job_id,omitempty"`

	// Object Resource object type. Always chat_message.
	Object *string `json:"object,omitempty"`

	// Read Whether the message has been read by the recipient.
	Read *bool `json:"read,omitempty"`

	// ReadAt UTC timestamp when the message was read, when available.
	ReadAt *time.Time `json:"read_at,omitempty"`

	// Sender Sender of the message: customer, business, or system.
	Sender *string `json:"sender,omitempty"`
}

ChatMessageResponse Public representation of a customer/business chat message.

type ChatMessagesParams 

type ChatMessagesParams struct {
	// JobId Optional public job id (`job_...`) to scope chat messages to one job.
	JobId *string `form:"job_id,omitempty" json:"job_id,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

ChatMessagesParams defines parameters for ChatMessages.

type ChatMessagesResponse 

type ChatMessagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfChatMessageResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseChatMessagesResponse 

func ParseChatMessagesResponse(rsp *http.Response) (*ChatMessagesResponse, error)

ParseChatMessagesResponse parses an HTTP response from a ChatMessagesWithResponse call

func (ChatMessagesResponse) ContentType 

func (r ChatMessagesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ChatMessagesResponse) Status 

func (r ChatMessagesResponse) Status() string

Status returns HTTPResponse.Status

func (ChatMessagesResponse) StatusCode 

func (r ChatMessagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AssetsCreate 

func (c *Client) AssetsCreate(ctx context.Context, params *AssetsCreateParams, body AssetsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AssetsCreateWithBody 

func (c *Client) AssetsCreateWithBody(ctx context.Context, params *AssetsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AssetsGet 

func (c *Client) AssetsGet(ctx context.Context, assetId string, params *AssetsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AssetsList 

func (c *Client) AssetsList(ctx context.Context, params *AssetsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AssetsListForCustomer 

func (c *Client) AssetsListForCustomer(ctx context.Context, customerId string, params *AssetsListForCustomerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AssetsUpdate 

func (c *Client) AssetsUpdate(ctx context.Context, assetId string, params *AssetsUpdateParams, body AssetsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AssetsUpdateWithBody 

func (c *Client) AssetsUpdateWithBody(ctx context.Context, assetId string, params *AssetsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BusinessesAvailability 

func (c *Client) BusinessesAvailability(ctx context.Context, businessId string, params *BusinessesAvailabilityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BusinessesAvailabilitySlots 

func (c *Client) BusinessesAvailabilitySlots(ctx context.Context, businessId string, params *BusinessesAvailabilitySlotsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BusinessesGet 

func (c *Client) BusinessesGet(ctx context.Context, businessId string, params *BusinessesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BusinessesList 

func (c *Client) BusinessesList(ctx context.Context, params *BusinessesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BusinessesNextAvailableSlot 

func (c *Client) BusinessesNextAvailableSlot(ctx context.Context, businessId string, params *BusinessesNextAvailableSlotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BusinessesServices 

func (c *Client) BusinessesServices(ctx context.Context, businessId string, params *BusinessesServicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ChatCreateAttachmentsWithBody 

func (c *Client) ChatCreateAttachmentsWithBody(ctx context.Context, customerId string, params *ChatCreateAttachmentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ChatCreateMessage 

func (c *Client) ChatCreateMessage(ctx context.Context, customerId string, params *ChatCreateMessageParams, body ChatCreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ChatCreateMessageWithBody 

func (c *Client) ChatCreateMessageWithBody(ctx context.Context, customerId string, params *ChatCreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ChatMessages 

func (c *Client) ChatMessages(ctx context.Context, customerId string, params *ChatMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CustomersGet 

func (c *Client) CustomersGet(ctx context.Context, customerId string, params *CustomersGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CustomersList 

func (c *Client) CustomersList(ctx context.Context, params *CustomersListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CustomersUpdate 

func (c *Client) CustomersUpdate(ctx context.Context, customerId string, params *CustomersUpdateParams, body CustomersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CustomersUpdateWithBody 

func (c *Client) CustomersUpdateWithBody(ctx context.Context, customerId string, params *CustomersUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoiceItemsCreate 

func (c *Client) InvoiceItemsCreate(ctx context.Context, params *InvoiceItemsCreateParams, body InvoiceItemsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoiceItemsCreateWithBody 

func (c *Client) InvoiceItemsCreateWithBody(ctx context.Context, params *InvoiceItemsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoiceItemsDelete 

func (c *Client) InvoiceItemsDelete(ctx context.Context, invoiceItemId string, params *InvoiceItemsDeleteParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoiceItemsGet 

func (c *Client) InvoiceItemsGet(ctx context.Context, invoiceItemId string, params *InvoiceItemsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoiceItemsUpdate 

func (c *Client) InvoiceItemsUpdate(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, body InvoiceItemsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoiceItemsUpdateWithBody 

func (c *Client) InvoiceItemsUpdateWithBody(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoicesGet 

func (c *Client) InvoicesGet(ctx context.Context, invoiceId string, params *InvoicesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InvoicesList 

func (c *Client) InvoicesList(ctx context.Context, params *InvoicesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobReportsGet 

func (c *Client) JobReportsGet(ctx context.Context, jobReportId string, params *JobReportsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobReportsGetForJob 

func (c *Client) JobReportsGetForJob(ctx context.Context, jobId string, jobReportId string, params *JobReportsGetForJobParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobReportsList 

func (c *Client) JobReportsList(ctx context.Context, params *JobReportsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobReportsListForJob 

func (c *Client) JobReportsListForJob(ctx context.Context, jobId string, params *JobReportsListForJobParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsCreate 

func (c *Client) JobsCreate(ctx context.Context, params *JobsCreateParams, body JobsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsCreateWithBody 

func (c *Client) JobsCreateWithBody(ctx context.Context, params *JobsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsGet 

func (c *Client) JobsGet(ctx context.Context, jobId string, params *JobsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsList 

func (c *Client) JobsList(ctx context.Context, params *JobsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsPartAuthorisations 

func (c *Client) JobsPartAuthorisations(ctx context.Context, jobId string, params *JobsPartAuthorisationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsSubmitPartAuthorisationDecisions 

func (c *Client) JobsSubmitPartAuthorisationDecisions(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, body JobsSubmitPartAuthorisationDecisionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsSubmitPartAuthorisationDecisionsWithBody 

func (c *Client) JobsSubmitPartAuthorisationDecisionsWithBody(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ServicesCreate 

func (c *Client) ServicesCreate(ctx context.Context, businessId string, params *ServicesCreateParams, body ServicesCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ServicesCreateWithBody 

func (c *Client) ServicesCreateWithBody(ctx context.Context, businessId string, params *ServicesCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ServicesGet 

func (c *Client) ServicesGet(ctx context.Context, serviceId string, params *ServicesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ServicesList 

func (c *Client) ServicesList(ctx context.Context, params *ServicesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ServicesUpdate 

func (c *Client) ServicesUpdate(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, body ServicesUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ServicesUpdateWithBody 

func (c *Client) ServicesUpdateWithBody(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) StockGet 

func (c *Client) StockGet(ctx context.Context, stockVariationId string, params *StockGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) StockList 

func (c *Client) StockList(ctx context.Context, params *StockListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookDeliveriesGet 

func (c *Client) WebhookDeliveriesGet(ctx context.Context, deliveryId string, params *WebhookDeliveriesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookDeliveriesListForEndpoint 

func (c *Client) WebhookDeliveriesListForEndpoint(ctx context.Context, endpointId string, params *WebhookDeliveriesListForEndpointParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookDeliveriesReplay 

func (c *Client) WebhookDeliveriesReplay(ctx context.Context, deliveryId string, params *WebhookDeliveriesReplayParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsCreate 

func (c *Client) WebhookEndpointsCreate(ctx context.Context, params *WebhookEndpointsCreateParams, body WebhookEndpointsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsCreateWithBody 

func (c *Client) WebhookEndpointsCreateWithBody(ctx context.Context, params *WebhookEndpointsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsDelete 

func (c *Client) WebhookEndpointsDelete(ctx context.Context, endpointId string, params *WebhookEndpointsDeleteParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsGet 

func (c *Client) WebhookEndpointsGet(ctx context.Context, endpointId string, params *WebhookEndpointsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsList 

func (c *Client) WebhookEndpointsList(ctx context.Context, params *WebhookEndpointsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsRotateSecret 

func (c *Client) WebhookEndpointsRotateSecret(ctx context.Context, endpointId string, params *WebhookEndpointsRotateSecretParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsUpdate 

func (c *Client) WebhookEndpointsUpdate(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, body WebhookEndpointsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEndpointsUpdateWithBody 

func (c *Client) WebhookEndpointsUpdateWithBody(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) WebhookEventsList 

func (c *Client) WebhookEventsList(ctx context.Context, params *WebhookEventsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// AssetsList request
	AssetsList(ctx context.Context, params *AssetsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AssetsCreateWithBody request with any body
	AssetsCreateWithBody(ctx context.Context, params *AssetsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AssetsCreate(ctx context.Context, params *AssetsCreateParams, body AssetsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AssetsGet request
	AssetsGet(ctx context.Context, assetId string, params *AssetsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AssetsUpdateWithBody request with any body
	AssetsUpdateWithBody(ctx context.Context, assetId string, params *AssetsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AssetsUpdate(ctx context.Context, assetId string, params *AssetsUpdateParams, body AssetsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BusinessesList request
	BusinessesList(ctx context.Context, params *BusinessesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BusinessesGet request
	BusinessesGet(ctx context.Context, businessId string, params *BusinessesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BusinessesAvailability request
	BusinessesAvailability(ctx context.Context, businessId string, params *BusinessesAvailabilityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BusinessesAvailabilitySlots request
	BusinessesAvailabilitySlots(ctx context.Context, businessId string, params *BusinessesAvailabilitySlotsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BusinessesNextAvailableSlot request
	BusinessesNextAvailableSlot(ctx context.Context, businessId string, params *BusinessesNextAvailableSlotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BusinessesServices request
	BusinessesServices(ctx context.Context, businessId string, params *BusinessesServicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ServicesCreateWithBody request with any body
	ServicesCreateWithBody(ctx context.Context, businessId string, params *ServicesCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ServicesCreate(ctx context.Context, businessId string, params *ServicesCreateParams, body ServicesCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ServicesUpdateWithBody request with any body
	ServicesUpdateWithBody(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ServicesUpdate(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, body ServicesUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CustomersList request
	CustomersList(ctx context.Context, params *CustomersListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CustomersGet request
	CustomersGet(ctx context.Context, customerId string, params *CustomersGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CustomersUpdateWithBody request with any body
	CustomersUpdateWithBody(ctx context.Context, customerId string, params *CustomersUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CustomersUpdate(ctx context.Context, customerId string, params *CustomersUpdateParams, body CustomersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AssetsListForCustomer request
	AssetsListForCustomer(ctx context.Context, customerId string, params *AssetsListForCustomerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChatCreateAttachmentsWithBody request with any body
	ChatCreateAttachmentsWithBody(ctx context.Context, customerId string, params *ChatCreateAttachmentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChatMessages request
	ChatMessages(ctx context.Context, customerId string, params *ChatMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChatCreateMessageWithBody request with any body
	ChatCreateMessageWithBody(ctx context.Context, customerId string, params *ChatCreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ChatCreateMessage(ctx context.Context, customerId string, params *ChatCreateMessageParams, body ChatCreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InvoiceItemsCreateWithBody request with any body
	InvoiceItemsCreateWithBody(ctx context.Context, params *InvoiceItemsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	InvoiceItemsCreate(ctx context.Context, params *InvoiceItemsCreateParams, body InvoiceItemsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InvoiceItemsDelete request
	InvoiceItemsDelete(ctx context.Context, invoiceItemId string, params *InvoiceItemsDeleteParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InvoiceItemsGet request
	InvoiceItemsGet(ctx context.Context, invoiceItemId string, params *InvoiceItemsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InvoiceItemsUpdateWithBody request with any body
	InvoiceItemsUpdateWithBody(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	InvoiceItemsUpdate(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, body InvoiceItemsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InvoicesList request
	InvoicesList(ctx context.Context, params *InvoicesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InvoicesGet request
	InvoicesGet(ctx context.Context, invoiceId string, params *InvoicesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobReportsList request
	JobReportsList(ctx context.Context, params *JobReportsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobReportsGet request
	JobReportsGet(ctx context.Context, jobReportId string, params *JobReportsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobsList request
	JobsList(ctx context.Context, params *JobsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobsCreateWithBody request with any body
	JobsCreateWithBody(ctx context.Context, params *JobsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	JobsCreate(ctx context.Context, params *JobsCreateParams, body JobsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobsGet request
	JobsGet(ctx context.Context, jobId string, params *JobsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobReportsListForJob request
	JobReportsListForJob(ctx context.Context, jobId string, params *JobReportsListForJobParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobReportsGetForJob request
	JobReportsGetForJob(ctx context.Context, jobId string, jobReportId string, params *JobReportsGetForJobParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobsPartAuthorisations request
	JobsPartAuthorisations(ctx context.Context, jobId string, params *JobsPartAuthorisationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobsSubmitPartAuthorisationDecisionsWithBody request with any body
	JobsSubmitPartAuthorisationDecisionsWithBody(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	JobsSubmitPartAuthorisationDecisions(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, body JobsSubmitPartAuthorisationDecisionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ServicesList request
	ServicesList(ctx context.Context, params *ServicesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ServicesGet request
	ServicesGet(ctx context.Context, serviceId string, params *ServicesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StockList request
	StockList(ctx context.Context, params *StockListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StockGet request
	StockGet(ctx context.Context, stockVariationId string, params *StockGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookDeliveriesGet request
	WebhookDeliveriesGet(ctx context.Context, deliveryId string, params *WebhookDeliveriesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookDeliveriesReplay request
	WebhookDeliveriesReplay(ctx context.Context, deliveryId string, params *WebhookDeliveriesReplayParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookEndpointsList request
	WebhookEndpointsList(ctx context.Context, params *WebhookEndpointsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookEndpointsCreateWithBody request with any body
	WebhookEndpointsCreateWithBody(ctx context.Context, params *WebhookEndpointsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	WebhookEndpointsCreate(ctx context.Context, params *WebhookEndpointsCreateParams, body WebhookEndpointsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookEndpointsDelete request
	WebhookEndpointsDelete(ctx context.Context, endpointId string, params *WebhookEndpointsDeleteParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookEndpointsGet request
	WebhookEndpointsGet(ctx context.Context, endpointId string, params *WebhookEndpointsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookEndpointsUpdateWithBody request with any body
	WebhookEndpointsUpdateWithBody(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	WebhookEndpointsUpdate(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, body WebhookEndpointsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookDeliveriesListForEndpoint request
	WebhookDeliveriesListForEndpoint(ctx context.Context, endpointId string, params *WebhookDeliveriesListForEndpointParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookEndpointsRotateSecret request
	WebhookEndpointsRotateSecret(ctx context.Context, endpointId string, params *WebhookEndpointsRotateSecretParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WebhookEventsList request
	WebhookEventsList(ctx context.Context, params *WebhookEventsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AssetsCreateWithBodyWithResponse 

func (c *ClientWithResponses) AssetsCreateWithBodyWithResponse(ctx context.Context, params *AssetsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssetsCreateResponse, error)

AssetsCreateWithBodyWithResponse request with arbitrary body returning *AssetsCreateResponse

func (*ClientWithResponses) AssetsCreateWithResponse 

func (c *ClientWithResponses) AssetsCreateWithResponse(ctx context.Context, params *AssetsCreateParams, body AssetsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*AssetsCreateResponse, error)

func (*ClientWithResponses) AssetsGetWithResponse 

func (c *ClientWithResponses) AssetsGetWithResponse(ctx context.Context, assetId string, params *AssetsGetParams, reqEditors ...RequestEditorFn) (*AssetsGetResponse, error)

AssetsGetWithResponse request returning *AssetsGetResponse

func (*ClientWithResponses) AssetsListForCustomerWithResponse 

func (c *ClientWithResponses) AssetsListForCustomerWithResponse(ctx context.Context, customerId string, params *AssetsListForCustomerParams, reqEditors ...RequestEditorFn) (*AssetsListForCustomerResponse, error)

AssetsListForCustomerWithResponse request returning *AssetsListForCustomerResponse

func (*ClientWithResponses) AssetsListWithResponse 

func (c *ClientWithResponses) AssetsListWithResponse(ctx context.Context, params *AssetsListParams, reqEditors ...RequestEditorFn) (*AssetsListResponse, error)

AssetsListWithResponse request returning *AssetsListResponse

func (*ClientWithResponses) AssetsUpdateWithBodyWithResponse 

func (c *ClientWithResponses) AssetsUpdateWithBodyWithResponse(ctx context.Context, assetId string, params *AssetsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssetsUpdateResponse, error)

AssetsUpdateWithBodyWithResponse request with arbitrary body returning *AssetsUpdateResponse

func (*ClientWithResponses) AssetsUpdateWithResponse 

func (c *ClientWithResponses) AssetsUpdateWithResponse(ctx context.Context, assetId string, params *AssetsUpdateParams, body AssetsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*AssetsUpdateResponse, error)

func (*ClientWithResponses) BusinessesAvailabilitySlotsWithResponse 

func (c *ClientWithResponses) BusinessesAvailabilitySlotsWithResponse(ctx context.Context, businessId string, params *BusinessesAvailabilitySlotsParams, reqEditors ...RequestEditorFn) (*BusinessesAvailabilitySlotsResponse, error)

BusinessesAvailabilitySlotsWithResponse request returning *BusinessesAvailabilitySlotsResponse

func (*ClientWithResponses) BusinessesAvailabilityWithResponse 

func (c *ClientWithResponses) BusinessesAvailabilityWithResponse(ctx context.Context, businessId string, params *BusinessesAvailabilityParams, reqEditors ...RequestEditorFn) (*BusinessesAvailabilityResponse, error)

BusinessesAvailabilityWithResponse request returning *BusinessesAvailabilityResponse

func (*ClientWithResponses) BusinessesGetWithResponse 

func (c *ClientWithResponses) BusinessesGetWithResponse(ctx context.Context, businessId string, params *BusinessesGetParams, reqEditors ...RequestEditorFn) (*BusinessesGetResponse, error)

BusinessesGetWithResponse request returning *BusinessesGetResponse

func (*ClientWithResponses) BusinessesListWithResponse 

func (c *ClientWithResponses) BusinessesListWithResponse(ctx context.Context, params *BusinessesListParams, reqEditors ...RequestEditorFn) (*BusinessesListResponse, error)

BusinessesListWithResponse request returning *BusinessesListResponse

func (*ClientWithResponses) BusinessesNextAvailableSlotWithResponse 

func (c *ClientWithResponses) BusinessesNextAvailableSlotWithResponse(ctx context.Context, businessId string, params *BusinessesNextAvailableSlotParams, reqEditors ...RequestEditorFn) (*BusinessesNextAvailableSlotResponse, error)

BusinessesNextAvailableSlotWithResponse request returning *BusinessesNextAvailableSlotResponse

func (*ClientWithResponses) BusinessesServicesWithResponse 

func (c *ClientWithResponses) BusinessesServicesWithResponse(ctx context.Context, businessId string, params *BusinessesServicesParams, reqEditors ...RequestEditorFn) (*BusinessesServicesResponse, error)

BusinessesServicesWithResponse request returning *BusinessesServicesResponse

func (*ClientWithResponses) ChatCreateAttachmentsWithBodyWithResponse 

func (c *ClientWithResponses) ChatCreateAttachmentsWithBodyWithResponse(ctx context.Context, customerId string, params *ChatCreateAttachmentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChatCreateAttachmentsResponse, error)

ChatCreateAttachmentsWithBodyWithResponse request with arbitrary body returning *ChatCreateAttachmentsResponse

func (*ClientWithResponses) ChatCreateMessageWithBodyWithResponse 

func (c *ClientWithResponses) ChatCreateMessageWithBodyWithResponse(ctx context.Context, customerId string, params *ChatCreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChatCreateMessageResponse, error)

ChatCreateMessageWithBodyWithResponse request with arbitrary body returning *ChatCreateMessageResponse

func (*ClientWithResponses) ChatCreateMessageWithResponse 

func (c *ClientWithResponses) ChatCreateMessageWithResponse(ctx context.Context, customerId string, params *ChatCreateMessageParams, body ChatCreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*ChatCreateMessageResponse, error)

func (*ClientWithResponses) ChatMessagesWithResponse 

func (c *ClientWithResponses) ChatMessagesWithResponse(ctx context.Context, customerId string, params *ChatMessagesParams, reqEditors ...RequestEditorFn) (*ChatMessagesResponse, error)

ChatMessagesWithResponse request returning *ChatMessagesResponse

func (*ClientWithResponses) CustomersGetWithResponse 

func (c *ClientWithResponses) CustomersGetWithResponse(ctx context.Context, customerId string, params *CustomersGetParams, reqEditors ...RequestEditorFn) (*CustomersGetResponse, error)

CustomersGetWithResponse request returning *CustomersGetResponse

func (*ClientWithResponses) CustomersListWithResponse 

func (c *ClientWithResponses) CustomersListWithResponse(ctx context.Context, params *CustomersListParams, reqEditors ...RequestEditorFn) (*CustomersListResponse, error)

CustomersListWithResponse request returning *CustomersListResponse

func (*ClientWithResponses) CustomersUpdateWithBodyWithResponse 

func (c *ClientWithResponses) CustomersUpdateWithBodyWithResponse(ctx context.Context, customerId string, params *CustomersUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CustomersUpdateResponse, error)

CustomersUpdateWithBodyWithResponse request with arbitrary body returning *CustomersUpdateResponse

func (*ClientWithResponses) CustomersUpdateWithResponse 

func (c *ClientWithResponses) CustomersUpdateWithResponse(ctx context.Context, customerId string, params *CustomersUpdateParams, body CustomersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*CustomersUpdateResponse, error)

func (*ClientWithResponses) InvoiceItemsCreateWithBodyWithResponse 

func (c *ClientWithResponses) InvoiceItemsCreateWithBodyWithResponse(ctx context.Context, params *InvoiceItemsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InvoiceItemsCreateResponse, error)

InvoiceItemsCreateWithBodyWithResponse request with arbitrary body returning *InvoiceItemsCreateResponse

func (*ClientWithResponses) InvoiceItemsCreateWithResponse 

func (c *ClientWithResponses) InvoiceItemsCreateWithResponse(ctx context.Context, params *InvoiceItemsCreateParams, body InvoiceItemsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*InvoiceItemsCreateResponse, error)

func (*ClientWithResponses) InvoiceItemsDeleteWithResponse 

func (c *ClientWithResponses) InvoiceItemsDeleteWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsDeleteParams, reqEditors ...RequestEditorFn) (*InvoiceItemsDeleteResponse, error)

InvoiceItemsDeleteWithResponse request returning *InvoiceItemsDeleteResponse

func (*ClientWithResponses) InvoiceItemsGetWithResponse 

func (c *ClientWithResponses) InvoiceItemsGetWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsGetParams, reqEditors ...RequestEditorFn) (*InvoiceItemsGetResponse, error)

InvoiceItemsGetWithResponse request returning *InvoiceItemsGetResponse

func (*ClientWithResponses) InvoiceItemsUpdateWithBodyWithResponse 

func (c *ClientWithResponses) InvoiceItemsUpdateWithBodyWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InvoiceItemsUpdateResponse, error)

InvoiceItemsUpdateWithBodyWithResponse request with arbitrary body returning *InvoiceItemsUpdateResponse

func (*ClientWithResponses) InvoiceItemsUpdateWithResponse 

func (c *ClientWithResponses) InvoiceItemsUpdateWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, body InvoiceItemsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*InvoiceItemsUpdateResponse, error)

func (*ClientWithResponses) InvoicesGetWithResponse 

func (c *ClientWithResponses) InvoicesGetWithResponse(ctx context.Context, invoiceId string, params *InvoicesGetParams, reqEditors ...RequestEditorFn) (*InvoicesGetResponse, error)

InvoicesGetWithResponse request returning *InvoicesGetResponse

func (*ClientWithResponses) InvoicesListWithResponse 

func (c *ClientWithResponses) InvoicesListWithResponse(ctx context.Context, params *InvoicesListParams, reqEditors ...RequestEditorFn) (*InvoicesListResponse, error)

InvoicesListWithResponse request returning *InvoicesListResponse

func (*ClientWithResponses) JobReportsGetForJobWithResponse 

func (c *ClientWithResponses) JobReportsGetForJobWithResponse(ctx context.Context, jobId string, jobReportId string, params *JobReportsGetForJobParams, reqEditors ...RequestEditorFn) (*JobReportsGetForJobResponse, error)

JobReportsGetForJobWithResponse request returning *JobReportsGetForJobResponse

func (*ClientWithResponses) JobReportsGetWithResponse 

func (c *ClientWithResponses) JobReportsGetWithResponse(ctx context.Context, jobReportId string, params *JobReportsGetParams, reqEditors ...RequestEditorFn) (*JobReportsGetResponse, error)

JobReportsGetWithResponse request returning *JobReportsGetResponse

func (*ClientWithResponses) JobReportsListForJobWithResponse 

func (c *ClientWithResponses) JobReportsListForJobWithResponse(ctx context.Context, jobId string, params *JobReportsListForJobParams, reqEditors ...RequestEditorFn) (*JobReportsListForJobResponse, error)

JobReportsListForJobWithResponse request returning *JobReportsListForJobResponse

func (*ClientWithResponses) JobReportsListWithResponse 

func (c *ClientWithResponses) JobReportsListWithResponse(ctx context.Context, params *JobReportsListParams, reqEditors ...RequestEditorFn) (*JobReportsListResponse, error)

JobReportsListWithResponse request returning *JobReportsListResponse

func (*ClientWithResponses) JobsCreateWithBodyWithResponse 

func (c *ClientWithResponses) JobsCreateWithBodyWithResponse(ctx context.Context, params *JobsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*JobsCreateResponse, error)

JobsCreateWithBodyWithResponse request with arbitrary body returning *JobsCreateResponse

func (*ClientWithResponses) JobsCreateWithResponse 

func (c *ClientWithResponses) JobsCreateWithResponse(ctx context.Context, params *JobsCreateParams, body JobsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*JobsCreateResponse, error)

func (*ClientWithResponses) JobsGetWithResponse 

func (c *ClientWithResponses) JobsGetWithResponse(ctx context.Context, jobId string, params *JobsGetParams, reqEditors ...RequestEditorFn) (*JobsGetResponse, error)

JobsGetWithResponse request returning *JobsGetResponse

func (*ClientWithResponses) JobsListWithResponse 

func (c *ClientWithResponses) JobsListWithResponse(ctx context.Context, params *JobsListParams, reqEditors ...RequestEditorFn) (*JobsListResponse, error)

JobsListWithResponse request returning *JobsListResponse

func (*ClientWithResponses) JobsPartAuthorisationsWithResponse 

func (c *ClientWithResponses) JobsPartAuthorisationsWithResponse(ctx context.Context, jobId string, params *JobsPartAuthorisationsParams, reqEditors ...RequestEditorFn) (*JobsPartAuthorisationsResponse, error)

JobsPartAuthorisationsWithResponse request returning *JobsPartAuthorisationsResponse

func (*ClientWithResponses) JobsSubmitPartAuthorisationDecisionsWithBodyWithResponse 

func (c *ClientWithResponses) JobsSubmitPartAuthorisationDecisionsWithBodyWithResponse(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*JobsSubmitPartAuthorisationDecisionsResponse, error)

JobsSubmitPartAuthorisationDecisionsWithBodyWithResponse request with arbitrary body returning *JobsSubmitPartAuthorisationDecisionsResponse

func (*ClientWithResponses) JobsSubmitPartAuthorisationDecisionsWithResponse 

func (c *ClientWithResponses) JobsSubmitPartAuthorisationDecisionsWithResponse(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, body JobsSubmitPartAuthorisationDecisionsJSONRequestBody, reqEditors ...RequestEditorFn) (*JobsSubmitPartAuthorisationDecisionsResponse, error)

func (*ClientWithResponses) ServicesCreateWithBodyWithResponse 

func (c *ClientWithResponses) ServicesCreateWithBodyWithResponse(ctx context.Context, businessId string, params *ServicesCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ServicesCreateResponse, error)

ServicesCreateWithBodyWithResponse request with arbitrary body returning *ServicesCreateResponse

func (*ClientWithResponses) ServicesCreateWithResponse 

func (c *ClientWithResponses) ServicesCreateWithResponse(ctx context.Context, businessId string, params *ServicesCreateParams, body ServicesCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*ServicesCreateResponse, error)

func (*ClientWithResponses) ServicesGetWithResponse 

func (c *ClientWithResponses) ServicesGetWithResponse(ctx context.Context, serviceId string, params *ServicesGetParams, reqEditors ...RequestEditorFn) (*ServicesGetResponse, error)

ServicesGetWithResponse request returning *ServicesGetResponse

func (*ClientWithResponses) ServicesListWithResponse 

func (c *ClientWithResponses) ServicesListWithResponse(ctx context.Context, params *ServicesListParams, reqEditors ...RequestEditorFn) (*ServicesListResponse, error)

ServicesListWithResponse request returning *ServicesListResponse

func (*ClientWithResponses) ServicesUpdateWithBodyWithResponse 

func (c *ClientWithResponses) ServicesUpdateWithBodyWithResponse(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ServicesUpdateResponse, error)

ServicesUpdateWithBodyWithResponse request with arbitrary body returning *ServicesUpdateResponse

func (*ClientWithResponses) ServicesUpdateWithResponse 

func (c *ClientWithResponses) ServicesUpdateWithResponse(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, body ServicesUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*ServicesUpdateResponse, error)

func (*ClientWithResponses) StockGetWithResponse 

func (c *ClientWithResponses) StockGetWithResponse(ctx context.Context, stockVariationId string, params *StockGetParams, reqEditors ...RequestEditorFn) (*StockGetResponse, error)

StockGetWithResponse request returning *StockGetResponse

func (*ClientWithResponses) StockListWithResponse 

func (c *ClientWithResponses) StockListWithResponse(ctx context.Context, params *StockListParams, reqEditors ...RequestEditorFn) (*StockListResponse, error)

StockListWithResponse request returning *StockListResponse

func (*ClientWithResponses) WebhookDeliveriesGetWithResponse 

func (c *ClientWithResponses) WebhookDeliveriesGetWithResponse(ctx context.Context, deliveryId string, params *WebhookDeliveriesGetParams, reqEditors ...RequestEditorFn) (*WebhookDeliveriesGetResponse, error)

WebhookDeliveriesGetWithResponse request returning *WebhookDeliveriesGetResponse

func (*ClientWithResponses) WebhookDeliveriesListForEndpointWithResponse 

func (c *ClientWithResponses) WebhookDeliveriesListForEndpointWithResponse(ctx context.Context, endpointId string, params *WebhookDeliveriesListForEndpointParams, reqEditors ...RequestEditorFn) (*WebhookDeliveriesListForEndpointResponse, error)

WebhookDeliveriesListForEndpointWithResponse request returning *WebhookDeliveriesListForEndpointResponse

func (*ClientWithResponses) WebhookDeliveriesReplayWithResponse 

func (c *ClientWithResponses) WebhookDeliveriesReplayWithResponse(ctx context.Context, deliveryId string, params *WebhookDeliveriesReplayParams, reqEditors ...RequestEditorFn) (*WebhookDeliveriesReplayResponse, error)

WebhookDeliveriesReplayWithResponse request returning *WebhookDeliveriesReplayResponse

func (*ClientWithResponses) WebhookEndpointsCreateWithBodyWithResponse 

func (c *ClientWithResponses) WebhookEndpointsCreateWithBodyWithResponse(ctx context.Context, params *WebhookEndpointsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*WebhookEndpointsCreateResponse, error)

WebhookEndpointsCreateWithBodyWithResponse request with arbitrary body returning *WebhookEndpointsCreateResponse

func (*ClientWithResponses) WebhookEndpointsCreateWithResponse 

func (c *ClientWithResponses) WebhookEndpointsCreateWithResponse(ctx context.Context, params *WebhookEndpointsCreateParams, body WebhookEndpointsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*WebhookEndpointsCreateResponse, error)

func (*ClientWithResponses) WebhookEndpointsDeleteWithResponse 

func (c *ClientWithResponses) WebhookEndpointsDeleteWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsDeleteParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsDeleteResponse, error)

WebhookEndpointsDeleteWithResponse request returning *WebhookEndpointsDeleteResponse

func (*ClientWithResponses) WebhookEndpointsGetWithResponse 

func (c *ClientWithResponses) WebhookEndpointsGetWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsGetParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsGetResponse, error)

WebhookEndpointsGetWithResponse request returning *WebhookEndpointsGetResponse

func (*ClientWithResponses) WebhookEndpointsListWithResponse 

func (c *ClientWithResponses) WebhookEndpointsListWithResponse(ctx context.Context, params *WebhookEndpointsListParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsListResponse, error)

WebhookEndpointsListWithResponse request returning *WebhookEndpointsListResponse

func (*ClientWithResponses) WebhookEndpointsRotateSecretWithResponse 

func (c *ClientWithResponses) WebhookEndpointsRotateSecretWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsRotateSecretParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsRotateSecretResponse, error)

WebhookEndpointsRotateSecretWithResponse request returning *WebhookEndpointsRotateSecretResponse

func (*ClientWithResponses) WebhookEndpointsUpdateWithBodyWithResponse 

func (c *ClientWithResponses) WebhookEndpointsUpdateWithBodyWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*WebhookEndpointsUpdateResponse, error)

WebhookEndpointsUpdateWithBodyWithResponse request with arbitrary body returning *WebhookEndpointsUpdateResponse

func (*ClientWithResponses) WebhookEndpointsUpdateWithResponse 

func (c *ClientWithResponses) WebhookEndpointsUpdateWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, body WebhookEndpointsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*WebhookEndpointsUpdateResponse, error)

func (*ClientWithResponses) WebhookEventsListWithResponse 

func (c *ClientWithResponses) WebhookEventsListWithResponse(ctx context.Context, params *WebhookEventsListParams, reqEditors ...RequestEditorFn) (*WebhookEventsListResponse, error)

WebhookEventsListWithResponse request returning *WebhookEventsListResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// AssetsListWithResponse request
	AssetsListWithResponse(ctx context.Context, params *AssetsListParams, reqEditors ...RequestEditorFn) (*AssetsListResponse, error)

	// AssetsCreateWithBodyWithResponse request with any body
	AssetsCreateWithBodyWithResponse(ctx context.Context, params *AssetsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssetsCreateResponse, error)

	AssetsCreateWithResponse(ctx context.Context, params *AssetsCreateParams, body AssetsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*AssetsCreateResponse, error)

	// AssetsGetWithResponse request
	AssetsGetWithResponse(ctx context.Context, assetId string, params *AssetsGetParams, reqEditors ...RequestEditorFn) (*AssetsGetResponse, error)

	// AssetsUpdateWithBodyWithResponse request with any body
	AssetsUpdateWithBodyWithResponse(ctx context.Context, assetId string, params *AssetsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssetsUpdateResponse, error)

	AssetsUpdateWithResponse(ctx context.Context, assetId string, params *AssetsUpdateParams, body AssetsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*AssetsUpdateResponse, error)

	// BusinessesListWithResponse request
	BusinessesListWithResponse(ctx context.Context, params *BusinessesListParams, reqEditors ...RequestEditorFn) (*BusinessesListResponse, error)

	// BusinessesGetWithResponse request
	BusinessesGetWithResponse(ctx context.Context, businessId string, params *BusinessesGetParams, reqEditors ...RequestEditorFn) (*BusinessesGetResponse, error)

	// BusinessesAvailabilityWithResponse request
	BusinessesAvailabilityWithResponse(ctx context.Context, businessId string, params *BusinessesAvailabilityParams, reqEditors ...RequestEditorFn) (*BusinessesAvailabilityResponse, error)

	// BusinessesAvailabilitySlotsWithResponse request
	BusinessesAvailabilitySlotsWithResponse(ctx context.Context, businessId string, params *BusinessesAvailabilitySlotsParams, reqEditors ...RequestEditorFn) (*BusinessesAvailabilitySlotsResponse, error)

	// BusinessesNextAvailableSlotWithResponse request
	BusinessesNextAvailableSlotWithResponse(ctx context.Context, businessId string, params *BusinessesNextAvailableSlotParams, reqEditors ...RequestEditorFn) (*BusinessesNextAvailableSlotResponse, error)

	// BusinessesServicesWithResponse request
	BusinessesServicesWithResponse(ctx context.Context, businessId string, params *BusinessesServicesParams, reqEditors ...RequestEditorFn) (*BusinessesServicesResponse, error)

	// ServicesCreateWithBodyWithResponse request with any body
	ServicesCreateWithBodyWithResponse(ctx context.Context, businessId string, params *ServicesCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ServicesCreateResponse, error)

	ServicesCreateWithResponse(ctx context.Context, businessId string, params *ServicesCreateParams, body ServicesCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*ServicesCreateResponse, error)

	// ServicesUpdateWithBodyWithResponse request with any body
	ServicesUpdateWithBodyWithResponse(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ServicesUpdateResponse, error)

	ServicesUpdateWithResponse(ctx context.Context, businessId string, serviceId string, params *ServicesUpdateParams, body ServicesUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*ServicesUpdateResponse, error)

	// CustomersListWithResponse request
	CustomersListWithResponse(ctx context.Context, params *CustomersListParams, reqEditors ...RequestEditorFn) (*CustomersListResponse, error)

	// CustomersGetWithResponse request
	CustomersGetWithResponse(ctx context.Context, customerId string, params *CustomersGetParams, reqEditors ...RequestEditorFn) (*CustomersGetResponse, error)

	// CustomersUpdateWithBodyWithResponse request with any body
	CustomersUpdateWithBodyWithResponse(ctx context.Context, customerId string, params *CustomersUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CustomersUpdateResponse, error)

	CustomersUpdateWithResponse(ctx context.Context, customerId string, params *CustomersUpdateParams, body CustomersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*CustomersUpdateResponse, error)

	// AssetsListForCustomerWithResponse request
	AssetsListForCustomerWithResponse(ctx context.Context, customerId string, params *AssetsListForCustomerParams, reqEditors ...RequestEditorFn) (*AssetsListForCustomerResponse, error)

	// ChatCreateAttachmentsWithBodyWithResponse request with any body
	ChatCreateAttachmentsWithBodyWithResponse(ctx context.Context, customerId string, params *ChatCreateAttachmentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChatCreateAttachmentsResponse, error)

	// ChatMessagesWithResponse request
	ChatMessagesWithResponse(ctx context.Context, customerId string, params *ChatMessagesParams, reqEditors ...RequestEditorFn) (*ChatMessagesResponse, error)

	// ChatCreateMessageWithBodyWithResponse request with any body
	ChatCreateMessageWithBodyWithResponse(ctx context.Context, customerId string, params *ChatCreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChatCreateMessageResponse, error)

	ChatCreateMessageWithResponse(ctx context.Context, customerId string, params *ChatCreateMessageParams, body ChatCreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*ChatCreateMessageResponse, error)

	// InvoiceItemsCreateWithBodyWithResponse request with any body
	InvoiceItemsCreateWithBodyWithResponse(ctx context.Context, params *InvoiceItemsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InvoiceItemsCreateResponse, error)

	InvoiceItemsCreateWithResponse(ctx context.Context, params *InvoiceItemsCreateParams, body InvoiceItemsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*InvoiceItemsCreateResponse, error)

	// InvoiceItemsDeleteWithResponse request
	InvoiceItemsDeleteWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsDeleteParams, reqEditors ...RequestEditorFn) (*InvoiceItemsDeleteResponse, error)

	// InvoiceItemsGetWithResponse request
	InvoiceItemsGetWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsGetParams, reqEditors ...RequestEditorFn) (*InvoiceItemsGetResponse, error)

	// InvoiceItemsUpdateWithBodyWithResponse request with any body
	InvoiceItemsUpdateWithBodyWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InvoiceItemsUpdateResponse, error)

	InvoiceItemsUpdateWithResponse(ctx context.Context, invoiceItemId string, params *InvoiceItemsUpdateParams, body InvoiceItemsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*InvoiceItemsUpdateResponse, error)

	// InvoicesListWithResponse request
	InvoicesListWithResponse(ctx context.Context, params *InvoicesListParams, reqEditors ...RequestEditorFn) (*InvoicesListResponse, error)

	// InvoicesGetWithResponse request
	InvoicesGetWithResponse(ctx context.Context, invoiceId string, params *InvoicesGetParams, reqEditors ...RequestEditorFn) (*InvoicesGetResponse, error)

	// JobReportsListWithResponse request
	JobReportsListWithResponse(ctx context.Context, params *JobReportsListParams, reqEditors ...RequestEditorFn) (*JobReportsListResponse, error)

	// JobReportsGetWithResponse request
	JobReportsGetWithResponse(ctx context.Context, jobReportId string, params *JobReportsGetParams, reqEditors ...RequestEditorFn) (*JobReportsGetResponse, error)

	// JobsListWithResponse request
	JobsListWithResponse(ctx context.Context, params *JobsListParams, reqEditors ...RequestEditorFn) (*JobsListResponse, error)

	// JobsCreateWithBodyWithResponse request with any body
	JobsCreateWithBodyWithResponse(ctx context.Context, params *JobsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*JobsCreateResponse, error)

	JobsCreateWithResponse(ctx context.Context, params *JobsCreateParams, body JobsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*JobsCreateResponse, error)

	// JobsGetWithResponse request
	JobsGetWithResponse(ctx context.Context, jobId string, params *JobsGetParams, reqEditors ...RequestEditorFn) (*JobsGetResponse, error)

	// JobReportsListForJobWithResponse request
	JobReportsListForJobWithResponse(ctx context.Context, jobId string, params *JobReportsListForJobParams, reqEditors ...RequestEditorFn) (*JobReportsListForJobResponse, error)

	// JobReportsGetForJobWithResponse request
	JobReportsGetForJobWithResponse(ctx context.Context, jobId string, jobReportId string, params *JobReportsGetForJobParams, reqEditors ...RequestEditorFn) (*JobReportsGetForJobResponse, error)

	// JobsPartAuthorisationsWithResponse request
	JobsPartAuthorisationsWithResponse(ctx context.Context, jobId string, params *JobsPartAuthorisationsParams, reqEditors ...RequestEditorFn) (*JobsPartAuthorisationsResponse, error)

	// JobsSubmitPartAuthorisationDecisionsWithBodyWithResponse request with any body
	JobsSubmitPartAuthorisationDecisionsWithBodyWithResponse(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*JobsSubmitPartAuthorisationDecisionsResponse, error)

	JobsSubmitPartAuthorisationDecisionsWithResponse(ctx context.Context, jobId string, params *JobsSubmitPartAuthorisationDecisionsParams, body JobsSubmitPartAuthorisationDecisionsJSONRequestBody, reqEditors ...RequestEditorFn) (*JobsSubmitPartAuthorisationDecisionsResponse, error)

	// ServicesListWithResponse request
	ServicesListWithResponse(ctx context.Context, params *ServicesListParams, reqEditors ...RequestEditorFn) (*ServicesListResponse, error)

	// ServicesGetWithResponse request
	ServicesGetWithResponse(ctx context.Context, serviceId string, params *ServicesGetParams, reqEditors ...RequestEditorFn) (*ServicesGetResponse, error)

	// StockListWithResponse request
	StockListWithResponse(ctx context.Context, params *StockListParams, reqEditors ...RequestEditorFn) (*StockListResponse, error)

	// StockGetWithResponse request
	StockGetWithResponse(ctx context.Context, stockVariationId string, params *StockGetParams, reqEditors ...RequestEditorFn) (*StockGetResponse, error)

	// WebhookDeliveriesGetWithResponse request
	WebhookDeliveriesGetWithResponse(ctx context.Context, deliveryId string, params *WebhookDeliveriesGetParams, reqEditors ...RequestEditorFn) (*WebhookDeliveriesGetResponse, error)

	// WebhookDeliveriesReplayWithResponse request
	WebhookDeliveriesReplayWithResponse(ctx context.Context, deliveryId string, params *WebhookDeliveriesReplayParams, reqEditors ...RequestEditorFn) (*WebhookDeliveriesReplayResponse, error)

	// WebhookEndpointsListWithResponse request
	WebhookEndpointsListWithResponse(ctx context.Context, params *WebhookEndpointsListParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsListResponse, error)

	// WebhookEndpointsCreateWithBodyWithResponse request with any body
	WebhookEndpointsCreateWithBodyWithResponse(ctx context.Context, params *WebhookEndpointsCreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*WebhookEndpointsCreateResponse, error)

	WebhookEndpointsCreateWithResponse(ctx context.Context, params *WebhookEndpointsCreateParams, body WebhookEndpointsCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*WebhookEndpointsCreateResponse, error)

	// WebhookEndpointsDeleteWithResponse request
	WebhookEndpointsDeleteWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsDeleteParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsDeleteResponse, error)

	// WebhookEndpointsGetWithResponse request
	WebhookEndpointsGetWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsGetParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsGetResponse, error)

	// WebhookEndpointsUpdateWithBodyWithResponse request with any body
	WebhookEndpointsUpdateWithBodyWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*WebhookEndpointsUpdateResponse, error)

	WebhookEndpointsUpdateWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsUpdateParams, body WebhookEndpointsUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*WebhookEndpointsUpdateResponse, error)

	// WebhookDeliveriesListForEndpointWithResponse request
	WebhookDeliveriesListForEndpointWithResponse(ctx context.Context, endpointId string, params *WebhookDeliveriesListForEndpointParams, reqEditors ...RequestEditorFn) (*WebhookDeliveriesListForEndpointResponse, error)

	// WebhookEndpointsRotateSecretWithResponse request
	WebhookEndpointsRotateSecretWithResponse(ctx context.Context, endpointId string, params *WebhookEndpointsRotateSecretParams, reqEditors ...RequestEditorFn) (*WebhookEndpointsRotateSecretResponse, error)

	// WebhookEventsListWithResponse request
	WebhookEventsListWithResponse(ctx context.Context, params *WebhookEventsListParams, reqEditors ...RequestEditorFn) (*WebhookEventsListResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateAssetRequest 

type CreateAssetRequest struct {
	// CustomerId Required. Customer public id that will own the asset (`cus_...`).
	CustomerId string `json:"customer_id"`

	// Make Asset make or manufacturer.
	Make *string `json:"make,omitempty"`

	// Model Asset model.
	Model *string `json:"model,omitempty"`

	// Name Asset display name.
	Name *string `json:"name,omitempty"`

	// SerialNumber Asset serial number.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Type Public asset type, such as `bike`. Defaults to `bike` when omitted.
	Type *string `json:"type,omitempty"`

	// Year Asset model year.
	Year *int32 `json:"year,omitempty"`
}

CreateAssetRequest Request body for creating a customer asset through the public API.

type CreateChatMessageRequest 

type CreateChatMessageRequest struct {
	// Body Plain text message body to add to the customer's chat thread.
	Body string `json:"body"`

	// Sender Message sender: customer or business. Defaults to customer when omitted.
	Sender *string `json:"sender,omitempty"`
}

CreateChatMessageRequest Request body for creating a customer chat text message through an authenticated public API key.

type CreateInvoiceItemRequest 

type CreateInvoiceItemRequest struct {
	// AssetId Public customer asset id (`asset_...`) when the row is tied to a serviced bike or asset.
	AssetId *string `json:"asset_id,omitempty"`

	// Description Optional longer description for the item.
	Description *string `json:"description,omitempty"`

	// InvoiceId Public invoice id (`inv_...`) that the new item belongs to.
	InvoiceId string `json:"invoice_id"`

	// Name Display name. Required for custom items when `service_id` and `stock_variation_id` are omitted.
	Name *string `json:"name,omitempty"`

	// Order Display order of the item on the invoice.
	Order *int32 `json:"order,omitempty"`

	// Quantity Quantity billed on the item. Defaults to 1.
	Quantity *float64 `json:"quantity,omitempty"`

	// ServiceId Public catalogue service id (`svc_...`) for a service line.
	ServiceId *string `json:"service_id,omitempty"`

	// ServiceItemInstanceId Public service item instance id (`svitn_...`) when attaching a part to a checklist step.
	ServiceItemInstanceId *string `json:"service_item_instance_id,omitempty"`

	// StockVariationId Public stock SKU id (`stkv_...`) for a part line.
	StockVariationId *string `json:"stock_variation_id,omitempty"`

	// UnitPrice Unit price in the invoice currency.
	UnitPrice *float64 `json:"unit_price,omitempty"`
}

CreateInvoiceItemRequest Creates a line on an invoice. `invoice_id` is always required. Also provide exactly one of `service_id`, `stock_variation_id`, or `name` (custom line).

type CreateJobRequest 

type CreateJobRequest struct {
	// AllDay Whether the job is treated as an all-day booking in scheduling views.
	AllDay *bool `json:"all_day,omitempty"`

	// Assets Customer assets included on this job (bikes or other serviced assets). Required: at least one entry. Each entry must use `assets[].id` — an existing public asset id already on the customer (from `GET .../customers/{customer_id}` → `assets[].id`). This array is not optional and must not be empty.
	Assets []JobAssetInput `json:"assets"`

	// AssignedTeamMemberId Public team member id assigned at job level, for example a Clerk user id.
	AssignedTeamMemberId *string `json:"assigned_team_member_id,omitempty"`

	// BillingType Billing/charge source for the job, such as cod, on_account, insurance, or motability_warranty.
	BillingType *string `json:"billing_type,omitempty"`

	// CheckInNotes Check-in notes captured when the asset is received for service.
	CheckInNotes *string `json:"check_in_notes,omitempty"`

	// Customer Customer reference for public job creation.
	Customer JobCustomerInput `json:"customer"`

	// IntegrationOptions Optional till/POS integration settings for the created job. Does not describe which items or services are on the job — use `items` and `work_lines` on the job create request for that.
	IntegrationOptions *JobIntegrationOptions `json:"integration_options,omitempty"`

	// Notes Internal workshop notes to attach to the job.
	Notes         *string                 `json:"notes,omitempty"`
	Notifications *JobNotificationOptions `json:"notifications,omitempty"`

	// RequiredByDate Calendar date when the job must be completed by, when set.
	RequiredByDate *openapi_types.Date `json:"required_by_date,omitempty"`

	// Schedule Scheduling and logistics requested for a public job.
	Schedule *JobScheduleInput `json:"schedule,omitempty"`

	// WorkLines Work to perform per asset. Required: at least one entry; each entry needs `asset_id` and a non-empty `services` array. Each line's `asset_id` must match an `id` listed in `assets`.
	WorkLines []JobWorkLineInput `json:"work_lines"`
}

CreateJobRequest Request body for POST /public/v1/jobs.

type CreateServiceRequest 

type CreateServiceRequest struct {
	// Category Public category name. Workshop creates the category for the business if it does not exist.
	Category string `json:"category"`

	// Description Description of what the service includes.
	Description *string `json:"description,omitempty"`

	// DurationMinutes Estimated duration in minutes.
	DurationMinutes *int32 `json:"duration_minutes,omitempty"`

	// ImageUrl Public image URL to associate with the service.
	ImageUrl *string `json:"image_url,omitempty"`

	// Name Service name shown in the public catalogue.
	Name string `json:"name"`

	// Price Raw service price. Required by callers for set_price services; ignored in public display for other pricing models.
	Price *float64 `json:"price,omitempty"`

	// PricingType Pricing model as a snake_case value: set_price, price_on_assessment, or price_on_request.
	PricingType *string `json:"pricing_type,omitempty"`

	// Visibility Catalogue visibility as a snake_case value: external_and_internal, internal_only, or disabled.
	Visibility *string `json:"visibility,omitempty"`
}

CreateServiceRequest Public API request for creating a service in a business catalogue.

type CreateWebhookEndpointRequest 

type CreateWebhookEndpointRequest struct {
	// BusinessIds Public business ids (`org_...`) this endpoint is subscribed to. At least one id is required; each id must be allowed for your API key.
	BusinessIds []string `json:"business_ids"`

	// Description Optional human-readable description for this endpoint.
	Description *string `json:"description,omitempty"`

	// Enabled Whether delivery to this endpoint is enabled. Defaults to true when omitted.
	Enabled *bool `json:"enabled,omitempty"`

	// EventTypes Event type filters such as job.created. Use * or omit for all supported events.
	EventTypes *[]string `json:"event_types,omitempty"`

	// Url HTTPS URL that Workshop will POST webhook events to.
	Url string `json:"url"`
}

CreateWebhookEndpointRequest Request body for creating an outbound webhook endpoint subscription.

type CreateWebhookEndpointResponse 

type CreateWebhookEndpointResponse struct {
	// BusinessIds Public business ids this endpoint is subscribed to.
	BusinessIds *[]string `json:"business_ids,omitempty"`

	// CreatedAt UTC timestamp when this endpoint was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Description Human-readable description for this endpoint.
	Description *string `json:"description,omitempty"`

	// Enabled Whether delivery to this endpoint is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// EventTypes Event type filters. A single * means all supported events.
	EventTypes *[]string `json:"event_types,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// Object Resource object type. Always webhook_endpoint.
	Object *string `json:"object,omitempty"`

	// PreviousSigningSecretExpiresAt UTC timestamp when the previous signing secret stops being included in signatures.
	PreviousSigningSecretExpiresAt *time.Time `json:"previous_signing_secret_expires_at,omitempty"`

	// PreviousSigningSecretPrefix Display-only prefix for the previous signing secret during rotation, when active.
	PreviousSigningSecretPrefix *string `json:"previous_signing_secret_prefix,omitempty"`

	// SigningSecret One-time signing secret used to verify Workshop webhook signatures. Store it securely.
	SigningSecret *string `json:"signing_secret,omitempty"`

	// SigningSecretPrefix Display-only prefix for identifying the active signing secret.
	SigningSecretPrefix *string `json:"signing_secret_prefix,omitempty"`

	// UpdatedAt UTC timestamp when this endpoint was last updated.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// Url HTTPS URL that Workshop posts webhook events to.
	Url *string `json:"url,omitempty"`
}

CreateWebhookEndpointResponse Response returned when a webhook endpoint is created. The signing secret is only returned once.

type CustomerAssetSummaryResponse 

type CustomerAssetSummaryResponse struct {
	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// Make Asset make or manufacturer.
	Make *string `json:"make,omitempty"`

	// Model Asset model.
	Model *string `json:"model,omitempty"`

	// Name Asset display name.
	Name *string `json:"name,omitempty"`

	// SerialNumber Asset serial number, when known.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Type Public asset type, such as bike or another serviced asset category.
	Type *string `json:"type,omitempty"`

	// Year Asset year, when known.
	Year *int32 `json:"year,omitempty"`
}

CustomerAssetSummaryResponse Public customer asset summary embedded in customer responses.

type CustomerResponse 

type CustomerResponse struct {
	// Assets Assets associated with the customer that may be serviced in jobs.
	Assets *[]CustomerAssetSummaryResponse `json:"assets,omitempty"`

	// BusinessId Public business id that owns this customer, currently an org_... Clerk organization id.
	BusinessId *string `json:"business_id,omitempty"`

	// Country Customer country code or name, when available.
	Country *string `json:"country,omitempty"`

	// CreatedAt UTC timestamp when the customer was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Email Customer email address, when available.
	Email *string `json:"email,omitempty"`

	// FirstName Customer first name.
	FirstName *string `json:"first_name,omitempty"`

	// FullName Customer display name.
	FullName *string `json:"full_name,omitempty"`

	// Id Public customer id (`cus_...`, for example `cus_9k3mexample`).
	Id *string `json:"id,omitempty"`

	// Landline Customer landline phone number, when available.
	Landline *string `json:"landline,omitempty"`

	// LastName Customer last name.
	LastName *string `json:"last_name,omitempty"`

	// Object Resource object type. Always customer.
	Object *string `json:"object,omitempty"`

	// Phone Customer mobile phone number, when available.
	Phone *string `json:"phone,omitempty"`

	// PreferredContactMethod Customer's preferred contact method as a public string value.
	PreferredContactMethod *string `json:"preferred_contact_method,omitempty"`

	// UpdatedAt UTC timestamp when the customer was last updated, when available.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}

CustomerResponse Public representation of a customer available to authorized API clients.

type CustomersGetParams 

type CustomersGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

CustomersGetParams defines parameters for CustomersGet.

type CustomersGetResponse 

type CustomersGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomerResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseCustomersGetResponse 

func ParseCustomersGetResponse(rsp *http.Response) (*CustomersGetResponse, error)

ParseCustomersGetResponse parses an HTTP response from a CustomersGetWithResponse call

func (CustomersGetResponse) ContentType 

func (r CustomersGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CustomersGetResponse) Status 

func (r CustomersGetResponse) Status() string

Status returns HTTPResponse.Status

func (CustomersGetResponse) StatusCode 

func (r CustomersGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CustomersListParams 

type CustomersListParams struct {
	BusinessId *string `form:"business_id,omitempty" json:"business_id,omitempty"`
	Name       *string `form:"name,omitempty" json:"name,omitempty"`
	Email      *string `form:"email,omitempty" json:"email,omitempty"`
	Phone      *string `form:"phone,omitempty" json:"phone,omitempty"`

	// Sort Sort field. Allowed values: `created_at`, `name`, `email`. Default: `-created_at`. Prefix with `-` for descending order (for example `-created_at`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

CustomersListParams defines parameters for CustomersList.

type CustomersListResponse 

type CustomersListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfCustomerResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseCustomersListResponse 

func ParseCustomersListResponse(rsp *http.Response) (*CustomersListResponse, error)

ParseCustomersListResponse parses an HTTP response from a CustomersListWithResponse call

func (CustomersListResponse) ContentType 

func (r CustomersListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CustomersListResponse) Status 

func (r CustomersListResponse) Status() string

Status returns HTTPResponse.Status

func (CustomersListResponse) StatusCode 

func (r CustomersListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CustomersUpdateJSONRequestBody 

type CustomersUpdateJSONRequestBody = UpdateCustomerRequest

CustomersUpdateJSONRequestBody defines body for CustomersUpdate for application/json ContentType.

type CustomersUpdateParams 

type CustomersUpdateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

CustomersUpdateParams defines parameters for CustomersUpdate.

type CustomersUpdateResponse 

type CustomersUpdateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomerResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseCustomersUpdateResponse 

func ParseCustomersUpdateResponse(rsp *http.Response) (*CustomersUpdateResponse, error)

ParseCustomersUpdateResponse parses an HTTP response from a CustomersUpdateWithResponse call

func (CustomersUpdateResponse) ContentType 

func (r CustomersUpdateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CustomersUpdateResponse) Status 

func (r CustomersUpdateResponse) Status() string

Status returns HTTPResponse.Status

func (CustomersUpdateResponse) StatusCode 

func (r CustomersUpdateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InvoiceItemDeleteResponse 

type InvoiceItemDeleteResponse struct {
	// Deleted Whether the item was deleted.
	Deleted *bool `json:"deleted,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// Object Resource object type. Always invoice_item.
	Object *string `json:"object,omitempty"`
}

InvoiceItemDeleteResponse Response returned after deleting an invoice item.

type InvoiceItemResponse 

type InvoiceItemResponse struct {
	// AssetId Public customer asset id when the row is tied to a serviced asset, for example asset_....
	AssetId *string `json:"asset_id,omitempty"`

	// Description Optional longer description for the item.
	Description *string `json:"description,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// InvoiceId Public invoice id (`inv_...`) that this row belongs to.
	InvoiceId *string `json:"invoice_id,omitempty"`

	// LineType Stable line category: service, part, or custom.
	LineType *string `json:"line_type,omitempty"`

	// Name Display name of the billed service or part.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always invoice_item.
	Object *string `json:"object,omitempty"`

	// Order Display order of the item on the invoice.
	Order *int32 `json:"order,omitempty"`

	// Quantity Quantity billed on the item.
	Quantity *float64 `json:"quantity,omitempty"`

	// Total Row total (unit_price × quantity) in the invoice currency.
	Total *float64 `json:"total,omitempty"`

	// UnitPrice Unit price in the invoice currency.
	UnitPrice *float64 `json:"unit_price,omitempty"`
}

InvoiceItemResponse One billable item on a public invoice (internal `InvoiceItem`).

type InvoiceItemsCreateJSONRequestBody 

type InvoiceItemsCreateJSONRequestBody = CreateInvoiceItemRequest

InvoiceItemsCreateJSONRequestBody defines body for InvoiceItemsCreate for application/json ContentType.

type InvoiceItemsCreateParams 

type InvoiceItemsCreateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

InvoiceItemsCreateParams defines parameters for InvoiceItemsCreate.

type InvoiceItemsCreateResponse 

type InvoiceItemsCreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *InvoiceItemResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseInvoiceItemsCreateResponse 

func ParseInvoiceItemsCreateResponse(rsp *http.Response) (*InvoiceItemsCreateResponse, error)

ParseInvoiceItemsCreateResponse parses an HTTP response from a InvoiceItemsCreateWithResponse call

func (InvoiceItemsCreateResponse) ContentType 

func (r InvoiceItemsCreateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InvoiceItemsCreateResponse) Status 

func (r InvoiceItemsCreateResponse) Status() string

Status returns HTTPResponse.Status

func (InvoiceItemsCreateResponse) StatusCode 

func (r InvoiceItemsCreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InvoiceItemsDeleteParams 

type InvoiceItemsDeleteParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

InvoiceItemsDeleteParams defines parameters for InvoiceItemsDelete.

type InvoiceItemsDeleteResponse 

type InvoiceItemsDeleteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InvoiceItemDeleteResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseInvoiceItemsDeleteResponse 

func ParseInvoiceItemsDeleteResponse(rsp *http.Response) (*InvoiceItemsDeleteResponse, error)

ParseInvoiceItemsDeleteResponse parses an HTTP response from a InvoiceItemsDeleteWithResponse call

func (InvoiceItemsDeleteResponse) ContentType 

func (r InvoiceItemsDeleteResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InvoiceItemsDeleteResponse) Status 

func (r InvoiceItemsDeleteResponse) Status() string

Status returns HTTPResponse.Status

func (InvoiceItemsDeleteResponse) StatusCode 

func (r InvoiceItemsDeleteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InvoiceItemsGetParams 

type InvoiceItemsGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

InvoiceItemsGetParams defines parameters for InvoiceItemsGet.

type InvoiceItemsGetResponse 

type InvoiceItemsGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InvoiceItemResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseInvoiceItemsGetResponse 

func ParseInvoiceItemsGetResponse(rsp *http.Response) (*InvoiceItemsGetResponse, error)

ParseInvoiceItemsGetResponse parses an HTTP response from a InvoiceItemsGetWithResponse call

func (InvoiceItemsGetResponse) ContentType 

func (r InvoiceItemsGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InvoiceItemsGetResponse) Status 

func (r InvoiceItemsGetResponse) Status() string

Status returns HTTPResponse.Status

func (InvoiceItemsGetResponse) StatusCode 

func (r InvoiceItemsGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InvoiceItemsUpdateJSONRequestBody 

type InvoiceItemsUpdateJSONRequestBody = UpdateInvoiceItemRequest

InvoiceItemsUpdateJSONRequestBody defines body for InvoiceItemsUpdate for application/json ContentType.

type InvoiceItemsUpdateParams 

type InvoiceItemsUpdateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

InvoiceItemsUpdateParams defines parameters for InvoiceItemsUpdate.

type InvoiceItemsUpdateResponse 

type InvoiceItemsUpdateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InvoiceItemResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseInvoiceItemsUpdateResponse 

func ParseInvoiceItemsUpdateResponse(rsp *http.Response) (*InvoiceItemsUpdateResponse, error)

ParseInvoiceItemsUpdateResponse parses an HTTP response from a InvoiceItemsUpdateWithResponse call

func (InvoiceItemsUpdateResponse) ContentType 

func (r InvoiceItemsUpdateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InvoiceItemsUpdateResponse) Status 

func (r InvoiceItemsUpdateResponse) Status() string

Status returns HTTPResponse.Status

func (InvoiceItemsUpdateResponse) StatusCode 

func (r InvoiceItemsUpdateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InvoiceResponse 

type InvoiceResponse struct {
	// BusinessId Public business id that owns the invoice, currently an org_... Clerk organization id.
	BusinessId *string `json:"business_id,omitempty"`

	// CreatedAt UTC timestamp when the invoice was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Currency ISO currency code for all monetary fields, for example GBP.
	Currency *string `json:"currency,omitempty"`

	// CustomerId Public customer id for the billed party, for example cus_....
	CustomerId *string `json:"customer_id,omitempty"`

	// DiscountType Discount type when applied: percentage or fixed.
	DiscountType *string `json:"discount_type,omitempty"`

	// DiscountValue Discount value; interpretation depends on discount_type.
	DiscountValue *float64 `json:"discount_value,omitempty"`

	// DueAt UTC due date for payment, when set.
	DueAt *time.Time `json:"due_at,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// InvoiceNumber Human-readable invoice number shown in Workshop, for example INV-1234.
	InvoiceNumber *string `json:"invoice_number,omitempty"`

	// JobId Public job id when this invoice bills a job, for example job_....
	JobId *string `json:"job_id,omitempty"`

	// LastSentAt UTC timestamp when the invoice was last sent to the customer, when available.
	LastSentAt *time.Time `json:"last_sent_at,omitempty"`

	// LineItems Billable line items on the invoice (internal `InvoiceItem` rows).
	LineItems *[]InvoiceItemResponse `json:"line_items,omitempty"`

	// Object Resource object type. Always invoice.
	Object *string `json:"object,omitempty"`

	// Origin How the invoice was created: job, sale, or ad_hoc.
	Origin *string `json:"origin,omitempty"`

	// OutstandingAmount Amount still outstanding on the invoice.
	OutstandingAmount *float64 `json:"outstanding_amount,omitempty"`

	// PaidAmount Amount already paid against the invoice.
	PaidAmount *float64 `json:"paid_amount,omitempty"`

	// PaymentLink Customer payment link when configured.
	PaymentLink *string `json:"payment_link,omitempty"`

	// Status Invoice lifecycle status: draft, pending, paid, or cancelled.
	Status *string `json:"status,omitempty"`

	// Total Invoice total after discounts, in currency units.
	Total *float64 `json:"total,omitempty"`

	// UpdatedAt UTC timestamp when the invoice was last updated, when available.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}

InvoiceResponse Public invoice for a job or standalone sale (Workshop costs).

type InvoicesGetParams 

type InvoicesGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

InvoicesGetParams defines parameters for InvoicesGet.

type InvoicesGetResponse 

type InvoicesGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InvoiceResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseInvoicesGetResponse 

func ParseInvoicesGetResponse(rsp *http.Response) (*InvoicesGetResponse, error)

ParseInvoicesGetResponse parses an HTTP response from a InvoicesGetWithResponse call

func (InvoicesGetResponse) ContentType 

func (r InvoicesGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InvoicesGetResponse) Status 

func (r InvoicesGetResponse) Status() string

Status returns HTTPResponse.Status

func (InvoicesGetResponse) StatusCode 

func (r InvoicesGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InvoicesListParams 

type InvoicesListParams struct {
	BusinessId *string `form:"business_id,omitempty" json:"business_id,omitempty"`

	// JobId Optional public job id (`job_...`) to scope chat messages to one job.
	JobId         *string `form:"job_id,omitempty" json:"job_id,omitempty"`
	InvoiceNumber *string `form:"invoice_number,omitempty" json:"invoice_number,omitempty"`
	CustomerId    *string `form:"customer_id,omitempty" json:"customer_id,omitempty"`
	CustomerEmail *string `form:"customer_email,omitempty" json:"customer_email,omitempty"`

	// Sort Sort field. Allowed values: `created_at`, `invoice_number`. Default: `-created_at`. Prefix with `-` for descending order (for example `-created_at`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

InvoicesListParams defines parameters for InvoicesList.

type InvoicesListResponse 

type InvoicesListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfInvoiceResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseInvoicesListResponse 

func ParseInvoicesListResponse(rsp *http.Response) (*InvoicesListResponse, error)

ParseInvoicesListResponse parses an HTTP response from a InvoicesListWithResponse call

func (InvoicesListResponse) ContentType 

func (r InvoicesListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InvoicesListResponse) Status 

func (r InvoicesListResponse) Status() string

Status returns HTTPResponse.Status

func (InvoicesListResponse) StatusCode 

func (r InvoicesListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobAddressInput 

type JobAddressInput struct {
	// Country Country name or code supplied by the caller.
	Country *string `json:"country,omitempty"`

	// Latitude Latitude coordinate when the caller has geocoded the address.
	Latitude *float64 `json:"latitude,omitempty"`

	// Line1 First line of the postal address.
	Line1 *string `json:"line1,omitempty"`

	// Line2 Second line of the postal address.
	Line2 *string `json:"line2,omitempty"`

	// Longitude Longitude coordinate when the caller has geocoded the address.
	Longitude *float64 `json:"longitude,omitempty"`

	// Postcode Postal or ZIP code.
	Postcode *string `json:"postcode,omitempty"`

	// Region Region, county, state, or province when applicable.
	Region *string `json:"region,omitempty"`

	// Town Town or city.
	Town *string `json:"town,omitempty"`
}

JobAddressInput Public postal/geographic address input.

type JobAddressResponse 

type JobAddressResponse struct {
	// Country Country name or code.
	Country *string `json:"country,omitempty"`

	// Latitude Latitude coordinate when known.
	Latitude *float64 `json:"latitude,omitempty"`

	// Line1 First line of the postal address.
	Line1 *string `json:"line1,omitempty"`

	// Line2 Second line of the postal address.
	Line2 *string `json:"line2,omitempty"`

	// Longitude Longitude coordinate when known.
	Longitude *float64 `json:"longitude,omitempty"`

	// Postcode Postal or ZIP code.
	Postcode *string `json:"postcode,omitempty"`

	// Region Region, county, state, or province when applicable.
	Region *string `json:"region,omitempty"`

	// Town Town or city.
	Town *string `json:"town,omitempty"`
}

JobAddressResponse Public postal/geographic address on a job schedule.

type JobAssetInput 

type JobAssetInput struct {
	// ClientReference Request-local reference used by work lines when inline asset creation is supported in future. Not used while `id` is required on each asset.
	ClientReference *string `json:"client_reference,omitempty"`

	// Id Required. Existing public asset id on the customer (`asset_...` from the customer record). Example: `{ "id": "asset_4f2bexample" }`.
	Id string `json:"id"`
}

JobAssetInput One customer asset to include on the job. v1 does not create assets inline — reference an existing asset only.

type JobAssetSummaryResponse 

type JobAssetSummaryResponse struct {
	// CustomerId Public customer id that owns this asset, when known.
	CustomerId *string `json:"customer_id,omitempty"`

	// Description Human-readable asset description or formatted label.
	Description *string `json:"description,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// LastServicedDate Calendar date when the asset was last serviced, when known.
	LastServicedDate *openapi_types.Date `json:"last_serviced_date,omitempty"`

	// Make Asset make or manufacturer.
	Make *string `json:"make,omitempty"`

	// Model Asset model.
	Model *string `json:"model,omitempty"`

	// Name Asset display name.
	Name *string `json:"name,omitempty"`

	// SerialNumber Asset serial number, when known.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Type Public asset type, such as bike or another serviced asset category.
	Type *string `json:"type,omitempty"`

	// Year Asset year, when known.
	Year *int32 `json:"year,omitempty"`
}

JobAssetSummaryResponse Public customer asset summary embedded in job responses.

type JobCustomerInput 

type JobCustomerInput struct {
	// ExternalReference Optional caller-side customer reference for partner reconciliation. Not persisted in the current implementation.
	ExternalReference *string `json:"external_reference,omitempty"`

	// Id Existing customer public id (`cus_...`). Required. The customer's workshop is used for the new job.
	Id string `json:"id"`
}

JobCustomerInput Customer reference for public job creation.

type JobCustomerSchedulingOptionsInput 

type JobCustomerSchedulingOptionsInput struct {
	// AllowBookCustomerCollection Whether the customer can book their own collection appointments.
	AllowBookCustomerCollection *bool `json:"allow_book_customer_collection,omitempty"`

	// AllowBookMechanicDropOff Whether the customer can book mechanic drop-off appointments.
	AllowBookMechanicDropOff *bool `json:"allow_book_mechanic_drop_off,omitempty"`

	// AllowRescheduleCustomerDropOff Whether the customer can reschedule their own drop-off appointments.
	AllowRescheduleCustomerDropOff *bool `json:"allow_reschedule_customer_drop_off,omitempty"`

	// AllowRescheduleMechanicCollection Whether the customer can reschedule mechanic collection appointments.
	AllowRescheduleMechanicCollection *bool `json:"allow_reschedule_mechanic_collection,omitempty"`

	// AllowRescheduleOnSiteService Whether the customer can reschedule on-site service appointments.
	AllowRescheduleOnSiteService *bool `json:"allow_reschedule_on_site_service,omitempty"`
}

JobCustomerSchedulingOptionsInput Customer self-service scheduling permissions requested when creating a public job.

type JobCustomerSchedulingOptionsResponse 

type JobCustomerSchedulingOptionsResponse struct {
	AllowBookCustomerCollection       *bool `json:"allow_book_customer_collection,omitempty"`
	AllowBookMechanicDropOff          *bool `json:"allow_book_mechanic_drop_off,omitempty"`
	AllowRescheduleCustomerDropOff    *bool `json:"allow_reschedule_customer_drop_off,omitempty"`
	AllowRescheduleMechanicCollection *bool `json:"allow_reschedule_mechanic_collection,omitempty"`
	AllowRescheduleOnSiteService      *bool `json:"allow_reschedule_on_site_service,omitempty"`
}

JobCustomerSchedulingOptionsResponse defines model for JobCustomerSchedulingOptionsResponse.

type JobIntegrationOptions 

type JobIntegrationOptions struct {
	// AutoSync Whether Workshop should auto-sync the resulting job/invoice with connected systems when configured. Defaults should be applied by the endpoint implementation.
	AutoSync *bool `json:"auto_sync,omitempty"`

	// IntegrationStoreId External POS or integration store id to associate with the created job, when applicable.
	IntegrationStoreId *string `json:"integration_store_id,omitempty"`

	// IntegrationStoreName Display name for `integration_store_id`, when applicable.
	IntegrationStoreName *string `json:"integration_store_name,omitempty"`
}

JobIntegrationOptions Optional till/POS integration settings for the created job. Does not describe which items or services are on the job — use `items` and `work_lines` on the job create request for that.

type JobNotificationOptions 

type JobNotificationOptions struct {
	CustomerConfirmation *bool `json:"customer_confirmation,omitempty"`
}

JobNotificationOptions defines model for JobNotificationOptions.

type JobReportAttachmentResponse 

type JobReportAttachmentResponse struct {
	// ContentType Attachment content type, for example image/jpeg or application/pdf.
	ContentType *string `json:"content_type,omitempty"`

	// FileSizeBytes Attachment file size in bytes, when known.
	FileSizeBytes *int64 `json:"file_size_bytes,omitempty"`

	// FriendlyName Human-friendly attachment display name, when available.
	FriendlyName *string `json:"friendly_name,omitempty"`

	// Id Public attachment id for the report file.
	Id *string `json:"id,omitempty"`

	// Name Original attachment file name, when available.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always attachment.
	Object *string `json:"object,omitempty"`
}

JobReportAttachmentResponse Public attachment metadata for a job report.

type JobReportChecksResponse 

type JobReportChecksResponse struct {
	// MechanicalCheck True when a mechanical check was completed.
	MechanicalCheck *bool `json:"mechanical_check,omitempty"`

	// SignedOff True when the report or work was signed off.
	SignedOff *bool `json:"signed_off,omitempty"`

	// TestRidden True when the item was test ridden as part of the report.
	TestRidden *bool `json:"test_ridden,omitempty"`
}

JobReportChecksResponse Public quality-check summary for a job report.

type JobReportResponse 

type JobReportResponse struct {
	// AssetId Public asset id for the reported asset, for example asset_....
	AssetId *string `json:"asset_id,omitempty"`

	// Attachments Public attachment metadata for files included with the report.
	Attachments *[]JobReportAttachmentResponse `json:"attachments,omitempty"`

	// BusinessId Public business id that owns this report, currently an org_... Clerk organization id.
	BusinessId *string `json:"business_id,omitempty"`

	// Checks Public quality-check summary for a job report.
	Checks *JobReportChecksResponse `json:"checks,omitempty"`

	// Comment Public report comment or summary.
	Comment *string `json:"comment,omitempty"`

	// CreatedAt UTC timestamp when the report was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// CustomerId Public customer id for the report's customer, for example cus_....
	CustomerId *string `json:"customer_id,omitempty"`

	// Id Public job report id (`jr_...`, for example `jr_7d3eexample`).
	Id *string `json:"id,omitempty"`

	// JobId Public job id for the reported job, for example job_....
	JobId *string `json:"job_id,omitempty"`

	// Object Resource object type. Always job_report.
	Object *string `json:"object,omitempty"`

	// ServiceItems Service item or checklist results included in the report.
	ServiceItems *[]JobReportServiceItemResponse `json:"service_items,omitempty"`

	// UpdatedAt UTC timestamp when the report was last updated, when available.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}

JobReportResponse Public representation of a job report available to authorized API clients.

type JobReportServiceItemResponse 

type JobReportServiceItemResponse struct {
	// Category Public service item category, when available.
	Category *string `json:"category,omitempty"`

	// Comment Comment recorded against this service item.
	Comment *string `json:"comment,omitempty"`

	// Name Service item or checklist item name.
	Name *string `json:"name,omitempty"`

	// Order Display order of the service item in the report.
	Order *int32 `json:"order,omitempty"`

	// Status Service item result status as a stable snake_case value.
	Status *string `json:"status,omitempty"`
}

JobReportServiceItemResponse Public service item result documented in a job report.

type JobReportsGetForJobParams 

type JobReportsGetForJobParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

JobReportsGetForJobParams defines parameters for JobReportsGetForJob.

type JobReportsGetForJobResponse 

type JobReportsGetForJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *JobReportResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobReportsGetForJobResponse 

func ParseJobReportsGetForJobResponse(rsp *http.Response) (*JobReportsGetForJobResponse, error)

ParseJobReportsGetForJobResponse parses an HTTP response from a JobReportsGetForJobWithResponse call

func (JobReportsGetForJobResponse) ContentType 

func (r JobReportsGetForJobResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobReportsGetForJobResponse) Status 

func (r JobReportsGetForJobResponse) Status() string

Status returns HTTPResponse.Status

func (JobReportsGetForJobResponse) StatusCode 

func (r JobReportsGetForJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobReportsGetParams 

type JobReportsGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

JobReportsGetParams defines parameters for JobReportsGet.

type JobReportsGetResponse 

type JobReportsGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *JobReportResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobReportsGetResponse 

func ParseJobReportsGetResponse(rsp *http.Response) (*JobReportsGetResponse, error)

ParseJobReportsGetResponse parses an HTTP response from a JobReportsGetWithResponse call

func (JobReportsGetResponse) ContentType 

func (r JobReportsGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobReportsGetResponse) Status 

func (r JobReportsGetResponse) Status() string

Status returns HTTPResponse.Status

func (JobReportsGetResponse) StatusCode 

func (r JobReportsGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobReportsListForJobParams 

type JobReportsListForJobParams struct {
	BusinessId *string `form:"business_id,omitempty" json:"business_id,omitempty"`

	// JobId Optional public job id (`job_...`) to scope chat messages to one job.
	JobId *string `form:"job_id,omitempty" json:"job_id,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

JobReportsListForJobParams defines parameters for JobReportsListForJob.

type JobReportsListForJobResponse 

type JobReportsListForJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfJobReportResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobReportsListForJobResponse 

func ParseJobReportsListForJobResponse(rsp *http.Response) (*JobReportsListForJobResponse, error)

ParseJobReportsListForJobResponse parses an HTTP response from a JobReportsListForJobWithResponse call

func (JobReportsListForJobResponse) ContentType 

func (r JobReportsListForJobResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobReportsListForJobResponse) Status 

func (r JobReportsListForJobResponse) Status() string

Status returns HTTPResponse.Status

func (JobReportsListForJobResponse) StatusCode 

func (r JobReportsListForJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobReportsListParams 

type JobReportsListParams struct {
	BusinessId *string `form:"business_id,omitempty" json:"business_id,omitempty"`

	// JobId Optional public job id (`job_...`) to scope chat messages to one job.
	JobId *string `form:"job_id,omitempty" json:"job_id,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

JobReportsListParams defines parameters for JobReportsList.

type JobReportsListResponse 

type JobReportsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfJobReportResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobReportsListResponse 

func ParseJobReportsListResponse(rsp *http.Response) (*JobReportsListResponse, error)

ParseJobReportsListResponse parses an HTTP response from a JobReportsListWithResponse call

func (JobReportsListResponse) ContentType 

func (r JobReportsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobReportsListResponse) Status 

func (r JobReportsListResponse) Status() string

Status returns HTTPResponse.Status

func (JobReportsListResponse) StatusCode 

func (r JobReportsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobResponse 

type JobResponse struct {
	// AcceptedStatus Job acceptance status: pending, accepted, rejected, or cancelled.
	AcceptedStatus *string `json:"accepted_status,omitempty"`

	// AllDay Whether the job is treated as an all-day booking in scheduling views.
	AllDay *bool `json:"all_day,omitempty"`

	// Assets Assets being serviced on this job.
	Assets *[]JobAssetSummaryResponse `json:"assets,omitempty"`

	// AssignedTeamMemberId Public team member id assigned at job level, when assignment is exposed publicly.
	AssignedTeamMemberId *string `json:"assigned_team_member_id,omitempty"`

	// AuthorisationStatus Customer authorisation status for additional work or charges.
	AuthorisationStatus *string `json:"authorisation_status,omitempty"`

	// BillingType Billing/charge source for the job, such as customer, business, insurance, or motability.
	BillingType *string `json:"billing_type,omitempty"`

	// BusinessId Public business id that owns this job, currently an org_... Clerk organization id.
	BusinessId *string `json:"business_id,omitempty"`

	// CheckInNotes Check-in notes captured when the item is received for service.
	CheckInNotes *string `json:"check_in_notes,omitempty"`

	// CreatedAt UTC timestamp when the job was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// CreationSource How the job entered Workshop: manual, online_booking, or widget_booking.
	CreationSource *string `json:"creation_source,omitempty"`

	// CustomerId Public customer id for the job, for example cus_....
	CustomerId *string `json:"customer_id,omitempty"`

	// CustomerPreferredContactMethod Customer preferred contact method on the job, such as email, phone, or sms.
	CustomerPreferredContactMethod *string `json:"customer_preferred_contact_method,omitempty"`

	// DiscountType Discount type applied to the job, such as percentage or fixed_amount.
	DiscountType *string `json:"discount_type,omitempty"`

	// DiscountValue Discount value for the job, interpreted according to `discount_type`.
	DiscountValue *float64 `json:"discount_value,omitempty"`

	// ExternalJobId Partner or integration ticket/reference id supplied by the caller or upstream system.
	ExternalJobId *string `json:"external_job_id,omitempty"`

	// Id Public job id (`job_...`, for example `job_01h2example`).
	Id *string `json:"id,omitempty"`

	// IntegrationStoreId External POS or integration store id selected for this job, when applicable.
	IntegrationStoreId *string `json:"integration_store_id,omitempty"`

	// IntegrationStoreName Display name for `integration_store_id`, when applicable.
	IntegrationStoreName *string `json:"integration_store_name,omitempty"`

	// InvoiceLastSentAt UTC timestamp when the job invoice was last sent to the customer.
	InvoiceLastSentAt *time.Time `json:"invoice_last_sent_at,omitempty"`

	// IsLeasingJob Whether this job is leasing-related work.
	IsLeasingJob *bool `json:"is_leasing_job,omitempty"`

	// IsMotabilityJob Whether this job is motability-related work.
	IsMotabilityJob *bool `json:"is_motability_job,omitempty"`

	// IsWarrantyJob Whether this job is warranty-related work.
	IsWarrantyJob *bool `json:"is_warranty_job,omitempty"`

	// JobNumber Human-readable job number shown in workshop and customer communications.
	JobNumber *int64 `json:"job_number,omitempty"`

	// Object Resource object type. Always job.
	Object *string `json:"object,omitempty"`

	// Paid Whether the job has been fully paid.
	Paid *bool `json:"paid,omitempty"`

	// PartnerEmbedType Partner embed type that originated this job, when applicable.
	PartnerEmbedType *string `json:"partner_embed_type,omitempty"`

	// PaymentLink Customer payment link for outstanding job invoices, when generated.
	PaymentLink *string `json:"payment_link,omitempty"`

	// PrePaymentRequired Whether pre-payment is required before work begins.
	PrePaymentRequired *bool `json:"pre_payment_required,omitempty"`

	// RejectionReason Reason the job was rejected, when `accepted_status` is `rejected`.
	RejectionReason *string `json:"rejection_reason,omitempty"`

	// RequiredByDate Calendar date when the job must be completed by, when set.
	RequiredByDate *openapi_types.Date `json:"required_by_date,omitempty"`

	// Schedule Scheduling and logistics on a public job response.
	Schedule *JobScheduleResponse `json:"schedule,omitempty"`

	// TrackingId Legacy tracking reference generated when the job was created.
	TrackingId *string `json:"tracking_id,omitempty"`

	// UpdatedAt UTC timestamp when the job was last updated, when available.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// WorkLines Work lines on this job, mapped from service bookings.
	WorkLines *[]JobWorkLineResponse `json:"work_lines,omitempty"`
}

JobResponse Public representation of a created or retrieved job.

type JobScheduleInput 

type JobScheduleInput struct {
	// Address Public postal/geographic address input.
	Address *JobAddressInput `json:"address,omitempty"`

	// CollectionBringInDate Calendar date when the item was or will be brought in for collection services.
	CollectionBringInDate *openapi_types.Date `json:"collection_bring_in_date,omitempty"`

	// CustomerCollectionDate Calendar date when the customer plans to collect the item from the business.
	CustomerCollectionDate *openapi_types.Date `json:"customer_collection_date,omitempty"`

	// CustomerCollectionWindow Public time window selected by the caller.
	CustomerCollectionWindow *JobTimeWindowInput `json:"customer_collection_window,omitempty"`

	// CustomerDropOffDate Calendar date when the customer plans to drop the item off at the business.
	CustomerDropOffDate *openapi_types.Date `json:"customer_drop_off_date,omitempty"`

	// CustomerDropOffWindow Public time window selected by the caller.
	CustomerDropOffWindow *JobTimeWindowInput `json:"customer_drop_off_window,omitempty"`

	// CustomerScheduling Customer self-service scheduling permissions requested when creating a public job.
	CustomerScheduling *JobCustomerSchedulingOptionsInput `json:"customer_scheduling,omitempty"`

	// DropOffAddress Public postal/geographic address input.
	DropOffAddress *JobAddressInput `json:"drop_off_address,omitempty"`

	// EstimatedTravelMinutes Estimated travel time in minutes for mobile or on-site work when known.
	EstimatedTravelMinutes *float64 `json:"estimated_travel_minutes,omitempty"`

	// FulfilmentType Public workflow type: `drop_off` (customer drops off at the workshop), `collection` (workshop collects and returns), or `on_site_service` (service at customer location).
	FulfilmentType *string `json:"fulfilment_type,omitempty"`

	// MechanicCollectionDate Calendar date when the mechanic or business plans to collect the item from the customer.
	MechanicCollectionDate *openapi_types.Date `json:"mechanic_collection_date,omitempty"`

	// MechanicCollectionWindow Public time window selected by the caller.
	MechanicCollectionWindow *JobTimeWindowInput `json:"mechanic_collection_window,omitempty"`

	// MechanicDropOffDate Calendar date when the mechanic or business plans to return the item to the customer.
	MechanicDropOffDate *openapi_types.Date `json:"mechanic_drop_off_date,omitempty"`

	// MechanicDropOffWindow Public time window selected by the caller.
	MechanicDropOffWindow *JobTimeWindowInput `json:"mechanic_drop_off_window,omitempty"`

	// PreferredDate Preferred overall job date when the caller does not need per-service scheduling.
	PreferredDate *openapi_types.Date `json:"preferred_date,omitempty"`

	// PreferredWindow Public time window selected by the caller.
	PreferredWindow *JobTimeWindowInput `json:"preferred_window,omitempty"`

	// ShowCollectionInCalendar Whether collection and drop-off events should appear on workshop calendars.
	ShowCollectionInCalendar *bool `json:"show_collection_in_calendar,omitempty"`
}

JobScheduleInput Scheduling and logistics requested for a public job.

type JobScheduleResponse 

type JobScheduleResponse struct {
	// Address Public postal/geographic address on a job schedule.
	Address *JobAddressResponse `json:"address,omitempty"`

	// CollectionBringInDate Calendar date when the item was brought in for collection services.
	CollectionBringInDate *openapi_types.Date `json:"collection_bring_in_date,omitempty"`

	// CustomerCollectionDate Calendar date when the customer plans to collect the item from the business.
	CustomerCollectionDate *openapi_types.Date `json:"customer_collection_date,omitempty"`

	// CustomerCollectionWindow Public time window on a job schedule.
	CustomerCollectionWindow *JobTimeWindowResponse `json:"customer_collection_window,omitempty"`

	// CustomerDropOffDate Calendar date when the customer plans to drop the item off at the business.
	CustomerDropOffDate *openapi_types.Date `json:"customer_drop_off_date,omitempty"`

	// CustomerDropOffWindow Public time window on a job schedule.
	CustomerDropOffWindow *JobTimeWindowResponse                `json:"customer_drop_off_window,omitempty"`
	CustomerScheduling    *JobCustomerSchedulingOptionsResponse `json:"customer_scheduling,omitempty"`

	// DropOffAddress Public postal/geographic address on a job schedule.
	DropOffAddress *JobAddressResponse `json:"drop_off_address,omitempty"`

	// EstimatedTravelMinutes Estimated travel time in minutes for mobile/on-site work when calculated.
	EstimatedTravelMinutes *float64 `json:"estimated_travel_minutes,omitempty"`

	// FulfilmentType Public workflow type: `drop_off` (customer drops off at the workshop), `collection` (workshop collects and returns), or `on_site_service` (service at customer location).
	FulfilmentType *string `json:"fulfilment_type,omitempty"`

	// MechanicCollectionDate Calendar date when the mechanic or business plans to collect the item from the customer.
	MechanicCollectionDate *openapi_types.Date `json:"mechanic_collection_date,omitempty"`

	// MechanicCollectionWindow Public time window on a job schedule.
	MechanicCollectionWindow *JobTimeWindowResponse `json:"mechanic_collection_window,omitempty"`

	// MechanicDropOffDate Calendar date when the mechanic or business plans to return the item to the customer.
	MechanicDropOffDate *openapi_types.Date `json:"mechanic_drop_off_date,omitempty"`

	// MechanicDropOffWindow Public time window on a job schedule.
	MechanicDropOffWindow *JobTimeWindowResponse `json:"mechanic_drop_off_window,omitempty"`

	// ShowCollectionInCalendar Whether collection and drop-off events should appear on workshop calendars.
	ShowCollectionInCalendar *bool `json:"show_collection_in_calendar,omitempty"`
}

JobScheduleResponse Scheduling and logistics on a public job response.

type JobStatusResponse 

type JobStatusResponse struct {
	// Colour Primary calendar/UI colour for this status.
	Colour *string `json:"colour,omitempty"`

	// Enabled Whether this status is currently enabled for selection.
	Enabled *bool `json:"enabled,omitempty"`

	// Id Opaque public status id (`jst_...`).
	Id *string `json:"id,omitempty"`

	// IsDefault Whether this is the workshop default status for new work.
	IsDefault *bool `json:"is_default,omitempty"`

	// Name Display name shown in Workshop (may be renamed by the workshop).
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always `job_status`.
	Object *string `json:"object,omitempty"`

	// Order Sort order configured for this status in the workshop workflow.
	Order *int32 `json:"order,omitempty"`

	// Required Whether this status is marked as required in the workshop workflow.
	Required *bool `json:"required,omitempty"`

	// SecondaryColour Secondary accent colour for this status.
	SecondaryColour *string `json:"secondary_colour,omitempty"`

	// Type System status category in snake_case (for example `working_on`, `custom`).
	Type *string `json:"type,omitempty"`

	// TypeKey Stable status key within the workshop: custom `TypeAsString` when type is `custom`, otherwise the system type key.
	TypeKey *string `json:"type_key,omitempty"`
}

JobStatusResponse Workshop job status assigned to a work line's service booking. Integrators should key off id; name is display-only and may change.

type JobTimeWindowInput 

type JobTimeWindowInput struct {
	// EndTime End time of the requested window in the workshop-local schedule.
	EndTime *string `json:"end_time,omitempty"`

	// StartTime Start time of the requested window in the workshop-local schedule.
	StartTime *string `json:"start_time,omitempty"`
}

JobTimeWindowInput Public time window selected by the caller.

type JobTimeWindowResponse 

type JobTimeWindowResponse struct {
	// EndTime End time of the window in the workshop-local schedule.
	EndTime *string `json:"end_time,omitempty"`

	// StartTime Start time of the window in the workshop-local schedule.
	StartTime *string `json:"start_time,omitempty"`
}

JobTimeWindowResponse Public time window on a job schedule.

type JobWorkLineInput 

type JobWorkLineInput struct {
	// AssetClientReference Request-local asset reference when the work line applies to an asset created in this same request.
	AssetClientReference *string `json:"asset_client_reference,omitempty"`

	// AssetId Required in v1. Must match an `id` from the parent request's `assets` array.
	AssetId string `json:"asset_id"`

	// AssignedTeamMemberId Optional public staff/member id for assigning this work line.
	AssignedTeamMemberId *string `json:"assigned_team_member_id,omitempty"`

	// Notes Customer-visible notes for this work line.
	Notes *string `json:"notes,omitempty"`

	// ScheduledDate Requested scheduled calendar date for this work line, when known.
	ScheduledDate *openapi_types.Date `json:"scheduled_date,omitempty"`

	// ScheduledWindow Public time window selected by the caller.
	ScheduledWindow *JobTimeWindowInput `json:"scheduled_window,omitempty"`

	// Services Catalogue services to perform on this asset. Required: at least one entry.
	Services []JobWorkLineServiceInput `json:"services"`
}

JobWorkLineInput One asset's work on a job: an asset plus one or more catalogue services to perform on it. Maps to a single `ServiceBooking` with multiple `ServiceInstance` rows.

type JobWorkLineResponse 

type JobWorkLineResponse struct {
	// AssetId Public asset id this work line applies to (`asset_...`).
	AssetId *string `json:"asset_id,omitempty"`

	// AssignedTeamMemberId Public team member id assigned to this work line, when assignment is exposed publicly.
	AssignedTeamMemberId *string `json:"assigned_team_member_id,omitempty"`

	// CustomerNotes Customer-provided notes for this work line.
	CustomerNotes *string `json:"customer_notes,omitempty"`

	// Id Public work line id (`wl_...`). Identifies the service booking for one item on the job — not a catalogue `svc_...` id.
	Id *string `json:"id,omitempty"`

	// JobReportId Public job report id for this work line, when a report exists.
	JobReportId *string `json:"job_report_id,omitempty"`

	// Object Resource object type. Always `work_line`.
	Object *string `json:"object,omitempty"`

	// ScheduledDate Scheduled calendar date for this work line when set on the underlying service booking.
	ScheduledDate *openapi_types.Date `json:"scheduled_date,omitempty"`

	// ScheduledWindow Public time window on a job schedule.
	ScheduledWindow *JobTimeWindowResponse `json:"scheduled_window,omitempty"`

	// Services Catalogue services performed on this work line.
	Services *[]JobWorkLineServiceResponse `json:"services,omitempty"`

	// Status Workshop job status for this work line. Use `status.id` (`jst_...`) as the stable reference; `name` is display-only.
	Status *JobStatusResponse `json:"status,omitempty"`

	// TotalCost Total cost for this work line, when pricing is exposed publicly.
	TotalCost *float64 `json:"total_cost,omitempty"`
}

JobWorkLineResponse One asset's booked work on a job: a service booking with one or more catalogue services. Maps from `ServiceBooking` + its `ServiceInstance` rows.

type JobWorkLineServiceInput 

type JobWorkLineServiceInput struct {
	// Quantity Quantity of this service on the work line. Defaults to `1` when omitted.
	Quantity *float64 `json:"quantity,omitempty"`

	// ServiceId Required. Public catalogue service id (`svc_...` from `GET .../services`).
	ServiceId string `json:"service_id"`
}

JobWorkLineServiceInput One catalogue service to book on a work line.

type JobWorkLineServiceResponse 

type JobWorkLineServiceResponse struct {
	// Name Catalogue service name at the time the job is returned.
	Name *string `json:"name,omitempty"`

	// Quantity Quantity of this catalogue service on the work line.
	Quantity *float64 `json:"quantity,omitempty"`

	// ServiceId Public catalogue service id (`svc_...`).
	ServiceId *string `json:"service_id,omitempty"`

	// UnitPrice Unit price for this service, when pricing is exposed publicly.
	UnitPrice *float64 `json:"unit_price,omitempty"`
}

JobWorkLineServiceResponse One catalogue service booked on a work line (service instance on the underlying service booking).

type JobsCreateJSONRequestBody 

type JobsCreateJSONRequestBody = CreateJobRequest

JobsCreateJSONRequestBody defines body for JobsCreate for application/json ContentType.

type JobsCreateParams 

type JobsCreateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

JobsCreateParams defines parameters for JobsCreate.

type JobsCreateResponse 

type JobsCreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *JobResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobsCreateResponse 

func ParseJobsCreateResponse(rsp *http.Response) (*JobsCreateResponse, error)

ParseJobsCreateResponse parses an HTTP response from a JobsCreateWithResponse call

func (JobsCreateResponse) ContentType 

func (r JobsCreateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobsCreateResponse) Status 

func (r JobsCreateResponse) Status() string

Status returns HTTPResponse.Status

func (JobsCreateResponse) StatusCode 

func (r JobsCreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobsGetParams 

type JobsGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

JobsGetParams defines parameters for JobsGet.

type JobsGetResponse 

type JobsGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *JobResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobsGetResponse 

func ParseJobsGetResponse(rsp *http.Response) (*JobsGetResponse, error)

ParseJobsGetResponse parses an HTTP response from a JobsGetWithResponse call

func (JobsGetResponse) ContentType 

func (r JobsGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobsGetResponse) Status 

func (r JobsGetResponse) Status() string

Status returns HTTPResponse.Status

func (JobsGetResponse) StatusCode 

func (r JobsGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobsListParams 

type JobsListParams struct {
	BusinessId    *string `form:"business_id,omitempty" json:"business_id,omitempty"`
	JobNumber     *string `form:"job_number,omitempty" json:"job_number,omitempty"`
	CustomerId    *string `form:"customer_id,omitempty" json:"customer_id,omitempty"`
	CustomerEmail *string `form:"customer_email,omitempty" json:"customer_email,omitempty"`

	// Sort Sort field. Allowed values: `created_at`, `job_number`. Default: `-created_at`. Prefix with `-` for descending order (for example `-created_at`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

JobsListParams defines parameters for JobsList.

type JobsListResponse 

type JobsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfJobResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobsListResponse 

func ParseJobsListResponse(rsp *http.Response) (*JobsListResponse, error)

ParseJobsListResponse parses an HTTP response from a JobsListWithResponse call

func (JobsListResponse) ContentType 

func (r JobsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobsListResponse) Status 

func (r JobsListResponse) Status() string

Status returns HTTPResponse.Status

func (JobsListResponse) StatusCode 

func (r JobsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobsPartAuthorisationsParams 

type JobsPartAuthorisationsParams struct {
	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

JobsPartAuthorisationsParams defines parameters for JobsPartAuthorisations.

type JobsPartAuthorisationsResponse 

type JobsPartAuthorisationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfPartAuthorisationResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobsPartAuthorisationsResponse 

func ParseJobsPartAuthorisationsResponse(rsp *http.Response) (*JobsPartAuthorisationsResponse, error)

ParseJobsPartAuthorisationsResponse parses an HTTP response from a JobsPartAuthorisationsWithResponse call

func (JobsPartAuthorisationsResponse) ContentType 

func (r JobsPartAuthorisationsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobsPartAuthorisationsResponse) Status 

func (r JobsPartAuthorisationsResponse) Status() string

Status returns HTTPResponse.Status

func (JobsPartAuthorisationsResponse) StatusCode 

func (r JobsPartAuthorisationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobsSubmitPartAuthorisationDecisionsJSONRequestBody 

type JobsSubmitPartAuthorisationDecisionsJSONRequestBody = SubmitPartAuthorisationDecisionsRequest

JobsSubmitPartAuthorisationDecisionsJSONRequestBody defines body for JobsSubmitPartAuthorisationDecisions for application/json ContentType.

type JobsSubmitPartAuthorisationDecisionsParams 

type JobsSubmitPartAuthorisationDecisionsParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

JobsSubmitPartAuthorisationDecisionsParams defines parameters for JobsSubmitPartAuthorisationDecisions.

type JobsSubmitPartAuthorisationDecisionsResponse 

type JobsSubmitPartAuthorisationDecisionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfPartAuthorisationResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseJobsSubmitPartAuthorisationDecisionsResponse 

func ParseJobsSubmitPartAuthorisationDecisionsResponse(rsp *http.Response) (*JobsSubmitPartAuthorisationDecisionsResponse, error)

ParseJobsSubmitPartAuthorisationDecisionsResponse parses an HTTP response from a JobsSubmitPartAuthorisationDecisionsWithResponse call

func (JobsSubmitPartAuthorisationDecisionsResponse) ContentType 

func (r JobsSubmitPartAuthorisationDecisionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (JobsSubmitPartAuthorisationDecisionsResponse) Status 

func (r JobsSubmitPartAuthorisationDecisionsResponse) Status() string

Status returns HTTPResponse.Status

func (JobsSubmitPartAuthorisationDecisionsResponse) StatusCode 

func (r JobsSubmitPartAuthorisationDecisionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NextAvailableSlotResponse 

type NextAvailableSlotResponse struct {
	// BusinessId Public business id for this availability result.
	BusinessId *string `json:"business_id,omitempty"`

	// Date Calendar date (`YYYY-MM-DD`). No time or timezone offset — use the date part only. Null when no bookable day is found.
	Date *openapi_types.Date `json:"date,omitempty"`

	// FulfilmentType How the customer fulfils the booking on date: `collection` or `customer_drop_off`.
	FulfilmentType *string `json:"fulfilment_type,omitempty"`

	// Object Resource object type. Always next_available_slot.
	Object *string `json:"object,omitempty"`

	// Slots Time windows for the returned date. Each slot includes `is_available` for capacity.
	Slots *[]AvailabilitySlotResponse `json:"slots,omitempty"`
}

NextAvailableSlotResponse Public response containing the next available booking date and any known time slots.

type PartAuthorisationDecisionRequest 

type PartAuthorisationDecisionRequest struct {
	// Decision `approved` or `declined` (snake_case). You cannot set `pending` via the API.
	Decision string `json:"decision"`

	// Id Public part authorisation id (`pauth_...`). Must match `PartAuthorisationResponse.id` from `GET .../part_authorisations` or `data.id` on a `part_authorisation.*` webhook.
	Id string `json:"id"`
}

PartAuthorisationDecisionRequest A single approve or decline decision for one part line on the job.

type PartAuthorisationResponse 

type PartAuthorisationResponse struct {
	// Id Public part authorisation id (`pauth_...`, for example `pauth_01h2xexample`). Copy into `decisions[].id` when submitting decisions.
	Id *string `json:"id,omitempty"`

	// JobId Public job id that owns the part authorisation.
	JobId *string `json:"job_id,omitempty"`

	// JobReportId Public job report id associated with the part, when available.
	JobReportId *string `json:"job_report_id,omitempty"`

	// Name Part or stock item display name.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always part_authorisation.
	Object *string `json:"object,omitempty"`

	// Quantity Quantity requested or used.
	Quantity *float64 `json:"quantity,omitempty"`

	// ServiceItemName Public service item or checklist name associated with the part, when available.
	ServiceItemName *string `json:"service_item_name,omitempty"`

	// Status Current status: `not_sent`, `pending`, `approved`, or `declined` (snake_case).
	Status *string `json:"status,omitempty"`
}

PartAuthorisationResponse A single part line on a job report that the customer or integration can approve or decline.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RotateWebhookEndpointSecretResponse 

type RotateWebhookEndpointSecretResponse struct {
	// BusinessIds Public business ids this endpoint is subscribed to.
	BusinessIds *[]string `json:"business_ids,omitempty"`

	// CreatedAt UTC timestamp when this endpoint was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Description Human-readable description for this endpoint.
	Description *string `json:"description,omitempty"`

	// Enabled Whether delivery to this endpoint is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// EventTypes Event type filters. A single * means all supported events.
	EventTypes *[]string `json:"event_types,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// Object Resource object type. Always webhook_endpoint.
	Object *string `json:"object,omitempty"`

	// PreviousSigningSecretExpiresAt UTC timestamp when the previous signing secret stops being included in signatures.
	PreviousSigningSecretExpiresAt *time.Time `json:"previous_signing_secret_expires_at,omitempty"`

	// PreviousSigningSecretPrefix Display-only prefix for the previous signing secret during rotation, when active.
	PreviousSigningSecretPrefix *string `json:"previous_signing_secret_prefix,omitempty"`

	// SigningSecret One-time new signing secret used to verify Workshop webhook signatures. Store it securely.
	SigningSecret *string `json:"signing_secret,omitempty"`

	// SigningSecretPrefix Display-only prefix for identifying the active signing secret.
	SigningSecretPrefix *string `json:"signing_secret_prefix,omitempty"`

	// UpdatedAt UTC timestamp when this endpoint was last updated.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// Url HTTPS URL that Workshop posts webhook events to.
	Url *string `json:"url,omitempty"`
}

RotateWebhookEndpointSecretResponse Response returned when a webhook endpoint signing secret is rotated. The new secret is only returned once.

type ServiceResponse 

type ServiceResponse struct {
	// BusinessId Public business id that owns this service, currently an org_... Clerk organization id.
	BusinessId *string `json:"business_id,omitempty"`

	// Category Public category name for grouping services in the catalogue.
	Category *string `json:"category,omitempty"`

	// Currency Currency code for the service price, for example GBP.
	Currency *string `json:"currency,omitempty"`

	// Description Public description of what the service includes.
	Description *string `json:"description,omitempty"`

	// DurationMinutes Estimated service duration in minutes, when configured.
	DurationMinutes *int32 `json:"duration_minutes,omitempty"`

	// Id Public catalogue service id (`svc_...`, for example `svc_8n1cexample`).
	Id *string `json:"id,omitempty"`

	// ImageUrl Public image URL for the service, when configured.
	ImageUrl *string `json:"image_url,omitempty"`

	// Name Public service name shown to customers and API users.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always service.
	Object *string `json:"object,omitempty"`

	// Order Display order within the service category.
	Order *int32 `json:"order,omitempty"`

	// Price Effective public price for set_price services. Non-fixed pricing models return 0.
	Price *float64 `json:"price,omitempty"`

	// PricingType Pricing model as a snake_case value: set_price, price_on_assessment, or price_on_request.
	PricingType *string `json:"pricing_type,omitempty"`

	// UpdatedAt UTC timestamp when the service was last updated, when available.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}

ServiceResponse Public service catalogue entry.

type ServicesCreateJSONRequestBody 

type ServicesCreateJSONRequestBody = CreateServiceRequest

ServicesCreateJSONRequestBody defines body for ServicesCreate for application/json ContentType.

type ServicesCreateParams 

type ServicesCreateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

ServicesCreateParams defines parameters for ServicesCreate.

type ServicesCreateResponse 

type ServicesCreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *ServiceResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseServicesCreateResponse 

func ParseServicesCreateResponse(rsp *http.Response) (*ServicesCreateResponse, error)

ParseServicesCreateResponse parses an HTTP response from a ServicesCreateWithResponse call

func (ServicesCreateResponse) ContentType 

func (r ServicesCreateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ServicesCreateResponse) Status 

func (r ServicesCreateResponse) Status() string

Status returns HTTPResponse.Status

func (ServicesCreateResponse) StatusCode 

func (r ServicesCreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ServicesGetParams 

type ServicesGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

ServicesGetParams defines parameters for ServicesGet.

type ServicesGetResponse 

type ServicesGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ServiceResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseServicesGetResponse 

func ParseServicesGetResponse(rsp *http.Response) (*ServicesGetResponse, error)

ParseServicesGetResponse parses an HTTP response from a ServicesGetWithResponse call

func (ServicesGetResponse) ContentType 

func (r ServicesGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ServicesGetResponse) Status 

func (r ServicesGetResponse) Status() string

Status returns HTTPResponse.Status

func (ServicesGetResponse) StatusCode 

func (r ServicesGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ServicesListParams 

type ServicesListParams struct {
	BusinessId *string `form:"business_id,omitempty" json:"business_id,omitempty"`
	Name       *string `form:"name,omitempty" json:"name,omitempty"`

	// Sort Sort field. Allowed values: `order`, `name`, `price`, `category`. Default: `order`. Prefix with `-` for descending order (for example `-order`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

ServicesListParams defines parameters for ServicesList.

type ServicesListResponse 

type ServicesListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfServiceResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseServicesListResponse 

func ParseServicesListResponse(rsp *http.Response) (*ServicesListResponse, error)

ParseServicesListResponse parses an HTTP response from a ServicesListWithResponse call

func (ServicesListResponse) ContentType 

func (r ServicesListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ServicesListResponse) Status 

func (r ServicesListResponse) Status() string

Status returns HTTPResponse.Status

func (ServicesListResponse) StatusCode 

func (r ServicesListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ServicesUpdateJSONRequestBody 

type ServicesUpdateJSONRequestBody = UpdateServiceRequest

ServicesUpdateJSONRequestBody defines body for ServicesUpdate for application/json ContentType.

type ServicesUpdateParams 

type ServicesUpdateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

ServicesUpdateParams defines parameters for ServicesUpdate.

type ServicesUpdateResponse 

type ServicesUpdateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ServiceResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseServicesUpdateResponse 

func ParseServicesUpdateResponse(rsp *http.Response) (*ServicesUpdateResponse, error)

ParseServicesUpdateResponse parses an HTTP response from a ServicesUpdateWithResponse call

func (ServicesUpdateResponse) ContentType 

func (r ServicesUpdateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ServicesUpdateResponse) Status 

func (r ServicesUpdateResponse) Status() string

Status returns HTTPResponse.Status

func (ServicesUpdateResponse) StatusCode 

func (r ServicesUpdateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StockGetParams 

type StockGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

StockGetParams defines parameters for StockGet.

type StockGetResponse 

type StockGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *StockVariationResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseStockGetResponse 

func ParseStockGetResponse(rsp *http.Response) (*StockGetResponse, error)

ParseStockGetResponse parses an HTTP response from a StockGetWithResponse call

func (StockGetResponse) ContentType 

func (r StockGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StockGetResponse) Status 

func (r StockGetResponse) Status() string

Status returns HTTPResponse.Status

func (StockGetResponse) StatusCode 

func (r StockGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StockItemSummaryResponse 

type StockItemSummaryResponse struct {
	// Brand Brand or manufacturer, when configured.
	Brand *string `json:"brand,omitempty"`

	// Category Stock category name, when configured.
	Category *string `json:"category,omitempty"`

	// CategoryId Stock category public id (`stkcat_...`), when configured.
	CategoryId *string `json:"category_id,omitempty"`

	// Description Stock item description, when configured.
	Description *string `json:"description,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// ImageUrl Public image URL for the stock item, when configured.
	ImageUrl *string `json:"image_url,omitempty"`

	// Location Storage location within the workshop, when configured.
	Location *string `json:"location,omitempty"`

	// Name Stock item display name.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always `stock_item`.
	Object *string `json:"object,omitempty"`

	// Vendor Supplier or vendor name, when configured.
	Vendor *string `json:"vendor,omitempty"`
}

StockItemSummaryResponse Parent stock item details embedded on stock variation responses.

type StockListParams 

type StockListParams struct {
	BusinessId *string `form:"business_id,omitempty" json:"business_id,omitempty"`

	// Query Case-insensitive search across common name, email, phone, or public id fields.
	Query   *string `form:"query,omitempty" json:"query,omitempty"`
	Sku     *string `form:"sku,omitempty" json:"sku,omitempty"`
	Ean     *string `form:"ean,omitempty" json:"ean,omitempty"`
	Barcode *string `form:"barcode,omitempty" json:"barcode,omitempty"`

	// Sort Sort field. Allowed values: `name`, `sku`, `price`, `remaining_stock`. Default: `name`. Prefix with `-` for descending order (for example `-name`).
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

StockListParams defines parameters for StockList.

type StockListResponse 

type StockListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfStockVariationResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseStockListResponse 

func ParseStockListResponse(rsp *http.Response) (*StockListResponse, error)

ParseStockListResponse parses an HTTP response from a StockListWithResponse call

func (StockListResponse) ContentType 

func (r StockListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StockListResponse) Status 

func (r StockListResponse) Status() string

Status returns HTTPResponse.Status

func (StockListResponse) StatusCode 

func (r StockListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StockVariationResponse 

type StockVariationResponse struct {
	// Barcode Barcode value, when configured.
	Barcode *string `json:"barcode,omitempty"`

	// BusinessId Workshop that owns this stock variation.
	BusinessId *string `json:"business_id,omitempty"`

	// Currency Currency code for the price, for example GBP.
	Currency *string `json:"currency,omitempty"`

	// Ean European Article Number, when configured.
	Ean *string `json:"ean,omitempty"`

	// Id Opaque resource-prefixed public identifier, such as job_... or cus_.... Internal database ids must never be assigned here.
	Id *string `json:"id,omitempty"`

	// ManufacturerSku Manufacturer SKU, when configured.
	ManufacturerSku *string `json:"manufacturer_sku,omitempty"`

	// Name Variation display name.
	Name *string `json:"name,omitempty"`

	// Object Resource object type. Always `stock_variation`.
	Object *string `json:"object,omitempty"`

	// Price Selling price, when configured.
	Price *float64 `json:"price,omitempty"`

	// RemainingStock Remaining quantity when inventory tracking is enabled.
	RemainingStock *float64 `json:"remaining_stock,omitempty"`

	// Sku Workshop SKU, when configured.
	Sku *string `json:"sku,omitempty"`

	// StockItem Parent stock item details embedded on stock variation responses.
	StockItem *StockItemSummaryResponse `json:"stock_item,omitempty"`

	// StockItemId Parent stock item public id (`stki_...`).
	StockItemId *string `json:"stock_item_id,omitempty"`

	// TrackingEnabled Whether inventory tracking is enabled for this variation.
	TrackingEnabled *bool `json:"tracking_enabled,omitempty"`
}

StockVariationResponse Public stock variation (SKU) read model for catalogue and inventory lookup.

type SubmitPartAuthorisationDecisionsRequest 

type SubmitPartAuthorisationDecisionsRequest struct {
	// Decisions One or more decisions. Use the `id` from each list item (for example `pauth_01h2xexample`).
	Decisions []PartAuthorisationDecisionRequest `json:"decisions"`
}

SubmitPartAuthorisationDecisionsRequest Batch of approve/decline decisions for parts that already exist on a job report.

type UpdateAssetRequest 

type UpdateAssetRequest struct {
	// Make Asset make or manufacturer. Omit to leave unchanged.
	Make *string `json:"make,omitempty"`

	// Model Asset model. Omit to leave unchanged.
	Model *string `json:"model,omitempty"`

	// Name Asset display name. Omit to leave unchanged.
	Name *string `json:"name,omitempty"`

	// SerialNumber Asset serial number. Omit to leave unchanged.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Type Public asset type. Omit to leave unchanged.
	Type *string `json:"type,omitempty"`

	// Year Asset model year. Omit to leave unchanged.
	Year *int32 `json:"year,omitempty"`
}

UpdateAssetRequest Request body for updating a customer's asset through an authenticated business-scoped public API key.

type UpdateCustomerRequest 

type UpdateCustomerRequest struct {
	// Email Customer email address. Omit to leave unchanged.
	Email *string `json:"email,omitempty"`

	// FirstName Customer first name. Omit to leave unchanged.
	FirstName *string `json:"first_name,omitempty"`

	// Landline Customer landline phone number. Omit to leave unchanged.
	Landline *string `json:"landline,omitempty"`

	// LastName Customer last name. Omit to leave unchanged.
	LastName *string `json:"last_name,omitempty"`

	// Phone Customer mobile phone number. Omit to leave unchanged.
	Phone *string `json:"phone,omitempty"`

	// PreferredContactMethod Preferred contact method as a public value such as email, phone, whats_app, instagram, or facebook. Omit to leave unchanged.
	PreferredContactMethod *string `json:"preferred_contact_method,omitempty"`
}

UpdateCustomerRequest Request body for updating a customer through an authenticated business-scoped public API key.

type UpdateInvoiceItemRequest 

type UpdateInvoiceItemRequest struct {
	// AssetId Public customer asset id (`asset_...`). Omit to leave unchanged.
	AssetId *string `json:"asset_id,omitempty"`

	// Description Optional longer description. Omit to leave unchanged.
	Description *string `json:"description,omitempty"`

	// Name Display name. Omit to leave unchanged.
	Name *string `json:"name,omitempty"`

	// Order Display order of the item on the invoice. Omit to leave unchanged.
	Order *int32 `json:"order,omitempty"`

	// Quantity Quantity billed on the item. Omit to leave unchanged.
	Quantity *float64 `json:"quantity,omitempty"`

	// UnitPrice Unit price in the invoice currency. Omit to leave unchanged.
	UnitPrice *float64 `json:"unit_price,omitempty"`
}

UpdateInvoiceItemRequest Request body for updating an invoice item through the public API.

type UpdateServiceRequest 

type UpdateServiceRequest struct {
	// Category New public category name. Workshop creates the category for the business if it does not exist.
	Category *string `json:"category,omitempty"`

	// Description New description of what the service includes.
	Description *string `json:"description,omitempty"`

	// DurationMinutes New estimated duration in minutes.
	DurationMinutes *int32 `json:"duration_minutes,omitempty"`

	// ImageUrl New public image URL. Send an empty value to clear the service image.
	ImageUrl *string `json:"image_url,omitempty"`

	// Name New service name shown in the public catalogue.
	Name *string `json:"name,omitempty"`

	// Price New raw service price. Public responses show this only when pricing_type is set_price.
	Price *float64 `json:"price,omitempty"`

	// PricingType New pricing model as a snake_case value: set_price, price_on_assessment, or price_on_request.
	PricingType *string `json:"pricing_type,omitempty"`

	// Visibility New catalogue visibility as a snake_case value: external_and_internal, internal_only, or disabled.
	Visibility *string `json:"visibility,omitempty"`
}

UpdateServiceRequest Public API request for updating selected service catalogue fields. Null properties are ignored so callers can patch only the fields they need.

type UpdateWebhookEndpointRequest 

type UpdateWebhookEndpointRequest struct {
	// BusinessIds Public business ids this endpoint is subscribed to. Omit to leave unchanged.
	BusinessIds *[]string `json:"business_ids,omitempty"`

	// Description Human-readable description for this endpoint. Omit to leave unchanged.
	Description *string `json:"description,omitempty"`

	// Enabled Whether delivery to this endpoint is enabled. Omit to leave unchanged.
	Enabled *bool `json:"enabled,omitempty"`

	// EventTypes Event type filters such as job.created. Use * for all supported events. Omit to leave unchanged.
	EventTypes *[]string `json:"event_types,omitempty"`

	// Url HTTPS URL that Workshop will POST webhook events to. Omit to leave unchanged.
	Url *string `json:"url,omitempty"`
}

UpdateWebhookEndpointRequest Request body for updating an outbound webhook endpoint subscription.

type WebhookDeliveriesGetParams 

type WebhookDeliveriesGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

WebhookDeliveriesGetParams defines parameters for WebhookDeliveriesGet.

type WebhookDeliveriesGetResponse 

type WebhookDeliveriesGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WebhookDeliveryResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookDeliveriesGetResponse 

func ParseWebhookDeliveriesGetResponse(rsp *http.Response) (*WebhookDeliveriesGetResponse, error)

ParseWebhookDeliveriesGetResponse parses an HTTP response from a WebhookDeliveriesGetWithResponse call

func (WebhookDeliveriesGetResponse) ContentType 

func (r WebhookDeliveriesGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookDeliveriesGetResponse) Status 

func (r WebhookDeliveriesGetResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookDeliveriesGetResponse) StatusCode 

func (r WebhookDeliveriesGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookDeliveriesListForEndpointParams 

type WebhookDeliveriesListForEndpointParams struct {
	// Status Filter webhook deliveries by status: `pending`, `success`, or `failed`.
	Status *string `form:"status,omitempty" json:"status,omitempty"`

	// EventType Filter webhook deliveries to a single event type name.
	EventType *string `form:"event_type,omitempty" json:"event_type,omitempty"`

	// Limit Maximum number of resources to return (1–100, default 50).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque page cursor from a previous list response's `pagination.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

WebhookDeliveriesListForEndpointParams defines parameters for WebhookDeliveriesListForEndpoint.

type WebhookDeliveriesListForEndpointResponse 

type WebhookDeliveriesListForEndpointResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfWebhookDeliveryResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookDeliveriesListForEndpointResponse 

func ParseWebhookDeliveriesListForEndpointResponse(rsp *http.Response) (*WebhookDeliveriesListForEndpointResponse, error)

ParseWebhookDeliveriesListForEndpointResponse parses an HTTP response from a WebhookDeliveriesListForEndpointWithResponse call

func (WebhookDeliveriesListForEndpointResponse) ContentType 

func (r WebhookDeliveriesListForEndpointResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookDeliveriesListForEndpointResponse) Status 

func (r WebhookDeliveriesListForEndpointResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookDeliveriesListForEndpointResponse) StatusCode 

func (r WebhookDeliveriesListForEndpointResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookDeliveriesReplayParams 

type WebhookDeliveriesReplayParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

WebhookDeliveriesReplayParams defines parameters for WebhookDeliveriesReplay.

type WebhookDeliveriesReplayResponse 

type WebhookDeliveriesReplayResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *WebhookDeliveryResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookDeliveriesReplayResponse 

func ParseWebhookDeliveriesReplayResponse(rsp *http.Response) (*WebhookDeliveriesReplayResponse, error)

ParseWebhookDeliveriesReplayResponse parses an HTTP response from a WebhookDeliveriesReplayWithResponse call

func (WebhookDeliveriesReplayResponse) ContentType 

func (r WebhookDeliveriesReplayResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookDeliveriesReplayResponse) Status 

func (r WebhookDeliveriesReplayResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookDeliveriesReplayResponse) StatusCode 

func (r WebhookDeliveriesReplayResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookDeliveryResponse 

type WebhookDeliveryResponse struct {
	// AttemptCount Number of delivery attempts made so far.
	AttemptCount *int32 `json:"attempt_count,omitempty"`

	// BusinessId Public business id that generated the webhook event.
	BusinessId *string `json:"business_id,omitempty"`

	// CreatedAt UTC timestamp when this delivery row was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// EventId Stable public event id for the underlying domain event.
	EventId *string `json:"event_id,omitempty"`

	// EventType Public webhook event type, such as job.created.
	EventType *string `json:"event_type,omitempty"`

	// Id Public webhook delivery id (`whd_...`).
	Id *string `json:"id,omitempty"`

	// LastErrorMessage Error summary from the most recent failed delivery attempt.
	LastErrorMessage *string `json:"last_error_message,omitempty"`

	// LastResponseBody Truncated response body summary from the most recent delivery attempt.
	LastResponseBody *string `json:"last_response_body,omitempty"`

	// LastResponseCode HTTP status code from the most recent delivery attempt, when available.
	LastResponseCode *int32 `json:"last_response_code,omitempty"`

	// NextRetryAt UTC timestamp for the next retry attempt, when scheduled.
	NextRetryAt *time.Time `json:"next_retry_at,omitempty"`

	// Object Resource object type. Always webhook_delivery.
	Object *string `json:"object,omitempty"`

	// Payload Serialised JSON payload that was or will be posted to the endpoint.
	Payload *string `json:"payload,omitempty"`

	// ProcessedAt UTC timestamp when the delivery succeeded or was marked permanently failed.
	ProcessedAt *time.Time `json:"processed_at,omitempty"`

	// ReplayedFromDeliveryId Opaque delivery id that this replay was created from, when applicable.
	ReplayedFromDeliveryId *string `json:"replayed_from_delivery_id,omitempty"`

	// Status Delivery status: pending, success, or failed.
	Status *string `json:"status,omitempty"`

	// WebhookEndpointId Opaque webhook endpoint id that received this delivery.
	WebhookEndpointId *string `json:"webhook_endpoint_id,omitempty"`
}

WebhookDeliveryResponse Public representation of an outbound webhook delivery attempt.

type WebhookEndpointResponse 

type WebhookEndpointResponse struct {
	// BusinessIds Public business ids this endpoint is subscribed to.
	BusinessIds *[]string `json:"business_ids,omitempty"`

	// CreatedAt UTC timestamp when this endpoint was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Description Human-readable description for this endpoint.
	Description *string `json:"description,omitempty"`

	// Enabled Whether delivery to this endpoint is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// EventTypes Event type filters. A single * means all supported events.
	EventTypes *[]string `json:"event_types,omitempty"`

	// Id Public webhook endpoint id (`wh_...`).
	Id *string `json:"id,omitempty"`

	// Object Resource object type. Always webhook_endpoint.
	Object *string `json:"object,omitempty"`

	// PreviousSigningSecretExpiresAt UTC timestamp when the previous signing secret stops being included in signatures.
	PreviousSigningSecretExpiresAt *time.Time `json:"previous_signing_secret_expires_at,omitempty"`

	// PreviousSigningSecretPrefix Display-only prefix for the previous signing secret during rotation, when active.
	PreviousSigningSecretPrefix *string `json:"previous_signing_secret_prefix,omitempty"`

	// SigningSecretPrefix Display-only prefix for identifying the active signing secret.
	SigningSecretPrefix *string `json:"signing_secret_prefix,omitempty"`

	// UpdatedAt UTC timestamp when this endpoint was last updated.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// Url HTTPS URL that Workshop posts webhook events to.
	Url *string `json:"url,omitempty"`
}

WebhookEndpointResponse Public representation of an outbound webhook endpoint subscription.

type WebhookEndpointsCreateJSONRequestBody 

type WebhookEndpointsCreateJSONRequestBody = CreateWebhookEndpointRequest

WebhookEndpointsCreateJSONRequestBody defines body for WebhookEndpointsCreate for application/json ContentType.

type WebhookEndpointsCreateParams 

type WebhookEndpointsCreateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

WebhookEndpointsCreateParams defines parameters for WebhookEndpointsCreate.

type WebhookEndpointsCreateResponse 

type WebhookEndpointsCreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *CreateWebhookEndpointResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookEndpointsCreateResponse 

func ParseWebhookEndpointsCreateResponse(rsp *http.Response) (*WebhookEndpointsCreateResponse, error)

ParseWebhookEndpointsCreateResponse parses an HTTP response from a WebhookEndpointsCreateWithResponse call

func (WebhookEndpointsCreateResponse) ContentType 

func (r WebhookEndpointsCreateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookEndpointsCreateResponse) Status 

func (r WebhookEndpointsCreateResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookEndpointsCreateResponse) StatusCode 

func (r WebhookEndpointsCreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookEndpointsDeleteParams 

type WebhookEndpointsDeleteParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

WebhookEndpointsDeleteParams defines parameters for WebhookEndpointsDelete.

type WebhookEndpointsDeleteResponse 

type WebhookEndpointsDeleteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WebhookEndpointResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookEndpointsDeleteResponse 

func ParseWebhookEndpointsDeleteResponse(rsp *http.Response) (*WebhookEndpointsDeleteResponse, error)

ParseWebhookEndpointsDeleteResponse parses an HTTP response from a WebhookEndpointsDeleteWithResponse call

func (WebhookEndpointsDeleteResponse) ContentType 

func (r WebhookEndpointsDeleteResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookEndpointsDeleteResponse) Status 

func (r WebhookEndpointsDeleteResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookEndpointsDeleteResponse) StatusCode 

func (r WebhookEndpointsDeleteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookEndpointsGetParams 

type WebhookEndpointsGetParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

WebhookEndpointsGetParams defines parameters for WebhookEndpointsGet.

type WebhookEndpointsGetResponse 

type WebhookEndpointsGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WebhookEndpointResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookEndpointsGetResponse 

func ParseWebhookEndpointsGetResponse(rsp *http.Response) (*WebhookEndpointsGetResponse, error)

ParseWebhookEndpointsGetResponse parses an HTTP response from a WebhookEndpointsGetWithResponse call

func (WebhookEndpointsGetResponse) ContentType 

func (r WebhookEndpointsGetResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookEndpointsGetResponse) Status 

func (r WebhookEndpointsGetResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookEndpointsGetResponse) StatusCode 

func (r WebhookEndpointsGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookEndpointsListParams 

type WebhookEndpointsListParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

WebhookEndpointsListParams defines parameters for WebhookEndpointsList.

type WebhookEndpointsListResponse 

type WebhookEndpointsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfWebhookEndpointResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookEndpointsListResponse 

func ParseWebhookEndpointsListResponse(rsp *http.Response) (*WebhookEndpointsListResponse, error)

ParseWebhookEndpointsListResponse parses an HTTP response from a WebhookEndpointsListWithResponse call

func (WebhookEndpointsListResponse) ContentType 

func (r WebhookEndpointsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookEndpointsListResponse) Status 

func (r WebhookEndpointsListResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookEndpointsListResponse) StatusCode 

func (r WebhookEndpointsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookEndpointsRotateSecretParams 

type WebhookEndpointsRotateSecretParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

WebhookEndpointsRotateSecretParams defines parameters for WebhookEndpointsRotateSecret.

type WebhookEndpointsRotateSecretResponse 

type WebhookEndpointsRotateSecretResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *RotateWebhookEndpointSecretResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookEndpointsRotateSecretResponse 

func ParseWebhookEndpointsRotateSecretResponse(rsp *http.Response) (*WebhookEndpointsRotateSecretResponse, error)

ParseWebhookEndpointsRotateSecretResponse parses an HTTP response from a WebhookEndpointsRotateSecretWithResponse call

func (WebhookEndpointsRotateSecretResponse) ContentType 

func (r WebhookEndpointsRotateSecretResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookEndpointsRotateSecretResponse) Status 

func (r WebhookEndpointsRotateSecretResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookEndpointsRotateSecretResponse) StatusCode 

func (r WebhookEndpointsRotateSecretResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookEndpointsUpdateJSONRequestBody 

type WebhookEndpointsUpdateJSONRequestBody = UpdateWebhookEndpointRequest

WebhookEndpointsUpdateJSONRequestBody defines body for WebhookEndpointsUpdate for application/json ContentType.

type WebhookEndpointsUpdateParams 

type WebhookEndpointsUpdateParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`

	// IdempotencyKey Required for public write operations to make retries safe.
	IdempotencyKey string `json:"Idempotency-Key"`
}

WebhookEndpointsUpdateParams defines parameters for WebhookEndpointsUpdate.

type WebhookEndpointsUpdateResponse 

type WebhookEndpointsUpdateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WebhookEndpointResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON409      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookEndpointsUpdateResponse 

func ParseWebhookEndpointsUpdateResponse(rsp *http.Response) (*WebhookEndpointsUpdateResponse, error)

ParseWebhookEndpointsUpdateResponse parses an HTTP response from a WebhookEndpointsUpdateWithResponse call

func (WebhookEndpointsUpdateResponse) ContentType 

func (r WebhookEndpointsUpdateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookEndpointsUpdateResponse) Status 

func (r WebhookEndpointsUpdateResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookEndpointsUpdateResponse) StatusCode 

func (r WebhookEndpointsUpdateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WebhookEventResponse 

type WebhookEventResponse struct {
	// Description Human-readable event description for API docs and UI.
	Description *string `json:"description,omitempty"`

	// Name Public event name, for example job.created.
	Name *string `json:"name,omitempty"`

	// PayloadObject Public payload object type delivered for this event.
	PayloadObject *string `json:"payload_object,omitempty"`

	// Status Event availability status, for example available.
	Status *string `json:"status,omitempty"`
}

WebhookEventResponse Public webhook event catalog entry.

type WebhookEventsListParams 

type WebhookEventsListParams struct {
	// Authorization Bearer Workshop API key. Example: Bearer bbk_live_...
	Authorization *string `json:"Authorization,omitempty"`

	// XBikebookRequestId Optional request id supplied by the client for support correlation.
	XBikebookRequestId *string `json:"X-Bikebook-Request-Id,omitempty"`
}

WebhookEventsListParams defines parameters for WebhookEventsList.

type WebhookEventsListResponse 

type WebhookEventsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiListResponseOfWebhookEventResponse
	JSON400      *ApiErrorResponse
	JSON401      *ApiErrorResponse
	JSON403      *ApiErrorResponse
	JSON404      *ApiErrorResponse
	JSON429      *ApiErrorResponse
}

func ParseWebhookEventsListResponse 

func ParseWebhookEventsListResponse(rsp *http.Response) (*WebhookEventsListResponse, error)

ParseWebhookEventsListResponse parses an HTTP response from a WebhookEventsListWithResponse call

func (WebhookEventsListResponse) ContentType 

func (r WebhookEventsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (WebhookEventsListResponse) Status 

func (r WebhookEventsListResponse) Status() string

Status returns HTTPResponse.Status

func (WebhookEventsListResponse) StatusCode 

func (r WebhookEventsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.